crackerjack 0.14.3__py3-none-any.whl → 0.14.5__py3-none-any.whl

crackerjack/.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: check-added-large-files
         name: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.10
+    rev: v0.11.2
     hooks:
       - id: ruff-format
       - id: ruff
@@ -65,11 +65,11 @@ repos:
       - id: bandit
         args: ["-c", "pyproject.toml"]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.396
+    rev: v1.1.397
     hooks:
       - id: pyright
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.10
+    rev: v0.11.2
     hooks:
       - id: ruff
       - id: ruff-format

crackerjack/crackerjack.py

@@ -5,13 +5,13 @@ import subprocess
 import tokenize
 import typing as t
 from contextlib import suppress
+from dataclasses import dataclass, field
 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
 
@@ -20,7 +20,8 @@ interactive_hooks = ("refurb", "bandit", "pyright")
 default_python_version = "3.13"
 
 
-class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
+@dataclass
+class CodeCleaner:
     console: Console
 
     def clean_files(self, pkg_dir: Path | None) -> None:
@@ -35,25 +36,25 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
     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).")
+                self.console.print(f"Skipping cleaning of {file_path} (self file).")
                 return
         except Exception as e:
-            print(f"Error comparing file paths: {e}")
+            self.console.print(f"Error comparing file paths: {e}")
         try:
             code = file_path.read_text()
             code = self.remove_docstrings(code)
             code = self.remove_line_comments(code)
             code = self.remove_extra_whitespace(code)
             code = self.reformat_code(code)
-            file_path.write_text(code)
-            print(f"Cleaned: {file_path}")
+            file_path.write_text(code)  # type: ignore
+            self.console.print(f"Cleaned: {file_path}")
         except Exception as e:
-            print(f"Error cleaning {file_path}: {e}")
+            self.console.print(f"Error cleaning {file_path}: {e}")
 
     def remove_line_comments(self, code: str) -> str:
         new_lines = []
         for line in code.splitlines():
-            if "#" not in line or line.startswith("#"):
+            if "#" not in line:
                 new_lines.append(line)
                 continue
             idx = line.find("#")
@@ -66,31 +67,87 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
                     new_lines.append(code_part)
         return "\n".join(new_lines)
 
+    def _is_triple_quoted(self, token_string: str) -> bool:
+        triple_quote_patterns = [
+            ('"""', '"""'),
+            ("'''", "'''"),
+            ('r"""', '"""'),
+            ("r'''", "'''"),
+        ]
+        return any(
+            token_string.startswith(start) and token_string.endswith(end)
+            for start, end in triple_quote_patterns
+        )
+
+    def _is_module_docstring(
+        self, tokens: list[tokenize.TokenInfo], i: int, indent_level: int
+    ) -> bool:
+        if i <= 0 or indent_level != 0:
+            return False
+        preceding_tokens = tokens[:i]
+        return not preceding_tokens
+
+    def _is_function_or_class_docstring(
+        self,
+        tokens: list[tokenize.TokenInfo],
+        i: int,
+        last_token_type: t.Any,
+        last_token_string: str,
+    ) -> bool:
+        if last_token_type != tokenize.OP or last_token_string != ":":  # nosec B105
+            return False
+        for prev_idx in range(i - 1, max(0, i - 20), -1):
+            prev_token = tokens[prev_idx]
+            if prev_token[1] in ("def", "class") and prev_token[0] == tokenize.NAME:
+                return True
+            elif prev_token[0] == tokenize.DEDENT:
+                break
+        return False
+
+    def _is_variable_docstring(
+        self, tokens: list[tokenize.TokenInfo], i: int, indent_level: int
+    ) -> bool:
+        if indent_level <= 0:
+            return False
+        for prev_idx in range(i - 1, max(0, i - 10), -1):
+            if tokens[prev_idx][0]:
+                return True
+        return False
+
     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
+            result_tokens = []
+            indent_level = 0
+            last_non_ws_token_type = None
+            last_non_ws_token_string = ""  # nosec B105
+            for i, token in enumerate(tokens):
+                token_type, token_string, _, _, _ = token
                 if token_type == tokenize.INDENT:
-                    first_token_stack.append(True)
+                    indent_level += 1
                 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:
-                    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)
+                    indent_level -= 1
+                if token_type == STRING and self._is_triple_quoted(token_string):
+                    is_docstring = (
+                        self._is_module_docstring(tokens, i, indent_level)
+                        or self._is_function_or_class_docstring(
+                            tokens, i, last_non_ws_token_type, last_non_ws_token_string
+                        )
+                        or self._is_variable_docstring(tokens, i, indent_level)
+                    )
+                    if is_docstring:
+                        continue
+                if token_type not in (
+                    tokenize.NL,
+                    tokenize.NEWLINE,
+                    tokenize.INDENT,
+                    tokenize.DEDENT,
+                ):
+                    last_non_ws_token_type = token_type
+                    last_non_ws_token_string = token_string
+                result_tokens.append(token)
+            return tokenize.untokenize(result_tokens)
         except Exception as e:
             self.console.print(f"Error removing docstrings: {e}")
             return source
@@ -105,7 +162,7 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
             cleaned_lines.append(line)
         return "\n".join(cleaned_lines)
 
-    def reformat_code(self, code: str) -> str:
+    def reformat_code(self, code: str) -> str | None:
         try:
             import tempfile
 
@@ -124,21 +181,22 @@ class CodeCleaner(BaseModel, arbitrary_types_allowed=True):
                 if result.returncode == 0:
                     formatted_code = temp_path.read_text()
                 else:
-                    print(f"Ruff formatting failed: {result.stderr}")
+                    self.console.print(f"Ruff formatting failed: {result.stderr}")
                     formatted_code = code
             except Exception as e:
-                print(f"Error running Ruff: {e}")
+                self.console.print(f"Error running Ruff: {e}")
                 formatted_code = code
             finally:
                 with suppress(FileNotFoundError):
                     temp_path.unlink()
             return formatted_code
         except Exception as e:
-            print(f"Error during reformatting: {e}")
+            self.console.print(f"Error during reformatting: {e}")
             return code
 
 
-class ConfigManager(BaseModel, arbitrary_types_allowed=True):
+@dataclass
+class ConfigManager:
     our_path: Path
     pkg_path: Path
     pkg_name: str
@@ -262,14 +320,15 @@ class ConfigManager(BaseModel, arbitrary_types_allowed=True):
         return execute(cmd, **kwargs)
 
 
-class ProjectManager(BaseModel, arbitrary_types_allowed=True):
+@dataclass
+class ProjectManager:
     our_path: Path
     pkg_path: Path
-    pkg_dir: Path | None = None
-    pkg_name: str = "crackerjack"
     console: Console
     code_cleaner: CodeCleaner
     config_manager: ConfigManager
+    pkg_dir: Path | None = None
+    pkg_name: str = "crackerjack"
     dry_run: bool = False
 
     def run_interactive(self, hook: str) -> None:
@@ -321,39 +380,42 @@ class ProjectManager(BaseModel, arbitrary_types_allowed=True):
         return execute(cmd, **kwargs)
 
 
-class Crackerjack(BaseModel, arbitrary_types_allowed=True):
-    our_path: Path = Path(__file__).parent
-    pkg_path: Path = Path(Path.cwd())
+@dataclass
+class Crackerjack:
+    our_path: Path = field(default_factory=lambda: Path(__file__).parent)
+    pkg_path: Path = field(default_factory=lambda: Path(Path.cwd()))
     pkg_dir: Path | None = None
     pkg_name: str = "crackerjack"
     python_version: str = default_python_version
-    console: Console = Console(force_terminal=True)
+    console: Console = field(default_factory=lambda: Console(force_terminal=True))
     dry_run: bool = False
     code_cleaner: CodeCleaner | None = None
     config_manager: ConfigManager | None = None
     project_manager: ProjectManager | None = None
 
-    def __init__(self, **data: t.Any) -> None:
-        super().__init__(**data)
-        self.code_cleaner = CodeCleaner(console=self.console)
-        self.config_manager = ConfigManager(
-            our_path=self.our_path,
-            pkg_path=self.pkg_path,
-            pkg_name=self.pkg_name,
-            console=self.console,
-            python_version=self.python_version,
-            dry_run=self.dry_run,
-        )
-        self.project_manager = ProjectManager(
-            our_path=self.our_path,
-            pkg_path=self.pkg_path,
-            pkg_dir=self.pkg_dir,
-            pkg_name=self.pkg_name,
-            console=self.console,
-            code_cleaner=self.code_cleaner,
-            config_manager=self.config_manager,
-            dry_run=self.dry_run,
-        )
+    def __post_init__(self) -> None:
+        if self.code_cleaner is None:
+            self.code_cleaner = CodeCleaner(console=self.console)
+        if self.config_manager is None:
+            self.config_manager = ConfigManager(
+                our_path=self.our_path,
+                pkg_path=self.pkg_path,
+                pkg_name=self.pkg_name,
+                console=self.console,
+                python_version=self.python_version,
+                dry_run=self.dry_run,
+            )
+        if self.project_manager is None:
+            self.project_manager = ProjectManager(
+                our_path=self.our_path,
+                pkg_path=self.pkg_path,
+                pkg_dir=self.pkg_dir,
+                pkg_name=self.pkg_name,
+                console=self.console,
+                code_cleaner=self.code_cleaner,
+                config_manager=self.config_manager,
+                dry_run=self.dry_run,
+            )
 
     def _setup_package(self) -> None:
         self.pkg_name = self.pkg_path.stem.lower().replace("-", "_")

crackerjack/pyproject.toml

@@ -1,6 +1,34 @@
 [tool.pytest.ini_options]
 addopts = "--cov=crackerjack"
 asyncio_default_fixture_loop_scope = "function"
+python_files = ["test_*.py", "*_test.py"]
+python_classes = "Test*"
+python_functions = "test_*"
+asyncio_mode = "auto"
+
+[tool.coverage.run]
+branch = true
+source = ["crackerjack"]
+omit = [
+    "*/tests/*",
+    "*/site-packages/*",
+    "*/__pycache__/*",
+    "*/__init__.py",
+    ]
+
+[tool.coverage.report]
+exclude_also = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "pass",
+    "raise ImportError",
+    "except ImportError",
+    "def __str__",
+    "@abstractmethod",
+    ]
+ignore_errors = false
 
 [tool.codespell]
 skip = "*/data/*"
@@ -119,7 +147,7 @@ pythonPlatform = "Darwin"
 
 [project]
 name = "crackerjack"
-version = "0.14.2"
+version = "0.14.4"
 description = "Default template for PDM package"
 requires-python = ">=3.13"
 readme = "README.md"
@@ -146,12 +174,12 @@ classifiers = [
 ]
 dependencies = [
     "autotyping>=24.9.0",
-    "pre-commit>=4.1.0",
+    "pre-commit>=4.2.0",
     "pytest>=8.3.5",
     "pydantic>=2.10.6",
     "pdm-bump>=0.9.10",
     "pdm>=2.22.4",
-    "uv>=0.6.6",
+    "uv>=0.6.9",
     "pytest-cov>=6.0.0",
     "pytest-mock>=3.14.0",
     "tomli-w>=1.2.0",

{crackerjack-0.14.3.dist-info → crackerjack-0.14.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.14.3
+Version: 0.14.5
 Summary: Default template for PDM package
 Keywords: black,ruff,mypy,creosote,refurb
 Author-Email: lesleslie <les@wedgwoodwebworks.com>
@@ -23,12 +23,12 @@ Project-URL: documentation, https://github.com/lesleslie/crackerjack
 Project-URL: repository, https://github.com/lesleslie/crackerjack
 Requires-Python: >=3.13
 Requires-Dist: autotyping>=24.9.0
-Requires-Dist: pre-commit>=4.1.0
+Requires-Dist: pre-commit>=4.2.0
 Requires-Dist: pytest>=8.3.5
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: pdm-bump>=0.9.10
 Requires-Dist: pdm>=2.22.4
-Requires-Dist: uv>=0.6.6
+Requires-Dist: uv>=0.6.9
 Requires-Dist: pytest-cov>=6.0.0
 Requires-Dist: pytest-mock>=3.14.0
 Requires-Dist: tomli-w>=1.2.0

{crackerjack-0.14.3.dist-info → crackerjack-0.14.5.dist-info}/RECORD

@@ -1,12 +1,12 @@
-crackerjack-0.14.3.dist-info/METADATA,sha256=d1KMIGQ4kl0qLVeLrcwufpSOg_IDVQAxSYmv23RN6Gk,11033
-crackerjack-0.14.3.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-crackerjack-0.14.3.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-crackerjack-0.14.3.dist-info/licenses/LICENSE,sha256=fDt371P6_6sCu7RyqiZH_AhT1LdN3sN1zjBtqEhDYCk,1531
+crackerjack-0.14.5.dist-info/METADATA,sha256=kft0v_xwfOXdAYFhGrtaflsYXvnq5UfGLWJ2oZ7G6Js,11033
+crackerjack-0.14.5.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+crackerjack-0.14.5.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+crackerjack-0.14.5.dist-info/licenses/LICENSE,sha256=fDt371P6_6sCu7RyqiZH_AhT1LdN3sN1zjBtqEhDYCk,1531
 crackerjack/.coverage,sha256=dLzPzp72qZEXohNfxnOAlRwvM9dqF06-HoFqfvXZd1U,53248
 crackerjack/.gitignore,sha256=l8ErBAypC3rI6N9lhc7ZMdOw87t0Tz69ZW5C6uj15Wg,214
 crackerjack/.libcst.codemod.yaml,sha256=a8DlErRAIPV1nE6QlyXPAzTOgkB24_spl2E9hphuf5s,772
 crackerjack/.pdm.toml,sha256=dZe44HRcuxxCFESGG8SZIjmc-cGzSoyK3Hs6t4NYA8w,23
-crackerjack/.pre-commit-config.yaml,sha256=cLIzulHerHmCHjo5UWA2JAMm5d5PjwGpIp5Lx-nL3FQ,2267
+crackerjack/.pre-commit-config.yaml,sha256=rb_3cBRHFSzWYC1OW8mLkFC7A8Retb0zdyeIM5FUQ1I,2267
 crackerjack/.pytest_cache/.gitignore,sha256=Ptcxtl0GFQwTji2tsL4Gl1UIiKa0frjEXsya26i46b0,37
 crackerjack/.pytest_cache/CACHEDIR.TAG,sha256=N9yI75oKvt2-gQU6bdj9-xOvthMEXqHrSlyBWnSjveQ,191
 crackerjack/.pytest_cache/README.md,sha256=c_1vzN2ALEGaay2YPWwxc7fal1WKxLWJ7ewt_kQ9ua0,302
@@ -19,6 +19,7 @@ crackerjack/.ruff_cache/0.1.4/10355199064880463147,sha256=kmqNg5WySQYPeAqa5elfaV
 crackerjack/.ruff_cache/0.1.6/15140459877605758699,sha256=oQy5boAXeskdm5M0Abh_nyBtitWj5N5wtx_4gsDgu7c,248
 crackerjack/.ruff_cache/0.1.7/1790508110482614856,sha256=De7Puq32XF0925xrGehWSKX6cw5Wi2bpt1cnqh__f54,248
 crackerjack/.ruff_cache/0.1.9/17041001205004563469,sha256=tKP_k8HaHhQJyrHbDfJ93kM7vahjrU8cKQ1f_-OUzZY,248
+crackerjack/.ruff_cache/0.11.2/4070660268492669020,sha256=5oEl9zpN_cL4MPdtF1_mLFYyeFT5Wp6UI4h5twWAZ04,224
 crackerjack/.ruff_cache/0.2.0/10047773857155985907,sha256=j9LNa_RQ4Plor7go1uTYgz17cEENKvZQ-dP6b9MX0ik,248
 crackerjack/.ruff_cache/0.2.1/8522267973936635051,sha256=u_aPBMibtAp_iYvLwR88GMAECMcIgHezxMyuapmU2P4,248
 crackerjack/.ruff_cache/0.2.2/18053836298936336950,sha256=Xb_ebP0pVuUfSqPEZKlhQ70so_vqkEfMYpuHQ06iR5U,248
@@ -41,13 +42,13 @@ crackerjack/.ruff_cache/0.7.1/285614542852677309,sha256=mOHKRzKoSvW-1sHtqI_LHWRt
 crackerjack/.ruff_cache/0.7.3/16061516852537040135,sha256=AWJR9gmaO7-wpv8mY1homuwI8CrMPI3VrnbXH-wRPlg,224
 crackerjack/.ruff_cache/0.8.4/16354268377385700367,sha256=Ksz4X8N6Z1i83N0vV1PxmBRlqgjrtzmDCOg7VBF4baQ,224
 crackerjack/.ruff_cache/0.9.10/12813592349865671909,sha256=6yRYi5XvzLtzUymRBm6-DozDE48eJtLmaLGSghgY3Wo,224
-crackerjack/.ruff_cache/0.9.10/923908772239632759,sha256=ZS7bKHVE-HdGkSqM231c0JwcelE8GskD5ymNEjZmal0,224
+crackerjack/.ruff_cache/0.9.10/923908772239632759,sha256=XNakPJR4lyXTBP_I8A0Lpa8zo2WSQhbDnlRKD2lCNrI,224
 crackerjack/.ruff_cache/0.9.3/13948373885254993391,sha256=kGhtIkzPUtKAgvlKs3D8j4QM4qG8RhsHrmQJI69Sv3o,224
 crackerjack/.ruff_cache/0.9.9/12813592349865671909,sha256=tmr8_vhRD2OxsVuMfbJPdT9fDFX-d5tfC5U9jgziyho,224
 crackerjack/.ruff_cache/0.9.9/8843823720003377982,sha256=e4ymkXfQsUg5e_mtO34xTsaTvs1uA3_fI216Qq9qCAM,136
 crackerjack/.ruff_cache/CACHEDIR.TAG,sha256=WVMVbX4MVkpCclExbq8m-IcOZIOuIZf5FrYw5Pk-Ma4,43
 crackerjack/__init__.py,sha256=XTWW_XQkWR6dSydFSLg-T--eY3TPKUp4jUwZP11kgwY,142
 crackerjack/__main__.py,sha256=7SHrcRFYhMaSV0S-EG8q2w8udURwdvIsS7vi9AW4naU,3784
-crackerjack/crackerjack.py,sha256=KInDrWX--rXaL4EL7DYhceA6WiRDUOWgKC7rFS8VpIY,18951
-crackerjack/pyproject.toml,sha256=kcDxCcODGdFEYAjf42Oo7ufCa3skZJQeBIYUbda1i6A,3418
-crackerjack-0.14.3.dist-info/RECORD,,
+crackerjack/crackerjack.py,sha256=u3ulfgYbnuPGT7shM_upeJUWO_bB4ReC693bKncvkWg,21247
+crackerjack/pyproject.toml,sha256=Br1rZoz0srCo047TjrHgpuyUhcTw2AwbXCB61NEdmDI,3981
+crackerjack-0.14.5.dist-info/RECORD,,