Tool for reordering python imports
Project description
reorder_python_imports
Tool for automatically reordering python imports. Similar to isort but
uses static analysis more.
Installation
pip install reorder-python-imports
Console scripts
Consult reorder-python-imports --help for the full set of options.
reorder-python-imports takes filenames as positional arguments
Common options:
--py##-plus: see below.--add-import/--remove-import: see below.--replace-import: see below.--application-directories: by default,reorder-python-importsassumes your project is rooted at.. If this isn't true, tell it where your import roots live. For example, when using the popular./srclayout you'd use--application-directories=.:src(note: multiple paths are separated using a:).
As a pre-commit hook
See pre-commit for instructions
Sample .pre-commit-config.yaml
- repo: https://github.com/asottile/reorder_python_imports
rev: v2.0.0
hooks:
- id: reorder-python-imports
What does it do?
Separates imports into three sections
import sys
import pyramid
import reorder_python_imports
becomes
import sys
import pyramid
import reorder_python_imports
import imports before from imports
from os import path
import sys
becomes
import sys
from os import path
Splits from imports
from os.path import abspath, exists
becomes
from os.path import abspath
from os.path import exists
Removes duplicate imports
import os
import os.path
import sys
import sys
becomes
import os.path
import sys
Using # noreorder
Lines containing and after lines which contain a # noreorder comment will
be ignored. Additionally any imports that appear after non-whitespace
non-comment lines will be ignored.
For instance, these will not be changed:
import sys
try: # not import, not whitespace
import foo
except ImportError:
pass
import sys
import reorder_python_imports
import matplotlib # noreorder
matplotlib.use('Agg')
import matplotlib.pyplot as plt
# noreorder
import sys
import pyramid
import reorder_python_imports
why this style?
The style chosen by reorder-python-imports has a single aim: reduce merge
conflicts.
By having a single import per line, multiple contributors can add / remove imports from a single module without resulting in a conflict.
Consider the following example which causes a merge conflict:
# developer 1
-from typing import Dict, List
+from typing import Any, Dict, List
# developer 2
-from typing import Dict, List
+from typing import Dict, List, Tuple
no conflict with the style enforced by reorder-python-imports:
+from typing import Any
from typing import Dict
from typing import List
+from typing import Tuple
Adding / Removing Imports
Let's say I want to enforce absolute_import across my codebase. I can use:
--add-import 'from __future__ import absolute_import'.
$ cat test.py
print('Hello world')
$ reorder-python-imports --add-import 'from __future__ import absolute_import' test.py
Reordering imports in test.py
$ cat test.py
from __future__ import absolute_import
print('Hello world')
Let's say I no longer care about supporting Python 2.5, I can remove
from __future__ import with_statement with
--remove-import 'from __future__ import with_statement'
$ cat test.py
from __future__ import with_statement
with open('foo.txt', 'w') as foo_f:
foo_f.write('hello world')
$ reorder-python-imports --remove-import 'from __future__ import with_statement' test.py
Reordering imports in test.py
$ cat test.py
with open('foo.txt', 'w') as foo_f:
foo_f.write('hello world')
Replacing imports
Imports can be replaced with others automatically (if they provide the same
names). This can be useful for factoring out compatibility libraries such
as six (see below for automated six rewriting).
This rewrite avoids NameErrors as such it only occurs when:
- the imported symbol is the same before and after
- the import is a
fromimport
The argument is specified as orig.mod=new.mod or with an optional
checked attribute orig.mod=new.mod:attr. The checked attribute is useful
for renaming some imports from a module instead of a full module.
For example:
# full module move
--replace-import six.moves.queue=queue
# specific attribute move
--replace-import six.moves=io:StringIO
Removing obsolete __future__ imports
The cli provides a few options to help "burn the bridges" with old python
versions by removing __future__ imports automatically. Each option implies
all older versions.
--py22-plus:nested_scopes--py23-plus:generators--py26-plus:with_statement--py3-plus:division,absolute_import,print_function,unicode_literals--py37-plus:generator_stop
Removing / rewriting obsolete six imports
With --py3-plus, reorder-python-imports will also remove / rewrite imports
from six. Rewrites follow the same rules as
replacing imports above.
For example:
+import queue
+from io import StringIO
+from urllib.parse import quote_plus
+
import six.moves.urllib.parse
-from six.moves import queue
-from six.moves import range
-from six.moves import StringIO
-from six.moves.urllib.parse import quote_plus
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file reorder_python_imports-2.0.0.tar.gz.
File metadata
- Download URL: reorder_python_imports-2.0.0.tar.gz
- Upload date:
- Size: 13.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce3a8e5caef9d0bb535c8b32204b6f12aa1c052469f355df2aac5f0e463f51a9 |
|
| MD5 | 5c56c5b624af22682859758e5af3176f |
|
| BLAKE2b-256 | ab1cdcd897bf8ad39ea18a9032218116af5d6d007de53d5ed8791197612a6df9 |
Provenance
File details
Details for the file reorder_python_imports-2.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: reorder_python_imports-2.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 11.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de680b4a04b8f9ebcc2a7ecbdc7bf698431589b9f0f288c396f38b124c3e8faa |
|
| MD5 | 249d071763769835c3ade967079d940a |
|
| BLAKE2b-256 | 40395750eedd95acdea5fb8474974b3fab44e503ae921d8d99b8592655a37faf |
