crackerjack 0.21.4__tar.gz → 0.21.6__tar.gz

{crackerjack-0.21.4 → crackerjack-0.21.6}/PKG-INFO

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

{crackerjack-0.21.4 → crackerjack-0.21.6}/crackerjack/.gitignore

@@ -13,5 +13,8 @@
 /scratch/
 /.zencoder/
 /.benchmarks/
-
 **/.claude/settings.local.json
+/complexipy.json
+/coverage.json
+/test-results.xml
+/.coverage

{crackerjack-0.21.4 → crackerjack-0.21.6}/crackerjack/crackerjack.py

@@ -89,23 +89,50 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
     def remove_docstrings(self, code: str) -> str:
         lines = code.split("\n")
         cleaned_lines = []
-        docstring_state = {"in_docstring": False, "delimiter": None, "waiting": False}
-        for line in lines:
+        docstring_state = {
+            "in_docstring": False,
+            "delimiter": None,
+            "waiting": False,
+            "function_indent": 0,
+            "removed_docstring": False,
+        }
+        for i, line in enumerate(lines):
             stripped = line.strip()
             if self._is_function_or_class_definition(stripped):
                 docstring_state["waiting"] = True
+                docstring_state["function_indent"] = len(line) - len(line.lstrip())
+                docstring_state["removed_docstring"] = False
                 cleaned_lines.append(line)
                 continue
             if docstring_state["waiting"] and stripped:
                 if self._handle_docstring_start(stripped, docstring_state):
+                    if not docstring_state["in_docstring"]:
+                        if self._needs_pass_statement(
+                            lines, i + 1, docstring_state["function_indent"]
+                        ):
+                            pass_line = (
+                                " " * (docstring_state["function_indent"] + 4) + "pass"
+                            )
+                            cleaned_lines.append(pass_line)
+                    docstring_state["removed_docstring"] = True
                     continue
                 else:
                     docstring_state["waiting"] = False
             if docstring_state["in_docstring"]:
                 if self._handle_docstring_end(stripped, docstring_state):
+                    if self._needs_pass_statement(
+                        lines, i + 1, docstring_state["function_indent"]
+                    ):
+                        pass_line = (
+                            " " * (docstring_state["function_indent"] + 4) + "pass"
+                        )
+                        cleaned_lines.append(pass_line)
+                    docstring_state["removed_docstring"] = False
                     continue
                 else:
                     continue
+            if docstring_state["removed_docstring"] and stripped:
+                docstring_state["removed_docstring"] = False
             cleaned_lines.append(line)
 
         return "\n".join(cleaned_lines)
@@ -137,6 +164,22 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
             state["in_docstring"] = False
             state["delimiter"] = None
             return True
+        return False
+
+    def _needs_pass_statement(
+        self, lines: list[str], start_index: int, function_indent: int
+    ) -> bool:
+        for i in range(start_index, len(lines)):
+            line = lines[i]
+            stripped = line.strip()
+            if not stripped:
+                continue
+            line_indent = len(line) - len(line.lstrip())
+            if line_indent <= function_indent:
+                return True
+            if line_indent == function_indent + 4:
+                return False
+
         return True
 
     def remove_line_comments(self, code: str) -> str:
@@ -633,7 +676,7 @@ class Crackerjack(BaseModel, arbitrary_types_allowed=True):
             )
             if result.returncode == 0:
                 self.console.print("PDM installed: ✅\n")
-                self.execute_command(["pdm", "sync"])
+                self.execute_command(["pdm", "lock"])
                 self.console.print("Lock file updated: ✅\n")
             else:
                 self.console.print(

{crackerjack-0.21.4 → crackerjack-0.21.6}/crackerjack/pyproject.toml

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

{crackerjack-0.21.4 → crackerjack-0.21.6}/pyproject.toml

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

{crackerjack-0.21.4 → crackerjack-0.21.6}/tests/test_crackerjack.py

@@ -1091,6 +1091,7 @@ class TestCrackerjackProcess:
             mock_clean_file.assert_called_once_with(py_file)
 
     def test_code_cleaner_remove_docstrings(self) -> None:
+        import ast
         from rich.console import Console
         from crackerjack.crackerjack import CodeCleaner
 
@@ -1108,6 +1109,51 @@ class TestCrackerjackProcess:
         assert "This is a multi-line docstring." not in cleaned_code, (
             f"Got: {cleaned_code!r}"
         )
+        try:
+            ast.parse(cleaned_code)
+        except SyntaxError as e:
+            raise AssertionError(
+                f"Cleaned code is not valid Python syntax: {e}\nCode: {cleaned_code!r}"
+            )
+
+    def test_code_cleaner_remove_docstrings_empty_functions(self) -> None:
+        import ast
+        from rich.console import Console
+        from crackerjack.crackerjack import CodeCleaner
+
+        code_cleaner = CodeCleaner(console=Console())
+        test_code = """
+def empty_function():
+    pass
+
+class TestClass:
+
+    def method_with_docstring_only(self):
+        pass
+
+    def method_with_code(self):
+        return True
+"""
+
+        cleaned_code = code_cleaner.remove_docstrings(test_code)
+        print(f"Cleaned code: {cleaned_code!r}")
+
+        assert '"""This function has only a docstring."""' not in cleaned_code
+        assert '"""Class docstring."""' not in cleaned_code
+        assert '"""Method with only docstring."""' not in cleaned_code
+        assert '"""This method has code after docstring."""' not in cleaned_code
+
+        assert "def empty_function():\n    pass" in cleaned_code
+        assert "def method_with_docstring_only(self):\n        pass" in cleaned_code
+
+        assert "def method_with_code(self):\n        return True" in cleaned_code
+
+        try:
+            ast.parse(cleaned_code)
+        except SyntaxError as e:
+            raise AssertionError(
+                f"Cleaned code is not valid Python syntax: {e}\nCode: {cleaned_code!r}"
+            )
 
     def test_code_cleaner_remove_line_comments(self) -> None:
         from pathlib import Path