A Python utility / library to sort imports.

isort - isort your imports, so you don't have to.


PyPI version Test Status Lint Status Code coverage Status License Join the chat at https://gitter.im/timothycrosley/isort Downloads Code style: black Imports: isort DeepSource


Read Latest Documentation - Browse GitHub Code Repository


isort your imports, so you don't have to.

isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type. It provides a command line utility, Python library and plugins for various editors to quickly sort all your imports. It requires Python 3.6+ to run but supports formatting Python 2 code too.

Example Usage

Before isort:

from my_lib import Object

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("Hey")
print("yo")

After isort:

from __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 isort

Installing isort is as simple as:

pip install isort

Install isort with requirements.txt support:

pip install isort[requirements_deprecated_finder]

Install isort with Pipfile support:

pip install isort[pipfile_deprecated_finder]

Install isort with both formats support:

pip install isort[requirements_deprecated_finder,pipfile_deprecated_finder]

Using isort

From the command line:

isort mypythonfile.py mypythonfile2.py

or recursively:

isort .

which is equivalent to:

isort **/*.py

or to see the proposed changes without applying them:

isort mypythonfile.py --diff

Finally, to atomically run isort against a project, only applying changes if they don't introduce syntax errors do:

isort --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:

import isort

isort.file("pythonfile.py")

or:

import isort

sorted_code = isort.code("import b\nimport a\n")

Installing isort's for your preferred text editor

Several plugins have been written that enable to use isort from within a variety of text-editors. You can find a full list of them on 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 modes

You 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 12 possible settings:

0 - Grid

from third_party import (lib1, lib2, lib3,
                         lib4, lib5, ...)

1 - Vertical

from third_party import (lib1,
                         lib2,
                         lib3
                         lib4,
                         lib5,
                         ...)

2 - Hanging Indent

from third_party import \
    lib1, lib2, lib3, \
    lib4, lib5, lib6

3 - Vertical Hanging Indent

from third_party import (
    lib1,
    lib2,
    lib3,
    lib4,
)

4 - Hanging Grid

from third_party import (
    lib1, lib2, lib3, lib4,
    lib5, ...)

5 - Hanging Grid Grouped

from third_party import (
    lib1, lib2, lib3, lib4,
    lib5, ...
)

6 - Hanging Grid Grouped, No Trailing Comma

In 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 -tc or include_trailing_comma: True.

from third_party import (
    lib1, lib2, lib3, lib4,
    lib5
)

7 - NOQA

from third_party import lib1, lib2, lib3, ...  # NOQA

Alternatively, you can set force_single_line to True (-sl on the command line) and every import will appear on its own line:

from third_party import lib1
from third_party import lib2
from third_party import lib3
...

8 - Vertical Hanging Indent Bracket

Same as Mode 3 - Vertical Hanging Indent but the closing parentheses on the last line is indented.

from third_party import (
    lib1,
    lib2,
    lib3,
    lib4,
    )

9 - Vertical Prefix From Module Import

Starts a new line with the same from MODULE import prefix when lines are longer than the line length limit.

from third_party import lib1, lib2, lib3
from third_party import lib4, lib5, lib6

10 - Hanging Indent With Parentheses

Same as Mode 2 - Hanging Indent but uses parentheses instead of backslash for wrapping long lines.

from third_party import (
    lib1, lib2, lib3,
    lib4, lib5, lib6)

11 - Backslash Grid

Same as Mode 0 - Grid but uses backslashes instead of parentheses to group imports.

from third_party import lib1, lib2, lib3, \
                        lib4, lib5

Indentation

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.
  • Tab
  • A 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 the include_trailing_comma option (defaults to False).

Intelligently Balanced Multi-line Imports

As 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 set balanced_wrapping to True in your config or pass the -e option into the command line utility.

Custom Sections and Ordering

You can change the section order with sections option from the default of:

FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER

to your preference (if defined, omitting a default section may cause errors):

sections=FUTURE,STDLIB,FIRSTPARTY,THIRDPARTY,LOCALFOLDER

You also can define your own sections and their order.

Example:

known_django=django
known_pandas=pandas,numpy
sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,PANDAS,FIRSTPARTY,LOCALFOLDER

would create two new sections with the specified known modules.

The no_lines_before option will prevent the listed sections from being split from the previous section by an empty line.

Example:

sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
no_lines_before=LOCALFOLDER

would produce a section with both FIRSTPARTY and LOCALFOLDER modules combined.

IMPORTANT NOTE: It is very important to know when setting known sections that the naming does not directly map for historical reasons. For custom settings, the only difference is capitalization (known_custom=custom VS sections=CUSTOM,...) for all others reference the following mapping:

  • known_standard_library : STANDARD_LIBRARY
  • extra_standard_library : STANDARD_LIBRARY # Like known standard library but appends instead of replacing
  • known_future_library : FUTURE
  • known_first_party: FIRSTPARTY
  • known_third_party: THIRDPARTY
  • known_local_folder: LOCALFOLDER

This will likely be changed in isort 6.0.0+ in a backwards compatible way.

Auto-comment import sections

Some 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 the import_heading_{section_name} setting for each section you wish to have auto commented - to the desired comment.

For Example:

import_heading_stdlib=Standard Library
import_heading_firstparty=My Stuff

Would lead to output looking like the following:

# Standard Library
import os
import sys

import django.settings

# My Stuff
import myproject.test

Ordering by import length

isort also makes it easy to sort your imports by length, simply by setting the length_sort option to True. This will result in the following output style:

from 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 using length_sort_ followed by the section name as a configuration item, e.g.:

length_sort_stdlib=1

Controlling how isort sections from imports

By default isort places straight (import y) imports above from imports (from x import y):

import b
from a import a  # This will always appear below because it is a from import.

However, if you prefer to keep strict alphabetical sorting you can set force sort within sections to true. Resulting in:

from a import a  # This will now appear at top because a appears in the alphabet before b
import b

You can even tell isort to always place from imports on top, instead of the default of placing them on bottom, using from first.

from b import b # If from first is set to True, all from imports will be placed before non-from imports.
import a

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 text isort:skip:

import module  # isort:skip

or:

from xyz import (abc,  # isort:skip
                 yo,
                 hey)

To make isort skip an entire file simply add isort:skip_file to the module's doc string:

""" my_module.py
    Best module ever

   isort:skip_file
"""

import b
import a

Adding an import to multiple files

isort makes it easy to add an import statement across multiple files, while being assured it's correctly placed.

To add an import to all files:

isort -a "from __future__ import print_function" *.py

To add an import only to files that already have imports:

isort -a "from __future__ import print_function" --append-only *.py

Removing an import from multiple files

isort 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:

isort --rm "os.system" *.py

Using isort to verify code

The --check-only option

isort 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 to stderr.

isort **/*.py -c -v

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/8717683

This can help to ensure a certain level of code quality throughout a project.

Git hook

isort 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:

#!/usr/bin/env python
import sys
from isort.hooks import git_hook

sys.exit(git_hook(strict=True, modify=True, lazy=True, settings_file=""))

If you just want to display warnings, but allow the commit to happen anyway, call git_hook without the strict parameter. If you want to display warnings, but not also fix the code, call git_hook without the modify parameter. The lazy argument is to support users who are "lazy" to add files individually to the index and tend to use git commit -a instead. Set it to True to ensure all tracked files are properly isorted, leave it out or set it to False to check only files added to your index.

If you want to use a specific configuration file for the hook, you can pass its path to settings_file. If no path is specifically requested, git_hook will search for the configuration file starting at the directory containing the first staged file, as per git diff-index ordering, and going upward in the directory structure until a valid configuration file is found or MAX_CONFIG_SEARCH_DEPTH directories are checked. The settings_file parameter is used to support users who keep their configuration file in a directory that might not be a parent of all the other files.

Setuptools integration

Upon installation, isort enables a setuptools command that checks Python files declared by your project.

Running python setup.py isort on the command line will check the files listed in your py_modules and packages. If any warning is found, the command will exit with an error code:

$ python setup.py isort

Also, to allow users to be able to use the command without having to install isort themselves, add isort to the setup_requires of your setup() like so:

setup(
    name="project",
    packages=["project"],

    setup_requires=[
        "isort"
    ]
)

Spread the word

Imports: isort

Place 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 information

To report a security vulnerability, please use the Tidelift 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 Subscription

Professional support for isort is available as part of the Tidelift 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

Owner
Python Code Quality Authority
Organization for code quality tools (and plugins) for the Python programming language
Python Code Quality Authority
Comments
  • isort does not skip files

    isort does not skip files

    Describe the bug

    isort does not respect skip and skip_glob configuration options.

    To Reproduce

    Steps to reproduce the behavior:

    1. Create file.py with the following content:
      import os, \
          sys
      
    2. Create .isort.cfg with the following content:
      [settings]
      skip_glob = file.py
      
    3. Run isort file.py.
    4. Open file.py and check out it's content to become:
      import os
      import sys
      

    Expected behavior

    A file.py is skipped and is not touched.

    Screenshots

    β€”

    Environment (please complete the following information):

    • OS: Linux
    • Python version: 3.7.2
    • isort version: 4.3.11

    Additional context

    isort 4.3.10 is working correctly. Issue can be reproduced with skip option as well.

  • skip statements

    skip statements

    Some statements need to be nested within imports, is there a way for isort to ignore them?

    Here's the motivating example:

    import matplotlib
    matplotlib.use('Agg')  # isort:skip
    import matplotlib.pyplot as plt
    

    the use Agg must be called before the plt import. isort:skip doesn't work here.

  • Interopability with black

    Interopability with black

    Hey, Timothy! Thanks for isort, it's a very useful project.

    I made an opinionated formatter, Black. Quite a few of my users are also isort users. That's great, I don't want to have to perform import sorting in Black. However, there's a small issue.

    None of isort's multiline modes fits what Black is doing. Black wraps lines like this:

    • try to fit everything in one line; if you can't then
    • indent the contents of the parens one level and try to fit those in one line; if you can't then
    • explode one element per line.

    The second step in Black's algorithm is like your mode 5, and the third is like mode 3. I'd like to create a pull request for isort to introduce mode 8 (5+3) that does what Black does in this scenario. This would enable Black and isort to co-exist and keep consistent import styling.

    Would you accept such pull request?

    (I initially wrote this on Twitter but this belongs here better.)

  • isort behavior different on linux vs osx even with config

    isort behavior different on linux vs osx even with config

    on OSX:

    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4 took 2s
    ➜ pipenv run isort --recursive --check-only server
    ERROR: /Users/ahonnecke/Code/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py Imports are incorrectly sorted.
    ERROR: /Users/ahonnecke/Code/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py Imports are incorrectly sorted.
    
    
    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4
    ➜ head -n16 /Users/ahonnecke/Code/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py
    import json
    import os
    from time import sleep
    from unittest.mock import MagicMock
    
    from django.test import TestCase
    
    from wiremock.constants import Config
    from wiremock.resources.mappings import Mapping
    from wiremock.resources.mappings.resource import Mappings
    from wiremock.server import WireMockServer
    
    
    from assets.models import Ledger
    from dad.configuration import PortfolioManagerConfiguration
    from portfolio_manager.models import LedgerAddress, Portfolio
    
    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4
    ➜ head -n16 /Users/ahonnecke/Code/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py
    import json
    import os
    from time import sleep
    from unittest.mock import MagicMock
    
    from django.test import TestCase
    
    from wiremock.constants import Config
    from wiremock.resources.mappings import Mapping
    from wiremock.resources.mappings.resource import Mappings
    from wiremock.server import WireMockServer
    
    
    from assets.models import Ledger
    from dad.configuration import PortfolioManagerConfiguration
    from portfolio_manager.wallets.ledger_client import LedgerClient
    
    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4
    ➜ pipenv run isort --recursive --check-only server
    ERROR: /Users/ahonnecke/Code/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py Imports are incorrectly sorted.
    ERROR: /Users/ahonnecke/Code/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py Imports are incorrectly sorted.
    
    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4 took 2s
    ➜ pipenv run isort --recursive server
    Fixing /Users/ahonnecke/Code/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py
    Fixing /Users/ahonnecke/Code/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py
    Skipped 26 files
    
    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4 took 2s
    ➜ head -n16 /Users/ahonnecke/Code/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py
    import json
    import os
    from time import sleep
    from unittest.mock import MagicMock
    
    from django.test import TestCase
    
    from wiremock.constants import Config
    from wiremock.resources.mappings import Mapping
    from wiremock.resources.mappings.resource import Mappings
    from wiremock.server import WireMockServer
    
    from assets.models import Ledger
    from dad.configuration import PortfolioManagerConfiguration
    from portfolio_manager.wallets.ledger_client import LedgerClient
    from util.security import create_user, get_token_for_user
    
    web on ξ‚  fox-295 [⇑$!] via 🐍 3.6.4
    ➜ head -n16 /Users/ahonnecke/Code/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py
    import json
    import os
    from time import sleep
    from unittest.mock import MagicMock
    
    from django.test import TestCase
    
    from wiremock.constants import Config
    from wiremock.resources.mappings import Mapping
    from wiremock.resources.mappings.resource import Mappings
    from wiremock.server import WireMockServer
    
    from assets.models import Ledger
    from dad.configuration import PortfolioManagerConfiguration
    from portfolio_manager.models import LedgerAddress, Portfolio
    from util.security import create_client_user, get_token_for_user
    

    Cloud based CI platform (Circle CI / ubuntu)

    [email protected]:~/project/repos/web$ pipenv run isort --recursive --check-only server
    ERROR: /home/circleci/project/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py Imports are incorrectly sorted.
    ERROR: /home/circleci/project/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py Imports are incorrectly sorted.
    
    [email protected]:~/project/repos/web$ cp /home/circleci/project/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py /home/circleci/project/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py.bak
    
    [email protected]:~/project/repos/web$ cp /home/circleci/project/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py /home/circleci/project/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py.bak
    
    [email protected]:~/project/repos/web$ pipenv run isort --recursive server
    Fixing /home/circleci/project/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py
    Fixing /home/circleci/project/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py
    Skipped 26 files
    [email protected]:~/project/repos/web$ diff /home/circleci/project/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py /home/circleci/project/repos/web/server/portfolio_manager/graphql/tests/test_ledger_addresses_query.py.bak
    8,12d7
    < from wiremock.constants import Config
    < from wiremock.resources.mappings import Mapping
    < from wiremock.resources.mappings.resource import Mappings
    < from wiremock.server import WireMockServer
    <
    17a13,16
    > from wiremock.constants import Config
    > from wiremock.resources.mappings import Mapping
    > from wiremock.resources.mappings.resource import Mappings
    > from wiremock.server import WireMockServer
    [email protected]:~/project/repos/web$ diff /home/circleci/project/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py /home/circleci/project/repos/web/server/portfolio_manager/wallets/test_supported_ledgers.py.bak
    8,12d7
    < from wiremock.constants import Config
    < from wiremock.resources.mappings import Mapping
    < from wiremock.resources.mappings.resource import Mappings
    < from wiremock.server import WireMockServer
    <
    17a13,16
    > from wiremock.constants import Config
    > from wiremock.resources.mappings import Mapping
    > from wiremock.resources.mappings.resource import Mappings
    > from wiremock.server import WireMockServer
    [email protected]:~/project/repos/web$ pipenv run isort --recursive --check-only server
    Skipped 26 files
    

    isort

    [settings]
    known_django=django
    sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
    

    TLDR, isort requires a different number of newlines on ubuntu.

  • Add configuration to ensure a newline before each comment

    Add configuration to ensure a newline before each comment

    This adds a ensure_newline_before_comments configuration that matches the format that black imposes (for better or worse) and allows isort to be used with black without any thrashing/conflicts with regards to blank lines before comments.

    Should help address https://github.com/psf/black/issues/251

  • ast and others not considered standard lib

    ast and others not considered standard lib

    Hi Tim,

    Upgrading from 4.2.5 to 4.2.8, it seems that isort now does not recognize ast as a standard library anymore. We can see it's doc here in standard library so I think it really should be considered stdlib :/

    What do you think?

  • How to make isort black compatible. Original Question: isort conflicts with black?

    How to make isort black compatible. Original Question: isort conflicts with black?

    Hi.

    I experience that black and isort undo eachothers changes when working on some of my files.

    I am using the following two first steps in my .pre-commit-config.yaml:

    repos:
      - repo: https://github.com/psf/black
        rev: 20.8b1
        hooks:
          - id: black
    
      - repo: https://github.com/pycqa/isort
        rev: 5.5.4
        hooks:
          - id: isort
    

    When I run pre-commit run --all-files, both black and isort report they are making changes. The changes result to the following formatting in my file configs.py:

    from datetime import date
    
    from cost_categories import (applsj, asjdfsi, bananana, sdjffsd, sjdifjsl,
                                 sjdil, yoyoyoyoy)
    from library_user import User
    

    However, if I remove the isort-hook from the yaml file, the conflict stops. Then, I get the following output (as dictated by black alone):

    from datetime import date
    
    from cost_categories import (
        applsj,
        asjdfsi,
        bananana,
        sdjffsd,
        sjdifjsl,
        sjdil,
        yoyoyoyoy,
    )
    from library_user import User
    

    How should I approach this? Am I using some wrong revision?

  • skips are not honored since isort 5.9.x

    skips are not honored since isort 5.9.x

    I'm using isort with my project for some time now, thank you for this project !

    Everything was working well with 5.8.0 but with 5.9.0 I have the error

    OSError: [Errno 7] Argument list too long: 'git'
    

    And with the version 5.9.1, extend_skip and skip_gitignore are not honored and isort goes into my venv folder where it shouldn't go.

    Thank you for looking into this

  • Add `multi_line_output` mode for more compact formatting

    Add `multi_line_output` mode for more compact formatting

    Could we add a mode similar to 0/grid mode, but that uses the fixed indent width for subsequent lines? Mode 0 looks like this:

    from third_party import (lib1, lib2, lib3,
                             lib4, lib5, ...)
    

    I would like this (where indent=2):

    from third_party import (lib1, lib2, lib3,
      lib4, lib5, ...)
    

    This would be more compact, and can reduce line count. I would be happy to attempt a PR; pointers on where to look would be welcome. isort has been a great improvement to my workflow; thank you for building it!

  • [regression] Inconsistent results on travis-ci

    [regression] Inconsistent results on travis-ci

    After the last release I started to get inconsistent results on travis again (python3).

    I cannot replicate and fix the issues.

    I opened this issue even though I don't have much details to offer, hoping that if more people are experiencing the same problem they will help to debug, for now I will try to pin the test requirements to the previous stable version.

  • First-party library (incorrectly?) detected as third-party depending on working directory

    First-party library (incorrectly?) detected as third-party depending on working directory

    I cannot post my a fully-contained working environment here, but this is my example code, and maybe it's enough to reproduce or at least understand the issue.

    This is /home/bers/myproj/myproj/tool/bug.py:

    import os
    
    import isort
    
    import myproj
    
    
    def _test():
        code = isort.code(open(__file__).read(), import_heading_thirdparty="3rd")
        print(code[: code.find("\n\n\ndef")] + "\n")
    
    
    print("correct:")
    os.chdir("/home/bers/myproj/myproj")
    _test()
    
    print("incorrect:")
    os.chdir("/home/bers/myproj/myproj/tool")
    _test()
    

    What this outputs is this:

    correct:
    import os
    
    # 3rd
    import isort
    
    import myproj
    
    incorrect:
    import os
    
    # 3rd
    import myproj
    import isort
    

    So you see that isort detects myproj as a 3rd-party library depending on the working directory - is this intended?

    It may be relevant that I usually do pip install -e . from /home/bers/myproj when setting up environments - this is what makes import myproj possible from within /home/bers/myproj/myproj/tool/bug.py.

  • ensure_newline_before_comments is not respected

    ensure_newline_before_comments is not respected

    https://pycqa.github.io/isort/docs/configuration/options.html#ensure-newline-before-comments

    Behavior before:

    example_app  | ERROR: /app/some_module.py Imports are incorrectly sorted and/or formatted.
    example_app  | --- /app/some_module:before	2022-11-29 06:27:44.401078
    example_app  | +++ /app/some_module.py:after	2022-11-29 06:27:47.062501
    example_app  | @@ -3,6 +3,7 @@
    example_app  |  from example_app.module1 import Import1
    example_app  |  from example_app.module2 import Import2
    example_app  |  from example_app.module3 import Import3
    example_app  | +
    example_app  |  # from example_app.module4 import (
    example_app  |  #     Import4,
    example_app  |  #     Import5,
    

    Behavior after: No error.

    Version: 5.10.1

    Configuration

    setup.cfg (no other configs):

    [isort]
    profile = black
    ensure_newline_before_comments = false
    line_length = 80
    sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
    

    I assume that profile setting overwrites ensure_newline_before_comments OR the later one is not working at all somewhy OR I do not understand it right.

  • Python version 3.11 as an valid option

    Python version 3.11 as an valid option

    It can be a part of an "epic" called "Support for python3.11" https://github.com/PyCQA/isort/issues/1996

    For the following line

    py_version=311
    

    Behavior before:

    ValueError: The python version 311 is not supported. You can set a python version with the -py or --python-version flag. The following versions are supported: ('all', '2', '27', '3', '310', '35', '36', '37', '38', '39')
    

    Behavior after: Everything is OK.

    Version: 5.10.1

  • `tomllib` is considered as third-party lib in py3.11 but it is built-in now

    `tomllib` is considered as third-party lib in py3.11 but it is built-in now

    https://docs.python.org/3/library/tomllib.html

    It can be a part of an "epic" called "Support for python3.11" #1996

    Behavior before:

    @@ -1,8 +1,10 @@
    -import tomllib
    from pathlib import Path
    from typing import Generator
     
    +import tomllib
    ...
    

    Behavior after: The message that everything is OK

    Version: 5.10.1

  • isort Deletes a used import

    isort Deletes a used import

    I tried to test it with the try online tool but it just freezes on "loading".

    Heres the code before isort:

    from django.core.management.base import BaseCommand
    
    from lib import buildlib
    from ...import build
    
    
    class Command(BaseCommand):
    
        def handle(self, *args, **options):
            options = buildlib.Options(verbose=True, force=True, prefix="WcApp")
            build.build_all_wc(options)
    
    

    After isort, it removes the build import:

    from django.core.management.base import BaseCommand
    from lib import buildlib
    
    
    class Command(BaseCommand):
        def handle(self, *args, **options):
            options = buildlib.Options(verbose=True, force=True, prefix="WcApp")
            build.build_all_wc(options)
    

    I tried:

    from ... import build as build_
    

    But it still gets removed

  • Add release workflow

    Add release workflow

    • Add release workflow - for it to work properly Github settings must have 2 secrets:
      • PYPI_TOKEN - to send releases to pypi.org (when version on pyproject.toml changes)
      • TEST_PYPI_TOKEN - to send non-release versions to test.pypi.org
    • Upgrade base python version for workflows from 3.8 to 3.9.
    • Pin version of pip, poetry and virtualenv used in all workflows.
    • Made consistent the checkout, python setup and dependency installation in all workflows.
    • Commented temporarily circular dependencies that use isort for a release.
    • Commented temporarily also linting script since it uses mostly the dependencies commented.
  • Imports in an `if sys.version_info` block are not handled as part of the same imports

    Imports in an `if sys.version_info` block are not handled as part of the same imports

    Config:

    [isort]
    lines_after_imports = 2
    remove_redundant_aliases = True
    

    Input:

    import sys
    
    if sys.version_info < (3, 10):
        from typing_extensions import ParamSpec
    else:
        from typing import ParamSpec
    

    I expect it to stay the same, but isort adds another newline between import sys and if sys.version_info....

Collection of library stubs for Python, with static types

typeshed About Typeshed contains external type annotations for the Python standard library and Python builtins, as well as third party packages as con

Dec 2, 2022
pycallgraph is a Python module that creates call graphs for Python programs.
pycallgraph is a Python module that creates call graphs for Python programs.

Project Abandoned Many apologies. I've stopped maintaining this project due to personal time constraints. Blog post with more information. I'm happy t

Nov 29, 2022
Turn your Python and Javascript code into DOT flowcharts
Turn your Python and Javascript code into DOT flowcharts

Notes from 2017 This is an older project which I am no longer working on. It was built before ES6 existed and before Python 3 had much usage. While it

Nov 28, 2022
Inspects Python source files and provides information about type and location of classes, methods etc

prospector About Prospector is a tool to analyse Python code and output information about errors, potential problems, convention violations and comple

Nov 26, 2022
Find dead Python code

Vulture - Find dead code Vulture finds unused code in Python programs. This is useful for cleaning up and finding errors in large code bases. If you r

Nov 30, 2022
Code audit tool for python.

Pylama Code audit tool for Python and JavaScript. Pylama wraps these tools: pycodestyle (formerly pep8) Β© 2012-2013, Florent Xicluna; pydocstyle (form

Nov 30, 2022
The strictest and most opinionated python linter ever!
The strictest and most opinionated python linter ever!

wemake-python-styleguide Welcome to the strictest and most opinionated python linter ever. wemake-python-styleguide is actually a flake8 plugin with s

Dec 5, 2022
The uncompromising Python code formatter
The uncompromising Python code formatter

The Uncompromising Code Formatter β€œAny color you like.” Black is the uncompromising Python code formatter. By using it, you agree to cede control over

Nov 27, 2022
A formatter for Python files

YAPF Introduction Most of the current formatters for Python --- e.g., autopep8, and pep8ify --- are made to remove lint errors from code. This has som

Dec 1, 2022
Performant type-checking for python.
Performant type-checking for python.

Pyre is a performant type checker for Python compliant with PEP 484. Pyre can analyze codebases with millions of lines of code incrementally – providi

Dec 3, 2022
A system for Python that generates static type annotations by collecting runtime types

MonkeyType MonkeyType collects runtime types of function arguments and return values, and can automatically generate stub files or even add draft type

Dec 2, 2022
A static type analyzer for Python code

pytype - ? βœ” Pytype checks and infers types for your Python code - without requiring type annotations. Pytype can: Lint plain Python code, flagging c

Nov 30, 2022
Optional static typing for Python 3 and 2 (PEP 484)

Mypy: Optional Static Typing for Python Got a question? Join us on Gitter! We don't have a mailing list; but we are always happy to answer questions o

Dec 3, 2022
Static type checker for Python
Static type checker for Python

Static type checker for Python Speed Pyright is a fast type checker meant for large Python source bases. It can run in a β€œwatch” mode and performs fas

Dec 4, 2022
A static analysis tool for Python

pyanalyze Pyanalyze is a tool for programmatically detecting common mistakes in Python code, such as references to undefined variables and some catego

Dec 6, 2022
Unbearably fast O(1) runtime type-checking in pure Python.
Unbearably fast O(1) runtime type-checking in pure Python.

Look for the bare necessities, the simple bare necessities. Forget about your worries and your strife. β€” The Jungle Book.

Nov 23, 2022
Typing-toolbox for Python 3 _and_ 2.7 w.r.t. PEP 484.
Typing-toolbox for Python 3 _and_ 2.7 w.r.t. PEP 484.

Welcome to the pytypes project pytypes is a typing toolbox w.r.t. PEP 484 (PEP 526 on the road map, later also 544 if it gets accepted). Its main feat

Dec 4, 2022
Data parsing and validation using Python type hints

pydantic Data validation and settings management using Python type hinting. Fast and extensible, pydantic plays nicely with your linters/IDE/brain. De

Dec 5, 2022
Run-time type checker for Python

This library provides run-time type checking for functions defined with PEP 484 argument (and return) type annotations. Four principal ways to do type

Nov 30, 2022