Format code and docs with black+blacken-docs+pre-commit #244
Conversation
sloria
commented
Jul 9, 2018
•
sloria
commented
- Format code with black
- Format doc code blocks with blacken-docs. This uncovered a number of syntax issues in the docs.
- Run both with pre-commit
sloria
force-pushed
the
precommit
branch
4 times, most recently
from
c2574cb to
ff77a97
Compare
|
@asottile If you're feeling generous, feel free to give this a drive-by =). |
docs/conf.py
Outdated
| sys.path.insert(0, os.path.abspath('..')) | ||
| import webargs | ||
| sys.path.insert(0, os.path.abspath("..")) | ||
| import webargs # flake8: noqa |
There was a problem hiding this comment.
fun story about # flake8: noqa
I believe you want # noqa here (or # flake8: noqa on a line by itself if you actually don't want to lint this file)
setup.cfg
Outdated
| max-line-length = 100 | ||
| exclude = .git,.ropeproject,.tox,build,.direnv,__pycache__ | ||
| ignore = E203, E266, E501, W503, E302 | ||
| max-line-length = 80 |
There was a problem hiding this comment.
black I believe uses 88, though I see you've ignored E501 so I guess this line does nothing! :D
There was a problem hiding this comment.
Is it possible to use explicit names in there?
-ignore = E203, E266, E501, W503, E302
+ignore = rule-number-one, another-rule
There was a problem hiding this comment.
unfortunately not -- pylint has this but flake8 does not
There was a problem hiding this comment.
black I believe uses 88, though I see you've ignored E501 so I guess this line does nothing! :D
This is from the recommended flake8 config from black. E501 is ignored, but Bugbear's B901 is enabled, which will warn when the max-line-length exceeds 10% of max-line-length.
There was a problem hiding this comment.
are you using flake8-bugbear? I don't see it installed
There was a problem hiding this comment.
Ah, woops. Forgot to add that to dev-requirements.txt. Will fix this up after work today.
tasks.py
Outdated
|
|
||
| @task | ||
| def precommit(ctx): | ||
| ctx.run("pre-commit run --all-files", echo=True) |
There was a problem hiding this comment.
--show-diff-on-failure is usually a good option for CI's sake (helps drive-by contributors that might not have set up the linting locally)
My local environment is Python 3.5. Will this make |
Not necessarily, the hooks here are configured with |
|
Addressed @asottile 's comments and also added some notes in CONTRIBUTING.rst about needing the |
|
OK. This means that all contributors on Python 3.5 won't be able to use There's a trade-off, here. This commit adds more features to No big deal. If I can't run it locally, Travis will complain and I'll use my special ability ( |
|
@lafrech You can use Python 3.5 in your virtualenv and still use pre-commit as long as you have the With pyenv: |
