{"author":"Alex Stapleton","author_email":"alexs@prol.etari.at","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Framework :: Flake8","Intended Audience :: Developers","License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 2","Programming Language :: Python :: 3","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Software Development :: Quality Assurance"],"description":"flake8-import-order\n===================\n\n|Build Status|\n\nA `flake8 `__ and `Pylama\n`__ plugin that checks the ordering of\nyour imports. It does not check anything else about the\nimports. Merely that they are grouped and ordered correctly.\n\nIn general stdlib comes first, then 3rd party, then local packages,\nand that each group is individually alphabetized, however this depends\non the style used. Flake8-Import-Order supports a number of `styles\n<#styles>`_ and is extensible allowing for `custom styles\n<#extending-styles>`_.\n\nThis plugin was originally developed to match the style preferences of\nthe `cryptography `__ project,\nwith this style remaining the default.\n\nWarnings\n--------\n\nThis package adds 4 new flake8 warnings\n\n- ``I100``: Your import statements are in the wrong order.\n- ``I101``: The names in your from import are in the wrong order.\n- ``I201``: Missing newline between import groups.\n- ``I202``: Additional newline in a group of imports.\n\nStyles\n------\n\nThe following styles are directly supported,\n\n* ``cryptography`` - see an `example `__\n* ``google`` - style described in `Google Style Guidelines `__, see an `example `__\n* ``smarkets`` - style as ``google`` only with `import` statements before `from X import ...` statements, see an `example `__\n* ``appnexus`` - style as ``google`` only with `import` statements for packages local to your company or organisation coming after `import` statements for third-party packages, see an `example `__\n* ``edited`` - see an `example `__\n* ``pycharm`` - style as ``smarkets`` only with case sensitive sorting imported names\n* ``pep8`` - style that only enforces groups without enforcing the order within the groups\n\nYou can also `add your own style <#extending-styles>`_ by extending ``Style``\nclass.\n\nConfiguration\n-------------\n\nYou will want to set the ``application-import-names`` option to a\ncomma separated list of names that should be considered local to your\napplication. These will be used to help categorise your import\nstatements into the correct groups. Note that relative imports are\nalways considered local.\n\nYou will want to set the ``application-package-names`` option to a\ncomma separated list of names that should be considered local to your\ncompany or organisation, but which are obtained using some sort of\npackage manager like Pip, Apt, or Yum. Typically, code representing\nthe values listed in this option is located in a different repository\nthan the code being developed. This option is only accepted in the\nsupported ``appnexus`` or ``edited`` styles or in any style that\naccepts application package names.\n\nThe ``application-import-names`` and ``application-package-names`` can\ncontain namespaced packages or even exact nested module names. (This\nis possible with 0.16 onwards).\n\n``import-order-style`` controls what style the plugin follows\n(``cryptography`` is the default).\n\nLimitations\n-----------\n\nCurrently these checks are limited to module scope imports only.\nConditional imports in module scope will also be ignored.\n\nClassification of an imported module is achieved by checking the\nmodule against a stdlib list and then if there is no match against the\n``application-import-names`` list and ``application-package-names`` if\nthe style accepts application-package names. Only if none of these\nlists contain the imported module will it be classified as third\nparty.\n\nThese checks only consider an import against its previous import,\nrather than considering all the imports together. This means that\n``I100`` errors are only raised for the latter of adjacent imports out\nof order. For example,\n\n.. code-block:: python\n\n import X.B\n import X # I100\n import X.A\n\nonly ``import X`` raises an ``I100`` error, yet ``import X.A`` is also\nout of order compared with the ``import X.B``.\n\nImported modules are classified as stdlib if the module is in a\nvendored list of stdlib modules. This list is based on the latest\nrelease of Python and hence the results can be misleading. This list\nis also the same for all Python versions because otherwise it would\nbe impossible to write programs that work under both Python 2 and 3\n*and* pass the import order check.\n\nThe ``I202`` check will consider any blank line between imports to\ncount, even if the line is not contextually related to the\nimports. For example,\n\n.. code-block:: python\n\n import logging\n try:\n from logging import NullHandler\n except ImportError:\n class NullHandler(logging.Handler):\n \"\"\"Shim for version of Python < 2.7.\"\"\"\n\n def emit(self, record):\n pass\n import sys # I202 due to the blank line before the 'def emit'\n\nwill trigger a ``I202`` error despite the blank line not being\ncontextually related.\n\nExtending styles\n----------------\n\nYou can add your own style by extending ``flake8_import_order.styles.Style``\nclass. Here's an example:\n\n.. code-block:: python\n\n from flake8_import_order.styles import Cryptography\n\n\n class ReversedCryptography(Cryptography):\n # Note that Cryptography is a subclass of Style.\n\n @staticmethod\n def sorted_names(names):\n return reversed(Cryptography.sorted_names(names))\n\nBy default there are five import groupings or sections; future,\nstdlib, third party, application, and relative imports. A style can\nchoose to accept another grouping, application-package, by setting the\n``Style`` class variable ``accepts_application_package_names`` to\nTrue, e.g.\n\n.. code-block:: python\n\n class PackageNameCryptography(Cryptography):\n accepts_application_package_names = True\n\nTo make flake8-import-order able to discover your extended style, you need to\nregister it as ``flake8_import_order.styles`` using setuptools' `entry points\n`__\nmechanism:\n\n.. code-block:: python\n\n # setup.py of your style package\n setup(\n name='flake8-import-order-reversed-cryptography',\n ...,\n entry_points={\n 'flake8_import_order.styles': [\n 'reversed = reversedcryptography:ReversedCryptography',\n # 'reversed' is a style name. You can pass it to\n # --import-order-style option\n # 'reversedcryptography:ReversedCryptography' is an import path\n # of your extended style class.\n ]\n }\n )\n\n.. |Build Status| image:: https://travis-ci.org/PyCQA/flake8-import-order.svg?branch=master\n :target: https://travis-ci.org/PyCQA/flake8-import-order\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/PyCQA/flake8-import-order","keywords":"","license":"LGPLv3","license_expression":null,"license_files":null,"maintainer":"Phil Jones","maintainer_email":"philip.graham.jones+flake8-import@gmail.com","name":"flake8-import-order","package_url":"https://pypi.org/project/flake8-import-order/","platform":null,"project_url":"https://pypi.org/project/flake8-import-order/","project_urls":{"Homepage":"https://github.com/PyCQA/flake8-import-order"},"provides_extra":null,"release_url":"https://pypi.org/project/flake8-import-order/0.18.2/","requires_dist":["pycodestyle","setuptools","enum34 ; python_version <= \"2.7\""],"requires_python":"","summary":"Flake8 and pylama plugin that checks the ordering of import statements.","version":"0.18.2","yanked":false,"yanked_reason":null}

Dependencies of flake8-import-order (3).
Dependency	Optional
enum34	false
pycodestyle	false
setuptools	false

Package search

flake8-import-order

project_urls

Dependencies

All package metadata

Releases