test_relative_fields.py 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770
  1. from unittest import mock
  2. from django.core.checks import Error, Warning as DjangoWarning
  3. from django.db import connection, models
  4. from django.test.testcases import SimpleTestCase
  5. from django.test.utils import isolate_apps, modify_settings, override_settings
  6. @isolate_apps('invalid_models_tests')
  7. class RelativeFieldTests(SimpleTestCase):
  8. def test_valid_foreign_key_without_accessor(self):
  9. class Target(models.Model):
  10. # There would be a clash if Model.field installed an accessor.
  11. model = models.IntegerField()
  12. class Model(models.Model):
  13. field = models.ForeignKey(Target, models.CASCADE, related_name='+')
  14. field = Model._meta.get_field('field')
  15. self.assertEqual(field.check(), [])
  16. def test_foreign_key_to_missing_model(self):
  17. # Model names are resolved when a model is being created, so we cannot
  18. # test relative fields in isolation and we need to attach them to a
  19. # model.
  20. class Model(models.Model):
  21. foreign_key = models.ForeignKey('Rel1', models.CASCADE)
  22. field = Model._meta.get_field('foreign_key')
  23. self.assertEqual(field.check(), [
  24. Error(
  25. "Field defines a relation with model 'Rel1', "
  26. "which is either not installed, or is abstract.",
  27. obj=field,
  28. id='fields.E300',
  29. ),
  30. ])
  31. @isolate_apps('invalid_models_tests')
  32. def test_foreign_key_to_isolate_apps_model(self):
  33. """
  34. #25723 - Referenced model registration lookup should be run against the
  35. field's model registry.
  36. """
  37. class OtherModel(models.Model):
  38. pass
  39. class Model(models.Model):
  40. foreign_key = models.ForeignKey('OtherModel', models.CASCADE)
  41. field = Model._meta.get_field('foreign_key')
  42. self.assertEqual(field.check(from_model=Model), [])
  43. def test_many_to_many_to_missing_model(self):
  44. class Model(models.Model):
  45. m2m = models.ManyToManyField("Rel2")
  46. field = Model._meta.get_field('m2m')
  47. self.assertEqual(field.check(from_model=Model), [
  48. Error(
  49. "Field defines a relation with model 'Rel2', "
  50. "which is either not installed, or is abstract.",
  51. obj=field,
  52. id='fields.E300',
  53. ),
  54. ])
  55. @isolate_apps('invalid_models_tests')
  56. def test_many_to_many_to_isolate_apps_model(self):
  57. """
  58. #25723 - Referenced model registration lookup should be run against the
  59. field's model registry.
  60. """
  61. class OtherModel(models.Model):
  62. pass
  63. class Model(models.Model):
  64. m2m = models.ManyToManyField('OtherModel')
  65. field = Model._meta.get_field('m2m')
  66. self.assertEqual(field.check(from_model=Model), [])
  67. def test_many_to_many_with_useless_options(self):
  68. class Model(models.Model):
  69. name = models.CharField(max_length=20)
  70. class ModelM2M(models.Model):
  71. m2m = models.ManyToManyField(Model, null=True, validators=[lambda x: x])
  72. field = ModelM2M._meta.get_field('m2m')
  73. self.assertEqual(ModelM2M.check(), [
  74. DjangoWarning(
  75. 'null has no effect on ManyToManyField.',
  76. obj=field,
  77. id='fields.W340',
  78. ),
  79. DjangoWarning(
  80. 'ManyToManyField does not support validators.',
  81. obj=field,
  82. id='fields.W341',
  83. ),
  84. ])
  85. def test_many_to_many_with_useless_related_name(self):
  86. class ModelM2M(models.Model):
  87. m2m = models.ManyToManyField('self', related_name='children')
  88. field = ModelM2M._meta.get_field('m2m')
  89. self.assertEqual(ModelM2M.check(), [
  90. DjangoWarning(
  91. 'related_name has no effect on ManyToManyField with '
  92. 'a symmetrical relationship, e.g. to "self".',
  93. obj=field,
  94. id='fields.W345',
  95. ),
  96. ])
  97. def test_ambiguous_relationship_model_from(self):
  98. class Person(models.Model):
  99. pass
  100. class Group(models.Model):
  101. field = models.ManyToManyField('Person', through='AmbiguousRelationship')
  102. class AmbiguousRelationship(models.Model):
  103. person = models.ForeignKey(Person, models.CASCADE)
  104. first_group = models.ForeignKey(Group, models.CASCADE, related_name='first')
  105. second_group = models.ForeignKey(Group, models.CASCADE, related_name='second')
  106. field = Group._meta.get_field('field')
  107. self.assertEqual(field.check(from_model=Group), [
  108. Error(
  109. "The model is used as an intermediate model by "
  110. "'invalid_models_tests.Group.field', but it has more than one "
  111. "foreign key from 'Group', which is ambiguous. You must "
  112. "specify which foreign key Django should use via the "
  113. "through_fields keyword argument.",
  114. hint=(
  115. 'If you want to create a recursive relationship, use '
  116. 'ManyToManyField("self", through="AmbiguousRelationship").'
  117. ),
  118. obj=field,
  119. id='fields.E334',
  120. ),
  121. ])
  122. def test_ambiguous_relationship_model_to(self):
  123. class Person(models.Model):
  124. pass
  125. class Group(models.Model):
  126. field = models.ManyToManyField('Person', through="AmbiguousRelationship", related_name='tertiary')
  127. class AmbiguousRelationship(models.Model):
  128. # Too much foreign keys to Person.
  129. first_person = models.ForeignKey(Person, models.CASCADE, related_name="first")
  130. second_person = models.ForeignKey(Person, models.CASCADE, related_name="second")
  131. second_model = models.ForeignKey(Group, models.CASCADE)
  132. field = Group._meta.get_field('field')
  133. self.assertEqual(field.check(from_model=Group), [
  134. Error(
  135. "The model is used as an intermediate model by "
  136. "'invalid_models_tests.Group.field', but it has more than one "
  137. "foreign key to 'Person', which is ambiguous. You must specify "
  138. "which foreign key Django should use via the through_fields "
  139. "keyword argument.",
  140. hint=(
  141. 'If you want to create a recursive relationship, use '
  142. 'ManyToManyField("self", through="AmbiguousRelationship").'
  143. ),
  144. obj=field,
  145. id='fields.E335',
  146. ),
  147. ])
  148. def test_relationship_model_with_foreign_key_to_wrong_model(self):
  149. class WrongModel(models.Model):
  150. pass
  151. class Person(models.Model):
  152. pass
  153. class Group(models.Model):
  154. members = models.ManyToManyField('Person', through="InvalidRelationship")
  155. class InvalidRelationship(models.Model):
  156. person = models.ForeignKey(Person, models.CASCADE)
  157. wrong_foreign_key = models.ForeignKey(WrongModel, models.CASCADE)
  158. # The last foreign key should point to Group model.
  159. field = Group._meta.get_field('members')
  160. self.assertEqual(field.check(from_model=Group), [
  161. Error(
  162. "The model is used as an intermediate model by "
  163. "'invalid_models_tests.Group.members', but it does not "
  164. "have a foreign key to 'Group' or 'Person'.",
  165. obj=InvalidRelationship,
  166. id='fields.E336',
  167. ),
  168. ])
  169. def test_relationship_model_missing_foreign_key(self):
  170. class Person(models.Model):
  171. pass
  172. class Group(models.Model):
  173. members = models.ManyToManyField('Person', through="InvalidRelationship")
  174. class InvalidRelationship(models.Model):
  175. group = models.ForeignKey(Group, models.CASCADE)
  176. # No foreign key to Person
  177. field = Group._meta.get_field('members')
  178. self.assertEqual(field.check(from_model=Group), [
  179. Error(
  180. "The model is used as an intermediate model by "
  181. "'invalid_models_tests.Group.members', but it does not have "
  182. "a foreign key to 'Group' or 'Person'.",
  183. obj=InvalidRelationship,
  184. id='fields.E336',
  185. ),
  186. ])
  187. def test_missing_relationship_model(self):
  188. class Person(models.Model):
  189. pass
  190. class Group(models.Model):
  191. members = models.ManyToManyField('Person', through="MissingM2MModel")
  192. field = Group._meta.get_field('members')
  193. self.assertEqual(field.check(from_model=Group), [
  194. Error(
  195. "Field specifies a many-to-many relation through model "
  196. "'MissingM2MModel', which has not been installed.",
  197. obj=field,
  198. id='fields.E331',
  199. ),
  200. ])
  201. def test_missing_relationship_model_on_model_check(self):
  202. class Person(models.Model):
  203. pass
  204. class Group(models.Model):
  205. members = models.ManyToManyField('Person', through='MissingM2MModel')
  206. self.assertEqual(Group.check(), [
  207. Error(
  208. "Field specifies a many-to-many relation through model "
  209. "'MissingM2MModel', which has not been installed.",
  210. obj=Group._meta.get_field('members'),
  211. id='fields.E331',
  212. ),
  213. ])
  214. @isolate_apps('invalid_models_tests')
  215. def test_many_to_many_through_isolate_apps_model(self):
  216. """
  217. #25723 - Through model registration lookup should be run against the
  218. field's model registry.
  219. """
  220. class GroupMember(models.Model):
  221. person = models.ForeignKey('Person', models.CASCADE)
  222. group = models.ForeignKey('Group', models.CASCADE)
  223. class Person(models.Model):
  224. pass
  225. class Group(models.Model):
  226. members = models.ManyToManyField('Person', through='GroupMember')
  227. field = Group._meta.get_field('members')
  228. self.assertEqual(field.check(from_model=Group), [])
  229. def test_too_many_foreign_keys_in_self_referential_model(self):
  230. class Person(models.Model):
  231. friends = models.ManyToManyField('self', through="InvalidRelationship", symmetrical=False)
  232. class InvalidRelationship(models.Model):
  233. first = models.ForeignKey(Person, models.CASCADE, related_name="rel_from_set_2")
  234. second = models.ForeignKey(Person, models.CASCADE, related_name="rel_to_set_2")
  235. third = models.ForeignKey(Person, models.CASCADE, related_name="too_many_by_far")
  236. field = Person._meta.get_field('friends')
  237. self.assertEqual(field.check(from_model=Person), [
  238. Error(
  239. "The model is used as an intermediate model by "
  240. "'invalid_models_tests.Person.friends', but it has more than two "
  241. "foreign keys to 'Person', which is ambiguous. You must specify "
  242. "which two foreign keys Django should use via the through_fields "
  243. "keyword argument.",
  244. hint='Use through_fields to specify which two foreign keys Django should use.',
  245. obj=InvalidRelationship,
  246. id='fields.E333',
  247. ),
  248. ])
  249. def test_foreign_key_to_abstract_model(self):
  250. class AbstractModel(models.Model):
  251. class Meta:
  252. abstract = True
  253. class Model(models.Model):
  254. rel_string_foreign_key = models.ForeignKey('AbstractModel', models.CASCADE)
  255. rel_class_foreign_key = models.ForeignKey(AbstractModel, models.CASCADE)
  256. fields = [
  257. Model._meta.get_field('rel_string_foreign_key'),
  258. Model._meta.get_field('rel_class_foreign_key'),
  259. ]
  260. expected_error = Error(
  261. "Field defines a relation with model 'AbstractModel', "
  262. "which is either not installed, or is abstract.",
  263. id='fields.E300',
  264. )
  265. for field in fields:
  266. expected_error.obj = field
  267. self.assertEqual(field.check(), [expected_error])
  268. def test_m2m_to_abstract_model(self):
  269. class AbstractModel(models.Model):
  270. class Meta:
  271. abstract = True
  272. class Model(models.Model):
  273. rel_string_m2m = models.ManyToManyField('AbstractModel')
  274. rel_class_m2m = models.ManyToManyField(AbstractModel)
  275. fields = [
  276. Model._meta.get_field('rel_string_m2m'),
  277. Model._meta.get_field('rel_class_m2m'),
  278. ]
  279. expected_error = Error(
  280. "Field defines a relation with model 'AbstractModel', "
  281. "which is either not installed, or is abstract.",
  282. id='fields.E300',
  283. )
  284. for field in fields:
  285. expected_error.obj = field
  286. self.assertEqual(field.check(from_model=Model), [expected_error])
  287. def test_unique_m2m(self):
  288. class Person(models.Model):
  289. name = models.CharField(max_length=5)
  290. class Group(models.Model):
  291. members = models.ManyToManyField('Person', unique=True)
  292. field = Group._meta.get_field('members')
  293. self.assertEqual(field.check(from_model=Group), [
  294. Error(
  295. 'ManyToManyFields cannot be unique.',
  296. obj=field,
  297. id='fields.E330',
  298. ),
  299. ])
  300. def test_foreign_key_to_non_unique_field(self):
  301. class Target(models.Model):
  302. bad = models.IntegerField() # No unique=True
  303. class Model(models.Model):
  304. foreign_key = models.ForeignKey('Target', models.CASCADE, to_field='bad')
  305. field = Model._meta.get_field('foreign_key')
  306. self.assertEqual(field.check(), [
  307. Error(
  308. "'Target.bad' must be unique because it is referenced by a foreign key.",
  309. hint=(
  310. 'Add unique=True to this field or add a UniqueConstraint '
  311. '(without condition) in the model Meta.constraints.'
  312. ),
  313. obj=field,
  314. id='fields.E311',
  315. ),
  316. ])
  317. def test_foreign_key_to_non_unique_field_under_explicit_model(self):
  318. class Target(models.Model):
  319. bad = models.IntegerField()
  320. class Model(models.Model):
  321. field = models.ForeignKey(Target, models.CASCADE, to_field='bad')
  322. field = Model._meta.get_field('field')
  323. self.assertEqual(field.check(), [
  324. Error(
  325. "'Target.bad' must be unique because it is referenced by a foreign key.",
  326. hint=(
  327. 'Add unique=True to this field or add a UniqueConstraint '
  328. '(without condition) in the model Meta.constraints.'
  329. ),
  330. obj=field,
  331. id='fields.E311',
  332. ),
  333. ])
  334. def test_foreign_key_to_partially_unique_field(self):
  335. class Target(models.Model):
  336. source = models.IntegerField()
  337. class Meta:
  338. constraints = [
  339. models.UniqueConstraint(
  340. fields=['source'],
  341. name='tfktpuf_partial_unique',
  342. condition=models.Q(pk__gt=2),
  343. ),
  344. ]
  345. class Model(models.Model):
  346. field = models.ForeignKey(Target, models.CASCADE, to_field='source')
  347. field = Model._meta.get_field('field')
  348. self.assertEqual(field.check(), [
  349. Error(
  350. "'Target.source' must be unique because it is referenced by a "
  351. "foreign key.",
  352. hint=(
  353. 'Add unique=True to this field or add a UniqueConstraint '
  354. '(without condition) in the model Meta.constraints.'
  355. ),
  356. obj=field,
  357. id='fields.E311',
  358. ),
  359. ])
  360. def test_foreign_key_to_unique_field_with_meta_constraint(self):
  361. class Target(models.Model):
  362. source = models.IntegerField()
  363. class Meta:
  364. constraints = [
  365. models.UniqueConstraint(
  366. fields=['source'],
  367. name='tfktufwmc_unique',
  368. ),
  369. ]
  370. class Model(models.Model):
  371. field = models.ForeignKey(Target, models.CASCADE, to_field='source')
  372. field = Model._meta.get_field('field')
  373. self.assertEqual(field.check(), [])
  374. def test_foreign_object_to_non_unique_fields(self):
  375. class Person(models.Model):
  376. # Note that both fields are not unique.
  377. country_id = models.IntegerField()
  378. city_id = models.IntegerField()
  379. class MMembership(models.Model):
  380. person_country_id = models.IntegerField()
  381. person_city_id = models.IntegerField()
  382. person = models.ForeignObject(
  383. Person,
  384. on_delete=models.CASCADE,
  385. from_fields=['person_country_id', 'person_city_id'],
  386. to_fields=['country_id', 'city_id'],
  387. )
  388. field = MMembership._meta.get_field('person')
  389. self.assertEqual(field.check(), [
  390. Error(
  391. "No subset of the fields 'country_id', 'city_id' on model 'Person' is unique.",
  392. hint=(
  393. 'Mark a single field as unique=True or add a set of '
  394. 'fields to a unique constraint (via unique_together or a '
  395. 'UniqueConstraint (without condition) in the model '
  396. 'Meta.constraints).'
  397. ),
  398. obj=field,
  399. id='fields.E310',
  400. )
  401. ])
  402. def test_foreign_object_to_partially_unique_field(self):
  403. class Person(models.Model):
  404. country_id = models.IntegerField()
  405. city_id = models.IntegerField()
  406. class Meta:
  407. constraints = [
  408. models.UniqueConstraint(
  409. fields=['country_id', 'city_id'],
  410. name='tfotpuf_partial_unique',
  411. condition=models.Q(pk__gt=2),
  412. ),
  413. ]
  414. class MMembership(models.Model):
  415. person_country_id = models.IntegerField()
  416. person_city_id = models.IntegerField()
  417. person = models.ForeignObject(
  418. Person,
  419. on_delete=models.CASCADE,
  420. from_fields=['person_country_id', 'person_city_id'],
  421. to_fields=['country_id', 'city_id'],
  422. )
  423. field = MMembership._meta.get_field('person')
  424. self.assertEqual(field.check(), [
  425. Error(
  426. "No subset of the fields 'country_id', 'city_id' on model "
  427. "'Person' is unique.",
  428. hint=(
  429. 'Mark a single field as unique=True or add a set of '
  430. 'fields to a unique constraint (via unique_together or a '
  431. 'UniqueConstraint (without condition) in the model '
  432. 'Meta.constraints).'
  433. ),
  434. obj=field,
  435. id='fields.E310',
  436. ),
  437. ])
  438. def test_foreign_object_to_unique_field_with_meta_constraint(self):
  439. class Person(models.Model):
  440. country_id = models.IntegerField()
  441. city_id = models.IntegerField()
  442. class Meta:
  443. constraints = [
  444. models.UniqueConstraint(
  445. fields=['country_id', 'city_id'],
  446. name='tfotpuf_unique',
  447. ),
  448. ]
  449. class MMembership(models.Model):
  450. person_country_id = models.IntegerField()
  451. person_city_id = models.IntegerField()
  452. person = models.ForeignObject(
  453. Person,
  454. on_delete=models.CASCADE,
  455. from_fields=['person_country_id', 'person_city_id'],
  456. to_fields=['country_id', 'city_id'],
  457. )
  458. field = MMembership._meta.get_field('person')
  459. self.assertEqual(field.check(), [])
  460. def test_on_delete_set_null_on_non_nullable_field(self):
  461. class Person(models.Model):
  462. pass
  463. class Model(models.Model):
  464. foreign_key = models.ForeignKey('Person', models.SET_NULL)
  465. field = Model._meta.get_field('foreign_key')
  466. self.assertEqual(field.check(), [
  467. Error(
  468. 'Field specifies on_delete=SET_NULL, but cannot be null.',
  469. hint='Set null=True argument on the field, or change the on_delete rule.',
  470. obj=field,
  471. id='fields.E320',
  472. ),
  473. ])
  474. def test_on_delete_set_default_without_default_value(self):
  475. class Person(models.Model):
  476. pass
  477. class Model(models.Model):
  478. foreign_key = models.ForeignKey('Person', models.SET_DEFAULT)
  479. field = Model._meta.get_field('foreign_key')
  480. self.assertEqual(field.check(), [
  481. Error(
  482. 'Field specifies on_delete=SET_DEFAULT, but has no default value.',
  483. hint='Set a default value, or change the on_delete rule.',
  484. obj=field,
  485. id='fields.E321',
  486. ),
  487. ])
  488. def test_nullable_primary_key(self):
  489. class Model(models.Model):
  490. field = models.IntegerField(primary_key=True, null=True)
  491. field = Model._meta.get_field('field')
  492. with mock.patch.object(connection.features, 'interprets_empty_strings_as_nulls', False):
  493. results = field.check()
  494. self.assertEqual(results, [
  495. Error(
  496. 'Primary keys must not have null=True.',
  497. hint='Set null=False on the field, or remove primary_key=True argument.',
  498. obj=field,
  499. id='fields.E007',
  500. ),
  501. ])
  502. def test_not_swapped_model(self):
  503. class SwappableModel(models.Model):
  504. # A model that can be, but isn't swapped out. References to this
  505. # model should *not* raise any validation error.
  506. class Meta:
  507. swappable = 'TEST_SWAPPABLE_MODEL'
  508. class Model(models.Model):
  509. explicit_fk = models.ForeignKey(
  510. SwappableModel,
  511. models.CASCADE,
  512. related_name='explicit_fk',
  513. )
  514. implicit_fk = models.ForeignKey(
  515. 'invalid_models_tests.SwappableModel',
  516. models.CASCADE,
  517. related_name='implicit_fk',
  518. )
  519. explicit_m2m = models.ManyToManyField(SwappableModel, related_name='explicit_m2m')
  520. implicit_m2m = models.ManyToManyField(
  521. 'invalid_models_tests.SwappableModel',
  522. related_name='implicit_m2m',
  523. )
  524. explicit_fk = Model._meta.get_field('explicit_fk')
  525. self.assertEqual(explicit_fk.check(), [])
  526. implicit_fk = Model._meta.get_field('implicit_fk')
  527. self.assertEqual(implicit_fk.check(), [])
  528. explicit_m2m = Model._meta.get_field('explicit_m2m')
  529. self.assertEqual(explicit_m2m.check(from_model=Model), [])
  530. implicit_m2m = Model._meta.get_field('implicit_m2m')
  531. self.assertEqual(implicit_m2m.check(from_model=Model), [])
  532. @override_settings(TEST_SWAPPED_MODEL='invalid_models_tests.Replacement')
  533. def test_referencing_to_swapped_model(self):
  534. class Replacement(models.Model):
  535. pass
  536. class SwappedModel(models.Model):
  537. class Meta:
  538. swappable = 'TEST_SWAPPED_MODEL'
  539. class Model(models.Model):
  540. explicit_fk = models.ForeignKey(
  541. SwappedModel,
  542. models.CASCADE,
  543. related_name='explicit_fk',
  544. )
  545. implicit_fk = models.ForeignKey(
  546. 'invalid_models_tests.SwappedModel',
  547. models.CASCADE,
  548. related_name='implicit_fk',
  549. )
  550. explicit_m2m = models.ManyToManyField(SwappedModel, related_name='explicit_m2m')
  551. implicit_m2m = models.ManyToManyField(
  552. 'invalid_models_tests.SwappedModel',
  553. related_name='implicit_m2m',
  554. )
  555. fields = [
  556. Model._meta.get_field('explicit_fk'),
  557. Model._meta.get_field('implicit_fk'),
  558. Model._meta.get_field('explicit_m2m'),
  559. Model._meta.get_field('implicit_m2m'),
  560. ]
  561. expected_error = Error(
  562. ("Field defines a relation with the model "
  563. "'invalid_models_tests.SwappedModel', which has been swapped out."),
  564. hint="Update the relation to point at 'settings.TEST_SWAPPED_MODEL'.",
  565. id='fields.E301',
  566. )
  567. for field in fields:
  568. expected_error.obj = field
  569. self.assertEqual(field.check(from_model=Model), [expected_error])
  570. def test_related_field_has_invalid_related_name(self):
  571. digit = 0
  572. illegal_non_alphanumeric = '!'
  573. whitespace = '\t'
  574. invalid_related_names = [
  575. '%s_begins_with_digit' % digit,
  576. '%s_begins_with_illegal_non_alphanumeric' % illegal_non_alphanumeric,
  577. '%s_begins_with_whitespace' % whitespace,
  578. 'contains_%s_illegal_non_alphanumeric' % illegal_non_alphanumeric,
  579. 'contains_%s_whitespace' % whitespace,
  580. 'ends_with_with_illegal_non_alphanumeric_%s' % illegal_non_alphanumeric,
  581. 'ends_with_whitespace_%s' % whitespace,
  582. 'with', # a Python keyword
  583. 'related_name\n',
  584. '',
  585. ',', # non-ASCII
  586. ]
  587. class Parent(models.Model):
  588. pass
  589. for invalid_related_name in invalid_related_names:
  590. Child = type('Child%s' % invalid_related_name, (models.Model,), {
  591. 'parent': models.ForeignKey('Parent', models.CASCADE, related_name=invalid_related_name),
  592. '__module__': Parent.__module__,
  593. })
  594. field = Child._meta.get_field('parent')
  595. self.assertEqual(Child.check(), [
  596. Error(
  597. "The name '%s' is invalid related_name for field Child%s.parent"
  598. % (invalid_related_name, invalid_related_name),
  599. hint="Related name must be a valid Python identifier or end with a '+'",
  600. obj=field,
  601. id='fields.E306',
  602. ),
  603. ])
  604. def test_related_field_has_valid_related_name(self):
  605. lowercase = 'a'
  606. uppercase = 'A'
  607. digit = 0
  608. related_names = [
  609. '%s_starts_with_lowercase' % lowercase,
  610. '%s_tarts_with_uppercase' % uppercase,
  611. '_starts_with_underscore',
  612. 'contains_%s_digit' % digit,
  613. 'ends_with_plus+',
  614. '_+',
  615. '+',
  616. '試',
  617. '試驗+',
  618. ]
  619. class Parent(models.Model):
  620. pass
  621. for related_name in related_names:
  622. Child = type('Child%s' % related_name, (models.Model,), {
  623. 'parent': models.ForeignKey('Parent', models.CASCADE, related_name=related_name),
  624. '__module__': Parent.__module__,
  625. })
  626. self.assertEqual(Child.check(), [])
  627. def test_to_fields_exist(self):
  628. class Parent(models.Model):
  629. pass
  630. class Child(models.Model):
  631. a = models.PositiveIntegerField()
  632. b = models.PositiveIntegerField()
  633. parent = models.ForeignObject(
  634. Parent,
  635. on_delete=models.SET_NULL,
  636. from_fields=('a', 'b'),
  637. to_fields=('a', 'b'),
  638. )
  639. field = Child._meta.get_field('parent')
  640. self.assertEqual(field.check(), [
  641. Error(
  642. "The to_field 'a' doesn't exist on the related model 'invalid_models_tests.Parent'.",
  643. obj=field,
  644. id='fields.E312',
  645. ),
  646. Error(
  647. "The to_field 'b' doesn't exist on the related model 'invalid_models_tests.Parent'.",
  648. obj=field,
  649. id='fields.E312',
  650. ),
  651. ])
  652. def test_to_fields_not_checked_if_related_model_doesnt_exist(self):
  653. class Child(models.Model):
  654. a = models.PositiveIntegerField()
  655. b = models.PositiveIntegerField()
  656. parent = models.ForeignObject(
  657. 'invalid_models_tests.Parent',
  658. on_delete=models.SET_NULL,
  659. from_fields=('a', 'b'),
  660. to_fields=('a', 'b'),
  661. )
  662. field = Child._meta.get_field('parent')
  663. self.assertEqual(field.check(), [
  664. Error(
  665. "Field defines a relation with model 'invalid_models_tests.Parent', "
  666. "which is either not installed, or is abstract.",
  667. id='fields.E300',
  668. obj=field,
  669. ),
  670. ])
  671. def test_invalid_related_query_name(self):
  672. class Target(models.Model):
  673. pass
  674. class Model(models.Model):
  675. first = models.ForeignKey(Target, models.CASCADE, related_name='contains__double')
  676. second = models.ForeignKey(Target, models.CASCADE, related_query_name='ends_underscore_')
  677. self.assertEqual(Model.check(), [
  678. Error(
  679. "Reverse query name 'contains__double' must not contain '__'.",
  680. hint=("Add or change a related_name or related_query_name "
  681. "argument for this field."),
  682. obj=Model._meta.get_field('first'),
  683. id='fields.E309',
  684. ),
  685. Error(
  686. "Reverse query name 'ends_underscore_' must not end with an "
  687. "underscore.",
  688. hint=("Add or change a related_name or related_query_name "
  689. "argument for this field."),
  690. obj=Model._meta.get_field('second'),
  691. id='fields.E308',
  692. ),
  693. ])
  694. @isolate_apps('invalid_models_tests')
  695. class AccessorClashTests(SimpleTestCase):
  696. def test_fk_to_integer(self):
  697. self._test_accessor_clash(
  698. target=models.IntegerField(),
  699. relative=models.ForeignKey('Target', models.CASCADE))
  700. def test_fk_to_fk(self):
  701. self._test_accessor_clash(
  702. target=models.ForeignKey('Another', models.CASCADE),
  703. relative=models.ForeignKey('Target', models.CASCADE))
  704. def test_fk_to_m2m(self):
  705. self._test_accessor_clash(
  706. target=models.ManyToManyField('Another'),
  707. relative=models.ForeignKey('Target', models.CASCADE))
  708. def test_m2m_to_integer(self):
  709. self._test_accessor_clash(
  710. target=models.IntegerField(),
  711. relative=models.ManyToManyField('Target'))
  712. def test_m2m_to_fk(self):
  713. self._test_accessor_clash(
  714. target=models.ForeignKey('Another', models.CASCADE),
  715. relative=models.ManyToManyField('Target'))
  716. def test_m2m_to_m2m(self):
  717. self._test_accessor_clash(
  718. target=models.ManyToManyField('Another'),
  719. relative=models.ManyToManyField('Target'))
  720. def _test_accessor_clash(self, target, relative):
  721. class Another(models.Model):
  722. pass
  723. class Target(models.Model):
  724. model_set = target
  725. class Model(models.Model):
  726. rel = relative
  727. self.assertEqual(Model.check(), [
  728. Error(
  729. "Reverse accessor for 'invalid_models_tests.Model.rel' "
  730. "clashes with field name "
  731. "'invalid_models_tests.Target.model_set'.",
  732. hint=(
  733. "Rename field 'invalid_models_tests.Target.model_set', or "
  734. "add/change a related_name argument to the definition for "
  735. "field 'invalid_models_tests.Model.rel'."
  736. ),
  737. obj=Model._meta.get_field('rel'),
  738. id='fields.E302',
  739. ),
  740. ])
  741. def test_clash_between_accessors(self):
  742. class Target(models.Model):
  743. pass
  744. class Model(models.Model):
  745. foreign = models.ForeignKey(Target, models.CASCADE)
  746. m2m = models.ManyToManyField(Target)
  747. self.assertEqual(Model.check(), [
  748. Error(
  749. "Reverse accessor for 'invalid_models_tests.Model.foreign' "
  750. "clashes with reverse accessor for "
  751. "'invalid_models_tests.Model.m2m'.",
  752. hint=(
  753. "Add or change a related_name argument to the definition "
  754. "for 'invalid_models_tests.Model.foreign' or "
  755. "'invalid_models_tests.Model.m2m'."
  756. ),
  757. obj=Model._meta.get_field('foreign'),
  758. id='fields.E304',
  759. ),
  760. Error(
  761. "Reverse accessor for 'invalid_models_tests.Model.m2m' "
  762. "clashes with reverse accessor for "
  763. "'invalid_models_tests.Model.foreign'.",
  764. hint=(
  765. "Add or change a related_name argument to the definition "
  766. "for 'invalid_models_tests.Model.m2m' or "
  767. "'invalid_models_tests.Model.foreign'."
  768. ),
  769. obj=Model._meta.get_field('m2m'),
  770. id='fields.E304',
  771. ),
  772. ])
  773. def test_m2m_to_m2m_with_inheritance(self):
  774. """ Ref #22047. """
  775. class Target(models.Model):
  776. pass
  777. class Model(models.Model):
  778. children = models.ManyToManyField('Child', related_name="m2m_clash", related_query_name="no_clash")
  779. class Parent(models.Model):
  780. m2m_clash = models.ManyToManyField('Target')
  781. class Child(Parent):
  782. pass
  783. self.assertEqual(Model.check(), [
  784. Error(
  785. "Reverse accessor for 'invalid_models_tests.Model.children' "
  786. "clashes with field name "
  787. "'invalid_models_tests.Child.m2m_clash'.",
  788. hint=(
  789. "Rename field 'invalid_models_tests.Child.m2m_clash', or "
  790. "add/change a related_name argument to the definition for "
  791. "field 'invalid_models_tests.Model.children'."
  792. ),
  793. obj=Model._meta.get_field('children'),
  794. id='fields.E302',
  795. )
  796. ])
  797. def test_no_clash_for_hidden_related_name(self):
  798. class Stub(models.Model):
  799. pass
  800. class ManyToManyRel(models.Model):
  801. thing1 = models.ManyToManyField(Stub, related_name='+')
  802. thing2 = models.ManyToManyField(Stub, related_name='+')
  803. class FKRel(models.Model):
  804. thing1 = models.ForeignKey(Stub, models.CASCADE, related_name='+')
  805. thing2 = models.ForeignKey(Stub, models.CASCADE, related_name='+')
  806. self.assertEqual(ManyToManyRel.check(), [])
  807. self.assertEqual(FKRel.check(), [])
  808. @isolate_apps('invalid_models_tests')
  809. class ReverseQueryNameClashTests(SimpleTestCase):
  810. def test_fk_to_integer(self):
  811. self._test_reverse_query_name_clash(
  812. target=models.IntegerField(),
  813. relative=models.ForeignKey('Target', models.CASCADE))
  814. def test_fk_to_fk(self):
  815. self._test_reverse_query_name_clash(
  816. target=models.ForeignKey('Another', models.CASCADE),
  817. relative=models.ForeignKey('Target', models.CASCADE))
  818. def test_fk_to_m2m(self):
  819. self._test_reverse_query_name_clash(
  820. target=models.ManyToManyField('Another'),
  821. relative=models.ForeignKey('Target', models.CASCADE))
  822. def test_m2m_to_integer(self):
  823. self._test_reverse_query_name_clash(
  824. target=models.IntegerField(),
  825. relative=models.ManyToManyField('Target'))
  826. def test_m2m_to_fk(self):
  827. self._test_reverse_query_name_clash(
  828. target=models.ForeignKey('Another', models.CASCADE),
  829. relative=models.ManyToManyField('Target'))
  830. def test_m2m_to_m2m(self):
  831. self._test_reverse_query_name_clash(
  832. target=models.ManyToManyField('Another'),
  833. relative=models.ManyToManyField('Target'))
  834. def _test_reverse_query_name_clash(self, target, relative):
  835. class Another(models.Model):
  836. pass
  837. class Target(models.Model):
  838. model = target
  839. class Model(models.Model):
  840. rel = relative
  841. self.assertEqual(Model.check(), [
  842. Error(
  843. "Reverse query name for 'invalid_models_tests.Model.rel' "
  844. "clashes with field name 'invalid_models_tests.Target.model'.",
  845. hint=(
  846. "Rename field 'invalid_models_tests.Target.model', or "
  847. "add/change a related_name argument to the definition for "
  848. "field 'invalid_models_tests.Model.rel'."
  849. ),
  850. obj=Model._meta.get_field('rel'),
  851. id='fields.E303',
  852. ),
  853. ])
  854. @modify_settings(INSTALLED_APPS={'append': 'basic'})
  855. @isolate_apps('basic', 'invalid_models_tests')
  856. def test_no_clash_across_apps_without_accessor(self):
  857. class Target(models.Model):
  858. class Meta:
  859. app_label = 'invalid_models_tests'
  860. class Model(models.Model):
  861. m2m = models.ManyToManyField(Target, related_name='+')
  862. class Meta:
  863. app_label = 'basic'
  864. def _test():
  865. # Define model with the same name.
  866. class Model(models.Model):
  867. m2m = models.ManyToManyField(Target, related_name='+')
  868. class Meta:
  869. app_label = 'invalid_models_tests'
  870. self.assertEqual(Model.check(), [])
  871. _test()
  872. self.assertEqual(Model.check(), [])
  873. @isolate_apps('invalid_models_tests')
  874. class ExplicitRelatedNameClashTests(SimpleTestCase):
  875. def test_fk_to_integer(self):
  876. self._test_explicit_related_name_clash(
  877. target=models.IntegerField(),
  878. relative=models.ForeignKey('Target', models.CASCADE, related_name='clash'))
  879. def test_fk_to_fk(self):
  880. self._test_explicit_related_name_clash(
  881. target=models.ForeignKey('Another', models.CASCADE),
  882. relative=models.ForeignKey('Target', models.CASCADE, related_name='clash'))
  883. def test_fk_to_m2m(self):
  884. self._test_explicit_related_name_clash(
  885. target=models.ManyToManyField('Another'),
  886. relative=models.ForeignKey('Target', models.CASCADE, related_name='clash'))
  887. def test_m2m_to_integer(self):
  888. self._test_explicit_related_name_clash(
  889. target=models.IntegerField(),
  890. relative=models.ManyToManyField('Target', related_name='clash'))
  891. def test_m2m_to_fk(self):
  892. self._test_explicit_related_name_clash(
  893. target=models.ForeignKey('Another', models.CASCADE),
  894. relative=models.ManyToManyField('Target', related_name='clash'))
  895. def test_m2m_to_m2m(self):
  896. self._test_explicit_related_name_clash(
  897. target=models.ManyToManyField('Another'),
  898. relative=models.ManyToManyField('Target', related_name='clash'))
  899. def _test_explicit_related_name_clash(self, target, relative):
  900. class Another(models.Model):
  901. pass
  902. class Target(models.Model):
  903. clash = target
  904. class Model(models.Model):
  905. rel = relative
  906. self.assertEqual(Model.check(), [
  907. Error(
  908. "Reverse accessor for 'invalid_models_tests.Model.rel' "
  909. "clashes with field name 'invalid_models_tests.Target.clash'.",
  910. hint=(
  911. "Rename field 'invalid_models_tests.Target.clash', or "
  912. "add/change a related_name argument to the definition for "
  913. "field 'invalid_models_tests.Model.rel'."
  914. ),
  915. obj=Model._meta.get_field('rel'),
  916. id='fields.E302',
  917. ),
  918. Error(
  919. "Reverse query name for 'invalid_models_tests.Model.rel' "
  920. "clashes with field name 'invalid_models_tests.Target.clash'.",
  921. hint=(
  922. "Rename field 'invalid_models_tests.Target.clash', or "
  923. "add/change a related_name argument to the definition for "
  924. "field 'invalid_models_tests.Model.rel'."
  925. ),
  926. obj=Model._meta.get_field('rel'),
  927. id='fields.E303',
  928. ),
  929. ])
  930. @isolate_apps('invalid_models_tests')
  931. class ExplicitRelatedQueryNameClashTests(SimpleTestCase):
  932. def test_fk_to_integer(self, related_name=None):
  933. self._test_explicit_related_query_name_clash(
  934. target=models.IntegerField(),
  935. relative=models.ForeignKey(
  936. 'Target',
  937. models.CASCADE,
  938. related_name=related_name,
  939. related_query_name='clash',
  940. )
  941. )
  942. def test_hidden_fk_to_integer(self, related_name=None):
  943. self.test_fk_to_integer(related_name='+')
  944. def test_fk_to_fk(self, related_name=None):
  945. self._test_explicit_related_query_name_clash(
  946. target=models.ForeignKey('Another', models.CASCADE),
  947. relative=models.ForeignKey(
  948. 'Target',
  949. models.CASCADE,
  950. related_name=related_name,
  951. related_query_name='clash',
  952. )
  953. )
  954. def test_hidden_fk_to_fk(self):
  955. self.test_fk_to_fk(related_name='+')
  956. def test_fk_to_m2m(self, related_name=None):
  957. self._test_explicit_related_query_name_clash(
  958. target=models.ManyToManyField('Another'),
  959. relative=models.ForeignKey(
  960. 'Target',
  961. models.CASCADE,
  962. related_name=related_name,
  963. related_query_name='clash',
  964. )
  965. )
  966. def test_hidden_fk_to_m2m(self):
  967. self.test_fk_to_m2m(related_name='+')
  968. def test_m2m_to_integer(self, related_name=None):
  969. self._test_explicit_related_query_name_clash(
  970. target=models.IntegerField(),
  971. relative=models.ManyToManyField('Target', related_name=related_name, related_query_name='clash'))
  972. def test_hidden_m2m_to_integer(self):
  973. self.test_m2m_to_integer(related_name='+')
  974. def test_m2m_to_fk(self, related_name=None):
  975. self._test_explicit_related_query_name_clash(
  976. target=models.ForeignKey('Another', models.CASCADE),
  977. relative=models.ManyToManyField('Target', related_name=related_name, related_query_name='clash'))
  978. def test_hidden_m2m_to_fk(self):
  979. self.test_m2m_to_fk(related_name='+')
  980. def test_m2m_to_m2m(self, related_name=None):
  981. self._test_explicit_related_query_name_clash(
  982. target=models.ManyToManyField('Another'),
  983. relative=models.ManyToManyField(
  984. 'Target',
  985. related_name=related_name,
  986. related_query_name='clash',
  987. )
  988. )
  989. def test_hidden_m2m_to_m2m(self):
  990. self.test_m2m_to_m2m(related_name='+')
  991. def _test_explicit_related_query_name_clash(self, target, relative):
  992. class Another(models.Model):
  993. pass
  994. class Target(models.Model):
  995. clash = target
  996. class Model(models.Model):
  997. rel = relative
  998. self.assertEqual(Model.check(), [
  999. Error(
  1000. "Reverse query name for 'invalid_models_tests.Model.rel' "
  1001. "clashes with field name 'invalid_models_tests.Target.clash'.",
  1002. hint=(
  1003. "Rename field 'invalid_models_tests.Target.clash', or "
  1004. "add/change a related_name argument to the definition for "
  1005. "field 'invalid_models_tests.Model.rel'."
  1006. ),
  1007. obj=Model._meta.get_field('rel'),
  1008. id='fields.E303',
  1009. ),
  1010. ])
  1011. @isolate_apps('invalid_models_tests')
  1012. class SelfReferentialM2MClashTests(SimpleTestCase):
  1013. def test_clash_between_accessors(self):
  1014. class Model(models.Model):
  1015. first_m2m = models.ManyToManyField('self', symmetrical=False)
  1016. second_m2m = models.ManyToManyField('self', symmetrical=False)
  1017. self.assertEqual(Model.check(), [
  1018. Error(
  1019. "Reverse accessor for 'invalid_models_tests.Model.first_m2m' "
  1020. "clashes with reverse accessor for "
  1021. "'invalid_models_tests.Model.second_m2m'.",
  1022. hint=(
  1023. "Add or change a related_name argument to the definition "
  1024. "for 'invalid_models_tests.Model.first_m2m' or "
  1025. "'invalid_models_tests.Model.second_m2m'."
  1026. ),
  1027. obj=Model._meta.get_field('first_m2m'),
  1028. id='fields.E304',
  1029. ),
  1030. Error(
  1031. "Reverse accessor for 'invalid_models_tests.Model.second_m2m' "
  1032. "clashes with reverse accessor for "
  1033. "'invalid_models_tests.Model.first_m2m'.",
  1034. hint=(
  1035. "Add or change a related_name argument to the definition "
  1036. "for 'invalid_models_tests.Model.second_m2m' or "
  1037. "'invalid_models_tests.Model.first_m2m'."
  1038. ),
  1039. obj=Model._meta.get_field('second_m2m'),
  1040. id='fields.E304',
  1041. ),
  1042. ])
  1043. def test_accessor_clash(self):
  1044. class Model(models.Model):
  1045. model_set = models.ManyToManyField("self", symmetrical=False)
  1046. self.assertEqual(Model.check(), [
  1047. Error(
  1048. "Reverse accessor for 'invalid_models_tests.Model.model_set' "
  1049. "clashes with field name "
  1050. "'invalid_models_tests.Model.model_set'.",
  1051. hint=(
  1052. "Rename field 'invalid_models_tests.Model.model_set', or "
  1053. "add/change a related_name argument to the definition for "
  1054. "field 'invalid_models_tests.Model.model_set'."
  1055. ),
  1056. obj=Model._meta.get_field('model_set'),
  1057. id='fields.E302',
  1058. ),
  1059. ])
  1060. def test_reverse_query_name_clash(self):
  1061. class Model(models.Model):
  1062. model = models.ManyToManyField("self", symmetrical=False)
  1063. self.assertEqual(Model.check(), [
  1064. Error(
  1065. "Reverse query name for 'invalid_models_tests.Model.model' "
  1066. "clashes with field name 'invalid_models_tests.Model.model'.",
  1067. hint=(
  1068. "Rename field 'invalid_models_tests.Model.model', or "
  1069. "add/change a related_name argument to the definition for "
  1070. "field 'invalid_models_tests.Model.model'."
  1071. ),
  1072. obj=Model._meta.get_field('model'),
  1073. id='fields.E303',
  1074. ),
  1075. ])
  1076. def test_clash_under_explicit_related_name(self):
  1077. class Model(models.Model):
  1078. clash = models.IntegerField()
  1079. m2m = models.ManyToManyField("self", symmetrical=False, related_name='clash')
  1080. self.assertEqual(Model.check(), [
  1081. Error(
  1082. "Reverse accessor for 'invalid_models_tests.Model.m2m' "
  1083. "clashes with field name 'invalid_models_tests.Model.clash'.",
  1084. hint=(
  1085. "Rename field 'invalid_models_tests.Model.clash', or "
  1086. "add/change a related_name argument to the definition for "
  1087. "field 'invalid_models_tests.Model.m2m'."
  1088. ),
  1089. obj=Model._meta.get_field('m2m'),
  1090. id='fields.E302',
  1091. ),
  1092. Error(
  1093. "Reverse query name for 'invalid_models_tests.Model.m2m' "
  1094. "clashes with field name 'invalid_models_tests.Model.clash'.",
  1095. hint=(
  1096. "Rename field 'invalid_models_tests.Model.clash', or "
  1097. "add/change a related_name argument to the definition for "
  1098. "field 'invalid_models_tests.Model.m2m'."
  1099. ),
  1100. obj=Model._meta.get_field('m2m'),
  1101. id='fields.E303',
  1102. ),
  1103. ])
  1104. def test_valid_model(self):
  1105. class Model(models.Model):
  1106. first = models.ManyToManyField("self", symmetrical=False, related_name='first_accessor')
  1107. second = models.ManyToManyField("self", symmetrical=False, related_name='second_accessor')
  1108. self.assertEqual(Model.check(), [])
  1109. @isolate_apps('invalid_models_tests')
  1110. class SelfReferentialFKClashTests(SimpleTestCase):
  1111. def test_accessor_clash(self):
  1112. class Model(models.Model):
  1113. model_set = models.ForeignKey("Model", models.CASCADE)
  1114. self.assertEqual(Model.check(), [
  1115. Error(
  1116. "Reverse accessor for 'invalid_models_tests.Model.model_set' "
  1117. "clashes with field name "
  1118. "'invalid_models_tests.Model.model_set'.",
  1119. hint=(
  1120. "Rename field 'invalid_models_tests.Model.model_set', or "
  1121. "add/change a related_name argument to the definition for "
  1122. "field 'invalid_models_tests.Model.model_set'."
  1123. ),
  1124. obj=Model._meta.get_field('model_set'),
  1125. id='fields.E302',
  1126. ),
  1127. ])
  1128. def test_reverse_query_name_clash(self):
  1129. class Model(models.Model):
  1130. model = models.ForeignKey("Model", models.CASCADE)
  1131. self.assertEqual(Model.check(), [
  1132. Error(
  1133. "Reverse query name for 'invalid_models_tests.Model.model' "
  1134. "clashes with field name 'invalid_models_tests.Model.model'.",
  1135. hint=(
  1136. "Rename field 'invalid_models_tests.Model.model', or "
  1137. "add/change a related_name argument to the definition for "
  1138. "field 'invalid_models_tests.Model.model'."
  1139. ),
  1140. obj=Model._meta.get_field('model'),
  1141. id='fields.E303',
  1142. ),
  1143. ])
  1144. def test_clash_under_explicit_related_name(self):
  1145. class Model(models.Model):
  1146. clash = models.CharField(max_length=10)
  1147. foreign = models.ForeignKey("Model", models.CASCADE, related_name='clash')
  1148. self.assertEqual(Model.check(), [
  1149. Error(
  1150. "Reverse accessor for 'invalid_models_tests.Model.foreign' "
  1151. "clashes with field name 'invalid_models_tests.Model.clash'.",
  1152. hint=(
  1153. "Rename field 'invalid_models_tests.Model.clash', or "
  1154. "add/change a related_name argument to the definition for "
  1155. "field 'invalid_models_tests.Model.foreign'."
  1156. ),
  1157. obj=Model._meta.get_field('foreign'),
  1158. id='fields.E302',
  1159. ),
  1160. Error(
  1161. "Reverse query name for 'invalid_models_tests.Model.foreign' "
  1162. "clashes with field name 'invalid_models_tests.Model.clash'.",
  1163. hint=(
  1164. "Rename field 'invalid_models_tests.Model.clash', or "
  1165. "add/change a related_name argument to the definition for "
  1166. "field 'invalid_models_tests.Model.foreign'."
  1167. ),
  1168. obj=Model._meta.get_field('foreign'),
  1169. id='fields.E303',
  1170. ),
  1171. ])
  1172. @isolate_apps('invalid_models_tests')
  1173. class ComplexClashTests(SimpleTestCase):
  1174. # New tests should not be included here, because this is a single,
  1175. # self-contained sanity check, not a test of everything.
  1176. def test_complex_clash(self):
  1177. class Target(models.Model):
  1178. tgt_safe = models.CharField(max_length=10)
  1179. clash = models.CharField(max_length=10)
  1180. model = models.CharField(max_length=10)
  1181. clash1_set = models.CharField(max_length=10)
  1182. class Model(models.Model):
  1183. src_safe = models.CharField(max_length=10)
  1184. foreign_1 = models.ForeignKey(Target, models.CASCADE, related_name='id')
  1185. foreign_2 = models.ForeignKey(Target, models.CASCADE, related_name='src_safe')
  1186. m2m_1 = models.ManyToManyField(Target, related_name='id')
  1187. m2m_2 = models.ManyToManyField(Target, related_name='src_safe')
  1188. self.assertEqual(Model.check(), [
  1189. Error(
  1190. "Reverse accessor for 'invalid_models_tests.Model.foreign_1' "
  1191. "clashes with field name 'invalid_models_tests.Target.id'.",
  1192. hint=(
  1193. "Rename field 'invalid_models_tests.Target.id', or "
  1194. "add/change a related_name argument to the definition for "
  1195. "field 'invalid_models_tests.Model.foreign_1'."
  1196. ),
  1197. obj=Model._meta.get_field('foreign_1'),
  1198. id='fields.E302',
  1199. ),
  1200. Error(
  1201. "Reverse query name for 'invalid_models_tests.Model.foreign_1' "
  1202. "clashes with field name 'invalid_models_tests.Target.id'.",
  1203. hint=(
  1204. "Rename field 'invalid_models_tests.Target.id', or "
  1205. "add/change a related_name argument to the definition for "
  1206. "field 'invalid_models_tests.Model.foreign_1'."
  1207. ),
  1208. obj=Model._meta.get_field('foreign_1'),
  1209. id='fields.E303',
  1210. ),
  1211. Error(
  1212. "Reverse accessor for 'invalid_models_tests.Model.foreign_1' "
  1213. "clashes with reverse accessor for "
  1214. "'invalid_models_tests.Model.m2m_1'.",
  1215. hint=(
  1216. "Add or change a related_name argument to the definition "
  1217. "for 'invalid_models_tests.Model.foreign_1' or "
  1218. "'invalid_models_tests.Model.m2m_1'."
  1219. ),
  1220. obj=Model._meta.get_field('foreign_1'),
  1221. id='fields.E304',
  1222. ),
  1223. Error(
  1224. "Reverse query name for 'invalid_models_tests.Model.foreign_1' "
  1225. "clashes with reverse query name for "
  1226. "'invalid_models_tests.Model.m2m_1'.",
  1227. hint=(
  1228. "Add or change a related_name argument to the definition "
  1229. "for 'invalid_models_tests.Model.foreign_1' or "
  1230. "'invalid_models_tests.Model.m2m_1'."
  1231. ),
  1232. obj=Model._meta.get_field('foreign_1'),
  1233. id='fields.E305',
  1234. ),
  1235. Error(
  1236. "Reverse accessor for 'invalid_models_tests.Model.foreign_2' "
  1237. "clashes with reverse accessor for "
  1238. "'invalid_models_tests.Model.m2m_2'.",
  1239. hint=(
  1240. "Add or change a related_name argument to the definition "
  1241. "for 'invalid_models_tests.Model.foreign_2' or "
  1242. "'invalid_models_tests.Model.m2m_2'."
  1243. ),
  1244. obj=Model._meta.get_field('foreign_2'),
  1245. id='fields.E304',
  1246. ),
  1247. Error(
  1248. "Reverse query name for 'invalid_models_tests.Model.foreign_2' "
  1249. "clashes with reverse query name for "
  1250. "'invalid_models_tests.Model.m2m_2'.",
  1251. hint=(
  1252. "Add or change a related_name argument to the definition "
  1253. "for 'invalid_models_tests.Model.foreign_2' or "
  1254. "'invalid_models_tests.Model.m2m_2'."
  1255. ),
  1256. obj=Model._meta.get_field('foreign_2'),
  1257. id='fields.E305',
  1258. ),
  1259. Error(
  1260. "Reverse accessor for 'invalid_models_tests.Model.m2m_1' "
  1261. "clashes with field name 'invalid_models_tests.Target.id'.",
  1262. hint=(
  1263. "Rename field 'invalid_models_tests.Target.id', or "
  1264. "add/change a related_name argument to the definition for "
  1265. "field 'invalid_models_tests.Model.m2m_1'."
  1266. ),
  1267. obj=Model._meta.get_field('m2m_1'),
  1268. id='fields.E302',
  1269. ),
  1270. Error(
  1271. "Reverse query name for 'invalid_models_tests.Model.m2m_1' "
  1272. "clashes with field name 'invalid_models_tests.Target.id'.",
  1273. hint=(
  1274. "Rename field 'invalid_models_tests.Target.id', or "
  1275. "add/change a related_name argument to the definition for "
  1276. "field 'invalid_models_tests.Model.m2m_1'."
  1277. ),
  1278. obj=Model._meta.get_field('m2m_1'),
  1279. id='fields.E303',
  1280. ),
  1281. Error(
  1282. "Reverse accessor for 'invalid_models_tests.Model.m2m_1' "
  1283. "clashes with reverse accessor for "
  1284. "'invalid_models_tests.Model.foreign_1'.",
  1285. hint=(
  1286. "Add or change a related_name argument to the definition "
  1287. "for 'invalid_models_tests.Model.m2m_1' or "
  1288. "'invalid_models_tests.Model.foreign_1'."
  1289. ),
  1290. obj=Model._meta.get_field('m2m_1'),
  1291. id='fields.E304',
  1292. ),
  1293. Error(
  1294. "Reverse query name for 'invalid_models_tests.Model.m2m_1' "
  1295. "clashes with reverse query name for "
  1296. "'invalid_models_tests.Model.foreign_1'.",
  1297. hint=(
  1298. "Add or change a related_name argument to the definition "
  1299. "for 'invalid_models_tests.Model.m2m_1' or "
  1300. "'invalid_models_tests.Model.foreign_1'."
  1301. ),
  1302. obj=Model._meta.get_field('m2m_1'),
  1303. id='fields.E305',
  1304. ),
  1305. Error(
  1306. "Reverse accessor for 'invalid_models_tests.Model.m2m_2' "
  1307. "clashes with reverse accessor for "
  1308. "'invalid_models_tests.Model.foreign_2'.",
  1309. hint=(
  1310. "Add or change a related_name argument to the definition "
  1311. "for 'invalid_models_tests.Model.m2m_2' or "
  1312. "'invalid_models_tests.Model.foreign_2'."
  1313. ),
  1314. obj=Model._meta.get_field('m2m_2'),
  1315. id='fields.E304',
  1316. ),
  1317. Error(
  1318. "Reverse query name for 'invalid_models_tests.Model.m2m_2' "
  1319. "clashes with reverse query name for "
  1320. "'invalid_models_tests.Model.foreign_2'.",
  1321. hint=(
  1322. "Add or change a related_name argument to the definition "
  1323. "for 'invalid_models_tests.Model.m2m_2' or "
  1324. "'invalid_models_tests.Model.foreign_2'."
  1325. ),
  1326. obj=Model._meta.get_field('m2m_2'),
  1327. id='fields.E305',
  1328. ),
  1329. ])
  1330. def test_clash_parent_link(self):
  1331. class Parent(models.Model):
  1332. pass
  1333. class Child(Parent):
  1334. other_parent = models.OneToOneField(Parent, models.CASCADE)
  1335. errors = [
  1336. ('fields.E304', 'accessor', 'parent_ptr', 'other_parent'),
  1337. ('fields.E305', 'query name', 'parent_ptr', 'other_parent'),
  1338. ('fields.E304', 'accessor', 'other_parent', 'parent_ptr'),
  1339. ('fields.E305', 'query name', 'other_parent', 'parent_ptr'),
  1340. ]
  1341. self.assertEqual(Child.check(), [
  1342. Error(
  1343. "Reverse %s for 'invalid_models_tests.Child.%s' clashes with "
  1344. "reverse %s for 'invalid_models_tests.Child.%s'."
  1345. % (attr, field_name, attr, clash_name),
  1346. hint=(
  1347. "Add or change a related_name argument to the definition "
  1348. "for 'invalid_models_tests.Child.%s' or "
  1349. "'invalid_models_tests.Child.%s'." % (field_name, clash_name)
  1350. ),
  1351. obj=Child._meta.get_field(field_name),
  1352. id=error_id,
  1353. )
  1354. for error_id, attr, field_name, clash_name in errors
  1355. ])
  1356. @isolate_apps('invalid_models_tests')
  1357. class M2mThroughFieldsTests(SimpleTestCase):
  1358. def test_m2m_field_argument_validation(self):
  1359. """
  1360. ManyToManyField accepts the ``through_fields`` kwarg
  1361. only if an intermediary table is specified.
  1362. """
  1363. class Fan(models.Model):
  1364. pass
  1365. with self.assertRaisesMessage(ValueError, 'Cannot specify through_fields without a through model'):
  1366. models.ManyToManyField(Fan, through_fields=('f1', 'f2'))
  1367. def test_invalid_order(self):
  1368. """
  1369. Mixing up the order of link fields to ManyToManyField.through_fields
  1370. triggers validation errors.
  1371. """
  1372. class Fan(models.Model):
  1373. pass
  1374. class Event(models.Model):
  1375. invitees = models.ManyToManyField(Fan, through='Invitation', through_fields=('invitee', 'event'))
  1376. class Invitation(models.Model):
  1377. event = models.ForeignKey(Event, models.CASCADE)
  1378. invitee = models.ForeignKey(Fan, models.CASCADE)
  1379. inviter = models.ForeignKey(Fan, models.CASCADE, related_name='+')
  1380. field = Event._meta.get_field('invitees')
  1381. self.assertEqual(field.check(from_model=Event), [
  1382. Error(
  1383. "'Invitation.invitee' is not a foreign key to 'Event'.",
  1384. hint="Did you mean one of the following foreign keys to 'Event': event?",
  1385. obj=field,
  1386. id='fields.E339',
  1387. ),
  1388. Error(
  1389. "'Invitation.event' is not a foreign key to 'Fan'.",
  1390. hint="Did you mean one of the following foreign keys to 'Fan': invitee, inviter?",
  1391. obj=field,
  1392. id='fields.E339',
  1393. ),
  1394. ])
  1395. def test_invalid_field(self):
  1396. """
  1397. Providing invalid field names to ManyToManyField.through_fields
  1398. triggers validation errors.
  1399. """
  1400. class Fan(models.Model):
  1401. pass
  1402. class Event(models.Model):
  1403. invitees = models.ManyToManyField(
  1404. Fan,
  1405. through='Invitation',
  1406. through_fields=('invalid_field_1', 'invalid_field_2'),
  1407. )
  1408. class Invitation(models.Model):
  1409. event = models.ForeignKey(Event, models.CASCADE)
  1410. invitee = models.ForeignKey(Fan, models.CASCADE)
  1411. inviter = models.ForeignKey(Fan, models.CASCADE, related_name='+')
  1412. field = Event._meta.get_field('invitees')
  1413. self.assertEqual(field.check(from_model=Event), [
  1414. Error(
  1415. "The intermediary model 'invalid_models_tests.Invitation' has no field 'invalid_field_1'.",
  1416. hint="Did you mean one of the following foreign keys to 'Event': event?",
  1417. obj=field,
  1418. id='fields.E338',
  1419. ),
  1420. Error(
  1421. "The intermediary model 'invalid_models_tests.Invitation' has no field 'invalid_field_2'.",
  1422. hint="Did you mean one of the following foreign keys to 'Fan': invitee, inviter?",
  1423. obj=field,
  1424. id='fields.E338',
  1425. ),
  1426. ])
  1427. def test_explicit_field_names(self):
  1428. """
  1429. If ``through_fields`` kwarg is given, it must specify both
  1430. link fields of the intermediary table.
  1431. """
  1432. class Fan(models.Model):
  1433. pass
  1434. class Event(models.Model):
  1435. invitees = models.ManyToManyField(Fan, through='Invitation', through_fields=(None, 'invitee'))
  1436. class Invitation(models.Model):
  1437. event = models.ForeignKey(Event, models.CASCADE)
  1438. invitee = models.ForeignKey(Fan, models.CASCADE)
  1439. inviter = models.ForeignKey(Fan, models.CASCADE, related_name='+')
  1440. field = Event._meta.get_field('invitees')
  1441. self.assertEqual(field.check(from_model=Event), [
  1442. Error(
  1443. "Field specifies 'through_fields' but does not provide the names "
  1444. "of the two link fields that should be used for the relation "
  1445. "through model 'invalid_models_tests.Invitation'.",
  1446. hint="Make sure you specify 'through_fields' as through_fields=('field1', 'field2')",
  1447. obj=field,
  1448. id='fields.E337',
  1449. ),
  1450. ])
  1451. def test_superset_foreign_object(self):
  1452. class Parent(models.Model):
  1453. a = models.PositiveIntegerField()
  1454. b = models.PositiveIntegerField()
  1455. c = models.PositiveIntegerField()
  1456. class Meta:
  1457. unique_together = (('a', 'b', 'c'),)
  1458. class Child(models.Model):
  1459. a = models.PositiveIntegerField()
  1460. b = models.PositiveIntegerField()
  1461. value = models.CharField(max_length=255)
  1462. parent = models.ForeignObject(
  1463. Parent,
  1464. on_delete=models.SET_NULL,
  1465. from_fields=('a', 'b'),
  1466. to_fields=('a', 'b'),
  1467. related_name='children',
  1468. )
  1469. field = Child._meta.get_field('parent')
  1470. self.assertEqual(field.check(from_model=Child), [
  1471. Error(
  1472. "No subset of the fields 'a', 'b' on model 'Parent' is unique.",
  1473. hint=(
  1474. 'Mark a single field as unique=True or add a set of '
  1475. 'fields to a unique constraint (via unique_together or a '
  1476. 'UniqueConstraint (without condition) in the model '
  1477. 'Meta.constraints).'
  1478. ),
  1479. obj=field,
  1480. id='fields.E310',
  1481. ),
  1482. ])
  1483. def test_intersection_foreign_object(self):
  1484. class Parent(models.Model):
  1485. a = models.PositiveIntegerField()
  1486. b = models.PositiveIntegerField()
  1487. c = models.PositiveIntegerField()
  1488. d = models.PositiveIntegerField()
  1489. class Meta:
  1490. unique_together = (('a', 'b', 'c'),)
  1491. class Child(models.Model):
  1492. a = models.PositiveIntegerField()
  1493. b = models.PositiveIntegerField()
  1494. d = models.PositiveIntegerField()
  1495. value = models.CharField(max_length=255)
  1496. parent = models.ForeignObject(
  1497. Parent,
  1498. on_delete=models.SET_NULL,
  1499. from_fields=('a', 'b', 'd'),
  1500. to_fields=('a', 'b', 'd'),
  1501. related_name='children',
  1502. )
  1503. field = Child._meta.get_field('parent')
  1504. self.assertEqual(field.check(from_model=Child), [
  1505. Error(
  1506. "No subset of the fields 'a', 'b', 'd' on model 'Parent' is unique.",
  1507. hint=(
  1508. 'Mark a single field as unique=True or add a set of '
  1509. 'fields to a unique constraint (via unique_together or a '
  1510. 'UniqueConstraint (without condition) in the model '
  1511. 'Meta.constraints).'
  1512. ),
  1513. obj=field,
  1514. id='fields.E310',
  1515. ),
  1516. ])