deadcode 2.3.1__tar.gz → 2.4.0__tar.gz

{deadcode-2.3.1 → deadcode-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deadcode
-Version: 2.3.1
+Version: 2.4.0
 Summary: Find and remove dead code.
 Project-URL: homepage, https://github.com/albertas/deadcode
 Project-URL: documentation, https://deadcode.readthedocs.io/
@@ -11,12 +11,10 @@ Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: tomli>=2.0.1
 Provides-Extra: test
 Requires-Dist: hatch; extra == 'test'
@@ -32,9 +30,10 @@ Description-Content-Type: text/markdown
 <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://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit" alt="pre-commit" style="max-width:100%;"></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>
+<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>
 </p>
 
 
@@ -56,7 +55,7 @@ deadcode . --fix --dry
 
 To see suggested fixes only for `foo.py` file:
 ```shell
-deadcode . --fix --dry foo.py
+deadcode . --fix --dry --only foo.py
 ```
 
 To fix:
@@ -82,7 +81,8 @@ 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. |
+|`--dry`                                    | -    | Show changes which would be made in files. |
+|`--only`                                   | list | Filenames (or path expressions), that will be reflected in the output (and modified if needed). |
 |`--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. |
@@ -100,9 +100,9 @@ ignore-names-in-files = ["migrations"]
 
 
 ##### Glossory
-name - variable, function or class name.
-body - code block which follows after `:` in function or class definition.
-definition - whole class or function definition expression including its name and body.
+- `name` - variable, function or class name.
+- `body` - code block which follows after `:` in function or class definition.
+- `definition` - whole class or function definition expression including its name and body.
 
 
 ## Rules
@@ -185,13 +185,11 @@ code base is implemented in.
 - [ ] 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.
-- [x] `--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.
-- [x] 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.
@@ -200,8 +198,15 @@ code base is implemented in.
   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.
 - [ ] Check if file is still valid/parsable after automatic fixing, if not: halt the change and report error.
+- [ ] Investigate ways of extracting and backporting Python3.10+ `ast` implementation to lower Python versions.
 
 ## Release notes
+- v2.4.0:
+    - Add `--only` option that accepts filenames only which will be reflected in the output and modified.
+      This option can be used with `--fix` and `--fix --dry` options as well as for simple unused code detection without fixing.
+- v2.3.2:
+    - Add `pre-commit` hook support.
+    - Drop support for Python 3.8 and 3.9 versions, since their `ast` implementation is lacking features.
 - v2.3.1:
     - Started analysing files in bytes instead of trying to convert them into UTF-8 encoded strings.
     - Improved automatic removal of unused imports.

{deadcode-2.3.1 → deadcode-2.4.0}/README.md

@@ -3,9 +3,10 @@
 <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://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit" alt="pre-commit" style="max-width:100%;"></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>
+<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>
 </p>
 
 
@@ -27,7 +28,7 @@ deadcode . --fix --dry
 
 To see suggested fixes only for `foo.py` file:
 ```shell
-deadcode . --fix --dry foo.py
+deadcode . --fix --dry --only foo.py
 ```
 
 To fix:
@@ -53,7 +54,8 @@ 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. |
+|`--dry`                                    | -    | Show changes which would be made in files. |
+|`--only`                                   | list | Filenames (or path expressions), that will be reflected in the output (and modified if needed). |
 |`--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. |
@@ -71,9 +73,9 @@ ignore-names-in-files = ["migrations"]
 
 
 ##### Glossory
-name - variable, function or class name.
-body - code block which follows after `:` in function or class definition.
-definition - whole class or function definition expression including its name and body.
+- `name` - variable, function or class name.
+- `body` - code block which follows after `:` in function or class definition.
+- `definition` - whole class or function definition expression including its name and body.
 
 
 ## Rules
@@ -156,13 +158,11 @@ code base is implemented in.
 - [ ] 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.
-- [x] `--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.
-- [x] 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.
@@ -171,8 +171,15 @@ code base is implemented in.
   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.
 - [ ] Check if file is still valid/parsable after automatic fixing, if not: halt the change and report error.
+- [ ] Investigate ways of extracting and backporting Python3.10+ `ast` implementation to lower Python versions.
 
 ## Release notes
+- v2.4.0:
+    - Add `--only` option that accepts filenames only which will be reflected in the output and modified.
+      This option can be used with `--fix` and `--fix --dry` options as well as for simple unused code detection without fixing.
+- v2.3.2:
+    - Add `pre-commit` hook support.
+    - Drop support for Python 3.8 and 3.9 versions, since their `ast` implementation is lacking features.
 - v2.3.1:
     - Started analysing files in bytes instead of trying to convert them into UTF-8 encoded strings.
     - Improved automatic removal of unused imports.

deadcode-2.4.0/deadcode/__init__.py

@@ -0,0 +1,6 @@
+try:
+    import importlib.metadata
+    __version__ = importlib.metadata.version(__package__ or __name__)
+except ImportError:
+    import importlib_metadata
+    __version__ = importlib_metadata.version(__package__ or __name__)

{deadcode-2.3.1 → deadcode-2.4.0}/deadcode/actions/fix_or_show_unused_code.py

@@ -38,22 +38,28 @@ def fix_or_show_unused_code(unused_items: Iterable[CodeItem], args: Args) -> str
         updated_file_content_lines = remove_file_parts_from_content(file_content_lines, unused_file_parts)
         updated_file_content = b''.join(updated_file_content_lines)
         if updated_file_content.strip():
-            if args.dry and ('__all_files__' in args.dry or _match(filename, args.dry)):
-                with open(filename, 'rb') as f:
-                    filename_bytes = filename.encode()
-                    diff = diff_bytes(unified_diff, f.readlines(), updated_file_content_lines,
-                                      fromfile=filename_bytes, tofile=filename_bytes)
-                    # TODO: consider printing result instantly to save memory
-                    result_chunk = b''.join(diff)
-                    if args.no_color:
-                        result.append(result_chunk)
-                    else:
-                        result.append(add_colors_to_diff(result_chunk))
+            if not args.only or _match(filename, args.only):
+                if args.dry:
+                    with open(filename, 'rb') as f:
+                        filename_bytes = filename.encode()
+                        diff = diff_bytes(
+                            unified_diff,
+                            f.readlines(),
+                            updated_file_content_lines,
+                            fromfile=filename_bytes,
+                            tofile=filename_bytes,
+                        )
+                        # TODO: consider printing result instantly to save memory
+                        result_chunk = b''.join(diff)
+                        if args.no_color:
+                            result.append(result_chunk)
+                        else:
+                            result.append(add_colors_to_diff(result_chunk))
 
-            elif args.fix:
-                with open(filename, 'wb') as f:
-                    # TODO: is there a method writelines?
-                    f.write(updated_file_content)
+                elif args.fix:
+                    with open(filename, 'wb') as f:
+                        # TODO: is there a method writelines?
+                        f.write(updated_file_content)
         else:
             os.remove(filename)
 

deadcode-2.4.0/deadcode/actions/get_unused_names_error_message.py

@@ -0,0 +1,37 @@
+from typing import Iterable, Optional
+
+from deadcode.data_types import Args
+from deadcode.visitor.code_item import CodeItem
+from deadcode.visitor.ignore import _match
+
+
+def get_unused_names_error_message(unused_names: Iterable[CodeItem], args: Args) -> Optional[str]:
+    unused_names = list(unused_names)
+
+    if not unused_names:
+        return None
+
+    if args.quiet:
+        return ''
+
+    if args.count:
+        return f'{len(unused_names)}'
+
+    messages = []
+    for item in unused_names:
+        if not args.only or _match(item.filename, args.only):
+            message = f'{item.filename_with_position} \033[91m{item.error_code}\033[0m '
+            message += item.message or (
+                f"{item.type_.replace('_', ' ').capitalize()} " f"`\033[1m{item.name}\033[0m` " f"is never used"
+            )
+            if args.no_color:
+                message = message.replace('\033[91m', '').replace('\033[1m', '').replace('\033[0m', '')
+            messages.append(message)
+
+    if args.fix:
+        message = f"\nRemoved \033[1m{len(messages)}\033[0m unused code item{'s' if len(messages) > 1 else ''}!"
+        if args.no_color:
+            message = message.replace('\x1b[1m', '').replace('\x1b[0m', '')
+        messages.append(message)
+
+    return '\n'.join(messages)

{deadcode-2.3.1 → deadcode-2.4.0}/deadcode/actions/parse_arguments.py

@@ -36,9 +36,15 @@ def parse_arguments(args: Optional[List[str]]) -> Args:
     parser.add_argument(
         '--dry',
         help='Show changes which would be made in files with --fix option.',
+        action='store_true',
+        default=False,
+    )
+    parser.add_argument(
+        '--only',
+        help='Filenames (or path expressions), that will be reflected in the output and modified.',
         nargs='*',
         action='append',
-        default=[['__all_files__']],
+        default=[],
         type=str,
     )
     parser.add_argument(
@@ -200,10 +206,6 @@ def parse_arguments(args: Optional[List[str]]) -> Args:
         if key in parsed_args:
             parsed_args[key].extend(item)
 
-    # Show changes for only provided files instead of all
-    if len(parsed_args['dry']) > 1 or '--dry' not in args:
-        parsed_args['dry'].remove('__all_files__')
-
     # Do not fix if dry option is provided:
     if parsed_args['dry']:
         parsed_args['fix'] = False

{deadcode-2.3.1 → deadcode-2.4.0}/deadcode/data_types.py

@@ -14,7 +14,8 @@ Pathname = str  # Can contain wildewards
 class Args:
     fix: bool = False
     verbose: bool = False
-    dry: Iterable[Pathname] = ()
+    dry: bool = False
+    only: Iterable[Pathname] = ()
     paths: Iterable[Pathname] = ()
     exclude: Iterable[Pathname] = ()
     ignore_definitions: Iterable[Pathname] = ()

{deadcode-2.3.1 → deadcode-2.4.0}/deadcode/utils/fix_indent.py

@@ -3,6 +3,7 @@ from typing import Optional, TypeVar
 
 T = TypeVar('T')
 
+
 def fix_indent(doc: T) -> Optional[T]:
     """Finds indentation of a first line and removes it from all following lines.
 

{deadcode-2.3.1 → deadcode-2.4.0}/pyproject.toml

@@ -1,20 +1,18 @@
 [project]
 name = "deadcode"
-version = "2.3.1"
+version = "2.4.0"
 authors = [
     {name = "Albertas Gimbutas", email = "albertasgim@gmail.com"},
 ]
 description = "Find and remove dead code."
 readme = "README.md"
-requires-python = ">= 3.8"
+requires-python = ">= 3.10"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: GNU Affero General Public License v3",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -156,10 +154,9 @@ ignore = [
 ]
 "tests/fix/test_unused_imports.py" = ["F401", "W291"]
 
-
 [tool.mypy]
 exclude = ["build", "dist", ".venv"]
-python_version = "3.8"
+python_version = "3.10"
 strict = true
 pretty = true
 color_output = true
@@ -167,12 +164,6 @@ show_error_codes = true
 warn_return_any = true
 warn_unused_configs = true
 
-
-[tool.isort]
-profile = "black"
-multi_line_output = 3
-known_third_party = ["deadcode"]
-
 [tool.deadcode]
 ignore_names = [
     "ERROR_CODES",
@@ -195,14 +186,7 @@ ignore_names = [
 ignore_names_in_files = [
     "deadcode/utils/base_test_case.py"
 ]
-
 exclude = ["tests"]
 
-[tool.black]
-max_line_length = 120
-line_length = 120
-target_version = ["py38"]
-
-
 [tool.pytest.ini_options]
 addopts = "--cov=. --no-cov-on-fail --cov-fail-under=88.0"

deadcode-2.3.1/deadcode/actions/get_unused_names_error_message.py

@@ -1,35 +0,0 @@
-from typing import Iterable, Optional
-
-from deadcode.data_types import Args
-from deadcode.visitor.code_item import CodeItem
-
-
-def get_unused_names_error_message(unused_names: Iterable[CodeItem], args: Args) -> Optional[str]:
-    unused_names = list(unused_names)
-
-    if not unused_names:
-        return None
-
-    if args.quiet:
-        return ''
-
-    if args.count:
-        return f'{len(unused_names)}'
-
-    messages = []
-    for item in unused_names:
-        message = f'{item.filename_with_position} \033[91m{item.error_code}\033[0m '
-        message += item.message or (
-            f"{item.type_.replace('_', ' ').capitalize()} " f"`\033[1m{item.name}\033[0m` " f"is never used"
-        )
-        if args.no_color:
-            message = message.replace('\033[91m', '').replace('\033[1m', '').replace('\033[0m', '')
-        messages.append(message)
-
-    if args.fix:
-        message = f"\nRemoved \033[1m{len(unused_names)}\033[0m unused code item{'s' if len(unused_names) > 1 else ''}!"
-        if args.no_color:
-            message = message.replace('\x1b[1m', '').replace('\x1b[0m', '')
-        messages.append(message)
-
-    return '\n'.join(messages)