crackerjack 0.20.13__tar.gz → 0.20.15__tar.gz

{crackerjack-0.20.13 → crackerjack-0.20.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.20.13
+Version: 0.20.15
 Summary: Crackerjack: code quality toolkit
 Keywords: bandit,black,creosote,mypy,pyright,pytest,refurb,ruff
 Author-Email: lesleslie <les@wedgwoodwebworks.com>
@@ -35,6 +35,7 @@ Requires-Dist: pytest-cov>=6.1.1
 Requires-Dist: pytest-mock>=3.14.1
 Requires-Dist: pytest-timeout>=2.4
 Requires-Dist: pytest-xdist>=3.7
+Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: rich>=14
 Requires-Dist: tomli-w>=1.2
 Requires-Dist: typer>=0.16

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/__init__.py

@@ -1,4 +1,5 @@
 import typing as t
+
 from .crackerjack import Crackerjack, create_crackerjack_runner
 from .errors import (
     CleaningError,

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/__main__.py

@@ -1,4 +1,5 @@
 from enum import Enum
+
 import typer
 from pydantic import BaseModel, field_validator
 from rich.console import Console

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/crackerjack.py

@@ -1,4 +1,3 @@
-import ast
 import re
 import subprocess
 import typing as t
@@ -7,6 +6,7 @@ from pathlib import Path
 from subprocess import CompletedProcess
 from subprocess import run as execute
 from tomllib import loads
+
 from pydantic import BaseModel
 from rich.console import Console
 from tomli_w import dumps
@@ -73,8 +73,8 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
     def clean_file(self, file_path: Path) -> None:
         try:
             code = file_path.read_text()
-            code = self.remove_docstrings(code)
             code = self.remove_line_comments(code)
+            code = self.remove_docstrings(code)
             code = self.remove_extra_whitespace(code)
             code = self.reformat_code(code)
             file_path.write_text(code)
@@ -83,18 +83,44 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
             print(f"Error cleaning {file_path}: {e}")
 
     def remove_docstrings(self, code: str) -> str:
-        tree = ast.parse(code)
-        for node in ast.walk(tree):
-            if isinstance(
-                node, ast.FunctionDef | ast.AsyncFunctionDef | ast.ClassDef | ast.Module
-            ):
-                if ast.get_docstring(node):
-                    node.body = (
-                        node.body[1:]
-                        if isinstance(node.body[0], ast.Expr)
-                        else node.body
-                    )
-        return ast.unparse(tree)
+        lines = code.split("\n")
+        cleaned_lines = []
+        in_docstring = False
+        docstring_delimiter = None
+        waiting_for_docstring = False
+        for line in lines:
+            stripped = line.strip()
+            if stripped.startswith(("def ", "class ", "async def ")):
+                waiting_for_docstring = True
+                cleaned_lines.append(line)
+                continue
+            if waiting_for_docstring and stripped:
+                if stripped.startswith(('"""', "'''", '"', "'")):
+                    if stripped.startswith(('"""', "'''")):
+                        docstring_delimiter = stripped[:3]
+                    else:
+                        docstring_delimiter = stripped[0]
+                    if stripped.endswith(docstring_delimiter) and len(stripped) > len(
+                        docstring_delimiter
+                    ):
+                        waiting_for_docstring = False
+                        continue
+                    else:
+                        in_docstring = True
+                        waiting_for_docstring = False
+                        continue
+                else:
+                    waiting_for_docstring = False
+            if in_docstring:
+                if docstring_delimiter and stripped.endswith(docstring_delimiter):
+                    in_docstring = False
+                    docstring_delimiter = None
+                    continue
+                else:
+                    continue
+            cleaned_lines.append(line)
+
+        return "\n".join(cleaned_lines)
 
     def remove_line_comments(self, code: str) -> str:
         lines = code.split("\n")
@@ -119,7 +145,7 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
                 elif char == "#" and in_string is None:
                     comment = line[i:].strip()
                     if re.match(
-                        "^#\\s*(?:type:\\s*ignore|noqa|nosec|pragma:\\s*no\\s*cover|pylint:\\s*disable|mypy:\\s*ignore)",
+                        r"^#\s*(?:type:\s*ignore(?:\[.*?\])?|noqa|nosec|pragma:\s*no\s*cover|pylint:\s*disable|mypy:\s*ignore)",
                         comment,
                     ):
                         result.append(line[i:])
@@ -167,16 +193,14 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
                             or (
                                 next_line.startswith("#")
                                 and any(
-                                    (
-                                        pattern in next_line
-                                        for pattern in (
-                                            "type:",
-                                            "noqa",
-                                            "nosec",
-                                            "pragma:",
-                                            "pylint:",
-                                            "mypy:",
-                                        )
+                                    pattern in next_line
+                                    for pattern in (
+                                        "type:",
+                                        "noqa",
+                                        "nosec",
+                                        "pragma:",
+                                        "pylint:",
+                                        "mypy:",
                                     )
                                 )
                             )

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/errors.py

@@ -2,6 +2,7 @@ import sys
 import typing as t
 from enum import Enum
 from pathlib import Path
+
 from rich.console import Console
 from rich.panel import Panel
 

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/interactive.py

@@ -2,6 +2,7 @@ import time
 import typing as t
 from enum import Enum, auto
 from pathlib import Path
+
 from rich.box import ROUNDED
 from rich.console import Console
 from rich.layout import Layout
@@ -18,6 +19,7 @@ from rich.prompt import Confirm, Prompt
 from rich.table import Table
 from rich.text import Text
 from rich.tree import Tree
+
 from .errors import CrackerjackError, ErrorCode, handle_error
 
 
@@ -66,10 +68,8 @@ class Task:
 
     def can_run(self) -> bool:
         return all(
-            (
-                dep.status in (TaskStatus.SUCCESS, TaskStatus.SKIPPED)
-                for dep in self.dependencies
-            )
+            dep.status in (TaskStatus.SUCCESS, TaskStatus.SKIPPED)
+            for dep in self.dependencies
         )
 
     def __str__(self) -> str:
@@ -107,11 +107,8 @@ class WorkflowManager:
 
     def all_tasks_completed(self) -> bool:
         return all(
-            (
-                task.status
-                in (TaskStatus.SUCCESS, TaskStatus.FAILED, TaskStatus.SKIPPED)
-                for task in self.tasks.values()
-            )
+            task.status in (TaskStatus.SUCCESS, TaskStatus.FAILED, TaskStatus.SKIPPED)
+            for task in self.tasks.values()
         )
 
     def run_task(self, task: Task, func: t.Callable[[], t.Any]) -> bool:
@@ -257,7 +254,7 @@ class InteractiveCLI:
                 status = "[grey]⏸️ Pending[/grey]"
             duration = task.duration
             duration_text = f"{duration:.2f}s" if duration else "-"
-            deps = ", ".join((dep.name for dep in task.dependencies)) or "-"
+            deps = ", ".join(dep.name for dep in task.dependencies) or "-"
             table.add_row(task.name, status, duration_text, deps)
         return table
 
@@ -317,25 +314,19 @@ class InteractiveCLI:
                     layout["details"].update(self.show_task_status(next_task))
                 layout["tasks"].update(self.show_task_table())
                 successful = sum(
-                    (
-                        1
-                        for task in self.workflow.tasks.values()
-                        if task.status == TaskStatus.SUCCESS
-                    )
+                    1
+                    for task in self.workflow.tasks.values()
+                    if task.status == TaskStatus.SUCCESS
                 )
                 failed = sum(
-                    (
-                        1
-                        for task in self.workflow.tasks.values()
-                        if task.status == TaskStatus.FAILED
-                    )
+                    1
+                    for task in self.workflow.tasks.values()
+                    if task.status == TaskStatus.FAILED
                 )
                 skipped = sum(
-                    (
-                        1
-                        for task in self.workflow.tasks.values()
-                        if task.status == TaskStatus.SKIPPED
-                    )
+                    1
+                    for task in self.workflow.tasks.values()
+                    if task.status == TaskStatus.SKIPPED
                 )
                 summary = Panel(
                     f"Workflow completed!\n\n[green]✅ Successful tasks: {successful}[/green]\n[red]❌ Failed tasks: {failed}[/red]\n[blue]⏩ Skipped tasks: {skipped}[/blue]",

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/py313.py

@@ -168,7 +168,7 @@ def clean_python_code(code: str) -> str:
                 continue
             case s if "#" in s and (
                 not any(
-                    (skip in s for skip in ("# noqa", "# type:", "# pragma", "# skip"))
+                    skip in s for skip in ("# noqa", "# type:", "# pragma", "# skip")
                 )
             ):
                 code_part = line.split("#", 1)[0].rstrip()

{crackerjack-0.20.13 → crackerjack-0.20.15}/crackerjack/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "pdm-backend" ]
 
 [project]
 name = "crackerjack"
-version = "0.20.12"
+version = "0.20.14"
 description = "Crackerjack: code quality toolkit"
 readme = "README.md"
 keywords = [
@@ -54,6 +54,7 @@ dependencies = [
     "pytest-mock>=3.14.1",
     "pytest-timeout>=2.4",
     "pytest-xdist>=3.7",
+    "pyyaml>=6.0.2",
     "rich>=14",
     "tomli-w>=1.2",
     "typer>=0.16",

{crackerjack-0.20.13 → crackerjack-0.20.15}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "crackerjack"
-version = "0.20.13"
+version = "0.20.15"
 description = "Crackerjack: code quality toolkit"
 readme = "README.md"
 keywords = [
@@ -54,6 +54,7 @@ dependencies = [
     "pytest-mock>=3.14.1",
     "pytest-timeout>=2.4",
     "pytest-xdist>=3.7",
+    "pyyaml>=6.0.2",
     "rich>=14",
     "tomli-w>=1.2",
     "typer>=0.16",

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/conftest.py

@@ -2,6 +2,7 @@ import os
 import time
 import typing as t
 from pathlib import Path
+
 import pytest
 from pytest import Config, Item, Parser
 
@@ -42,7 +43,7 @@ def pytest_addoption(parser: Parser) -> None:
 
 def pytest_collection_modifyitems(config: Config, items: list[Item]) -> None:
     benchmark_mode = t.cast(bool, config.getoption("--benchmark"))
-    has_benchmark_tests = any((item.get_closest_marker("benchmark") for item in items))
+    has_benchmark_tests = any(item.get_closest_marker("benchmark") for item in items)
     if benchmark_mode or has_benchmark_tests:
         has_worker = hasattr(config, "workerinput")
         try:

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_crackerjack.py

@@ -6,6 +6,7 @@ from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
 from unittest.mock import MagicMock, patch
+
 import pytest
 from rich.console import Console
 from crackerjack.crackerjack import (
@@ -229,12 +230,12 @@ class TestCrackerjackProcess:
             cj.process(options)
             mock_run_tests.assert_called_once_with(options)
         console_print_calls = [str(call) for call in mock_console_print.call_args_list]
-        assert any(("Running tests" in call for call in console_print_calls)), (
+        assert any("Running tests" in call for call in console_print_calls), (
             "Expected 'Running tests' message was not printed"
         )
-        assert any(
-            ("Skipping config updates" in call for call in console_print_calls)
-        ), "Expected 'Skipping config updates' message was not printed"
+        assert any("Skipping config updates" in call for call in console_print_calls), (
+            "Expected 'Skipping config updates' message was not printed"
+        )
 
     def test_process_with_skip_hooks_option(
         self,
@@ -264,11 +265,11 @@ class TestCrackerjackProcess:
             mock_run_pre_commit.assert_not_called()
             mock_run_tests.assert_called_once_with(options)
         console_print_calls = [str(call) for call in mock_console_print.call_args_list]
-        assert any(("Running tests" in call for call in console_print_calls)), (
+        assert any("Running tests" in call for call in console_print_calls), (
             "Expected 'Running tests' message was not printed"
         )
         assert any(
-            ("Skipping pre-commit hooks" in call for call in console_print_calls)
+            "Skipping pre-commit hooks" in call for call in console_print_calls
         ), "Expected 'Skipping pre-commit hooks' message was not printed"
 
     def test_process_with_bump_option(
@@ -296,9 +297,9 @@ class TestCrackerjackProcess:
                 cj.process(options)
                 mock_cj_execute.assert_any_call(["pdm", "bump", "minor"])
         console_print_calls = [str(call) for call in mock_console_print.call_args_list]
-        assert any(
-            ("Skipping config updates" in call for call in console_print_calls)
-        ), "Expected 'Skipping config updates' message was not printed"
+        assert any("Skipping config updates" in call for call in console_print_calls), (
+            "Expected 'Skipping config updates' message was not printed"
+        )
 
     def test_process_with_publish_option(
         self,
@@ -704,10 +705,8 @@ class TestCrackerjackProcess:
                         assert ["pdm", "build"] in actual_calls
                         assert ["pdm", "publish", "--no-build"] in actual_calls
                         assert any(
-                            (
-                                "build output" in str(call)
-                                for call in mock_print.mock_calls
-                            )
+                            "build output" in str(call)
+                            for call in mock_print.mock_calls
                         )
 
     def test_process_with_commit_input(
@@ -760,10 +759,8 @@ class TestCrackerjackProcess:
                 cj.process(options)
                 mock_update_configs.assert_called_once()
                 assert any(
-                    (
-                        "PDM installation failed" in str(call)
-                        for call in mock_console_print.mock_calls
-                    )
+                    "PDM installation failed" in str(call)
+                    for call in mock_console_print.mock_calls
                 )
 
     def test_process_with_crackerjack_project(
@@ -1062,6 +1059,30 @@ class TestCrackerjackProcess:
             f"Cleaned code does not match expected.\nExpected:\n{expected_cleaned}\nGot:\n{cleaned_code}"
         )
 
+    def test_code_cleaner_preserve_special_comments(self) -> None:
+        from rich.console import Console
+        from crackerjack.crackerjack import CodeCleaner
+
+        code_cleaner = CodeCleaner(console=Console())
+        test_code = "def test_func():\n    x = 1  # type: ignore\n    y = 2  # noqa\n    z = 3  # nosec\n    a = 4  # type: ignore[arg-type]\n    b = 5  # noqa: E501\n    c = 6  # nosec: B101\n    d = 7  # pragma: no cover\n    e = 8  # pylint: disable=line-too-long\n    f = 9  # mypy: ignore\n    g = 10  # regular comment that should be removed\n    h = 11 #type:ignore\n    i = 12#noqa\n    j = 13 #nosec\n    return x + y + z"
+        expected_code = "def test_func():\n    x = 1  # type: ignore\n    y = 2  # noqa\n    z = 3  # nosec\n    a = 4  # type: ignore[arg-type]\n    b = 5  # noqa: E501\n    c = 6  # nosec: B101\n    d = 7  # pragma: no cover\n    e = 8  # pylint: disable=line-too-long\n    f = 9  # mypy: ignore\n    g = 10\n    h = 11 #type:ignore\n    i = 12#noqa\n    j = 13 #nosec\n    return x + y + z"
+        cleaned_code = code_cleaner.remove_line_comments(test_code)
+        assert cleaned_code == expected_code, (
+            f"Special comments not preserved correctly.\nExpected:\n{expected_code}\nGot:\n{cleaned_code}"
+        )
+
+    def test_code_cleaner_special_comments_in_strings(self) -> None:
+        from rich.console import Console
+        from crackerjack.crackerjack import CodeCleaner
+
+        code_cleaner = CodeCleaner(console=Console())
+        test_code = 'def test_func():\n    s1 = "# type: ignore"  # should keep comment outside string but preserve string\n    s2 = \'# noqa\'  # type: ignore\n    s3 = "test"  # regular comment should be removed\n    return s1 + s2'
+        expected_code = 'def test_func():\n    s1 = "# type: ignore"\n    s2 = \'# noqa\'  # type: ignore\n    s3 = "test"\n    return s1 + s2'
+        cleaned_code = code_cleaner.remove_line_comments(test_code)
+        assert cleaned_code == expected_code, (
+            f"String handling with special comments failed.\nExpected:\n{expected_code}\nGot:\n{cleaned_code}"
+        )
+
     def test_code_cleaner_remove_extra_whitespace(self) -> None:
         from rich.console import Console
         from crackerjack.crackerjack import CodeCleaner

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_crackerjack_runner.py

@@ -2,6 +2,7 @@ import tempfile
 import typing as t
 from pathlib import Path
 from unittest.mock import MagicMock, patch
+
 import pytest
 from rich.console import Console
 from crackerjack import create_crackerjack_runner
@@ -129,8 +130,6 @@ def test_process_with_test_and_skip_hooks_options(
     mock_run_tests.assert_called_once_with(options)
     mocks["project_manager"].run_pre_commit.assert_not_called()
     assert any(
-        (
-            "Skipping pre-commit hooks" in str(call)
-            for call in mocks["console"].print.call_args_list
-        )
+        "Skipping pre-commit hooks" in str(call)
+        for call in mocks["console"].print.call_args_list
     )

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_errors.py

@@ -1,5 +1,6 @@
 import typing as t
 from unittest.mock import MagicMock, patch
+
 import pytest
 from rich.console import Console
 from crackerjack.errors import (
@@ -125,19 +126,15 @@ class TestErrorCodes:
                 assert "CONFIG" in code.name
             elif 2000 <= value < 3000:
                 assert any(
-                    (
-                        prefix in code.name
-                        for prefix in ("COMMAND", "EXTERNAL", "PDM", "PRE_COMMIT")
-                    )
+                    prefix in code.name
+                    for prefix in ("COMMAND", "EXTERNAL", "PDM", "PRE_COMMIT")
                 )
             elif 3000 <= value < 4000:
                 assert "TEST" in code.name or "BENCHMARK" in code.name
             elif 4000 <= value < 5000:
                 assert any(
-                    (
-                        prefix in code.name
-                        for prefix in ("BUILD", "PUBLISH", "VERSION", "AUTHENTICATION")
-                    )
+                    prefix in code.name
+                    for prefix in ("BUILD", "PUBLISH", "VERSION", "AUTHENTICATION")
                 )
             elif 5000 <= value < 6000:
                 assert (
@@ -151,8 +148,6 @@ class TestErrorCodes:
                 assert "CODE" in code.name or "FORMATTING" in code.name
             elif 9000 <= value < 10000:
                 assert any(
-                    (
-                        prefix in code.name
-                        for prefix in ("UNKNOWN", "NOT_IMPLEMENTED", "UNEXPECTED")
-                    )
+                    prefix in code.name
+                    for prefix in ("UNKNOWN", "NOT_IMPLEMENTED", "UNEXPECTED")
                 )

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_interactive.py

@@ -2,6 +2,7 @@ import io
 import time
 from pathlib import Path
 from unittest.mock import MagicMock, patch
+
 import pytest
 from rich.console import Console
 from rich.panel import Panel

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_interactive_run.py

@@ -1,4 +1,5 @@
 from unittest.mock import MagicMock, patch
+
 import pytest
 from rich.console import Console
 from crackerjack.errors import ErrorCode, ExecutionError
@@ -123,31 +124,25 @@ class TestInteractiveRun:
             assert len(cli.workflow.tasks) == 3
             assert (
                 sum(
-                    (
-                        1
-                        for t in cli.workflow.tasks.values()
-                        if t.status == TaskStatus.SUCCESS
-                    )
+                    1
+                    for t in cli.workflow.tasks.values()
+                    if t.status == TaskStatus.SUCCESS
                 )
                 == 1
             )
             assert (
                 sum(
-                    (
-                        1
-                        for t in cli.workflow.tasks.values()
-                        if t.status == TaskStatus.FAILED
-                    )
+                    1
+                    for t in cli.workflow.tasks.values()
+                    if t.status == TaskStatus.FAILED
                 )
                 == 1
             )
             assert (
                 sum(
-                    (
-                        1
-                        for t in cli.workflow.tasks.values()
-                        if t.status == TaskStatus.SKIPPED
-                    )
+                    1
+                    for t in cli.workflow.tasks.values()
+                    if t.status == TaskStatus.SKIPPED
                 )
                 == 1
             )

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_main.py

@@ -1,5 +1,6 @@
 import typing as t
 from unittest.mock import MagicMock, patch
+
 import pytest
 from typer.testing import CliRunner
 from crackerjack.__main__ import BumpOption, Options, app

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_py313_advanced.py

@@ -2,6 +2,7 @@ import subprocess
 from pathlib import Path
 from typing import Any
 from unittest import mock
+
 from crackerjack.py313 import (
     CommandResult,
     CommandRunner,

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_py313_features.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+
 from crackerjack.py313 import (
     CommandResult,
     HookResult,

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_pytest_features.py

@@ -1,4 +1,5 @@
 import time
+
 import pytest
 
 

{crackerjack-0.20.13 → crackerjack-0.20.15}/tests/test_structured_errors.py

@@ -2,6 +2,7 @@ import io
 import typing as t
 from pathlib import Path
 from unittest.mock import MagicMock, patch
+
 import pytest
 from rich.console import Console