diff options
| author | Sean Mooney <work@seanmooney.info> | 2021-08-26 14:16:19 +0100 |
|---|---|---|
| committer | Sean Mooney <work@seanmooney.info> | 2021-11-08 12:37:27 +0000 |
| commit | f3d48000b139ec38d92da276a43a8387f76cbc89 (patch) | |
| tree | 4b1bbbf298d78b2dc00a6399766c9614d7f5e47e /.pre-commit-config.yaml | |
| parent | f024490e95c2bdb8072247e9907c6aa1475c80d8 (diff) | |
| download | nova-f3d48000b139ec38d92da276a43a8387f76cbc89.tar.gz | |
Add autopep8 to tox and pre-commit
autopep8 is a code formating tool that makes python code pep8
compliant without changing everything. Unlike black it will
not radically change all code and the primary change to the
existing codebase is adding a new line after class level doc strings.
This change adds a new tox autopep8 env to manually run it on your
code before you submit a patch, it also adds autopep8 to pre-commit
so if you use pre-commit it will do it for you automatically.
This change runs autopep8 in diff mode with --exit-code in the pep8
tox env so it will fail if autopep8 would modify your code if run
in in-place mode. This allows use to gate on autopep8 not modifying
patches that are submited. This will ensure authorship of patches is
maintianed.
The intent of this change is to save the large amount of time we spend
on ensuring style guidlines are followed automatically to make it
simpler for both new and old contibutors to work on nova and save
time and effort for all involved.
Change-Id: Idd618d634cc70ae8d58fab32f322e75bfabefb9d
Diffstat (limited to '.pre-commit-config.yaml')
| -rw-r--r-- | .pre-commit-config.yaml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 36274409c1..83fbb77920 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -33,3 +33,9 @@ repos: entry: flake8 files: '^.*\.py$' exclude: '^(doc|releasenotes|tools)/.*$' + + - repo: https://github.com/pre-commit/mirrors-autopep8 + rev: 'v1.5.7' + hooks: + - id: autopep8 + files: '^.*\.py$' |