def test_overload_decorator():
original = _clean("""
from typing import overload
def g():
f(1)
@overload
def f(x: int) -> int:
...
@overload
def f(x: str) -> str:
...
def f(x: int | str) -> int | str:
print(x)
return x
if __name__ == "__main__":
f(5)
""")
expected = _clean("""
from typing import overload
@overload
def f(x: int) -> int:
...
@overload
def f(x: str) -> str:
...
def f(x: int | str) -> int | str:
print(x)
return x
def g():
f(1)
if __name__ == "__main__":
f(5)
""")
actual = ssort(original)
assert actual == expected
def test_mixed_runtime_initialisation():
original = _clean("""
class Loopy:
def method(self):
return self._method()
attr = method
def _method(self):
pass
""")
expected = _clean("""
class Loopy:
def _method(self):
pass
def method(self):
return self._method()
attr = method
""")
actual = ssort(original)
assert actual == expected
def test_lifecycle_class_private():
original = _clean("""
class Thing:
def startup(self):
...
def poll(self):
try:
...
except:
self._shutdown_inner()
def _shutdown_inner(self):
...
def shutdown(self):
self._shutdown_inner
""")
expected = _clean("""
class Thing:
def startup(self):
...
def _shutdown_inner(self):
...
def poll(self):
try:
...
except:
self._shutdown_inner()
def shutdown(self):
self._shutdown_inner
""")
actual = ssort(original)
assert actual == expected
def test_idempotent(sample):
samples_dir = pathlib.Path("test_data/samples")
input_path = samples_dir / f"{sample}_input.py"
input_text = input_path.read_bytes()
sorted_text = ssort(
input_text,
filename=str(input_path),
on_wildcard_import=lambda **kwargs: None,
)
resorted_text = ssort(
sorted_text,
filename=str(input_path),
on_wildcard_import=lambda **kwargs: None,
)
assert resorted_text == sorted_text
def test_single_comment():
original = _clean("""
# This is a file with just a single comment!
""")
expected = _clean("""
# This is a file with just a single comment!
""")
actual = ssort(original)
assert actual == expected
def test_iter_unpack_in_class():
original = _clean("""
class MyClass:
def method(self):
a, *b = 1, 2, 3
""")
expected = _clean("""
class MyClass:
def method(self):
a, *b = 1, 2, 3
""")
actual = ssort(original)
assert actual == expected
def test_slots():
original = _clean("""
class Struct:
int_attr: int
__slots__ = ("int_attr", "str_attr")
str_attr: str
""")
expected = _clean("""
class Struct:
__slots__ = ("int_attr", "str_attr")
int_attr: int
str_attr: str
""")
actual = ssort(original)
assert actual == expected
def test_concat():
original = _clean("""
def f():
return l
l = []
l += 1
""")
expected = _clean("""
l = []
l += 1
def f():
return l
""")
actual = ssort(original)
assert actual == expected
def test_pretend_dunder_properties():
original = _clean("""
class Table:
column = None
__tablename__ = "table"
__slots__ = ("column", "other_column")
other_column = None
""")
expected = _clean("""
class Table:
__slots__ = ("column", "other_column")
column = None
__tablename__ = "table"
other_column = None
""")
actual = ssort(original)
assert actual == expected
def test_samples(sample):
samples_dir = pathlib.Path("test_data/samples")
input_path = samples_dir / f"{sample}_input.py"
output_path = samples_dir / f"{sample}_output.py"
input_text = input_path.read_bytes()
actual_text = ssort(
input_text,
filename=str(input_path),
on_wildcard_import=lambda **kwargs: None,
)
# XXX Uncomment to update samples. XXX
# output_path.write_bytes(actual_text)
# XXX Don't forget to restore re-comment after. XXX
expected_text = output_path.read_bytes()
assert actual_text == expected_text
def test_cycle_with_dependant():
original = _clean("""
def c():
return a()
def a():
return b()
def b():
return a()
""")
expected = _clean("""
def a():
return b()
def c():
return a()
def b():
return a()
""")
actual = ssort(original)
assert actual == expected
def test_cycle_reversed():
original = _clean("""
def a():
return c()
def b():
return a()
def c():
return b()
""")
expected = _clean("""
def a():
return c()
def b():
return a()
def c():
return b()
""")
actual = ssort(original)
assert actual == expected
def test_attribute_assign_class_example():
original = _clean("""
import admin
class TestAdmin(admin.ModelAdmin):
list_filter = ("foo_method",)
def foo_method(self, obj):
return "something"
foo_method.short_description = "Foo method"
""")
expected = _clean("""
import admin
class TestAdmin(admin.ModelAdmin):
list_filter = ("foo_method",)
def foo_method(self, obj):
return "something"
foo_method.short_description = "Foo method"
""")
actual = ssort(original)
assert actual == expected
def test_walrus():
original = _clean("""
def fun():
if (a := nofun()):
return a
else:
return True
def nofun():
return False
""")
expected = _clean("""
def nofun():
return False
def fun():
if (a := nofun()):
return a
else:
return True
""")
actual = ssort(original)
assert actual == expected
def test_single_dispatch():
original = _clean("""
import functools
@functools.singledispatch
def fun(x):
...
@fun.register(str)
def _fun_str(x):
...
@fun.register(int)
def _fun_int(x):
...
if __name__ == "__main__":
fun()
""")
expected = _clean("""
import functools
@functools.singledispatch
def fun(x):
...
@fun.register(str)
def _fun_str(x):
...
@fun.register(int)
def _fun_int(x):
...
if __name__ == "__main__":
fun()
""")
actual = ssort(original)
assert actual == expected
def test_depencency_order():
# TODO We previously tried to reorder dependencies to match the order they
# were required in.
original = _clean("""
def _step2():
...
def _step1():
...
def main():
_step1()
_step2()
""")
expected = _clean("""
def _step2():
...
def _step1():
...
def main():
_step1()
_step2()
""")
actual = ssort(original)
assert actual == expected
def test_inner_class():
original = _clean("""
class Outer:
'''
The outer class.
'''
a = 4
class Inner:
pass
__slots__ = ("b",)
""")
expected = _clean("""
class Outer:
'''
The outer class.
'''
__slots__ = ("b",)
class Inner:
pass
a = 4
""")
actual = ssort(original)
assert actual == expected
def test_isort_finders():
original = _clean("""
class Base:
pass
def a():
pass
class A(Base):
def method():
a()
class B(Base):
pass
def something():
return [A, B]
""")
expected = _clean("""
class Base:
pass
def a():
pass
class A(Base):
def method():
a()
class B(Base):
pass
def something():
return [A, B]
""")
actual = ssort(original)
assert actual == expected
def test_empty():
original = ""
expected = ""
actual = ssort(original)
assert actual == expected
def test_ssort_preserve_crlf_endlines_str():
original = "a = b\r\nb = 4"
expected = "b = 4\r\na = b\r\n"
actual = ssort(original)
assert actual == expected
def test_no_trailing_newline():
original = "a = 1"
expected = "a = 1\n"
actual = ssort(original)
assert actual == expected
def test_trailing_newline():
original = "b = 2\n"
expected = "b = 2\n"
actual = ssort(original)
assert actual == expected
