wexample-filestate-python 9.0.6__tar.gz → 9.1.0__tar.gz

{wexample_filestate_python-9.0.6 → wexample_filestate_python-9.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wexample-filestate-python
-Version: 9.0.6
+Version: 9.1.0
 Summary: Extends wexample-filestate with Python file options: format, sort imports, modernize typing, and reorder class members.
 Author-Email: weeger <contact@wexample.com>
 License: MIT
@@ -28,7 +28,7 @@ Description-Content-Type: text/markdown
 
 # filestate_python
 
-Version: 9.0.6
+Version: 9.1.0
 
 `wexample-filestate-python` extends [wexample-filestate](https://github.com/wexample/python-filestate) with a `python` configuration option that applies up to 22 code-transformation sub-options to `.py` files — formatting with Black, import sorting with isort, unused-name removal with autoflake, f-string conversion with flynt, typing modernisation, and a range of structural ordering passes (class attributes, methods, docstrings, constants, iterables, and more) implemented with libcst. It is aimed at Python package authors who want source conventions declared once and enforced uniformly by the filestate engine, without maintaining separate linting scripts per project.
 

{wexample_filestate_python-9.0.6 → wexample_filestate_python-9.1.0}/README.md

@@ -1,6 +1,6 @@
 # filestate_python
 
-Version: 9.0.6
+Version: 9.1.0
 
 `wexample-filestate-python` extends [wexample-filestate](https://github.com/wexample/python-filestate) with a `python` configuration option that applies up to 22 code-transformation sub-options to `.py` files — formatting with Black, import sorting with isort, unused-name removal with autoflake, f-string conversion with flynt, typing modernisation, and a range of structural ordering passes (class attributes, methods, docstrings, constants, iterables, and more) implemented with libcst. It is aimed at Python package authors who want source conventions declared once and enforced uniformly by the filestate engine, without maintaining separate linting scripts per project.
 

{wexample_filestate_python-9.0.6 → wexample_filestate_python-9.1.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-filestate-python"
-version = "9.0.6"
+version = "9.1.0"
 description = "Extends wexample-filestate with Python file options: format, sort imports, modernize typing, and reorder class members."
 authors = [
     { name = "weeger", email = "contact@wexample.com" },

{wexample_filestate_python-9.0.6 → wexample_filestate_python-9.1.0}/src/wexample_filestate_python/utils/python_iterable_utils.py

@@ -45,7 +45,23 @@ def reorder_flagged_iterables(src: str) -> str:
         lines[start:end] = [ln for i in order for ln in groups[i]]
         changed = True
 
-    return "\n".join(lines) if changed else src
+    if not changed:
+        return src
+
+    result = "\n".join(lines)
+
+    # This function rewrites source files in place, so the one outcome it must never
+    # have is producing invalid Python — a corrupt file is committed and discovered
+    # far from here. Sorting is cosmetic: when a literal is shaped in a way this
+    # line-based pass reads wrong, leaving it alone is the right answer.
+    import ast
+
+    try:
+        ast.parse(result)
+    except SyntaxError:
+        return src
+
+    return result
 
 
 def _collect_iterable_block(lines: list[str], flag_idx: int) -> tuple[int, int]:
@@ -65,6 +81,15 @@ def _collect_iterable_block(lines: list[str], flag_idx: int) -> tuple[int, int]:
     # Skip immediate blank/comment lines (though the example shows none)
     while i < n and (lines[i].strip() == "" or lines[i].lstrip().startswith("#")):
         i += 1
+
+    # The flag sits either inside the literal, on the line below its opening bracket,
+    # or on the line above it — both read as "flagging this literal". In the second
+    # case the first line collected opens the literal (`return [`, `NAMES: set = {`)
+    # and is not an item: sorting it among the items moves the opening into the
+    # middle of its own list, which is no longer Python.
+    if i < n and lines[i].rstrip().endswith(("[", "{", "(")):
+        i += 1
+
     start = i
 
     # Scan until blank line or closing bracket ']' at indentation <= base

wexample_filestate_python-9.1.0/tests/unit/utils/test_python_iterable_utils.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+import ast
+
+import pytest
+
+# The shape that corrupted a source file: the flag above `return [`. Sorting swallowed
+# the opening line, which landed between `Path…` and `Table…` — case-insensitive, so
+# `path` < `return` < `table` — leaving the list opening in the middle of its own body.
+FLAG_ABOVE_OPENING = '''def get_options() -> list[type]:
+    # filestate: python-iterable-sort
+    return [
+        TableConfigOption,
+        CredentialConfigOption,
+        PathConfigOption,
+    ]
+'''
+
+FLAG_INSIDE_LITERAL = '''NAMES: set[str] = {
+    # filestate: python-iterable-sort
+    "ruff",
+    "black",
+    "isort",
+}
+'''
+
+
+def _reorder(src: str) -> str:
+    from wexample_filestate_python.utils.python_iterable_utils import (
+        reorder_flagged_iterables,
+    )
+
+    return reorder_flagged_iterables(src)
+
+
+def test_the_flag_above_the_opening_sorts_the_items_only() -> None:
+    result = _reorder(FLAG_ABOVE_OPENING)
+
+    ast.parse(result)
+    assert [line.strip() for line in result.splitlines()[2:6]] == [
+        "return [",
+        "CredentialConfigOption,",
+        "PathConfigOption,",
+        "TableConfigOption,",
+    ]
+
+
+def test_the_flag_inside_the_literal_still_works() -> None:
+    result = _reorder(FLAG_INSIDE_LITERAL)
+
+    ast.parse(result)
+    assert [line.strip() for line in result.splitlines()[2:5]] == [
+        '"black",',
+        '"isort",',
+        '"ruff",',
+    ]
+
+
+@pytest.mark.parametrize("src", [FLAG_ABOVE_OPENING, FLAG_INSIDE_LITERAL])
+def test_sorting_twice_changes_nothing_the_second_time(src: str) -> None:
+    once = _reorder(src)
+    assert _reorder(once) == once
+
+
+@pytest.mark.parametrize("src", [FLAG_ABOVE_OPENING, FLAG_INSIDE_LITERAL])
+def test_the_result_always_parses(src: str) -> None:
+    """The invariant that matters: this pass rewrites files, so it may not break them."""
+    ast.parse(_reorder(src))
+
+
+def test_an_already_sorted_literal_is_returned_untouched() -> None:
+    sorted_src = '''NAMES: set[str] = {
+    # filestate: python-iterable-sort
+    "black",
+    "isort",
+    "ruff",
+}
+'''
+    assert _reorder(sorted_src) is sorted_src