django-codemod 2.0.0__tar.gz → 2.1.1__tar.gz

{django_codemod-2.0.0 → django_codemod-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-codemod
-Version: 2.0.0
+Version: 2.1.1
 Summary: A command line tool to automatically fix Django deprecations.
 Home-page: https://github.com/browniebroke/django-codemod
 License: MIT
@@ -18,6 +18,7 @@ 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
 Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: click (<9)
 Requires-Dist: libcst (==1.0.1)

{django_codemod-2.0.0 → django_codemod-2.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-codemod"
-version = "2.0.0"
+version = "2.1.1"
 description = "A command line tool to automatically fix Django deprecations."
 authors = ["Bruno Alla <alla.brunoo@gmail.com>"]
 license = "MIT"
@@ -14,6 +14,7 @@ classifiers = [
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Libraries",
+    "Programming Language :: Python :: 3.12",
 ]
 packages = [
     { include = "django_codemod", from = "src" },
@@ -49,21 +50,66 @@ optional = true
 [tool.poetry.group.docs.dependencies]
 myst-parser = ">=0.16"
 sphinx = ">=4.0"
-sphinx-rtd-theme = ">=1.0"
+furo = ">=2023.5.20"
 
 [tool.semantic_release]
 branch = "main"
-version_toml = "pyproject.toml:tool.poetry.version"
+version_toml = ["pyproject.toml:tool.poetry.version"]
 version_variable = "src/django_codemod/__init__.py:__version__"
 build_command = "pip install poetry && poetry build"
 
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [
+    "chore*",
+    "ci*",
+]
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true
+
 [tool.pytest.ini_options]
 addopts = "-v -Wdefault --cov=django_codemod --cov-report=term-missing:skip-covered"
 pythonpath = ["src"]
 
-[tool.isort]
-profile = "black"
-known_first_party = ["django_codemod", "tests"]
+[tool.ruff]
+target-version = "py38"
+line-length = 88
+ignore = [
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D104", # Missing docstring in public package
+    "D107", # Missing docstring in `__init__`
+    "D401", # First line of docstring should be in imperative mood
+]
+select = [
+    "B",   # flake8-bugbear
+    "D",   # flake8-docstrings
+    "C4",  # flake8-comprehensions
+    "S",   # flake8-bandit
+    "F",   # pyflake
+    "E",   # pycodestyle
+    "W",   # pycodestyle
+    "UP",  # pyupgrade
+    "I",   # isort
+    "RUF", # ruff specific
+]
+[tool.ruff.per-file-ignores]
+"tests/**/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "S101",
+]
+"conftest.py" = ["D100"]
+"docs/conf.py" = ["D100"]
+
+[tool.ruff.isort]
+known-first-party = ["django_codemod", "tests"]
 
 [tool.coverage.run]
 branch = true

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/cli.py

@@ -193,8 +193,8 @@ def call_command(command_instance: BaseCodemodCommand, files: List[Path]):
             command_instance,
             files,  # type: ignore
         )
-    except KeyboardInterrupt:
-        raise click.Abort("Interrupted!")
+    except KeyboardInterrupt as exc:
+        raise click.Abort("Interrupted!") from exc
 
     # fancy summary a-la libCST
     total = result.successes + result.skips + result.failures
@@ -247,8 +247,7 @@ def get_short_description(codemodder: Type[BaseDjCodemodTransformer]) -> str:
     if codemodder.__doc__ is None:
         return ""
     for line in codemodder.__doc__.split("\n"):
-        description = line.strip()
-        if description:
+        if description := line.strip():
             return description
     return ""
 

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/path_utils.py

@@ -1,4 +1,5 @@
-"""Some utilities to deal with files.
+"""
+Some utilities to deal with files.
 
 Inspired or taken from black:
 https://github.com/psf/black
@@ -10,7 +11,8 @@ from pathspec import PathSpec
 
 
 def get_sources(src: Iterable[str]) -> List[Path]:
-    """Return a list of sources to codemod.
+    """
+    Return a list of sources to codemod.
 
     Based on a list of paths or files, recursively find python source files,
     ignoring the ones according to `.gitignore`.
@@ -31,7 +33,8 @@ def get_sources(src: Iterable[str]) -> List[Path]:
 
 
 def find_project_root(sources: Iterable[str]) -> Path:
-    """Return a directory containing .git, .hg, or pyproject.toml.
+    """
+    Return a directory containing .git, .hg, or pyproject.toml.
 
     That directory will be a common parent of all files and directories
     passed in `sources`.
@@ -83,7 +86,8 @@ def gen_python_files(
     root: Path,
     gitignore: PathSpec,
 ) -> Iterator[Path]:
-    """Generate all files under `paths`.
+    """
+    Generate all files under `paths`.
 
     Files listed in .gitignore are not considered.
     """

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/utils/calls.py

@@ -1,21 +1,18 @@
 from typing import Optional, Sequence
 
-from libcst import Arg, Call, FunctionDef, Param
+from libcst import Arg, Call, FunctionDef, Param, parse_expression, parse_statement
 from libcst import matchers as m
-from libcst import parse_expression, parse_statement
 
 
 def find_keyword_arg(args: Sequence[Arg], keyword_name: str) -> Optional[Arg]:
     """Find a kwarg among a sequence of arguments."""
     matcher = m.Arg(keyword=m.Name(keyword_name))
-    for arg in args:
-        if m.matches(arg, matcher):
-            return arg
-    return None
+    return next((arg for arg in args if m.matches(arg, matcher)), None)
 
 
 def parse_arg(arg_str: str) -> Arg:
-    """Build a `Arg` instance based on its string representation.
+    """
+    Build a `Arg` instance based on its string representation.
 
     Instantiating it from scratch is cumbersome, this helper generates a
     function call with the given argument and extract it from the tree.
@@ -27,7 +24,8 @@ def parse_arg(arg_str: str) -> Arg:
 
 
 def parse_param(arg_str: str) -> Param:
-    """Build a `Param` instance based on its string representation.
+    """
+    Build a `Param` instance based on its string representation.
 
     Instantiating it from scratch is cumbersome, this helper generates a
     function definition with the given param and extract it from the tree.

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/admin.py

@@ -149,7 +149,7 @@ class InlineHasAddPermissionsTransformer(BaseDjCodemodTransformer):
 
 
 class ActionCheckboxNameTransformer(BaseRenameTransformer):
-    """Replace `django.contrib.admin.ACTION_CHECKBOX_NAME` compatibility import"""
+    """Replace `django.contrib.admin.ACTION_CHECKBOX_NAME` compatibility import."""
 
     deprecated_in = DJANGO_1_3
     removed_in = DJANGO_3_1

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/base.py

@@ -28,9 +28,7 @@ from django_codemod.feature_flags import REPLACE_PARENT_MODULE_IMPORTED
 
 
 class IsTryImportProvider(BatchableMetadataProvider[bool]):
-    """
-    Marks ImportFrom nodes found inside a try block.
-    """
+    """Marks ImportFrom nodes found inside a try block."""
 
     def __init__(self) -> None:
         super().__init__()
@@ -114,7 +112,6 @@ class BaseRenameTransformer(BaseDjCodemodTransformer, ABC):
         self, original_node: ImportFrom, updated_node: ImportFrom
     ) -> Union[BaseSmallStatement, RemovalSentinel]:
         """Update import statements for matching old module name."""
-
         return (
             self._check_import_from_exact(original_node, updated_node)
             or self._check_import_from_parent(original_node, updated_node)
@@ -218,21 +215,21 @@ class BaseRenameTransformer(BaseDjCodemodTransformer, ABC):
                     add_import_module: Optional[str] = None
                     if self.new_parent_module_parts:
                         add_import_module = ".".join(self.new_parent_module_parts)
-                    self.context.scratch[self.ctx_key_add_import_kwargs] = dict(
-                        context=self.context,
-                        module=add_import_module,
-                        obj=self.new_parent_name,
-                        asname=new_as_name,
-                    )
+                    self.context.scratch[self.ctx_key_add_import_kwargs] = {
+                        "context": self.context,
+                        "module": add_import_module,
+                        "obj": self.new_parent_name,
+                        "asname": new_as_name,
+                    }
                     remove_import_module: Optional[str] = None
                     if self.old_parent_module_parts:
                         remove_import_module = ".".join(self.old_parent_module_parts)
-                    self.context.scratch[self.ctx_key_remove_import_kwargs] = dict(
-                        context=self.context,
-                        module=remove_import_module,
-                        obj=self.old_parent_name,
-                        asname=import_alias.evaluated_alias,
-                    )
+                    self.context.scratch[self.ctx_key_remove_import_kwargs] = {
+                        "context": self.context,
+                        "module": remove_import_module,
+                        "obj": self.old_parent_name,
+                        "asname": import_alias.evaluated_alias,
+                    }
         return updated_node
 
     def _check_import_from_child(
@@ -281,16 +278,13 @@ class BaseRenameTransformer(BaseDjCodemodTransformer, ABC):
 
     def update_imports(self):
         """Update import statements if a change is required."""
-        remove_import_kwargs = self.remove_import_kwargs
-        if remove_import_kwargs:
+        if remove_import_kwargs := self.remove_import_kwargs:
             RemoveImportsVisitor.remove_unused_import(**remove_import_kwargs)
-        add_import_kwargs = self.add_import_kwargs
-        if add_import_kwargs:
+        if add_import_kwargs := self.add_import_kwargs:
             AddImportsVisitor.add_needed_import(**add_import_kwargs)
 
     def leave_Name(self, original_node: Name, updated_node: Name) -> BaseExpression:
         """Rename reference to the imported name."""
-
         matcher = self.name_matcher
         if (
             matcher

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/crypto.py

@@ -8,7 +8,7 @@ from django_codemod.visitors.base import BaseFuncRenameTransformer
 
 
 class GetRandomStringTransformer(BaseFuncRenameTransformer):
-    """Update lengthless uses of get_random_string()"""
+    """Update lengthless uses of get_random_string()."""
 
     deprecated_in = DJANGO_3_1
     removed_in = DJANGO_4_0

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/exceptions.py

@@ -21,10 +21,7 @@ class SqlEmptyResultSetTransformer(BaseRenameTransformer):
 
 
 class DatastructuresEmptyResultSetTransformer(BaseRenameTransformer):
-    """
-    Replace `django.db.models.sql.datastructures.EmptyResultSet` compatibility
-    import.
-    """
+    """Replace `django.db.models.sql.datastructures.EmptyResultSet` import."""
 
     deprecated_in = DJANGO_1_11
     removed_in = DJANGO_3_1

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/models.py

@@ -153,18 +153,18 @@ class ModelsPermalinkTransformer(BaseDjCodemodTransformer):
         return super().leave_Return(original_node, updated_node)
 
 
-def is_foreign_key(node: Call) -> bool:
+def _is_foreign_key(node: Call) -> bool:
     return m.matches(node, m.Call(func=m.Attribute(attr=m.Name(value="ForeignKey"))))
 
 
-def is_one_to_one_field(node: Call) -> bool:
+def _is_one_to_one_field(node: Call) -> bool:
     return m.matches(
         node,
         m.Call(func=m.Attribute(attr=m.Name(value="OneToOneField"))),
     )
 
 
-def has_on_delete(node: Call) -> bool:
+def _has_on_delete(node: Call) -> bool:
     # if on_delete exists in any kwarg we return True
     if find_keyword_arg(node.args, "on_delete"):
         return True
@@ -184,8 +184,8 @@ class OnDeleteTransformer(BaseDjCodemodTransformer):
 
     def leave_Call(self, original_node: Call, updated_node: Call) -> BaseExpression:
         if (
-            is_one_to_one_field(original_node) or is_foreign_key(original_node)
-        ) and not has_on_delete(original_node):
+            _is_one_to_one_field(original_node) or _is_foreign_key(original_node)
+        ) and not _has_on_delete(original_node):
             AddImportsVisitor.add_needed_import(
                 context=self.context,
                 module="django.db",

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/signals.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import ClassVar, List, Optional
 
 from libcst import BaseExpression, Call, ImportFrom, ImportStar, MaybeSentinel, Module
 from libcst import matchers as m
@@ -15,7 +15,7 @@ class SignalDisconnectWeakTransformer(BaseDjCodemodTransformer):
 
     ctx_key_prefix = "SignalDisconnectWeakTransformer"
     ctx_key_call_matchers = f"{ctx_key_prefix}-call_matchers"
-    builtin_signals = [
+    builtin_signals: ClassVar[List[str]] = [
         "pre_init",
         "post_init",
         "pre_save",
@@ -35,9 +35,10 @@ class SignalDisconnectWeakTransformer(BaseDjCodemodTransformer):
         return self.context.scratch.get(self.ctx_key_call_matchers, [])
 
     def add_disconnect_call_matcher(self, call_matcher: m.Call) -> None:
-        self.context.scratch[
-            self.ctx_key_call_matchers
-        ] = self.disconnect_call_matchers + [call_matcher]
+        self.context.scratch[self.ctx_key_call_matchers] = [
+            *self.disconnect_call_matchers,
+            call_matcher,
+        ]
 
     def leave_Module(self, original_node: Module, updated_node: Module) -> Module:
         """Clear context when leaving module."""
@@ -81,7 +82,7 @@ class SignalDisconnectWeakTransformer(BaseDjCodemodTransformer):
             should_change = False
             last_comma = MaybeSentinel.DEFAULT
             # Keep all arguments except the one with the keyword `weak` (if present)
-            for index, arg in enumerate(updated_node.args):
+            for arg in updated_node.args:
                 if m.matches(arg, m.Arg(keyword=m.Name("weak"))):
                     # An argument with the keyword `weak` was found
                     # -> we need to rewrite the statement

{django_codemod-2.0.0 → django_codemod-2.1.1}/src/django_codemod/visitors/urls.py

@@ -92,9 +92,9 @@ class URLTransformer(BaseFuncRenameTransformer):
         group_name, group_regex = group.split(">", 1)
         try:
             converter = REGEX_TO_CONVERTER[group_regex]
-        except KeyError:
-            raise PatternNotSupported("No converter found")
-        return prefix + f"<{converter}:{group_name}>", left_to_parse
+        except KeyError as exc:
+            raise PatternNotSupported("No converter found") from exc
+        return f"{prefix}<{converter}:{group_name}>", left_to_parse
 
     @staticmethod
     def check_route(route: str) -> None:

{django_codemod-2.0.0 → django_codemod-2.1.1}/tests/test_cli.py

@@ -198,19 +198,21 @@ class NoDocString:
 
 
 class EmptyDocString:
-    """"""
+    """"""  # noqa D419
 
     pass
 
 
 class SingleLine:
-    """This is the description."""
+    """The description."""
 
 
 class MultiLine1:
-    """This is the title.
+    """
+    Some title.
 
-    This is more details."""
+    This is more details.
+    """
 
 
 class MultiLine2:
@@ -226,8 +228,8 @@ class MultiLine2:
     [
         (NoDocString, ""),
         (EmptyDocString, ""),
-        (SingleLine, "This is the description."),
-        (MultiLine1, "This is the title."),
+        (SingleLine, "The description."),
+        (MultiLine1, "Some title."),
         (MultiLine2, "Another title."),
     ],
 )

{django_codemod-2.0.0 → django_codemod-2.1.1}/tests/visitors/test_models.py

@@ -39,7 +39,7 @@ class TestOnDeleteTransformer(BaseVisitorTest):
         self.assertCodemod(before, after)
 
     def test_multiple_kwargs_with_on_delete(self) -> None:
-        """Should do nothing"""
+        """Should do nothing."""
         before = """
             from django.db import models
 
@@ -123,7 +123,7 @@ class TestOnDeleteTransformer(BaseVisitorTest):
         self.assertCodemod(before, after)
 
     def test_positional_args_with_on_delete(self) -> None:
-        """Should do nothing"""
+        """Should do nothing."""
         before = """
             from django.db import models
 

{django_codemod-2.0.0 → django_codemod-2.1.1}/tests/visitors/test_signals.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+from typing import ClassVar
+
 from parameterized import parameterized
 
 from django_codemod.visitors import SignalDisconnectWeakTransformer
@@ -6,7 +10,7 @@ from tests.visitors.base import BaseVisitorTest
 
 class TestSignalDisconnectWeakTransformer(BaseVisitorTest):
     transformer = SignalDisconnectWeakTransformer
-    DJANGO_SIGNAL_NAMES = [
+    DJANGO_SIGNAL_NAMES: ClassVar[list[str]] = [
         "pre_init",
         "post_init",
         "pre_save",