def test_isort_shouldnt_split_skip_issue_1556():
assert isort.check_code(
"""
from tools.dependency_pruning.prune_dependencies import ( # isort:skip
prune_dependencies,
)
from tools.developer_pruning.prune_developers import ( # isort:skip
prune_developers,
)
""",
show_diff=True,
profile="black",
float_to_top=True,
)
assert isort.check_code(
"""
from tools.dependency_pruning.prune_dependencies import ( # isort:skip
prune_dependencies,
)
from tools.developer_pruning.prune_developers import x # isort:skip
""",
show_diff=True,
profile="black",
float_to_top=True,
)
def test_isort_treats_src_paths_same_as_from_config_as_cli_issue_1711(tmpdir):
assert isort.check_code(
"""
import mymodule
import sqlalchemy
""",
show_diff=True,
)
config_file = tmpdir.join(".isort.cfg")
config_file.write("""
[settings]
src_paths=
api
""")
api_dir = tmpdir.mkdir("api")
api_dir.join("mymodule.py").write("# comment")
config = isort.settings.Config(str(config_file))
assert isort.check_code(
"""
import sqlalchemy
import mymodule
""",
show_diff=True,
config=config,
)
def test_isort_automatically_removes_duplicate_aliases_issue_1193():
"""Test to ensure isort can automatically remove duplicate aliases.
See: https://github.com/pycqa/isort/issues/1281
"""
assert isort.check_code("from urllib import parse as parse\n", show_diff=True)
assert (
isort.code("from urllib import parse as parse", remove_redundant_aliases=True)
== "from urllib import parse\n"
)
assert isort.check_code("import os as os\n", show_diff=True)
assert isort.code("import os as os", remove_redundant_aliases=True) == "import os\n"
def test_empty_float_to_top_shouldnt_error_issue_1453():
"""isort shouldn't error when float to top is set with a mostly empty file"""
assert isort.check_code(
"""
""",
show_diff=True,
float_to_top=True,
)
assert isort.check_code(
"""
""",
show_diff=True,
)
def test_isort_adding_second_comma_issue_1621():
"""Ensure isort doesnt add a second comma when very long comment is present
See: https://github.com/PyCQA/isort/issues/1621.
"""
assert isort.check_code(
"""from .test import (
TestTestTestTestTestTest2 as TestTestTestTestTestTest1, """
"""# Some really long comment bla bla bla bla bla
)
""",
profile="black",
show_diff=True,
)
assert (
isort.code(
"""from .test import (
TestTestTestTestTestTest2 as TestTestTestTestTestTest1 """
"""# Some really long comment bla bla bla bla bla
)
""",
profile="black",
)
== """from .test import (
TestTestTestTestTestTest2 as TestTestTestTestTestTest1, """
"""# Some really long comment bla bla bla bla bla
)
"""
)
def test_isort_losing_imports_vertical_prefix_from_module_import_wrap_mode_issue_1542():
"""Ensure isort doesnt lose imports when a comment is combined with an import and
wrap mode VERTICAL_PREFIX_FROM_MODULE_IMPORT is used.
See: https://github.com/PyCQA/isort/issues/1542.
"""
assert (
isort.code(
"""
from xxxxxxxxxxxxxxxx import AAAAAAAAAA, BBBBBBBBBB
from xxxxxxxxxxxxxxxx import CCCCCCCCC, DDDDDDDDD # xxxxxxxxxxxxxxxxxx
print(CCCCCCCCC)
""",
multi_line_output=9,
)
== """
from xxxxxxxxxxxxxxxx import AAAAAAAAAA, BBBBBBBBBB # xxxxxxxxxxxxxxxxxx
from xxxxxxxxxxxxxxxx import CCCCCCCCC, DDDDDDDDD
print(CCCCCCCCC)
"""
)
assert isort.check_code(
"""
from xxxxxxxxxxxxxxxx import AAAAAAAAAA, BBBBBBBBBB
from xxxxxxxxxxxxxxxx import CCCCCCCCC, DDDDDDDDD # xxxxxxxxxxxxxxxxxx isort: skip
print(CCCCCCCCC)
""",
show_diff=True,
multi_line_output=9,
)
def test_isort_supports_append_only_imports_issue_727():
"""Test to ensure isort provides a way to only add imports as an append.
See: https://github.com/pycqa/isort/issues/727.
"""
assert isort.code("", add_imports=["from __future__ import absolute_imports"]) == ""
assert (
isort.code("import os", add_imports=["from __future__ import absolute_imports"])
== """from __future__ import absolute_imports
import os
"""
)
# issue 1838: don't append in middle of class
assert isort.check_code(
'''class C:
"""a
"""
# comment
''',
append_only=True,
add_imports=["from __future__ import annotations"],
show_diff=True,
)
def test_isort_shouldnt_add_extra_new_line_when_fass_and_n_issue_1315():
"""Test to ensure isort doesnt add a second extra new line when combining --fss and -n options.
See: https://github.com/timothycrosley/isort/issues/1315
"""
assert isort.check_code(
"""import sys
# Comment canary
from . import foo
""",
ensure_newline_before_comments=True, # -n
force_sort_within_sections=True, # -fss
show_diff=True, # for better debugging in the case the test case fails.
)
assert (isort.code(
"""
from . import foo
# Comment canary
from .. import foo
""",
ensure_newline_before_comments=True,
force_sort_within_sections=True,
) == """
from . import foo
# Comment canary
from .. import foo
""")
def test_isort_doesnt_misplace_add_import_issue_1445():
"""Test to ensure isort won't misplace an added import depending on docstring position
See: https://github.com/PyCQA/isort/issues/1445
"""
assert (isort.code(
'''#!/usr/bin/env python
"""module docstring"""
''',
add_imports=["import os"],
) == '''#!/usr/bin/env python
"""module docstring"""
import os
''')
assert isort.check_code(
'''#!/usr/bin/env python
"""module docstring"""
import os
''',
add_imports=["import os"],
show_diff=True,
)
def test_isort_shouldnt_introduce_syntax_error_issue_1539():
"""isort should NEVER introduce syntax errors.
In 5.5.4 some strings that contained a line starting with from could lead to no empty paren.
See: https://github.com/PyCQA/isort/issues/1539.
"""
assert isort.check_code(
'''"""Foobar
from {}""".format(
"bar",
)
''',
show_diff=True,
)
assert isort.check_code(
'''"""Foobar
import {}""".format(
"bar",
)
''',
show_diff=True,
)
assert (
isort.code(
'''"""Foobar
from {}"""
from a import b, a
''',
)
== '''"""Foobar
from {}"""
from a import a, b
'''
)
assert (
isort.code(
'''"""Foobar
from {}"""
import b
import a
''',
)
== '''"""Foobar
from {}"""
import a
import b
'''
)
def test_isort_should_keep_multi_noqa_with_star_issue_1744():
assert isort.check_code(
"""
from typing import * # noqa
from typing import IO, BinaryIO, Union # noqa
""",
show_diff=True,
)
assert isort.check_code(
"""
from typing import * # noqa 1
from typing import IO, BinaryIO, Union # noqa 2
""",
show_diff=True,
)
assert isort.check_code(
"""
from typing import * # noqa
from typing import IO, BinaryIO, Union
""",
show_diff=True,
)
assert isort.check_code(
"""
from typing import *
from typing import IO, BinaryIO, Union # noqa
""",
show_diff=True,
)
assert (isort.code(
"""
from typing import * # hi
from typing import IO, BinaryIO, Union # noqa
""",
combine_star=True,
) == """
from typing import * # noqa; hi
""")
assert (isort.code(
"""
from typing import * # noqa
from typing import IO, BinaryIO, Union # noqa
""",
combine_star=True,
) == """
from typing import * # noqa
""")
def test_windows_newline_issue_1278():
"""Test to ensure windows new lines are correctly handled within indented scopes.
See: https://github.com/timothycrosley/isort/issues/1278
"""
assert isort.check_code(
"\ntry:\r\n import datadog_agent\r\n\r\n "
"from ..log import CheckLoggingAdapter, init_logging\r\n\r\n init_logging()\r\n"
"except ImportError:\r\n pass\r\n")
def test_comments_should_never_be_moved_between_imports_issue_1427():
"""isort should never move comments to different import statement.
See: https://github.com/PyCQA/isort/issues/1427
"""
assert isort.check_code(
"""from package import CONSTANT
from package import * # noqa
""",
force_single_line=True,
show_diff=True,
)
def test_add_imports_shouldnt_make_isort_unusable_issue_1297():
"""Test to ensure add imports doesn't cause any unexpected behaviour when combined with check
See: https://github.com/timothycrosley/isort/issues/1297
"""
assert isort.check_code(
"""from __future__ import unicode_literals
from os import path
""",
add_imports={"from __future__ import unicode_literals"},
)
def test_isort_should_keep_all_as_and_non_as_imports_issue_1523():
"""isort should keep as and non-as imports of the same path that happen to exist within the
same statement.
See: https://github.com/PyCQA/isort/issues/1523.
"""
assert isort.check_code(
"""
from selenium.webdriver import Remote, Remote as Driver
""",
show_diff=True,
combine_as_imports=True,
)
def test_isort_should_be_able_to_add_independent_of_doc_string_placement_issue_1420():
"""isort should be able to know when an import requested to be added is sucesfully added,
independent of where the top doc string is located.
See: https://github.com/PyCQA/isort/issues/1420
"""
assert isort.check_code(
'''"""module docstring"""
import os
''',
show_diff=True,
add_imports=["os"],
)
def test_isort_skipped_nested_imports_issue_1339():
"""Ensure `isort:skip are honored in nested imports.
See: https://github.com/timothycrosley/isort/issues/1339.
"""
assert isort.check_code(
"""
def import_test():
from os ( # isort:skip
import path
)
""",
show_diff=True,
)
def test_comments_should_cause_wrapping_on_long_lines_black_mode_issue_1219():
"""Tests to ensure if isort encounters a single import line which is made too long with a comment
it is wrapped when using black profile.
See: https://github.com/timothycrosley/isort/issues/1219
"""
assert isort.check_code(
"""
from many_stop_words import (
get_stop_words as get_base_stopwords, # extended list of stop words, also for en
)
""",
show_diff=True,
profile="black",
)
def test_semicolon_ignored_for_dynamic_lines_after_import_issue_1178():
"""Test to ensure even if a semicolon is in the decorator in the line following an import
the correct line spacing detrmination will be made.
See: https://github.com/pycqa/isort/issues/1178.
"""
assert isort.check_code(
"""
import pytest
@pytest.mark.skip(';')
def test_thing(): pass
""",
show_diff=True,
)
def test_isort_doesnt_rewrite_import_with_dot_to_from_import_issue_1280():
"""Test to ensure isort doesn't rewrite imports in the from of import y.x into from y import x.
This is because they are not technically fully equivalent to eachother and can introduce broken
behaviour.
See: https://github.com/timothycrosley/isort/issues/1280
"""
assert isort.check_code(
"""
import test.module
import test.module as m
from test import module
from test import module as m
""",
show_diff=True,
)
def test_check_never_passes_with_indented_headings_issue_1301():
"""Test to ensure that test can pass even when there are indented headings.
See: https://github.com/timothycrosley/isort/issues/1301
"""
assert isort.check_code(
"""
try:
# stdlib
import logging
from os import abc, path
except ImportError:
pass
""",
import_heading_stdlib="stdlib",
)
def test_isort_shouldnt_add_extra_line_float_to_top_issue_1667():
assert isort.check_code(
"""
import sys
sys.path.insert(1, 'path/containing/something_else/..')
import something_else # isort:skip
# Some constant
SOME_CONSTANT = 4
""",
show_diff=True,
float_to_top=True,
)
def test_wrap_mode_equal_to_line_length_with_indendet_imports_issue_1333():
assert isort.check_code(
"""
import a
import b
def function():
import a as b
import c as d
""",
line_length=17,
wrap_length=17,
show_diff=True,
)
def test_isort_should_keep_multiple_noqa_comments_force_single_line_mode_issue_1721(
):
assert isort.check_code(
"""
from some_very_long_filename_to_import_from_that_causes_a_too_long_import_row import ( # noqa: E501
CONSTANT_1,
)
from some_very_long_filename_to_import_from_that_causes_a_too_long_import_row import ( # noqa: E501
CONSTANT_2,
)
""",
show_diff=True,
profile="black",
force_single_line=True,
)
def test_isort_can_turn_off_import_adds_with_action_comment_issue_1737():
assert (
isort.code(
"""
import os
""",
add_imports=[
"from __future__ import absolute_imports",
"from __future__ import annotations",
],
)
== """
from __future__ import absolute_imports, annotations
import os
"""
)
assert isort.check_code(
"""
# isort: dont-add-imports
import os
""",
show_diff=True,
add_imports=[
"from __future__ import absolute_imports",
"from __future__ import annotations",
],
)
assert (
isort.code(
"""
# isort: dont-add-import: from __future__ import annotations
import os
""",
add_imports=[
"from __future__ import absolute_imports",
"from __future__ import annotations",
],
)
== """
# isort: dont-add-import: from __future__ import annotations
from __future__ import absolute_imports
import os
"""
)
def test_isort_support_custom_groups_above_stdlib_that_contain_stdlib_modules_issue_1407():
"""Test to ensure it is possible to declare custom groups above standard library that include
modules from the standard library.
See: https://github.com/PyCQA/isort/issues/1407
"""
assert isort.check_code(
"""
from __future__ import annotations
from typing import *
from pathlib import Path
""",
known_typing=["typing"],
sections=["FUTURE", "TYPING", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"],
no_lines_before=["TYPING"],
show_diff=True,
)
def test_isort_shouldnt_duplicate_comments_issue_1631():
assert isort.check_code(
"""
import a # a comment
import a as b # b comment
""",
show_diff=True,
)
assert (isort.code(
"""
import a # a comment
import a as a # b comment
""",
remove_redundant_aliases=True,
) == """
import a # a comment; b comment
""")
def test_comment_shouldnt_be_duplicated_with_fass_enabled_issue_1329():
"""Tests to ensure isort doesn't duplicate comments when imports occur with comment on top,
immediately after large comment blocks.
See: https://github.com/timothycrosley/isort/pull/1329/files.
"""
assert isort.check_code(
"""'''
Multi-line docstring
'''
# Comment for A.
import a
# Comment for B - not A!
import b
""",
force_sort_within_sections=True,
show_diff=True,
)
def test_reverse_relative_combined_with_force_sort_within_sections_issue_1395():
"""Test to ensure reverse relative combines well with other common isort settings.
See: https://github.com/pycqa/isort/issues/1395.
"""
assert isort.check_code(
"""from .fileA import a_var
from ..fileB import b_var
""",
show_diff=True,
reverse_relative=True,
force_sort_within_sections=True,
order_by_type=False,
case_sensitive=False,
multi_line_output=5,
sections=["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "APPLICATION", "LOCALFOLDER"],
lines_after_imports=2,
no_lines_before="LOCALFOLDER",
)
def test_import_sorting_shouldnt_be_endless_with_headers_issue_1454():
"""isort should never enter an endless sorting loop.
See: https://github.com/PyCQA/isort/issues/1454
"""
assert isort.check_code(
"""
# standard library imports
import sys
try:
# Comment about local lib
# related third party imports
from local_lib import stuff
except ImportError as e:
pass
""",
known_third_party=["local_lib"],
import_heading_thirdparty="related third party imports",
show_diff=True,
)
