auto-walrus 0.3.4__tar.gz → 0.4.0__tar.gz

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/.github/workflows/publish_to_pypi.yml

@@ -8,9 +8,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
       - name: Install pypa/build
@@ -22,7 +22,7 @@ jobs:
       - name: Build a binary wheel and a source tarball
         run: python3 -m build
       - name: Store the distribution packages
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: python-package-distributions
           path: dist/
@@ -42,7 +42,7 @@ jobs:
 
     steps:
       - name: Download all the dists
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v7
         with:
           name: python-package-distributions
           path: dist/
@@ -63,12 +63,12 @@ jobs:
 
     steps:
       - name: Download all the dists
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v7
         with:
           name: python-package-distributions
           path: dist/
       - name: Sign the dists with Sigstore
-        uses: sigstore/gh-action-sigstore-python@v2.1.1
+        uses: sigstore/gh-action-sigstore-python@v3.2.0
         with:
           inputs: >-
             ./dist/*.tar.gz

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/.github/workflows/tox.yml

@@ -9,18 +9,18 @@ jobs:
   tox:
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
         os: [windows-latest, ubuntu-latest]
 
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
       - name: Cache multiple paths
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: |
             ~/.cache/pip
@@ -31,3 +31,4 @@ jobs:
         run: python -m pip install --upgrade tox virtualenv setuptools pip
       - name: run-tox
         run: tox -e py
+      - run: pipx run auto-walrus -h

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: 'v0.4.1'
+  rev: 'v0.9.2'
   hooks:
     # Run the formatter.
     - id: ruff-format
@@ -9,13 +9,13 @@ repos:
     - id: ruff
       args: [--fix]
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: 'v1.9.0'
+  rev: 'v1.14.1'
   hooks:
     - id: mypy
       additional_dependencies: [pytest]
       exclude: utils
 - repo: https://github.com/codespell-project/codespell
-  rev: 'v2.2.6'
+  rev: 'v2.3.0'
   hooks:
     - id: codespell
       files: \.(py|rst|md)$

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: auto-walrus
-Version: 0.3.4
+Version: 0.4.0
 Summary: Automatically apply the awesome walrus operator
 Project-URL: Homepage, https://github.com/MarcoGorelli/auto-walrus
 Project-URL: Bug Tracker, https://github.com/MarcoGorelli/auto-walrus
@@ -45,7 +45,7 @@ Sample `.pre-commit-config.yaml`:
 
 ```yaml
 -   repo: https://github.com/MarcoGorelli/auto-walrus
-    rev: 0.3.4
+    rev: 0.4.0
     hooks:
     -   id: auto-walrus
 ```

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/README.md

@@ -30,7 +30,7 @@ Sample `.pre-commit-config.yaml`:
 
 ```yaml
 -   repo: https://github.com/MarcoGorelli/auto-walrus
-    rev: 0.3.4
+    rev: 0.4.0
     hooks:
     -   id: auto-walrus
 ```

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/auto_walrus.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import argparse
 import ast
+import dataclasses
 import os
 import pathlib
 import re
@@ -30,6 +31,12 @@ EXCLUDES = (
 )
 
 
+@dataclasses.dataclass
+class Config:
+    line_length: int
+    unsafe: bool = False
+
+
 def name_lineno_coloffset_iterable(
     tokens: Iterable[Token],
 ) -> list[tuple[str, int, int]]:
@@ -193,6 +200,7 @@ def related_vars_are_unused(
 
 def visit_function_def(
     node: ast.FunctionDef,
+    config: Config,
 ) -> list[tuple[Token, Token]]:
     names = set()
     assignments: set[Token] = set()
@@ -204,7 +212,7 @@ def visit_function_def(
     related_vars: dict[str, list[Token]] = {}
     in_body_vars: dict[Token, set[Token]] = {}
 
-    for _node in node.body:
+    for _node in ast.walk(node) if config.unsafe else node.body:
         if isinstance(_node, ast.Assign):
             process_assign(_node, assignments, related_vars)
         elif isinstance(_node, ast.If):
@@ -255,7 +263,7 @@ def visit_function_def(
 
 def auto_walrus(
     content: str,
-    line_length: int,
+    config: Config,
 ) -> str | None:
     lines = content.splitlines()
     try:
@@ -266,7 +274,7 @@ def auto_walrus(
     walruses = []
     for node in ast.walk(tree):
         if isinstance(node, ast.FunctionDef):
-            walruses.extend(visit_function_def(node))
+            walruses.extend(visit_function_def(node, config))
     lines_to_remove = []
     walruses = sorted(walruses, key=lambda x: (-x[1][1], -x[1][2]))
 
@@ -290,13 +298,13 @@ def auto_walrus(
             line_with_walrus = left_bit + replace + right_bit
         else:
             line_with_walrus = left_bit + "(" + replace + ")" + right_bit
-        if len(line_with_walrus) > line_length:
+        if len(line_with_walrus) > config.line_length:
             # don't rewrite if it would split over multiple lines
             continue
         # replace assignment
         line_without_assignment = (
-            f"{lines[_assignment[1]-1][:_assignment[2]]}"
-            f"{lines[_assignment[1]-1][_assignment[4]:]}"
+            f"{lines[_assignment[1] - 1][: _assignment[2]]}"
+            f"{lines[_assignment[1] - 1][_assignment[4] :]}"
         )
         if (ENDS_WITH_COMMENT.search(lines[_assignment[1] - 1]) is not None) or (
             ENDS_WITH_COMMENT.search(lines[_if_statement[1] - 1]) is not None
@@ -348,7 +356,7 @@ def _get_config(paths: list[pathlib.Path]) -> dict[str, Any]:
 
 def main(argv: Sequence[str] | None = None) -> int:  # pragma: no cover
     parser = argparse.ArgumentParser()
-    parser.add_argument("paths", nargs="*")
+    parser.add_argument("paths", nargs="+", metavar="path")
     parser.add_argument(
         "--files",
         help="Regex pattern with which to match files to include",
@@ -361,18 +369,24 @@ def main(argv: Sequence[str] | None = None) -> int:  # pragma: no cover
         required=False,
         default=r"^$",
     )
+    parser.add_argument(
+        "--unsafe",
+        action="store_true",
+        help="Also process if statements inside other blocks (like for loops)",
+    )
     # black formatter's default
     parser.add_argument("--line-length", type=int, default=88)
     args = parser.parse_args(argv)
     paths = [pathlib.Path(path).resolve() for path in args.paths]
 
     # Update defaults from pyproject.toml if present
-    config = {k.replace("-", "_"): v for k, v in _get_config(paths).items()}
-    parser.set_defaults(**config)
+    defaults = {k.replace("-", "_"): v for k, v in _get_config(paths).items()}
+    parser.set_defaults(**defaults)
     args = parser.parse_args(argv)
 
     ret = 0
 
+    config = Config(line_length=args.line_length, unsafe=args.unsafe)
     for path in paths:
         if path.is_file():
             filepaths = iter((path,))
@@ -382,7 +396,7 @@ def main(argv: Sequence[str] | None = None) -> int:  # pragma: no cover
                 for p in path.rglob("*")
                 if re.search(args.files, p.as_posix(), re.VERBOSE)
                 and not re.search(args.exclude, p.as_posix(), re.VERBOSE)
-                and not re.search(EXCLUDES, p.as_posix())
+                and not re.search(EXCLUDES, p.relative_to(path).as_posix())
                 and p.suffix == ".py"
             )
 
@@ -392,10 +406,7 @@ def main(argv: Sequence[str] | None = None) -> int:  # pragma: no cover
                     content = fd.read()
             except UnicodeDecodeError:
                 continue
-            new_content = auto_walrus(
-                content,
-                line_length=args.line_length,
-            )
+            new_content = auto_walrus(content, config)
             if new_content is not None and content != new_content:
                 sys.stdout.write(f"Rewriting {filepath}\n")
                 with open(filepath, "w", encoding="utf-8") as fd:

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "auto-walrus"
-version = "0.3.4"
+version = "0.4.0"
 authors = [
   { name="Marco Gorelli", email="33491632+MarcoGorelli@users.noreply.github.com" },
 ]
@@ -80,7 +80,7 @@ filterwarnings = [
   'ignore:distutils Version classes are deprecated:DeprecationWarning',
 ]
 xfail_strict = true
-markers = ["config_content"]
+markers = ["config_content", "project_dir_name"]
 
 [tool.coverage.run]
 plugins = ["covdefaults"]

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/tests/main_test.py

@@ -7,6 +7,7 @@ from typing import Tuple
 
 import pytest
 
+from auto_walrus import Config
 from auto_walrus import auto_walrus
 from auto_walrus import main
 
@@ -15,12 +16,12 @@ from auto_walrus import main
     ("src", "expected"),
     [
         (
-            "def foo():\n" "    a = 0\n" "    if a:\n" "        print(a)\n",
-            "def foo():\n" "    if (a := 0):\n" "        print(a)\n",
+            "def foo():\n    a = 0\n    if a:\n        print(a)\n",
+            "def foo():\n    if (a := 0):\n        print(a)\n",
         ),
         (
-            "def foo():\n" "    a = 0\n" "    if a > 3:\n" "        print(a)\n",
-            "def foo():\n" "    if (a := 0) > 3:\n" "        print(a)\n",
+            "def foo():\n    a = 0\n    if a > 3:\n        print(a)\n",
+            "def foo():\n    if (a := 0) > 3:\n        print(a)\n",
         ),
         (
             "def foo():\n"
@@ -29,11 +30,7 @@ from auto_walrus import main
             "        print(a)\n"
             "    else:\n"
             "        pass\n",
-            "def foo():\n"
-            "    if (a := 0):\n"
-            "        print(a)\n"
-            "    else:\n"
-            "        pass\n",
+            "def foo():\n    if (a := 0):\n        print(a)\n    else:\n        pass\n",
         ),
         (
             "def foo():\n"
@@ -49,24 +46,20 @@ from auto_walrus import main
             "        print(a)\n",
         ),
         (
-            "def foo():\n"
-            "    a = 0\n"
-            "    print(0)\n"
-            "    if a:\n"
-            "        print(a)\n",
-            "def foo():\n" "    print(0)\n" "    if (a := 0):\n" "        print(a)\n",
+            "def foo():\n    a = 0\n    print(0)\n    if a:\n        print(a)\n",
+            "def foo():\n    print(0)\n    if (a := 0):\n        print(a)\n",
         ),
         (
-            "def foo():\n" "    a = 0\n" "    if (a):\n" "        print(a)\n",
-            "def foo():\n" "    if (a := 0):\n" "        print(a)\n",
+            "def foo():\n    a = 0\n    if (a):\n        print(a)\n",
+            "def foo():\n    if (a := 0):\n        print(a)\n",
         ),
         (
-            "def foo():\n" "    b = 0; a = 0\n" "    if a:\n" "        print(a)\n",
-            "def foo():\n" "    b = 0; \n" "    if (a := 0):\n" "        print(a)\n",
+            "def foo():\n    b = 0; a = 0\n    if a:\n        print(a)\n",
+            "def foo():\n    b = 0; \n    if (a := 0):\n        print(a)\n",
         ),
         (
-            "def foo():\n" "    a = 0\n" "    if a:\n" "        print(a)",
-            "def foo():\n" "    if (a := 0):\n" "        print(a)",
+            "def foo():\n    a = 0\n    if a:\n        print(a)",
+            "def foo():\n    if (a := 0):\n        print(a)",
         ),
         (
             "def foo():\n"
@@ -97,7 +90,7 @@ from auto_walrus import main
     ],
 )
 def test_rewrite(src: str, expected: str) -> None:
-    ret = auto_walrus(src, 88)
+    ret = auto_walrus(src, Config(line_length=88))
     assert ret == expected
 
 
@@ -110,43 +103,54 @@ def test_rewrite(src: str, expected: str) -> None:
         "    b[0] = 1\n"
         "    if a:\n"
         "        print(a)\n",
-        "def foo():\n" "    a = 1\n" "    a = 2\n" "    if a:\n" "        print(a)\n",
-        "def foo():\n" "    a = (\n" "        0,)\n" "    if a:\n" "        print(a)\n",
-        "def foo():\n" "    a = (b==True)\n" "    if a:\n" "        print(a)\n",
+        "def foo():\n    a = 1\n    a = 2\n    if a:\n        print(a)\n",
+        "def foo():\n    a = (\n        0,)\n    if a:\n        print(a)\n",
+        "def foo():\n    a = (b==True)\n    if a:\n        print(a)\n",
         "def foo():\n"
         "    a = thequickbrownfoxjumpsoverthelazydog\n"
         "    if a:\n"
         "        print(a)\n",
-        "def foo():\n" "    a = 0  # no-walrus\n" "    if a:\n" "        print(a)\n",
-        "def foo():\n" "    a = 0\n" "    if a:  # no-walrus\n" "        print(a)\n",
-        "n = 10\n" "if foo(a := n+1):\n" "    print(n)\n",
-        "a = 0\n" "if False and a:\n" "    print(a)\n" "else:\n" "    print(a)\n",
-        "def foo():\n" "    a = 1\n" "    if a:\n" "        print(a)\n" "    a = 2\n",
+        "def foo():\n    a = 0  # no-walrus\n    if a:\n        print(a)\n",
+        "def foo():\n    a = 0\n    if a:  # no-walrus\n        print(a)\n",
+        "n = 10\nif foo(a := n+1):\n    print(n)\n",
+        "a = 0\nif False and a:\n    print(a)\nelse:\n    print(a)\n",
+        "def foo():\n    a = 1\n    if a:\n        print(a)\n    a = 2\n",
         "def foo():\n"
         "    n = 10\n"
         "    if True:\n"
         "        pass\n"
         "    elif foo(a := n+1):\n"
         "        print(n)\n",
-        "def foo():\n"
-        "    n = 10\n"
-        "    if n > np.sin(foo.bar.quox):\n"
-        "        print(n)\n",
-        "def foo():\n" "    n = 10\n" "    if True or n > 3:\n" "        print(n)\n",
+        "def foo():\n    n = 10\n    if n > np.sin(foo.bar.quox):\n        print(n)\n",
+        "def foo():\n    n = 10\n    if True or n > 3:\n        print(n)\n",
     ],
 )
 def test_noop(src: str) -> None:
-    ret = auto_walrus(src, 40)
+    ret = auto_walrus(src, Config(line_length=40))
     assert ret is None
 
 
+@pytest.mark.parametrize(
+    ("src", "expected"),
+    [
+        (
+            'def foo(data):\n    if True:\n        foo = data.get("blah")\n        if foo:\n            return foo\n    return data',
+            'def foo(data):\n    if True:\n        if (foo := data.get("blah")):\n            return foo\n    return data',
+        ),
+    ],
+)
+def test_rewrite_unsafe(src: str, expected: str) -> None:
+    ret = auto_walrus(src, Config(line_length=88, unsafe=True))
+    assert ret == expected
+
+
 ProjectDirT = Tuple[pathlib.Path, List[pathlib.Path]]
 
-SRC_ORIG = "def foo():\n" "    a = 0\n" "    if a:\n" "        print(a)\n"
-SRC_CHANGED = "def foo():\n" "    if (a := 0):\n" "        print(a)\n"
+SRC_ORIG = "def foo():\n    a = 0\n    if a:\n        print(a)\n"
+SRC_CHANGED = "def foo():\n    if (a := 0):\n        print(a)\n"
 
 
-@pytest.fixture()
+@pytest.fixture
 def project_dir(request: Any, tmp_path: pathlib.Path) -> ProjectDirT:
     # tmp_path will be the root of the project, e.g.:
     # tmp_path
@@ -158,6 +162,10 @@ def project_dir(request: Any, tmp_path: pathlib.Path) -> ProjectDirT:
     # |   └── c.py
     # └── pyproject.toml
 
+    if project_dir_name := request.node.get_closest_marker("project_dir_name"):
+        tmp_path = tmp_path / project_dir_name.args[0]
+        tmp_path.mkdir(parents=True)
+
     if config_content := request.node.get_closest_marker("config_content"):
         (tmp_path / "pyproject.toml").write_text(config_content.args[0])
 
@@ -173,7 +181,7 @@ def project_dir(request: Any, tmp_path: pathlib.Path) -> ProjectDirT:
     return tmp_path, python_files
 
 
-PROJECT_CONFIG_EXCLUDE_A = "[tool.auto-walrus]\n" 'exclude = "/a"\n'
+PROJECT_CONFIG_EXCLUDE_A = '[tool.auto-walrus]\nexclude = "/a"\n'
 
 
 @pytest.mark.config_content(PROJECT_CONFIG_EXCLUDE_A)
@@ -209,3 +217,18 @@ def test_config_file_missing(project_dir: ProjectDirT) -> None:
     main([str(project_root)])
     for file in files:
         assert file.read_text() == SRC_CHANGED, f"Unexpected result for {file}"
+
+
+@pytest.mark.project_dir_name("build/zoop")
+def test_project_in_subdirectory_that_would_be_ignored(project_dir: ProjectDirT) -> None:
+    project_root, files = project_dir
+    main([str(project_root)])
+    for file in files:
+        assert file.read_text() == SRC_CHANGED, f"Unexpected result for {file}"
+
+
+def test_complains_when_no_paths(capsys: pytest.CaptureFixture[str]) -> None:
+    with pytest.raises(SystemExit) as ei:
+        main([])
+    assert ei.value.code == 2
+    assert "the following arguments are required" in capsys.readouterr().err

{auto_walrus-0.3.4 → auto_walrus-0.4.0}/tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py{38,39,310,311,312}
+envlist = py{38,39,310,311,312,313,314}
 
 [testenv]
 deps =