Package: isort
Read Latest Documentation-Browse GitHub Code Repositoryisort your imports, so you don't have to.isort is a Python utility / library to sort imports alphabetically and
automatically separate into sections and by type. It provides a command line
utility, Python library andplugins for various
editorsto
quickly sort all your imports. It requires Python 3.8+ to run but
supports formatting Python 2 code too.Try isort now from your browser!Using black? See the isort and black compatibility guide.isort has official support for pre-commit!Before isort:frommy_libimportObjectimportosfrommy_libimportObject3frommy_libimportObject2importsysfromthird_partyimportlib15,lib1,lib2,lib3,lib4,lib5,lib6,lib7,lib8,lib9,lib10,lib11,lib12,lib13,lib14importsysfrom__future__importabsolute_importfromthird_partyimportlib3print("Hey")print("yo")After isort:from__future__importabsolute_importimportosimportsysfromthird_partyimport(lib1,lib2,lib3,lib4,lib5,lib6,lib7,lib8,lib9,lib10,lib11,lib12,lib13,lib14,lib15)frommy_libimportObject,Object2,Object3print("Hey")print("yo")Installing isortInstalling isort is as simple as:pipinstallisortUsing isortFrom the command line:To run on specific files:isortmypythonfile.pymypythonfile2.pyTo apply recursively:isort.Ifglobstaris enabled,isort .is equivalent to:isort**/*.pyTo view proposed changes without applying them:isortmypythonfile.py--diffFinally, to atomically run isort against a project, only applying
changes if they don't introduce syntax errors:isort--atomic.(Note: this is disabled by default, as it prevents isort from
running against code written using a different version of Python.)From within Python:importisortisort.file("pythonfile.py")or:importisortsorted_code=isort.code("import b\nimport a\n")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.
Additionally, I will enthusiastically accept pull requests that include
plugins for other text editors and add documentation for them as I am
notified.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 has12 possible settings.IndentationTo 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:"    "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:from__future__import(absolute_import,division,print_function,unicode_literals)Will be produced instead of:from__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 Orderingisort provides configuration options to change almost every aspect of how
imports are organized, ordered, or grouped together in sections.Click herefor an overview of all these options.Skip 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:importmodule# isort:skipor:fromxyzimport(abc,# isort:skipyo,hey)To make isort skip an entire file simply addisort:skip_fileto the
module's doc string:""" my_module.pyBest module everisort:skip_file"""importbimportaAdding or removing an import from multiple filesisort can be ran or configured to add / remove imports automatically.See a complete guide here.Using isort to verify codeThe--check-onlyoptionisort can also be 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.isort**/*.py-c-v

SUCCESS:/home/timothy/Projects/Open_Source/isort/isort_kate_plugin.pyEverythingLooksGood!
ERROR:/home/timothy/Projects/Open_Source/isort/isort/isort.pyImportsareincorrectlysorted.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.More info here.Setuptools integrationUpon installation, isort enables asetuptoolscommand that checks
Python files declared by your project.More info here.Spread the wordPlace this badge at the top of your repository to let others know your project uses isort.For README.md:[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)Or README.rst:..image::https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336:target:https://pycqa.github.io/isort/Security contact informationTo report a security vulnerability, please use theTidelift security
contact. Tidelift will coordinate the
fix and disclosure.Why 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 :)Get professionally supported isort with the Tidelift
SubscriptionProfessional 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.Thanks and I hope you find isort useful!~Timothy Crosley