OpenStack Hacking Style Checks
Go to file
2013-09-03 10:34:09 +00:00
doc/source Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
hacking Merge "Use the name for this attribute that exists on Python3" 2013-09-03 10:34:09 +00:00
integration-test Enable all checks during integration test 2013-06-06 09:35:33 -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 Fix typo in HACKING.rst 2013-08-05 19:14:10 -07:00
LICENSE Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
MANIFEST.in Include HACKING.rst in MANIFEST.in 2013-06-20 10:18:00 +01:00
README.rst Add information about the Google style guide 2013-07-14 15:43:47 -04:00
requirements.txt Update requirements 2013-08-23 15:00:00 +02:00
setup.cfg Add check for deprecated method assertEquals 2013-08-12 11:36:23 -03:00
setup.py Synced with global requirements 2013-08-07 18:35:34 -03:00
test-requirements.txt Update requirements 2013-08-23 15:00:00 +02:00
tox.ini Add pypy on tox envlist 2013-08-29 17:40:09 +02:00

Introduction

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

Origin

Most of the additional style guidelines that OpenStack has taken on came from the Google Python Style Guide.

http://google-styleguide.googlecode.com/svn/trunk/pyguide.html

Since then, a few more OpenStack specific ones have been added or modified.

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 check must already have community support. We do not want to dictate style, only enforce it.
  • 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