crackerjack 0.20.12__tar.gz → 0.20.14__tar.gz

{crackerjack-0.20.12 → crackerjack-0.20.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.20.12
+Version: 0.20.14
 Summary: Crackerjack: code quality toolkit
 Keywords: bandit,black,creosote,mypy,pyright,pytest,refurb,ruff
 Author-Email: lesleslie <les@wedgwoodwebworks.com>

{crackerjack-0.20.12 → crackerjack-0.20.14}/crackerjack/crackerjack.py

@@ -118,7 +118,10 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
                     i += 1
                 elif char == "#" and in_string is None:
                     comment = line[i:].strip()
-                    if re.match("^#\\s*(?:type:\\s*ignore|noqa)\\b", comment):
+                    if re.match(
+                        "^#\\s*(?:type:\\s*ignore|noqa|nosec|pragma:\\s*no\\s*cover|pylint:\\s*disable|mypy:\\s*ignore)",
+                        comment,
+                    ):
                         result.append(line[i:])
                         break
                     break
@@ -133,11 +136,55 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
     def remove_extra_whitespace(self, code: str) -> str:
         lines = code.split("\n")
         cleaned_lines = []
+        in_function = False
+        function_indent = 0
         for i, line in enumerate(lines):
             line = line.rstrip()
-            if i > 0 and (not line) and (not cleaned_lines[-1]):
-                continue
+            stripped_line = line.lstrip()
+            if stripped_line.startswith(("def ", "async def ")):
+                in_function = True
+                function_indent = len(line) - len(stripped_line)
+            elif (
+                in_function
+                and line
+                and (len(line) - len(stripped_line) <= function_indent)
+                and (not stripped_line.startswith(("@", "#")))
+            ):
+                in_function = False
+                function_indent = 0
+            if not line:
+                if i > 0 and cleaned_lines and (not cleaned_lines[-1]):
+                    continue
+                if in_function:
+                    next_line_idx = i + 1
+                    if next_line_idx < len(lines):
+                        next_line = lines[next_line_idx].strip()
+                        if not (
+                            next_line.startswith(
+                                ("return", "class ", "def ", "async def ", "@")
+                            )
+                            or next_line in ("pass", "break", "continue", "raise")
+                            or (
+                                next_line.startswith("#")
+                                and any(
+                                    (
+                                        pattern in next_line
+                                        for pattern in (
+                                            "type:",
+                                            "noqa",
+                                            "nosec",
+                                            "pragma:",
+                                            "pylint:",
+                                            "mypy:",
+                                        )
+                                    )
+                                )
+                            )
+                        ):
+                            continue
             cleaned_lines.append(line)
+        while cleaned_lines and (not cleaned_lines[-1]):
+            cleaned_lines.pop()
         return "\n".join(cleaned_lines)
 
     def reformat_code(self, code: str) -> str:

{crackerjack-0.20.12 → crackerjack-0.20.14}/crackerjack/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "pdm-backend" ]
 
 [project]
 name = "crackerjack"
-version = "0.20.11"
+version = "0.20.13"
 description = "Crackerjack: code quality toolkit"
 readme = "README.md"
 keywords = [

{crackerjack-0.20.12 → crackerjack-0.20.14}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "crackerjack"
-version = "0.20.12"
+version = "0.20.14"
 description = "Crackerjack: code quality toolkit"
 readme = "README.md"
 keywords = [

{crackerjack-0.20.12 → crackerjack-0.20.14}/tests/data/comments_sample.txt

@@ -4,6 +4,7 @@ def test_func():
 # Full line comment
 x = 1  # type: ignore
 y = 2 # noqa
+z = subprocess.run(["rm", "-rf", user_input])  # nosec
 
 
 class AsyncRedisBytecodeCache(AsyncBytecodeCache):

{crackerjack-0.20.12 → crackerjack-0.20.14}/tests/data/expected_comments_sample.txt

@@ -3,6 +3,7 @@ def test_func():
 
 x = 1  # type: ignore
 y = 2 # noqa
+z = subprocess.run(["rm", "-rf", user_input])  # nosec
 
 
 class AsyncRedisBytecodeCache(AsyncBytecodeCache):

{crackerjack-0.20.12 → crackerjack-0.20.14}/tests/test_crackerjack.py

@@ -1062,18 +1062,53 @@ 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
 
         code_cleaner = CodeCleaner(console=Console())
         code_with_whitespace = (
-            "def test_func():\n        return True\n    \n    \n    x = 1\n    "
+            "def test_func():\n    x = 1\n\n\n    y = 2\n\n    return x + y\n\n\n"
         )
         cleaned_code = code_cleaner.remove_extra_whitespace(code_with_whitespace)
         assert "def test_func():" in cleaned_code, f"Got: {cleaned_code!r}"
-        assert "return True" in cleaned_code, f"Got: {cleaned_code!r}"
         assert "x = 1" in cleaned_code, f"Got: {cleaned_code!r}"
+        assert "y = 2" in cleaned_code, f"Got: {cleaned_code!r}"
+        assert "\n\n\n" not in cleaned_code, (
+            f"Triple newlines should be removed: {cleaned_code!r}"
+        )
+        assert "y = 2\n\n    return x + y" in cleaned_code, (
+            f"Should keep blank before return: {cleaned_code!r}"
+        )
+        code_with_classes = "class TestClass:\n\n\n    def method1(self):\n        pass\n\n\n    def method2(self):\n        return True\n\n"
+        cleaned_class_code = code_cleaner.remove_extra_whitespace(code_with_classes)
+        assert "class TestClass:" in cleaned_class_code
+        assert "def method1(self):" in cleaned_class_code
+        assert "def method2(self):" in cleaned_class_code
 
     def test_code_cleaner_reformat_code_success(
         self, mock_execute: MagicMock, mock_console_print: MagicMock, tmp_path: Path