1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041 |
- from unittest import mock
- from django.core.checks import Error
- from django.core.checks import Warning as DjangoWarning
- from django.db import connection, models
- from django.test.testcases import SimpleTestCase
- from django.test.utils import isolate_apps, modify_settings, override_settings
- @isolate_apps("invalid_models_tests")
- class RelativeFieldTests(SimpleTestCase):
- def test_valid_foreign_key_without_accessor(self):
- class Target(models.Model):
- # There would be a clash if Model.field installed an accessor.
- model = models.IntegerField()
- class Model(models.Model):
- field = models.ForeignKey(Target, models.CASCADE, related_name="+")
- field = Model._meta.get_field("field")
- self.assertEqual(field.check(), [])
- def test_foreign_key_to_missing_model(self):
- # Model names are resolved when a model is being created, so we cannot
- # test relative fields in isolation and we need to attach them to a
- # model.
- class Model(models.Model):
- foreign_key = models.ForeignKey("Rel1", models.CASCADE)
- field = Model._meta.get_field("foreign_key")
- self.assertEqual(
- field.check(),
- [
- Error(
- "Field defines a relation with model 'Rel1', "
- "which is either not installed, or is abstract.",
- obj=field,
- id="fields.E300",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- def test_foreign_key_to_isolate_apps_model(self):
- """
- #25723 - Referenced model registration lookup should be run against the
- field's model registry.
- """
- class OtherModel(models.Model):
- pass
- class Model(models.Model):
- foreign_key = models.ForeignKey("OtherModel", models.CASCADE)
- field = Model._meta.get_field("foreign_key")
- self.assertEqual(field.check(from_model=Model), [])
- def test_many_to_many_to_missing_model(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("Rel2")
- field = Model._meta.get_field("m2m")
- self.assertEqual(
- field.check(from_model=Model),
- [
- Error(
- "Field defines a relation with model 'Rel2', "
- "which is either not installed, or is abstract.",
- obj=field,
- id="fields.E300",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- def test_many_to_many_to_isolate_apps_model(self):
- """
- #25723 - Referenced model registration lookup should be run against the
- field's model registry.
- """
- class OtherModel(models.Model):
- pass
- class Model(models.Model):
- m2m = models.ManyToManyField("OtherModel")
- field = Model._meta.get_field("m2m")
- self.assertEqual(field.check(from_model=Model), [])
- def test_many_to_many_with_useless_options(self):
- class Model(models.Model):
- name = models.CharField(max_length=20)
- class ModelM2M(models.Model):
- m2m = models.ManyToManyField(
- Model, null=True, validators=[lambda x: x], db_comment="Column comment"
- )
- field = ModelM2M._meta.get_field("m2m")
- self.assertEqual(
- ModelM2M.check(),
- [
- DjangoWarning(
- "null has no effect on ManyToManyField.",
- obj=field,
- id="fields.W340",
- ),
- DjangoWarning(
- "ManyToManyField does not support validators.",
- obj=field,
- id="fields.W341",
- ),
- DjangoWarning(
- "db_comment has no effect on ManyToManyField.",
- obj=field,
- id="fields.W346",
- ),
- ],
- )
- def test_many_to_many_with_useless_related_name(self):
- class ModelM2M(models.Model):
- m2m = models.ManyToManyField("self", related_name="children")
- field = ModelM2M._meta.get_field("m2m")
- self.assertEqual(
- ModelM2M.check(),
- [
- DjangoWarning(
- "related_name has no effect on ManyToManyField with "
- 'a symmetrical relationship, e.g. to "self".',
- obj=field,
- id="fields.W345",
- ),
- ],
- )
- def test_ambiguous_relationship_model_from(self):
- class Person(models.Model):
- pass
- class Group(models.Model):
- field = models.ManyToManyField("Person", through="AmbiguousRelationship")
- class AmbiguousRelationship(models.Model):
- person = models.ForeignKey(Person, models.CASCADE)
- first_group = models.ForeignKey(Group, models.CASCADE, related_name="first")
- second_group = models.ForeignKey(
- Group, models.CASCADE, related_name="second"
- )
- field = Group._meta.get_field("field")
- self.assertEqual(
- field.check(from_model=Group),
- [
- Error(
- "The model is used as an intermediate model by "
- "'invalid_models_tests.Group.field', but it has more than one "
- "foreign key from 'Group', which is ambiguous. You must "
- "specify which foreign key Django should use via the "
- "through_fields keyword argument.",
- hint=(
- "If you want to create a recursive relationship, use "
- 'ManyToManyField("self", through="AmbiguousRelationship").'
- ),
- obj=field,
- id="fields.E334",
- ),
- ],
- )
- def test_ambiguous_relationship_model_to(self):
- class Person(models.Model):
- pass
- class Group(models.Model):
- field = models.ManyToManyField(
- "Person", through="AmbiguousRelationship", related_name="tertiary"
- )
- class AmbiguousRelationship(models.Model):
- # Too much foreign keys to Person.
- first_person = models.ForeignKey(
- Person, models.CASCADE, related_name="first"
- )
- second_person = models.ForeignKey(
- Person, models.CASCADE, related_name="second"
- )
- second_model = models.ForeignKey(Group, models.CASCADE)
- field = Group._meta.get_field("field")
- self.assertEqual(
- field.check(from_model=Group),
- [
- Error(
- "The model is used as an intermediate model by "
- "'invalid_models_tests.Group.field', but it has more than one "
- "foreign key to 'Person', which is ambiguous. You must specify "
- "which foreign key Django should use via the through_fields "
- "keyword argument.",
- hint=(
- "If you want to create a recursive relationship, use "
- 'ManyToManyField("self", through="AmbiguousRelationship").'
- ),
- obj=field,
- id="fields.E335",
- ),
- ],
- )
- def test_relationship_model_with_foreign_key_to_wrong_model(self):
- class WrongModel(models.Model):
- pass
- class Person(models.Model):
- pass
- class Group(models.Model):
- members = models.ManyToManyField("Person", through="InvalidRelationship")
- class InvalidRelationship(models.Model):
- person = models.ForeignKey(Person, models.CASCADE)
- wrong_foreign_key = models.ForeignKey(WrongModel, models.CASCADE)
- # The last foreign key should point to Group model.
- field = Group._meta.get_field("members")
- self.assertEqual(
- field.check(from_model=Group),
- [
- Error(
- "The model is used as an intermediate model by "
- "'invalid_models_tests.Group.members', but it does not "
- "have a foreign key to 'Group' or 'Person'.",
- obj=InvalidRelationship,
- id="fields.E336",
- ),
- ],
- )
- def test_relationship_model_missing_foreign_key(self):
- class Person(models.Model):
- pass
- class Group(models.Model):
- members = models.ManyToManyField("Person", through="InvalidRelationship")
- class InvalidRelationship(models.Model):
- group = models.ForeignKey(Group, models.CASCADE)
- # No foreign key to Person
- field = Group._meta.get_field("members")
- self.assertEqual(
- field.check(from_model=Group),
- [
- Error(
- "The model is used as an intermediate model by "
- "'invalid_models_tests.Group.members', but it does not have "
- "a foreign key to 'Group' or 'Person'.",
- obj=InvalidRelationship,
- id="fields.E336",
- ),
- ],
- )
- def test_missing_relationship_model(self):
- class Person(models.Model):
- pass
- class Group(models.Model):
- members = models.ManyToManyField("Person", through="MissingM2MModel")
- field = Group._meta.get_field("members")
- self.assertEqual(
- field.check(from_model=Group),
- [
- Error(
- "Field specifies a many-to-many relation through model "
- "'MissingM2MModel', which has not been installed.",
- obj=field,
- id="fields.E331",
- ),
- ],
- )
- def test_missing_relationship_model_on_model_check(self):
- class Person(models.Model):
- pass
- class Group(models.Model):
- members = models.ManyToManyField("Person", through="MissingM2MModel")
- self.assertEqual(
- Group.check(),
- [
- Error(
- "Field specifies a many-to-many relation through model "
- "'MissingM2MModel', which has not been installed.",
- obj=Group._meta.get_field("members"),
- id="fields.E331",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- def test_many_to_many_through_isolate_apps_model(self):
- """
- #25723 - Through model registration lookup should be run against the
- field's model registry.
- """
- class GroupMember(models.Model):
- person = models.ForeignKey("Person", models.CASCADE)
- group = models.ForeignKey("Group", models.CASCADE)
- class Person(models.Model):
- pass
- class Group(models.Model):
- members = models.ManyToManyField("Person", through="GroupMember")
- field = Group._meta.get_field("members")
- self.assertEqual(field.check(from_model=Group), [])
- def test_too_many_foreign_keys_in_self_referential_model(self):
- class Person(models.Model):
- friends = models.ManyToManyField(
- "self", through="InvalidRelationship", symmetrical=False
- )
- class InvalidRelationship(models.Model):
- first = models.ForeignKey(
- Person, models.CASCADE, related_name="rel_from_set_2"
- )
- second = models.ForeignKey(
- Person, models.CASCADE, related_name="rel_to_set_2"
- )
- third = models.ForeignKey(
- Person, models.CASCADE, related_name="too_many_by_far"
- )
- field = Person._meta.get_field("friends")
- self.assertEqual(
- field.check(from_model=Person),
- [
- Error(
- "The model is used as an intermediate model by "
- "'invalid_models_tests.Person.friends', but it has more than two "
- "foreign keys to 'Person', which is ambiguous. You must specify "
- "which two foreign keys Django should use via the through_fields "
- "keyword argument.",
- hint=(
- "Use through_fields to specify which two foreign keys Django "
- "should use."
- ),
- obj=InvalidRelationship,
- id="fields.E333",
- ),
- ],
- )
- def test_foreign_key_to_abstract_model(self):
- class AbstractModel(models.Model):
- class Meta:
- abstract = True
- class Model(models.Model):
- rel_string_foreign_key = models.ForeignKey("AbstractModel", models.CASCADE)
- rel_class_foreign_key = models.ForeignKey(AbstractModel, models.CASCADE)
- fields = [
- Model._meta.get_field("rel_string_foreign_key"),
- Model._meta.get_field("rel_class_foreign_key"),
- ]
- expected_error = Error(
- "Field defines a relation with model 'AbstractModel', "
- "which is either not installed, or is abstract.",
- id="fields.E300",
- )
- for field in fields:
- expected_error.obj = field
- self.assertEqual(field.check(), [expected_error])
- def test_m2m_to_abstract_model(self):
- class AbstractModel(models.Model):
- class Meta:
- abstract = True
- class Model(models.Model):
- rel_string_m2m = models.ManyToManyField("AbstractModel")
- rel_class_m2m = models.ManyToManyField(AbstractModel)
- fields = [
- Model._meta.get_field("rel_string_m2m"),
- Model._meta.get_field("rel_class_m2m"),
- ]
- expected_error = Error(
- "Field defines a relation with model 'AbstractModel', "
- "which is either not installed, or is abstract.",
- id="fields.E300",
- )
- for field in fields:
- expected_error.obj = field
- self.assertEqual(field.check(from_model=Model), [expected_error])
- def test_unique_m2m(self):
- class Person(models.Model):
- name = models.CharField(max_length=5)
- class Group(models.Model):
- members = models.ManyToManyField("Person", unique=True)
- field = Group._meta.get_field("members")
- self.assertEqual(
- field.check(from_model=Group),
- [
- Error(
- "ManyToManyFields cannot be unique.",
- obj=field,
- id="fields.E330",
- ),
- ],
- )
- def test_foreign_key_to_non_unique_field(self):
- class Target(models.Model):
- bad = models.IntegerField() # No unique=True
- class Model(models.Model):
- foreign_key = models.ForeignKey("Target", models.CASCADE, to_field="bad")
- field = Model._meta.get_field("foreign_key")
- self.assertEqual(
- field.check(),
- [
- Error(
- "'Target.bad' must be unique because it is referenced by a foreign "
- "key.",
- hint=(
- "Add unique=True to this field or add a UniqueConstraint "
- "(without condition) in the model Meta.constraints."
- ),
- obj=field,
- id="fields.E311",
- ),
- ],
- )
- def test_foreign_key_to_non_unique_field_under_explicit_model(self):
- class Target(models.Model):
- bad = models.IntegerField()
- class Model(models.Model):
- field = models.ForeignKey(Target, models.CASCADE, to_field="bad")
- field = Model._meta.get_field("field")
- self.assertEqual(
- field.check(),
- [
- Error(
- "'Target.bad' must be unique because it is referenced by a foreign "
- "key.",
- hint=(
- "Add unique=True to this field or add a UniqueConstraint "
- "(without condition) in the model Meta.constraints."
- ),
- obj=field,
- id="fields.E311",
- ),
- ],
- )
- def test_foreign_key_to_partially_unique_field(self):
- class Target(models.Model):
- source = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["source"],
- name="tfktpuf_partial_unique",
- condition=models.Q(pk__gt=2),
- ),
- ]
- class Model(models.Model):
- field = models.ForeignKey(Target, models.CASCADE, to_field="source")
- field = Model._meta.get_field("field")
- self.assertEqual(
- field.check(),
- [
- Error(
- "'Target.source' must be unique because it is referenced by a "
- "foreign key.",
- hint=(
- "Add unique=True to this field or add a UniqueConstraint "
- "(without condition) in the model Meta.constraints."
- ),
- obj=field,
- id="fields.E311",
- ),
- ],
- )
- def test_foreign_key_to_unique_field_with_meta_constraint(self):
- class Target(models.Model):
- source = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["source"],
- name="tfktufwmc_unique",
- ),
- ]
- class Model(models.Model):
- field = models.ForeignKey(Target, models.CASCADE, to_field="source")
- field = Model._meta.get_field("field")
- self.assertEqual(field.check(), [])
- def test_foreign_object_to_non_unique_fields(self):
- class Person(models.Model):
- # Note that both fields are not unique.
- country_id = models.IntegerField()
- city_id = models.IntegerField()
- class MMembership(models.Model):
- person_country_id = models.IntegerField()
- person_city_id = models.IntegerField()
- person = models.ForeignObject(
- Person,
- on_delete=models.CASCADE,
- from_fields=["person_country_id", "person_city_id"],
- to_fields=["country_id", "city_id"],
- )
- field = MMembership._meta.get_field("person")
- self.assertEqual(
- field.check(),
- [
- Error(
- "No subset of the fields 'country_id', 'city_id' on model 'Person' "
- "is unique.",
- hint=(
- "Mark a single field as unique=True or add a set of "
- "fields to a unique constraint (via unique_together or a "
- "UniqueConstraint (without condition) in the model "
- "Meta.constraints)."
- ),
- obj=field,
- id="fields.E310",
- )
- ],
- )
- def test_foreign_object_to_partially_unique_field(self):
- class Person(models.Model):
- country_id = models.IntegerField()
- city_id = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["country_id", "city_id"],
- name="tfotpuf_partial_unique",
- condition=models.Q(pk__gt=2),
- ),
- ]
- class MMembership(models.Model):
- person_country_id = models.IntegerField()
- person_city_id = models.IntegerField()
- person = models.ForeignObject(
- Person,
- on_delete=models.CASCADE,
- from_fields=["person_country_id", "person_city_id"],
- to_fields=["country_id", "city_id"],
- )
- field = MMembership._meta.get_field("person")
- self.assertEqual(
- field.check(),
- [
- Error(
- "No subset of the fields 'country_id', 'city_id' on model "
- "'Person' is unique.",
- hint=(
- "Mark a single field as unique=True or add a set of "
- "fields to a unique constraint (via unique_together or a "
- "UniqueConstraint (without condition) in the model "
- "Meta.constraints)."
- ),
- obj=field,
- id="fields.E310",
- ),
- ],
- )
- def test_foreign_object_to_unique_field_with_meta_constraint(self):
- class Person(models.Model):
- country_id = models.IntegerField()
- city_id = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["country_id", "city_id"],
- name="tfotpuf_unique",
- ),
- ]
- class MMembership(models.Model):
- person_country_id = models.IntegerField()
- person_city_id = models.IntegerField()
- person = models.ForeignObject(
- Person,
- on_delete=models.CASCADE,
- from_fields=["person_country_id", "person_city_id"],
- to_fields=["country_id", "city_id"],
- )
- field = MMembership._meta.get_field("person")
- self.assertEqual(field.check(), [])
- def test_on_delete_set_null_on_non_nullable_field(self):
- class Person(models.Model):
- pass
- class Model(models.Model):
- foreign_key = models.ForeignKey("Person", models.SET_NULL)
- field = Model._meta.get_field("foreign_key")
- self.assertEqual(
- field.check(),
- [
- Error(
- "Field specifies on_delete=SET_NULL, but cannot be null.",
- hint=(
- "Set null=True argument on the field, or change the on_delete "
- "rule."
- ),
- obj=field,
- id="fields.E320",
- ),
- ],
- )
- def test_on_delete_set_default_without_default_value(self):
- class Person(models.Model):
- pass
- class Model(models.Model):
- foreign_key = models.ForeignKey("Person", models.SET_DEFAULT)
- field = Model._meta.get_field("foreign_key")
- self.assertEqual(
- field.check(),
- [
- Error(
- "Field specifies on_delete=SET_DEFAULT, but has no default value.",
- hint="Set a default value, or change the on_delete rule.",
- obj=field,
- id="fields.E321",
- ),
- ],
- )
- def test_nullable_primary_key(self):
- class Model(models.Model):
- field = models.IntegerField(primary_key=True, null=True)
- field = Model._meta.get_field("field")
- with mock.patch.object(
- connection.features, "interprets_empty_strings_as_nulls", False
- ):
- results = field.check()
- self.assertEqual(
- results,
- [
- Error(
- "Primary keys must not have null=True.",
- hint=(
- "Set null=False on the field, or remove primary_key=True "
- "argument."
- ),
- obj=field,
- id="fields.E007",
- ),
- ],
- )
- def test_not_swapped_model(self):
- class SwappableModel(models.Model):
- # A model that can be, but isn't swapped out. References to this
- # model should *not* raise any validation error.
- class Meta:
- swappable = "TEST_SWAPPABLE_MODEL"
- class Model(models.Model):
- explicit_fk = models.ForeignKey(
- SwappableModel,
- models.CASCADE,
- related_name="explicit_fk",
- )
- implicit_fk = models.ForeignKey(
- "invalid_models_tests.SwappableModel",
- models.CASCADE,
- related_name="implicit_fk",
- )
- explicit_m2m = models.ManyToManyField(
- SwappableModel, related_name="explicit_m2m"
- )
- implicit_m2m = models.ManyToManyField(
- "invalid_models_tests.SwappableModel",
- related_name="implicit_m2m",
- )
- explicit_fk = Model._meta.get_field("explicit_fk")
- self.assertEqual(explicit_fk.check(), [])
- implicit_fk = Model._meta.get_field("implicit_fk")
- self.assertEqual(implicit_fk.check(), [])
- explicit_m2m = Model._meta.get_field("explicit_m2m")
- self.assertEqual(explicit_m2m.check(from_model=Model), [])
- implicit_m2m = Model._meta.get_field("implicit_m2m")
- self.assertEqual(implicit_m2m.check(from_model=Model), [])
- @override_settings(TEST_SWAPPED_MODEL="invalid_models_tests.Replacement")
- def test_referencing_to_swapped_model(self):
- class Replacement(models.Model):
- pass
- class SwappedModel(models.Model):
- class Meta:
- swappable = "TEST_SWAPPED_MODEL"
- class Model(models.Model):
- explicit_fk = models.ForeignKey(
- SwappedModel,
- models.CASCADE,
- related_name="explicit_fk",
- )
- implicit_fk = models.ForeignKey(
- "invalid_models_tests.SwappedModel",
- models.CASCADE,
- related_name="implicit_fk",
- )
- explicit_m2m = models.ManyToManyField(
- SwappedModel, related_name="explicit_m2m"
- )
- implicit_m2m = models.ManyToManyField(
- "invalid_models_tests.SwappedModel",
- related_name="implicit_m2m",
- )
- fields = [
- Model._meta.get_field("explicit_fk"),
- Model._meta.get_field("implicit_fk"),
- Model._meta.get_field("explicit_m2m"),
- Model._meta.get_field("implicit_m2m"),
- ]
- expected_error = Error(
- (
- "Field defines a relation with the model "
- "'invalid_models_tests.SwappedModel', which has been swapped out."
- ),
- hint="Update the relation to point at 'settings.TEST_SWAPPED_MODEL'.",
- id="fields.E301",
- )
- for field in fields:
- expected_error.obj = field
- self.assertEqual(field.check(from_model=Model), [expected_error])
- def test_related_field_has_invalid_related_name(self):
- digit = 0
- illegal_non_alphanumeric = "!"
- whitespace = "\t"
- invalid_related_names = [
- "%s_begins_with_digit" % digit,
- "%s_begins_with_illegal_non_alphanumeric" % illegal_non_alphanumeric,
- "%s_begins_with_whitespace" % whitespace,
- "contains_%s_illegal_non_alphanumeric" % illegal_non_alphanumeric,
- "contains_%s_whitespace" % whitespace,
- "ends_with_with_illegal_non_alphanumeric_%s" % illegal_non_alphanumeric,
- "ends_with_whitespace_%s" % whitespace,
- "with", # a Python keyword
- "related_name\n",
- "",
- ",", # non-ASCII
- ]
- class Parent(models.Model):
- pass
- for invalid_related_name in invalid_related_names:
- Child = type(
- "Child%s" % invalid_related_name,
- (models.Model,),
- {
- "parent": models.ForeignKey(
- "Parent", models.CASCADE, related_name=invalid_related_name
- ),
- "__module__": Parent.__module__,
- },
- )
- field = Child._meta.get_field("parent")
- self.assertEqual(
- Child.check(),
- [
- Error(
- "The name '%s' is invalid related_name for field Child%s.parent"
- % (invalid_related_name, invalid_related_name),
- hint=(
- "Related name must be a valid Python identifier or end "
- "with a '+'"
- ),
- obj=field,
- id="fields.E306",
- ),
- ],
- )
- def test_related_field_has_valid_related_name(self):
- lowercase = "a"
- uppercase = "A"
- digit = 0
- related_names = [
- "%s_starts_with_lowercase" % lowercase,
- "%s_tarts_with_uppercase" % uppercase,
- "_starts_with_underscore",
- "contains_%s_digit" % digit,
- "ends_with_plus+",
- "_+",
- "+",
- "試",
- "試驗+",
- ]
- class Parent(models.Model):
- pass
- for related_name in related_names:
- Child = type(
- "Child%s" % related_name,
- (models.Model,),
- {
- "parent": models.ForeignKey(
- "Parent", models.CASCADE, related_name=related_name
- ),
- "__module__": Parent.__module__,
- },
- )
- self.assertEqual(Child.check(), [])
- def test_to_fields_exist(self):
- class Parent(models.Model):
- pass
- class Child(models.Model):
- a = models.PositiveIntegerField()
- b = models.PositiveIntegerField()
- parent = models.ForeignObject(
- Parent,
- on_delete=models.SET_NULL,
- from_fields=("a", "b"),
- to_fields=("a", "b"),
- )
- field = Child._meta.get_field("parent")
- self.assertEqual(
- field.check(),
- [
- Error(
- "The to_field 'a' doesn't exist on the related model "
- "'invalid_models_tests.Parent'.",
- obj=field,
- id="fields.E312",
- ),
- Error(
- "The to_field 'b' doesn't exist on the related model "
- "'invalid_models_tests.Parent'.",
- obj=field,
- id="fields.E312",
- ),
- ],
- )
- def test_to_fields_not_checked_if_related_model_doesnt_exist(self):
- class Child(models.Model):
- a = models.PositiveIntegerField()
- b = models.PositiveIntegerField()
- parent = models.ForeignObject(
- "invalid_models_tests.Parent",
- on_delete=models.SET_NULL,
- from_fields=("a", "b"),
- to_fields=("a", "b"),
- )
- field = Child._meta.get_field("parent")
- self.assertEqual(
- field.check(),
- [
- Error(
- "Field defines a relation with model "
- "'invalid_models_tests.Parent', which is either not installed, or "
- "is abstract.",
- id="fields.E300",
- obj=field,
- ),
- ],
- )
- def test_invalid_related_query_name(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- first = models.ForeignKey(
- Target, models.CASCADE, related_name="contains__double"
- )
- second = models.ForeignKey(
- Target, models.CASCADE, related_query_name="ends_underscore_"
- )
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse query name 'contains__double' must not contain '__'.",
- hint=(
- "Add or change a related_name or related_query_name "
- "argument for this field."
- ),
- obj=Model._meta.get_field("first"),
- id="fields.E309",
- ),
- Error(
- "Reverse query name 'ends_underscore_' must not end with an "
- "underscore.",
- hint=(
- "Add or change a related_name or related_query_name "
- "argument for this field."
- ),
- obj=Model._meta.get_field("second"),
- id="fields.E308",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- class AccessorClashTests(SimpleTestCase):
- def test_fk_to_integer(self):
- self._test_accessor_clash(
- target=models.IntegerField(),
- relative=models.ForeignKey("Target", models.CASCADE),
- )
- def test_fk_to_fk(self):
- self._test_accessor_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ForeignKey("Target", models.CASCADE),
- )
- def test_fk_to_m2m(self):
- self._test_accessor_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ForeignKey("Target", models.CASCADE),
- )
- def test_m2m_to_integer(self):
- self._test_accessor_clash(
- target=models.IntegerField(), relative=models.ManyToManyField("Target")
- )
- def test_m2m_to_fk(self):
- self._test_accessor_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ManyToManyField("Target"),
- )
- def test_m2m_to_m2m(self):
- self._test_accessor_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ManyToManyField("Target"),
- )
- def _test_accessor_clash(self, target, relative):
- class Another(models.Model):
- pass
- class Target(models.Model):
- model_set = target
- class Model(models.Model):
- rel = relative
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Target.model_set' for "
- "'invalid_models_tests.Model.rel' clashes with field name "
- "'invalid_models_tests.Target.model_set'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.model_set', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.rel'."
- ),
- obj=Model._meta.get_field("rel"),
- id="fields.E302",
- ),
- ],
- )
- def test_clash_between_accessors(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- foreign = models.ForeignKey(Target, models.CASCADE)
- m2m = models.ManyToManyField(Target)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Target.model_set' for "
- "'invalid_models_tests.Model.foreign' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.m2m'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.foreign' or "
- "'invalid_models_tests.Model.m2m'."
- ),
- obj=Model._meta.get_field("foreign"),
- id="fields.E304",
- ),
- Error(
- "Reverse accessor 'Target.model_set' for "
- "'invalid_models_tests.Model.m2m' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.foreign'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.m2m' or "
- "'invalid_models_tests.Model.foreign'."
- ),
- obj=Model._meta.get_field("m2m"),
- id="fields.E304",
- ),
- ],
- )
- def test_m2m_to_m2m_with_inheritance(self):
- """Ref #22047."""
- class Target(models.Model):
- pass
- class Model(models.Model):
- children = models.ManyToManyField(
- "Child", related_name="m2m_clash", related_query_name="no_clash"
- )
- class Parent(models.Model):
- m2m_clash = models.ManyToManyField("Target")
- class Child(Parent):
- pass
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Child.m2m_clash' for "
- "'invalid_models_tests.Model.children' clashes with field "
- "name 'invalid_models_tests.Child.m2m_clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Child.m2m_clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.children'."
- ),
- obj=Model._meta.get_field("children"),
- id="fields.E302",
- )
- ],
- )
- def test_no_clash_for_hidden_related_name(self):
- class Stub(models.Model):
- pass
- class ManyToManyRel(models.Model):
- thing1 = models.ManyToManyField(Stub, related_name="+")
- thing2 = models.ManyToManyField(Stub, related_name="+")
- class FKRel(models.Model):
- thing1 = models.ForeignKey(Stub, models.CASCADE, related_name="+")
- thing2 = models.ForeignKey(Stub, models.CASCADE, related_name="+")
- self.assertEqual(ManyToManyRel.check(), [])
- self.assertEqual(FKRel.check(), [])
- @isolate_apps("invalid_models_tests")
- class ReverseQueryNameClashTests(SimpleTestCase):
- def test_fk_to_integer(self):
- self._test_reverse_query_name_clash(
- target=models.IntegerField(),
- relative=models.ForeignKey("Target", models.CASCADE),
- )
- def test_fk_to_fk(self):
- self._test_reverse_query_name_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ForeignKey("Target", models.CASCADE),
- )
- def test_fk_to_m2m(self):
- self._test_reverse_query_name_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ForeignKey("Target", models.CASCADE),
- )
- def test_m2m_to_integer(self):
- self._test_reverse_query_name_clash(
- target=models.IntegerField(), relative=models.ManyToManyField("Target")
- )
- def test_m2m_to_fk(self):
- self._test_reverse_query_name_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ManyToManyField("Target"),
- )
- def test_m2m_to_m2m(self):
- self._test_reverse_query_name_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ManyToManyField("Target"),
- )
- def _test_reverse_query_name_clash(self, target, relative):
- class Another(models.Model):
- pass
- class Target(models.Model):
- model = target
- class Model(models.Model):
- rel = relative
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse query name for 'invalid_models_tests.Model.rel' "
- "clashes with field name 'invalid_models_tests.Target.model'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.model', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.rel'."
- ),
- obj=Model._meta.get_field("rel"),
- id="fields.E303",
- ),
- ],
- )
- @modify_settings(INSTALLED_APPS={"append": "basic"})
- @isolate_apps("basic", "invalid_models_tests")
- def test_no_clash_across_apps_without_accessor(self):
- class Target(models.Model):
- class Meta:
- app_label = "invalid_models_tests"
- class Model(models.Model):
- m2m = models.ManyToManyField(Target, related_name="+")
- class Meta:
- app_label = "basic"
- def _test():
- # Define model with the same name.
- class Model(models.Model):
- m2m = models.ManyToManyField(Target, related_name="+")
- class Meta:
- app_label = "invalid_models_tests"
- self.assertEqual(Model.check(), [])
- _test()
- self.assertEqual(Model.check(), [])
- @isolate_apps("invalid_models_tests")
- class ExplicitRelatedNameClashTests(SimpleTestCase):
- def test_fk_to_integer(self):
- self._test_explicit_related_name_clash(
- target=models.IntegerField(),
- relative=models.ForeignKey("Target", models.CASCADE, related_name="clash"),
- )
- def test_fk_to_fk(self):
- self._test_explicit_related_name_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ForeignKey("Target", models.CASCADE, related_name="clash"),
- )
- def test_fk_to_m2m(self):
- self._test_explicit_related_name_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ForeignKey("Target", models.CASCADE, related_name="clash"),
- )
- def test_m2m_to_integer(self):
- self._test_explicit_related_name_clash(
- target=models.IntegerField(),
- relative=models.ManyToManyField("Target", related_name="clash"),
- )
- def test_m2m_to_fk(self):
- self._test_explicit_related_name_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ManyToManyField("Target", related_name="clash"),
- )
- def test_m2m_to_m2m(self):
- self._test_explicit_related_name_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ManyToManyField("Target", related_name="clash"),
- )
- def _test_explicit_related_name_clash(self, target, relative):
- class Another(models.Model):
- pass
- class Target(models.Model):
- clash = target
- class Model(models.Model):
- rel = relative
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Target.clash' for "
- "'invalid_models_tests.Model.rel' clashes with field name "
- "'invalid_models_tests.Target.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.rel'."
- ),
- obj=Model._meta.get_field("rel"),
- id="fields.E302",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.rel' "
- "clashes with field name 'invalid_models_tests.Target.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.rel'."
- ),
- obj=Model._meta.get_field("rel"),
- id="fields.E303",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- class ExplicitRelatedQueryNameClashTests(SimpleTestCase):
- def test_fk_to_integer(self, related_name=None):
- self._test_explicit_related_query_name_clash(
- target=models.IntegerField(),
- relative=models.ForeignKey(
- "Target",
- models.CASCADE,
- related_name=related_name,
- related_query_name="clash",
- ),
- )
- def test_hidden_fk_to_integer(self, related_name=None):
- self.test_fk_to_integer(related_name="+")
- def test_fk_to_fk(self, related_name=None):
- self._test_explicit_related_query_name_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ForeignKey(
- "Target",
- models.CASCADE,
- related_name=related_name,
- related_query_name="clash",
- ),
- )
- def test_hidden_fk_to_fk(self):
- self.test_fk_to_fk(related_name="+")
- def test_fk_to_m2m(self, related_name=None):
- self._test_explicit_related_query_name_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ForeignKey(
- "Target",
- models.CASCADE,
- related_name=related_name,
- related_query_name="clash",
- ),
- )
- def test_hidden_fk_to_m2m(self):
- self.test_fk_to_m2m(related_name="+")
- def test_m2m_to_integer(self, related_name=None):
- self._test_explicit_related_query_name_clash(
- target=models.IntegerField(),
- relative=models.ManyToManyField(
- "Target", related_name=related_name, related_query_name="clash"
- ),
- )
- def test_hidden_m2m_to_integer(self):
- self.test_m2m_to_integer(related_name="+")
- def test_m2m_to_fk(self, related_name=None):
- self._test_explicit_related_query_name_clash(
- target=models.ForeignKey("Another", models.CASCADE),
- relative=models.ManyToManyField(
- "Target", related_name=related_name, related_query_name="clash"
- ),
- )
- def test_hidden_m2m_to_fk(self):
- self.test_m2m_to_fk(related_name="+")
- def test_m2m_to_m2m(self, related_name=None):
- self._test_explicit_related_query_name_clash(
- target=models.ManyToManyField("Another"),
- relative=models.ManyToManyField(
- "Target",
- related_name=related_name,
- related_query_name="clash",
- ),
- )
- def test_hidden_m2m_to_m2m(self):
- self.test_m2m_to_m2m(related_name="+")
- def _test_explicit_related_query_name_clash(self, target, relative):
- class Another(models.Model):
- pass
- class Target(models.Model):
- clash = target
- class Model(models.Model):
- rel = relative
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse query name for 'invalid_models_tests.Model.rel' "
- "clashes with field name 'invalid_models_tests.Target.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.rel'."
- ),
- obj=Model._meta.get_field("rel"),
- id="fields.E303",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- class SelfReferentialM2MClashTests(SimpleTestCase):
- def test_clash_between_accessors(self):
- class Model(models.Model):
- first_m2m = models.ManyToManyField("self", symmetrical=False)
- second_m2m = models.ManyToManyField("self", symmetrical=False)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Model.model_set' for "
- "'invalid_models_tests.Model.first_m2m' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.second_m2m'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.first_m2m' or "
- "'invalid_models_tests.Model.second_m2m'."
- ),
- obj=Model._meta.get_field("first_m2m"),
- id="fields.E304",
- ),
- Error(
- "Reverse accessor 'Model.model_set' for "
- "'invalid_models_tests.Model.second_m2m' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.first_m2m'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.second_m2m' or "
- "'invalid_models_tests.Model.first_m2m'."
- ),
- obj=Model._meta.get_field("second_m2m"),
- id="fields.E304",
- ),
- ],
- )
- def test_accessor_clash(self):
- class Model(models.Model):
- model_set = models.ManyToManyField("self", symmetrical=False)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Model.model_set' for "
- "'invalid_models_tests.Model.model_set' clashes with field "
- "name 'invalid_models_tests.Model.model_set'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.model_set', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.model_set'."
- ),
- obj=Model._meta.get_field("model_set"),
- id="fields.E302",
- ),
- ],
- )
- def test_reverse_query_name_clash(self):
- class Model(models.Model):
- model = models.ManyToManyField("self", symmetrical=False)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse query name for 'invalid_models_tests.Model.model' "
- "clashes with field name 'invalid_models_tests.Model.model'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.model', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.model'."
- ),
- obj=Model._meta.get_field("model"),
- id="fields.E303",
- ),
- ],
- )
- def test_clash_under_explicit_related_name(self):
- class Model(models.Model):
- clash = models.IntegerField()
- m2m = models.ManyToManyField(
- "self", symmetrical=False, related_name="clash"
- )
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Model.clash' for "
- "'invalid_models_tests.Model.m2m' clashes with field name "
- "'invalid_models_tests.Model.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.m2m'."
- ),
- obj=Model._meta.get_field("m2m"),
- id="fields.E302",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.m2m' "
- "clashes with field name 'invalid_models_tests.Model.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.m2m'."
- ),
- obj=Model._meta.get_field("m2m"),
- id="fields.E303",
- ),
- ],
- )
- def test_valid_model(self):
- class Model(models.Model):
- first = models.ManyToManyField(
- "self", symmetrical=False, related_name="first_accessor"
- )
- second = models.ManyToManyField(
- "self", symmetrical=False, related_name="second_accessor"
- )
- self.assertEqual(Model.check(), [])
- @isolate_apps("invalid_models_tests")
- class SelfReferentialFKClashTests(SimpleTestCase):
- def test_accessor_clash(self):
- class Model(models.Model):
- model_set = models.ForeignKey("Model", models.CASCADE)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Model.model_set' for "
- "'invalid_models_tests.Model.model_set' clashes with field "
- "name 'invalid_models_tests.Model.model_set'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.model_set', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.model_set'."
- ),
- obj=Model._meta.get_field("model_set"),
- id="fields.E302",
- ),
- ],
- )
- def test_reverse_query_name_clash(self):
- class Model(models.Model):
- model = models.ForeignKey("Model", models.CASCADE)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse query name for 'invalid_models_tests.Model.model' "
- "clashes with field name 'invalid_models_tests.Model.model'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.model', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.model'."
- ),
- obj=Model._meta.get_field("model"),
- id="fields.E303",
- ),
- ],
- )
- def test_clash_under_explicit_related_name(self):
- class Model(models.Model):
- clash = models.CharField(max_length=10)
- foreign = models.ForeignKey("Model", models.CASCADE, related_name="clash")
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Model.clash' for "
- "'invalid_models_tests.Model.foreign' clashes with field name "
- "'invalid_models_tests.Model.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.foreign'."
- ),
- obj=Model._meta.get_field("foreign"),
- id="fields.E302",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.foreign' "
- "clashes with field name 'invalid_models_tests.Model.clash'.",
- hint=(
- "Rename field 'invalid_models_tests.Model.clash', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.foreign'."
- ),
- obj=Model._meta.get_field("foreign"),
- id="fields.E303",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- class ComplexClashTests(SimpleTestCase):
- # New tests should not be included here, because this is a single,
- # self-contained sanity check, not a test of everything.
- def test_complex_clash(self):
- class Target(models.Model):
- tgt_safe = models.CharField(max_length=10)
- clash = models.CharField(max_length=10)
- model = models.CharField(max_length=10)
- clash1_set = models.CharField(max_length=10)
- class Model(models.Model):
- src_safe = models.CharField(max_length=10)
- foreign_1 = models.ForeignKey(Target, models.CASCADE, related_name="id")
- foreign_2 = models.ForeignKey(
- Target, models.CASCADE, related_name="src_safe"
- )
- m2m_1 = models.ManyToManyField(Target, related_name="id")
- m2m_2 = models.ManyToManyField(Target, related_name="src_safe")
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Reverse accessor 'Target.id' for "
- "'invalid_models_tests.Model.foreign_1' clashes with field "
- "name 'invalid_models_tests.Target.id'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.id', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.foreign_1'."
- ),
- obj=Model._meta.get_field("foreign_1"),
- id="fields.E302",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.foreign_1' "
- "clashes with field name 'invalid_models_tests.Target.id'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.id', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.foreign_1'."
- ),
- obj=Model._meta.get_field("foreign_1"),
- id="fields.E303",
- ),
- Error(
- "Reverse accessor 'Target.id' for "
- "'invalid_models_tests.Model.foreign_1' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.m2m_1'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.foreign_1' or "
- "'invalid_models_tests.Model.m2m_1'."
- ),
- obj=Model._meta.get_field("foreign_1"),
- id="fields.E304",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.foreign_1' "
- "clashes with reverse query name for "
- "'invalid_models_tests.Model.m2m_1'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.foreign_1' or "
- "'invalid_models_tests.Model.m2m_1'."
- ),
- obj=Model._meta.get_field("foreign_1"),
- id="fields.E305",
- ),
- Error(
- "Reverse accessor 'Target.src_safe' for "
- "'invalid_models_tests.Model.foreign_2' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.m2m_2'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.foreign_2' or "
- "'invalid_models_tests.Model.m2m_2'."
- ),
- obj=Model._meta.get_field("foreign_2"),
- id="fields.E304",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.foreign_2' "
- "clashes with reverse query name for "
- "'invalid_models_tests.Model.m2m_2'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.foreign_2' or "
- "'invalid_models_tests.Model.m2m_2'."
- ),
- obj=Model._meta.get_field("foreign_2"),
- id="fields.E305",
- ),
- Error(
- "Reverse accessor 'Target.id' for "
- "'invalid_models_tests.Model.m2m_1' clashes with field name "
- "'invalid_models_tests.Target.id'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.id', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.m2m_1'."
- ),
- obj=Model._meta.get_field("m2m_1"),
- id="fields.E302",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.m2m_1' "
- "clashes with field name 'invalid_models_tests.Target.id'.",
- hint=(
- "Rename field 'invalid_models_tests.Target.id', or "
- "add/change a related_name argument to the definition for "
- "field 'invalid_models_tests.Model.m2m_1'."
- ),
- obj=Model._meta.get_field("m2m_1"),
- id="fields.E303",
- ),
- Error(
- "Reverse accessor 'Target.id' for "
- "'invalid_models_tests.Model.m2m_1' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.foreign_1'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.m2m_1' or "
- "'invalid_models_tests.Model.foreign_1'."
- ),
- obj=Model._meta.get_field("m2m_1"),
- id="fields.E304",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.m2m_1' "
- "clashes with reverse query name for "
- "'invalid_models_tests.Model.foreign_1'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.m2m_1' or "
- "'invalid_models_tests.Model.foreign_1'."
- ),
- obj=Model._meta.get_field("m2m_1"),
- id="fields.E305",
- ),
- Error(
- "Reverse accessor 'Target.src_safe' for "
- "'invalid_models_tests.Model.m2m_2' clashes with reverse "
- "accessor for 'invalid_models_tests.Model.foreign_2'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.m2m_2' or "
- "'invalid_models_tests.Model.foreign_2'."
- ),
- obj=Model._meta.get_field("m2m_2"),
- id="fields.E304",
- ),
- Error(
- "Reverse query name for 'invalid_models_tests.Model.m2m_2' "
- "clashes with reverse query name for "
- "'invalid_models_tests.Model.foreign_2'.",
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Model.m2m_2' or "
- "'invalid_models_tests.Model.foreign_2'."
- ),
- obj=Model._meta.get_field("m2m_2"),
- id="fields.E305",
- ),
- ],
- )
- def test_clash_parent_link(self):
- class Parent(models.Model):
- pass
- class Child(Parent):
- other_parent = models.OneToOneField(Parent, models.CASCADE)
- errors = [
- (
- "fields.E304",
- "accessor",
- " 'Parent.child'",
- "parent_ptr",
- "other_parent",
- ),
- ("fields.E305", "query name", "", "parent_ptr", "other_parent"),
- (
- "fields.E304",
- "accessor",
- " 'Parent.child'",
- "other_parent",
- "parent_ptr",
- ),
- ("fields.E305", "query name", "", "other_parent", "parent_ptr"),
- ]
- self.assertEqual(
- Child.check(),
- [
- Error(
- "Reverse %s%s for 'invalid_models_tests.Child.%s' clashes with "
- "reverse %s for 'invalid_models_tests.Child.%s'."
- % (attr, rel_name, field_name, attr, clash_name),
- hint=(
- "Add or change a related_name argument to the definition "
- "for 'invalid_models_tests.Child.%s' or "
- "'invalid_models_tests.Child.%s'." % (field_name, clash_name)
- ),
- obj=Child._meta.get_field(field_name),
- id=error_id,
- )
- for error_id, attr, rel_name, field_name, clash_name in errors
- ],
- )
- @isolate_apps("invalid_models_tests")
- class M2mThroughFieldsTests(SimpleTestCase):
- def test_m2m_field_argument_validation(self):
- """
- ManyToManyField accepts the ``through_fields`` kwarg
- only if an intermediary table is specified.
- """
- class Fan(models.Model):
- pass
- with self.assertRaisesMessage(
- ValueError, "Cannot specify through_fields without a through model"
- ):
- models.ManyToManyField(Fan, through_fields=("f1", "f2"))
- def test_invalid_order(self):
- """
- Mixing up the order of link fields to ManyToManyField.through_fields
- triggers validation errors.
- """
- class Fan(models.Model):
- pass
- class Event(models.Model):
- invitees = models.ManyToManyField(
- Fan, through="Invitation", through_fields=("invitee", "event")
- )
- class Invitation(models.Model):
- event = models.ForeignKey(Event, models.CASCADE)
- invitee = models.ForeignKey(Fan, models.CASCADE)
- inviter = models.ForeignKey(Fan, models.CASCADE, related_name="+")
- field = Event._meta.get_field("invitees")
- self.assertEqual(
- field.check(from_model=Event),
- [
- Error(
- "'Invitation.invitee' is not a foreign key to 'Event'.",
- hint=(
- "Did you mean one of the following foreign keys to 'Event': "
- "event?"
- ),
- obj=field,
- id="fields.E339",
- ),
- Error(
- "'Invitation.event' is not a foreign key to 'Fan'.",
- hint=(
- "Did you mean one of the following foreign keys to 'Fan': "
- "invitee, inviter?"
- ),
- obj=field,
- id="fields.E339",
- ),
- ],
- )
- def test_invalid_field(self):
- """
- Providing invalid field names to ManyToManyField.through_fields
- triggers validation errors.
- """
- class Fan(models.Model):
- pass
- class Event(models.Model):
- invitees = models.ManyToManyField(
- Fan,
- through="Invitation",
- through_fields=("invalid_field_1", "invalid_field_2"),
- )
- class Invitation(models.Model):
- event = models.ForeignKey(Event, models.CASCADE)
- invitee = models.ForeignKey(Fan, models.CASCADE)
- inviter = models.ForeignKey(Fan, models.CASCADE, related_name="+")
- field = Event._meta.get_field("invitees")
- self.assertEqual(
- field.check(from_model=Event),
- [
- Error(
- "The intermediary model 'invalid_models_tests.Invitation' has no "
- "field 'invalid_field_1'.",
- hint=(
- "Did you mean one of the following foreign keys to 'Event': "
- "event?"
- ),
- obj=field,
- id="fields.E338",
- ),
- Error(
- "The intermediary model 'invalid_models_tests.Invitation' has no "
- "field 'invalid_field_2'.",
- hint=(
- "Did you mean one of the following foreign keys to 'Fan': "
- "invitee, inviter?"
- ),
- obj=field,
- id="fields.E338",
- ),
- ],
- )
- def test_explicit_field_names(self):
- """
- If ``through_fields`` kwarg is given, it must specify both
- link fields of the intermediary table.
- """
- class Fan(models.Model):
- pass
- class Event(models.Model):
- invitees = models.ManyToManyField(
- Fan, through="Invitation", through_fields=(None, "invitee")
- )
- class Invitation(models.Model):
- event = models.ForeignKey(Event, models.CASCADE)
- invitee = models.ForeignKey(Fan, models.CASCADE)
- inviter = models.ForeignKey(Fan, models.CASCADE, related_name="+")
- field = Event._meta.get_field("invitees")
- self.assertEqual(
- field.check(from_model=Event),
- [
- Error(
- "Field specifies 'through_fields' but does not provide the names "
- "of the two link fields that should be used for the relation "
- "through model 'invalid_models_tests.Invitation'.",
- hint=(
- "Make sure you specify 'through_fields' as "
- "through_fields=('field1', 'field2')"
- ),
- obj=field,
- id="fields.E337",
- ),
- ],
- )
- def test_superset_foreign_object(self):
- class Parent(models.Model):
- a = models.PositiveIntegerField()
- b = models.PositiveIntegerField()
- c = models.PositiveIntegerField()
- class Meta:
- unique_together = (("a", "b", "c"),)
- class Child(models.Model):
- a = models.PositiveIntegerField()
- b = models.PositiveIntegerField()
- value = models.CharField(max_length=255)
- parent = models.ForeignObject(
- Parent,
- on_delete=models.SET_NULL,
- from_fields=("a", "b"),
- to_fields=("a", "b"),
- related_name="children",
- )
- field = Child._meta.get_field("parent")
- self.assertEqual(
- field.check(from_model=Child),
- [
- Error(
- "No subset of the fields 'a', 'b' on model 'Parent' is unique.",
- hint=(
- "Mark a single field as unique=True or add a set of "
- "fields to a unique constraint (via unique_together or a "
- "UniqueConstraint (without condition) in the model "
- "Meta.constraints)."
- ),
- obj=field,
- id="fields.E310",
- ),
- ],
- )
- def test_intersection_foreign_object(self):
- class Parent(models.Model):
- a = models.PositiveIntegerField()
- b = models.PositiveIntegerField()
- c = models.PositiveIntegerField()
- d = models.PositiveIntegerField()
- class Meta:
- unique_together = (("a", "b", "c"),)
- class Child(models.Model):
- a = models.PositiveIntegerField()
- b = models.PositiveIntegerField()
- d = models.PositiveIntegerField()
- value = models.CharField(max_length=255)
- parent = models.ForeignObject(
- Parent,
- on_delete=models.SET_NULL,
- from_fields=("a", "b", "d"),
- to_fields=("a", "b", "d"),
- related_name="children",
- )
- field = Child._meta.get_field("parent")
- self.assertEqual(
- field.check(from_model=Child),
- [
- Error(
- "No subset of the fields 'a', 'b', 'd' on model 'Parent' is "
- "unique.",
- hint=(
- "Mark a single field as unique=True or add a set of "
- "fields to a unique constraint (via unique_together or a "
- "UniqueConstraint (without condition) in the model "
- "Meta.constraints)."
- ),
- obj=field,
- id="fields.E310",
- ),
- ],
- )
|