OpenStack Hacking Style Checks
Go to file
OpenDev Sysadmins dd96761cc5 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:33:16 +00:00
doc/source Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00
hacking Ignore import lines with noqa 2013-06-26 21:18:59 +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 OpenDev Migration Patch 2019-04-19 19:33:16 +00: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 update HACKING.rst to be OpenStack Style Commandments 2013-06-07 16:00:12 -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-26 21:18:40 +00: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 Disable H102 until ready to add new checks 2013-05-31 14:55:07 -07: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 Add local-check test 2013-06-07 15:43:25 -07:00

README.rst

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