PEP8 clean only the parts of the files which you have touched since the last commit, previous commit or branch.
PEP8 clean only the parts of the files touched since the last commit, a previous commit or branch.
Fixing the entire project of PEP8 infractions (“PEP8 storms”) can lead to merge conflicts, add noise to merges / pull requests and break (git) blame. pep8radius solves this problem by fixing only those PEP8 infractions incontained on the lines of the project which you’ve been working, leaving these sections “better than you found it” whilst keeping your commits focused on the areas of the codebase you were actually working on.
$ pip install pep8radius
- Move to project directory
- Make some changes to the project
- Run pep8radius --diff # view a diff of proposed fixed
- Run pep8radius --in-place # apply the fixes
- Commit your changes
Against a branch you can use the same syntax as with git diff:
$ pep8radius master # branch name $ pep8radius c12166f # commit hash $ pep8radius master --in-place # these work with other options too
$ pep8radius --docformatter --diff
Note: can also use ``btyfi`` alias for ``pep8radius``.
usage: pep8radius.py [-h] [--version] [-v] [-d] [-i] [-p n] [-a] [--experimental] [--exclude globs] [--list-fixes] [--ignore errors] [--select errors] [--max-line-length n] [--indent-size n] [--docformatter] [--no-blank] [--pre-summary-newline] [--force-wrap] [rev] positional arguments: rev commit or name of branch to compare against optional arguments: -h, --help show this help message and exit --version print version number and exit -v, --verbose print verbose messages; multiple -v result in more verbose messages (passed to autopep8) -d, --diff print the diff for the fixed source -i, --in-place make the changes in place -f, --docformatter fix docstrings for PEP257 using docformatter -p n, --pep8-passes n maximum number of additional pep8 passes (default: infinite) -a, --aggressive enable non-whitespace changes; multiple -a result in more aggressive changes --experimental enable experimental fixes --exclude globs exclude file/directory names that match these comma- separated globs --list-fixes list codes for fixes; used by --ignore and --select --ignore errors do not fix these errors/warnings (default: E24) --select errors fix only these errors/warnings (e.g. E4,W) --max-line-length n set maximum allowed line length (default: 79) --indent-size n number of spaces per indent level (default 4) --no-blank do not add blank line after description; used by docformatter --pre-summary-newline add a newline before the summary of a multi-line docstring; used by docformatter --force-wrap force descriptions to be wrapped even if it may result in a mess; used by docformatter
For more information about these options see `autopep8 <https://pypi.python.org/pypi/autopep8>`__.