openstack
/
hacking
Code Issues Proposed changes
OpenStack Hacking Style Checks
798 Commits 6 Branches 41 Tags 5 MiB
Python 98.8%
Shell 1.2%
Go to file
Surojit Pathak 3af414c0c9 Fixing broken while loop in imports.py 
This commit is backporting commit 64ef5bf5. It could not be
cherry-picked, as the unit test code had lot more dependent code to be
pulled in.

Issue: flake8 occasionally encounters "H302  import only modules."
error even though the python module exists at the path and python
shell is able to import the same.

Root-cause: The while loop in is_module_for_sure() had a bug, where
iterating variable, 'mod_name', was getting derived from the same
input, 'mod', every time. It should have led to an infinite loop
otherwise. But, an ImportError takes it out of the loop. Most of
the cases, this is not an issue, if as part of the exception handler,
built-in __import__() finds the module. The evidence of the issue is
the availability of import statements suffixed with "# noqa" to
work-around the bug.

Fixing the while loop causes the logic to flow in the original path of
the code to use 'imp.find_module()'

Change-Id: I421a66242121b987b7c8c1568394478514073b87
 		2014-12-03 18:18:54 +00:00
doc/source Add link to readme at bottom of docs.openstack.org/developer/hacking/ 2014-05-06 12:25:06 -07:00
hacking Fixing broken while loop in imports.py 2014-12-03 18:18:54 +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 Set default gitreview branch 2014-10-27 11:45:02 -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 Clarify where the "following template" is 2014-06-04 17:17:49 +10: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 Add Installation section to the readme 2014-05-11 13:19:28 -07:00
requirements.txt Pin mccabe to prevent it from breaking hacking 2014-10-27 11:45:11 -07:00
setup.cfg Remove H901,H902 since it is a duplicate of H714,H713 2014-04-28 12:58:03 -07:00
setup.py Updated from global requirements 2014-04-30 02:37:33 +00:00
test-requirements.txt Updated from global requirements 2014-05-26 23:48:00 +00:00
tox.ini Cleanup hacking doc generation 2014-04-25 14:13:33 -07:00

README.rst

Introduction

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

Installation

hacking is available from pypi, so just run:

pip install hacking

This will install flake8 with the hacking and pyflake plugins

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