Issue #1081: non necessary raw strings #1178

Mema5 · 2020-02-23T18:10:01Z

First PR for our group

@fwald and I solved this issue today. We added the new rule along with tests and documentation. We also refactored old tests and enforced the new rule in the project.
Thank you for your answers!

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 Raw strings vs regular strings #1081

🙏 Please, if you or your company is finding wemake-python-styleguide valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/wemake-python-styleguide. As a thank you, your profile/company logo will be added to our main README which receives hundreds of unique visitors per day.

sobolevn · 2020-02-23T18:25:57Z

Wow! @Mema5, @Gwin73 thanks! I will review this shortly.

Offtop: can you please share your story behind this feature? Do you practice pair programming? Or is it a part of some kind of practice? And the most important question for me as a maintainer: why did you choose this project to contribute to?

You rock! 👾 🚀

Mema5 · 2020-02-23T18:39:12Z

Thank you, it is rewarding to receive such a positive feedback :)

Actually we are a group of 5 students (@fward @Gwin73 @Fils2 @ruwaid123 @Mema5) and we contribute as part of a course assignment. So yes, it is mostly to learn and gain experience on software engineering practices!
As for the project selection, we spent some time on that and we chose WPS for the following reasons. First, the project was active (thanks to you), the issues seemed interesting and reachable for us. Secondly, the building and testing were relatively easy from the documentation, thanks to poetry. Finally, the members of our team were pleased with the purpose of the project and keen on working in Python :)

The project will only last one week, but we are glad if it is useful!

sobolevn

Thanks a lot for your work! 👍
There are several minor things to polish and I will schedule this PR for 0.15 release.

CHANGELOG.md

tests/test_visitors/test_tokenize/test_primitives/test_string_tokens/test_string_modifier.py

wemake_python_styleguide/violations/consistency.py

sobolevn · 2020-02-23T18:50:40Z

wemake_python_styleguide/visitors/tokenize/primitives.py

+        modifiers, string_def = split_prefixes(token)
+
+        if 'r' in modifiers.lower():
+            if '\\' not in string_def.encode('unicode-escape').decode():


r'\' is better here.

Can you please also explain encode('unicode-escape').decode() part? Why is it required?

No, r'\' is not correct in Python I think.

Python 3.6.9 >>> a=r'\' File "<stdin>", line 1 a=r'\' ^ SyntaxError: EOL while scanning string literal >>>

The encode('unicode-escape').decode() is a workaround to convert into a raw string. (see here). If you know something more beautiful let me know!

Ok, about r'\' part 👍

Can you please test your code without encode('unicode-escape').decode()? Will it still work?

@Mema5 have you tried running tests without encode('unicode-escape').decode()? Did it work?

wemake_python_styleguide/visitors/tokenize/primitives.py

* CHANGELOG.md: new header for release 0.15.0 * added contribution * Related to PR wemake-services#1178

…make-services#1178

tests/fixtures/noqa/noqa.py

sobolevn · 2020-02-24T13:59:59Z

wemake_python_styleguide/visitors/tokenize/primitives.py

+        modifiers, string_def = split_prefixes(token)
+
+        if 'r' in modifiers.lower():
+            if '\\' not in string_def.encode('unicode-escape').decode():


@Mema5 have you tried running tests without encode('unicode-escape').decode()? Did it work?

…emake-services#1178

…s#1178

…e '\' character. If there is no '\' in the string a raw string should not be used. Closes issue #8 Relates to issue#1081 on the original repository

…edViolation (WPS357). Follows the general structure for documentation. Relates to original issue wemake-services#1081. Closes #11

relates to #11

…some cases to make the test pass. Related to issue #9

* CHANGELOG.md: new header for release 0.15.0 * added contribution * Related to PR wemake-services#1178

…make-services#1178

…emake-services#1178

…s#1178

sobolevn · 2020-02-25T07:46:39Z

@Mema5 can you please rebase your branch?

Mema5 · 2020-02-25T08:45:59Z

@sobolevn here it is!

sobolevn

Almost done! The last round of review.

There are just 3 minor notes and we are ready to go.
Thank you!

wemake_python_styleguide/violations/consistency.py

wemake_python_styleguide/visitors/tokenize/primitives.py

coveralls · 2020-02-25T13:57:16Z

Pull Request Test Coverage Report for Build 2656

10 of 10 (100.0%) changed or added relevant lines in 3 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 2650:	0.0%
Covered Lines:	5243
Relevant Lines:	5243

💛 - Coveralls

coveralls · 2020-02-25T13:57:17Z

Pull Request Test Coverage Report for Build 2664

10 of 10 (100.0%) changed or added relevant lines in 3 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 2650:	0.0%
Covered Lines:	5223
Relevant Lines:	5223

💛 - Coveralls

sobolevn

Thanks a lot! Your work will be merged into 0.15

codecov · 2020-10-20T14:50:11Z

Codecov Report

Merging #1178 into master will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #1178   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          105       105           
  Lines         5531      5540    +9     
  Branches      1224      1226    +2     
=========================================
+ Hits          5531      5540    +9

Impacted Files	Coverage Δ
wemake_python_styleguide/logic/naming/access.py	`100.00% <100.00%> (ø)`
wemake_python_styleguide/violations/consistency.py	`100.00% <100.00%> (ø)`
..._python_styleguide/visitors/tokenize/primitives.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 34b9004...f9a38f7. Read the comment docs.

Mema5 requested a review from sobolevn February 23, 2020 18:16

sobolevn requested changes Feb 23, 2020

View reviewed changes

Mema5 added a commit to adrwes/wemake-python-styleguide that referenced this pull request Feb 23, 2020

test: added a test for wrong case. PR wemake-services#1178

f3b5542

Mema5 added a commit to adrwes/wemake-python-styleguide that referenced this pull request Feb 24, 2020

Doc:

870f8be

* CHANGELOG.md: new header for release 0.15.0 * added contribution * Related to PR wemake-services#1178

Mema5 added a commit to adrwes/wemake-python-styleguide that referenced this pull request Feb 24, 2020

test: new tests for rule WPS357. Not passing for escaped quote. PR we…

d23bc65

…make-services#1178

sobolevn reviewed Feb 24, 2020

View reviewed changes

Mema5 added a commit to adrwes/wemake-python-styleguide that referenced this pull request Feb 24, 2020

fix: correct type and missing newline. PR wemake-services#1178

1e3e695

Mema5 added a commit to adrwes/wemake-python-styleguide that referenced this pull request Feb 24, 2020

tests: refactored tests that now all pass. Closes #9. Related to PR w…

5961039

…emake-services#1178

Mema5 added a commit to adrwes/wemake-python-styleguide that referenced this pull request Feb 24, 2020

doc: the previous usage was actually a wrong usage. PR wemake-service…

950119d

…s#1178

Mael MADON and others added 19 commits February 25, 2020 00:08

feat: added the new violation to be completed, closes #7

720b632

refac: refactor for flake8 consistancy, issue #7

44f757e

feat: implementing the new rule. Build yet to be debugged. Issue #9

c02aa31

test: added a test for violation WPS357. A raw string must contain th…

358f852

…e '\' character. If there is no '\' in the string a raw string should not be used. Closes issue #8 Relates to issue#1081 on the original repository

documentation: Added documentation for the violation RawStringNotNeed…

4dea657

…edViolation (WPS357). Follows the general structure for documentation. Relates to original issue wemake-services#1081. Closes #11

fix: Removed an unnecessary single quotation mark in the documentation

b1bb063

relates to #11

fix: repaired build a priori, issue #9

2ee8ce9

fix: adapted test suite to respect the new rule. Temporarily removed …

d3b8433

…some cases to make the test pass. Related to issue #9

fix: corrected the WPS warnings, issue #9

1af8ffc

fix: enforce the new rule WPS357 in the project itself

7b32af6

refac: old tests to match the new rule or ignore it, issue #9

e212e1a

refac: last refactoring. Closes #9

728ea0c

doc: changelogs for new rule

933610c

test: added a test for wrong case. PR wemake-services#1178

36c5889

fix: minor changes required for PR wemake-services#1187

7be3416

Doc:

c7a0d6f

* CHANGELOG.md: new header for release 0.15.0 * added contribution * Related to PR wemake-services#1178

test: new tests for rule WPS357. Not passing for escaped quote. PR we…

a0303c3

…make-services#1178

fix: correct type and missing newline. PR wemake-services#1178

80fa236

tests: refactored tests that now all pass. Closes #9. Related to PR w…

123f365

…emake-services#1178

Mema5 added 3 commits February 25, 2020 00:28

doc: the previous usage was actually a wrong usage. PR wemake-service…

4ad6970

…s#1178

refac: remove useless encode().decode()

6d56f17

merged and solve the conflits. All tests pass

14e8ce0

Mema5 force-pushed the issue-#1081 branch from 53c8cef to 14e8ce0 Compare February 25, 2020 08:37

sobolevn requested changes Feb 25, 2020

View reviewed changes

wemake_python_styleguide/violations/consistency.py Outdated Show resolved Hide resolved

wemake_python_styleguide/violations/consistency.py Outdated Show resolved Hide resolved

wemake_python_styleguide/visitors/tokenize/primitives.py Outdated Show resolved Hide resolved

Mema5 added 2 commits February 25, 2020 13:09

fix: minor changes for PR wemake-services#1178

eba9fef

fix: error linter wrong indentation, related to PR wemake-services#1178

4092355

sobolevn approved these changes Feb 25, 2020

View reviewed changes

sobolevn added the on hold label Feb 25, 2020

sobolevn added this to the Version 0.15 milestone Feb 25, 2020

Mema5 changed the title ~~Issue #1081~~ Issue #1081: non necessary raw strings Feb 26, 2020

fix: wrong error_template in for RawStringNotNeededViolation

ef727bf

sobolevn force-pushed the master branch from 4b1a202 to a0a009d Compare July 29, 2020 16:44

sobolevn added 3 commits October 20, 2020 17:36

Merge

708d92f

Fixes Ci

d374b5e

Fixes Ci

f9a38f7

sobolevn merged commit 9dd22ac into wemake-services:master Oct 20, 2020

sobolevn modified the milestones: Version 0.16, Version 0.15 aka New runtime Oct 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #1081: non necessary raw strings #1178

Issue #1081: non necessary raw strings #1178

Mema5 commented Feb 23, 2020

sobolevn commented Feb 23, 2020

Mema5 commented Feb 23, 2020

sobolevn left a comment

sobolevn Feb 23, 2020

sobolevn Feb 23, 2020

Mema5 Feb 23, 2020

sobolevn Feb 23, 2020 •

edited

sobolevn Feb 24, 2020

sobolevn Feb 24, 2020

sobolevn commented Feb 25, 2020

Mema5 commented Feb 25, 2020

sobolevn left a comment

coveralls commented Feb 25, 2020

coveralls commented Feb 25, 2020 •

edited

sobolevn left a comment

codecov bot commented Oct 20, 2020 •

edited

Issue #1081: non necessary raw strings #1178

Issue #1081: non necessary raw strings #1178

Conversation

Mema5 commented Feb 23, 2020

First PR for our group

Checklist

Related issues

sobolevn commented Feb 23, 2020

Mema5 commented Feb 23, 2020

sobolevn left a comment

Choose a reason for hiding this comment

sobolevn Feb 23, 2020

Choose a reason for hiding this comment

sobolevn Feb 23, 2020

Choose a reason for hiding this comment

Mema5 Feb 23, 2020

Choose a reason for hiding this comment

sobolevn Feb 23, 2020 • edited

Choose a reason for hiding this comment

sobolevn Feb 24, 2020

Choose a reason for hiding this comment

sobolevn Feb 24, 2020

Choose a reason for hiding this comment

sobolevn commented Feb 25, 2020

Mema5 commented Feb 25, 2020

sobolevn left a comment

Choose a reason for hiding this comment

coveralls commented Feb 25, 2020

Pull Request Test Coverage Report for Build 2656

💛 - Coveralls

coveralls commented Feb 25, 2020 • edited

Pull Request Test Coverage Report for Build 2664

💛 - Coveralls

sobolevn left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 20, 2020 • edited

Codecov Report

sobolevn Feb 23, 2020 •

edited

coveralls commented Feb 25, 2020 •

edited

codecov bot commented Oct 20, 2020 •

edited