tests.py 93 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367
  1. import datetime
  2. import re
  3. from datetime import date
  4. from decimal import Decimal
  5. from django import forms
  6. from django.core.exceptions import ImproperlyConfigured
  7. from django.db import models
  8. from django.forms.formsets import formset_factory
  9. from django.forms.models import (
  10. BaseModelFormSet,
  11. _get_foreign_key,
  12. inlineformset_factory,
  13. modelformset_factory,
  14. )
  15. from django.http import QueryDict
  16. from django.test import TestCase, skipUnlessDBFeature
  17. from .models import (
  18. AlternateBook,
  19. Author,
  20. AuthorMeeting,
  21. BetterAuthor,
  22. Book,
  23. BookWithCustomPK,
  24. BookWithOptionalAltEditor,
  25. ClassyMexicanRestaurant,
  26. CustomPrimaryKey,
  27. Location,
  28. Membership,
  29. MexicanRestaurant,
  30. Owner,
  31. OwnerProfile,
  32. Person,
  33. Place,
  34. Player,
  35. Poem,
  36. Poet,
  37. Post,
  38. Price,
  39. Product,
  40. Repository,
  41. Restaurant,
  42. Revision,
  43. Team,
  44. )
  45. class DeletionTests(TestCase):
  46. def test_deletion(self):
  47. PoetFormSet = modelformset_factory(Poet, fields="__all__", can_delete=True)
  48. poet = Poet.objects.create(name="test")
  49. data = {
  50. "form-TOTAL_FORMS": "1",
  51. "form-INITIAL_FORMS": "1",
  52. "form-MAX_NUM_FORMS": "0",
  53. "form-0-id": str(poet.pk),
  54. "form-0-name": "test",
  55. "form-0-DELETE": "on",
  56. }
  57. formset = PoetFormSet(data, queryset=Poet.objects.all())
  58. formset.save(commit=False)
  59. self.assertEqual(Poet.objects.count(), 1)
  60. formset.save()
  61. self.assertTrue(formset.is_valid())
  62. self.assertEqual(Poet.objects.count(), 0)
  63. def test_add_form_deletion_when_invalid(self):
  64. """
  65. Make sure that an add form that is filled out, but marked for deletion
  66. doesn't cause validation errors.
  67. """
  68. PoetFormSet = modelformset_factory(Poet, fields="__all__", can_delete=True)
  69. poet = Poet.objects.create(name="test")
  70. # One existing untouched and two new unvalid forms
  71. data = {
  72. "form-TOTAL_FORMS": "3",
  73. "form-INITIAL_FORMS": "1",
  74. "form-MAX_NUM_FORMS": "0",
  75. "form-0-id": str(poet.id),
  76. "form-0-name": "test",
  77. "form-1-id": "",
  78. "form-1-name": "x" * 1000, # Too long
  79. "form-2-id": str(poet.id), # Violate unique constraint
  80. "form-2-name": "test2",
  81. }
  82. formset = PoetFormSet(data, queryset=Poet.objects.all())
  83. # Make sure this form doesn't pass validation.
  84. self.assertIs(formset.is_valid(), False)
  85. self.assertEqual(Poet.objects.count(), 1)
  86. # Then make sure that it *does* pass validation and delete the object,
  87. # even though the data in new forms aren't actually valid.
  88. data["form-0-DELETE"] = "on"
  89. data["form-1-DELETE"] = "on"
  90. data["form-2-DELETE"] = "on"
  91. formset = PoetFormSet(data, queryset=Poet.objects.all())
  92. self.assertIs(formset.is_valid(), True)
  93. formset.save()
  94. self.assertEqual(Poet.objects.count(), 0)
  95. def test_change_form_deletion_when_invalid(self):
  96. """
  97. Make sure that a change form that is filled out, but marked for deletion
  98. doesn't cause validation errors.
  99. """
  100. PoetFormSet = modelformset_factory(Poet, fields="__all__", can_delete=True)
  101. poet = Poet.objects.create(name="test")
  102. data = {
  103. "form-TOTAL_FORMS": "1",
  104. "form-INITIAL_FORMS": "1",
  105. "form-MAX_NUM_FORMS": "0",
  106. "form-0-id": str(poet.id),
  107. "form-0-name": "x" * 1000,
  108. }
  109. formset = PoetFormSet(data, queryset=Poet.objects.all())
  110. # Make sure this form doesn't pass validation.
  111. self.assertIs(formset.is_valid(), False)
  112. self.assertEqual(Poet.objects.count(), 1)
  113. # Then make sure that it *does* pass validation and delete the object,
  114. # even though the data isn't actually valid.
  115. data["form-0-DELETE"] = "on"
  116. formset = PoetFormSet(data, queryset=Poet.objects.all())
  117. self.assertIs(formset.is_valid(), True)
  118. formset.save()
  119. self.assertEqual(Poet.objects.count(), 0)
  120. def test_outdated_deletion(self):
  121. poet = Poet.objects.create(name="test")
  122. poem = Poem.objects.create(name="Brevity is the soul of wit", poet=poet)
  123. PoemFormSet = inlineformset_factory(
  124. Poet, Poem, fields="__all__", can_delete=True
  125. )
  126. # Simulate deletion of an object that doesn't exist in the database
  127. data = {
  128. "form-TOTAL_FORMS": "2",
  129. "form-INITIAL_FORMS": "2",
  130. "form-0-id": str(poem.pk),
  131. "form-0-name": "foo",
  132. "form-1-id": str(poem.pk + 1), # doesn't exist
  133. "form-1-name": "bar",
  134. "form-1-DELETE": "on",
  135. }
  136. formset = PoemFormSet(data, instance=poet, prefix="form")
  137. # The formset is valid even though poem.pk + 1 doesn't exist,
  138. # because it's marked for deletion anyway
  139. self.assertTrue(formset.is_valid())
  140. formset.save()
  141. # Make sure the save went through correctly
  142. self.assertEqual(Poem.objects.get(pk=poem.pk).name, "foo")
  143. self.assertEqual(poet.poem_set.count(), 1)
  144. self.assertFalse(Poem.objects.filter(pk=poem.pk + 1).exists())
  145. class ModelFormsetTest(TestCase):
  146. def test_modelformset_factory_without_fields(self):
  147. """Regression for #19733"""
  148. message = (
  149. "Calling modelformset_factory without defining 'fields' or 'exclude' "
  150. "explicitly is prohibited."
  151. )
  152. with self.assertRaisesMessage(ImproperlyConfigured, message):
  153. modelformset_factory(Author)
  154. def test_simple_save(self):
  155. qs = Author.objects.all()
  156. AuthorFormSet = modelformset_factory(Author, fields="__all__", extra=3)
  157. formset = AuthorFormSet(queryset=qs)
  158. self.assertEqual(len(formset.forms), 3)
  159. self.assertHTMLEqual(
  160. formset.forms[0].as_p(),
  161. '<p><label for="id_form-0-name">Name:</label>'
  162. '<input id="id_form-0-name" type="text" name="form-0-name" maxlength="100">'
  163. '<input type="hidden" name="form-0-id" id="id_form-0-id"></p>',
  164. )
  165. self.assertHTMLEqual(
  166. formset.forms[1].as_p(),
  167. '<p><label for="id_form-1-name">Name:</label>'
  168. '<input id="id_form-1-name" type="text" name="form-1-name" maxlength="100">'
  169. '<input type="hidden" name="form-1-id" id="id_form-1-id"></p>',
  170. )
  171. self.assertHTMLEqual(
  172. formset.forms[2].as_p(),
  173. '<p><label for="id_form-2-name">Name:</label>'
  174. '<input id="id_form-2-name" type="text" name="form-2-name" maxlength="100">'
  175. '<input type="hidden" name="form-2-id" id="id_form-2-id"></p>',
  176. )
  177. data = {
  178. "form-TOTAL_FORMS": "3", # the number of forms rendered
  179. "form-INITIAL_FORMS": "0", # the number of forms with initial data
  180. "form-MAX_NUM_FORMS": "", # the max number of forms
  181. "form-0-name": "Charles Baudelaire",
  182. "form-1-name": "Arthur Rimbaud",
  183. "form-2-name": "",
  184. }
  185. formset = AuthorFormSet(data=data, queryset=qs)
  186. self.assertTrue(formset.is_valid())
  187. saved = formset.save()
  188. self.assertEqual(len(saved), 2)
  189. author1, author2 = saved
  190. self.assertEqual(author1, Author.objects.get(name="Charles Baudelaire"))
  191. self.assertEqual(author2, Author.objects.get(name="Arthur Rimbaud"))
  192. authors = list(Author.objects.order_by("name"))
  193. self.assertEqual(authors, [author2, author1])
  194. # Gah! We forgot Paul Verlaine. Let's create a formset to edit the
  195. # existing authors with an extra form to add him. We *could* pass in a
  196. # queryset to restrict the Author objects we edit, but in this case
  197. # we'll use it to display them in alphabetical order by name.
  198. qs = Author.objects.order_by("name")
  199. AuthorFormSet = modelformset_factory(
  200. Author, fields="__all__", extra=1, can_delete=False
  201. )
  202. formset = AuthorFormSet(queryset=qs)
  203. self.assertEqual(len(formset.forms), 3)
  204. self.assertHTMLEqual(
  205. formset.forms[0].as_p(),
  206. '<p><label for="id_form-0-name">Name:</label>'
  207. '<input id="id_form-0-name" type="text" name="form-0-name" '
  208. 'value="Arthur Rimbaud" maxlength="100">'
  209. '<input type="hidden" name="form-0-id" value="%d" id="id_form-0-id"></p>'
  210. % author2.id,
  211. )
  212. self.assertHTMLEqual(
  213. formset.forms[1].as_p(),
  214. '<p><label for="id_form-1-name">Name:</label>'
  215. '<input id="id_form-1-name" type="text" name="form-1-name" '
  216. 'value="Charles Baudelaire" maxlength="100">'
  217. '<input type="hidden" name="form-1-id" value="%d" id="id_form-1-id"></p>'
  218. % author1.id,
  219. )
  220. self.assertHTMLEqual(
  221. formset.forms[2].as_p(),
  222. '<p><label for="id_form-2-name">Name:</label>'
  223. '<input id="id_form-2-name" type="text" name="form-2-name" maxlength="100">'
  224. '<input type="hidden" name="form-2-id" id="id_form-2-id"></p>',
  225. )
  226. data = {
  227. "form-TOTAL_FORMS": "3", # the number of forms rendered
  228. "form-INITIAL_FORMS": "2", # the number of forms with initial data
  229. "form-MAX_NUM_FORMS": "", # the max number of forms
  230. "form-0-id": str(author2.id),
  231. "form-0-name": "Arthur Rimbaud",
  232. "form-1-id": str(author1.id),
  233. "form-1-name": "Charles Baudelaire",
  234. "form-2-name": "Paul Verlaine",
  235. }
  236. formset = AuthorFormSet(data=data, queryset=qs)
  237. self.assertTrue(formset.is_valid())
  238. # Only changed or new objects are returned from formset.save()
  239. saved = formset.save()
  240. self.assertEqual(len(saved), 1)
  241. author3 = saved[0]
  242. self.assertEqual(author3, Author.objects.get(name="Paul Verlaine"))
  243. authors = list(Author.objects.order_by("name"))
  244. self.assertEqual(authors, [author2, author1, author3])
  245. # This probably shouldn't happen, but it will. If an add form was
  246. # marked for deletion, make sure we don't save that form.
  247. qs = Author.objects.order_by("name")
  248. AuthorFormSet = modelformset_factory(
  249. Author, fields="__all__", extra=1, can_delete=True
  250. )
  251. formset = AuthorFormSet(queryset=qs)
  252. self.assertEqual(len(formset.forms), 4)
  253. self.assertHTMLEqual(
  254. formset.forms[0].as_p(),
  255. '<p><label for="id_form-0-name">Name:</label>'
  256. '<input id="id_form-0-name" type="text" name="form-0-name" '
  257. 'value="Arthur Rimbaud" maxlength="100"></p>'
  258. '<p><label for="id_form-0-DELETE">Delete:</label>'
  259. '<input type="checkbox" name="form-0-DELETE" id="id_form-0-DELETE">'
  260. '<input type="hidden" name="form-0-id" value="%d" id="id_form-0-id"></p>'
  261. % author2.id,
  262. )
  263. self.assertHTMLEqual(
  264. formset.forms[1].as_p(),
  265. '<p><label for="id_form-1-name">Name:</label>'
  266. '<input id="id_form-1-name" type="text" name="form-1-name" '
  267. 'value="Charles Baudelaire" maxlength="100"></p>'
  268. '<p><label for="id_form-1-DELETE">Delete:</label>'
  269. '<input type="checkbox" name="form-1-DELETE" id="id_form-1-DELETE">'
  270. '<input type="hidden" name="form-1-id" value="%d" id="id_form-1-id"></p>'
  271. % author1.id,
  272. )
  273. self.assertHTMLEqual(
  274. formset.forms[2].as_p(),
  275. '<p><label for="id_form-2-name">Name:</label>'
  276. '<input id="id_form-2-name" type="text" name="form-2-name" '
  277. 'value="Paul Verlaine" maxlength="100"></p>'
  278. '<p><label for="id_form-2-DELETE">Delete:</label>'
  279. '<input type="checkbox" name="form-2-DELETE" id="id_form-2-DELETE">'
  280. '<input type="hidden" name="form-2-id" value="%d" id="id_form-2-id"></p>'
  281. % author3.id,
  282. )
  283. self.assertHTMLEqual(
  284. formset.forms[3].as_p(),
  285. '<p><label for="id_form-3-name">Name:</label>'
  286. '<input id="id_form-3-name" type="text" name="form-3-name" maxlength="100">'
  287. '</p><p><label for="id_form-3-DELETE">Delete:</label>'
  288. '<input type="checkbox" name="form-3-DELETE" id="id_form-3-DELETE">'
  289. '<input type="hidden" name="form-3-id" id="id_form-3-id"></p>',
  290. )
  291. data = {
  292. "form-TOTAL_FORMS": "4", # the number of forms rendered
  293. "form-INITIAL_FORMS": "3", # the number of forms with initial data
  294. "form-MAX_NUM_FORMS": "", # the max number of forms
  295. "form-0-id": str(author2.id),
  296. "form-0-name": "Arthur Rimbaud",
  297. "form-1-id": str(author1.id),
  298. "form-1-name": "Charles Baudelaire",
  299. "form-2-id": str(author3.id),
  300. "form-2-name": "Paul Verlaine",
  301. "form-3-name": "Walt Whitman",
  302. "form-3-DELETE": "on",
  303. }
  304. formset = AuthorFormSet(data=data, queryset=qs)
  305. self.assertTrue(formset.is_valid())
  306. # No objects were changed or saved so nothing will come back.
  307. self.assertEqual(formset.save(), [])
  308. authors = list(Author.objects.order_by("name"))
  309. self.assertEqual(authors, [author2, author1, author3])
  310. # Let's edit a record to ensure save only returns that one record.
  311. data = {
  312. "form-TOTAL_FORMS": "4", # the number of forms rendered
  313. "form-INITIAL_FORMS": "3", # the number of forms with initial data
  314. "form-MAX_NUM_FORMS": "", # the max number of forms
  315. "form-0-id": str(author2.id),
  316. "form-0-name": "Walt Whitman",
  317. "form-1-id": str(author1.id),
  318. "form-1-name": "Charles Baudelaire",
  319. "form-2-id": str(author3.id),
  320. "form-2-name": "Paul Verlaine",
  321. "form-3-name": "",
  322. "form-3-DELETE": "",
  323. }
  324. formset = AuthorFormSet(data=data, queryset=qs)
  325. self.assertTrue(formset.is_valid())
  326. # One record has changed.
  327. saved = formset.save()
  328. self.assertEqual(len(saved), 1)
  329. self.assertEqual(saved[0], Author.objects.get(name="Walt Whitman"))
  330. def test_commit_false(self):
  331. # Test the behavior of commit=False and save_m2m
  332. author1 = Author.objects.create(name="Charles Baudelaire")
  333. author2 = Author.objects.create(name="Paul Verlaine")
  334. author3 = Author.objects.create(name="Walt Whitman")
  335. meeting = AuthorMeeting.objects.create(created=date.today())
  336. meeting.authors.set(Author.objects.all())
  337. # create an Author instance to add to the meeting.
  338. author4 = Author.objects.create(name="John Steinbeck")
  339. AuthorMeetingFormSet = modelformset_factory(
  340. AuthorMeeting, fields="__all__", extra=1, can_delete=True
  341. )
  342. data = {
  343. "form-TOTAL_FORMS": "2", # the number of forms rendered
  344. "form-INITIAL_FORMS": "1", # the number of forms with initial data
  345. "form-MAX_NUM_FORMS": "", # the max number of forms
  346. "form-0-id": str(meeting.id),
  347. "form-0-name": "2nd Tuesday of the Week Meeting",
  348. "form-0-authors": [author2.id, author1.id, author3.id, author4.id],
  349. "form-1-name": "",
  350. "form-1-authors": "",
  351. "form-1-DELETE": "",
  352. }
  353. formset = AuthorMeetingFormSet(data=data, queryset=AuthorMeeting.objects.all())
  354. self.assertTrue(formset.is_valid())
  355. instances = formset.save(commit=False)
  356. for instance in instances:
  357. instance.created = date.today()
  358. instance.save()
  359. formset.save_m2m()
  360. self.assertSequenceEqual(
  361. instances[0].authors.all(),
  362. [author1, author4, author2, author3],
  363. )
  364. def test_max_num(self):
  365. # Test the behavior of max_num with model formsets. It should allow
  366. # all existing related objects/inlines for a given object to be
  367. # displayed, but not allow the creation of new inlines beyond max_num.
  368. a1 = Author.objects.create(name="Charles Baudelaire")
  369. a2 = Author.objects.create(name="Paul Verlaine")
  370. a3 = Author.objects.create(name="Walt Whitman")
  371. qs = Author.objects.order_by("name")
  372. AuthorFormSet = modelformset_factory(
  373. Author, fields="__all__", max_num=None, extra=3
  374. )
  375. formset = AuthorFormSet(queryset=qs)
  376. self.assertEqual(len(formset.forms), 6)
  377. self.assertEqual(len(formset.extra_forms), 3)
  378. AuthorFormSet = modelformset_factory(
  379. Author, fields="__all__", max_num=4, extra=3
  380. )
  381. formset = AuthorFormSet(queryset=qs)
  382. self.assertEqual(len(formset.forms), 4)
  383. self.assertEqual(len(formset.extra_forms), 1)
  384. AuthorFormSet = modelformset_factory(
  385. Author, fields="__all__", max_num=0, extra=3
  386. )
  387. formset = AuthorFormSet(queryset=qs)
  388. self.assertEqual(len(formset.forms), 3)
  389. self.assertEqual(len(formset.extra_forms), 0)
  390. AuthorFormSet = modelformset_factory(Author, fields="__all__", max_num=None)
  391. formset = AuthorFormSet(queryset=qs)
  392. self.assertSequenceEqual(formset.get_queryset(), [a1, a2, a3])
  393. AuthorFormSet = modelformset_factory(Author, fields="__all__", max_num=0)
  394. formset = AuthorFormSet(queryset=qs)
  395. self.assertSequenceEqual(formset.get_queryset(), [a1, a2, a3])
  396. AuthorFormSet = modelformset_factory(Author, fields="__all__", max_num=4)
  397. formset = AuthorFormSet(queryset=qs)
  398. self.assertSequenceEqual(formset.get_queryset(), [a1, a2, a3])
  399. def test_min_num(self):
  400. # Test the behavior of min_num with model formsets. It should be
  401. # added to extra.
  402. qs = Author.objects.none()
  403. AuthorFormSet = modelformset_factory(Author, fields="__all__", extra=0)
  404. formset = AuthorFormSet(queryset=qs)
  405. self.assertEqual(len(formset.forms), 0)
  406. AuthorFormSet = modelformset_factory(
  407. Author, fields="__all__", min_num=1, extra=0
  408. )
  409. formset = AuthorFormSet(queryset=qs)
  410. self.assertEqual(len(formset.forms), 1)
  411. AuthorFormSet = modelformset_factory(
  412. Author, fields="__all__", min_num=1, extra=1
  413. )
  414. formset = AuthorFormSet(queryset=qs)
  415. self.assertEqual(len(formset.forms), 2)
  416. def test_min_num_with_existing(self):
  417. # Test the behavior of min_num with existing objects.
  418. Author.objects.create(name="Charles Baudelaire")
  419. qs = Author.objects.all()
  420. AuthorFormSet = modelformset_factory(
  421. Author, fields="__all__", extra=0, min_num=1
  422. )
  423. formset = AuthorFormSet(queryset=qs)
  424. self.assertEqual(len(formset.forms), 1)
  425. def test_custom_save_method(self):
  426. class PoetForm(forms.ModelForm):
  427. def save(self, commit=True):
  428. # change the name to "Vladimir Mayakovsky" just to be a jerk.
  429. author = super().save(commit=False)
  430. author.name = "Vladimir Mayakovsky"
  431. if commit:
  432. author.save()
  433. return author
  434. PoetFormSet = modelformset_factory(Poet, fields="__all__", form=PoetForm)
  435. data = {
  436. "form-TOTAL_FORMS": "3", # the number of forms rendered
  437. "form-INITIAL_FORMS": "0", # the number of forms with initial data
  438. "form-MAX_NUM_FORMS": "", # the max number of forms
  439. "form-0-name": "Walt Whitman",
  440. "form-1-name": "Charles Baudelaire",
  441. "form-2-name": "",
  442. }
  443. qs = Poet.objects.all()
  444. formset = PoetFormSet(data=data, queryset=qs)
  445. self.assertTrue(formset.is_valid())
  446. poets = formset.save()
  447. self.assertEqual(len(poets), 2)
  448. poet1, poet2 = poets
  449. self.assertEqual(poet1.name, "Vladimir Mayakovsky")
  450. self.assertEqual(poet2.name, "Vladimir Mayakovsky")
  451. def test_custom_form(self):
  452. """
  453. model_formset_factory() respects fields and exclude parameters of a
  454. custom form.
  455. """
  456. class PostForm1(forms.ModelForm):
  457. class Meta:
  458. model = Post
  459. fields = ("title", "posted")
  460. class PostForm2(forms.ModelForm):
  461. class Meta:
  462. model = Post
  463. exclude = ("subtitle",)
  464. PostFormSet = modelformset_factory(Post, form=PostForm1)
  465. formset = PostFormSet()
  466. self.assertNotIn("subtitle", formset.forms[0].fields)
  467. PostFormSet = modelformset_factory(Post, form=PostForm2)
  468. formset = PostFormSet()
  469. self.assertNotIn("subtitle", formset.forms[0].fields)
  470. def test_custom_queryset_init(self):
  471. """
  472. A queryset can be overridden in the formset's __init__() method.
  473. """
  474. Author.objects.create(name="Charles Baudelaire")
  475. Author.objects.create(name="Paul Verlaine")
  476. class BaseAuthorFormSet(BaseModelFormSet):
  477. def __init__(self, *args, **kwargs):
  478. super().__init__(*args, **kwargs)
  479. self.queryset = Author.objects.filter(name__startswith="Charles")
  480. AuthorFormSet = modelformset_factory(
  481. Author, fields="__all__", formset=BaseAuthorFormSet
  482. )
  483. formset = AuthorFormSet()
  484. self.assertEqual(len(formset.get_queryset()), 1)
  485. def test_model_inheritance(self):
  486. BetterAuthorFormSet = modelformset_factory(BetterAuthor, fields="__all__")
  487. formset = BetterAuthorFormSet()
  488. self.assertEqual(len(formset.forms), 1)
  489. self.assertHTMLEqual(
  490. formset.forms[0].as_p(),
  491. '<p><label for="id_form-0-name">Name:</label>'
  492. '<input id="id_form-0-name" type="text" name="form-0-name" maxlength="100">'
  493. '</p><p><label for="id_form-0-write_speed">Write speed:</label>'
  494. '<input type="number" name="form-0-write_speed" id="id_form-0-write_speed">'
  495. '<input type="hidden" name="form-0-author_ptr" id="id_form-0-author_ptr">'
  496. "</p>",
  497. )
  498. data = {
  499. "form-TOTAL_FORMS": "1", # the number of forms rendered
  500. "form-INITIAL_FORMS": "0", # the number of forms with initial data
  501. "form-MAX_NUM_FORMS": "", # the max number of forms
  502. "form-0-author_ptr": "",
  503. "form-0-name": "Ernest Hemingway",
  504. "form-0-write_speed": "10",
  505. }
  506. formset = BetterAuthorFormSet(data)
  507. self.assertTrue(formset.is_valid())
  508. saved = formset.save()
  509. self.assertEqual(len(saved), 1)
  510. (author1,) = saved
  511. self.assertEqual(author1, BetterAuthor.objects.get(name="Ernest Hemingway"))
  512. hemingway_id = BetterAuthor.objects.get(name="Ernest Hemingway").pk
  513. formset = BetterAuthorFormSet()
  514. self.assertEqual(len(formset.forms), 2)
  515. self.assertHTMLEqual(
  516. formset.forms[0].as_p(),
  517. '<p><label for="id_form-0-name">Name:</label>'
  518. '<input id="id_form-0-name" type="text" name="form-0-name" '
  519. 'value="Ernest Hemingway" maxlength="100"></p>'
  520. '<p><label for="id_form-0-write_speed">Write speed:</label>'
  521. '<input type="number" name="form-0-write_speed" value="10" '
  522. 'id="id_form-0-write_speed">'
  523. '<input type="hidden" name="form-0-author_ptr" value="%d" '
  524. 'id="id_form-0-author_ptr"></p>' % hemingway_id,
  525. )
  526. self.assertHTMLEqual(
  527. formset.forms[1].as_p(),
  528. '<p><label for="id_form-1-name">Name:</label>'
  529. '<input id="id_form-1-name" type="text" name="form-1-name" maxlength="100">'
  530. '</p><p><label for="id_form-1-write_speed">Write speed:</label>'
  531. '<input type="number" name="form-1-write_speed" id="id_form-1-write_speed">'
  532. '<input type="hidden" name="form-1-author_ptr" id="id_form-1-author_ptr">'
  533. "</p>",
  534. )
  535. data = {
  536. "form-TOTAL_FORMS": "2", # the number of forms rendered
  537. "form-INITIAL_FORMS": "1", # the number of forms with initial data
  538. "form-MAX_NUM_FORMS": "", # the max number of forms
  539. "form-0-author_ptr": hemingway_id,
  540. "form-0-name": "Ernest Hemingway",
  541. "form-0-write_speed": "10",
  542. "form-1-author_ptr": "",
  543. "form-1-name": "",
  544. "form-1-write_speed": "",
  545. }
  546. formset = BetterAuthorFormSet(data)
  547. self.assertTrue(formset.is_valid())
  548. self.assertEqual(formset.save(), [])
  549. def test_inline_formsets(self):
  550. # We can also create a formset that is tied to a parent model. This is
  551. # how the admin system's edit inline functionality works.
  552. AuthorBooksFormSet = inlineformset_factory(
  553. Author, Book, can_delete=False, extra=3, fields="__all__"
  554. )
  555. author = Author.objects.create(name="Charles Baudelaire")
  556. formset = AuthorBooksFormSet(instance=author)
  557. self.assertEqual(len(formset.forms), 3)
  558. self.assertHTMLEqual(
  559. formset.forms[0].as_p(),
  560. '<p><label for="id_book_set-0-title">Title:</label>'
  561. '<input id="id_book_set-0-title" type="text" name="book_set-0-title" '
  562. 'maxlength="100">'
  563. '<input type="hidden" name="book_set-0-author" value="%d" '
  564. 'id="id_book_set-0-author">'
  565. '<input type="hidden" name="book_set-0-id" id="id_book_set-0-id">'
  566. "</p>" % author.id,
  567. )
  568. self.assertHTMLEqual(
  569. formset.forms[1].as_p(),
  570. '<p><label for="id_book_set-1-title">Title:</label>'
  571. '<input id="id_book_set-1-title" type="text" name="book_set-1-title" '
  572. 'maxlength="100">'
  573. '<input type="hidden" name="book_set-1-author" value="%d" '
  574. 'id="id_book_set-1-author">'
  575. '<input type="hidden" name="book_set-1-id" id="id_book_set-1-id"></p>'
  576. % author.id,
  577. )
  578. self.assertHTMLEqual(
  579. formset.forms[2].as_p(),
  580. '<p><label for="id_book_set-2-title">Title:</label>'
  581. '<input id="id_book_set-2-title" type="text" name="book_set-2-title" '
  582. 'maxlength="100">'
  583. '<input type="hidden" name="book_set-2-author" value="%d" '
  584. 'id="id_book_set-2-author">'
  585. '<input type="hidden" name="book_set-2-id" id="id_book_set-2-id"></p>'
  586. % author.id,
  587. )
  588. data = {
  589. "book_set-TOTAL_FORMS": "3", # the number of forms rendered
  590. "book_set-INITIAL_FORMS": "0", # the number of forms with initial data
  591. "book_set-MAX_NUM_FORMS": "", # the max number of forms
  592. "book_set-0-title": "Les Fleurs du Mal",
  593. "book_set-1-title": "",
  594. "book_set-2-title": "",
  595. }
  596. formset = AuthorBooksFormSet(data, instance=author)
  597. self.assertTrue(formset.is_valid())
  598. saved = formset.save()
  599. self.assertEqual(len(saved), 1)
  600. (book1,) = saved
  601. self.assertEqual(book1, Book.objects.get(title="Les Fleurs du Mal"))
  602. self.assertSequenceEqual(author.book_set.all(), [book1])
  603. # Now that we've added a book to Charles Baudelaire, let's try adding
  604. # another one. This time though, an edit form will be available for
  605. # every existing book.
  606. AuthorBooksFormSet = inlineformset_factory(
  607. Author, Book, can_delete=False, extra=2, fields="__all__"
  608. )
  609. author = Author.objects.get(name="Charles Baudelaire")
  610. formset = AuthorBooksFormSet(instance=author)
  611. self.assertEqual(len(formset.forms), 3)
  612. self.assertHTMLEqual(
  613. formset.forms[0].as_p(),
  614. '<p><label for="id_book_set-0-title">Title:</label>'
  615. '<input id="id_book_set-0-title" type="text" name="book_set-0-title" '
  616. 'value="Les Fleurs du Mal" maxlength="100">'
  617. '<input type="hidden" name="book_set-0-author" value="%d" '
  618. 'id="id_book_set-0-author">'
  619. '<input type="hidden" name="book_set-0-id" value="%d" '
  620. 'id="id_book_set-0-id"></p>'
  621. % (
  622. author.id,
  623. book1.id,
  624. ),
  625. )
  626. self.assertHTMLEqual(
  627. formset.forms[1].as_p(),
  628. '<p><label for="id_book_set-1-title">Title:</label>'
  629. '<input id="id_book_set-1-title" type="text" name="book_set-1-title" '
  630. 'maxlength="100">'
  631. '<input type="hidden" name="book_set-1-author" value="%d" '
  632. 'id="id_book_set-1-author">'
  633. '<input type="hidden" name="book_set-1-id" id="id_book_set-1-id"></p>'
  634. % author.id,
  635. )
  636. self.assertHTMLEqual(
  637. formset.forms[2].as_p(),
  638. '<p><label for="id_book_set-2-title">Title:</label>'
  639. '<input id="id_book_set-2-title" type="text" name="book_set-2-title" '
  640. 'maxlength="100">'
  641. '<input type="hidden" name="book_set-2-author" value="%d" '
  642. 'id="id_book_set-2-author">'
  643. '<input type="hidden" name="book_set-2-id" id="id_book_set-2-id"></p>'
  644. % author.id,
  645. )
  646. data = {
  647. "book_set-TOTAL_FORMS": "3", # the number of forms rendered
  648. "book_set-INITIAL_FORMS": "1", # the number of forms with initial data
  649. "book_set-MAX_NUM_FORMS": "", # the max number of forms
  650. "book_set-0-id": str(book1.id),
  651. "book_set-0-title": "Les Fleurs du Mal",
  652. "book_set-1-title": "Les Paradis Artificiels",
  653. "book_set-2-title": "",
  654. }
  655. formset = AuthorBooksFormSet(data, instance=author)
  656. self.assertTrue(formset.is_valid())
  657. saved = formset.save()
  658. self.assertEqual(len(saved), 1)
  659. (book2,) = saved
  660. self.assertEqual(book2, Book.objects.get(title="Les Paradis Artificiels"))
  661. # As you can see, 'Les Paradis Artificiels' is now a book belonging to
  662. # Charles Baudelaire.
  663. self.assertSequenceEqual(author.book_set.order_by("title"), [book1, book2])
  664. def test_inline_formsets_save_as_new(self):
  665. # The save_as_new parameter lets you re-associate the data to a new
  666. # instance. This is used in the admin for save_as functionality.
  667. AuthorBooksFormSet = inlineformset_factory(
  668. Author, Book, can_delete=False, extra=2, fields="__all__"
  669. )
  670. Author.objects.create(name="Charles Baudelaire")
  671. # An immutable QueryDict simulates request.POST.
  672. data = QueryDict(mutable=True)
  673. data.update(
  674. {
  675. "book_set-TOTAL_FORMS": "3", # the number of forms rendered
  676. "book_set-INITIAL_FORMS": "2", # the number of forms with initial data
  677. "book_set-MAX_NUM_FORMS": "", # the max number of forms
  678. "book_set-0-id": "1",
  679. "book_set-0-title": "Les Fleurs du Mal",
  680. "book_set-1-id": "2",
  681. "book_set-1-title": "Les Paradis Artificiels",
  682. "book_set-2-title": "",
  683. }
  684. )
  685. data._mutable = False
  686. formset = AuthorBooksFormSet(data, instance=Author(), save_as_new=True)
  687. self.assertTrue(formset.is_valid())
  688. self.assertIs(data._mutable, False)
  689. new_author = Author.objects.create(name="Charles Baudelaire")
  690. formset = AuthorBooksFormSet(data, instance=new_author, save_as_new=True)
  691. saved = formset.save()
  692. self.assertEqual(len(saved), 2)
  693. book1, book2 = saved
  694. self.assertEqual(book1.title, "Les Fleurs du Mal")
  695. self.assertEqual(book2.title, "Les Paradis Artificiels")
  696. # Test using a custom prefix on an inline formset.
  697. formset = AuthorBooksFormSet(prefix="test")
  698. self.assertEqual(len(formset.forms), 2)
  699. self.assertHTMLEqual(
  700. formset.forms[0].as_p(),
  701. '<p><label for="id_test-0-title">Title:</label>'
  702. '<input id="id_test-0-title" type="text" name="test-0-title" '
  703. 'maxlength="100">'
  704. '<input type="hidden" name="test-0-author" id="id_test-0-author">'
  705. '<input type="hidden" name="test-0-id" id="id_test-0-id"></p>',
  706. )
  707. self.assertHTMLEqual(
  708. formset.forms[1].as_p(),
  709. '<p><label for="id_test-1-title">Title:</label>'
  710. '<input id="id_test-1-title" type="text" name="test-1-title" '
  711. 'maxlength="100">'
  712. '<input type="hidden" name="test-1-author" id="id_test-1-author">'
  713. '<input type="hidden" name="test-1-id" id="id_test-1-id"></p>',
  714. )
  715. def test_inline_formsets_with_custom_pk(self):
  716. # Test inline formsets where the inline-edited object has a custom
  717. # primary key that is not the fk to the parent object.
  718. self.maxDiff = 1024
  719. AuthorBooksFormSet2 = inlineformset_factory(
  720. Author, BookWithCustomPK, can_delete=False, extra=1, fields="__all__"
  721. )
  722. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  723. formset = AuthorBooksFormSet2(instance=author)
  724. self.assertEqual(len(formset.forms), 1)
  725. self.assertHTMLEqual(
  726. formset.forms[0].as_p(),
  727. '<p><label for="id_bookwithcustompk_set-0-my_pk">My pk:</label>'
  728. '<input id="id_bookwithcustompk_set-0-my_pk" type="number" '
  729. 'name="bookwithcustompk_set-0-my_pk" step="1"></p>'
  730. '<p><label for="id_bookwithcustompk_set-0-title">Title:</label>'
  731. '<input id="id_bookwithcustompk_set-0-title" type="text" '
  732. 'name="bookwithcustompk_set-0-title" maxlength="100">'
  733. '<input type="hidden" name="bookwithcustompk_set-0-author" '
  734. 'value="1" id="id_bookwithcustompk_set-0-author"></p>',
  735. )
  736. data = {
  737. # The number of forms rendered.
  738. "bookwithcustompk_set-TOTAL_FORMS": "1",
  739. # The number of forms with initial data.
  740. "bookwithcustompk_set-INITIAL_FORMS": "0",
  741. # The max number of forms.
  742. "bookwithcustompk_set-MAX_NUM_FORMS": "",
  743. "bookwithcustompk_set-0-my_pk": "77777",
  744. "bookwithcustompk_set-0-title": "Les Fleurs du Mal",
  745. }
  746. formset = AuthorBooksFormSet2(data, instance=author)
  747. self.assertTrue(formset.is_valid())
  748. saved = formset.save()
  749. self.assertEqual(len(saved), 1)
  750. (book1,) = saved
  751. self.assertEqual(book1.pk, 77777)
  752. book1 = author.bookwithcustompk_set.get()
  753. self.assertEqual(book1.title, "Les Fleurs du Mal")
  754. def test_inline_formsets_with_multi_table_inheritance(self):
  755. # Test inline formsets where the inline-edited object uses multi-table
  756. # inheritance, thus has a non AutoField yet auto-created primary key.
  757. AuthorBooksFormSet3 = inlineformset_factory(
  758. Author, AlternateBook, can_delete=False, extra=1, fields="__all__"
  759. )
  760. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  761. formset = AuthorBooksFormSet3(instance=author)
  762. self.assertEqual(len(formset.forms), 1)
  763. self.assertHTMLEqual(
  764. formset.forms[0].as_p(),
  765. '<p><label for="id_alternatebook_set-0-title">Title:</label>'
  766. '<input id="id_alternatebook_set-0-title" type="text" '
  767. 'name="alternatebook_set-0-title" maxlength="100"></p>'
  768. '<p><label for="id_alternatebook_set-0-notes">Notes:</label>'
  769. '<input id="id_alternatebook_set-0-notes" type="text" '
  770. 'name="alternatebook_set-0-notes" maxlength="100">'
  771. '<input type="hidden" name="alternatebook_set-0-author" value="1" '
  772. 'id="id_alternatebook_set-0-author">'
  773. '<input type="hidden" name="alternatebook_set-0-book_ptr" '
  774. 'id="id_alternatebook_set-0-book_ptr"></p>',
  775. )
  776. data = {
  777. # The number of forms rendered.
  778. "alternatebook_set-TOTAL_FORMS": "1",
  779. # The number of forms with initial data.
  780. "alternatebook_set-INITIAL_FORMS": "0",
  781. # The max number of forms.
  782. "alternatebook_set-MAX_NUM_FORMS": "",
  783. "alternatebook_set-0-title": "Flowers of Evil",
  784. "alternatebook_set-0-notes": "English translation of Les Fleurs du Mal",
  785. }
  786. formset = AuthorBooksFormSet3(data, instance=author)
  787. self.assertTrue(formset.is_valid())
  788. saved = formset.save()
  789. self.assertEqual(len(saved), 1)
  790. (book1,) = saved
  791. self.assertEqual(book1.title, "Flowers of Evil")
  792. self.assertEqual(book1.notes, "English translation of Les Fleurs du Mal")
  793. @skipUnlessDBFeature("supports_partially_nullable_unique_constraints")
  794. def test_inline_formsets_with_nullable_unique_together(self):
  795. # Test inline formsets where the inline-edited object has a
  796. # unique_together constraint with a nullable member
  797. AuthorBooksFormSet4 = inlineformset_factory(
  798. Author,
  799. BookWithOptionalAltEditor,
  800. can_delete=False,
  801. extra=2,
  802. fields="__all__",
  803. )
  804. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  805. data = {
  806. # The number of forms rendered.
  807. "bookwithoptionalalteditor_set-TOTAL_FORMS": "2",
  808. # The number of forms with initial data.
  809. "bookwithoptionalalteditor_set-INITIAL_FORMS": "0",
  810. # The max number of forms.
  811. "bookwithoptionalalteditor_set-MAX_NUM_FORMS": "",
  812. "bookwithoptionalalteditor_set-0-author": "1",
  813. "bookwithoptionalalteditor_set-0-title": "Les Fleurs du Mal",
  814. "bookwithoptionalalteditor_set-1-author": "1",
  815. "bookwithoptionalalteditor_set-1-title": "Les Fleurs du Mal",
  816. }
  817. formset = AuthorBooksFormSet4(data, instance=author)
  818. self.assertTrue(formset.is_valid())
  819. saved = formset.save()
  820. self.assertEqual(len(saved), 2)
  821. book1, book2 = saved
  822. self.assertEqual(book1.author_id, 1)
  823. self.assertEqual(book1.title, "Les Fleurs du Mal")
  824. self.assertEqual(book2.author_id, 1)
  825. self.assertEqual(book2.title, "Les Fleurs du Mal")
  826. def test_inline_formsets_with_custom_save_method(self):
  827. AuthorBooksFormSet = inlineformset_factory(
  828. Author, Book, can_delete=False, extra=2, fields="__all__"
  829. )
  830. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  831. book1 = Book.objects.create(
  832. pk=1, author=author, title="Les Paradis Artificiels"
  833. )
  834. book2 = Book.objects.create(pk=2, author=author, title="Les Fleurs du Mal")
  835. book3 = Book.objects.create(pk=3, author=author, title="Flowers of Evil")
  836. class PoemForm(forms.ModelForm):
  837. def save(self, commit=True):
  838. # change the name to "Brooklyn Bridge" just to be a jerk.
  839. poem = super().save(commit=False)
  840. poem.name = "Brooklyn Bridge"
  841. if commit:
  842. poem.save()
  843. return poem
  844. PoemFormSet = inlineformset_factory(Poet, Poem, form=PoemForm, fields="__all__")
  845. data = {
  846. "poem_set-TOTAL_FORMS": "3", # the number of forms rendered
  847. "poem_set-INITIAL_FORMS": "0", # the number of forms with initial data
  848. "poem_set-MAX_NUM_FORMS": "", # the max number of forms
  849. "poem_set-0-name": "The Cloud in Trousers",
  850. "poem_set-1-name": "I",
  851. "poem_set-2-name": "",
  852. }
  853. poet = Poet.objects.create(name="Vladimir Mayakovsky")
  854. formset = PoemFormSet(data=data, instance=poet)
  855. self.assertTrue(formset.is_valid())
  856. saved = formset.save()
  857. self.assertEqual(len(saved), 2)
  858. poem1, poem2 = saved
  859. self.assertEqual(poem1.name, "Brooklyn Bridge")
  860. self.assertEqual(poem2.name, "Brooklyn Bridge")
  861. # We can provide a custom queryset to our InlineFormSet:
  862. custom_qs = Book.objects.order_by("-title")
  863. formset = AuthorBooksFormSet(instance=author, queryset=custom_qs)
  864. self.assertEqual(len(formset.forms), 5)
  865. self.assertHTMLEqual(
  866. formset.forms[0].as_p(),
  867. '<p><label for="id_book_set-0-title">Title:</label>'
  868. '<input id="id_book_set-0-title" type="text" name="book_set-0-title" '
  869. 'value="Les Paradis Artificiels" maxlength="100">'
  870. '<input type="hidden" name="book_set-0-author" value="1" '
  871. 'id="id_book_set-0-author">'
  872. '<input type="hidden" name="book_set-0-id" value="1" id="id_book_set-0-id">'
  873. "</p>",
  874. )
  875. self.assertHTMLEqual(
  876. formset.forms[1].as_p(),
  877. '<p><label for="id_book_set-1-title">Title:</label>'
  878. '<input id="id_book_set-1-title" type="text" name="book_set-1-title" '
  879. 'value="Les Fleurs du Mal" maxlength="100">'
  880. '<input type="hidden" name="book_set-1-author" value="1" '
  881. 'id="id_book_set-1-author">'
  882. '<input type="hidden" name="book_set-1-id" value="2" id="id_book_set-1-id">'
  883. "</p>",
  884. )
  885. self.assertHTMLEqual(
  886. formset.forms[2].as_p(),
  887. '<p><label for="id_book_set-2-title">Title:</label>'
  888. '<input id="id_book_set-2-title" type="text" name="book_set-2-title" '
  889. 'value="Flowers of Evil" maxlength="100">'
  890. '<input type="hidden" name="book_set-2-author" value="1" '
  891. 'id="id_book_set-2-author">'
  892. '<input type="hidden" name="book_set-2-id" value="3" '
  893. 'id="id_book_set-2-id"></p>',
  894. )
  895. self.assertHTMLEqual(
  896. formset.forms[3].as_p(),
  897. '<p><label for="id_book_set-3-title">Title:</label>'
  898. '<input id="id_book_set-3-title" type="text" name="book_set-3-title" '
  899. 'maxlength="100">'
  900. '<input type="hidden" name="book_set-3-author" value="1" '
  901. 'id="id_book_set-3-author">'
  902. '<input type="hidden" name="book_set-3-id" id="id_book_set-3-id"></p>',
  903. )
  904. self.assertHTMLEqual(
  905. formset.forms[4].as_p(),
  906. '<p><label for="id_book_set-4-title">Title:</label>'
  907. '<input id="id_book_set-4-title" type="text" name="book_set-4-title" '
  908. 'maxlength="100">'
  909. '<input type="hidden" name="book_set-4-author" value="1" '
  910. 'id="id_book_set-4-author">'
  911. '<input type="hidden" name="book_set-4-id" id="id_book_set-4-id"></p>',
  912. )
  913. data = {
  914. "book_set-TOTAL_FORMS": "5", # the number of forms rendered
  915. "book_set-INITIAL_FORMS": "3", # the number of forms with initial data
  916. "book_set-MAX_NUM_FORMS": "", # the max number of forms
  917. "book_set-0-id": str(book1.id),
  918. "book_set-0-title": "Les Paradis Artificiels",
  919. "book_set-1-id": str(book2.id),
  920. "book_set-1-title": "Les Fleurs du Mal",
  921. "book_set-2-id": str(book3.id),
  922. "book_set-2-title": "Flowers of Evil",
  923. "book_set-3-title": "Revue des deux mondes",
  924. "book_set-4-title": "",
  925. }
  926. formset = AuthorBooksFormSet(data, instance=author, queryset=custom_qs)
  927. self.assertTrue(formset.is_valid())
  928. custom_qs = Book.objects.filter(title__startswith="F")
  929. formset = AuthorBooksFormSet(instance=author, queryset=custom_qs)
  930. self.assertHTMLEqual(
  931. formset.forms[0].as_p(),
  932. '<p><label for="id_book_set-0-title">Title:</label>'
  933. '<input id="id_book_set-0-title" type="text" name="book_set-0-title" '
  934. 'value="Flowers of Evil" maxlength="100">'
  935. '<input type="hidden" name="book_set-0-author" value="1" '
  936. 'id="id_book_set-0-author">'
  937. '<input type="hidden" name="book_set-0-id" value="3" '
  938. 'id="id_book_set-0-id"></p>',
  939. )
  940. self.assertHTMLEqual(
  941. formset.forms[1].as_p(),
  942. '<p><label for="id_book_set-1-title">Title:</label>'
  943. '<input id="id_book_set-1-title" type="text" name="book_set-1-title" '
  944. 'maxlength="100">'
  945. '<input type="hidden" name="book_set-1-author" value="1" '
  946. 'id="id_book_set-1-author">'
  947. '<input type="hidden" name="book_set-1-id" id="id_book_set-1-id"></p>',
  948. )
  949. self.assertHTMLEqual(
  950. formset.forms[2].as_p(),
  951. '<p><label for="id_book_set-2-title">Title:</label>'
  952. '<input id="id_book_set-2-title" type="text" name="book_set-2-title" '
  953. 'maxlength="100">'
  954. '<input type="hidden" name="book_set-2-author" value="1" '
  955. 'id="id_book_set-2-author">'
  956. '<input type="hidden" name="book_set-2-id" id="id_book_set-2-id"></p>',
  957. )
  958. data = {
  959. "book_set-TOTAL_FORMS": "3", # the number of forms rendered
  960. "book_set-INITIAL_FORMS": "1", # the number of forms with initial data
  961. "book_set-MAX_NUM_FORMS": "", # the max number of forms
  962. "book_set-0-id": str(book3.id),
  963. "book_set-0-title": "Flowers of Evil",
  964. "book_set-1-title": "Revue des deux mondes",
  965. "book_set-2-title": "",
  966. }
  967. formset = AuthorBooksFormSet(data, instance=author, queryset=custom_qs)
  968. self.assertTrue(formset.is_valid())
  969. def test_inline_formsets_with_custom_save_method_related_instance(self):
  970. """
  971. The ModelForm.save() method should be able to access the related object
  972. if it exists in the database (#24395).
  973. """
  974. class PoemForm2(forms.ModelForm):
  975. def save(self, commit=True):
  976. poem = super().save(commit=False)
  977. poem.name = "%s by %s" % (poem.name, poem.poet.name)
  978. if commit:
  979. poem.save()
  980. return poem
  981. PoemFormSet = inlineformset_factory(
  982. Poet, Poem, form=PoemForm2, fields="__all__"
  983. )
  984. data = {
  985. "poem_set-TOTAL_FORMS": "1",
  986. "poem_set-INITIAL_FORMS": "0",
  987. "poem_set-MAX_NUM_FORMS": "",
  988. "poem_set-0-name": "Le Lac",
  989. }
  990. poet = Poet()
  991. formset = PoemFormSet(data=data, instance=poet)
  992. self.assertTrue(formset.is_valid())
  993. # The Poet instance is saved after the formset instantiation. This
  994. # happens in admin's changeform_view() when adding a new object and
  995. # some inlines in the same request.
  996. poet.name = "Lamartine"
  997. poet.save()
  998. poem = formset.save()[0]
  999. self.assertEqual(poem.name, "Le Lac by Lamartine")
  1000. def test_inline_formsets_with_wrong_fk_name(self):
  1001. """Regression for #23451"""
  1002. message = "fk_name 'title' is not a ForeignKey to 'model_formsets.Author'."
  1003. with self.assertRaisesMessage(ValueError, message):
  1004. inlineformset_factory(Author, Book, fields="__all__", fk_name="title")
  1005. def test_custom_pk(self):
  1006. # We need to ensure that it is displayed
  1007. CustomPrimaryKeyFormSet = modelformset_factory(
  1008. CustomPrimaryKey, fields="__all__"
  1009. )
  1010. formset = CustomPrimaryKeyFormSet()
  1011. self.assertEqual(len(formset.forms), 1)
  1012. self.assertHTMLEqual(
  1013. formset.forms[0].as_p(),
  1014. '<p><label for="id_form-0-my_pk">My pk:</label>'
  1015. '<input id="id_form-0-my_pk" type="text" name="form-0-my_pk" '
  1016. 'maxlength="10"></p>'
  1017. '<p><label for="id_form-0-some_field">Some field:</label>'
  1018. '<input id="id_form-0-some_field" type="text" name="form-0-some_field" '
  1019. 'maxlength="100"></p>',
  1020. )
  1021. # Custom primary keys with ForeignKey, OneToOneField and AutoField ############
  1022. place = Place.objects.create(pk=1, name="Giordanos", city="Chicago")
  1023. FormSet = inlineformset_factory(
  1024. Place, Owner, extra=2, can_delete=False, fields="__all__"
  1025. )
  1026. formset = FormSet(instance=place)
  1027. self.assertEqual(len(formset.forms), 2)
  1028. self.assertHTMLEqual(
  1029. formset.forms[0].as_p(),
  1030. '<p><label for="id_owner_set-0-name">Name:</label>'
  1031. '<input id="id_owner_set-0-name" type="text" name="owner_set-0-name" '
  1032. 'maxlength="100">'
  1033. '<input type="hidden" name="owner_set-0-place" value="1" '
  1034. 'id="id_owner_set-0-place">'
  1035. '<input type="hidden" name="owner_set-0-auto_id" '
  1036. 'id="id_owner_set-0-auto_id"></p>',
  1037. )
  1038. self.assertHTMLEqual(
  1039. formset.forms[1].as_p(),
  1040. '<p><label for="id_owner_set-1-name">Name:</label>'
  1041. '<input id="id_owner_set-1-name" type="text" name="owner_set-1-name" '
  1042. 'maxlength="100">'
  1043. '<input type="hidden" name="owner_set-1-place" value="1" '
  1044. 'id="id_owner_set-1-place">'
  1045. '<input type="hidden" name="owner_set-1-auto_id" '
  1046. 'id="id_owner_set-1-auto_id"></p>',
  1047. )
  1048. data = {
  1049. "owner_set-TOTAL_FORMS": "2",
  1050. "owner_set-INITIAL_FORMS": "0",
  1051. "owner_set-MAX_NUM_FORMS": "",
  1052. "owner_set-0-auto_id": "",
  1053. "owner_set-0-name": "Joe Perry",
  1054. "owner_set-1-auto_id": "",
  1055. "owner_set-1-name": "",
  1056. }
  1057. formset = FormSet(data, instance=place)
  1058. self.assertTrue(formset.is_valid())
  1059. saved = formset.save()
  1060. self.assertEqual(len(saved), 1)
  1061. (owner1,) = saved
  1062. self.assertEqual(owner1.name, "Joe Perry")
  1063. self.assertEqual(owner1.place.name, "Giordanos")
  1064. formset = FormSet(instance=place)
  1065. self.assertEqual(len(formset.forms), 3)
  1066. self.assertHTMLEqual(
  1067. formset.forms[0].as_p(),
  1068. '<p><label for="id_owner_set-0-name">Name:</label>'
  1069. '<input id="id_owner_set-0-name" type="text" name="owner_set-0-name" '
  1070. 'value="Joe Perry" maxlength="100">'
  1071. '<input type="hidden" name="owner_set-0-place" value="1" '
  1072. 'id="id_owner_set-0-place">'
  1073. '<input type="hidden" name="owner_set-0-auto_id" value="%d" '
  1074. 'id="id_owner_set-0-auto_id"></p>' % owner1.auto_id,
  1075. )
  1076. self.assertHTMLEqual(
  1077. formset.forms[1].as_p(),
  1078. '<p><label for="id_owner_set-1-name">Name:</label>'
  1079. '<input id="id_owner_set-1-name" type="text" name="owner_set-1-name" '
  1080. 'maxlength="100">'
  1081. '<input type="hidden" name="owner_set-1-place" value="1" '
  1082. 'id="id_owner_set-1-place">'
  1083. '<input type="hidden" name="owner_set-1-auto_id" '
  1084. 'id="id_owner_set-1-auto_id"></p>',
  1085. )
  1086. self.assertHTMLEqual(
  1087. formset.forms[2].as_p(),
  1088. '<p><label for="id_owner_set-2-name">Name:</label>'
  1089. '<input id="id_owner_set-2-name" type="text" name="owner_set-2-name" '
  1090. 'maxlength="100">'
  1091. '<input type="hidden" name="owner_set-2-place" value="1" '
  1092. 'id="id_owner_set-2-place">'
  1093. '<input type="hidden" name="owner_set-2-auto_id" '
  1094. 'id="id_owner_set-2-auto_id"></p>',
  1095. )
  1096. data = {
  1097. "owner_set-TOTAL_FORMS": "3",
  1098. "owner_set-INITIAL_FORMS": "1",
  1099. "owner_set-MAX_NUM_FORMS": "",
  1100. "owner_set-0-auto_id": str(owner1.auto_id),
  1101. "owner_set-0-name": "Joe Perry",
  1102. "owner_set-1-auto_id": "",
  1103. "owner_set-1-name": "Jack Berry",
  1104. "owner_set-2-auto_id": "",
  1105. "owner_set-2-name": "",
  1106. }
  1107. formset = FormSet(data, instance=place)
  1108. self.assertTrue(formset.is_valid())
  1109. saved = formset.save()
  1110. self.assertEqual(len(saved), 1)
  1111. (owner2,) = saved
  1112. self.assertEqual(owner2.name, "Jack Berry")
  1113. self.assertEqual(owner2.place.name, "Giordanos")
  1114. # A custom primary key that is a ForeignKey or OneToOneField get
  1115. # rendered for the user to choose.
  1116. FormSet = modelformset_factory(OwnerProfile, fields="__all__")
  1117. formset = FormSet()
  1118. self.assertHTMLEqual(
  1119. formset.forms[0].as_p(),
  1120. '<p><label for="id_form-0-owner">Owner:</label>'
  1121. '<select name="form-0-owner" id="id_form-0-owner">'
  1122. '<option value="" selected>---------</option>'
  1123. '<option value="%d">Joe Perry at Giordanos</option>'
  1124. '<option value="%d">Jack Berry at Giordanos</option>'
  1125. "</select></p>"
  1126. '<p><label for="id_form-0-age">Age:</label>'
  1127. '<input type="number" name="form-0-age" id="id_form-0-age" min="0"></p>'
  1128. % (owner1.auto_id, owner2.auto_id),
  1129. )
  1130. owner1 = Owner.objects.get(name="Joe Perry")
  1131. FormSet = inlineformset_factory(
  1132. Owner, OwnerProfile, max_num=1, can_delete=False, fields="__all__"
  1133. )
  1134. self.assertEqual(FormSet.max_num, 1)
  1135. formset = FormSet(instance=owner1)
  1136. self.assertEqual(len(formset.forms), 1)
  1137. self.assertHTMLEqual(
  1138. formset.forms[0].as_p(),
  1139. '<p><label for="id_ownerprofile-0-age">Age:</label>'
  1140. '<input type="number" name="ownerprofile-0-age" '
  1141. 'id="id_ownerprofile-0-age" min="0">'
  1142. '<input type="hidden" name="ownerprofile-0-owner" value="%d" '
  1143. 'id="id_ownerprofile-0-owner"></p>' % owner1.auto_id,
  1144. )
  1145. data = {
  1146. "ownerprofile-TOTAL_FORMS": "1",
  1147. "ownerprofile-INITIAL_FORMS": "0",
  1148. "ownerprofile-MAX_NUM_FORMS": "1",
  1149. "ownerprofile-0-owner": "",
  1150. "ownerprofile-0-age": "54",
  1151. }
  1152. formset = FormSet(data, instance=owner1)
  1153. self.assertTrue(formset.is_valid())
  1154. saved = formset.save()
  1155. self.assertEqual(len(saved), 1)
  1156. (profile1,) = saved
  1157. self.assertEqual(profile1.owner, owner1)
  1158. self.assertEqual(profile1.age, 54)
  1159. formset = FormSet(instance=owner1)
  1160. self.assertEqual(len(formset.forms), 1)
  1161. self.assertHTMLEqual(
  1162. formset.forms[0].as_p(),
  1163. '<p><label for="id_ownerprofile-0-age">Age:</label>'
  1164. '<input type="number" name="ownerprofile-0-age" value="54" '
  1165. 'id="id_ownerprofile-0-age" min="0">'
  1166. '<input type="hidden" name="ownerprofile-0-owner" value="%d" '
  1167. 'id="id_ownerprofile-0-owner"></p>' % owner1.auto_id,
  1168. )
  1169. data = {
  1170. "ownerprofile-TOTAL_FORMS": "1",
  1171. "ownerprofile-INITIAL_FORMS": "1",
  1172. "ownerprofile-MAX_NUM_FORMS": "1",
  1173. "ownerprofile-0-owner": str(owner1.auto_id),
  1174. "ownerprofile-0-age": "55",
  1175. }
  1176. formset = FormSet(data, instance=owner1)
  1177. self.assertTrue(formset.is_valid())
  1178. saved = formset.save()
  1179. self.assertEqual(len(saved), 1)
  1180. (profile1,) = saved
  1181. self.assertEqual(profile1.owner, owner1)
  1182. self.assertEqual(profile1.age, 55)
  1183. def test_unique_true_enforces_max_num_one(self):
  1184. # ForeignKey with unique=True should enforce max_num=1
  1185. place = Place.objects.create(pk=1, name="Giordanos", city="Chicago")
  1186. FormSet = inlineformset_factory(
  1187. Place, Location, can_delete=False, fields="__all__"
  1188. )
  1189. self.assertEqual(FormSet.max_num, 1)
  1190. formset = FormSet(instance=place)
  1191. self.assertEqual(len(formset.forms), 1)
  1192. self.assertHTMLEqual(
  1193. formset.forms[0].as_p(),
  1194. '<p><label for="id_location_set-0-lat">Lat:</label>'
  1195. '<input id="id_location_set-0-lat" type="text" name="location_set-0-lat" '
  1196. 'maxlength="100"></p>'
  1197. '<p><label for="id_location_set-0-lon">Lon:</label>'
  1198. '<input id="id_location_set-0-lon" type="text" name="location_set-0-lon" '
  1199. 'maxlength="100">'
  1200. '<input type="hidden" name="location_set-0-place" value="1" '
  1201. 'id="id_location_set-0-place">'
  1202. '<input type="hidden" name="location_set-0-id" '
  1203. 'id="id_location_set-0-id"></p>',
  1204. )
  1205. def test_foreign_keys_in_parents(self):
  1206. self.assertEqual(type(_get_foreign_key(Restaurant, Owner)), models.ForeignKey)
  1207. self.assertEqual(
  1208. type(_get_foreign_key(MexicanRestaurant, Owner)), models.ForeignKey
  1209. )
  1210. def test_unique_validation(self):
  1211. FormSet = modelformset_factory(Product, fields="__all__", extra=1)
  1212. data = {
  1213. "form-TOTAL_FORMS": "1",
  1214. "form-INITIAL_FORMS": "0",
  1215. "form-MAX_NUM_FORMS": "",
  1216. "form-0-slug": "car-red",
  1217. }
  1218. formset = FormSet(data)
  1219. self.assertTrue(formset.is_valid())
  1220. saved = formset.save()
  1221. self.assertEqual(len(saved), 1)
  1222. (product1,) = saved
  1223. self.assertEqual(product1.slug, "car-red")
  1224. data = {
  1225. "form-TOTAL_FORMS": "1",
  1226. "form-INITIAL_FORMS": "0",
  1227. "form-MAX_NUM_FORMS": "",
  1228. "form-0-slug": "car-red",
  1229. }
  1230. formset = FormSet(data)
  1231. self.assertFalse(formset.is_valid())
  1232. self.assertEqual(
  1233. formset.errors, [{"slug": ["Product with this Slug already exists."]}]
  1234. )
  1235. def test_modelformset_validate_max_flag(self):
  1236. # If validate_max is set and max_num is less than TOTAL_FORMS in the
  1237. # data, then throw an exception. MAX_NUM_FORMS in the data is
  1238. # irrelevant here (it's output as a hint for the client but its
  1239. # value in the returned data is not checked)
  1240. data = {
  1241. "form-TOTAL_FORMS": "2",
  1242. "form-INITIAL_FORMS": "0",
  1243. "form-MAX_NUM_FORMS": "2", # should be ignored
  1244. "form-0-price": "12.00",
  1245. "form-0-quantity": "1",
  1246. "form-1-price": "24.00",
  1247. "form-1-quantity": "2",
  1248. }
  1249. FormSet = modelformset_factory(
  1250. Price, fields="__all__", extra=1, max_num=1, validate_max=True
  1251. )
  1252. formset = FormSet(data)
  1253. self.assertFalse(formset.is_valid())
  1254. self.assertEqual(formset.non_form_errors(), ["Please submit at most 1 form."])
  1255. # Now test the same thing without the validate_max flag to ensure
  1256. # default behavior is unchanged
  1257. FormSet = modelformset_factory(Price, fields="__all__", extra=1, max_num=1)
  1258. formset = FormSet(data)
  1259. self.assertTrue(formset.is_valid())
  1260. def test_modelformset_min_num_equals_max_num_less_than(self):
  1261. data = {
  1262. "form-TOTAL_FORMS": "3",
  1263. "form-INITIAL_FORMS": "0",
  1264. "form-MAX_NUM_FORMS": "2",
  1265. "form-0-slug": "car-red",
  1266. "form-1-slug": "car-blue",
  1267. "form-2-slug": "car-black",
  1268. }
  1269. FormSet = modelformset_factory(
  1270. Product,
  1271. fields="__all__",
  1272. extra=1,
  1273. max_num=2,
  1274. validate_max=True,
  1275. min_num=2,
  1276. validate_min=True,
  1277. )
  1278. formset = FormSet(data)
  1279. self.assertFalse(formset.is_valid())
  1280. self.assertEqual(formset.non_form_errors(), ["Please submit at most 2 forms."])
  1281. def test_modelformset_min_num_equals_max_num_more_than(self):
  1282. data = {
  1283. "form-TOTAL_FORMS": "1",
  1284. "form-INITIAL_FORMS": "0",
  1285. "form-MAX_NUM_FORMS": "2",
  1286. "form-0-slug": "car-red",
  1287. }
  1288. FormSet = modelformset_factory(
  1289. Product,
  1290. fields="__all__",
  1291. extra=1,
  1292. max_num=2,
  1293. validate_max=True,
  1294. min_num=2,
  1295. validate_min=True,
  1296. )
  1297. formset = FormSet(data)
  1298. self.assertFalse(formset.is_valid())
  1299. self.assertEqual(formset.non_form_errors(), ["Please submit at least 2 forms."])
  1300. def test_unique_together_validation(self):
  1301. FormSet = modelformset_factory(Price, fields="__all__", extra=1)
  1302. data = {
  1303. "form-TOTAL_FORMS": "1",
  1304. "form-INITIAL_FORMS": "0",
  1305. "form-MAX_NUM_FORMS": "",
  1306. "form-0-price": "12.00",
  1307. "form-0-quantity": "1",
  1308. }
  1309. formset = FormSet(data)
  1310. self.assertTrue(formset.is_valid())
  1311. saved = formset.save()
  1312. self.assertEqual(len(saved), 1)
  1313. (price1,) = saved
  1314. self.assertEqual(price1.price, Decimal("12.00"))
  1315. self.assertEqual(price1.quantity, 1)
  1316. data = {
  1317. "form-TOTAL_FORMS": "1",
  1318. "form-INITIAL_FORMS": "0",
  1319. "form-MAX_NUM_FORMS": "",
  1320. "form-0-price": "12.00",
  1321. "form-0-quantity": "1",
  1322. }
  1323. formset = FormSet(data)
  1324. self.assertFalse(formset.is_valid())
  1325. self.assertEqual(
  1326. formset.errors,
  1327. [{"__all__": ["Price with this Price and Quantity already exists."]}],
  1328. )
  1329. def test_unique_together_with_inlineformset_factory(self):
  1330. # Also see bug #8882.
  1331. repository = Repository.objects.create(name="Test Repo")
  1332. FormSet = inlineformset_factory(Repository, Revision, extra=1, fields="__all__")
  1333. data = {
  1334. "revision_set-TOTAL_FORMS": "1",
  1335. "revision_set-INITIAL_FORMS": "0",
  1336. "revision_set-MAX_NUM_FORMS": "",
  1337. "revision_set-0-repository": repository.pk,
  1338. "revision_set-0-revision": "146239817507f148d448db38840db7c3cbf47c76",
  1339. "revision_set-0-DELETE": "",
  1340. }
  1341. formset = FormSet(data, instance=repository)
  1342. self.assertTrue(formset.is_valid())
  1343. saved = formset.save()
  1344. self.assertEqual(len(saved), 1)
  1345. (revision1,) = saved
  1346. self.assertEqual(revision1.repository, repository)
  1347. self.assertEqual(revision1.revision, "146239817507f148d448db38840db7c3cbf47c76")
  1348. # attempt to save the same revision against the same repo.
  1349. data = {
  1350. "revision_set-TOTAL_FORMS": "1",
  1351. "revision_set-INITIAL_FORMS": "0",
  1352. "revision_set-MAX_NUM_FORMS": "",
  1353. "revision_set-0-repository": repository.pk,
  1354. "revision_set-0-revision": "146239817507f148d448db38840db7c3cbf47c76",
  1355. "revision_set-0-DELETE": "",
  1356. }
  1357. formset = FormSet(data, instance=repository)
  1358. self.assertFalse(formset.is_valid())
  1359. self.assertEqual(
  1360. formset.errors,
  1361. [
  1362. {
  1363. "__all__": [
  1364. "Revision with this Repository and Revision already exists."
  1365. ]
  1366. }
  1367. ],
  1368. )
  1369. # unique_together with inlineformset_factory with overridden form fields
  1370. # Also see #9494
  1371. FormSet = inlineformset_factory(
  1372. Repository, Revision, fields=("revision",), extra=1
  1373. )
  1374. data = {
  1375. "revision_set-TOTAL_FORMS": "1",
  1376. "revision_set-INITIAL_FORMS": "0",
  1377. "revision_set-MAX_NUM_FORMS": "",
  1378. "revision_set-0-repository": repository.pk,
  1379. "revision_set-0-revision": "146239817507f148d448db38840db7c3cbf47c76",
  1380. "revision_set-0-DELETE": "",
  1381. }
  1382. formset = FormSet(data, instance=repository)
  1383. self.assertFalse(formset.is_valid())
  1384. def test_callable_defaults(self):
  1385. # Use of callable defaults (see bug #7975).
  1386. person = Person.objects.create(name="Ringo")
  1387. FormSet = inlineformset_factory(
  1388. Person, Membership, can_delete=False, extra=1, fields="__all__"
  1389. )
  1390. formset = FormSet(instance=person)
  1391. # Django will render a hidden field for model fields that have a callable
  1392. # default. This is required to ensure the value is tested for change correctly
  1393. # when determine what extra forms have changed to save.
  1394. self.assertEqual(len(formset.forms), 1) # this formset only has one form
  1395. form = formset.forms[0]
  1396. now = form.fields["date_joined"].initial()
  1397. result = form.as_p()
  1398. result = re.sub(
  1399. r"[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(?:\.[0-9]+)?",
  1400. "__DATETIME__",
  1401. result,
  1402. )
  1403. self.assertHTMLEqual(
  1404. result,
  1405. '<p><label for="id_membership_set-0-date_joined">Date joined:</label>'
  1406. '<input type="text" name="membership_set-0-date_joined" '
  1407. 'value="__DATETIME__" id="id_membership_set-0-date_joined">'
  1408. '<input type="hidden" name="initial-membership_set-0-date_joined" '
  1409. 'value="__DATETIME__" '
  1410. 'id="initial-membership_set-0-id_membership_set-0-date_joined"></p>'
  1411. '<p><label for="id_membership_set-0-karma">Karma:</label>'
  1412. '<input type="number" name="membership_set-0-karma" '
  1413. 'id="id_membership_set-0-karma">'
  1414. '<input type="hidden" name="membership_set-0-person" value="%d" '
  1415. 'id="id_membership_set-0-person">'
  1416. '<input type="hidden" name="membership_set-0-id" '
  1417. 'id="id_membership_set-0-id"></p>' % person.id,
  1418. )
  1419. # test for validation with callable defaults. Validations rely on hidden fields
  1420. data = {
  1421. "membership_set-TOTAL_FORMS": "1",
  1422. "membership_set-INITIAL_FORMS": "0",
  1423. "membership_set-MAX_NUM_FORMS": "",
  1424. "membership_set-0-date_joined": now.strftime("%Y-%m-%d %H:%M:%S"),
  1425. "initial-membership_set-0-date_joined": now.strftime("%Y-%m-%d %H:%M:%S"),
  1426. "membership_set-0-karma": "",
  1427. }
  1428. formset = FormSet(data, instance=person)
  1429. self.assertTrue(formset.is_valid())
  1430. # now test for when the data changes
  1431. one_day_later = now + datetime.timedelta(days=1)
  1432. filled_data = {
  1433. "membership_set-TOTAL_FORMS": "1",
  1434. "membership_set-INITIAL_FORMS": "0",
  1435. "membership_set-MAX_NUM_FORMS": "",
  1436. "membership_set-0-date_joined": one_day_later.strftime("%Y-%m-%d %H:%M:%S"),
  1437. "initial-membership_set-0-date_joined": now.strftime("%Y-%m-%d %H:%M:%S"),
  1438. "membership_set-0-karma": "",
  1439. }
  1440. formset = FormSet(filled_data, instance=person)
  1441. self.assertFalse(formset.is_valid())
  1442. # now test with split datetime fields
  1443. class MembershipForm(forms.ModelForm):
  1444. date_joined = forms.SplitDateTimeField(initial=now)
  1445. class Meta:
  1446. model = Membership
  1447. fields = "__all__"
  1448. def __init__(self, **kwargs):
  1449. super().__init__(**kwargs)
  1450. self.fields["date_joined"].widget = forms.SplitDateTimeWidget()
  1451. FormSet = inlineformset_factory(
  1452. Person,
  1453. Membership,
  1454. form=MembershipForm,
  1455. can_delete=False,
  1456. extra=1,
  1457. fields="__all__",
  1458. )
  1459. data = {
  1460. "membership_set-TOTAL_FORMS": "1",
  1461. "membership_set-INITIAL_FORMS": "0",
  1462. "membership_set-MAX_NUM_FORMS": "",
  1463. "membership_set-0-date_joined_0": now.strftime("%Y-%m-%d"),
  1464. "membership_set-0-date_joined_1": now.strftime("%H:%M:%S"),
  1465. "initial-membership_set-0-date_joined": now.strftime("%Y-%m-%d %H:%M:%S"),
  1466. "membership_set-0-karma": "",
  1467. }
  1468. formset = FormSet(data, instance=person)
  1469. self.assertTrue(formset.is_valid())
  1470. def test_inlineformset_factory_with_null_fk(self):
  1471. # inlineformset_factory tests with fk having null=True. see #9462.
  1472. # create some data that will exhibit the issue
  1473. team = Team.objects.create(name="Red Vipers")
  1474. Player(name="Timmy").save()
  1475. Player(name="Bobby", team=team).save()
  1476. PlayerInlineFormSet = inlineformset_factory(Team, Player, fields="__all__")
  1477. formset = PlayerInlineFormSet()
  1478. self.assertQuerySetEqual(formset.get_queryset(), [])
  1479. formset = PlayerInlineFormSet(instance=team)
  1480. players = formset.get_queryset()
  1481. self.assertEqual(len(players), 1)
  1482. (player1,) = players
  1483. self.assertEqual(player1.team, team)
  1484. self.assertEqual(player1.name, "Bobby")
  1485. def test_inlineformset_with_arrayfield(self):
  1486. class SimpleArrayField(forms.CharField):
  1487. """A proxy for django.contrib.postgres.forms.SimpleArrayField."""
  1488. def to_python(self, value):
  1489. value = super().to_python(value)
  1490. return value.split(",") if value else []
  1491. class BookForm(forms.ModelForm):
  1492. title = SimpleArrayField()
  1493. class Meta:
  1494. model = Book
  1495. fields = ("title",)
  1496. BookFormSet = inlineformset_factory(Author, Book, form=BookForm)
  1497. data = {
  1498. "book_set-TOTAL_FORMS": "3",
  1499. "book_set-INITIAL_FORMS": "0",
  1500. "book_set-MAX_NUM_FORMS": "",
  1501. "book_set-0-title": "test1,test2",
  1502. "book_set-1-title": "test1,test2",
  1503. "book_set-2-title": "test3,test4",
  1504. }
  1505. author = Author.objects.create(name="test")
  1506. formset = BookFormSet(data, instance=author)
  1507. self.assertEqual(
  1508. formset.errors,
  1509. [{}, {"__all__": ["Please correct the duplicate values below."]}, {}],
  1510. )
  1511. def test_model_formset_with_custom_pk(self):
  1512. # a formset for a Model that has a custom primary key that still needs to be
  1513. # added to the formset automatically
  1514. FormSet = modelformset_factory(
  1515. ClassyMexicanRestaurant, fields=["tacos_are_yummy"]
  1516. )
  1517. self.assertEqual(
  1518. sorted(FormSet().forms[0].fields), ["tacos_are_yummy", "the_restaurant"]
  1519. )
  1520. def test_model_formset_with_initial_model_instance(self):
  1521. # has_changed should compare model instance and primary key
  1522. # see #18898
  1523. FormSet = modelformset_factory(Poem, fields="__all__")
  1524. john_milton = Poet(name="John Milton")
  1525. john_milton.save()
  1526. data = {
  1527. "form-TOTAL_FORMS": 1,
  1528. "form-INITIAL_FORMS": 0,
  1529. "form-MAX_NUM_FORMS": "",
  1530. "form-0-name": "",
  1531. "form-0-poet": str(john_milton.id),
  1532. }
  1533. formset = FormSet(initial=[{"poet": john_milton}], data=data)
  1534. self.assertFalse(formset.extra_forms[0].has_changed())
  1535. def test_model_formset_with_initial_queryset(self):
  1536. # has_changed should work with queryset and list of pk's
  1537. # see #18898
  1538. FormSet = modelformset_factory(AuthorMeeting, fields="__all__")
  1539. Author.objects.create(pk=1, name="Charles Baudelaire")
  1540. data = {
  1541. "form-TOTAL_FORMS": 1,
  1542. "form-INITIAL_FORMS": 0,
  1543. "form-MAX_NUM_FORMS": "",
  1544. "form-0-name": "",
  1545. "form-0-created": "",
  1546. "form-0-authors": list(Author.objects.values_list("id", flat=True)),
  1547. }
  1548. formset = FormSet(initial=[{"authors": Author.objects.all()}], data=data)
  1549. self.assertFalse(formset.extra_forms[0].has_changed())
  1550. def test_prevent_duplicates_from_with_the_same_formset(self):
  1551. FormSet = modelformset_factory(Product, fields="__all__", extra=2)
  1552. data = {
  1553. "form-TOTAL_FORMS": 2,
  1554. "form-INITIAL_FORMS": 0,
  1555. "form-MAX_NUM_FORMS": "",
  1556. "form-0-slug": "red_car",
  1557. "form-1-slug": "red_car",
  1558. }
  1559. formset = FormSet(data)
  1560. self.assertFalse(formset.is_valid())
  1561. self.assertEqual(
  1562. formset._non_form_errors, ["Please correct the duplicate data for slug."]
  1563. )
  1564. FormSet = modelformset_factory(Price, fields="__all__", extra=2)
  1565. data = {
  1566. "form-TOTAL_FORMS": 2,
  1567. "form-INITIAL_FORMS": 0,
  1568. "form-MAX_NUM_FORMS": "",
  1569. "form-0-price": "25",
  1570. "form-0-quantity": "7",
  1571. "form-1-price": "25",
  1572. "form-1-quantity": "7",
  1573. }
  1574. formset = FormSet(data)
  1575. self.assertFalse(formset.is_valid())
  1576. self.assertEqual(
  1577. formset._non_form_errors,
  1578. [
  1579. "Please correct the duplicate data for price and quantity, which must "
  1580. "be unique."
  1581. ],
  1582. )
  1583. # Only the price field is specified, this should skip any unique
  1584. # checks since the unique_together is not fulfilled. This will fail
  1585. # with a KeyError if broken.
  1586. FormSet = modelformset_factory(Price, fields=("price",), extra=2)
  1587. data = {
  1588. "form-TOTAL_FORMS": "2",
  1589. "form-INITIAL_FORMS": "0",
  1590. "form-MAX_NUM_FORMS": "",
  1591. "form-0-price": "24",
  1592. "form-1-price": "24",
  1593. }
  1594. formset = FormSet(data)
  1595. self.assertTrue(formset.is_valid())
  1596. FormSet = inlineformset_factory(Author, Book, extra=0, fields="__all__")
  1597. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  1598. Book.objects.create(pk=1, author=author, title="Les Paradis Artificiels")
  1599. Book.objects.create(pk=2, author=author, title="Les Fleurs du Mal")
  1600. Book.objects.create(pk=3, author=author, title="Flowers of Evil")
  1601. book_ids = author.book_set.order_by("id").values_list("id", flat=True)
  1602. data = {
  1603. "book_set-TOTAL_FORMS": "2",
  1604. "book_set-INITIAL_FORMS": "2",
  1605. "book_set-MAX_NUM_FORMS": "",
  1606. "book_set-0-title": "The 2008 Election",
  1607. "book_set-0-author": str(author.id),
  1608. "book_set-0-id": str(book_ids[0]),
  1609. "book_set-1-title": "The 2008 Election",
  1610. "book_set-1-author": str(author.id),
  1611. "book_set-1-id": str(book_ids[1]),
  1612. }
  1613. formset = FormSet(data=data, instance=author)
  1614. self.assertFalse(formset.is_valid())
  1615. self.assertEqual(
  1616. formset._non_form_errors, ["Please correct the duplicate data for title."]
  1617. )
  1618. self.assertEqual(
  1619. formset.errors,
  1620. [{}, {"__all__": ["Please correct the duplicate values below."]}],
  1621. )
  1622. FormSet = modelformset_factory(Post, fields="__all__", extra=2)
  1623. data = {
  1624. "form-TOTAL_FORMS": "2",
  1625. "form-INITIAL_FORMS": "0",
  1626. "form-MAX_NUM_FORMS": "",
  1627. "form-0-title": "blah",
  1628. "form-0-slug": "Morning",
  1629. "form-0-subtitle": "foo",
  1630. "form-0-posted": "2009-01-01",
  1631. "form-1-title": "blah",
  1632. "form-1-slug": "Morning in Prague",
  1633. "form-1-subtitle": "rawr",
  1634. "form-1-posted": "2009-01-01",
  1635. }
  1636. formset = FormSet(data)
  1637. self.assertFalse(formset.is_valid())
  1638. self.assertEqual(
  1639. formset._non_form_errors,
  1640. [
  1641. "Please correct the duplicate data for title which must be unique for "
  1642. "the date in posted."
  1643. ],
  1644. )
  1645. self.assertEqual(
  1646. formset.errors,
  1647. [{}, {"__all__": ["Please correct the duplicate values below."]}],
  1648. )
  1649. data = {
  1650. "form-TOTAL_FORMS": "2",
  1651. "form-INITIAL_FORMS": "0",
  1652. "form-MAX_NUM_FORMS": "",
  1653. "form-0-title": "foo",
  1654. "form-0-slug": "Morning in Prague",
  1655. "form-0-subtitle": "foo",
  1656. "form-0-posted": "2009-01-01",
  1657. "form-1-title": "blah",
  1658. "form-1-slug": "Morning in Prague",
  1659. "form-1-subtitle": "rawr",
  1660. "form-1-posted": "2009-08-02",
  1661. }
  1662. formset = FormSet(data)
  1663. self.assertFalse(formset.is_valid())
  1664. self.assertEqual(
  1665. formset._non_form_errors,
  1666. [
  1667. "Please correct the duplicate data for slug which must be unique for "
  1668. "the year in posted."
  1669. ],
  1670. )
  1671. data = {
  1672. "form-TOTAL_FORMS": "2",
  1673. "form-INITIAL_FORMS": "0",
  1674. "form-MAX_NUM_FORMS": "",
  1675. "form-0-title": "foo",
  1676. "form-0-slug": "Morning in Prague",
  1677. "form-0-subtitle": "rawr",
  1678. "form-0-posted": "2008-08-01",
  1679. "form-1-title": "blah",
  1680. "form-1-slug": "Prague",
  1681. "form-1-subtitle": "rawr",
  1682. "form-1-posted": "2009-08-02",
  1683. }
  1684. formset = FormSet(data)
  1685. self.assertFalse(formset.is_valid())
  1686. self.assertEqual(
  1687. formset._non_form_errors,
  1688. [
  1689. "Please correct the duplicate data for subtitle which must be unique "
  1690. "for the month in posted."
  1691. ],
  1692. )
  1693. def test_prevent_change_outer_model_and_create_invalid_data(self):
  1694. author = Author.objects.create(name="Charles")
  1695. other_author = Author.objects.create(name="Walt")
  1696. AuthorFormSet = modelformset_factory(Author, fields="__all__")
  1697. data = {
  1698. "form-TOTAL_FORMS": "2",
  1699. "form-INITIAL_FORMS": "2",
  1700. "form-MAX_NUM_FORMS": "",
  1701. "form-0-id": str(author.id),
  1702. "form-0-name": "Charles",
  1703. "form-1-id": str(other_author.id), # A model not in the formset's queryset.
  1704. "form-1-name": "Changed name",
  1705. }
  1706. # This formset is only for Walt Whitman and shouldn't accept data for
  1707. # other_author.
  1708. formset = AuthorFormSet(
  1709. data=data, queryset=Author.objects.filter(id__in=(author.id,))
  1710. )
  1711. self.assertTrue(formset.is_valid())
  1712. formset.save()
  1713. # The name of other_author shouldn't be changed and new models aren't
  1714. # created.
  1715. self.assertSequenceEqual(Author.objects.all(), [author, other_author])
  1716. def test_validation_without_id(self):
  1717. AuthorFormSet = modelformset_factory(Author, fields="__all__")
  1718. data = {
  1719. "form-TOTAL_FORMS": "1",
  1720. "form-INITIAL_FORMS": "1",
  1721. "form-MAX_NUM_FORMS": "",
  1722. "form-0-name": "Charles",
  1723. }
  1724. formset = AuthorFormSet(data)
  1725. self.assertEqual(
  1726. formset.errors,
  1727. [{"id": ["This field is required."]}],
  1728. )
  1729. def test_validation_with_child_model_without_id(self):
  1730. BetterAuthorFormSet = modelformset_factory(BetterAuthor, fields="__all__")
  1731. data = {
  1732. "form-TOTAL_FORMS": "1",
  1733. "form-INITIAL_FORMS": "1",
  1734. "form-MAX_NUM_FORMS": "",
  1735. "form-0-name": "Charles",
  1736. "form-0-write_speed": "10",
  1737. }
  1738. formset = BetterAuthorFormSet(data)
  1739. self.assertEqual(
  1740. formset.errors,
  1741. [{"author_ptr": ["This field is required."]}],
  1742. )
  1743. def test_validation_with_invalid_id(self):
  1744. AuthorFormSet = modelformset_factory(Author, fields="__all__")
  1745. data = {
  1746. "form-TOTAL_FORMS": "1",
  1747. "form-INITIAL_FORMS": "1",
  1748. "form-MAX_NUM_FORMS": "",
  1749. "form-0-id": "abc",
  1750. "form-0-name": "Charles",
  1751. }
  1752. formset = AuthorFormSet(data)
  1753. self.assertEqual(
  1754. formset.errors,
  1755. [
  1756. {
  1757. "id": [
  1758. "Select a valid choice. That choice is not one of the "
  1759. "available choices."
  1760. ]
  1761. }
  1762. ],
  1763. )
  1764. def test_validation_with_nonexistent_id(self):
  1765. AuthorFormSet = modelformset_factory(Author, fields="__all__")
  1766. data = {
  1767. "form-TOTAL_FORMS": "1",
  1768. "form-INITIAL_FORMS": "1",
  1769. "form-MAX_NUM_FORMS": "",
  1770. "form-0-id": "12345",
  1771. "form-0-name": "Charles",
  1772. }
  1773. formset = AuthorFormSet(data)
  1774. self.assertEqual(
  1775. formset.errors,
  1776. [
  1777. {
  1778. "id": [
  1779. "Select a valid choice. That choice is not one of the "
  1780. "available choices."
  1781. ]
  1782. }
  1783. ],
  1784. )
  1785. def test_initial_form_count_empty_data(self):
  1786. AuthorFormSet = modelformset_factory(Author, fields="__all__")
  1787. formset = AuthorFormSet({})
  1788. self.assertEqual(formset.initial_form_count(), 0)
  1789. def test_edit_only(self):
  1790. charles = Author.objects.create(name="Charles Baudelaire")
  1791. AuthorFormSet = modelformset_factory(Author, fields="__all__", edit_only=True)
  1792. data = {
  1793. "form-TOTAL_FORMS": "2",
  1794. "form-INITIAL_FORMS": "0",
  1795. "form-MAX_NUM_FORMS": "0",
  1796. "form-0-name": "Arthur Rimbaud",
  1797. "form-1-name": "Walt Whitman",
  1798. }
  1799. formset = AuthorFormSet(data)
  1800. self.assertIs(formset.is_valid(), True)
  1801. formset.save()
  1802. self.assertSequenceEqual(Author.objects.all(), [charles])
  1803. data = {
  1804. "form-TOTAL_FORMS": "2",
  1805. "form-INITIAL_FORMS": "1",
  1806. "form-MAX_NUM_FORMS": "0",
  1807. "form-0-id": charles.pk,
  1808. "form-0-name": "Arthur Rimbaud",
  1809. "form-1-name": "Walt Whitman",
  1810. }
  1811. formset = AuthorFormSet(data)
  1812. self.assertIs(formset.is_valid(), True)
  1813. formset.save()
  1814. charles.refresh_from_db()
  1815. self.assertEqual(charles.name, "Arthur Rimbaud")
  1816. self.assertSequenceEqual(Author.objects.all(), [charles])
  1817. def test_edit_only_inlineformset_factory(self):
  1818. charles = Author.objects.create(name="Charles Baudelaire")
  1819. book = Book.objects.create(author=charles, title="Les Paradis Artificiels")
  1820. AuthorFormSet = inlineformset_factory(
  1821. Author,
  1822. Book,
  1823. can_delete=False,
  1824. fields="__all__",
  1825. edit_only=True,
  1826. )
  1827. data = {
  1828. "book_set-TOTAL_FORMS": "4",
  1829. "book_set-INITIAL_FORMS": "1",
  1830. "book_set-MAX_NUM_FORMS": "0",
  1831. "book_set-0-id": book.pk,
  1832. "book_set-0-title": "Les Fleurs du Mal",
  1833. "book_set-0-author": charles.pk,
  1834. "book_set-1-title": "Flowers of Evil",
  1835. "book_set-1-author": charles.pk,
  1836. }
  1837. formset = AuthorFormSet(data, instance=charles)
  1838. self.assertIs(formset.is_valid(), True)
  1839. formset.save()
  1840. book.refresh_from_db()
  1841. self.assertEqual(book.title, "Les Fleurs du Mal")
  1842. self.assertSequenceEqual(Book.objects.all(), [book])
  1843. def test_edit_only_object_outside_of_queryset(self):
  1844. charles = Author.objects.create(name="Charles Baudelaire")
  1845. walt = Author.objects.create(name="Walt Whitman")
  1846. data = {
  1847. "form-TOTAL_FORMS": "1",
  1848. "form-INITIAL_FORMS": "1",
  1849. "form-0-id": walt.pk,
  1850. "form-0-name": "Parth Patil",
  1851. }
  1852. AuthorFormSet = modelformset_factory(Author, fields="__all__", edit_only=True)
  1853. formset = AuthorFormSet(data, queryset=Author.objects.filter(pk=charles.pk))
  1854. self.assertIs(formset.is_valid(), True)
  1855. formset.save()
  1856. self.assertCountEqual(Author.objects.all(), [charles, walt])
  1857. def test_edit_only_formset_factory_with_basemodelformset(self):
  1858. charles = Author.objects.create(name="Charles Baudelaire")
  1859. class AuthorForm(forms.ModelForm):
  1860. class Meta:
  1861. model = Author
  1862. fields = "__all__"
  1863. class BaseAuthorFormSet(BaseModelFormSet):
  1864. def __init__(self, *args, **kwargs):
  1865. self.model = Author
  1866. super().__init__(*args, **kwargs)
  1867. AuthorFormSet = formset_factory(AuthorForm, formset=BaseAuthorFormSet)
  1868. data = {
  1869. "form-TOTAL_FORMS": "2",
  1870. "form-INITIAL_FORMS": "1",
  1871. "form-MAX_NUM_FORMS": "0",
  1872. "form-0-id": charles.pk,
  1873. "form-0-name": "Shawn Dong",
  1874. "form-1-name": "Walt Whitman",
  1875. }
  1876. formset = AuthorFormSet(data)
  1877. self.assertIs(formset.is_valid(), True)
  1878. formset.save()
  1879. self.assertEqual(Author.objects.count(), 2)
  1880. charles.refresh_from_db()
  1881. self.assertEqual(charles.name, "Shawn Dong")
  1882. self.assertEqual(Author.objects.count(), 2)
  1883. class TestModelFormsetOverridesTroughFormMeta(TestCase):
  1884. def test_modelformset_factory_widgets(self):
  1885. widgets = {"name": forms.TextInput(attrs={"class": "poet"})}
  1886. PoetFormSet = modelformset_factory(Poet, fields="__all__", widgets=widgets)
  1887. form = PoetFormSet.form()
  1888. self.assertHTMLEqual(
  1889. str(form["name"]),
  1890. '<input id="id_name" maxlength="100" type="text" class="poet" name="name" '
  1891. "required>",
  1892. )
  1893. def test_inlineformset_factory_widgets(self):
  1894. widgets = {"title": forms.TextInput(attrs={"class": "book"})}
  1895. BookFormSet = inlineformset_factory(
  1896. Author, Book, widgets=widgets, fields="__all__"
  1897. )
  1898. form = BookFormSet.form()
  1899. self.assertHTMLEqual(
  1900. str(form["title"]),
  1901. '<input class="book" id="id_title" maxlength="100" name="title" '
  1902. 'type="text" required>',
  1903. )
  1904. def test_modelformset_factory_labels_overrides(self):
  1905. BookFormSet = modelformset_factory(
  1906. Book, fields="__all__", labels={"title": "Name"}
  1907. )
  1908. form = BookFormSet.form()
  1909. self.assertHTMLEqual(
  1910. form["title"].label_tag(), '<label for="id_title">Name:</label>'
  1911. )
  1912. self.assertHTMLEqual(
  1913. form["title"].legend_tag(),
  1914. '<legend for="id_title">Name:</legend>',
  1915. )
  1916. def test_inlineformset_factory_labels_overrides(self):
  1917. BookFormSet = inlineformset_factory(
  1918. Author, Book, fields="__all__", labels={"title": "Name"}
  1919. )
  1920. form = BookFormSet.form()
  1921. self.assertHTMLEqual(
  1922. form["title"].label_tag(), '<label for="id_title">Name:</label>'
  1923. )
  1924. self.assertHTMLEqual(
  1925. form["title"].legend_tag(),
  1926. '<legend for="id_title">Name:</legend>',
  1927. )
  1928. def test_modelformset_factory_help_text_overrides(self):
  1929. BookFormSet = modelformset_factory(
  1930. Book, fields="__all__", help_texts={"title": "Choose carefully."}
  1931. )
  1932. form = BookFormSet.form()
  1933. self.assertEqual(form["title"].help_text, "Choose carefully.")
  1934. def test_inlineformset_factory_help_text_overrides(self):
  1935. BookFormSet = inlineformset_factory(
  1936. Author, Book, fields="__all__", help_texts={"title": "Choose carefully."}
  1937. )
  1938. form = BookFormSet.form()
  1939. self.assertEqual(form["title"].help_text, "Choose carefully.")
  1940. def test_modelformset_factory_error_messages_overrides(self):
  1941. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  1942. BookFormSet = modelformset_factory(
  1943. Book,
  1944. fields="__all__",
  1945. error_messages={"title": {"max_length": "Title too long!!"}},
  1946. )
  1947. form = BookFormSet.form(data={"title": "Foo " * 30, "author": author.id})
  1948. form.full_clean()
  1949. self.assertEqual(form.errors, {"title": ["Title too long!!"]})
  1950. def test_inlineformset_factory_error_messages_overrides(self):
  1951. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  1952. BookFormSet = inlineformset_factory(
  1953. Author,
  1954. Book,
  1955. fields="__all__",
  1956. error_messages={"title": {"max_length": "Title too long!!"}},
  1957. )
  1958. form = BookFormSet.form(data={"title": "Foo " * 30, "author": author.id})
  1959. form.full_clean()
  1960. self.assertEqual(form.errors, {"title": ["Title too long!!"]})
  1961. def test_modelformset_factory_field_class_overrides(self):
  1962. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  1963. BookFormSet = modelformset_factory(
  1964. Book,
  1965. fields="__all__",
  1966. field_classes={
  1967. "title": forms.SlugField,
  1968. },
  1969. )
  1970. form = BookFormSet.form(data={"title": "Foo " * 30, "author": author.id})
  1971. self.assertIs(Book._meta.get_field("title").__class__, models.CharField)
  1972. self.assertIsInstance(form.fields["title"], forms.SlugField)
  1973. def test_inlineformset_factory_field_class_overrides(self):
  1974. author = Author.objects.create(pk=1, name="Charles Baudelaire")
  1975. BookFormSet = inlineformset_factory(
  1976. Author,
  1977. Book,
  1978. fields="__all__",
  1979. field_classes={
  1980. "title": forms.SlugField,
  1981. },
  1982. )
  1983. form = BookFormSet.form(data={"title": "Foo " * 30, "author": author.id})
  1984. self.assertIs(Book._meta.get_field("title").__class__, models.CharField)
  1985. self.assertIsInstance(form.fields["title"], forms.SlugField)
  1986. def test_modelformset_factory_absolute_max(self):
  1987. AuthorFormSet = modelformset_factory(
  1988. Author, fields="__all__", absolute_max=1500
  1989. )
  1990. data = {
  1991. "form-TOTAL_FORMS": "1501",
  1992. "form-INITIAL_FORMS": "0",
  1993. "form-MAX_NUM_FORMS": "0",
  1994. }
  1995. formset = AuthorFormSet(data=data)
  1996. self.assertIs(formset.is_valid(), False)
  1997. self.assertEqual(len(formset.forms), 1500)
  1998. self.assertEqual(
  1999. formset.non_form_errors(),
  2000. ["Please submit at most 1000 forms."],
  2001. )
  2002. def test_modelformset_factory_absolute_max_with_max_num(self):
  2003. AuthorFormSet = modelformset_factory(
  2004. Author,
  2005. fields="__all__",
  2006. max_num=20,
  2007. absolute_max=100,
  2008. )
  2009. data = {
  2010. "form-TOTAL_FORMS": "101",
  2011. "form-INITIAL_FORMS": "0",
  2012. "form-MAX_NUM_FORMS": "0",
  2013. }
  2014. formset = AuthorFormSet(data=data)
  2015. self.assertIs(formset.is_valid(), False)
  2016. self.assertEqual(len(formset.forms), 100)
  2017. self.assertEqual(
  2018. formset.non_form_errors(),
  2019. ["Please submit at most 20 forms."],
  2020. )
  2021. def test_inlineformset_factory_absolute_max(self):
  2022. author = Author.objects.create(name="Charles Baudelaire")
  2023. BookFormSet = inlineformset_factory(
  2024. Author,
  2025. Book,
  2026. fields="__all__",
  2027. absolute_max=1500,
  2028. )
  2029. data = {
  2030. "book_set-TOTAL_FORMS": "1501",
  2031. "book_set-INITIAL_FORMS": "0",
  2032. "book_set-MAX_NUM_FORMS": "0",
  2033. }
  2034. formset = BookFormSet(data, instance=author)
  2035. self.assertIs(formset.is_valid(), False)
  2036. self.assertEqual(len(formset.forms), 1500)
  2037. self.assertEqual(
  2038. formset.non_form_errors(),
  2039. ["Please submit at most 1000 forms."],
  2040. )
  2041. def test_inlineformset_factory_absolute_max_with_max_num(self):
  2042. author = Author.objects.create(name="Charles Baudelaire")
  2043. BookFormSet = inlineformset_factory(
  2044. Author,
  2045. Book,
  2046. fields="__all__",
  2047. max_num=20,
  2048. absolute_max=100,
  2049. )
  2050. data = {
  2051. "book_set-TOTAL_FORMS": "101",
  2052. "book_set-INITIAL_FORMS": "0",
  2053. "book_set-MAX_NUM_FORMS": "0",
  2054. }
  2055. formset = BookFormSet(data, instance=author)
  2056. self.assertIs(formset.is_valid(), False)
  2057. self.assertEqual(len(formset.forms), 100)
  2058. self.assertEqual(
  2059. formset.non_form_errors(),
  2060. ["Please submit at most 20 forms."],
  2061. )
  2062. def test_modelformset_factory_can_delete_extra(self):
  2063. AuthorFormSet = modelformset_factory(
  2064. Author,
  2065. fields="__all__",
  2066. can_delete=True,
  2067. can_delete_extra=True,
  2068. extra=2,
  2069. )
  2070. formset = AuthorFormSet()
  2071. self.assertEqual(len(formset), 2)
  2072. self.assertIn("DELETE", formset.forms[0].fields)
  2073. self.assertIn("DELETE", formset.forms[1].fields)
  2074. def test_modelformset_factory_disable_delete_extra(self):
  2075. AuthorFormSet = modelformset_factory(
  2076. Author,
  2077. fields="__all__",
  2078. can_delete=True,
  2079. can_delete_extra=False,
  2080. extra=2,
  2081. )
  2082. formset = AuthorFormSet()
  2083. self.assertEqual(len(formset), 2)
  2084. self.assertNotIn("DELETE", formset.forms[0].fields)
  2085. self.assertNotIn("DELETE", formset.forms[1].fields)
  2086. def test_inlineformset_factory_can_delete_extra(self):
  2087. BookFormSet = inlineformset_factory(
  2088. Author,
  2089. Book,
  2090. fields="__all__",
  2091. can_delete=True,
  2092. can_delete_extra=True,
  2093. extra=2,
  2094. )
  2095. formset = BookFormSet()
  2096. self.assertEqual(len(formset), 2)
  2097. self.assertIn("DELETE", formset.forms[0].fields)
  2098. self.assertIn("DELETE", formset.forms[1].fields)
  2099. def test_inlineformset_factory_can_not_delete_extra(self):
  2100. BookFormSet = inlineformset_factory(
  2101. Author,
  2102. Book,
  2103. fields="__all__",
  2104. can_delete=True,
  2105. can_delete_extra=False,
  2106. extra=2,
  2107. )
  2108. formset = BookFormSet()
  2109. self.assertEqual(len(formset), 2)
  2110. self.assertNotIn("DELETE", formset.forms[0].fields)
  2111. self.assertNotIn("DELETE", formset.forms[1].fields)
  2112. def test_inlineformset_factory_passes_renderer(self):
  2113. from django.forms.renderers import Jinja2
  2114. renderer = Jinja2()
  2115. BookFormSet = inlineformset_factory(
  2116. Author,
  2117. Book,
  2118. fields="__all__",
  2119. renderer=renderer,
  2120. )
  2121. formset = BookFormSet()
  2122. self.assertEqual(formset.renderer, renderer)
  2123. def test_modelformset_factory_passes_renderer(self):
  2124. from django.forms.renderers import Jinja2
  2125. renderer = Jinja2()
  2126. BookFormSet = modelformset_factory(Author, fields="__all__", renderer=renderer)
  2127. formset = BookFormSet()
  2128. self.assertEqual(formset.renderer, renderer)