Skip to main content

Reorder import statements in Python files

Project description

travis-badge codecov-badge readthedocs-badge pypi-badge

Python Fix Imports is a Python executable that can automatically reorganize the import statements of your Python script, by splitting single import statement importing several package into as many import statement as imported module (“one import, one line” principle), and sorting these import statements respecting position of group of them.

The main advantage for this method is to strictly restrict the forms of import statement and facilitate multiple code branch merges and rebase, while still allowing to specify a given order if it is the wish of the developer.

Please read the full rational online documenation for more information.

Sublime Text 3 users can use my Python Fix Imports plugin.

Example

Fix imports allows you to automatically turn:

from any_module import d, f
from other_module import z, x
from any_module import (b,
                        e)
from any_module import a, \
                       c

from a_module_that_should_be import at, after, all_others

into:

from any_module import a
from any_module import b
from any_module import c
from any_module import d
from any_module import e
from any_module import f
from other_module import x
from other_module import z

from a_module_that_should_be import after
from a_module_that_should_be import all_others
from a_module_that_should_be import at

Fiximport installation

$ pip install fiximports

Development environment

$ virtualenv env
$ source env/bin/activate
$ pip install --upgrade -e .
$ pip install -r test-requirements.txt
$ python setup.py --version

Executing tests

$ python setup.py test

Updating AUTHORS, ChangeLog

Source distribution:

$ python setup.py sdist

Binary distribution:

$ python setup.py bdist

Wheels:

$ python setup.py bdist_wheel

Universal Wheels:

python setup.py bdist_wheel --universal

Update the dependencies for tests

$ pip-compile test-requirements.in

Generating the documentation

$ python setup.py docs

Release and upload to Pypi

Here is the manual release procedure.

  • Commit everything localy

  • Create the release tag

    git tag 0.?.?
  • Create you source distribution to regenerate ChangeLog properly

    $ python setup.py sdist
  • Overwrite the release tag

    git tag --force 0.?.?
  • Push to Github, create a release with the same tag

  • Build source and distribution:

    $ rm -rfv dist/*
    $ python setup.py bdist
    $ python setup.py bdist_wheel
    $ python setup.py bdist_wheel --universal
  • Upload distributions:

    $ twine upload dist/*

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

fiximports-0.1.11.dev1.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

fiximports-0.1.11.dev1-py2.py3-none-any.whl (19.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fiximports-0.1.11.dev1.tar.gz.

File metadata

File hashes

Hashes for fiximports-0.1.11.dev1.tar.gz
Algorithm Hash digest
SHA256 35409ac16c0fd4aa01503f5b40f2bccb6d31f695a9487adbd6a2556db2214989
MD5 11ed41c0c44566999c79f349a61867a2
BLAKE2b-256 a416402460028a32bb4d64741795410c8e6517b5502b96573bcffbc50d85173e

See more details on using hashes here.

File details

Details for the file fiximports-0.1.11.dev1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fiximports-0.1.11.dev1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 177bb60cd3fef4ada19af8812e048d4f829fa58df7f24f073fa6a249b28205ad
MD5 990eb10c648a6d01755e902670aa9934
BLAKE2b-256 ce9f3e045ca37d366d857c4e821ee1afbc66efcef8a193cd3190e96d46ecf0ef

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