Nick Pope
1c66767d4e
Refs #27910 -- Improved documentation for model field choice enumeration types.
2019-09-13 15:37:40 +02:00
Tobias Kunze
4a954cfd11
Fixed #30573 -- Rephrased documentation to avoid words that minimise the 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-09-06 13:27:46 +02:00
Shai Berger
72ebe85a26
Fixed #27910 -- Added enumeration helpers for use in Field.choices.
...
These classes can serve as a base class for user enums, supporting
translatable human-readable names, or names automatically inferred
from the enum member name.
Additional properties make it easy to access the list of names, values
and display labels.
Thanks to the following for ideas and reviews:
Carlton Gibson, Fran Hrženjak, Ian Foote, Mariusz Felisiak, Shai Berger.
Co-authored-by: Shai Berger <shai@platonix.com>
Co-authored-by: Nick Pope <nick.pope@flightdataservices.com>
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2019-09-04 14:42:49 +02:00
Claude Paroz
d1c2e6dd04
Refs #28428 -- Made FileField.upload_to support pathlib.Path.
2019-08-18 20:34:58 +02:00
Nick Pope
194d1dfc18
Fixed #30661 -- Added models.SmallAutoField.
2019-08-02 11:39:01 +02:00
Jon Dufresne
5ed20b3aa3
Fixed #30657 -- Allowed customizing Field's descriptors with a descriptor_class attribute.
...
Allows model fields to override the descriptor class used on the model
instance attribute.
2019-07-25 08:15:20 +02:00
Nadège Michel
87b1ad6e73
Fixed #30421 -- Allowed symmetrical intermediate table for self-referential ManyToManyField.
2019-06-21 15:03:17 +02:00
Caio Ariede
5248abe9b0
Fixed #30505 -- Doc'd how changes in the order of Field.choices affect migrations.
2019-06-04 14:11:41 +02:00
Jon Dufresne
e86cc14bd3
Changed docs to link to Python's description of iterable.
2019-05-17 17:27:19 +02:00
Jon Dufresne
97d3321e89
Changed tuple choices to list in docs.
2019-05-15 14:31:42 +02:00
Mykola Kokalko
ef082ebb84
Fixed #29529 -- Allowed models.fields.FilePathField to accept a callable path.
2019-05-02 11:11:56 +02:00
Mariusz Felisiak
b0799f5d86
Fixed documentation of database representation for ManyToManyField.
2019-02-25 20:05:31 +01:00
Tim Graham
ec7e179aeb
Removed versionadded/changed annotations for 2.1.
2019-01-17 10:50:25 -05:00
François Freitag
9b15ff08ba
Used auto-numbered lists in documentation.
2018-11-15 13:54:28 -05:00
Andrea Rabbaglietti
1b49b792e9
Emphasized that ForeignKey.on_delete doesn't create a SQL constraint.
2018-10-10 14:56:50 -04:00
Jon Dufresne
b3b47bf515
Added tests for using bytearray with BinaryField and corrected docs.
2018-10-01 09:16:16 -04:00
Jon Dufresne
fb2964a410
Added test of filtering on BinaryField and corrected docs.
2018-09-26 14:38:12 -04:00
Jon Dufresne
8c3e0eb1c1
Normalized spelling of "lowercase" and "lowercased".
2018-09-25 10:30:18 -04:00
Curtis Maloney
c49ea6f591
Refs #20910 -- Replaced snippet directive with code-block.
2018-09-10 13:00:34 -04:00
Matt Wiens
c122a7c53c
Fixed typo in docs/ref/models/fields.txt.
2018-08-28 07:53:09 -04:00
Jeff
3fa3de5415
Fixed #29646 -- Doc'd the validators that each model and form field uses.
2018-08-16 17:03:28 -04:00
Claude Paroz
6e78e10549
Added doc links for django.utils.html.escape().
2018-07-18 11:32:27 -04:00
Tim Graham
8b1d361f28
Fixed #29549 -- Doc'd that Field.choices are enforced by model validation.
2018-07-09 15:06:36 -04:00
Srinivas Reddy Thatiparthy
4c35a173e8
Fixed #29423 -- Documented Field.value_from_object().
2018-05-25 15:10:45 -04:00
Tim Graham
e038f98bf3
Fixed #29398 -- Doc'd that cascade deletion doesn't call delete() of related models.
2018-05-18 18:08:37 -04:00
Tim Graham
5fa4f40f45
Fixed #29227 -- Allowed BooleanField to be null=True.
...
Thanks Lynn Cyrin for contributing to the patch, and Nick Pope for review.
2018-03-20 12:10:10 -04:00
Cameron Curry
622ead6aaf
Fixed #28937 -- Allowed BinaryField to be editable=True.
2017-12-22 16:31:46 -05:00
Tim Graham
5446b72003
Removed versionadded/changed annotations for 1.11.
2017-09-22 12:51:18 -04:00
Tim Graham
6e4a34580d
Fixed #28557 -- Fixed ForeignKey/OneToOneField/ManyToManyField argument name in docs.
2017-09-01 20:03:32 -04:00
Tim Graham
50a97edc1a
Fixed #28466 -- Clarified the definition of a lazy relationship.
2017-08-07 15:51:46 -04:00
Tim Graham
487362fa8f
Fixed #28370 -- Deprecated the context arg of Field.from_db_value() and Expression.convert_value().
...
Unused since a0d166306f
.
2017-07-20 16:30:08 -04:00
Josh Schneier
98ee57e343
Removed nonexistent methods from File's docs.
...
read() and write() were removed in 68a890e79f
.
2017-04-25 19:49:00 -04:00
Taavi Teska
5dbf1c4b23
Fixed #27947 -- Doc'd that model Field.error_messages often don't propagate to forms.
2017-04-10 14:24:44 -04:00
Mariusz Felisiak
a3af8c99d9
Removed extra characters in docs header underlines.
2017-03-20 18:30:32 -04:00
Tim Graham
2d96c027f5
Refs #23919 -- Removed obsolete MySQLdb references.
2017-01-25 10:16:10 -05:00
Tim Graham
e27e4c0339
Removed versionadded/changed annotations for 1.10.
2017-01-17 20:52:05 -05:00
Tim Graham
bcf3532ede
Refs #26154 -- Removed deprecated CommaSeparatedIntegerField.
2017-01-17 20:52:02 -05:00
Tim Graham
ddd3268975
Refs #21127 -- Required on_delete for ForeignKey/OneToOneField.
...
Per deprecation timeline.
2017-01-17 14:09:28 -05:00
Tim Graham
55adfc0760
Fixed #27511 -- Corrected Field.related_model docs about GenericRelation.
2016-11-21 12:30:54 -05:00
Jonatas CD
9da45ff352
Fixed #26985 -- Doc'd that ForeignKey.to_field reference must be unique.
2016-11-15 11:09:23 -05:00
Michael Scott
ec9ed07488
Fixed #27188 -- Allowed using unique=True with FileField.
...
Thanks Tim Graham for the initial patch.
2016-10-28 20:11:03 -04:00
zhuanyenan
17677d510f
Corrected docs for return type of Field.formfield().
2016-09-17 14:26:54 -04:00
Victor Oliveira da Silva
d7804662f8
Made cosmetic edits to Field.default docs.
2016-08-15 10:44:39 -04:00
Jon Dufresne
267dc4addd
Fixed #4136 -- Made ModelForm save empty values for nullable CharFields as NULL.
...
Previously, empty values were saved as strings.
2016-06-13 09:14:36 -04:00
Ed Henderson
4a4d7f980e
Fixed #26021 -- Applied hanging indentation to docs.
2016-06-03 11:44:34 -04:00
Tim Graham
46a38307c2
Removed versionadded/changed annotations for 1.9.
2016-05-20 11:44:29 -04:00
Tobias McNulty
dbd99de6fa
Fixed #26508 -- Clarified docs for various FieldFile methods.
2016-05-07 12:16:42 -04:00
Claude Paroz
388bb5bd9a
Fixed #22936 -- Obsoleted Field.get_prep_lookup()/get_db_prep_lookup()
...
Thanks Tim Graham for completing the initial patch.
2016-05-04 20:02:01 +02:00
Tim Graham
f945fb24a3
Fixed #26554 -- Updated docs URLs to readthedocs.io
2016-04-28 10:09:57 -04:00
Duane Hilton
ca5c05ddbe
Fixed #26239 -- Added a note about how auto_now works with QuerySet.update().
2016-03-12 12:39:00 -05:00
Marc Tamlyn
8ddc79a799
Fixed #26285 -- Deprecated the MySQL-specific __search lookup.
2016-03-02 14:41:56 -05:00
Simon Charette
0223e213dd
Fixed #26186 -- Documented how app relative relationships of abstract models behave.
...
This partially reverts commit bc7d201bdb
.
Thanks Tim for the review.
Refs #25858 .
2016-02-29 22:07:05 -05:00
chenesan
b84f5ab4ec
Fixed #26230 -- Made default_related_name affect related_query_name.
2016-02-27 08:48:32 -05:00
Claude Paroz
d43156e1e9
Fixed #26238 -- Raised explicit error for non-editable field in ModelForm
...
Thanks Luke Crouch for the report and Simon Charette for the review.
2016-02-21 00:24:20 +01:00
Brobin
dca8b916ff
Fixed #26154 -- Deprecated CommaSeparatedIntegerField
2016-02-10 17:57:43 -05:00
Tim Graham
8ce8beb3f2
Unified some doc links to OneToOneField and ManyToManyField.
2016-02-01 11:02:26 -05:00
rowanv
a6ef025dfb
Fixed #26124 -- Added missing code formatting to docs headers.
2016-02-01 10:42:05 -05:00
James Pulec
f05722a08a
Fixed #25354 -- Added class/app_label interpolation for related_query_name.
2016-01-28 11:10:47 -05:00
Alexander Sosnovskiy
2a7ce34600
Fixed #14286 -- Added models.BigAutoField.
2015-12-25 20:01:31 -05:00
Chris Lamb
77b8d8cb6d
Discouraged use of /tmp with predictable names.
...
The use of predictable filenames in /tmp often leads to symlink attacks
so remove the most obvious use of them in the docs.
2015-12-24 09:54:33 -05:00
Alexander Sosnovskiy
b61eab18f7
Fixed #13774 -- Added models.Field.rel_db_type().
2015-12-04 07:55:41 -05:00
Jon Dufresne
7aabd62380
Fixed #25778 -- Updated docs links to use https when available.
2015-12-01 08:01:34 -05:00
Bulgantamir Gankhuyag
8bce6fa637
Clarified default value for DateField to emulate auto_now_add.
2015-11-24 08:38:14 -05:00
areski
1e7da99ea6
Corrected GenericIPAddressField protocol parameter doc.
2015-11-19 11:18:31 -05:00
Tim Graham
54848a96dd
Removed versionadded/changed annotations for 1.8.
2015-09-23 19:31:11 -04:00
Tim Graham
5980b05c1f
Fixed #25160 -- Moved unsaved model instance data loss check to Model.save()
...
This mostly reverts 5643a3b51b
and
81e1a35c36
.
Thanks Carl Meyer for review.
2015-08-10 08:51:32 -04:00
Flavio Curella
c2e70f0265
Fixed #21127 -- Started deprecation toward requiring on_delete for ForeignKey/OneToOneField
2015-07-27 18:28:13 -04:00
Tim Graham
87d55081ea
Fixed #25159 -- Removed brackets from class/function/method signatures in docs.
...
Thanks hellbeast for the initial patch.
2015-07-27 10:32:47 -04:00
Tim Graham
b60375d4bb
Fixed #25129 -- Made model instance defaults work with migrations (refs #24919 ).
2015-07-21 09:19:40 -04:00
Edward Henderson
f8cc464452
Fixed #16501 -- Added an allow_unicode parameter to SlugField.
...
Thanks Flavio Curella and Berker Peksag for the initial patch.
2015-07-17 13:48:58 -04:00
Matt Deacalion Stevens
77f3d7adb1
Clarified the default form widgets for model number fields in docs
2015-06-09 12:33:01 -04:00
Yamila Moreno
cbe4efcbc1
Fixed #22571 -- Added clarification about auto_now_add=True
2015-06-05 09:56:02 -04:00
Tim Graham
2b086229a2
Fixed #24665 -- Clarified model field flag defaults.
2015-04-29 20:35:22 -04:00
Christopher Luc
8119876d4a
Improved docs for timezone handling for auto_now and auto_now_add
...
Thanks djbug for the report and Aymeric Augustin and Carl Meyer for the
review.
2015-03-29 22:32:05 +02:00
Matt Seymour
98c5370ef6
Fixed #24510 -- Clarified FileField.upload_to docs.
2015-03-26 19:21:12 -04:00
Fabio Natali
cb506aed2a
Fixed #23814 -- Documented apps refactored out of Django.
2015-03-25 08:46:23 -04:00
Iacopo Spalletti
87fed94440
Fixed #23814 -- Pointed localflavor documentation to external package
...
Edited localflavor doc to point to the external package documentation,
leaving just the 'How to migrate' section in Django.
2015-03-22 15:31:54 +01:00
Karl Hobley
81e1a35c36
Fixed #24495 -- Allowed unsaved model instance assignment check to be bypassed.
2015-03-18 19:00:09 -04:00
Steven Das
53bc6e2e98
Fixed typo in docs/ref/models/fields.txt
2015-03-12 19:16:05 -04:00
Floris den Hengst
b9b8411129
Fixed #24432 -- Added docs for ManyToManyFields that reside in and refer to the same model.
2015-03-09 20:44:55 -04:00
Marc Tamlyn
32d4db66b9
Update converters to take a consistent set of parameters.
...
As suggested by Anssi. This has the slightly strange side effect of
passing the expression to Expression.convert_value has the expression
passed back to it, but it allows more complex patterns of expressions.
2015-02-20 11:35:52 +00:00
Loic Bistuer
18c0aaa912
Fixed #24289 -- Reversed usage of Field.many_to_one and one_to_many.
...
Thanks Carl Meyer and Tim Graham for the reviews and to all involved
in the discussion.
2015-02-14 02:28:24 +07:00
Anssi Kääriäinen
8adc59038c
Fixed #23617 -- Added get_pk_value_on_save()
...
The method is mainly intended for use with UUIDField. For UUIDField we
want to call the field's default even when primary key value is
explicitly set to None to match the behavior of AutoField.
Thanks to Marc Tamlyn and Tim Graham for review.
2015-02-03 09:23:44 -05:00
Tim Graham
c79faae761
Removed versionadded/changed notes for 1.7.
2015-02-01 21:02:40 -05:00
Tim Graham
33457cd3b0
Removed IPAddressField per deprecation timeline; refs #20439 .
2015-01-19 11:12:57 -05:00
Tim Graham
7e8cf74dc7
Removed support for syncing apps without migrations per deprecation timeline.
...
Kept support for creating models without migrations when running tests
(especially for Django's test suite).
2015-01-18 15:58:06 -05:00
Tim Graham
4aa089a9a9
Removed support for custom SQL per deprecation timeline.
2015-01-17 10:16:06 -05:00
Anssi Kääriäinen
0c7633178f
Fixed #24020 -- Refactored SQL compiler to use expressions
...
Refactored compiler SELECT, GROUP BY and ORDER BY generation.
While there, also refactored select_related() implementation
(get_cached_row() and get_klass_info() are now gone!).
Made get_db_converters() method work on expressions instead of
internal_type. This allows the backend converters to target
specific expressions if need be.
Added query.context, this can be used to set per-query state.
Also changed the signature of database converters. They now accept
context as an argument.
2015-01-08 14:07:54 -05:00
Daniel Pyrathon
fb48eb0581
Fixed #12663 -- Formalized the Model._meta API for retrieving fields.
...
Thanks to Russell Keith-Magee for mentoring this Google Summer of
Code 2014 project and everyone else who helped with the patch!
2015-01-06 19:25:12 -05:00
Helen Sherwood-Taylor
4ccdf6e57f
Fixed #24041 -- Documented effect of changing a model instance's primary key.
2014-12-24 15:06:09 -05:00
Marc Tamlyn
5ca82e710e
Fixed #24033 -- Use interval type on Oracle.
...
Use INTERVAL DAY(9) TO SECOND(6) for Durationfield on Oracle rather than
storing as a NUMBER(19) of microseconds.
There are issues with cx_Oracle which require some extra data
manipulation in the database backend when constructing queries, but it
handles the conversion back to timedelta objects cleanly.
Thanks to Shai for the review.
2014-12-23 10:38:32 +00:00
Marc Tamlyn
57554442fe
Fixed #2443 -- Added DurationField.
...
A field for storing periods of time - modeled in Python by timedelta. It
is stored in the native interval data type on PostgreSQL and as a bigint
of microseconds on other backends.
Also includes significant changes to the internals of time related maths
in expressions, including the removal of DateModifierNode.
Thanks to Tim and Josh in particular for reviews.
2014-12-20 18:28:29 +00:00
Tim Graham
1aa41dd000
Fixed #23974 -- Clarified wording of FileField.save/delete save parameter.
...
Thanks GreenAsJade.
2014-12-08 13:15:46 -05:00
Tim Graham
5281d9620d
Fixed #23965 -- Mentioned that FieldFile inherits from File
2014-12-06 11:51:32 -05:00
Raul Cumplido
68d3db8a7b
Fixed #23725 -- Substituted AUTH_USER_MODEL for User in docs.
2014-10-30 08:29:18 -04:00
Jon Dufresne
c1b9f99a81
Fixed #23676 -- Rearranged sentence; "by default" applies only to max length
2014-10-18 06:55:11 -04:00
Marc Tamlyn
acdbecda05
Fix formatting error in UUIDField docs.
2014-10-04 12:22:11 +01:00
Marc Tamlyn
ed7821231b
Fixed #19463 -- Added UUIDField
...
Uses native support in postgres, and char(32) on other backends.
2014-09-16 10:08:09 +01:00
Tim Graham
60c38c1a4e
Fixed #23281 -- Added "concrete model" to glossary.
...
Thanks knowledgepoint-devs for the suggestion.
2014-09-08 08:45:47 -04:00
Andrew Godwin
6d504562f5
Fixed #22534 : Reinforce swappable documentation
2014-09-05 11:39:55 -07:00