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.
1 x = "This is a really long string that can't possibly be expected to fit all together on one line. In fact it may even take up three or more lines... like four or five... but probably just three."
3 x += "This is a really long string that can't possibly be expected to fit all together on one line. In fact it may even take up three or more lines... like four or five... but probably just three."
9 print('This is a really long string inside of a print statement with extra arguments attached at the end of it.', x, y, z)
11 print("This is a really long string inside of a print statement with no extra arguments attached at the end of it.")
13 D1 = {"The First": "This is a really long string that can't possibly be expected to fit all together on one line. Also it is inside a dictionary, so formatting is more difficult.", "The Second": "This is another really really (not really) long string that also can't be expected to fit on one line and is, like the other string, inside a dictionary."}
15 D2 = {1.0: "This is a really long string that can't possibly be expected to fit all together on one line. Also it is inside a dictionary, so formatting is more difficult.", 2.0: "This is another really really (not really) long string that also can't be expected to fit on one line and is, like the other string, inside a dictionary."}
17 D3 = {x: "This is a really long string that can't possibly be expected to fit all together on one line. Also it is inside a dictionary, so formatting is more difficult.", y: "This is another really really (not really) long string that also can't be expected to fit on one line and is, like the other string, inside a dictionary."}
19 D4 = {"A long and ridiculous {}".format(string_key): "This is a really really really long string that has to go i,side of a dictionary. It is soooo bad.", some_func("calling", "some", "stuff"): "This is a really really really long string that has to go inside of a dictionary. It is {soooo} bad (#{x}).".format(sooo="soooo", x=2), "A %s %s" % ("formatted", "string"): "This is a really really really long string that has to go inside of a dictionary. It is %s bad (#%d)." % ("soooo", 2)}
21 D5 = { # Test for https://github.com/psf/black/issues/3261
22 ("This is a really long string that can't be expected to fit in one line and is used as a nested dict's key"): {"inner": "value"},
25 D6 = { # Test for https://github.com/psf/black/issues/3261
26 ("This is a really long string that can't be expected to fit in one line and is used as a dict's key"): ["value1", "value2"],
29 L1 = ["The is a short string", "This is a really long string that can't possibly be expected to fit all together on one line. Also it is inside a list literal, so it's expected to be wrapped in parens when splitting to avoid implicit str concatenation.", short_call("arg", {"key": "value"}), "This is another really really (not really) long string that also can't be expected to fit on one line and is, like the other string, inside a list literal.", ("parens should be stripped for short string in list")]
31 L2 = ["This is a really long string that can't be expected to fit in one line and is the only child of a list literal."]
33 S1 = {"The is a short string", "This is a really long string that can't possibly be expected to fit all together on one line. Also it is inside a set literal, so it's expected to be wrapped in parens when splitting to avoid implicit str concatenation.", short_call("arg", {"key": "value"}), "This is another really really (not really) long string that also can't be expected to fit on one line and is, like the other string, inside a set literal.", ("parens should be stripped for short string in set")}
35 S2 = {"This is a really long string that can't be expected to fit in one line and is the only child of a set literal."}
37 T1 = ("The is a short string", "This is a really long string that can't possibly be expected to fit all together on one line. Also it is inside a tuple literal, so it's expected to be wrapped in parens when splitting to avoid implicit str concatenation.", short_call("arg", {"key": "value"}), "This is another really really (not really) long string that also can't be expected to fit on one line and is, like the other string, inside a tuple literal.", ("parens should be stripped for short string in list"))
39 T2 = ("This is a really long string that can't be expected to fit in one line and is the only child of a tuple literal.",)
41 func_with_keywords(my_arg, my_kwarg="Long keyword strings also need to be wrapped, but they will probably need to be handled a little bit differently.")
44 'But what should happen when code has already been formatted but in the wrong way? Like'
45 " with a space at the end instead of the beginning. Or what about when it is split too soon?"
48 bad_split2 = "But what should happen when code has already " \
49 "been formatted but in the wrong way? Like " \
50 "with a space at the end instead of the " \
51 "beginning. Or what about when it is split too " \
52 "soon? In the case of a split that is too " \
53 "short, black will try to honer the custom " \
57 "What if we have inline comments on " # First Comment
58 "each line of a bad split? In that " # Second Comment
59 "case, we should just leave it alone." # Third Comment
63 "But what should happen when code has already "
64 "been formatted but in the wrong way? Like "
65 "with a space at the end instead of the "
66 "beginning. Or what about when it is split too "
67 "soon? In the case of a split that is too "
68 "short, black will try to honer the custom "
75 long_string_kwarg="But what should happen when code has already been formatted but in the wrong way? Like "
76 "with a space at the end instead of the beginning. Or what about when it is split too "
82 "But what should happen when code has already "
83 r"been formatted but in the wrong way? Like "
84 "with a space at the end instead of the "
85 r"beginning. Or what about when it is split too "
86 r"soon? In the case of a split that is too "
87 "short, black will try to honer the custom "
95 inline_comments_func1(
96 "if there are inline "
97 "comments in the middle "
98 # Here is the standard alone comment.
99 "of the implicitly concatenated "
100 "string, we should handle "
105 inline_comments_func2(
106 "what if the string is very very very very very very very very very very long and this part does "
107 "not fit into a single line? "
108 # Here is the standard alone comment.
109 "then the string should still be properly handled by merging and splitting "
110 "it into parts that fit in line length.",
114 raw_string = r"This is a long raw string. When re-formatting this string, black needs to make sure it prepends the 'r' onto the new string."
116 fmt_string1 = "We also need to be sure to preserve any and all {} which may or may not be attached to the string in question.".format("method calls")
118 fmt_string2 = "But what about when the string is {} but {}".format("short", "the method call is really really really really really really really really long?")
120 old_fmt_string1 = "While we are on the topic of %s, we should also note that old-style formatting must also be preserved, since some %s still uses it." % ("formatting", "code")
122 old_fmt_string2 = "This is a %s %s %s %s" % ("really really really really really", "old", "way to format strings!", "Use f-strings instead!")
124 old_fmt_string3 = "Whereas only the strings after the percent sign were long in the last example, this example uses a long initial string as well. This is another %s %s %s %s" % ("really really really really really", "old", "way to format strings!", "Use f-strings instead!")
126 fstring = f"f-strings definitely make things more {difficult} than they need to be for {{black}}. But boy they sure are handy. The problem is that some lines will need to have the 'f' whereas others do not. This {line}, for example, needs one."
128 fstring_with_no_fexprs = f"Some regular string that needs to get split certainly but is NOT an fstring by any means whatsoever."
130 comment_string = "Long lines with inline comments should have their comments appended to the reformatted string's enclosing right parentheses." # This comment gets thrown to the top.
132 arg_comment_string = print("Long lines with inline comments which are apart of (and not the only member of) an argument list should have their comments appended to the reformatted string's enclosing left parentheses.", # This comment gets thrown to the top.
133 "Arg #2", "Arg #3", "Arg #4", "Arg #5")
135 pragma_comment_string1 = "Lines which end with an inline pragma comment of the form `# <pragma>: <...>` should be left alone." # noqa: E501
137 pragma_comment_string2 = "Lines which end with an inline pragma comment of the form `# <pragma>: <...>` should be left alone." # noqa
139 """This is a really really really long triple quote string and it should not be touched."""
141 triple_quote_string = """This is a really really really long triple quote string assignment and it should not be touched."""
143 assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception."
145 assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string {}.".format("formatting")
147 assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic string %s." % "formatting"
149 assert some_type_of_boolean_expression, "Followed by a really really really long string that is used to provide context to the AssertionError exception, which uses dynamic %s %s." % ("string", "formatting")
151 some_function_call("With a reallly generic name and with a really really long string that is, at some point down the line, " + added + " to a variable and then added to another string.")
153 some_function_call("With a reallly generic name and with a really really long string that is, at some point down the line, " + added + " to a variable and then added to another string. But then what happens when the final string is also supppppperrrrr long?! Well then that second (realllllllly long) string should be split too.", "and a second argument", and_a_third)
155 return "A really really really really really really really really really really really really really long {} {}".format("return", "value")
158 "This is a really long string argument to a function that has a trailing comma which should NOT be there.",
162 "This is a really long string argument to a function that has a trailing comma which should NOT be there.", # comment after comma
167 "This is a really long string argument to a function that has a trailing comma"
168 " which should NOT be there."
174 "This is a really long string argument to a function that has a trailing comma"
175 " which should NOT be there."
176 ), # comment after comma
179 func_with_bad_parens_that_wont_fit_in_one_line(
180 ("short string that should have parens stripped"),
186 func_with_bad_parens_that_wont_fit_in_one_line(
189 ("short string that should have parens stripped"),
193 func_with_bad_parens(
194 ("short string that should have parens stripped"),
200 func_with_bad_parens(
203 ("short string that should have parens stripped"),
207 annotated_variable: Final = "This is a large " + STRING + " that has been " + CONCATENATED + "using the '+' operator."
208 annotated_variable: Final = "This is a large string that has a type annotation attached to it. A type annotation should NOT stop a long string from being wrapped."
209 annotated_variable: Literal["fakse_literal"] = "This is a large string that has a type annotation attached to it. A type annotation should NOT stop a long string from being wrapped."
211 backslashes = "This is a really long string with \"embedded\" double quotes and 'single' quotes that also handles checking for an even number of backslashes \\"
212 backslashes = "This is a really long string with \"embedded\" double quotes and 'single' quotes that also handles checking for an even number of backslashes \\\\"
213 backslashes = "This is a really 'long' string with \"embedded double quotes\" and 'single' quotes that also handles checking for an odd number of backslashes \\\", like this...\\\\\\"
227 raw_strings = r"Don't" " get" r" merged" " unless they are all raw."
230 yield "This is a really long string that can't possibly be expected to fit all together on one line. In fact it may even take up three or more lines... like four or five... but probably just three."
232 x = f"This is a {{really}} long string that needs to be split without a doubt (i.e. most definitely). In short, this {string} that can't possibly be {{expected}} to fit all together on one line. In {fact} it may even take up three or more lines... like four or five... but probably just four."
234 long_unmergable_string_with_pragma = (
235 "This is a really long string that can't be merged because it has a likely pragma at the end" # type: ignore
239 long_unmergable_string_with_pragma = (
240 "This is a really long string that can't be merged because it has a likely pragma at the end" # noqa
244 long_unmergable_string_with_pragma = (
245 "This is a really long string that can't be merged because it has a likely pragma at the end" # pylint: disable=some-pylint-check
249 string_with_nameescape = (
250 "........................................................................ \N{LAO KO LA}"
253 string_with_nameescape = (
254 "........................................................................... \N{LAO KO LA}"
257 string_with_nameescape = (
258 "............................................................................ \N{LAO KO LA}"
261 string_with_nameescape_and_escaped_backslash = (
262 "...................................................................... \\\N{LAO KO LA}"
265 string_with_nameescape_and_escaped_backslash = (
266 "......................................................................... \\\N{LAO KO LA}"
269 string_with_nameescape_and_escaped_backslash = (
270 ".......................................................................... \\\N{LAO KO LA}"
273 string_with_escaped_nameescape = (
274 "........................................................................ \\N{LAO KO LA}"
277 string_with_escaped_nameescape = (
278 "........................................................................... \\N{LAO KO LA}"
281 msg = lambda x: f"this is a very very very long lambda value {x} that doesn't fit on a single line"
283 dict_with_lambda_values = {
285 f"{j.__class__.__name__}({some_function_call(j.left)}, "
286 f"{some_function_call(j.right)})"
290 # Complex string concatenations with a method call in the middle.
295 " (%r, self.%s, visitor.%s)"
296 % (attrname, attrname, visit_name)
297 for attrname, visit_name in names
304 # Test case of an outer string' parens enclose an inner string's parens.
305 call(body=("%s %s" % ((",".join(items)), suffix)))
312 "This is a really long string that can't possibly be expected to fit all together"
313 " on one line. In fact it may even take up three or more lines... like four or"
314 " five... but probably just three."
318 "This is a really long string that can't possibly be expected to fit all together"
319 " on one line. In fact it may even take up three or more lines... like four or"
320 " five... but probably just three."
326 "This is a really long string inside of a print statement with extra arguments"
327 " attached at the end of it.",
334 "This is a really long string inside of a print statement with no extra arguments"
335 " attached at the end of it."
340 "This is a really long string that can't possibly be expected to fit all"
341 " together on one line. Also it is inside a dictionary, so formatting is more"
345 "This is another really really (not really) long string that also can't be"
346 " expected to fit on one line and is, like the other string, inside a"
353 "This is a really long string that can't possibly be expected to fit all"
354 " together on one line. Also it is inside a dictionary, so formatting is more"
358 "This is another really really (not really) long string that also can't be"
359 " expected to fit on one line and is, like the other string, inside a"
366 "This is a really long string that can't possibly be expected to fit all"
367 " together on one line. Also it is inside a dictionary, so formatting is more"
371 "This is another really really (not really) long string that also can't be"
372 " expected to fit on one line and is, like the other string, inside a"
378 "A long and ridiculous {}".format(string_key): (
379 "This is a really really really long string that has to go i,side of a"
380 " dictionary. It is soooo bad."
382 some_func("calling", "some", "stuff"): (
383 "This is a really really really long string that has to go inside of a"
384 " dictionary. It is {soooo} bad (#{x}).".format(sooo="soooo", x=2)
387 % ("formatted", "string"): (
388 "This is a really really really long string that has to go inside of a"
389 " dictionary. It is %s bad (#%d)." % ("soooo", 2)
393 D5 = { # Test for https://github.com/psf/black/issues/3261
394 "This is a really long string that can't be expected to fit in one line and is used as a nested dict's key": {
399 D6 = { # Test for https://github.com/psf/black/issues/3261
400 "This is a really long string that can't be expected to fit in one line and is used as a dict's key": [
407 "The is a short string",
409 "This is a really long string that can't possibly be expected to fit all"
410 " together on one line. Also it is inside a list literal, so it's expected to"
411 " be wrapped in parens when splitting to avoid implicit str concatenation."
413 short_call("arg", {"key": "value"}),
415 "This is another really really (not really) long string that also can't be"
416 " expected to fit on one line and is, like the other string, inside a list"
419 "parens should be stripped for short string in list",
423 "This is a really long string that can't be expected to fit in one line and is the"
424 " only child of a list literal."
428 "The is a short string",
430 "This is a really long string that can't possibly be expected to fit all"
431 " together on one line. Also it is inside a set literal, so it's expected to be"
432 " wrapped in parens when splitting to avoid implicit str concatenation."
434 short_call("arg", {"key": "value"}),
436 "This is another really really (not really) long string that also can't be"
437 " expected to fit on one line and is, like the other string, inside a set"
440 "parens should be stripped for short string in set",
444 "This is a really long string that can't be expected to fit in one line and is the"
445 " only child of a set literal."
449 "The is a short string",
451 "This is a really long string that can't possibly be expected to fit all"
452 " together on one line. Also it is inside a tuple literal, so it's expected to"
453 " be wrapped in parens when splitting to avoid implicit str concatenation."
455 short_call("arg", {"key": "value"}),
457 "This is another really really (not really) long string that also can't be"
458 " expected to fit on one line and is, like the other string, inside a tuple"
461 "parens should be stripped for short string in list",
466 "This is a really long string that can't be expected to fit in one line and is"
467 " the only child of a tuple literal."
474 "Long keyword strings also need to be wrapped, but they will probably need to"
475 " be handled a little bit differently."
480 "But what should happen when code has already been formatted but in the wrong way?"
481 " Like with a space at the end instead of the beginning. Or what about when it is"
486 "But what should happen when code has already "
487 "been formatted but in the wrong way? Like "
488 "with a space at the end instead of the "
489 "beginning. Or what about when it is split too "
490 "soon? In the case of a split that is too "
491 "short, black will try to honer the custom "
496 "What if we have inline comments on " # First Comment
497 "each line of a bad split? In that " # Second Comment
498 "case, we should just leave it alone." # Third Comment
502 "But what should happen when code has already "
503 "been formatted but in the wrong way? Like "
504 "with a space at the end instead of the "
505 "beginning. Or what about when it is split too "
506 "soon? In the case of a split that is too "
507 "short, black will try to honer the custom "
519 "But what should happen when code has already been formatted but in the wrong"
520 " way? Like with a space at the end instead of the beginning. Or what about"
521 " when it is split too soon?"
527 "But what should happen when code has already "
528 r"been formatted but in the wrong way? Like "
529 "with a space at the end instead of the "
530 r"beginning. Or what about when it is split too "
531 r"soon? In the case of a split that is too "
532 "short, black will try to honer the custom "
540 inline_comments_func1(
541 "if there are inline comments in the middle "
542 # Here is the standard alone comment.
543 "of the implicitly concatenated string, we should handle them correctly",
547 inline_comments_func2(
548 "what if the string is very very very very very very very very very very long and"
549 " this part does not fit into a single line? "
550 # Here is the standard alone comment.
551 "then the string should still be properly handled by merging and splitting "
552 "it into parts that fit in line length.",
557 r"This is a long raw string. When re-formatting this string, black needs to make"
558 r" sure it prepends the 'r' onto the new string."
562 "We also need to be sure to preserve any and all {} which may or may not be"
563 " attached to the string in question.".format("method calls")
566 fmt_string2 = "But what about when the string is {} but {}".format(
568 "the method call is really really really really really really really really long?",
572 "While we are on the topic of %s, we should also note that old-style formatting"
573 " must also be preserved, since some %s still uses it." % ("formatting", "code")
576 old_fmt_string2 = "This is a %s %s %s %s" % (
577 "really really really really really",
579 "way to format strings!",
580 "Use f-strings instead!",
584 "Whereas only the strings after the percent sign were long in the last example,"
585 " this example uses a long initial string as well. This is another %s %s %s %s"
587 "really really really really really",
589 "way to format strings!",
590 "Use f-strings instead!",
595 f"f-strings definitely make things more {difficult} than they need to be for"
596 " {black}. But boy they sure are handy. The problem is that some lines will need"
597 f" to have the 'f' whereas others do not. This {line}, for example, needs one."
600 fstring_with_no_fexprs = (
601 f"Some regular string that needs to get split certainly but is NOT an fstring by"
602 f" any means whatsoever."
605 comment_string = ( # This comment gets thrown to the top.
606 "Long lines with inline comments should have their comments appended to the"
607 " reformatted string's enclosing right parentheses."
610 arg_comment_string = print(
611 "Long lines with inline comments which are apart of (and not the only member of) an"
612 " argument list should have their comments appended to the reformatted string's"
613 " enclosing left parentheses.", # This comment gets thrown to the top.
620 pragma_comment_string1 = "Lines which end with an inline pragma comment of the form `# <pragma>: <...>` should be left alone." # noqa: E501
622 pragma_comment_string2 = "Lines which end with an inline pragma comment of the form `# <pragma>: <...>` should be left alone." # noqa
624 """This is a really really really long triple quote string and it should not be touched."""
626 triple_quote_string = """This is a really really really long triple quote string assignment and it should not be touched."""
628 assert some_type_of_boolean_expression, (
629 "Followed by a really really really long string that is used to provide context to"
630 " the AssertionError exception."
633 assert some_type_of_boolean_expression, (
634 "Followed by a really really really long string that is used to provide context to"
635 " the AssertionError exception, which uses dynamic string {}.".format("formatting")
638 assert some_type_of_boolean_expression, (
639 "Followed by a really really really long string that is used to provide context to"
640 " the AssertionError exception, which uses dynamic string %s." % "formatting"
643 assert some_type_of_boolean_expression, (
644 "Followed by a really really really long string that is used to provide context to"
645 " the AssertionError exception, which uses dynamic %s %s."
646 % ("string", "formatting")
650 "With a reallly generic name and with a really really long string that is, at some"
651 " point down the line, "
653 + " to a variable and then added to another string."
657 "With a reallly generic name and with a really really long string that is, at some"
658 " point down the line, "
660 + " to a variable and then added to another string. But then what happens when the"
661 " final string is also supppppperrrrr long?! Well then that second (realllllllly"
662 " long) string should be split too.",
663 "and a second argument",
668 "A really really really really really really really really really really really"
669 " really really long {} {}".format("return", "value")
673 "This is a really long string argument to a function that has a trailing comma"
674 " which should NOT be there.",
678 "This is a really long string argument to a function that has a trailing comma"
679 " which should NOT be there.", # comment after comma
683 "This is a really long string argument to a function that has a trailing comma"
684 " which should NOT be there.",
688 "This is a really long string argument to a function that has a trailing comma"
689 " which should NOT be there.", # comment after comma
692 func_with_bad_parens_that_wont_fit_in_one_line(
693 "short string that should have parens stripped", x, y, z
696 func_with_bad_parens_that_wont_fit_in_one_line(
697 x, y, "short string that should have parens stripped", z
700 func_with_bad_parens(
701 "short string that should have parens stripped",
707 func_with_bad_parens(
710 "short string that should have parens stripped",
714 annotated_variable: Final = (
719 + "using the '+' operator."
721 annotated_variable: Final = (
722 "This is a large string that has a type annotation attached to it. A type"
723 " annotation should NOT stop a long string from being wrapped."
725 annotated_variable: Literal["fakse_literal"] = (
726 "This is a large string that has a type annotation attached to it. A type"
727 " annotation should NOT stop a long string from being wrapped."
731 "This is a really long string with \"embedded\" double quotes and 'single' quotes"
732 " that also handles checking for an even number of backslashes \\"
735 "This is a really long string with \"embedded\" double quotes and 'single' quotes"
736 " that also handles checking for an even number of backslashes \\\\"
739 "This is a really 'long' string with \"embedded double quotes\" and 'single' quotes"
740 ' that also handles checking for an odd number of backslashes \\", like'
744 short_string = "Hi there."
746 func_call(short_string="Hi there.")
748 raw_strings = r"Don't" " get" r" merged" " unless they are all raw."
753 "This is a really long string that can't possibly be expected to fit all"
754 " together on one line. In fact it may even take up three or more lines... like"
755 " four or five... but probably just three."
760 "This is a {really} long string that needs to be split without a doubt (i.e."
761 f" most definitely). In short, this {string} that can't possibly be {{expected}} to"
762 f" fit all together on one line. In {fact} it may even take up three or more"
763 " lines... like four or five... but probably just four."
766 long_unmergable_string_with_pragma = (
767 "This is a really long string that can't be merged because it has a likely pragma at the end" # type: ignore
771 long_unmergable_string_with_pragma = (
772 "This is a really long string that can't be merged because it has a likely pragma at the end" # noqa
776 long_unmergable_string_with_pragma = (
777 "This is a really long string that can't be merged because it has a likely pragma at the end" # pylint: disable=some-pylint-check
781 string_with_nameescape = (
782 "........................................................................"
786 string_with_nameescape = (
787 "..........................................................................."
791 string_with_nameescape = (
792 "............................................................................"
796 string_with_nameescape_and_escaped_backslash = (
797 "......................................................................"
801 string_with_nameescape_and_escaped_backslash = (
802 "........................................................................."
806 string_with_nameescape_and_escaped_backslash = (
807 ".........................................................................."
811 string_with_escaped_nameescape = (
812 "........................................................................ \\N{LAO"
816 string_with_escaped_nameescape = (
817 "..........................................................................."
823 f"this is a very very very long lambda value {x} that doesn't fit on a single"
828 dict_with_lambda_values = {
830 f"{j.__class__.__name__}({some_function_call(j.left)}, "
831 f"{some_function_call(j.right)})"
835 # Complex string concatenations with a method call in the middle.
839 " (%r, self.%s, visitor.%s)" % (attrname, attrname, visit_name)
840 for attrname, visit_name in names
846 # Test case of an outer string' parens enclose an inner string's parens.
847 call(body="%s %s" % (",".join(items), suffix))