codesorter 0.2.2__tar.gz → 0.2.4__tar.gz

{codesorter-0.2.2 → codesorter-0.2.4}/CHANGES.rst

@@ -4,6 +4,30 @@
 
 codesorter follows `semantic versioning <https://semver.org/>`_.
 
+********************
+ 0.2.4 (2026/06/14)
+********************
+
+**Fixed**
+
+- Never reorder a definition across a side-effecting statement. A bare statement such as
+  ``sys.path.insert(0, str(REPO_ROOT))`` is now a barrier, and sorting happens only
+  within each segment between barriers, so a constant the statement uses is no longer
+  hoisted after it (which raised ``NameError``).
+
+********************
+ 0.2.3 (2026/06/14)
+********************
+
+**Fixed**
+
+- Keep an assignment that rebinds a name also bound by a sibling in its original
+  position relative to that sibling. For example ``ten = cachedproperty(ten, ...)``
+  following ``def ten`` now stays after the method it wraps instead of being hoisted
+  ahead of it (which raised ``NameError`` and changed which binding wins). Property
+  getter/setter/deleter groups, which carry no assignment, are still ordered by their
+  sort key.
+
 ********************
  0.2.2 (2026/06/14)
 ********************

{codesorter-0.2.2 → codesorter-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codesorter
-Version: 0.2.2
+Version: 0.2.4
 Summary: A Python codemod that sorts and organizes code in your files.
 Project-URL: Change Log, https://codesorter.readthedocs.io/en/latest/package_info/change_log.html
 Project-URL: Documentation, https://codesorter.readthedocs.io/

{codesorter-0.2.2 → codesorter-0.2.4}/codesorter/const.py

@@ -39,4 +39,4 @@ PLAIN_DECORATOR_PARTS = 1
 
 PROPERTY_DECORATOR_PARTS = 2
 
-__version__ = "0.2.2"
+__version__ = "0.2.4"

{codesorter-0.2.2 → codesorter-0.2.4}/codesorter/sort_code.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import enum
 import heapq
+import itertools
 from collections import defaultdict
 from enum import auto
 from typing import TYPE_CHECKING, Protocol, TypeAlias, TypeVar, cast
@@ -272,12 +273,27 @@ class SortCodeCommand(VisitorBasedCodemodCommand, m.MatcherDecoratableTransforme
             name_to_indexes[_sortable_name(item)].append(index)
         dependents: list[set[int]] = [set() for _ in items]
         indegree = [0] * len(items)
+
+        def _add_edge(earlier: int, later: int) -> None:
+            if earlier != later and later not in dependents[earlier]:
+                dependents[earlier].add(later)
+                indegree[later] += 1
+
         for index, item in enumerate(items):
             for dependency in self.dependencies.get(_sortable_name(item), ()):
                 for dependency_index in name_to_indexes.get(dependency, ()):
-                    if dependency_index != index and index not in dependents[dependency_index]:
-                        dependents[dependency_index].add(index)
-                        indegree[index] += 1
+                    _add_edge(dependency_index, index)
+        # An assignment that rebinds a name also bound by a sibling (for example
+        # ``def x`` followed by ``x = wraps(x)``) must keep its original position, since
+        # the later binding wins at runtime and may reference the earlier one. Groups of
+        # same-named methods (property getter/setter/deleter) are excluded — they carry
+        # no assignment and are ordered safely by their sort key.
+        for indexes in name_to_indexes.values():
+            for earlier, later in itertools.pairwise(indexes):
+                if isinstance(items[earlier], cst.SimpleStatementLine) or isinstance(
+                    items[later], cst.SimpleStatementLine
+                ):
+                    _add_edge(earlier, later)
         return dependents, indegree
 
     def _get_dependencies(  # noqa: C901
@@ -472,6 +488,44 @@ class SortCodeCommand(VisitorBasedCodemodCommand, m.MatcherDecoratableTransforme
             property_type,
         )
 
+    def _reorder_segment(
+        self,
+        body: Sequence[cst.BaseStatement],
+        new_body: list[cst.BaseStatement],
+        *,
+        anchor_indexes: list[int],
+        trailers_of: dict[int, list[int]],
+    ) -> None:
+        """Reorder one barrier-free segment of sortable members in place within ``new_body``."""
+        if not anchor_indexes:
+            return
+        positions: list[int] = []
+        anchor_nodes: list[_Sortable] = []
+        trailers_by_anchor: dict[int, list[cst.BaseStatement]] = {}
+        for index in anchor_indexes:
+            trailer_indexes = sorted(trailers_of.get(index, []))
+            positions.append(index)
+            positions.extend(trailer_indexes)
+            anchor = cast("_Sortable", body[index])
+            anchor_nodes.append(anchor)
+            trailers_by_anchor[id(anchor)] = [body[trailer] for trailer in trailer_indexes]
+        # Blank-line separators are positional: the n-th anchor in the segment keeps the
+        # n-th separator. Trailers are excluded so they stay tight to their anchor.
+        anchor_separators = [_split_leading_lines(node)[0] for node in anchor_nodes]
+        trailer_ids = {id(trailer) for trailers in trailers_by_anchor.values() for trailer in trailers}
+        flattened: list[cst.BaseStatement] = []
+        for anchor in self._sorted_items(anchor_nodes):
+            flattened.append(anchor)
+            flattened.extend(trailers_by_anchor[id(anchor)])
+        anchor_index = 0
+        for position, member in zip(sorted(positions), flattened, strict=True):
+            if id(member) in trailer_ids:
+                new_body[position] = member
+                continue
+            _, attached = _split_leading_lines(member)
+            new_body[position] = member.with_changes(leading_lines=[*anchor_separators[anchor_index], *attached])
+            anchor_index += 1
+
     def _resolve_dependents(self, node: _Sortable) -> None:
         dependencies, _ = self._get_dependencies(node)
         name = _sortable_name(node)
@@ -497,40 +551,27 @@ class SortCodeCommand(VisitorBasedCodemodCommand, m.MatcherDecoratableTransforme
         Blank-line spacing stays with each slot while comment lines travel with their
         statement, so reordering never shifts a blank line onto a different statement.
 
+        Sortable members are only reordered within a segment of consecutive sortable
+        members; any other statement (an import, a bare expression such as
+        ``sys.path.insert(...)``, an ``if`` block) is a barrier that no definition may
+        cross, since the barrier may depend on a definition beside it.
+
         """
         anchors = self._anchor_trailers(body, sort_constants=sort_constants)
         trailers_of: defaultdict[int, list[int]] = defaultdict(list)
         for trailer_index, anchor_index in anchors.items():
             trailers_of[anchor_index].append(trailer_index)
-        positions: list[int] = []
-        anchor_nodes: list[_Sortable] = []
-        trailers_by_anchor: dict[int, list[cst.BaseStatement]] = {}
-        for index, member in enumerate(body):
-            if index in anchors or not self._is_sortable(member, sort_constants=sort_constants):
-                continue
-            trailer_indexes = sorted(trailers_of.get(index, []))
-            positions.append(index)
-            positions.extend(trailer_indexes)
-            anchor = cast("_Sortable", member)
-            anchor_nodes.append(anchor)
-            trailers_by_anchor[id(anchor)] = [body[trailer] for trailer in trailer_indexes]
-        # Blank-line separators are positional: the n-th anchor in the body keeps the
-        # n-th separator. Trailers are excluded so they stay tight to their anchor.
-        anchor_separators = [_split_leading_lines(node)[0] for node in anchor_nodes]
-        trailer_ids = {id(trailer) for trailers in trailers_by_anchor.values() for trailer in trailers}
-        flattened: list[cst.BaseStatement] = []
-        for anchor in self._sorted_items(anchor_nodes):
-            flattened.append(anchor)
-            flattened.extend(trailers_by_anchor[id(anchor)])
         new_body = list(body)
-        anchor_index = 0
-        for position, member in zip(sorted(positions), flattened, strict=True):
-            if id(member) in trailer_ids:
-                new_body[position] = member
+        segment: list[int] = []
+        for index, member in enumerate(body):
+            if index in anchors:
+                continue  # a trailer, reordered together with its anchor
+            if self._is_sortable(member, sort_constants=sort_constants):
+                segment.append(index)
                 continue
-            _, attached = _split_leading_lines(member)
-            new_body[position] = member.with_changes(leading_lines=[*anchor_separators[anchor_index], *attached])
-            anchor_index += 1
+            self._reorder_segment(body, new_body, anchor_indexes=segment, trailers_of=trailers_of)
+            segment = []
+        self._reorder_segment(body, new_body, anchor_indexes=segment, trailers_of=trailers_of)
         return new_body
 
     def _sorted_items(

codesorter-0.2.4/tests/test_files/barrier_input.py

@@ -0,0 +1,11 @@
+"""Definitions never cross a side-effecting statement that may depend on them."""
+
+import sys
+from pathlib import Path
+
+ZEBRA = 1
+REPO_ROOT = Path(__file__).resolve().parent
+sys.path.insert(0, str(REPO_ROOT))
+
+BANANA = 3
+APPLE = 2

codesorter-0.2.4/tests/test_files/barrier_output.py

@@ -0,0 +1,11 @@
+"""Definitions never cross a side-effecting statement that may depend on them."""
+
+import sys
+from pathlib import Path
+
+REPO_ROOT = Path(__file__).resolve().parent
+ZEBRA = 1
+sys.path.insert(0, str(REPO_ROOT))
+
+APPLE = 2
+BANANA = 3

codesorter-0.2.4/tests/test_files/name_rebinding_input.py

@@ -0,0 +1,16 @@
+"""An assignment that rebinds a method name stays after the method it wraps."""
+
+
+class Klass:
+    def ten(self):
+        return 10
+
+    ten = cachedproperty(ten, doc="Return 10.")
+
+    def alpha(self):
+        """A method that sorts first alphabetically."""
+        return 1
+
+    def beta(self):
+        """A plain method."""
+        return 2

codesorter-0.2.4/tests/test_files/name_rebinding_output.py

@@ -0,0 +1,16 @@
+"""An assignment that rebinds a method name stays after the method it wraps."""
+
+
+class Klass:
+    def alpha(self):
+        """A method that sorts first alphabetically."""
+        return 1
+
+    def beta(self):
+        """A plain method."""
+        return 2
+
+    def ten(self):
+        return 10
+
+    ten = cachedproperty(ten, doc="Return 10.")

{codesorter-0.2.2 → codesorter-0.2.4}/tests/test_sort_code.py

@@ -48,6 +48,22 @@ class TestSortCodeCommand:
 
         assert expected_code == result.code
 
+    def test_barrier(self, test_files):
+        """Test that definitions are not reordered across a side-effecting statement.
+
+        A bare statement such as ``sys.path.insert(0, str(REPO_ROOT))`` is a barrier:
+        the constants before it (which it may use) must stay before it, so sorting
+        happens only within each segment between barriers rather than across the whole
+        module.
+
+        """
+        input_code, expected_code = test_files
+        context = CodemodContext()
+        command = SortCodeCommand(context)
+        result = command.transform_module(cst.parse_module(input_code))
+
+        assert expected_code == result.code
+
     def test_basic_function(self, test_files):
         """Test that functions are sorted correctly."""
         input_code, expected_code = test_files
@@ -217,6 +233,23 @@ from pathlib import Path
         assert "import sys" in result.code
         assert "from pathlib import Path" in result.code
 
+    def test_name_rebinding(self, test_files):
+        """Test that an assignment rebinding a method name stays after that method.
+
+        ``ten = cachedproperty(ten, ...)`` binds the same name as the ``def ten`` above
+        it and wraps that method, so the assignment must keep its position after the
+        method (moving it ahead would raise ``NameError`` and change which binding
+        wins). Property getter/setter/deleter groups are unaffected — they carry no
+        assignment.
+
+        """
+        input_code, expected_code = test_files
+        context = CodemodContext()
+        command = SortCodeCommand(context)
+        result = command.transform_module(cst.parse_module(input_code))
+
+        assert expected_code == result.code
+
     def test_order_sensitive(self, test_files):
         """Test that enum, dataclass, and named-tuple member order is preserved."""
         input_code, expected_code = test_files