django-codemod 2.5.0__tar.gz → 2.6.0__tar.gz

{django_codemod-2.5.0/src/django_codemod.egg-info → django_codemod-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-codemod
-Version: 2.5.0
+Version: 2.6.0
 Summary: A command line tool to automatically fix Django deprecations.
 Author-email: Bruno Alla <alla.brunoo@gmail.com>
 License-Expression: MIT
@@ -26,7 +26,7 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click<8.5
+Requires-Dist: click<8.6
 Requires-Dist: libcst==1.9
 Requires-Dist: pathspec<2,>=0.6
 Requires-Dist: rich>=10

{django_codemod-2.5.0 → django_codemod-2.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "setuptools>=77.0.3" ]
 
 [project]
 name = "django-codemod"
-version = "2.5.0"
+version = "2.6.0"
 description = "A command line tool to automatically fix Django deprecations."
 readme = "README.md"
 keywords = [
@@ -32,7 +32,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries",
 ]
 dependencies = [
-  "click<8.5",
+  "click<8.6",
   "libcst==1.9",
   "pathspec>=0.6,<2",
   "rich>=10",
@@ -52,7 +52,7 @@ dev = [
   "pytest>=9,<10",
   "pytest-cov>=7,<8",
   "pytest-mock>=3.3,<4",
-  "ty==0.0.69",
+  "ty==0.0.99",
 ]
 docs = [
   "furo>=2023.5.20; python_version>='3.11'",

django_codemod-2.6.0/src/django_codemod/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.6.0"

{django_codemod-2.5.0 → django_codemod-2.6.0}/src/django_codemod/path_utils.py

@@ -5,13 +5,13 @@ Inspired or taken from black:
 https://github.com/psf/black
 """
 
-from collections.abc import Iterable, Iterator
+from collections.abc import Collection, Iterable, Iterator
 from pathlib import Path
 
 from pathspec import PathSpec
 
 
-def get_sources(src: Iterable[str]) -> list[Path]:
+def get_sources(src: Collection[str]) -> list[Path]:
     """
     Return a list of sources to codemod.
 
@@ -33,7 +33,7 @@ def get_sources(src: Iterable[str]) -> list[Path]:
     return sorted(sources)
 
 
-def find_project_root(sources: Iterable[str]) -> Path:
+def find_project_root(sources: Collection[str]) -> Path:
     """
     Return a directory containing .git, .hg, or pyproject.toml.
 

{django_codemod-2.5.0 → django_codemod-2.6.0}/src/django_codemod/visitors/__init__.py

@@ -29,6 +29,7 @@ from .models import (
     ModelsPermalinkTransformer,
     NullBooleanFieldTransformer,
     OnDeleteTransformer,
+    QuerySetDateFieldTransformer,
 )
 from .os_utils import AbsPathTransformer
 from .paginator import QuerySetPaginatorTransformer
@@ -88,6 +89,7 @@ __all__ = (
     "OnDeleteTransformer",
     "PrettyNameTransformer",
     "QueryEmptyResultSetTransformer",
+    "QuerySetDateFieldTransformer",
     "QuerySetPaginatorTransformer",
     "RenderToResponseTransformer",
     "RequestContextTransformer",

{django_codemod-2.5.0 → django_codemod-2.6.0}/src/django_codemod/visitors/base.py

@@ -267,7 +267,10 @@ class BaseRenameTransformer(BaseDjCodemodTransformer, ABC):
 
     def resolve_scope(self, node: CSTNode) -> Scope:
         scopes_map = self.context.wrapper.resolve(ScopeProvider)  # type: ignore
-        return scopes_map[node]
+        scope = scopes_map[node]
+        if scope is None:
+            raise KeyError(f"Scope not found for node {node}")
+        return scope
 
     def save_import_scope(self, import_from: ImportFrom) -> None:
         scope = self.resolve_scope(import_from)

{django_codemod-2.5.0 → django_codemod-2.6.0}/src/django_codemod/visitors/models.py

@@ -2,10 +2,12 @@ from collections.abc import Sequence
 
 from libcst import (
     Arg,
+    AssignEqual,
     BaseExpression,
     BaseSmallStatement,
     BaseStatement,
     Call,
+    ConcatenatedString,
     FlattenSentinel,
     FunctionDef,
     ImportFrom,
@@ -15,6 +17,8 @@ from libcst import (
     RemovalSentinel,
     RemoveFromParent,
     Return,
+    SimpleString,
+    SimpleWhitespace,
 )
 from libcst import matchers as m
 from libcst.codemod.visitors import AddImportsVisitor
@@ -24,6 +28,7 @@ from django_codemod.constants import (
     DJANGO_1_11,
     DJANGO_2_0,
     DJANGO_2_1,
+    DJANGO_3_0,
     DJANGO_3_1,
     DJANGO_4_0,
 )
@@ -214,3 +219,49 @@ class NullBooleanFieldTransformer(BaseFuncRenameTransformer):
             *node.args,
             parse_arg("null=True"),
         )
+
+
+class QuerySetDateFieldTransformer(BaseDjCodemodTransformer):
+    """Pass literal field names positionally to `earliest()` and `latest()`."""
+
+    deprecated_in = DJANGO_2_0
+    removed_in = DJANGO_3_0
+
+    def leave_Call(self, original_node: Call, updated_node: Call) -> BaseExpression:
+        if not m.matches(
+            updated_node.func,
+            m.Attribute(attr=m.Name("earliest") | m.Name("latest")),
+        ):
+            return updated_node
+        arg = find_keyword_arg(updated_node.args, "field_name")
+        if arg is None:
+            return updated_node
+        if not isinstance(
+            arg.value, (SimpleString, ConcatenatedString)
+        ) or not isinstance(arg.value.evaluated_value, str):
+            self.warn(
+                "Cannot safely rewrite non-literal field_name in earliest()/latest(); "
+                "review this call manually."
+            )
+            return updated_node
+        if len(updated_node.args) != 1:
+            return updated_node
+        if isinstance(arg.equal, AssignEqual) and (
+            any(
+                not isinstance(whitespace, SimpleWhitespace)
+                or "\n" in whitespace.value
+                or "\r" in whitespace.value
+                for whitespace in (
+                    arg.equal.whitespace_before,
+                    arg.equal.whitespace_after,
+                )
+            )
+        ):
+            self.warn(
+                "Cannot safely rewrite field_name with comments or line breaks "
+                "around '=' in earliest()/latest(); review this call manually."
+            )
+            return updated_node
+        return updated_node.with_changes(
+            args=[arg.with_changes(keyword=None, equal=MaybeSentinel.DEFAULT)]
+        )

{django_codemod-2.5.0 → django_codemod-2.6.0/src/django_codemod.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-codemod
-Version: 2.5.0
+Version: 2.6.0
 Summary: A command line tool to automatically fix Django deprecations.
 Author-email: Bruno Alla <alla.brunoo@gmail.com>
 License-Expression: MIT
@@ -26,7 +26,7 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click<8.5
+Requires-Dist: click<8.6
 Requires-Dist: libcst==1.9
 Requires-Dist: pathspec<2,>=0.6
 Requires-Dist: rich>=10

{django_codemod-2.5.0 → django_codemod-2.6.0}/src/django_codemod.egg-info/SOURCES.txt

@@ -44,7 +44,6 @@ src/django_codemod/visitors/translations.py
 src/django_codemod/visitors/urls.py
 tests/__init__.py
 tests/test_cli.py
-tests/test_e2e.sh
 tests/test_path_utils.py
 tests/visitors/__init__.py
 tests/visitors/base.py

{django_codemod-2.5.0 → django_codemod-2.6.0}/src/django_codemod.egg-info/requires.txt

@@ -1,4 +1,4 @@
-click<8.5
+click<8.6
 libcst==1.9
 pathspec<2,>=0.6
 rich>=10

{django_codemod-2.5.0 → django_codemod-2.6.0}/tests/visitors/base.py

@@ -1,4 +1,4 @@
-from libcst.codemod import CodemodTest
+from libcst.codemod import CodemodContext, CodemodTest
 
 from django_codemod.commands import BaseCodemodCommand
 from django_codemod.visitors.base import BaseDjCodemodTransformer
@@ -9,6 +9,8 @@ class BaseVisitorTest(CodemodTest):
 
     transformer: type[BaseDjCodemodTransformer]
 
-    def TRANSFORM(self, context):
+    def TRANSFORM(  # ty: ignore[invalid-attribute-override]
+        self, context: CodemodContext
+    ) -> BaseCodemodCommand:
         """Create a command for the transformer under test."""
         return BaseCodemodCommand([self.transformer], context)

{django_codemod-2.5.0 → django_codemod-2.6.0}/tests/visitors/test_models.py

@@ -5,6 +5,7 @@ from django_codemod.visitors.models import (
     ModelsPermalinkTransformer,
     NullBooleanFieldTransformer,
     OnDeleteTransformer,
+    QuerySetDateFieldTransformer,
 )
 from tests.visitors.base import BaseVisitorTest
 
@@ -382,3 +383,96 @@ class TestNullBooleanFieldTransformer(BaseVisitorTest):
                 is_active = models.BooleanField(null=True)
         """
         self.assertCodemod(before, after)
+
+
+class TestQuerySetDateFieldTransformer(BaseVisitorTest):
+    transformer = QuerySetDateFieldTransformer
+
+    @parameterized.expand([("earliest",), ("latest",)])
+    def test_literal_field(self, method):
+        self.assertCodemod(
+            f"result = Article.objects.{method}(field_name='pub_date')",
+            f"result = Article.objects.{method}('pub_date')",
+        )
+
+    def test_chained_multiline_call(self):
+        self.assertCodemod(
+            """
+            result = Article.objects.filter(published=True).latest(
+                field_name = "pub_date",  # Keep the field comment.
+            )
+            """,
+            """
+            result = Article.objects.filter(published=True).latest(
+                "pub_date",  # Keep the field comment.
+            )
+            """,
+        )
+
+    @parameterized.expand(
+        [
+            ("qs.latest()",),
+            ("qs.earliest('pub_date')",),
+            ("qs.in_bulk(field_name='slug')",),
+            ("latest(field_name='pub_date')",),
+            ("qs.latest(**kwargs)",),
+            ("qs.latest('pub_date', field_name='created')",),
+        ]
+    )
+    def test_other_calls_unchanged(self, source):
+        self.assertCodemod(source, source)
+
+    @parameterized.expand(
+        [
+            (extra_args, value)
+            for extra_args in ("", "'other', ", "**kwargs, ")
+            for value in (
+                "None",
+                "field",
+                "get_field()",
+                "b'pub_date'",
+                "f'{field}'",
+                "'pub_' f'{field}'",
+                "b'pub_' b'date'",
+            )
+        ]
+    )
+    def test_non_literal_requires_review(self, extra_args, value):
+        source = f"qs.latest({extra_args}field_name={value})"
+        self.assertCodemod(
+            source,
+            source,
+            expected_warnings=[
+                "Cannot safely rewrite non-literal field_name in earliest()/latest(); "
+                "review this call manually."
+            ],
+        )
+
+    @parameterized.expand([("earliest",), ("latest",)])
+    def test_adjacent_literal_strings(self, method):
+        self.assertCodemod(
+            f"qs.{method}(field_name=('pub_' 'date'))",
+            f"qs.{method}(('pub_' 'date'))",
+        )
+
+    @parameterized.expand(
+        [
+            (" # Before the equals.\n    =",),
+            ("= # After the equals.\n    ",),
+            (" # Before.\n    = # After.\n    ",),
+            ("=\n    # On its own line.\n    ",),
+            ("=\n    ",),
+            ("= \\\n    ",),
+            (" \\\n    =",),
+        ]
+    )
+    def test_multiline_keyword_requires_review(self, equal):
+        source = f"qs.latest(field_name{equal}'pub_date')"
+        self.assertCodemod(
+            source,
+            source,
+            expected_warnings=[
+                "Cannot safely rewrite field_name with comments or line breaks "
+                "around '=' in earliest()/latest(); review this call manually."
+            ],
+        )

django_codemod-2.5.0/src/django_codemod/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.5.0"

django_codemod-2.5.0/tests/test_e2e.sh

@@ -1,39 +0,0 @@
-#!/usr/bin/env bash
-
-set -xu
-
-mkdir -p e2e
-cd e2e
-django-admin startproject djcme2e
-cd djcme2e
-django-admin startapp app1
-
-echo "from django.db import models
-from django.utils.encoding import force_text
-from django.utils.translation import ugettext_lazy as _
-
-
-class AppModel(models.Model):
-    name = models.CharField(_('Name'))
-    slug = models.SlugField(_('Name'))
-
-    def __str__(self):
-        return force_text(self.name)
-" > app1/models.py
-
-cp -r ../djcme2e ../djcme2e_orig
-
-djcodemod run --deprecated-in 3.0 .
-
-cd ..
-
-OUT=$(diff -qr djcme2e_orig/ djcme2e/ | grep -v 'models.py differ')
-
-if [ "${OUT}" != "" ]
-then
-    echo "ERROR: unexpected differences found:"
-    diff -r djcme2e_orig/ djcme2e/
-    exit 1
-else
-    exit 0
-fi