Skip to content


isort documentation

isort - GitHub

Configuration in Mega-Linter

Variable Description Default value
PYTHON_ISORT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
PYTHON_ISORT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src|lib)
Include every file
PYTHON_ISORT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test|examples)
Exclude no file
PYTHON_ISORT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
PYTHON_ISORT_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
PYTHON_ISORT_CONFIG_FILE isort configuration file name
Use LINTER_DEFAULT to let the linter find it
PYTHON_ISORT_RULES_PATH Path where to find linter configuration file Workspace folder, then Mega-Linter default rules
PYTHON_ISORT_DISABLE_ERRORS Run linter but consider errors as warnings true

IDE Integration

Use isort in your favorite IDE to catch errors before Mega-Linter !

IDE Extension Name Install
Atom atom-python-isort Visit Web Site
Atom atom-isort Visit Web Site
Emacs py-isort.el Visit Web Site
Sublime Text isort plugin Visit Web Site
vim ale Visit Web Site
vim vim-isort Visit Web Site
Visual Studio Code VsCode Python Extension Visit Web Site

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 83 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 43 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .py

Example calls

isort --diff --check --profile black
isort --diff --check --profile black --settings-file .isort.cfg
isort --profile black --settings-file .isort.cfg

Help content

usage: isort [-h] [-V] [--vn] [-v] [--only-modified] [--dedup-headings] [-q]
             [-d] [--show-config] [--show-files] [--df] [-c] [--ws]
             [--sp SETTINGS_PATH] [--profile PROFILE] [--old-finders]
             [-j JOBS] [--ac] [--interactive] [--filter-files] [-s SKIP]
             [--sg SKIP_GLOB] [--gitignore] [--ext SUPPORTED_EXTENSIONS]
             [--blocked-extension BLOCKED_EXTENSIONS] [--dont-follow-links]
             [--filename FILENAME] [-a ADD_IMPORTS] [--append] [--af]
             [--rm REMOVE_IMPORTS] [--float-to-top] [--dont-float-to-top]
             [--ca] [--cs] [-e] [--ff FROM_FIRST] [--fgw [FORCE_GRID_WRAP]]
             [-i INDENT] [--lai LINES_AFTER_IMPORTS]
             [--lbt LINES_BETWEEN_TYPES] [--le LINE_ENDING] [--ls] [--lss]
             [-n] [--nis] [--ot] [--dt] [--rr] [--sl]
             [--nsl SINGLE_LINE_EXCLUSIONS] [--tc] [--up] [-l LINE_LENGTH]
             [--wl WRAP_LENGTH] [--case-sensitive]
             [--remove-redundant-aliases] [--honor-noqa]
             [--treat-comment-as-code TREAT_COMMENTS_AS_CODE]
             [--treat-all-comment-as-code] [--formatter FORMATTER] [--color]
             [--ext-format EXT_FORMAT] [--sd DEFAULT_SECTION]
             [--only-sections] [--ds] [--fas] [--fss] [--fass]
             [-t FORCE_TO_TOP] [--combine-straight-imports]
             [--nlb NO_LINES_BEFORE] [--src SRC_PATHS]
             [-b KNOWN_STANDARD_LIBRARY]
             [--extra-builtin EXTRA_STANDARD_LIBRARY]
             [-p KNOWN_FIRST_PARTY] [--known-local-folder KNOWN_LOCAL_FOLDER]
             [--virtual-env VIRTUAL_ENV] [--conda-env CONDA_ENV]
             [--py {all,2,27,3,35,36,37,38,39,auto}]
             [files [files ...]]

Sort Python import definitions alphabetically within logical sections. Run
with no arguments to see a quick start guide, otherwise, one or more
files/directories/stdin must be provided. Use `-` as the first argument to
represent stdin. Use --interactive to use the pre 5.0.0 interactive behavior.
If you've used isort 4 but are new to isort 5, see the upgrading

general options:
  -h, --help            show this help message and exit
  -V, --version         Displays the currently installed version of isort.
  --vn, --version-number
                        Returns just the current version number without the
  -v, --verbose         Shows verbose output, such as when files are skipped
                        or when a check is successful.
  --only-modified, --om
                        Suppresses verbose output for non-modified files.
  --dedup-headings      Tells isort to only show an identical custom import
                        heading comment once, even if there are multiple
                        sections with the comment set.
  -q, --quiet           Shows extra quiet output, only errors are outputted.
  -d, --stdout          Force resulting output to stdout, instead of in-place.
  --show-config         See isort's determined config, as well as sources of
                        config options.
  --show-files          See the files isort will be ran against with the
                        current config options.
  --df, --diff          Prints a diff of all the changes isort would make to a
                        file, instead of changing it in place
  -c, --check-only, --check
                        Checks the file for unsorted / unformatted imports and
                        prints them to the command line without modifying the
                        file. Returns 0 when nothing would change and returns
                        1 when the file would be reformatted.
  --ws, --ignore-whitespace
                        Tells isort to ignore whitespace differences when
                        --check-only is being used.
  --sp SETTINGS_PATH, --settings-path SETTINGS_PATH, --settings-file SETTINGS_PATH, --settings SETTINGS_PATH
                        Explicitly set the settings path or file instead of
                        auto determining based on file location.
  --profile PROFILE     Base profile type to use for configuration. Profiles
                        include: black, django, pycharm, google, open_stack,
                        plone, attrs, hug. As well as any shared profiles.
  --old-finders, --magic-placement
                        Use the old deprecated finder logic that relies on
                        environment introspection magic.
  -j JOBS, --jobs JOBS  Number of files to process in parallel.
  --ac, --atomic        Ensures the output doesn't save if the resulting file
                        contains syntax errors.
  --interactive         Tells isort to apply changes interactively.

target options:
  files                 One or more Python source files that need their
                        imports sorted.
  --filter-files        Tells isort to filter files even when they are
                        explicitly passed in as part of the CLI command.
  -s SKIP, --skip SKIP  Files that sort imports should skip over. If you want
                        to skip multiple files you should specify twice:
                        --skip file1 --skip file2.
  --sg SKIP_GLOB, --skip-glob SKIP_GLOB
                        Files that sort imports should skip over.
  --gitignore, --skip-gitignore
                        Treat project as a git repository and ignore files
                        listed in .gitignore
                        Specifies what extensions isort can be ran against.
  --blocked-extension BLOCKED_EXTENSIONS
                        Specifies what extensions isort can never be ran
  --dont-follow-links   Tells isort not to follow symlinks that are
                        encountered when running recursively.
  --filename FILENAME   Provide the filename associated with a stream.

general output options:
  -a ADD_IMPORTS, --add-import ADD_IMPORTS
                        Adds the specified import line to all files,
                        automatically determining correct placement.
  --append, --append-only
                        Only adds the imports specified in --add-import if the
                        file contains existing imports.
  --af, --force-adds    Forces import adds even if the original file is empty.
  --rm REMOVE_IMPORTS, --remove-import REMOVE_IMPORTS
                        Removes the specified import from all files.
  --float-to-top        Causes all non-indented imports to float to the top of
                        the file having its imports sorted (immediately below
                        the top of file comment). This can be an excellent
                        shortcut for collecting imports every once in a while
                        when you place them in the middle of a file to avoid
                        context switching. *NOTE*: It currently doesn't work
                        with cimports and introduces some extra over-head and
                        a performance penalty.
  --dont-float-to-top   Forces --float-to-top setting off. See --float-to-top
                        for more information.
  --ca, --combine-as    Combines as imports on the same line.
  --cs, --combine-star  Ensures that if a star import is present, nothing else
                        is imported from that namespace.
  -e, --balanced        Balances wrapping to produce the most consistent line
                        length possible
  --ff FROM_FIRST, --from-first FROM_FIRST
                        Switches the typical ordering preference, showing from
                        imports first then straight ones.
  --fgw [FORCE_GRID_WRAP], --force-grid-wrap [FORCE_GRID_WRAP]
                        Force number of from imports (defaults to 2 when
                        passed as CLI flag without value)to be grid wrapped
                        regardless of line length. If 0 is passed in (the
                        global default) only line length is considered.
  -i INDENT, --indent INDENT
                        String to place for indents defaults to " " (4
  --lai LINES_AFTER_IMPORTS, --lines-after-imports LINES_AFTER_IMPORTS
  --lbt LINES_BETWEEN_TYPES, --lines-between-types LINES_BETWEEN_TYPES
  --le LINE_ENDING, --line-ending LINE_ENDING
                        Forces line endings to the specified value. If not
                        set, values will be guessed per-file.
  --ls, --length-sort   Sort imports by their string length.
  --lss, --length-sort-straight
                        Sort straight imports by their string length. Similar
                        to `length_sort` but applies only to straight imports
                        and doesn't affect from imports.
                        Multi line output (0-grid, 1-vertical, 2-hanging,
                        3-vert-hanging, 4-vert-grid, 5-vert-grid-grouped,
                        6-vert-grid-grouped-no-comma, 7-noqa, 8-vertical-
                        hanging-indent-bracket, 9-vertical-prefix-from-module-
                        import, 10-hanging-indent-with-parentheses).
  -n, --ensure-newline-before-comments
                        Inserts a blank line before a comment following an
  --nis, --no-inline-sort
                        Leaves `from` imports with multiple imports 'as-is'
                        (e.g. `from foo import a, c ,b`).
  --ot, --order-by-type
                        Order imports by type, which is determined by case, in
                        addition to alphabetically. **NOTE**: type here refers
                        to the implied type from the import name
                        capitalization. isort does not do type introspection
                        for the imports. These "types" are simply:
                        CONSTANT_VARIABLE, CamelCaseClass,
                        variable_or_function. If your project follows PEP8 or
                        a related coding standard and has many imports this is
                        a good default, otherwise you likely will want to turn
                        it off. From the CLI the `--dont-order-by-type` option
                        will turn this off.
  --dt, --dont-order-by-type
                        Don't order imports by type, which is determined by
                        case, in addition to alphabetically. **NOTE**: type
                        here refers to the implied type from the import name
                        capitalization. isort does not do type introspection
                        for the imports. These "types" are simply:
                        CONSTANT_VARIABLE, CamelCaseClass,
                        variable_or_function. If your project follows PEP8 or
                        a related coding standard and has many imports this is
                        a good default. You can turn this on from the CLI
                        using `--order-by-type`.
  --rr, --reverse-relative
                        Reverse order of relative imports.
  --sl, --force-single-line-imports
                        Forces all from imports to appear on their own line
                        One or more modules to exclude from the single line
  --tc, --trailing-comma
                        Includes a trailing comma on multi line imports that
                        include parentheses.
  --up, --use-parentheses
                        Use parentheses for line continuation on length limit
                        instead of slashes. **NOTE**: This is separate from
                        wrap modes, and only affects how individual lines that
                        are too long get continued, not sections of multiple
  -l LINE_LENGTH, -w LINE_LENGTH, --line-length LINE_LENGTH, --line-width LINE_LENGTH
                        The max length of an import line (used for wrapping
                        long imports).
  --wl WRAP_LENGTH, --wrap-length WRAP_LENGTH
                        Specifies how long lines that are wrapped should be,
                        if not set line_length is used. NOTE: wrap_length must
                        be LOWER than or equal to line_length.
  --case-sensitive      Tells isort to include casing when sorting module
                        Tells isort to remove redundant aliases from imports,
                        such as `import os as os`. This defaults to `False`
                        simply because some projects use these seemingly
                        useless aliases to signify intent and change
  --honor-noqa          Tells isort to honor noqa comments to enforce skipping
                        those comments.
  --treat-comment-as-code TREAT_COMMENTS_AS_CODE
                        Tells isort to treat the specified single line
                        comment(s) as if they are code.
                        Tells isort to treat all single line comments as if
                        they are code.
  --formatter FORMATTER
                        Specifies the name of a formatting plugin to use when
                        producing output.
  --color               Tells isort to use color in terminal output.
  --ext-format EXT_FORMAT
                        Tells isort to format the given files according to an
                        extensions formatting rules.

section output options:
  --sd DEFAULT_SECTION, --section-default DEFAULT_SECTION
                        Sets the default section for import options:
                        ('FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY',
  --only-sections, --os
                        Causes imports to be sorted only based on their
                        sections like STDLIB,THIRDPARTY etc. Imports are
                        unaltered and keep their relative positions within the
                        different sections.
  --ds, --no-sections   Put all imports into the same section bucket
  --fas, --force-alphabetical-sort
                        Force all imports to be sorted as a single section
  --fss, --force-sort-within-sections
                        Don't sort straight-style imports (like import sys)
                        before from-style imports (like from itertools import
                        groupby). Instead, sort the imports by module,
                        independent of import style.
  --fass, --force-alphabetical-sort-within-sections
                        Force all imports to be sorted alphabetically within a
                        Force specific imports to the top of their appropriate
  --combine-straight-imports, --csi
                        Combines all the bare straight imports of the same
                        section in a single line. Won't work with sections
                        which have 'as' imports
  --nlb NO_LINES_BEFORE, --no-lines-before NO_LINES_BEFORE
                        Sections which should not be split with previous by
                        empty lines
  --src SRC_PATHS, --src-path SRC_PATHS
                        Add an explicitly defined source path (modules within
                        src paths have their imports automatically categorized
                        as first_party).
                        Force isort to recognize a module as part of Python's
                        standard library.
  --extra-builtin EXTRA_STANDARD_LIBRARY
                        Extra modules to be included in the list of ones in
                        Python's standard library.
                        Force isort to recognize a module as part of Python's
                        internal future compatibility libraries. WARNING: this
                        overrides the behavior of __future__ handling and
                        therefore can result in code that can't execute. If
                        you're looking to add dependencies such as six a
                        better option is to create a another section below
                        --future using custom sections. See:
                        ordering and the discussion here:
                        Force isort to recognize a module as being part of a
                        third party library.
                        Force isort to recognize a module as being part of the
                        current python project.
  --known-local-folder KNOWN_LOCAL_FOLDER
                        Force isort to recognize a module as being a local
                        folder. Generally, this is reserved for relative
                        imports (from . import module).
  --virtual-env VIRTUAL_ENV
                        Virtual environment to use for determining whether a
                        package is third-party
  --conda-env CONDA_ENV
                        Conda environment to use for determining whether a
                        package is third-party
  --py {all,2,27,3,35,36,37,38,39,auto}, --python-version {all,2,27,3,35,36,37,38,39,auto}
                        Tells isort to set the known standard library based on
                        the specified Python version. Default is to assume any
                        Python 3 version could be the target, and use a union
                        of all stdlib modules across versions. If auto is
                        specified, the version of the interpreter used to run
                        isort (currently: 38) will be used.

Installation on mega-linter Docker image

Example success log

Results of isort linter (version 5.6.4)
See documentation on

[SUCCESS] .automation/test/python/

Example error log

Results of isort linter (version 5.6.4)
See documentation on

[ERROR] .automation/test/python/
    ERROR: .automation/test/python/ Imports are incorrectly sorted and/or formatted.
    --- .automation/test/python/  2020-12-05 12:08:47.707389
    +++ .automation/test/python/   2020-12-05 12:34:28.504872
    @@ -1,11 +1,11 @@
     import json
    +import sys
     from os import getenv, path
     from pprint import pprint
    -import sys

    -import click # pylint: disable=import-error
    -from dotenv import load_dotenv # pylint: disable=import-error
    -import requests # pylint: disable=import-error
    +import click  # pylint: disable=import-error
    +import requests  # pylint: disable=import-error
    +from dotenv import load_dotenv  # pylint: disable=import-error

     env = load_dotenv()
     api_url = getenv(API_URL, default='' )