summaryrefslogtreecommitdiff
path: root/docs/topics/serialization.txt
AgeCommit message (Collapse)Author
2026-01-12Refs #36769 -- Raised SuspiciousOperation for unexpected nested tags in XML ↵Jacob Walls
Deserializer. Thanks Shai Berger and Natalia Bidart for reviews.
2025-12-03Fixed #35729 -- Enabled natural key serialization opt-out for subclasses.rimi0108
Refactored serialization logic to allow models inheriting a natural_key() method (e.g. AbstractBaseUser) to explicitly opt out of natural key serialization by returning an empty tuple from the method. Thanks Jonas Dittrich for the report. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
2025-12-02Fixed CVE-2025-64460 -- Corrected quadratic inner text accumulation in XML ↵Shai Berger
serializer. Previously, `getInnerText()` recursively used `list.extend()` on strings, which added each character from child nodes as a separate list element. On deeply nested XML content, this caused the overall deserialization work to grow quadratically with input size, potentially allowing disproportionate CPU consumption for crafted XML. The fix separates collection of inner texts from joining them, so that each subtree is joined only once, reducing the complexity to linear in the size of the input. These changes also include a mitigation for a xml.dom.minidom performance issue. Thanks Seokchan Yoon (https://ch4n3.kr/) for report. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-09-18Fixed #36581 -- Updated serialization examples from XML to JSON.CodingWithSaksham
2025-09-17Removed versionadded/changed annotations for 5.2.Jacob Walls
2025-08-25Refs #36485 -- Rewrapped docs to 79 columns line length.David Smith
Lines in the docs files were manually adjusted to conform to the 79 columns limit per line (plus newline), improving readability and consistency across the content.
2024-09-17Fixed #29522 -- Refactored the Deserializer functions to classes.Amir Karimi
Co-authored-by: Emad Mokhtar <emad.mokhtar@veneficus.nl>
2023-03-01Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.django-bot
2023-02-28Refs #34140 -- Corrected rst code-block and various formatting issues in docs.Joseph Victor Zammit
2023-02-10Refs #34140 -- Applied rst code-block to non-Python examples.Carlton Gibson
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for reviews.
2023-02-09Fixed #34311 -- Updated serialization docs from unique_together to ↵Willem Van Onsem
UniqueConstraint.
2022-08-30Refs #30947 -- Changed tuples to lists where appropriate.Alex Morega
2021-12-28Updated example of YAML serialization format in docs.Sergey Fursov
2021-09-20Removed versionadded/changed annotations for 3.2.Mariusz Felisiak
2021-05-17Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS.Nick Pope
2021-01-14Removed versionadded/changed annotations for 3.1.Mariusz Felisiak
2020-06-17Refs #30190 -- Minor edits to JSONL serializer.Mariusz Felisiak
Follow up to e29637681be07606674cdccb47d1e53acb930f5b.
2020-06-16Fixed #30190 -- Added JSONL serializer.Ali Vakilzade
2020-05-04Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and ↵Adam Johnson
comments.
2020-04-28Fixed #29249 -- Made JSON and YAML serializers use Unicode by default.Hasan Ramezani
2019-09-10Removed versionadded/changed annotations for 2.2.Mariusz Felisiak
2019-09-06Fixed #30573 -- Rephrased documentation to avoid words that minimise the ↵Tobias Kunze
involved difficulty. This patch does not remove all occurrences of the words in question. Rather, I went through all of the occurrences of the words listed below, and judged if they a) suggested the reader had some kind of knowledge/experience, and b) if they added anything of value (including tone of voice, etc). I left most of the words alone. I looked at the following words: - simply/simple - easy/easier/easiest - obvious - just - merely - straightforward - ridiculous Thanks to Carlton Gibson for guidance on how to approach this issue, and to Tim Bell for providing the idea. But the enormous lion's share of thanks go to Adam Johnson for his patient and helpful review.
2019-04-24Changed tuple Mate.unique_together/permissions to lists in docs.Luke Plant
2018-12-27Followed style guide for model attribute ordering.Matt Wiens
2018-12-27Fixed broken links to PyYAML page.CHI Cheng
2018-09-28Refs #28909 -- Simplifed code using unpacking generalizations.Sergey Fedoseev
2018-07-31Removed code terms from docs/spelling_wordlist.Tim Graham
2018-07-13Fixed #26291 -- Allowed loaddata to handle forward references in natural_key ↵Peter Inglesby
fixtures.
2018-01-07Updated various links in docs to use HTTPS.Mariusz Felisiak
2017-09-22Removed versionadded/changed annotations for 1.11.Tim Graham
2017-04-27Refs #27795 -- Replaced many force_text() with str()Claude Paroz
Thanks Tim Graham for the review.
2017-01-25Refs #23919 -- Replaced super(ClassName, self) with super() in docs.chillaranand
2017-01-17Removed versionadded/changed annotations for 1.10.Tim Graham
2016-07-14Fixed #26656 -- Added duration (timedelta) support to DjangoJSONEncoder.Will Hardy
2016-06-28Fixed #15091 -- Allowed passing custom encoder to JSON serializer.Berker Peksag
2016-06-07Fixed #26704 -- Documented DjangoJSONEncoder.Tommy Beadle
2016-05-20Removed versionadded/changed annotations for 1.9.Tim Graham
2016-05-08Fixed #26483 -- Updated docs.python.org links to use Intersphinx.Tim Graham
2016-03-08Fixed #26256 -- Added note about primary key serializationClaude Paroz
Thanks Sonu kumar for the report and Tim Graham for the review.
2016-02-01Fixed #26124 -- Added missing code formatting to docs headers.rowanv
2016-01-22Fixed #26020 -- Normalized header stylings in docs.Elif T. Kus
2016-01-14Fixed #23868 -- Added support for non-unique django-admin-options in docs.Tim Graham
Also documented missing short command line options to fix #24134. This bumps the minimum sphinx version required to build the docs to 1.3.4. Thanks Simon Charette for review.
2015-09-27Fixed #25468 -- Made DjangoJSONEncoder lazy string awareClaude Paroz
Thanks Stavros Korokithakis for the report and Tim Graham for the review.
2015-07-27Fixed #21127 -- Started deprecation toward requiring on_delete for ↵Flavio Curella
ForeignKey/OneToOneField
2015-06-19Fixed #20197 -- Made XML serializer fail loudly when outputting ↵Claude Paroz
unserializable chars Thanks Tim Graham for the review.
2015-02-01Removed versionadded/changed notes for 1.7.Tim Graham
2015-01-17Removed dumpdata --natural option and serializers use_natural_keys parameter.Tim Graham
Per deprecation timeline; refs #13252.
2014-12-19Used https for most *.python.org linksClaude Paroz
2014-11-15Added a new GeoJSON serialization format for GeoDjangoClaude Paroz
Thanks Reinout van Rees for the review.
2014-11-03Fixed versionchanged indentation in docs/.Berker Peksag