Loading README.md +3 −2 Changes for README.md: 3 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -239,8 +239,9 @@ feeling confident, use `--fast`. _Black_ is a PEP 8 compliant opinionated formatter. _Black_ reformats entire files in place. It is not configurable. It doesn't take previous formatting into account. Your main option of configuring _Black_ is that it doesn't reformat blocks that start with `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` have to be on the same level of indentation. To learn more about _Black_'s opinions, to go `# fmt: off` and end with `# fmt: on`, or lines that ends with `# fmt: skip`. Pay attention that `# fmt: on/off` have to be on the same level of indentation. To learn more about _Black_'s opinions, to go [the_black_code_style](https://github.com/psf/black/blob/master/docs/the_black_code_style.md). Please refer to this document before submitting an issue. What seems like a bug might be Loading src/black/__init__.py +34 −10 Changes for src/black/__init__.py: 34 added lines, 10 removed lines. Original line number Diff line number Diff line Loading @@ -2581,6 +2581,8 @@ def is_split_before_delimiter(leaf: Leaf, previous: Optional[Leaf] = None) -> Pr FMT_OFF = {"# fmt: off", "# fmt:off", "# yapf: disable"} FMT_SKIP = {"# fmt: skip", "# fmt:skip"} FMT_PASS = {*FMT_OFF, *FMT_SKIP} FMT_ON = {"# fmt: on", "# fmt:on", "# yapf: enable"} Loading Loading @@ -5404,16 +5406,21 @@ def convert_one_fmt_off_pair(node: Node) -> bool: for leaf in node.leaves(): previous_consumed = 0 for comment in list_comments(leaf.prefix, is_endmarker=False): if comment.value in FMT_OFF: if comment.value not in FMT_PASS: previous_consumed = comment.consumed continue # We only want standalone comments. If there's no previous leaf or # the previous leaf is indentation, it's a standalone comment in # disguise. if comment.type != STANDALONE_COMMENT: if comment.value in FMT_PASS and comment.type != STANDALONE_COMMENT: prev = preceding_leaf(leaf) if prev and prev.type not in WHITESPACE: if prev: if comment.value in FMT_OFF and prev.type not in WHITESPACE: continue if comment.value in FMT_SKIP and prev.type in WHITESPACE: continue ignored_nodes = list(generate_ignored_nodes(leaf)) ignored_nodes = list(generate_ignored_nodes(leaf, comment)) if not ignored_nodes: continue Loading @@ -5421,9 +5428,11 @@ def convert_one_fmt_off_pair(node: Node) -> bool: parent = first.parent prefix = first.prefix first.prefix = prefix[comment.consumed :] hidden_value = ( comment.value + "\n" + "".join(str(n) for n in ignored_nodes) ) hidden_value = "".join(str(n) for n in ignored_nodes) if comment.value in FMT_OFF: hidden_value = comment.value + "\n" + hidden_value if comment.value in FMT_SKIP: hidden_value += " " + comment.value if hidden_value.endswith("\n"): # That happens when one of the `ignored_nodes` ended with a NEWLINE # leaf (possibly followed by a DEDENT). Loading @@ -5445,17 +5454,32 @@ def convert_one_fmt_off_pair(node: Node) -> bool: ) return True previous_consumed = comment.consumed return False def generate_ignored_nodes(leaf: Leaf) -> Iterator[LN]: def generate_ignored_nodes(leaf: Leaf, comment: ProtoComment) -> Iterator[LN]: """Starting from the container of `leaf`, generate all leaves until `# fmt: on`. If comment is skip, returns leaf only. Stops at the end of the block. """ container: Optional[LN] = container_of(leaf) if comment.value in FMT_SKIP: prev_sibling = leaf.prev_sibling if comment.value in leaf.prefix and prev_sibling is not None: leaf.prefix = leaf.prefix.replace(comment.value, "") siblings = [prev_sibling] while ( "\n" not in prev_sibling.prefix and prev_sibling.prev_sibling is not None ): prev_sibling = prev_sibling.prev_sibling siblings.insert(0, prev_sibling) for sibling in siblings: yield sibling elif leaf.parent is not None: yield leaf.parent return while container is not None and container.type != token.ENDMARKER: if is_fmt_on(container): return Loading tests/data/fmtskip.py 0 → 100644 +3 −0 Changes for tests/data/fmtskip.py: 3 added lines, 0 removed lines. Original line number Diff line number Diff line a, b = 1, 2 c = 6 # fmt: skip d = 5 tests/data/fmtskip2.py 0 → 100644 +17 −0 Changes for tests/data/fmtskip2.py: 17 added lines, 0 removed lines. Original line number Diff line number Diff line l1 = ["This list should be broken up", "into multiple lines", "because it is way too long"] l2 = ["But this list shouldn't", "even though it also has", "way too many characters in it"] # fmt: skip l3 = ["I have", "trailing comma", "so I should be braked",] # output l1 = [ "This list should be broken up", "into multiple lines", "because it is way too long", ] l2 = ["But this list shouldn't", "even though it also has", "way too many characters in it"] # fmt: skip l3 = [ "I have", "trailing comma", "so I should be braked", ] No newline at end of file tests/data/fmtskip3.py 0 → 100644 +20 −0 Changes for tests/data/fmtskip3.py: 20 added lines, 0 removed lines. Original line number Diff line number Diff line a = 3 # fmt: off b, c = 1, 2 d = 6 # fmt: skip e = 5 # fmt: on f = ["This is a very long line that should be formatted into a clearer line ", "by rearranging."] # output a = 3 # fmt: off b, c = 1, 2 d = 6 # fmt: skip e = 5 # fmt: on f = [ "This is a very long line that should be formatted into a clearer line ", "by rearranging.", ] Loading
README.md +3 −2 Changes for README.md: 3 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -239,8 +239,9 @@ feeling confident, use `--fast`. _Black_ is a PEP 8 compliant opinionated formatter. _Black_ reformats entire files in place. It is not configurable. It doesn't take previous formatting into account. Your main option of configuring _Black_ is that it doesn't reformat blocks that start with `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` have to be on the same level of indentation. To learn more about _Black_'s opinions, to go `# fmt: off` and end with `# fmt: on`, or lines that ends with `# fmt: skip`. Pay attention that `# fmt: on/off` have to be on the same level of indentation. To learn more about _Black_'s opinions, to go [the_black_code_style](https://github.com/psf/black/blob/master/docs/the_black_code_style.md). Please refer to this document before submitting an issue. What seems like a bug might be Loading
src/black/__init__.py +34 −10 Changes for src/black/__init__.py: 34 added lines, 10 removed lines. Original line number Diff line number Diff line Loading @@ -2581,6 +2581,8 @@ def is_split_before_delimiter(leaf: Leaf, previous: Optional[Leaf] = None) -> Pr FMT_OFF = {"# fmt: off", "# fmt:off", "# yapf: disable"} FMT_SKIP = {"# fmt: skip", "# fmt:skip"} FMT_PASS = {*FMT_OFF, *FMT_SKIP} FMT_ON = {"# fmt: on", "# fmt:on", "# yapf: enable"} Loading Loading @@ -5404,16 +5406,21 @@ def convert_one_fmt_off_pair(node: Node) -> bool: for leaf in node.leaves(): previous_consumed = 0 for comment in list_comments(leaf.prefix, is_endmarker=False): if comment.value in FMT_OFF: if comment.value not in FMT_PASS: previous_consumed = comment.consumed continue # We only want standalone comments. If there's no previous leaf or # the previous leaf is indentation, it's a standalone comment in # disguise. if comment.type != STANDALONE_COMMENT: if comment.value in FMT_PASS and comment.type != STANDALONE_COMMENT: prev = preceding_leaf(leaf) if prev and prev.type not in WHITESPACE: if prev: if comment.value in FMT_OFF and prev.type not in WHITESPACE: continue if comment.value in FMT_SKIP and prev.type in WHITESPACE: continue ignored_nodes = list(generate_ignored_nodes(leaf)) ignored_nodes = list(generate_ignored_nodes(leaf, comment)) if not ignored_nodes: continue Loading @@ -5421,9 +5428,11 @@ def convert_one_fmt_off_pair(node: Node) -> bool: parent = first.parent prefix = first.prefix first.prefix = prefix[comment.consumed :] hidden_value = ( comment.value + "\n" + "".join(str(n) for n in ignored_nodes) ) hidden_value = "".join(str(n) for n in ignored_nodes) if comment.value in FMT_OFF: hidden_value = comment.value + "\n" + hidden_value if comment.value in FMT_SKIP: hidden_value += " " + comment.value if hidden_value.endswith("\n"): # That happens when one of the `ignored_nodes` ended with a NEWLINE # leaf (possibly followed by a DEDENT). Loading @@ -5445,17 +5454,32 @@ def convert_one_fmt_off_pair(node: Node) -> bool: ) return True previous_consumed = comment.consumed return False def generate_ignored_nodes(leaf: Leaf) -> Iterator[LN]: def generate_ignored_nodes(leaf: Leaf, comment: ProtoComment) -> Iterator[LN]: """Starting from the container of `leaf`, generate all leaves until `# fmt: on`. If comment is skip, returns leaf only. Stops at the end of the block. """ container: Optional[LN] = container_of(leaf) if comment.value in FMT_SKIP: prev_sibling = leaf.prev_sibling if comment.value in leaf.prefix and prev_sibling is not None: leaf.prefix = leaf.prefix.replace(comment.value, "") siblings = [prev_sibling] while ( "\n" not in prev_sibling.prefix and prev_sibling.prev_sibling is not None ): prev_sibling = prev_sibling.prev_sibling siblings.insert(0, prev_sibling) for sibling in siblings: yield sibling elif leaf.parent is not None: yield leaf.parent return while container is not None and container.type != token.ENDMARKER: if is_fmt_on(container): return Loading
tests/data/fmtskip.py 0 → 100644 +3 −0 Changes for tests/data/fmtskip.py: 3 added lines, 0 removed lines. Original line number Diff line number Diff line a, b = 1, 2 c = 6 # fmt: skip d = 5
tests/data/fmtskip2.py 0 → 100644 +17 −0 Changes for tests/data/fmtskip2.py: 17 added lines, 0 removed lines. Original line number Diff line number Diff line l1 = ["This list should be broken up", "into multiple lines", "because it is way too long"] l2 = ["But this list shouldn't", "even though it also has", "way too many characters in it"] # fmt: skip l3 = ["I have", "trailing comma", "so I should be braked",] # output l1 = [ "This list should be broken up", "into multiple lines", "because it is way too long", ] l2 = ["But this list shouldn't", "even though it also has", "way too many characters in it"] # fmt: skip l3 = [ "I have", "trailing comma", "so I should be braked", ] No newline at end of file
tests/data/fmtskip3.py 0 → 100644 +20 −0 Changes for tests/data/fmtskip3.py: 20 added lines, 0 removed lines. Original line number Diff line number Diff line a = 3 # fmt: off b, c = 1, 2 d = 6 # fmt: skip e = 5 # fmt: on f = ["This is a very long line that should be formatted into a clearer line ", "by rearranging."] # output a = 3 # fmt: off b, c = 1, 2 d = 6 # fmt: skip e = 5 # fmt: on f = [ "This is a very long line that should be formatted into a clearer line ", "by rearranging.", ]