1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00

Fixed #35554, Refs #35060 -- Corrected deprecated *args parsing in Model.save()/asave().

The transitional logic added to deprecate the usage of *args for
Model.save()/asave() introduced two issues that this branch fixes:
 * Passing extra positional arguments no longer raised TypeError.
 * Passing a positional but empty update_fields would save all fields.

Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
This commit is contained in:
Adam Johnson 2024-06-25 17:12:10 +01:00 committed by GitHub
parent bcc327aa32
commit 28522c3c8d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 110 additions and 24 deletions

View File

@ -803,18 +803,20 @@ class Model(AltersData, metaclass=ModelBase):
RemovedInDjango60Warning, RemovedInDjango60Warning,
stacklevel=2, stacklevel=2,
) )
for arg, attr in zip( total_len_args = len(args) + 1 # include self
args, ["force_insert", "force_update", "using", "update_fields"] if total_len_args > 5:
): # Recreate the proper TypeError message from Python.
if arg: raise TypeError(
if attr == "force_insert": "Model.save() takes from 1 to 5 positional arguments but "
force_insert = arg f"{total_len_args} were given"
elif attr == "force_update": )
force_update = arg force_insert = args[0]
elif attr == "using": try:
using = arg force_update = args[1]
else: using = args[2]
update_fields = arg update_fields = args[3]
except IndexError:
pass
self._prepare_related_fields_for_save(operation_name="save") self._prepare_related_fields_for_save(operation_name="save")
@ -888,18 +890,20 @@ class Model(AltersData, metaclass=ModelBase):
RemovedInDjango60Warning, RemovedInDjango60Warning,
stacklevel=2, stacklevel=2,
) )
for arg, attr in zip( total_len_args = len(args) + 1 # include self
args, ["force_insert", "force_update", "using", "update_fields"] if total_len_args > 5:
): # Recreate the proper TypeError message from Python.
if arg: raise TypeError(
if attr == "force_insert": "Model.asave() takes from 1 to 5 positional arguments but "
force_insert = arg f"{total_len_args} were given"
elif attr == "force_update": )
force_update = arg force_insert = args[0]
elif attr == "using": try:
using = arg force_update = args[1]
else: using = args[2]
update_fields = arg update_fields = args[3]
except IndexError:
pass
return await sync_to_async(self.save)( return await sync_to_async(self.save)(
force_insert=force_insert, force_insert=force_insert,

View File

@ -210,6 +210,35 @@ class ModelInstanceCreationTests(TestCase):
a.save(False, False, None, None) a.save(False, False, None, None)
self.assertEqual(Article.objects.count(), 1) self.assertEqual(Article.objects.count(), 1)
def test_save_deprecation_positional_arguments_used(self):
a = Article()
fields = ["headline"]
with (
self.assertWarns(RemovedInDjango60Warning),
mock.patch.object(a, "save_base") as mock_save_base,
):
a.save(None, 1, 2, fields)
self.assertEqual(
mock_save_base.mock_calls,
[
mock.call(
using=2,
force_insert=None,
force_update=1,
update_fields=frozenset(fields),
)
],
)
def test_save_too_many_positional_arguments(self):
a = Article()
msg = "Model.save() takes from 1 to 5 positional arguments but 6 were given"
with (
self.assertWarns(RemovedInDjango60Warning),
self.assertRaisesMessage(TypeError, msg),
):
a.save(False, False, None, None, None)
async def test_asave_deprecation(self): async def test_asave_deprecation(self):
a = Article(headline="original", pub_date=datetime(2014, 5, 16)) a = Article(headline="original", pub_date=datetime(2014, 5, 16))
msg = "Passing positional arguments to asave() is deprecated" msg = "Passing positional arguments to asave() is deprecated"
@ -217,6 +246,35 @@ class ModelInstanceCreationTests(TestCase):
await a.asave(False, False, None, None) await a.asave(False, False, None, None)
self.assertEqual(await Article.objects.acount(), 1) self.assertEqual(await Article.objects.acount(), 1)
async def test_asave_deprecation_positional_arguments_used(self):
a = Article()
fields = ["headline"]
with (
self.assertWarns(RemovedInDjango60Warning),
mock.patch.object(a, "save_base") as mock_save_base,
):
await a.asave(None, 1, 2, fields)
self.assertEqual(
mock_save_base.mock_calls,
[
mock.call(
using=2,
force_insert=None,
force_update=1,
update_fields=frozenset(fields),
)
],
)
async def test_asave_too_many_positional_arguments(self):
a = Article()
msg = "Model.asave() takes from 1 to 5 positional arguments but 6 were given"
with (
self.assertWarns(RemovedInDjango60Warning),
self.assertRaisesMessage(TypeError, msg),
):
await a.asave(False, False, None, None, None)
@ignore_warnings(category=RemovedInDjango60Warning) @ignore_warnings(category=RemovedInDjango60Warning)
def test_save_positional_arguments(self): def test_save_positional_arguments(self):
a = Article.objects.create(headline="original", pub_date=datetime(2014, 5, 16)) a = Article.objects.create(headline="original", pub_date=datetime(2014, 5, 16))

View File

@ -1,5 +1,6 @@
from django.db.models.signals import post_save, pre_save from django.db.models.signals import post_save, pre_save
from django.test import TestCase from django.test import TestCase
from django.utils.deprecation import RemovedInDjango60Warning
from .models import Account, Employee, Person, Profile, ProxyEmployee from .models import Account, Employee, Person, Profile, ProxyEmployee
@ -256,6 +257,29 @@ class UpdateOnlyFieldsTests(TestCase):
pre_save.disconnect(pre_save_receiver) pre_save.disconnect(pre_save_receiver)
post_save.disconnect(post_save_receiver) post_save.disconnect(post_save_receiver)
def test_empty_update_fields_positional_save(self):
s = Person.objects.create(name="Sara", gender="F")
msg = "Passing positional arguments to save() is deprecated"
with (
self.assertWarnsMessage(RemovedInDjango60Warning, msg),
self.assertNumQueries(0),
):
s.save(False, False, None, [])
async def test_empty_update_fields_positional_asave(self):
s = await Person.objects.acreate(name="Sara", gender="F")
# Workaround for a lack of async assertNumQueries.
s.name = "Other"
msg = "Passing positional arguments to asave() is deprecated"
with self.assertWarnsMessage(RemovedInDjango60Warning, msg):
await s.asave(False, False, None, [])
# No save occurred for an empty update_fields.
await s.arefresh_from_db()
self.assertEqual(s.name, "Sara")
def test_num_queries_inheritance(self): def test_num_queries_inheritance(self):
s = Employee.objects.create(name="Sara", gender="F") s = Employee.objects.create(name="Sara", gender="F")
s.employee_num = 1 s.employee_num = 1