2015-01-28 12:35:27 +00:00
|
|
|
from django.db import IntegrityError, transaction
|
2021-02-13 08:58:24 +00:00
|
|
|
from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature
|
2010-09-12 20:03:12 +00:00
|
|
|
|
2021-02-13 08:58:24 +00:00
|
|
|
from .fields import MyWrapper
|
|
|
|
from .models import Bar, Business, CustomAutoFieldModel, Employee, Foo
|
2010-09-12 20:03:12 +00:00
|
|
|
|
|
|
|
|
2014-11-07 14:35:02 +00:00
|
|
|
class BasicCustomPKTests(TestCase):
|
|
|
|
@classmethod
|
|
|
|
def setUpTestData(cls):
|
|
|
|
cls.dan = Employee.objects.create(
|
|
|
|
employee_code=123, first_name="Dan", last_name="Jones",
|
|
|
|
)
|
|
|
|
cls.fran = Employee.objects.create(
|
|
|
|
employee_code=456, first_name="Fran", last_name="Bones",
|
|
|
|
)
|
|
|
|
cls.business = Business.objects.create(name="Sears")
|
|
|
|
cls.business.employees.add(cls.dan, cls.fran)
|
|
|
|
|
|
|
|
def test_querysets(self):
|
|
|
|
"""
|
|
|
|
Both pk and custom attribute_name can be used in filter and friends
|
|
|
|
"""
|
2010-09-12 20:03:12 +00:00
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
Employee.objects.filter(pk=123), [
|
2010-09-12 20:03:12 +00:00
|
|
|
"Dan Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
Employee.objects.filter(employee_code=123), [
|
2010-09-12 20:03:12 +00:00
|
|
|
"Dan Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Employee.objects.filter(pk__in=[123, 456]), [
|
|
|
|
"Fran Bones",
|
|
|
|
"Dan Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
Employee.objects.all(), [
|
|
|
|
"Fran Bones",
|
2010-09-12 20:03:12 +00:00
|
|
|
"Dan Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
Business.objects.filter(name="Sears"), [
|
|
|
|
"Sears"
|
2010-09-12 20:03:12 +00:00
|
|
|
],
|
2014-11-07 14:35:02 +00:00
|
|
|
lambda b: b.name
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
Business.objects.filter(pk="Sears"), [
|
2010-09-12 20:03:12 +00:00
|
|
|
"Sears",
|
|
|
|
],
|
|
|
|
lambda b: b.name
|
|
|
|
)
|
|
|
|
|
2014-11-07 14:35:02 +00:00
|
|
|
def test_querysets_related_name(self):
|
|
|
|
"""
|
|
|
|
Custom pk doesn't affect related_name based lookups
|
|
|
|
"""
|
2010-09-12 20:03:12 +00:00
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
self.business.employees.all(), [
|
|
|
|
"Fran Bones",
|
|
|
|
"Dan Jones",
|
2010-09-12 20:03:12 +00:00
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
self.assertQuerysetEqual(
|
2014-11-07 14:35:02 +00:00
|
|
|
self.fran.business_set.all(), [
|
2010-09-12 20:03:12 +00:00
|
|
|
"Sears",
|
|
|
|
],
|
|
|
|
lambda b: b.name
|
|
|
|
)
|
|
|
|
|
2014-11-07 14:35:02 +00:00
|
|
|
def test_querysets_relational(self):
|
|
|
|
"""
|
|
|
|
Queries across tables, involving primary key
|
|
|
|
"""
|
2010-09-12 20:03:12 +00:00
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Employee.objects.filter(business__name="Sears"), [
|
2014-11-07 14:35:02 +00:00
|
|
|
"Fran Bones",
|
2010-09-12 20:03:12 +00:00
|
|
|
"Dan Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str,
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Employee.objects.filter(business__pk="Sears"), [
|
2014-11-07 14:35:02 +00:00
|
|
|
"Fran Bones",
|
2010-09-12 20:03:12 +00:00
|
|
|
"Dan Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str,
|
2010-09-12 20:03:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Business.objects.filter(employees__employee_code=123), [
|
|
|
|
"Sears",
|
|
|
|
],
|
|
|
|
lambda b: b.name
|
|
|
|
)
|
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Business.objects.filter(employees__pk=123), [
|
|
|
|
"Sears",
|
|
|
|
],
|
|
|
|
lambda b: b.name,
|
|
|
|
)
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Business.objects.filter(employees__first_name__startswith="Fran"), [
|
|
|
|
"Sears",
|
|
|
|
],
|
|
|
|
lambda b: b.name
|
|
|
|
)
|
|
|
|
|
2014-11-07 14:35:02 +00:00
|
|
|
def test_get(self):
|
|
|
|
"""
|
|
|
|
Get can accept pk or the real attribute name
|
|
|
|
"""
|
|
|
|
self.assertEqual(Employee.objects.get(pk=123), self.dan)
|
|
|
|
self.assertEqual(Employee.objects.get(pk=456), self.fran)
|
|
|
|
|
2016-01-17 11:26:39 +00:00
|
|
|
with self.assertRaises(Employee.DoesNotExist):
|
|
|
|
Employee.objects.get(pk=42)
|
2014-11-07 14:35:02 +00:00
|
|
|
|
|
|
|
# Use the name of the primary key, rather than pk.
|
|
|
|
self.assertEqual(Employee.objects.get(employee_code=123), self.dan)
|
|
|
|
|
|
|
|
def test_pk_attributes(self):
|
|
|
|
"""
|
|
|
|
pk and attribute name are available on the model
|
|
|
|
No default id attribute is added
|
|
|
|
"""
|
|
|
|
# pk can be used as a substitute for the primary key.
|
|
|
|
# The primary key can be accessed via the pk property on the model.
|
|
|
|
e = Employee.objects.get(pk=123)
|
|
|
|
self.assertEqual(e.pk, 123)
|
|
|
|
# Or we can use the real attribute name for the primary key:
|
|
|
|
self.assertEqual(e.employee_code, 123)
|
|
|
|
|
2017-05-28 19:37:21 +00:00
|
|
|
with self.assertRaisesMessage(AttributeError, "'Employee' object has no attribute 'id'"):
|
2016-01-17 11:26:39 +00:00
|
|
|
e.id
|
2014-11-07 14:35:02 +00:00
|
|
|
|
|
|
|
def test_in_bulk(self):
|
|
|
|
"""
|
|
|
|
Custom pks work with in_bulk, both for integer and non-integer types
|
|
|
|
"""
|
|
|
|
emps = Employee.objects.in_bulk([123, 456])
|
|
|
|
self.assertEqual(emps[123], self.dan)
|
|
|
|
|
|
|
|
self.assertEqual(Business.objects.in_bulk(["Sears"]), {
|
|
|
|
"Sears": self.business,
|
|
|
|
})
|
|
|
|
|
|
|
|
def test_save(self):
|
|
|
|
"""
|
|
|
|
custom pks do not affect save
|
|
|
|
"""
|
|
|
|
fran = Employee.objects.get(pk=456)
|
|
|
|
fran.last_name = "Jones"
|
|
|
|
fran.save()
|
|
|
|
|
|
|
|
self.assertQuerysetEqual(
|
|
|
|
Employee.objects.filter(last_name="Jones"), [
|
|
|
|
"Dan Jones",
|
|
|
|
"Fran Jones",
|
|
|
|
],
|
2016-12-29 15:27:49 +00:00
|
|
|
str
|
2014-11-07 14:35:02 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
class CustomPKTests(TestCase):
|
|
|
|
def test_custom_pk_create(self):
|
|
|
|
"""
|
|
|
|
New objects can be created both with pk and the custom name
|
|
|
|
"""
|
|
|
|
Employee.objects.create(employee_code=1234, first_name="Foo", last_name="Bar")
|
|
|
|
Employee.objects.create(pk=1235, first_name="Foo", last_name="Baz")
|
|
|
|
Business.objects.create(name="Bears")
|
|
|
|
Business.objects.create(pk="Tears")
|
|
|
|
|
2010-09-12 20:03:12 +00:00
|
|
|
def test_unicode_pk(self):
|
2020-04-18 14:46:05 +00:00
|
|
|
# Primary key may be Unicode string.
|
2013-09-08 19:20:01 +00:00
|
|
|
Business.objects.create(name='jaźń')
|
2010-09-12 20:03:12 +00:00
|
|
|
|
|
|
|
def test_unique_pk(self):
|
2020-05-01 12:37:21 +00:00
|
|
|
# The primary key must also be unique, so trying to create a new object
|
|
|
|
# with the same primary key will fail.
|
2013-09-08 19:20:01 +00:00
|
|
|
Employee.objects.create(
|
2010-09-12 20:03:12 +00:00
|
|
|
employee_code=123, first_name="Frank", last_name="Jones"
|
|
|
|
)
|
2013-09-22 20:14:17 +00:00
|
|
|
with self.assertRaises(IntegrityError):
|
|
|
|
with transaction.atomic():
|
|
|
|
Employee.objects.create(employee_code=123, first_name="Fred", last_name="Jones")
|
2010-09-12 20:03:12 +00:00
|
|
|
|
2013-11-27 15:01:18 +00:00
|
|
|
def test_zero_non_autoincrement_pk(self):
|
|
|
|
Employee.objects.create(
|
|
|
|
employee_code=0, first_name="Frank", last_name="Jones"
|
|
|
|
)
|
|
|
|
employee = Employee.objects.get(pk=0)
|
|
|
|
self.assertEqual(employee.employee_code, 0)
|
|
|
|
|
2010-09-12 20:03:12 +00:00
|
|
|
def test_custom_field_pk(self):
|
|
|
|
# Regression for #10785 -- Custom fields can be used for primary keys.
|
|
|
|
new_bar = Bar.objects.create()
|
|
|
|
new_foo = Foo.objects.create(bar=new_bar)
|
|
|
|
|
2011-01-25 03:14:28 +00:00
|
|
|
f = Foo.objects.get(bar=new_bar.pk)
|
|
|
|
self.assertEqual(f, new_foo)
|
|
|
|
self.assertEqual(f.bar, new_bar)
|
2010-09-12 20:03:12 +00:00
|
|
|
|
|
|
|
f = Foo.objects.get(bar=new_bar)
|
|
|
|
self.assertEqual(f, new_foo),
|
|
|
|
self.assertEqual(f.bar, new_bar)
|
|
|
|
|
|
|
|
# SQLite lets objects be saved with an empty primary key, even though an
|
|
|
|
# integer is expected. So we can't check for an error being raised in that
|
|
|
|
# case for SQLite. Remove it from the suite for this next bit.
|
2010-10-11 12:55:17 +00:00
|
|
|
@skipIfDBFeature('supports_unspecified_pk')
|
|
|
|
def test_required_pk(self):
|
|
|
|
# The primary key must be specified, so an error is raised if you
|
|
|
|
# try to create an object without it.
|
2013-09-22 20:14:17 +00:00
|
|
|
with self.assertRaises(IntegrityError):
|
|
|
|
with transaction.atomic():
|
|
|
|
Employee.objects.create(first_name="Tom", last_name="Smith")
|
2021-02-13 08:58:24 +00:00
|
|
|
|
|
|
|
def test_auto_field_subclass_create(self):
|
|
|
|
obj = CustomAutoFieldModel.objects.create()
|
|
|
|
self.assertIsInstance(obj.id, MyWrapper)
|
|
|
|
|
|
|
|
@skipUnlessDBFeature('can_return_rows_from_bulk_insert')
|
|
|
|
def test_auto_field_subclass_bulk_create(self):
|
|
|
|
obj = CustomAutoFieldModel()
|
|
|
|
CustomAutoFieldModel.objects.bulk_create([obj])
|
|
|
|
self.assertIsInstance(obj.id, MyWrapper)
|