lapsed 2.6.0__tar.gz → 2.7.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lapsed
-Version: 2.6.0
+Version: 2.7.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.6.0
+    rev: 2.7.0
     hooks:
       - id: deadcode
 ```
@@ -227,6 +227,12 @@ code base is implemented in.
 - [ ] Investigate ways of extracting and backporting Python3.10+ `ast` implementation to lower Python versions.
 
 ## Release notes
+- v2.7.0:
+    - Treat `pytest_*` functions defined in `conftest.py` (e.g. `pytest_configure`,
+      `pytest_collection_modifyitems`, `pytest_addoption`) as pytest hooks, which pytest
+      calls automatically by name, and never report them as unused.
+    - Treat methods decorated with `@typing.override` (or `@typing_extensions.override`)
+      as used, since they are called via the base class they override, not by their own name.
 - 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

{lapsed-2.6.0 → lapsed-2.7.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.6.0
+    rev: 2.7.0
     hooks:
       - id: deadcode
 ```
@@ -199,6 +199,12 @@ code base is implemented in.
 - [ ] Investigate ways of extracting and backporting Python3.10+ `ast` implementation to lower Python versions.
 
 ## Release notes
+- v2.7.0:
+    - Treat `pytest_*` functions defined in `conftest.py` (e.g. `pytest_configure`,
+      `pytest_collection_modifyitems`, `pytest_addoption`) as pytest hooks, which pytest
+      calls automatically by name, and never report them as unused.
+    - Treat methods decorated with `@typing.override` (or `@typing_extensions.override`)
+      as used, since they are called via the base class they override, not by their own name.
 - 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

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

@@ -33,6 +33,7 @@ from deadcode.visitor.ignore import (
     _ignore_import,
     _ignore_function,
     _ignore_method,
+    _ignore_override,
     _ignore_pytest_fixture,
     _ignore_variable,
     _is_self_attribute,
@@ -442,6 +443,8 @@ class DeadCodeVisitor(ast.NodeVisitor):
             self._log(f'Ignoring {type_} "{node.name}" (decorator whitelisted)')
         elif _ignore_pytest_fixture(self.filename, decorator_names):
             self._log(f'Ignoring {type_} "{node.name}" (pytest fixture)')
+        elif _ignore_override(decorator_names):
+            self._log(f'Ignoring {type_} "{node.name}" (typing.override)')
         elif type_ == 'property':
             self._define(self.defined_props, node.name, node)
         elif type_ == 'method':

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

@@ -29,6 +29,11 @@ PYTEST_USEFIXTURES_DECORATOR_NAMES = {
     '@mark.usefixtures',
     '@usefixtures',
 }
+OVERRIDE_DECORATOR_NAMES = {
+    '@typing.override',
+    '@typing_extensions.override',
+    '@override',
+}
 
 ERROR_CODES = {
     'variable': b'DC01',
@@ -98,7 +103,19 @@ def _ignore_import(filename: Path, import_name: str) -> bool:
 
 
 def _ignore_function(filename: Path, function_name: str) -> bool:
-    return (function_name in PYTEST_FUNCTION_NAMES or function_name.startswith('test_')) and _is_test_file(filename)
+    return (
+        (function_name in PYTEST_FUNCTION_NAMES or function_name.startswith('test_')) and _is_test_file(filename)
+    ) or _ignore_pytest_hook(filename, function_name)
+
+
+def _ignore_pytest_hook(filename: Path, function_name: str) -> bool:
+    """
+    `pytest_*` functions in conftest.py (e.g. `pytest_configure`,
+    `pytest_collection_modifyitems`, `pytest_addoption`) are hook
+    implementations that pytest calls automatically by name, never directly,
+    so they would otherwise look unused.
+    """
+    return _is_conftest_file(filename) and function_name.startswith('pytest_')
 
 
 def _ignore_pytest_fixture(filename: Path, decorator_names: Iterable[str]) -> bool:
@@ -117,6 +134,16 @@ def _ignore_pytest_fixture(filename: Path, decorator_names: Iterable[str]) -> bo
     )
 
 
+def _ignore_override(decorator_names: Iterable[str]) -> bool:
+    """
+    `@typing.override` (and `@typing_extensions.override`) marks a method as
+    overriding one declared on a base class. The base class's method is what
+    calling code actually calls, so this override is used even though nothing
+    calls it by its own name directly.
+    """
+    return _match_many(decorator_names, OVERRIDE_DECORATOR_NAMES)
+
+
 def _ignore_method(filename: Path, method_name: str) -> bool:
     return _is_special_name(method_name) or (
         (method_name in PYTEST_METHOD_NAMES or method_name.startswith('test_')) and _is_test_file(filename)

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

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