deadcode 2.2.1__tar.gz → 2.3.0__tar.gz

{deadcode-2.2.1 → deadcode-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deadcode
-Version: 2.2.1
+Version: 2.3.0
 Summary: Find and remove dead code.
 Project-URL: Homepage, https://github.com/albertas/deadcode
 Project-URL: Documentation, https://deadcode.readthedocs.io/
@@ -19,10 +19,16 @@ Requires-Python: >=3.8
 Requires-Dist: tomli==2.0.1
 Description-Content-Type: text/markdown
 
-# deadcode
-`deadcode` allows to detect and fix unused Python code. It implements `DCXXX`
-static code linting rules for detecting unused code such as
-variables, functions and classes.
+[![Deadcode Logo](https://raw.githubusercontent.com/albertas/deadcode/main/docs/_static/deadcode-logo-readme.png)](https://deadcode.readthedocs.io/en/stable/)
+
+<h2 align="center">Find and Fix Unused Python Code</h2>
+
+<p align="center">
+<a href="https://github.com/albertas/deadcode/blob/main/LICENSE"><img alt="License: AGPLv3" src="https://raw.githubusercontent.com/albertas/deadcode/main/docs/_static/AGPLv3-license.svg"></a>
+<a href="https://pypi.org/project/deadcode/"><img alt="PyPI" src="https://img.shields.io/pypi/v/deadcode"></a>
+<a href="https://pepy.tech/project/deadcode"><img alt="Downloads" src="https://static.pepy.tech/badge/deadcode"></a>
+</p>
+
 
 ## Installation
 ```shell
@@ -30,11 +36,27 @@ pip install deadcode
 ```
 
 ## Usage
+To see unused code findings:
 ```shell
 deadcode .
 ```
 
-Or with command line options:
+To see suggested fixes for all files:
+```shell
+deadcode . --fix --dry
+```
+
+To see suggested fixes for only `foo.py` file:
+```shell
+deadcode . --fix --dry foo.py
+```
+
+To fix:
+```shell
+deadcode . --fix
+```
+
+Tune out some of the false positives, e.g.:
 ```
 deadcode . --exclude=venv,tests --ignore-names=BaseTestCase,*Mixin --ignore-names-in-files=migrations
 ```
@@ -52,6 +74,7 @@ ignore-names-in-files = ["migrations"]
 | Option&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Type | Meaning  |
 |-------------------------------------------|------|----------------------------------------------------------------------|
 |`--fix`                                    | -    | Automatically remove detected unused code expressions from the code base. |
+|`--dry`                                    | - or list | Show changes which would be made in files. Shows changes for provided filenames or shows all changes if no filename is specified. |
 |`--exclude`                                | list | Filenames (or path expressions), which will be completely skipped without being analysed. |
 |`--ignore-names`                           | list | Removes provided list of names from the output. Regexp expressions to match multiple names can also be provided, e.g. `*Mixin` will match all classes ending with `Mixin`. |
 |`--ignore-names-in-files`                  | list | Ignores unused names in files, which filenames match provided path expressions. |
@@ -77,27 +100,26 @@ definition - whole class or function definition expression including its name an
 ## Rules
 | Code   | Name               | Message        |
 |--------|--------------------|----------------|
-| DC001  | unused-variable    | Variable `{name}` is never used
-| DC002  | unused-function    | Function `{name}` is never used
-| DC003  | unused-class       | Class `{name}` is never used
-| DC004  | unused-method      | Method `{name}` is never used
-| DC005  | unused-attribute   | Attribute `{name}` is never used
-| DC006  | unused-name        | Name `{name}` is never used
-| DC007  | unused-import      | Import `{name}` is never used
-| DC008  | unused-property    | Property `{name}` is never used
-| DC009* | unreachable-code   | Unreachable `else` block
-| DC011  | empty-file         | Empty file
-| DC012* | commented-out-code | Commented out code
-| DC013* | ignore-expression  | *This error code can ony be used in `# noqa: DC013` comments (no errors will be reported for expression which begins in current line)*
-
-`*` - are not yet implemented rules.
+| DC01  | unused-variable      | Variable `{name}` is never used
+| DC02  | unused-function      | Function `{name}` is never used
+| DC03  | unused-class         | Class `{name}` is never used
+| DC04  | unused-method        | Method `{name}` is never used
+| DC05  | unused-attribute     | Attribute `{name}` is never used
+| DC06  | unused-name          | Name `{name}` is never used
+| DC07  | unused-import        | Import `{name}` is never used
+| DC08  | unused-property      | Property `{name}` is never used
+| DC09  | unreachable-if-block | Unreachable conditional statement block
+| DC11  | empty-file           | Empty Python file
+| DC12  | commented-out-code   | Commented out code
+| DC13  | unreachable-code     | Code after terminal statement, e.g. `return`, `raise`, `continue`, `break`
+| DC    | ignore-expression    | Do not show any findings for an expression, which starts on current line (this code can only be used in `# noqa: DC` comments)
 
 ## Ignoring checks with noqa comments
 Inline `# noqa` comments can be used to ignore `deadcode` checks.
-E.g. unused `Foo` class wont be detected/fixed because `# noqa: DC003` comment is used:
+E.g. unused `Foo` class wont be detected/fixed because `# noqa: DC03` comment is used:
 
 ```python
-class Foo:  # noqa: DC003
+class Foo:  # noqa: DC03
     pass
 ```
 
@@ -127,10 +149,10 @@ code base is implemented in.
 
 ## Feature requests
 - [x] Replace `.*` with only `*` in regexp matching.
-- [x] Add unused class method detection DC004 check.
+- [x] Add unused class method detection DC04 check.
 - [x] Add `--fix` option to automatically remove detected dead code occourencies
 - [x] Add a check for empty python files.
-- [x] Split error codes into DC001, DC002, DC003 for variables, functions, class.
+- [x] Split error codes into DC01, DC02, DC03 for variables, functions, class.
     - [x] Should have different codes for ignoring name and ignoring whole definition (reserved DCxx0 - ignore name, DCxx1 - ignore definition).
     - [ ] Allow to disable each check separately using:
         - [ ] inline comment.
@@ -144,4 +166,28 @@ code base is implemented in.
     - [ ] --ignore-definitions-if-decorated-with
     - [ ] --ignore-names-if-inherits-from
     - [ ] --ignore-names-if-decorated-with
+    - [ ] --ignore-bodies-of
+    - [ ] --ignore-bodies-if-decorated-with
+    - [ ] --ignore-bodies-if-inherits-from
+    - [ ] --ignore-definitions
+    - [ ] --ignore-definitions-if-inherits-from
+    - [ ] --ignore-definitions-if-decorated-with
+        - Question: would it be possible to ignore only certain types of checks for a body, e.g. only variable attributes of TypedDict and still check usage of methods and properties?
+        - What expression would allow this type of precission?
 - [ ] Distinguish between definitions with same name, but different files.
+- [ ] Repeated application of `deadcode` till the output stops changing.
+- [ ] Unreachable code detection and fixing: this should only be scoped for if statements and only limited to primitive variables.
+- [ ] `--fix --dry [filenames]` - only show whats about to change in the listed filenames.
+- [ ] Benchmarking performance with larger projects (time, CPU and memory consumption) in order to optimize.
+- [ ] `--fix` could accept a list of filenames as well (only those files would be changed, but the summary could would be full).
+    (This might be confusing, because filenames, which have to be considered are provided without any flag, --fix is expected to not accept arguments)
+- [ ] pre-commit-hook.
+- [ ] language server.
+- [ ] Use only two digits for error codes instead of 3. Two is plenty and it simplifies usage a bit
+- [ ] DC10: remove code after terminal statements like `raise`, `return`, `break`, `continue` and comes in the same scope.
+- [ ] Add `ignore` and `per-file-ignores` command line and pyproject.toml options, which allows to skip some rules.
+- [ ] Make sure that all rules are being skipped by `noqa` comment and all rules react to `noqa: rule_id` comments.
+- [ ] Include package names into code item scope (dot-separated path), e.g. "package1.package2.module.class.method.variable".
+- [ ] All options should be able to accept dot-separated path or a generic name, e.g. "marshmallow.Schema" vs "Schema",
+  documentation should cleary demonstrate the behaviour/example that "Schema" means "*.Schema".
+- [ ] Redefinition of an existing name makes previous name unreachable, unless it is assigned somehow.

{deadcode-2.2.1 → deadcode-2.3.0}/README.md

@@ -1,7 +1,13 @@
-# deadcode
-`deadcode` allows to detect and fix unused Python code. It implements `DCXXX`
-static code linting rules for detecting unused code such as
-variables, functions and classes.
+[![Deadcode Logo](https://raw.githubusercontent.com/albertas/deadcode/main/docs/_static/deadcode-logo-readme.png)](https://deadcode.readthedocs.io/en/stable/)
+
+<h2 align="center">Find and Fix Unused Python Code</h2>
+
+<p align="center">
+<a href="https://github.com/albertas/deadcode/blob/main/LICENSE"><img alt="License: AGPLv3" src="https://raw.githubusercontent.com/albertas/deadcode/main/docs/_static/AGPLv3-license.svg"></a>
+<a href="https://pypi.org/project/deadcode/"><img alt="PyPI" src="https://img.shields.io/pypi/v/deadcode"></a>
+<a href="https://pepy.tech/project/deadcode"><img alt="Downloads" src="https://static.pepy.tech/badge/deadcode"></a>
+</p>
+
 
 ## Installation
 ```shell
@@ -9,11 +15,27 @@ pip install deadcode
 ```
 
 ## Usage
+To see unused code findings:
 ```shell
 deadcode .
 ```
 
-Or with command line options:
+To see suggested fixes for all files:
+```shell
+deadcode . --fix --dry
+```
+
+To see suggested fixes for only `foo.py` file:
+```shell
+deadcode . --fix --dry foo.py
+```
+
+To fix:
+```shell
+deadcode . --fix
+```
+
+Tune out some of the false positives, e.g.:
 ```
 deadcode . --exclude=venv,tests --ignore-names=BaseTestCase,*Mixin --ignore-names-in-files=migrations
 ```
@@ -31,6 +53,7 @@ ignore-names-in-files = ["migrations"]
 | Option&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Type | Meaning  |
 |-------------------------------------------|------|----------------------------------------------------------------------|
 |`--fix`                                    | -    | Automatically remove detected unused code expressions from the code base. |
+|`--dry`                                    | - or list | Show changes which would be made in files. Shows changes for provided filenames or shows all changes if no filename is specified. |
 |`--exclude`                                | list | Filenames (or path expressions), which will be completely skipped without being analysed. |
 |`--ignore-names`                           | list | Removes provided list of names from the output. Regexp expressions to match multiple names can also be provided, e.g. `*Mixin` will match all classes ending with `Mixin`. |
 |`--ignore-names-in-files`                  | list | Ignores unused names in files, which filenames match provided path expressions. |
@@ -56,27 +79,26 @@ definition - whole class or function definition expression including its name an
 ## Rules
 | Code   | Name               | Message        |
 |--------|--------------------|----------------|
-| DC001  | unused-variable    | Variable `{name}` is never used
-| DC002  | unused-function    | Function `{name}` is never used
-| DC003  | unused-class       | Class `{name}` is never used
-| DC004  | unused-method      | Method `{name}` is never used
-| DC005  | unused-attribute   | Attribute `{name}` is never used
-| DC006  | unused-name        | Name `{name}` is never used
-| DC007  | unused-import      | Import `{name}` is never used
-| DC008  | unused-property    | Property `{name}` is never used
-| DC009* | unreachable-code   | Unreachable `else` block
-| DC011  | empty-file         | Empty file
-| DC012* | commented-out-code | Commented out code
-| DC013* | ignore-expression  | *This error code can ony be used in `# noqa: DC013` comments (no errors will be reported for expression which begins in current line)*
-
-`*` - are not yet implemented rules.
+| DC01  | unused-variable      | Variable `{name}` is never used
+| DC02  | unused-function      | Function `{name}` is never used
+| DC03  | unused-class         | Class `{name}` is never used
+| DC04  | unused-method        | Method `{name}` is never used
+| DC05  | unused-attribute     | Attribute `{name}` is never used
+| DC06  | unused-name          | Name `{name}` is never used
+| DC07  | unused-import        | Import `{name}` is never used
+| DC08  | unused-property      | Property `{name}` is never used
+| DC09  | unreachable-if-block | Unreachable conditional statement block
+| DC11  | empty-file           | Empty Python file
+| DC12  | commented-out-code   | Commented out code
+| DC13  | unreachable-code     | Code after terminal statement, e.g. `return`, `raise`, `continue`, `break`
+| DC    | ignore-expression    | Do not show any findings for an expression, which starts on current line (this code can only be used in `# noqa: DC` comments)
 
 ## Ignoring checks with noqa comments
 Inline `# noqa` comments can be used to ignore `deadcode` checks.
-E.g. unused `Foo` class wont be detected/fixed because `# noqa: DC003` comment is used:
+E.g. unused `Foo` class wont be detected/fixed because `# noqa: DC03` comment is used:
 
 ```python
-class Foo:  # noqa: DC003
+class Foo:  # noqa: DC03
     pass
 ```
 
@@ -106,10 +128,10 @@ code base is implemented in.
 
 ## Feature requests
 - [x] Replace `.*` with only `*` in regexp matching.
-- [x] Add unused class method detection DC004 check.
+- [x] Add unused class method detection DC04 check.
 - [x] Add `--fix` option to automatically remove detected dead code occourencies
 - [x] Add a check for empty python files.
-- [x] Split error codes into DC001, DC002, DC003 for variables, functions, class.
+- [x] Split error codes into DC01, DC02, DC03 for variables, functions, class.
     - [x] Should have different codes for ignoring name and ignoring whole definition (reserved DCxx0 - ignore name, DCxx1 - ignore definition).
     - [ ] Allow to disable each check separately using:
         - [ ] inline comment.
@@ -123,4 +145,28 @@ code base is implemented in.
     - [ ] --ignore-definitions-if-decorated-with
     - [ ] --ignore-names-if-inherits-from
     - [ ] --ignore-names-if-decorated-with
+    - [ ] --ignore-bodies-of
+    - [ ] --ignore-bodies-if-decorated-with
+    - [ ] --ignore-bodies-if-inherits-from
+    - [ ] --ignore-definitions
+    - [ ] --ignore-definitions-if-inherits-from
+    - [ ] --ignore-definitions-if-decorated-with
+        - Question: would it be possible to ignore only certain types of checks for a body, e.g. only variable attributes of TypedDict and still check usage of methods and properties?
+        - What expression would allow this type of precission?
 - [ ] Distinguish between definitions with same name, but different files.
+- [ ] Repeated application of `deadcode` till the output stops changing.
+- [ ] Unreachable code detection and fixing: this should only be scoped for if statements and only limited to primitive variables.
+- [ ] `--fix --dry [filenames]` - only show whats about to change in the listed filenames.
+- [ ] Benchmarking performance with larger projects (time, CPU and memory consumption) in order to optimize.
+- [ ] `--fix` could accept a list of filenames as well (only those files would be changed, but the summary could would be full).
+    (This might be confusing, because filenames, which have to be considered are provided without any flag, --fix is expected to not accept arguments)
+- [ ] pre-commit-hook.
+- [ ] language server.
+- [ ] Use only two digits for error codes instead of 3. Two is plenty and it simplifies usage a bit
+- [ ] DC10: remove code after terminal statements like `raise`, `return`, `break`, `continue` and comes in the same scope.
+- [ ] Add `ignore` and `per-file-ignores` command line and pyproject.toml options, which allows to skip some rules.
+- [ ] Make sure that all rules are being skipped by `noqa` comment and all rules react to `noqa: rule_id` comments.
+- [ ] Include package names into code item scope (dot-separated path), e.g. "package1.package2.module.class.method.variable".
+- [ ] All options should be able to accept dot-separated path or a generic name, e.g. "marshmallow.Schema" vs "Schema",
+  documentation should cleary demonstrate the behaviour/example that "Schema" means "*.Schema".
+- [ ] Redefinition of an existing name makes previous name unreachable, unless it is assigned somehow.

deadcode-2.3.0/black/action/main.py

@@ -0,0 +1,176 @@
+import os
+import re
+import shlex
+import shutil
+import sys
+from pathlib import Path
+from subprocess import PIPE, STDOUT, run
+from typing import Union
+
+ACTION_PATH = Path(os.environ["GITHUB_ACTION_PATH"])
+ENV_PATH = ACTION_PATH / ".black-env"
+ENV_BIN = ENV_PATH / ("Scripts" if sys.platform == "win32" else "bin")
+OPTIONS = os.getenv("INPUT_OPTIONS", default="")
+SRC = os.getenv("INPUT_SRC", default="")
+JUPYTER = os.getenv("INPUT_JUPYTER") == "true"
+BLACK_ARGS = os.getenv("INPUT_BLACK_ARGS", default="")
+VERSION = os.getenv("INPUT_VERSION", default="")
+USE_PYPROJECT = os.getenv("INPUT_USE_PYPROJECT") == "true"
+
+BLACK_VERSION_RE = re.compile(r"^black([^A-Z0-9._-]+.*)$", re.IGNORECASE)
+EXTRAS_RE = re.compile(r"\[.*\]")
+
+
+def determine_version_specifier() -> str:
+    """Determine the version of Black to install.
+
+    The version can be specified either via the `with.version` input or via the
+    pyproject.toml file if `with.use_pyproject` is set to `true`.
+    """
+    if USE_PYPROJECT and VERSION:
+        print(
+            "::error::'with.version' and 'with.use_pyproject' inputs are "
+            "mutually exclusive.",
+            file=sys.stderr,
+            flush=True,
+        )
+        sys.exit(1)
+    if USE_PYPROJECT:
+        return read_version_specifier_from_pyproject()
+    elif VERSION and VERSION[0] in "0123456789":
+        return f"=={VERSION}"
+    else:
+        return VERSION
+
+
+def read_version_specifier_from_pyproject() -> str:
+    if sys.version_info < (3, 11):
+        print(
+            "::error::'with.use_pyproject' input requires Python 3.11 or later.",
+            file=sys.stderr,
+            flush=True,
+        )
+        sys.exit(1)
+
+    import tomllib  # type: ignore[import-not-found,unreachable]
+
+    try:
+        with Path("pyproject.toml").open("rb") as fp:
+            pyproject = tomllib.load(fp)
+    except FileNotFoundError:
+        print(
+            "::error::'with.use_pyproject' input requires a pyproject.toml file.",
+            file=sys.stderr,
+            flush=True,
+        )
+        sys.exit(1)
+
+    version = pyproject.get("tool", {}).get("black", {}).get("required-version")
+    if version is not None:
+        return f"=={version}"
+
+    arrays = [
+        pyproject.get("project", {}).get("dependencies"),
+        *pyproject.get("project", {}).get("optional-dependencies", {}).values(),
+    ]
+    for array in arrays:
+        version = find_black_version_in_array(array)
+        if version is not None:
+            break
+
+    if version is None:
+        print(
+            "::error::'black' dependency missing from pyproject.toml.",
+            file=sys.stderr,
+            flush=True,
+        )
+        sys.exit(1)
+
+    return version
+
+
+def find_black_version_in_array(array: object) -> Union[str, None]:
+    if not isinstance(array, list):
+        return None
+    try:
+        for item in array:
+            # Rudimentary PEP 508 parsing.
+            item = item.split(";")[0]
+            item = EXTRAS_RE.sub("", item).strip()
+            if item == "black":
+                print(
+                    "::error::Version specifier missing for 'black' dependency in "
+                    "pyproject.toml.",
+                    file=sys.stderr,
+                    flush=True,
+                )
+                sys.exit(1)
+            elif m := BLACK_VERSION_RE.match(item):
+                return m.group(1).strip()
+    except TypeError:
+        pass
+
+    return None
+
+
+run([sys.executable, "-m", "venv", str(ENV_PATH)], check=True)
+
+version_specifier = determine_version_specifier()
+if JUPYTER:
+    extra_deps = "[colorama,jupyter]"
+else:
+    extra_deps = "[colorama]"
+if version_specifier:
+    req = f"black{extra_deps}{version_specifier}"
+else:
+    describe_name = ""
+    with open(ACTION_PATH / ".git_archival.txt", encoding="utf-8") as fp:
+        for line in fp:
+            if line.startswith("describe-name: "):
+                describe_name = line[len("describe-name: ") :].rstrip()
+                break
+    if not describe_name:
+        print("::error::Failed to detect action version.", file=sys.stderr, flush=True)
+        sys.exit(1)
+    # expected format is one of:
+    # - 23.1.0
+    # - 23.1.0-51-g448bba7
+    if describe_name.count("-") < 2:
+        # the action's commit matches a tag exactly, install exact version from PyPI
+        req = f"black{extra_deps}=={describe_name}"
+    else:
+        # the action's commit does not match any tag, install from the local git repo
+        req = f".{extra_deps}"
+print(f"Installing {req}...", flush=True)
+pip_proc = run(
+    [str(ENV_BIN / "python"), "-m", "pip", "install", req],
+    stdout=PIPE,
+    stderr=STDOUT,
+    encoding="utf-8",
+    cwd=ACTION_PATH,
+)
+if pip_proc.returncode:
+    print(pip_proc.stdout)
+    print("::error::Failed to install Black.", file=sys.stderr, flush=True)
+    sys.exit(pip_proc.returncode)
+
+
+base_cmd = [str(ENV_BIN / "black")]
+if BLACK_ARGS:
+    # TODO: remove after a while since this is deprecated in favour of SRC + OPTIONS.
+    proc = run(
+        [*base_cmd, *shlex.split(BLACK_ARGS)],
+        stdout=PIPE,
+        stderr=STDOUT,
+        encoding="utf-8",
+    )
+else:
+    proc = run(
+        [*base_cmd, *shlex.split(OPTIONS), *shlex.split(SRC)],
+        stdout=PIPE,
+        stderr=STDOUT,
+        encoding="utf-8",
+    )
+shutil.rmtree(ENV_PATH, ignore_errors=True)
+print(proc.stdout)
+sys.exit(proc.returncode)