fix issue-3405 by mkaraev · Pull Request #3411 · wemake-services/wemake-python-styleguide

mkaraev · 2025-05-08T19:53:07Z

I have made things!

Checklist

I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
I have created at least one test case for the changes I have made
I have updated the documentation for the changes I have made
I have added my changes to the CHANGELOG.md

Related issues

closes: #3405

sobolevn · 2025-05-09T09:57:47Z

 ### Features

 - Adds `WPS478`: forbids using non strict slice operations, #1011
+- Adds `WPS479`: forbids using multiline f strings, #3405


Suggested change

- Adds `WPS479`: forbids using multiline f strings, #3405

- Adds `WPS479`: forbids using multiline fstrings, #3405

sobolevn · 2025-05-09T10:00:36Z

+    MultilineFormattedStringTokenVisitor,
+)
+
+single_quote_formatted_string_wrong = """x=f'{ 1


Please, separete # Correct: and # Wrong: cases by comments. It would be easier to read

sobolevn · 2025-05-09T10:01:12Z

+@final
+class MultilineFormattedStringViolation(TokenizeViolation):
+    """
+    Forbid using multi-line formatted string with single and double quotes.


Please, add all required fields: reasoning, solution and examples.

sobolevn · 2025-05-09T10:01:20Z

        self._checker.check_string_modifiers(token, modifiers)
+
+
+class MultilineFormattedStringTokenVisitor(BaseTokenVisitor):


Suggested change

class MultilineFormattedStringTokenVisitor(BaseTokenVisitor):

@final

class MultilineFormattedStringTokenVisitor(BaseTokenVisitor):

sobolevn · 2025-05-09T10:01:55Z

+    """Checks incorrect formatted string usages."""
+
+    _multiline_fstring_pattern: ClassVar[re.Pattern[str]] = re.compile(
+        r'.*f([\'\"])(?!\1\1).*(\{.*\}.)*.*\{[^\}]*\n',


please use multiline regex with comments: I can't read it right now.

sobolevn · 2025-05-09T11:21:39Z

+        Multiline f-strings must use triple quotes for clarity; single f-strings may not span lines.
+
+    Solution:
+        Use  \"\"\" quotes instead of single quotes.


Suggested change

Use \"\"\" quotes instead of single quotes.

Use triple quotes instead of single quotes.

sobolevn · 2025-05-09T11:22:01Z

    Forbid using multi-line formatted string with single and double quotes.

+    Reasoning:
+        Multiline f-strings must use triple quotes for clarity; single f-strings may not span lines.


Suggested change

Multiline f-strings must use triple quotes for clarity; single f-strings may not span lines.

Multiline fstrings must use triple quotes for clarity; single fstrings must not span lines.

sobolevn · 2025-05-09T11:22:13Z

+        x = f\"\"\" { 1
+        ...}\"\"\"
+
+        # Wrong:
+        x = f\" { 1
+        ...}\"


Suggested change

x = f\"\"\" { 1

...}\"\"\"

# Wrong:

x = f\" { 1

...}\"

x = f'''{ 1

}'''

# Wrong:

x = f'{ 1

}'

codecov · 2025-05-09T11:25:32Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (214bbc0) to head (c84d410).
⚠️ Report is 80 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3411   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          362       362           
  Lines        11921     11933   +12     
  Branches       815       816    +1     
=========================================
+ Hits         11921     11933   +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

mkaraev · 2025-05-09T12:06:48Z

@sobolevn I've fixed all comments.

sobolevn

Almost done!

sobolevn · 2025-05-09T17:09:54Z

+    _multiline_fstring_pattern: ClassVar[re.Pattern[str]] = re.compile(
+        r"""
+        .*                  # (1) anything before the f-string
+        f(['"])             # (2) the `f` prefix + a single or double quote


there can also be a fr prefix. please, add a test case for it.

mkaraev · 2025-05-09T17:19:21Z

@sobolevn
For python 3.11 and python 3.10 checks I'm getting error that coverage is less than 100% for test file.
ERROR: Coverage failure: total of 99 is less than fail-under=100
However I've already added:

if not PY312:  # pragma: >=3.12 no cover
    pytest.skip(
        reason='unterminated string literal was added in 3.12',
        allow_module_level=True,
    )  # pragma: no cover

I don't understand why the pipelines are failing.
Could you please provide some information on how to fix them?

P.S. I've added suffix 312 to tests file name. I dont know if that would help :)

sobolevn · 2025-05-09T20:46:27Z

take a look at 5ea5c47 you need a 312 suffix

…tokens/test_mulitiline_formatted_string312.py

sobolevn · 2025-05-09T21:08:53Z

Thanks a lot!

mkaraev · 2025-05-10T04:14:12Z

@sobolevn Thanks for your comments and help. That was a really great experience. I will try to help with more contributions :)

sobolevn · 2025-05-10T06:13:00Z

Awesome, please, also check other projects :)

mkaraev added 2 commits May 9, 2025 00:52

fix issue-3405

18f9c8d

add changelog

01cc8ae

mkaraev mentioned this pull request May 8, 2025

Forbid multiline f and t strings #3405

Closed

mkaraev added 3 commits May 9, 2025 01:04

fix pre-commit errors

bdf72ee

fix pre-commit errors

493acf9

fix pre-commit errors

206e268

sobolevn reviewed May 9, 2025

View reviewed changes

mkaraev added 2 commits May 9, 2025 16:10

fix doc string and minor issues

bf54bc4

fix doc string and minor issues

1711987

sobolevn reviewed May 9, 2025

View reviewed changes

mkaraev added 4 commits May 9, 2025 16:41

check multiline fstring only for 3.12+

0025eed

split regex into multiple lines and add some comments

f22e4ab

split regex into multiple lines and add some comments

a380b90

cover for 3.12

28ea3eb

mkaraev requested a review from sobolevn May 9, 2025 12:07

sobolevn reviewed May 9, 2025

View reviewed changes

mkaraev added 2 commits May 9, 2025 22:35

fr prefixed formatted strings

43408af

fr prefixed formatted strings

27b393f

mkaraev requested a review from sobolevn May 9, 2025 17:39

make tests version specific

fad5f77

sobolevn approved these changes May 9, 2025

View reviewed changes

Comment thread ...tors/test_tokenize/test_primitives/test_string_tokens/test_mulitiline_formatted_string312.py Outdated

Update tests/test_visitors/test_tokenize/test_primitives/test_string_…

c84d410

…tokens/test_mulitiline_formatted_string312.py

sobolevn merged commit 1d95728 into wemake-services:master May 9, 2025
9 checks passed

mkaraev deleted the issue-3405-forbid-multiline-f-string branch May 10, 2025 04:20

	- Adds `WPS479`: forbids using multiline f strings, #3405
	- Adds `WPS479`: forbids using multiline fstrings, #3405

		self._checker.check_string_modifiers(token, modifiers)


		class MultilineFormattedStringTokenVisitor(BaseTokenVisitor):

	class MultilineFormattedStringTokenVisitor(BaseTokenVisitor):
	@final
	class MultilineFormattedStringTokenVisitor(BaseTokenVisitor):

	Use \"\"\" quotes instead of single quotes.
	Use triple quotes instead of single quotes.

	Multiline f-strings must use triple quotes for clarity; single f-strings may not span lines.
	Multiline fstrings must use triple quotes for clarity; single fstrings must not span lines.

Uh oh!

Conversation

mkaraev commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I have made things!

Checklist

Related issues

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mkaraev commented May 9, 2025

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mkaraev commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sobolevn commented May 9, 2025

Uh oh!

Uh oh!

Uh oh!

sobolevn commented May 9, 2025

Uh oh!

mkaraev commented May 10, 2025

Uh oh!

sobolevn commented May 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mkaraev commented May 8, 2025 •

edited

Loading

codecov Bot commented May 9, 2025 •

edited

Loading

mkaraev commented May 9, 2025 •

edited

Loading