Package: isort-black-compat
.. image::https://raw.github.com/timothycrosley/isort/master/logo.png:alt: isort########.. image::https://badge.fury.io/py/isort.svg:target:https://badge.fury.io/py/isort:alt: PyPI version.. image::https://travis-ci.org/timothycrosley/isort.svg?branch=master:target:https://travis-ci.org/timothycrosley/isort:alt: Build Status.. image::https://codecov.io/gh/timothycrosley/isort/branch/develop/graph/badge.svg:target:https://codecov.io/gh/timothycrosley/isort:alt: Code coverage Status.. image::https://img.shields.io/github/license/mashape/apistatus.svg:target:https://pypi.org/project/hug/:alt: License.. image::https://badges.gitter.im/Join%20Chat.svg:alt: Join the chat athttps://gitter.im/timothycrosley/isort:target:https://gitter.im/timothycrosley/isort?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge.. image::https://pepy.tech/badge/isort:alt: Downloads
:target:https://pepy.tech/project/isortisort your python imports for you so you don't have to.isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections.
It provides a command line utility, Python library andplugins for various editors <https://github.com/timothycrosley/isort/wiki/isort-Plugins>_ to quickly sort all your imports.
It requires Python 3.5+ to run but supports formatting Python 2 code too.########Get professionally supported isort with the Tidelift Subscription <https://tidelift.com/subscription/pkg/pypi-isort?utm_source=pypi-isort&utm_medium=referral&utm_campaign=readme>_Professional support for isort is available as part of theTidelift Subscription_.  Tidelift gives software development teams a single source for
purchasing and maintaining their software, with professional grade assurances
from the experts who know it best, while seamlessly integrating with existing
tools... _Tidelift Subscription:https://tidelift.com/subscription/pkg/pypi-isort?utm_source=pypi-isort&utm_medium=referral&utm_campaign=readme########.. image::https://raw.github.com/timothycrosley/isort/develop/example.gif:alt: Example UsageBefore isort:.. code-block:: pythonfrom my_lib import Object

print("Hey")

import os

from my_lib import Object3

from my_lib import Object2

import sys

from third_party import lib15, lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8, lib9, lib10, lib11, lib12, lib13, lib14

import sys

from __future__ import absolute_import

from third_party import lib3

print("yo")After isort:.. code-block:: pythonfrom __future__ import absolute_import

import os
import sys

from third_party import (lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8,
                         lib9, lib10, lib11, lib12, lib13, lib14, lib15)

from my_lib import Object, Object2, Object3

print("Hey")
print("yo")Installing isortInstalling isort is as simple as:.. code-block:: bashpip install isortInstall isort with requirements.txt support:.. code-block:: bashpip install isort[requirements]Install isort with Pipfile support:.. code-block:: bashpip install isort[pipfile]Install isort with both formats support:.. code-block:: bashpip install isort[requirements,pipfile]Using isortFrom the command line:.. code-block:: bashisort mypythonfile.py mypythonfile2.pyor recursively:.. code-block:: bashisort -rc .which is equivalent to:.. code-block:: bashisort **/*.pyor to see the proposed changes without applying them:.. code-block:: bashisort mypythonfile.py --diffFinally, to atomically run isort against a project, only applying changes if they don't introduce syntax errors do:.. code-block:: bashisort -rc --atomic .(Note: this is disabled by default as it keeps isort from being able to run against code written using a different version of Python)From within Python:.. code-block:: bashfrom isort import SortImports

SortImports("pythonfile.py")or:.. code-block:: bashfrom isort import SortImports

new_contents = SortImports(file_contents=old_contents).outputFrom within Kate:.. code-block:: bashctrl+[or:.. code-block:: bashmenu > Python > Sort ImportsInstalling isort's Kate pluginFor KDE 4.13+ / Pate 2.0+:.. code-block:: bashwget https://raw.github.com/timothycrosley/isort/master/kate_plugin/isort_plugin.py --output-document ~/.kde/share/apps/kate/pate/isort_plugin.py
wget https://raw.github.com/timothycrosley/isort/master/kate_plugin/isort_plugin_ui.rc --output-document ~/.kde/share/apps/kate/pate/isort_plugin_ui.rc
wget https://raw.github.com/timothycrosley/isort/master/kate_plugin/katepart_isort.desktop --output-document ~/.kde/share/kde4/services/katepart_isort.desktopFor all older versions:.. code-block:: bashwget https://raw.github.com/timothycrosley/isort/master/kate_plugin/isort_plugin_old.py --output-document ~/.kde/share/apps/kate/pate/isort_plugin.pyYou will then need to restart kate and enable Python Plugins as well as the isort plugin itself.Installing isort's for your preferred text editorSeveral plugins have been written that enable to use isort from within a variety of text-editors.
You can find a full list of themon the isort wiki <https://github.com/timothycrosley/isort/wiki/isort-Plugins>_.
Additionally, I will enthusiastically accept pull requests that include plugins for other text editors
and add documentation for them as I am notified.How does isort work?isort parses specified files for global level import lines (imports outside of try / except blocks, functions, etc..)
and puts them all at the top of the file grouped together by the type of import:FuturePython Standard LibraryThird PartyCurrent Python ProjectExplicitly Local (. before import, as in:from . import x)Custom Separate Sections (Defined by forced_separate list in configuration file)Custom Sections (Defined by sections list in configuration file)Inside of each section the imports are sorted alphabetically. isort automatically removes duplicate python imports,
and wraps long from imports to the specified line length (defaults to 79).When will isort not work?If you ever have the situation where you need to have a try / except block in the middle of top-level imports or if
your import order is directly linked to precedence.For example: a common practice in Django settings files is importing * from various settings files to form
a new settings file. In this case if any of the imports change order you are changing the settings definition itself.However, you can configure isort to skip over just these files - or even to force certain imports to the top.Configuring isortIf you find the default isort settings do not work well for your project, isort provides several ways to adjust
the behavior.To configure isort for a single user create a~/.isort.cfgor$XDG_CONFIG_HOME/isort.cfgfile:.. code-block:: ini[settings]
line_length=120
force_to_top=file1.py,file2.py
skip=file3.py,file4.py
known_future_library=future,pies
known_standard_library=std,std2
known_third_party=randomthirdparty
known_first_party=mylib1,mylib2
indent='    '
multi_line_output=3
length_sort=1
forced_separate=django.contrib,django.utils
default_section=FIRSTPARTY
no_lines_before=LOCALFOLDERAdditionally, you can specify project level configuration simply by placing a.isort.cfgfile at the root of your
project. isort will look up to 25 directories up, from the file it is ran against, to find a project specific configuration.Or, if you prefer, you can add anisortortool:isortsection to your project'ssetup.cfgortox.inifile with any desired settings.You can also add your desired settings under a[tool.isort]section in yourpyproject.tomlfile.You can then override any of these settings by using command line arguments, or by passing in override values to the
SortImports class.Finally, as of version 3.0 isort supports editorconfig files using the standard syntax defined here:https://editorconfig.org/Meaning you place any standard isort configuration parameters within a .editorconfig file under the*.pysection
and they will be honored.For a full list of isort settings and their meaningstake a look at the isort wiki <https://github.com/timothycrosley/isort/wiki/isort-Settings>_.Multi line output modesYou will notice above the "multi_line_output" setting. This setting defines how from imports wrap when they extend
past the line_length limit and has 6 possible settings:0 - Grid.. code-block:: pythonfrom third_party import (lib1, lib2, lib3,
                         lib4, lib5, ...)1 - Vertical.. code-block:: pythonfrom third_party import (lib1,
                         lib2,
                         lib3
                         lib4,
                         lib5,
                         ...)2 - Hanging Indent.. code-block:: pythonfrom third_party import \
    lib1, lib2, lib3, \
    lib4, lib5, lib63 - Vertical Hanging Indent.. code-block:: pythonfrom third_party import (
    lib1,
    lib2,
    lib3,
    lib4,
)4 - Hanging Grid.. code-block:: pythonfrom third_party import (
    lib1, lib2, lib3, lib4,
    lib5, ...)5 - Hanging Grid Grouped.. code-block:: pythonfrom third_party import (
    lib1, lib2, lib3, lib4,
    lib5, ...
)6 - Hanging Grid Grouped, No Trailing CommaIn Mode 5 isort leaves a single extra space to maintain consistency of output when a comma is added at the end.
Mode 6 is the same - except that no extra space is maintained leading to the possibility of lines one character longer.
You can enforce a trailing comma by using this in conjunction with-tcorinclude_trailing_comma: True... code-block:: pythonfrom third_party import (
    lib1, lib2, lib3, lib4,
    lib5
)7 - NOQA.. code-block:: pythonfrom third_party import lib1, lib2, lib3, ...  # NOQAAlternatively, you can setforce_single_linetoTrue(-slon the command line) and every import will appear on its
own line:.. code-block:: pythonfrom third_party import lib1
from third_party import lib2
from third_party import lib3
...Note: to change the how constant indents appear - simply change the indent property with the following accepted formats:Number of spaces you would like. For example: 4 would cause standard 4 space indentation.TabA verbatim string with quotes around it.For example:.. code-block:: python"    "is equivalent to 4.For the import styles that use parentheses, you can control whether or not to
include a trailing comma after the last import with theinclude_trailing_commaoption (defaults toFalse).Intelligently Balanced Multi-line ImportsAs of isort 3.1.0 support for balanced multi-line imports has been added.
With this enabled isort will dynamically change the import length to the one that produces the most balanced grid,
while staying below the maximum import length defined.Example:.. code-block:: pythonfrom __future__ import (absolute_import, division,
                        print_function, unicode_literals)Will be produced instead of:.. code-block:: pythonfrom __future__ import (absolute_import, division, print_function,
                        unicode_literals)To enable this setbalanced_wrappingtoTruein your config or pass the-eoption into the command line utility.Custom Sections and OrderingYou can change the section order withsectionsoption from the default of:.. code-block:: iniFUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDERto your preference:.. code-block:: inisections=FUTURE,STDLIB,FIRSTPARTY,THIRDPARTY,LOCALFOLDERYou also can define your own sections and their order.Example:.. code-block:: iniknown_django=django
known_pandas=pandas,numpy
sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,PANDAS,FIRSTPARTY,LOCALFOLDERwould create two new sections with the specified known modules.Theno_lines_beforeoption will prevent the listed sections from being split from the previous section by an empty line.Example:.. code-block:: inisections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
no_lines_before=LOCALFOLDERwould produce a section with both FIRSTPARTY and LOCALFOLDER modules combined.Auto-comment import sectionsSome projects prefer to have import sections uniquely titled to aid in identifying the sections quickly
when visually scanning. isort can automate this as well. To do this simply set theimport_heading_{section_name}setting for each section you wish to have auto commented - to the desired comment.For Example:.. code-block:: iniimport_heading_stdlib=Standard Library
import_heading_firstparty=My StuffWould lead to output looking like the following:.. code-block:: python# Standard Library
import os
import sys

import django.settings

# My Stuff
import myproject.testOrdering by import lengthisort also makes it easy to sort your imports by length, simply by setting thelength_sortoption toTrue.
This will result in the following output style:.. code-block:: pythonfrom evn.util import (
    Pool,
    Dict,
    Options,
    Constant,
    DecayDict,
    UnexpectedCodePath,
)It is also possible to opt-in to sorting imports by length for only specific
sections by usinglength_sort_followed by the section name as a
configuration item, e.g.::length_sort_stdlib=1Skip processing of imports (outside of configuration)To make isort ignore a single import simply add a comment at the end of the import line containing the textisort:skip:.. code-block:: pythonimport module  # isort:skipor:.. code-block:: pythonfrom xyz import (abc,  # isort:skip
                 yo,
                 hey)To make isort skip an entire file simply addisort:skip_fileto the module's doc string:.. code-block:: python""" my_module.py
    Best module ever

   isort:skip_file
"""

import b
import aAdding an import to multiple filesisort makes it easy to add an import statement across multiple files, while being assured it's correctly placed.From the command line:.. code-block:: bashisort -a "from __future__ import print_function" *.pyfrom within Kate:.. code-block::ctrl+]or:.. code-block::menu > Python > Add ImportRemoving an import from multiple filesisort also makes it easy to remove an import from multiple files, without having to be concerned with how it was originally
formatted.From the command line:.. code-block:: bashisort -rm "os.system" *.pyfrom within Kate:.. code-block::ctrl+shift+]or:.. code-block::menu > Python > Remove ImportUsing isort to verify codeThe--check-onlyoptionisort can also be used to used to verify that code is correctly formatted by running it with-c.
Any files that contain incorrectly sorted and/or formatted imports will be outputted tostderr... code-block:: bashisort **/*.py -c -vb

SUCCESS: /home/timothy/Projects/Open_Source/isort/isort_kate_plugin.py Everything Looks Good!
ERROR: /home/timothy/Projects/Open_Source/isort/isort/isort.py Imports are incorrectly sorted.One great place this can be used is with a pre-commit git hook, such as this one by @acdha:https://gist.github.com/acdha/8717683This can help to ensure a certain level of code quality throughout a project.Git hookisort provides a hook function that can be integrated into your Git pre-commit script to check
Python code before committing.To cause the commit to fail if there are isort errors (strict mode), include the following in.git/hooks/pre-commit:.. code-block:: python#!/usr/bin/env python
import sys
from isort.hooks import git_hook

sys.exit(git_hook(strict=True, modify=True))If you just want to display warnings, but allow the commit to happen anyway, callgit_hookwithout
thestrictparameter. If you want to display warnings, but not also fix the code, callgit_hookwithout
themodifyparameter.Setuptools integrationUpon installation, isort enables asetuptoolscommand that checks Python files
declared by your project.Runningpython setup.py isorton the command line will check the files
listed in yourpy_modulesandpackages.  If any warning is found,
the command will exit with an error code:.. code-block:: bash$ python setup.py isortAlso, to allow users to be able to use the command without having to install
isort themselves, add isort to the setup_requires of yoursetup()like so:.. code-block:: pythonsetup(
    name="project",
    packages=["project"],

    setup_requires=[
        "isort"
    ]
)Security contact informationTo report a security vulnerability, please use theTidelift security contact_. Tidelift will coordinate the fix and disclosure... _Tidelift security contact:https://tidelift.com/securityWhy isort?isort simply stands for import sort. It was originally called "sortImports" however I got tired of typing the extra
characters and came to the realization camelCase is not pythonic.I wrote isort because in an organization I used to work in the manager came in one day and decided all code must
have alphabetically sorted imports. The code base was huge - and he meant for us to do it by hand. However, being a
programmer - I'm too lazy to spend 8 hours mindlessly performing a function, but not too lazy to spend 16
hours automating it. I was given permission to open source sortImports and here we are :)Thanks and I hope you find isort useful!~Timothy Crosley