openstack/hacking
Code Issues Proposed changes
OpenStack Hacking Style Checks
748 Commits 6 Branches 42 Tags 5.1 MiB
Python 98.7%
Shell 1.3%
bdeb807559
Go to file
Joe Gordon bdeb807559 Move comment checks into their own module 
hacking.core is getting too big, this is the first patch to pull out a
group of checks (H1xx) into their own module.

Change-Id: Ibd0668be59ce6a440b94788692d3784da24d70d8
2014-04-23 10:03:18 -07:00
doc/source Switch over to oslosphinx 2014-02-14 18:52:42 +01:00
hacking Move comment checks into their own module 2014-04-23 10:03:18 -07: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 Merge "Move hacking to pep8 1.5.6" 2014-04-22 12:21:43 +00:00
LICENSE Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
MANIFEST.in Move the hacking guidelines to sphinx docs 2013-09-20 16:09:39 -07:00
README.rst Minor README.rst tweaks 2014-04-09 15:35:37 -07:00
requirements.txt Merge "Updated from global requirements" 2014-04-22 12:34:04 +00:00
setup.cfg Move comment checks into their own module 2014-04-23 10:03:18 -07:00
setup.py Sync requirements with OS requirements 2013-10-08 11:12:20 +02:00
test-requirements.txt Updated from global requirements 2014-02-23 09:23:21 +00:00
tox.ini Add posargs to tox -epep8 2014-04-04 16:28:19 -07:00

README.rst

Introduction

hacking is a set of flake8 plugins that test and enforce the OpenStack Style Guidlines.

Origin

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

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

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 Guidelines is doc/source/index.rst, and hacking just enforces them; so when adding a new check, it must be in docs/source/index.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. 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