python-constricter 0.2.5__tar.gz → 0.2.8__tar.gz

{python_constricter-0.2.5 → python_constricter-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: python-constricter
-Version: 0.2.5
+Version: 0.2.8
 Summary: Lint rules: every local variable is typed where it's first bound. A flake8 plugin, a pylint plugin and a standalone CLI.
 Author: Ivy Duggan
 Requires-Python: >=3.11
@@ -173,6 +173,8 @@ Options:
 | Option           | CLI                                                                                                                                                                          | `[tool.constricter]`                            | flake8 (CLI or config)          | pylint                            |
 | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------- | --------------------------------- |
 | level            | `--level`                                                                                                                                                                    | `level`                                         | `--constricter-level`           | `constricter-level`               |
+| strictest        | `--max`: `--level=suffocate` for every path, `--all-scopes`, and the opt-in `LVA012`                                                                                         | —                                               | —                               | —                                 |
+| every fix        | `--max-fix`: `--max`, `--fix --unsafe-fixes`, and `--infer-with` each of basedpyright and ty that's installed and runs                                                       | —                                               | —                               | —                                 |
 | type comments    | `--type-comments`                                                                                                                                                            | `type-comments`                                 | `--constricter-type-comments`   | `constricter-type-comments = yes` |
 | all scopes       | `--all-scopes`                                                                                                                                                               | `all-scopes`                                    | `--constricter-all-scopes`      | `constricter-all-scopes = yes`    |
 | nesting          | `--nesting N`                                                                                                                                                                | `nesting`                                       | `--constricter-nesting`         | `constricter-nesting`             |
@@ -231,12 +233,13 @@ ignore = ["LVA003"]
 
 `--fix` adds the annotation where the value decides it: a literal (`count = 0` becomes
 `count: int = 0`), a container whose elements agree, a constructor or a function that declares its
-return type (in another checked file too), a copy, subscript, attribute or method call of a local
-whose type is known, and values computed from those; a loop's target or an unpacking's names get a
-declaration on the line before. `--unsafe-fixes` adds guesses, and `--show-fixes` lists each fix and
-how its value decided it. `--infer-with basedpyright` (or `ty`, or `basedpyright,ty`, installed
-alongside) asks those type checkers for what `--fix` can't type itself, as guesses. The full list is
-in [docs/FIXES.md](https://github.com/ivylikethevine/python-constricter/blob/main/docs/FIXES.md).
+return type or whose `return`s agree (in another checked file too), a copy, subscript, attribute or
+method call of a local whose type is known, and values computed from those; a loop's target or an
+unpacking's names get a declaration on the line before. `--unsafe-fixes` adds guesses, and
+`--show-fixes` lists each fix and how its value decided it. `--infer-with basedpyright` (or `ty`, or
+`basedpyright,ty`, installed alongside) asks those type checkers for what `--fix` can't type itself,
+as guesses. The full list is in
+[docs/FIXES.md](https://github.com/ivylikethevine/python-constricter/blob/main/docs/FIXES.md).
 
 ### Installing and running
 
@@ -261,7 +264,7 @@ pre-commit, after ruff's hooks (or `constricter-fix`, which runs `--fix` first):
 
 ```yaml
 - repo: https://github.com/ivylikethevine/python-constricter
-  rev: v0.2.3
+  rev: v0.2.8
   hooks:
     - id: constricter
 ```

{python_constricter-0.2.5 → python_constricter-0.2.8}/README.md

@@ -146,6 +146,8 @@ Options:
 | Option           | CLI                                                                                                                                                                          | `[tool.constricter]`                            | flake8 (CLI or config)          | pylint                            |
 | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------- | --------------------------------- |
 | level            | `--level`                                                                                                                                                                    | `level`                                         | `--constricter-level`           | `constricter-level`               |
+| strictest        | `--max`: `--level=suffocate` for every path, `--all-scopes`, and the opt-in `LVA012`                                                                                         | —                                               | —                               | —                                 |
+| every fix        | `--max-fix`: `--max`, `--fix --unsafe-fixes`, and `--infer-with` each of basedpyright and ty that's installed and runs                                                       | —                                               | —                               | —                                 |
 | type comments    | `--type-comments`                                                                                                                                                            | `type-comments`                                 | `--constricter-type-comments`   | `constricter-type-comments = yes` |
 | all scopes       | `--all-scopes`                                                                                                                                                               | `all-scopes`                                    | `--constricter-all-scopes`      | `constricter-all-scopes = yes`    |
 | nesting          | `--nesting N`                                                                                                                                                                | `nesting`                                       | `--constricter-nesting`         | `constricter-nesting`             |
@@ -204,12 +206,13 @@ ignore = ["LVA003"]
 
 `--fix` adds the annotation where the value decides it: a literal (`count = 0` becomes
 `count: int = 0`), a container whose elements agree, a constructor or a function that declares its
-return type (in another checked file too), a copy, subscript, attribute or method call of a local
-whose type is known, and values computed from those; a loop's target or an unpacking's names get a
-declaration on the line before. `--unsafe-fixes` adds guesses, and `--show-fixes` lists each fix and
-how its value decided it. `--infer-with basedpyright` (or `ty`, or `basedpyright,ty`, installed
-alongside) asks those type checkers for what `--fix` can't type itself, as guesses. The full list is
-in [docs/FIXES.md](https://github.com/ivylikethevine/python-constricter/blob/main/docs/FIXES.md).
+return type or whose `return`s agree (in another checked file too), a copy, subscript, attribute or
+method call of a local whose type is known, and values computed from those; a loop's target or an
+unpacking's names get a declaration on the line before. `--unsafe-fixes` adds guesses, and
+`--show-fixes` lists each fix and how its value decided it. `--infer-with basedpyright` (or `ty`, or
+`basedpyright,ty`, installed alongside) asks those type checkers for what `--fix` can't type itself,
+as guesses. The full list is in
+[docs/FIXES.md](https://github.com/ivylikethevine/python-constricter/blob/main/docs/FIXES.md).
 
 ### Installing and running
 
@@ -234,7 +237,7 @@ pre-commit, after ruff's hooks (or `constricter-fix`, which runs `--fix` first):
 
 ```yaml
 - repo: https://github.com/ivylikethevine/python-constricter
-  rev: v0.2.3
+  rev: v0.2.8
   hooks:
     - id: constricter
 ```

{python_constricter-0.2.5 → python_constricter-0.2.8}/constricter/__init__.py

@@ -25,7 +25,7 @@ from constricter.offences import (
 )
 from constricter.rules.checker import Coverage, annotation_coverage, check_source, check_tree
 
-__version__ = "0.2.5"
+__version__ = "0.2.8"
 __all__ = [
     "COMMENT_TYPED_TARGET",
     "DEFAULT_CHECKS",

python_constricter-0.2.8/constricter/cli/collecting.py

@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: MIT
+"""The garbage collector, as the command runs it: by hand, once per file checked.
+
+A check keeps every file's tree (see `parsed`), and allocates a great deal for each file, little of it
+cyclic. Left to itself, the collector looked through the kept trees again and again as the check
+allocated: a third of the standard library's check (34s, 21s without). So while the command runs,
+it's off: what indexing built is frozen (never looked through again), and after each file, only
+what's been allocated since (the young generations) is collected, which bounds what a cycle can hold.
+"""
+
+import contextlib
+import gc
+from collections.abc import Generator
+from typing import Final
+
+_YOUNG: Final = 1  # the generations collected after each file: 0 and 1, never the frozen or the old
+_FREEZES: Final = hasattr(gc, "freeze")  # PyPy's collector has no freezing
+
+
+@contextlib.contextmanager
+def by_hand() -> Generator[None]:
+    """Turn automatic collection off for the command's run, and back as it was after.
+
+    Yields:
+      Nothing: the run.
+
+    """
+    was: bool = gc.isenabled()
+    gc.disable()
+    try:
+        yield
+    finally:
+        if _FREEZES:
+            gc.unfreeze()
+        if was:
+            gc.enable()
+
+
+def indexed() -> None:
+    """Freeze what indexing built (the kept trees, the index): it lives until the check takes it."""
+    if _FREEZES:
+        gc.freeze()
+
+
+def sweep() -> None:
+    """Collect what the file just checked left behind (see the module docstring)."""
+    _ = gc.collect(_YOUNG)