🔧 flake8: fix pre-commit errors #51
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
On Python 3.9.2 with the virtual environment ``` cachetools==5.2.1 certifi==2022.12.7 cfgv==3.3.1 chardet==5.1.0 charset-normalizer==3.0.1 colorama==0.4.6 distlib==0.3.6 docutils==0.19 filelock==3.9.0 flit==3.8.0 flit_core==3.8.0 identify==2.5.13 idna==3.4 nodeenv==1.7.0 packaging==23.0 pip==22.3.1 pkg_resources==0.0.0 platformdirs==2.6.2 pluggy==1.0.0 pre-commit==2.21.0 pyproject_api==1.4.0 PyYAML==6.0 requests==2.28.2 setuptools==65.7.0 tomli==2.0.1 tomli_w==1.0.0 tox==4.2.8 urllib3==1.26.14 virtualenv==20.17.1 wheel==0.38.4 ``` running ```shell pre-commit install --install-hooks pre-commit run --all ``` in the project root results in the output ```console (.venv) goxberry@penguin:~/repos/github.com/executable-books/rst-to-myst$ pre-commit run --all fix end of files.........................................................Passed mixed line ending........................................................Passed trim trailing whitespace.................................................Passed check yaml...............................................................Passed check toml...............................................................Passed check blanket noqa.......................................................Passed isort....................................................................Passed black....................................................................Passed flake8...................................................................Failed - hook id: flake8 - exit code: 1 rst_to_myst/states.py:148:21: B028 'conversion' is manually surrounded by quotes, consider using the `!r` conversion flag. rst_to_myst/states.py:163:17: B028 'type_name' is manually surrounded by quotes, consider using the `!r` conversion flag. rst_to_myst/states.py:350:17: B028 'subname' is manually surrounded by quotes, consider using the `!r` conversion flag. ``` This commit remediates those errors by adding the `!r` conversion flag to the brace expressions in the f-strings of the lines referenced in the output above. An alternative fix would be to add `B028` to the `extend-ignore` setting in the `[flake8]` section of `tox.ini` in the project root directory. Signed-off-by: Geoffrey M Oxberry <goxberry@gmail.com>
Codecov ReportBase: 84.48% // Head: 84.48% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
=======================================
Coverage 84.48% 84.48%
=======================================
Files 10 10
Lines 1637 1637
=======================================
Hits 1383 1383
Misses 254 254
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
Always helpful when someone fixes their own PR 😄 thanks |
chrisjsewell
changed the title
|
Congrats on your first merged pull request in this project! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On Python 3.9.2 with the virtual environment
running
in the project root results in the output
This commit remediates those errors by adding the
!rconversion flag to the brace expressions in the f-strings of the lines referenced in the output above.An alternative fix would be to add
B028to theextend-ignoresetting in the[flake8]section oftox.iniin the project root directory.It appears that this changeset (or the alternative discussed above) must be merged in order to be able to merge #50 without CI errors.
Signed-off-by: Geoffrey M Oxberry goxberry@gmail.com