hacking is a set of flake8 plugins that test and enforce the OpenStack Style Guidelines.
Hacking pins its dependencies, as a new release of some dependency can break hacking based gating jobs. This is because new versions of dependencies can introduce new rules, or make existing rules stricter.
hacking is available from pypi, so just run:
pip install hacking
This will install specific versions of flake8
with the hacking
,
pep8
, mccabe
and pyflakes
plugins.
Hacking started its life out as a text file in Nova’s first commit. It was initially based on the Google Python Style Guide, and over time more OpenStack specific rules were added. Hacking serves several purposes:
Initially the hacking style guide was enforced manually by reviewers, but this was a big waste of time so hacking, the tool, was born to automate the process and remove the extra burden from human reviewers.
hacking uses the major.minor.maintenance
release notation, where maintenance
releases cannot contain new checks. This way projects can gate on hacking
by pinning on the major.minor
number while accepting maintenance updates
without being concerned that a new version will break the gate with a new
check.
For example a project can depend on hacking>=0.10.0,<0.11.0
, and can know
that 0.10.1
will not fail in places where 0.10.0
passed.
Each check is a pep8 plugin so read
The focus of new or changed rules should be to do one of the following
But, as always, remember that these are Guidelines. Treat them as such. There are always times for exceptions. All new rules should support noqa.
If a check needs to be staged in, or it does not apply to every project or its branch, it can be added as off by default.
HACKING.rst
setup.cfg
Hxxx
groupSome of the available checks are disabled by default. These checks are:
To enable these checks, edit the flake8
section of the tox.ini
file.
For example to enable H106 and H203:
[flake8]
enable-extensions = H106,H203
hacking supports having local changes in a source tree. They can be configured to run in two different ways. They can be registered individually, or with a factory function.
For individual registration, put a comma separated list of pep8 compatible check functions into the hacking section of tox.ini. E.g.:
[hacking]
local-check = nova.tests.hacking.bad_code_is_terrible
Alternately, you can specify the location of a callable that will be called at registration time and will be passed the registration function. The callable should expect to call the passed in function on everything if wants to register. Such as:
[hacking]
local-check-factory = nova.tests.hacking.factory
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.