Skip to main content

Check python import order.

Project description

Wheel Status Supported Python versions Latest Version

CLI that check the ordering of imports. ordering follow a below rules.

  1. Module order: __future__ , standard libraries, site-packages, local.

  2. CONSTANT_NAMES must be the first.

  3. ClassNames must be the second.

  4. Rest must be in alphabetical order.

Requirements

  • Python 2.7.x or Python 3.3+

How to install

Via pip

$ pip install -U import-order

Or clone source code from repository and install it.

$ git clone https://github.com/spoqa/import-order.git
$ cd import_order
$ python setup.py install # or pip install .

How to use

Use import-order to check your python codes. If you want to check your local package named foo in root directory of package.

$ import-order foo

If you check your directory bar with local packages ( foo , baz ).

$ import-order foo ./bar baz

Or you can check your directory bar , file some.py without local packages (if --only-file is missing, it will raise ValueError ).

$ import-order --only-file ./bar some.py

For more information, look around help command.

$ import-order --help

When you ignore order on purpose, simply add # no import order at the import statement.

from foo.bar import b, a, c  # no import order

Author and license

import-order is maintained by Spoqa, and licensed under GPL3 or later.

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

import-order-0.0.3.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

import_order-0.0.3-py2.py3-none-any.whl (9.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file import-order-0.0.3.tar.gz.

File metadata

File hashes

Hashes for import-order-0.0.3.tar.gz
Algorithm Hash digest
SHA256 073bccf06ba29872a428c8db32373ac8552eccae0678353bca081553d3d8f4a2
MD5 bc707229898d886cd38ec407e7c44095
BLAKE2b-256 1acbad7bc5da896b6cb3983a3008be624c16763f02fd99205d953ad6b47964da

See more details on using hashes here.

File details

Details for the file import_order-0.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for import_order-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 92ded7bbc623244e877f6231e43aa00f32068943e0072d6b8b450f3a9279f7c1
MD5 9b435ab76765d199fc246f4e23a2c6f2
BLAKE2b-256 b9bc963f184278aff10fc8c68fffee9f3bb8e25091f480c16d74b7b3fc397161

See more details on using hashes here.

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