Skip to content

Commit cfcfc92

Browse files
authored
Fix FieldCacheMixin.cache_name (#2562)
1. Move the allowlist entries from the Django 5.1 file to the main one, under the `@cached_property` heading. This was missed in 0a3cb4a. 2. Move the `@deprecated` decorator to `get_cache_name()`, which is what is actually deprecated, per django/django@b9838c6.
1 parent ae4c932 commit cfcfc92

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

django-stubs/db/models/fields/mixins.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ from typing_extensions import deprecated
77
NOT_PROVIDED: Any
88

99
class FieldCacheMixin:
10+
@deprecated("get_cache_name() is deprecated and will be removed in Django 6.0. Use cache_name instead.")
1011
def get_cache_name(self) -> str: ...
1112
@cached_property
12-
@deprecated("cache_name() is deprecated and will be removed in Django 6.0. Use get_cache_name() instead.")
1313
def cache_name(self) -> str: ...
1414
def get_cached_value(self, instance: Model, default: Any = ...) -> Model | None: ...
1515
def is_cached(self, instance: Model) -> bool: ...

scripts/stubtest/allowlist.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ django.utils.functional.cached_property.name
158158
# Ignore @cached_property error "cannot reconcile @property on stub with runtime object"
159159
django.contrib.admin.helpers.Fieldset.is_collapsible
160160
django.contrib.admin.helpers.InlineAdminFormSet.is_collapsible
161+
django.contrib.contenttypes.fields.GenericForeignKey.cache_name
161162
django.contrib.contenttypes.fields.ReverseGenericManyToOneDescriptor.related_manager_cls
162163
django.contrib.gis.db.backends.base.operations.BaseSpatialOperations.select_extent
163164
django.contrib.gis.db.backends.mysql.features.DatabaseFeatures.django_test_skips
@@ -180,6 +181,7 @@ django.contrib.gis.db.models.ForeignObject.foreign_related_fields
180181
django.contrib.gis.db.models.ForeignObject.local_related_fields
181182
django.contrib.gis.db.models.ForeignObject.related_fields
182183
django.contrib.gis.db.models.ForeignObject.reverse_related_fields
184+
django.contrib.gis.db.models.ForeignObjectRel.cache_name
183185
django.contrib.gis.db.models.ForeignObjectRel.hidden
184186
django.contrib.gis.db.models.ForeignObjectRel.many_to_many
185187
django.contrib.gis.db.models.ForeignObjectRel.many_to_one
@@ -301,6 +303,7 @@ django.db.models.ForeignObject.foreign_related_fields
301303
django.db.models.ForeignObject.local_related_fields
302304
django.db.models.ForeignObject.related_fields
303305
django.db.models.ForeignObject.reverse_related_fields
306+
django.db.models.ForeignObjectRel.cache_name
304307
django.db.models.ForeignObjectRel.hidden
305308
django.db.models.ForeignObjectRel.many_to_many
306309
django.db.models.ForeignObjectRel.many_to_one
@@ -323,10 +326,12 @@ django.db.models.fields.Field.cached_col
323326
django.db.models.fields.Field.validators
324327
django.db.models.fields.IntegerField.validators
325328
django.db.models.fields.generated.GeneratedField.cached_col
329+
django.db.models.fields.mixins.FieldCacheMixin.cache_name
326330
django.db.models.fields.related.ForeignObject.foreign_related_fields
327331
django.db.models.fields.related.ForeignObject.local_related_fields
328332
django.db.models.fields.related.ForeignObject.related_fields
329333
django.db.models.fields.related.ForeignObject.reverse_related_fields
334+
django.db.models.fields.related.ForeignObjectRel.cache_name
330335
django.db.models.fields.related.ForeignObjectRel.hidden
331336
django.db.models.fields.related.ForeignObjectRel.many_to_many
332337
django.db.models.fields.related.ForeignObjectRel.many_to_one
@@ -336,13 +341,15 @@ django.db.models.fields.related.ForeignObjectRel.one_to_one
336341
django.db.models.fields.related.ForeignObjectRel.related_model
337342
django.db.models.fields.related.ForwardManyToOneDescriptor.RelatedObjectDoesNotExist
338343
django.db.models.fields.related.ManyToManyDescriptor.related_manager_cls
344+
django.db.models.fields.related.RelatedField.cache_name
339345
django.db.models.fields.related.RelatedField.related_model
340346
django.db.models.fields.related.ReverseManyToOneDescriptor.related_manager_cls
341347
django.db.models.fields.related.ReverseOneToOneDescriptor.RelatedObjectDoesNotExist
342348
django.db.models.fields.related_descriptors.ForwardManyToOneDescriptor.RelatedObjectDoesNotExist
343349
django.db.models.fields.related_descriptors.ManyToManyDescriptor.related_manager_cls
344350
django.db.models.fields.related_descriptors.ReverseManyToOneDescriptor.related_manager_cls
345351
django.db.models.fields.related_descriptors.ReverseOneToOneDescriptor.RelatedObjectDoesNotExist
352+
django.db.models.fields.reverse_related.ForeignObjectRel.cache_name
346353
django.db.models.fields.reverse_related.ForeignObjectRel.hidden
347354
django.db.models.fields.reverse_related.ForeignObjectRel.many_to_many
348355
django.db.models.fields.reverse_related.ForeignObjectRel.many_to_one

scripts/stubtest/allowlist_todo_django51.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@
33
# Only discrepancies that appeared after Django 5.0 -> 5.1 update.
44
# Unsorted: there are real problems and things we can really ignore:
55

6-
django.contrib.contenttypes.fields.GenericForeignKey.cache_name
76
django.contrib.contenttypes.fields.GenericForeignKey.get_attname_column
87
django.contrib.contenttypes.models.ContentType.get_object_for_this_type
98
django.contrib.gis.db.backends.mysql.operations.MySQLOperations.collect
109
django.contrib.gis.db.models.ForeignObjectRel.accessor_name
11-
django.contrib.gis.db.models.ForeignObjectRel.cache_name
1210
django.contrib.gis.db.models.OrderBy.constraint_validation_compatible
1311
django.contrib.gis.db.models.functions.FromWKB.__init__
1412
django.contrib.gis.db.models.functions.FromWKB.as_oracle
@@ -68,17 +66,12 @@ django.db.backends.sqlite3.operations.DatabaseOperations.force_group_by
6866
django.db.migrations.autodetector.MigrationAutodetector.generate_altered_index_together
6967
django.db.migrations.autodetector.OperationDependency
7068
django.db.models.ForeignObjectRel.accessor_name
71-
django.db.models.ForeignObjectRel.cache_name
7269
django.db.models.OrderBy.constraint_validation_compatible
7370
django.db.models.expressions.BaseExpression.constraint_validation_compatible
7471
django.db.models.expressions.BaseExpression.get_expression_for_validation
7572
django.db.models.expressions.OrderBy.constraint_validation_compatible
76-
django.db.models.fields.mixins.FieldCacheMixin.cache_name
7773
django.db.models.fields.related.ForeignObjectRel.accessor_name
78-
django.db.models.fields.related.ForeignObjectRel.cache_name
79-
django.db.models.fields.related.RelatedField.cache_name
8074
django.db.models.fields.reverse_related.ForeignObjectRel.accessor_name
81-
django.db.models.fields.reverse_related.ForeignObjectRel.cache_name
8275
django.db.models.functions.ConcatPair.pipes_concat_sql
8376
django.db.models.functions.text.ConcatPair.pipes_concat_sql
8477
django.db.models.lookups.In.get_refs

0 commit comments

Comments
 (0)