Skip to main content

OpenStack Hacking Guideline Enforcement

Project description

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

The focus of new or changed rules should be to do one of the following

  • Substantially increase the reviewability of the code (eg: H301,2,3 as they make it easy to understand where symbols come from)

  • Catch a common programming error that may arrise in the future (H201)

  • Prevent a situation that would 100% of the time be -1ed by developers (H903)

But, as always, remember that these are Guidelines. Treat them as such. There are always times for exceptions. All new rules should support noqa.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hacking-0.10.0.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

hacking-0.10.0-py2.py3-none-any.whl (28.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file hacking-0.10.0.tar.gz.

File metadata

  • Download URL: hacking-0.10.0.tar.gz
  • Upload date:
  • Size: 41.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hacking-0.10.0.tar.gz
Algorithm Hash digest
SHA256 d4142ebfa3242e3f449dc393a40b17022f80a5c3eb34aa56153a0c49844c7c8a
MD5 ecd0dde25b837527fe6082db1a9c1663
BLAKE2b-256 fc8aca67a3daad7a4aa2093f67443617c0ef7a06a41de32bc908349874d7c0c6

See more details on using hashes here.

Provenance

File details

Details for the file hacking-0.10.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for hacking-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3781574659aa552cb246150ce24210fb23e2e504607c5b9da19957fdcb216aa7
MD5 0e7a588653721d752218e6df91fe60a6
BLAKE2b-256 469bbc6ae5362b725086c4f3793e1ef14bc83331958c8e84fed0565025ab538b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page