aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorTom Christie2013-03-21 08:41:54 +0000
committerTom Christie2013-03-21 08:41:54 +0000
commit8adde506e865005a96cdeff996ec4b5b9bb73a8f (patch)
treebd9edbb8282a3c1aa40d1a17d9c2950c475b6a75 /docs/api-guide
parent20fd738c856dfa21a0d2d251b92459d6641c782c (diff)
downloaddjango-rest-framework-8adde506e865005a96cdeff996ec4b5b9bb73a8f.tar.bz2
Default date/time fields now return python date/time objects again by default
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/fields.md6
-rw-r--r--docs/api-guide/settings.md27
2 files changed, 23 insertions, 10 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index 9a745cf1..63bd5b1a 100644
--- a/docs/api-guide/fields.md
+++ b/docs/api-guide/fields.md
@@ -199,7 +199,7 @@ If you want to override this behavior, you'll need to declare the `DateTimeField
**Signature:** `DateTimeField(format=None, input_formats=None)`
-* `format` - A string representing the output format. If not specified, the `DATETIME_FORMAT` setting will be used, which defaults to `'iso-8601'`.
+* `format` - A string representing the output format. If not specified, this defaults to `None`, which indicates that python `datetime` objects should be returned by `to_native`. In this case the datetime encoding will be determined by the renderer.
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
DateTime format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style datetimes should be used. (eg `'2013-01-29T12:34:56.000000'`)
@@ -212,7 +212,7 @@ Corresponds to `django.db.models.fields.DateField`
**Signature:** `DateField(format=None, input_formats=None)`
-* `format` - A string representing the output format. If not specified, the `DATE_FORMAT` setting will be used, which defaults to `'iso-8601'`.
+* `format` - A string representing the output format. If not specified, this defaults to `None`, which indicates that python `date` objects should be returned by `to_native`. In this case the date encoding will be determined by the renderer.
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATE_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
Date format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style dates should be used. (eg `'2013-01-29'`)
@@ -227,7 +227,7 @@ Corresponds to `django.db.models.fields.TimeField`
**Signature:** `TimeField(format=None, input_formats=None)`
-* `format` - A string representing the output format. If not specified, the `TIME_FORMAT` setting will be used, which defaults to `'iso-8601'`.
+* `format` - A string representing the output format. If not specified, this defaults to `None`, which indicates that python `time` objects should be returned by `to_native`. In this case the time encoding will be determined by the renderer.
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `TIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
Time format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style times should be used. (eg `'12:34:56.000000'`)
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
index 11638696..c0d8d9ee 100644
--- a/docs/api-guide/settings.md
+++ b/docs/api-guide/settings.md
@@ -192,44 +192,56 @@ Default: `'format'`
---
-## Date/Time formatting
+## Date and time formatting
*The following settings are used to control how date and time representations may be parsed and rendered.*
#### DATETIME_FORMAT
-A format string that should be used by default for rendering the output of `DateTimeField` serializer fields.
+A format string that should be used by default for rendering the output of `DateTimeField` serializer fields. If `None`, then `DateTimeField` serializer fields will return python `datetime` objects, and the datetime encoding will be determined by the renderer.
-Default: `'iso-8601'`
+May be any of `None`, `'iso-8601'` or a python [strftime format][strftime] string.
+
+Default: `None'`
#### DATETIME_INPUT_FORMATS
A list of format strings that should be used by default for parsing inputs to `DateTimeField` serializer fields.
+May be a list including the string `'iso-8601'` or python [strftime format][strftime] strings.
+
Default: `['iso-8601']`
#### DATE_FORMAT
-A format string that should be used by default for rendering the output of `DateField` serializer fields.
+A format string that should be used by default for rendering the output of `DateField` serializer fields. If `None`, then `DateField` serializer fields will return python `date` objects, and the date encoding will be determined by the renderer.
-Default: `'iso-8601'`
+May be any of `None`, `'iso-8601'` or a python [strftime format][strftime] string.
+
+Default: `None`
#### DATE_INPUT_FORMATS
A list of format strings that should be used by default for parsing inputs to `DateField` serializer fields.
+May be a list including the string `'iso-8601'` or python [strftime format][strftime] strings.
+
Default: `['iso-8601']`
#### TIME_FORMAT
-A format string that should be used by default for rendering the output of `TimeField` serializer fields.
+A format string that should be used by default for rendering the output of `TimeField` serializer fields. If `None`, then `TimeField` serializer fields will return python `time` objects, and the time encoding will be determined by the renderer.
+
+May be any of `None`, `'iso-8601'` or a python [strftime format][strftime] string.
-Default: `'iso-8601'`
+Default: `None`
#### TIME_INPUT_FORMATS
A list of format strings that should be used by default for parsing inputs to `TimeField` serializer fields.
+May be a list including the string `'iso-8601'` or python [strftime format][strftime] strings.
+
Default: `['iso-8601']`
---
@@ -243,3 +255,4 @@ The name of a parameter in the URL conf that may be used to provide a format suf
Default: `'format'`
[cite]: http://www.python.org/dev/peps/pep-0020/
+[strftime]: http://docs.python.org/2/library/time.html#time.strftime \ No newline at end of file