OpenStack Hacking Style Checks
Go to file
2013-06-02 11:38:07 +00:00
doc/source Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
hacking Fix tests to redirect stdout 2013-05-31 16:11:22 -07:00
.gitignore Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
.gitreview Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
.mailmap Add .mailmap file 2013-05-24 19:58:36 +00:00
.testr.conf Fix tests to redirect stdout 2013-05-31 16:11:22 -07:00
CONTRIBUTING.rst Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
HACKING.rst Add proper README for how to develop on hacking 2013-05-29 22:04:29 +00:00
LICENSE Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
MANIFEST.in Fix requirements distribution. 2013-03-19 13:26:22 -07:00
README.rst Add proper README for how to develop on hacking 2013-05-29 22:04:29 +00:00
requirements.txt Pin the versions of pep8/pyflakes here. 2013-05-29 17:45:10 +00:00
setup.cfg add check that python files have Apache 2.0 license stanza 2013-05-30 09:58:57 -04:00
setup.py Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
test-requirements.txt Add tests. 2013-03-19 17:12:30 -07:00
tox.ini python3: Introduce py33 to tox.ini 2013-06-01 20:10:11 -05:00

Introduction

hacking is a set of flake8 plugins that test and enforce the OpenStack Style Commandments, HACKING.rst.

Versioning

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.

Adding additional checks

Each check is a pep8 plugin so read

https://github.com/jcrocholl/pep8/blob/master/docs/developer.rst#contribute

Requirements

  • The canonical source of the OpenStack Style Commandments is HACKING.rst, and hacking just enforces them; so when adding a new check, it must be in HACKING.rst
  • False negatives are ok, but false positives are not
  • Cannot be project specific, project specific checks should be Local Checks
  • Docstring tests
  • Registered as entry_points in setup.cfg
  • Error code must be in the relevant Hxxx group

Local Checks

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. Like

[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