lapsed 2.4.2__tar.gz → 2.6.0__tar.gz

{lapsed-2.4.2 → lapsed-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lapsed
-Version: 2.4.2
+Version: 2.6.0
 Summary: Find and remove dead code.
 Project-URL: homepage, https://github.com/albertas/deadcode
 Project-URL: documentation, https://deadcode.readthedocs.io/
@@ -94,7 +94,7 @@ Create a `.pre-commit-config.yaml` file in the root of your project directory, i
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/albertas/deadcode
-    rev: 2.4.2
+    rev: 2.6.0
     hooks:
       - id: deadcode
 ```
@@ -117,6 +117,8 @@ repos:
 |`--ignore-definitions`                     | list | Ignores definition (including name and body) if a name of an expression matches any of the provided ones. |
 |`--ignore-definitions-if-inherits-from`    | list | Ignores definition (including name and body) of a class if it inherits from any of the provided class names. |
 |`--ignore-definitions-if-decorated-with`   | list | Ignores definition (including name and body) of an expression, which is decorated with any of the provided decorator names. |
+|`--ignore-non-self-attributes`             | -    | Does not report unused attributes assigned on objects other than `self`, e.g. `foo.bar = 1`. Such assignments may have side effects or be consumed by code outside of the analysed files, so they cannot safely be assumed dead. |
+|`--ignore-class-attributes`                | -    | Does not report unused attributes assigned directly in a class body, e.g. `THING = "blah"` inside a `class Foo:` block. Such attributes may control behaviour of inherited/overridden methods, external frameworks, or metaclasses, so they cannot safely be assumed dead. |
 |`--tach-config`                            | list | Paths to `tach.toml` files (see [Tach](https://docs.gauge.sh)). Names exposed via `[[interfaces]]` are treated as public API and never reported as unused; files in `unchecked = true` modules are skipped entirely. |
 |`--no-color`                               | -    | Removes colors from the output. |
 |`--count`                                  | -    | Provides the count of the detected unused names instead of printing them all out. |
@@ -225,6 +227,14 @@ code base is implemented in.
 - [ ] Investigate ways of extracting and backporting Python3.10+ `ast` implementation to lower Python versions.
 
 ## Release notes
+- v2.6.0:
+    - Add `--ignore-class-attributes` option to not report unused attributes assigned directly
+      in a class body (e.g. `THING = "blah"` inside `class Foo:`), since such attributes may
+      control behaviour of inherited/overridden methods, external frameworks, or metaclasses.
+- v2.5.0:
+    - Add `--ignore-non-self-attributes` option to not report unused attributes assigned on
+      objects other than `self` (e.g. `foo.bar = 1`), since such assignments may have side
+      effects or be consumed by code outside of the analysed files.
 - v2.4.2:
     - Add `--tach-config` option to read `tach.toml` file(s) and treat names exposed via `[[interfaces]]`
       as public API, and skip `unchecked = true` modules entirely.

{lapsed-2.4.2 → lapsed-2.6.0}/README.md

@@ -66,7 +66,7 @@ Create a `.pre-commit-config.yaml` file in the root of your project directory, i
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/albertas/deadcode
-    rev: 2.4.2
+    rev: 2.6.0
     hooks:
       - id: deadcode
 ```
@@ -89,6 +89,8 @@ repos:
 |`--ignore-definitions`                     | list | Ignores definition (including name and body) if a name of an expression matches any of the provided ones. |
 |`--ignore-definitions-if-inherits-from`    | list | Ignores definition (including name and body) of a class if it inherits from any of the provided class names. |
 |`--ignore-definitions-if-decorated-with`   | list | Ignores definition (including name and body) of an expression, which is decorated with any of the provided decorator names. |
+|`--ignore-non-self-attributes`             | -    | Does not report unused attributes assigned on objects other than `self`, e.g. `foo.bar = 1`. Such assignments may have side effects or be consumed by code outside of the analysed files, so they cannot safely be assumed dead. |
+|`--ignore-class-attributes`                | -    | Does not report unused attributes assigned directly in a class body, e.g. `THING = "blah"` inside a `class Foo:` block. Such attributes may control behaviour of inherited/overridden methods, external frameworks, or metaclasses, so they cannot safely be assumed dead. |
 |`--tach-config`                            | list | Paths to `tach.toml` files (see [Tach](https://docs.gauge.sh)). Names exposed via `[[interfaces]]` are treated as public API and never reported as unused; files in `unchecked = true` modules are skipped entirely. |
 |`--no-color`                               | -    | Removes colors from the output. |
 |`--count`                                  | -    | Provides the count of the detected unused names instead of printing them all out. |
@@ -197,6 +199,14 @@ code base is implemented in.
 - [ ] Investigate ways of extracting and backporting Python3.10+ `ast` implementation to lower Python versions.
 
 ## Release notes
+- v2.6.0:
+    - Add `--ignore-class-attributes` option to not report unused attributes assigned directly
+      in a class body (e.g. `THING = "blah"` inside `class Foo:`), since such attributes may
+      control behaviour of inherited/overridden methods, external frameworks, or metaclasses.
+- v2.5.0:
+    - Add `--ignore-non-self-attributes` option to not report unused attributes assigned on
+      objects other than `self` (e.g. `foo.bar = 1`), since such assignments may have side
+      effects or be consumed by code outside of the analysed files.
 - v2.4.2:
     - Add `--tach-config` option to read `tach.toml` file(s) and treat names exposed via `[[interfaces]]`
       as public API, and skip `unchecked = true` modules entirely.

{lapsed-2.4.2 → lapsed-2.6.0}/deadcode/actions/parse_arguments.py

@@ -167,6 +167,29 @@ def parse_arguments(args: Optional[List[str]]) -> Args:
         type=str,
     )
 
+    parser.add_argument(
+        '--ignore-non-self-attributes',
+        help=(
+            'Does not report unused attributes assigned on objects other than `self`, e.g. `foo.bar = 1` '
+            'where `foo` is not the first argument of the enclosing method. Such assignments may have '
+            'side effects or be consumed by code outside of the analysed files, so they cannot safely '
+            'be assumed dead.'
+        ),
+        action='store_true',
+        default=False,
+    )
+
+    parser.add_argument(
+        '--ignore-class-attributes',
+        help=(
+            'Does not report unused attributes assigned directly in a class body, e.g. `THING = "blah"` '
+            'inside a `class Foo:` block. Such attributes may control behaviour of inherited or overridden '
+            'methods, external frameworks, or metaclasses, so they cannot safely be assumed dead.'
+        ),
+        action='store_true',
+        default=False,
+    )
+
     parser.add_argument(
         '--tach-config',
         help=(

{lapsed-2.4.2 → lapsed-2.6.0}/deadcode/data_types.py

@@ -31,6 +31,8 @@ class Args:
     ignore_names_if_decorated_with: Iterable[Pathname] = ()
     ignore_names_if_inherits_from: Iterable[Pathname] = ()
     ignore_names_in_files: Iterable[Pathname] = ()
+    ignore_non_self_attributes: bool = False
+    ignore_class_attributes: bool = False
     tach_config: Iterable[Pathname] = ()
     no_color: bool = False
     quiet: bool = False

{lapsed-2.4.2 → lapsed-2.6.0}/deadcode/visitor/dead_code_visitor.py

@@ -35,6 +35,7 @@ from deadcode.visitor.ignore import (
     _ignore_method,
     _ignore_pytest_fixture,
     _ignore_variable,
+    _is_self_attribute,
 )
 
 logger = getLogger()
@@ -72,6 +73,11 @@ class DeadCodeVisitor(ast.NodeVisitor):
         # Note: scope is a stack containing current module name, class names, function names
         self.scope_parts: List[str] = []
 
+        # Parallel stack to scope_parts (module name excluded), tracking whether each
+        # pushed scope is a 'class' or a 'function', so that class-level attributes
+        # (assigned directly in a class body) can be told apart from local variables.
+        self.scope_kinds: List[str] = []
+
         # This flag is used to stop registering code definitions in a code item
         # during recursive its parsing
         self.should_ignore_new_definitions = False
@@ -100,6 +106,7 @@ class DeadCodeVisitor(ast.NodeVisitor):
                 filename = os.path.basename(file_path)
                 module_name = os.path.splitext(filename)[0]
                 self.scope_parts = [module_name]
+                self.scope_kinds = []
 
                 file_content = f.read()
                 if file_content.strip() or (filename.startswith('__') and filename.endswith('__.py')):
@@ -284,7 +291,13 @@ class DeadCodeVisitor(ast.NodeVisitor):
         else:
             collection.append(code_item)
 
+    def _is_directly_in_class_body(self) -> bool:
+        return bool(self.scope_kinds) and self.scope_kinds[-1] == 'class'
+
     def _define_variable(self, name: str, node: ast.AST) -> None:
+        if self.args.ignore_class_attributes and self._is_directly_in_class_body():
+            return
+
         self._define(
             self.defined_vars,
             name,
@@ -301,6 +314,8 @@ class DeadCodeVisitor(ast.NodeVisitor):
 
     def visit_Attribute(self, node: ast.Attribute) -> None:
         if isinstance(node.ctx, ast.Store):
+            if self.args.ignore_non_self_attributes and not _is_self_attribute(node):
+                return
             self._define(self.defined_attrs, node.attr, node)
         elif isinstance(node.ctx, ast.Load):
             self.add_used_name(node.attr)
@@ -502,8 +517,10 @@ class DeadCodeVisitor(ast.NodeVisitor):
         was_scope_increased = True
         if isinstance(node, ast.ClassDef):
             self.scope_parts.append(node.name)
+            self.scope_kinds.append('class')
         elif isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
             self.scope_parts.append(node.name)
+            self.scope_kinds.append('function')
         else:
             was_scope_increased = False
 
@@ -541,6 +558,7 @@ class DeadCodeVisitor(ast.NodeVisitor):
         # TODO: use decorator for this code chunk
         if was_scope_increased:
             self.scope_parts.pop()
+            self.scope_kinds.pop()
 
     def _handle_ast_list(self, ast_list: List[ast.AST]) -> None:
         """

{lapsed-2.4.2 → lapsed-2.6.0}/deadcode/visitor/ignore.py

@@ -123,6 +123,12 @@ def _ignore_method(filename: Path, method_name: str) -> bool:
     )
 
 
+def _is_self_attribute(node: ast.Attribute) -> bool:
+    """Whether an attribute assignment target is `self.attr` (as opposed to
+    e.g. `foo.attr`, where `foo` is some other object)."""
+    return isinstance(node.value, ast.Name) and node.value.id == 'self'
+
+
 def _ignore_variable(filename: Path, varname: str) -> bool:
     """
     Ignore _ (Python idiom), _x (pylint convention) and

{lapsed-2.4.2 → lapsed-2.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lapsed"
-version = "2.4.2"
+version = "2.6.0"
 authors = [
     {name = "Albertas Gimbutas", email = "albertasgim@gmail.com"},
 ]