diff options
| author | Tom Christie | 2013-03-26 07:48:53 +0000 | 
|---|---|---|
| committer | Tom Christie | 2013-03-26 07:48:53 +0000 | 
| commit | 92c929094c88125ea4a2fd359ec99d2b4114f081 (patch) | |
| tree | defab9a9e57a626b83619aa3388f8ebf51ca33cc /docs/api-guide/fields.md | |
| parent | 8387cb5d1655e4d29cf8bca1919038091427e584 (diff) | |
| download | django-rest-framework-92c929094c88125ea4a2fd359ec99d2b4114f081.tar.bz2 | |
Version 2.2.52.2.5
Diffstat (limited to 'docs/api-guide/fields.md')
| -rw-r--r-- | docs/api-guide/fields.md | 7 | 
1 files changed, 6 insertions, 1 deletions
| diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 02876936..42f89f46 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -197,12 +197,16 @@ If you want to override this behavior, you'll need to declare the `DateTimeField          class Meta:              model = Comment +Note that by default, datetime representations are deteremined by the renderer in use, although this can be explicitly overridden as detailed below. + +In the case of JSON this means the default datetime representation uses the [ECMA 262 date time string specification][ecma262].  This is a subset of ISO 8601 which uses millisecond precision, and includes the 'Z' suffix for the UTC timezone, for example: `2013-01-29T12:34:56.123Z`. +  **Signature:** `DateTimeField(format=None, input_formats=None)`  * `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'`) +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.000000Z'`)  ## DateField @@ -318,5 +322,6 @@ As an example, let's create a field that can be used represent the class name of  [cite]: https://docs.djangoproject.com/en/dev/ref/forms/api/#django.forms.Form.cleaned_data  [FILE_UPLOAD_HANDLERS]: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FILE_UPLOAD_HANDLERS +[ecma262]: http://ecma-international.org/ecma-262/5.1/#sec-15.9.1.15  [strftime]: http://docs.python.org/2/library/datetime.html#strftime-and-strptime-behavior  [iso8601]: http://www.w3.org/TR/NOTE-datetime | 
