crackerjack 0.13.1__tar.gz → 0.14.0__tar.gz

{crackerjack-0.13.1 → crackerjack-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.13.1
+Version: 0.14.0
 Summary: Default template for PDM package
 Keywords: black,ruff,mypy,creosote,refurb
 Author-Email: lesleslie <les@wedgwoodwebworks.com>
@@ -167,7 +167,7 @@ Run Crackerjack from the root of your Python project using:
 -   `-n`, `--no-config-updates`: Skip updating configuration files (e.g., `pyproject.toml`).
 -   `-u`, `--update-precommit`: Update pre-commit hooks to the latest versions.
 -   `-d`, `--doc`: Generate documentation.  (not yet implemented)
--   `-v`, `--verbose`: Enable verbose output. (not yet implemented)
+-   `-v`, `--verbose`: Enable verbose output.
 -   `-p`, `--publish <micro|minor|major>`: Bump the project version and publish to PyPI using PDM.
 -   `-b`, `--bump <micro|minor|major>`: Bump the project version without publishing.
 -   `-x`, `--clean`: Clean code by removing docstrings, line comments, and extra whitespace.

{crackerjack-0.13.1 → crackerjack-0.14.0}/README.md

@@ -128,7 +128,7 @@ Run Crackerjack from the root of your Python project using:
 -   `-n`, `--no-config-updates`: Skip updating configuration files (e.g., `pyproject.toml`).
 -   `-u`, `--update-precommit`: Update pre-commit hooks to the latest versions.
 -   `-d`, `--doc`: Generate documentation.  (not yet implemented)
--   `-v`, `--verbose`: Enable verbose output. (not yet implemented)
+-   `-v`, `--verbose`: Enable verbose output.
 -   `-p`, `--publish <micro|minor|major>`: Bump the project version and publish to PyPI using PDM.
 -   `-b`, `--bump <micro|minor|major>`: Bump the project version without publishing.
 -   `-x`, `--clean`: Clean code by removing docstrings, line comments, and extra whitespace.

{crackerjack-0.13.1 → crackerjack-0.14.0}/crackerjack/__init__.py

@@ -1,4 +1,5 @@
 from typing import Sequence
+
 from .crackerjack import Crackerjack, crackerjack_it
 
 __all__: Sequence[str] = ["crackerjack_it", "Crackerjack"]

{crackerjack-0.13.1 → crackerjack-0.14.0}/crackerjack/__main__.py

@@ -1,5 +1,6 @@
 import typing as t
 from enum import Enum
+
 import typer
 from pydantic import BaseModel, field_validator
 from rich.console import Console

{crackerjack-0.13.1 → crackerjack-0.14.0}/crackerjack/crackerjack.py

@@ -1,13 +1,16 @@
-import ast
+import io
 import platform
 import re
 import subprocess
+import tokenize
 import typing as t
 from contextlib import suppress
 from pathlib import Path
 from subprocess import CompletedProcess
 from subprocess import run as execute
+from token import STRING
 from tomllib import loads
+
 from pydantic import BaseModel
 from rich.console import Console
 from tomli_w import dumps
@@ -30,6 +33,12 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
             pkg_dir.parent.joinpath("__pycache__").rmdir()
 
     def clean_file(self, file_path: Path) -> None:
+        try:
+            if file_path.resolve() == Path(__file__).resolve():
+                print(f"Skipping cleaning of {file_path} (self file).")
+                return
+        except Exception as e:
+            print(f"Error comparing file paths: {e}")
         try:
             code = file_path.read_text()
             code = self.remove_docstrings(code)
@@ -41,37 +50,50 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
         except Exception as e:
             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)
-
     def remove_line_comments(self, code: str) -> str:
-        lines = code.split("\n")
-        cleaned_lines = []
-        for line in lines:
-            comment_match = re.search("(?<!\\S)#(.*)", line)
-            if comment_match is None:
-                cleaned_lines.append(line)
+        new_lines = []
+        for line in code.splitlines():
+            if "#" not in line:
+                new_lines.append(line)
                 continue
-            comment_start = comment_match.start()
-            code_part = line[:comment_start].rstrip()
-            comment = line[comment_start:].strip()
-            if code_part:
-                if re.match("^#(?: type: ignore| noqa)(.*)?$", comment):
-                    cleaned_lines.append(line)
+            idx = line.find("#")
+            code_part = line[:idx].rstrip()
+            comment_part = line[idx:]
+            if "type: ignore" in comment_part or "noqa" in comment_part:
+                new_lines.append(line)
+            else:
+                if code_part:
+                    new_lines.append(code_part)
+        return "\n".join(new_lines)
+
+    def remove_docstrings(self, source: str) -> str:
+        try:
+            io_obj = io.StringIO(source)
+            output_tokens = []
+            first_token_stack = [True]
+            tokens = list(tokenize.generate_tokens(io_obj.readline))
+            for tok in tokens:
+                token_type = tok.type
+                if token_type == tokenize.INDENT:
+                    first_token_stack.append(True)
+                elif token_type == tokenize.DEDENT:
+                    if len(first_token_stack) > 1:
+                        first_token_stack.pop()
+                if token_type == STRING and first_token_stack[-1]:
+                    first_token_stack[-1] = False
+                    continue
                 else:
-                    cleaned_lines.append(code_part)
-        return "\n".join(cleaned_lines)
+                    if token_type not in (
+                        tokenize.NEWLINE,
+                        tokenize.NL,
+                        tokenize.COMMENT,
+                    ):
+                        first_token_stack[-1] = False
+                output_tokens.append(tok)
+            return tokenize.untokenize(output_tokens)
+        except Exception as e:
+            self.console.print(f"Error removing docstrings: {e}")
+            return source
 
     def remove_extra_whitespace(self, code: str) -> str:
         lines = code.split("\n")
@@ -376,7 +398,10 @@ class Crackerjack(BaseModel, arbitrary_types_allowed=True):
     def _run_tests(self, options: t.Any) -> None:
         if options.test:
             self.console.print("\n\nRunning tests...\n")
-            result = self.execute_command(["pytest"], capture_output=True, text=True)
+            test = ["pytest"]
+            if options.verbose:
+                test.append("-v")
+            result = self.execute_command(test, capture_output=True, text=True)
             if result.stdout:
                 self.console.print(result.stdout)
             if result.returncode > 0:

{crackerjack-0.13.1 → crackerjack-0.14.0}/crackerjack/pyproject.toml

@@ -120,7 +120,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.13.0"
+version = "0.13.2"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"

{crackerjack-0.13.1 → crackerjack-0.14.0}/pyproject.toml

@@ -124,7 +124,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.13.1"
+version = "0.14.0"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"

crackerjack-0.14.0/tests/data/comments_sample.txt

@@ -0,0 +1,57 @@
+def test_func():
+    # This comment should be removed
+    return True  # remove this inline comment
+
+# Full line comment
+x = 1  # type: ignore
+y = 2 # noqa
+
+
+class AsyncRedisBytecodeCache(AsyncBytecodeCache):
+    prefix: str | None
+    client: Redis | RedisCluster  # type: ignore
+    configs: MappingProxyType[str, t.Any]
+
+    def __init__(
+        self,
+        prefix: str | None = None,
+        client: Redis | RedisCluster | None = None,   # type: ignore
+        **configs: t.Any,
+    ) -> None:
+        self.prefix = prefix
+        self.client = client or Redis(**configs)
+        self.configs = MappingProxyType(configs)
+
+    def get_cache_key(self, name: str, filename: str | None = None) -> str:
+        return filename or name
+
+    def get_source_checksum(self, source: str) -> str:
+        return str(hash(source))
+
+    def get_bucket_name(self, key: str) -> str:
+        return ":".join([self.prefix, key]) if self.prefix else key
+
+    async def load_bytecode(self, bucket: Bucket) -> t.Optional[bytes]:  # type: ignore[override]
+        code = await self.client.get(self.get_bucket_name(bucket.key)) # type: ignore
+        if code:
+            bucket.bytecode_from_string(code)
+            # Note: bucket.bytecode_from_string returns None but modifies bucket.code internally.
+            return code
+        return None
+
+    async def dump_bytecode(self, bucket: Bucket) -> None:  # type: ignore[override]
+        await self.client.set(  # type: ignore
+            self.get_bucket_name(bucket.key), bucket.bytecode_to_string()
+        )
+
+    async def get_bucket(  # type: ignore[override]
+        self, environment: Environment, name: str, filename: str | None, source: str
+    ) -> Bucket:
+        key = self.get_cache_key(name, filename or name)
+        checksum = self.get_source_checksum(source)
+        bucket = Bucket(environment, key, checksum)
+        await self.load_bytecode(bucket)
+        return bucket
+
+    async def set_bucket(self, bucket: Bucket) -> None:  # type: ignore[override]
+        await self.dump_bytecode(bucket)

crackerjack-0.14.0/tests/data/expected_comments_sample.txt

@@ -0,0 +1,54 @@
+def test_func():
+    return True
+
+x = 1  # type: ignore
+y = 2 # noqa
+
+
+class AsyncRedisBytecodeCache(AsyncBytecodeCache):
+    prefix: str | None
+    client: Redis | RedisCluster  # type: ignore
+    configs: MappingProxyType[str, t.Any]
+
+    def __init__(
+        self,
+        prefix: str | None = None,
+        client: Redis | RedisCluster | None = None,   # type: ignore
+        **configs: t.Any,
+    ) -> None:
+        self.prefix = prefix
+        self.client = client or Redis(**configs)
+        self.configs = MappingProxyType(configs)
+
+    def get_cache_key(self, name: str, filename: str | None = None) -> str:
+        return filename or name
+
+    def get_source_checksum(self, source: str) -> str:
+        return str(hash(source))
+
+    def get_bucket_name(self, key: str) -> str:
+        return ":".join([self.prefix, key]) if self.prefix else key
+
+    async def load_bytecode(self, bucket: Bucket) -> t.Optional[bytes]:  # type: ignore[override]
+        code = await self.client.get(self.get_bucket_name(bucket.key)) # type: ignore
+        if code:
+            bucket.bytecode_from_string(code)
+            return code
+        return None
+
+    async def dump_bytecode(self, bucket: Bucket) -> None:  # type: ignore[override]
+        await self.client.set(  # type: ignore
+            self.get_bucket_name(bucket.key), bucket.bytecode_to_string()
+        )
+
+    async def get_bucket(  # type: ignore[override]
+        self, environment: Environment, name: str, filename: str | None, source: str
+    ) -> Bucket:
+        key = self.get_cache_key(name, filename or name)
+        checksum = self.get_source_checksum(source)
+        bucket = Bucket(environment, key, checksum)
+        await self.load_bytecode(bucket)
+        return bucket
+
+    async def set_bucket(self, bucket: Bucket) -> None:  # type: ignore[override]
+        await self.dump_bytecode(bucket)

{crackerjack-0.13.1 → crackerjack-0.14.0}/tests/test_crackerjack.py

@@ -3,6 +3,7 @@ import typing as t
 from enum import Enum
 from pathlib import Path
 from unittest.mock import MagicMock, patch
+
 import pytest
 from pydantic import BaseModel
 from rich.console import Console
@@ -905,26 +906,26 @@ class TestCrackerjackProcess:
         assert '"""Method docstring."""' not in cleaned_code, f"Got: {cleaned_code!r}"
 
     def test_code_cleaner_remove_line_comments(self) -> None:
+        from pathlib import Path
+
         from rich.console import Console
         from crackerjack.crackerjack import CodeCleaner
 
         code_cleaner = CodeCleaner(console=Console())
         code_with_comments = (
-            Path(__file__).parent / "data" / "comments_sample.txt"
-        ).read_text()
+            (Path(__file__).parent / "data" / "comments_sample.txt")
+            .read_text()
+            .rstrip()
+        )
         cleaned_code = code_cleaner.remove_line_comments(code_with_comments)
-        assert "x = 1  # type: ignore" in cleaned_code, f"Got: {cleaned_code!r}"
-        assert "y = 2  # noqa" in cleaned_code, f"Got: {cleaned_code!r}"
-        assert "# This comment should be removed" not in cleaned_code, (
-            f"Got: {cleaned_code!r}"
+        expected_cleaned = (
+            (Path(__file__).parent / "data" / "expected_comments_sample.txt")
+            .read_text()
+            .rstrip()
         )
-        assert "# remove this inline comment" not in cleaned_code, (
-            f"Got: {cleaned_code!r}"
+        assert cleaned_code == expected_cleaned, (
+            f"Cleaned code does not match expected.\nExpected:\n{expected_cleaned}\nGot:\n{cleaned_code}"
         )
-        assert (
-            "def test_func():\n    return True\n\nx = 1  # type: ignore\ny = 2  # noqa\n"
-            in cleaned_code
-        ), f"Got: {cleaned_code!r}"
 
     def test_code_cleaner_remove_extra_whitespace(self) -> None:
         from rich.console import Console

{crackerjack-0.13.1 → crackerjack-0.14.0}/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, create_options

crackerjack-0.13.1/tests/data/comments_sample.txt

@@ -1,7 +0,0 @@
-def test_func():
-    # This comment should be removed
-    return True  # remove this inline comment
-
-# Full line comment
-x = 1  # type: ignore
-y = 2  # noqa