python-hacking 0.12.0-0ubuntu1 / usr / lib / python2.7 / dist-packages / hacking-0.12.0.egg-info / PKG-INFO

This file is indexed.

/usr/lib/python2.7/dist-packages/hacking-0.12.0.egg-info/PKG-INFO is in python-hacking 0.12.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
Metadata-Version: 1.1
Name: hacking
Version: 0.12.0
Summary: OpenStack Hacking Guideline Enforcement
Home-page: http://docs.openstack.org/developer/hacking/
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
Description: Introduction
        ============
        
        hacking is a set of flake8 plugins that test and enforce the :ref:`StyleGuide`.
        
        Hacking pins its dependencies, as a new release of some dependency can break
        hacking based gating jobs. This is because new versions of dependencies can
        introduce new rules, or make existing rules stricter.
        
        Installation
        ============
        
        hacking is available from pypi, so just run:
        
          ``pip install hacking``
        
        This will install specific versions of ``flake8`` with the ``hacking``,
        ``pep8``, ``mccabe`` and ``pyflakes`` plugins.
        
        Origin
        ======
        
        Hacking started its life out as a text file in Nova's first commit. It was
        initially based on the `Google Python Style Guide`_, and over time more
        OpenStack specific rules were added. Hacking serves several purposes:
        
        1. Agree on a common style guide so reviews don't get bogged down on style
           nit picks. (example: docstring guidelines)
        2. Make code written by many different authors easier to read by making the
           style more uniform. (example: unix vs windows newlines)
        3. Call out dangerous patterns and avoid them. (example: shadowing built-in
           or reserved words)
        
        Initially the hacking style guide was enforced manually by reviewers, but this
        was a big waste of time so hacking, the tool, was born to automate
        the process and remove the extra burden from human reviewers.
        
        .. _`Google Python Style Guide`: https://google.github.io/styleguide/pyguide.html
        
        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.
        
        For example a project can depend on ``hacking>=0.10.0,<0.11.0``, and can know
        that ``0.10.1`` will not fail in places where ``0.10.0`` passed.
        
        
        Adding additional checks
        ========================
        
        Each check is a pep8 plugin so read
        
        - https://github.com/jcrocholl/pep8/blob/master/docs/developer.rst#contribute
        
        The focus of new or changed rules should be to do one of the following
        
        - Substantially increase the reviewability of the code (eg: H301, H303)
          as they make it easy to understand where symbols come from)
        - Catch a common programming error that may arise 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.
        
        If a check needs to be staged in, or it does not apply to every project or its
        branch, it can be added as off by default.
        
        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 :ref:`StyleGuide`,
          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`_
        - Include extensive tests
        - Registered as entry_points in `setup.cfg <setup.cfg>`_
        - Error code must be in the relevant ``Hxxx`` group
        - The check should not attempt to import modules from the code being checked.
          Importing random modules, has caused all kinds of trouble for us in the past.
        
        
        Enabling off-by-default checks
        ==============================
        
        Some of the available checks are disabled by default. These checks are:
        
        - [H106] Don't put vim configuration in source files.
        - [H203] Use assertIs(Not)None to check for None.
        - [H904] Delay string interpolations at logging calls.
        
        To enable these checks, edit the ``flake8`` section of the ``tox.ini`` file.
        For example to enable H106 and H203:
        
        .. code-block:: ini
        
          [flake8]
          enable-extensions = H106,H203
        
        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.:
        
        .. code-block:: ini
        
          [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:
        
        .. code-block:: ini
        
          [hacking]
          local-check-factory = nova.tests.hacking.factory
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4

APT Browse - Built by Thomas Orozco.