]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Describe how string literals are handled (#96)
authorZsolt Dollenstein <zsol.zsol@gmail.com>
Sat, 31 Mar 2018 21:42:48 +0000 (22:42 +0100)
committerŁukasz Langa <lukasz@langa.pl>
Sat, 31 Mar 2018 21:42:48 +0000 (14:42 -0700)
README.md
black.py
docs/reference/reference_functions.rst

index 3ab68878c4421598c1330d5b0e1cb61802622f1a..205163f3e158d92cdd6be653fda388980a18c0d2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -159,7 +159,7 @@ def very_important_function(
     debug: bool = False,
 ):
     """Applies `variables` to the `template` and writes to `file`."""
     debug: bool = False,
 ):
     """Applies `variables` to the `template` and writes to `file`."""
-    with open(file, 'w') as f:
+    with open(file, "w") as f:
         ...
 ```
 
         ...
 ```
 
@@ -260,6 +260,15 @@ if you'd like a trailing comma in this situation and *Black* didn't
 recognize it was safe to do so, put it there manually and *Black* will
 keep it.
 
 recognize it was safe to do so, put it there manually and *Black* will
 keep it.
 
+### Strings
+
+*Black* prefers double quotes (`"` and `"""`), but only if this does not
+result in more escaping. It will remove escape sequences as necessary as
+part of moving to the other type of quote. This applies to all kinds of
+prefixed strings, including *raw-strings* (`r""`), *byte literals* (`b""`),
+and *formatted strings* (`f""`). The approach above strikes a good balance
+between consistency and legibility.
+
 
 ## Editor integration
 
 
 ## Editor integration
 
index 3d5ea14736e0c6aca41a75c9cc517130802b5076..3bb83daef28c396cd7670503d7ad21c7d20336c2 100644 (file)
--- a/black.py
+++ b/black.py
@@ -1815,6 +1815,13 @@ def normalize_prefix(leaf: Leaf, *, inside_brackets: bool) -> None:
 
 
 def normalize_string_quotes(leaf: Leaf) -> None:
 
 
 def normalize_string_quotes(leaf: Leaf) -> None:
+    """Prefer double quotes but only if it doesn't cause more escaping.
+
+    Adds or removes backslashes as appropriate. Doesn't parse and fix
+    strings nested in f-strings (yet).
+
+    Note: Mutates its argument.
+    """
     value = leaf.value.lstrip("furbFURB")
     if value[:3] == '"""':
         return
     value = leaf.value.lstrip("furbFURB")
     if value[:3] == '"""':
         return
index b521f789e4a86ffbf791720b145637ef865266fc..4e7fb837222d1d0f477f85c2a2823a9ba0d6d461 100644 (file)
@@ -77,6 +77,8 @@ Utilities
 
 .. autofunction:: black.normalize_prefix
 
 
 .. autofunction:: black.normalize_prefix
 
+.. autofunction:: black.normalize_string_quotes
+
 .. autofunction:: black.preceding_leaf
 
 .. autofunction:: black.whitespace
 .. autofunction:: black.preceding_leaf
 
 .. autofunction:: black.whitespace