Fixed #23827 -- TZ behavior in Storage API ref doc

This is derived from the current behaviour of FileSystemStorage.
Note that since this was not previously documented, other
implementations may not currently conform.
This commit is contained in:
James Aylett 2014-11-15 11:57:53 +01:00
parent 4f90c99635
commit 88e13b44ed
1 changed files with 18 additions and 9 deletions

View File

@ -82,17 +82,25 @@ The Storage Class
behaviors that all other storage systems can inherit or override behaviors that all other storage systems can inherit or override
as necessary. as necessary.
.. note::
For methods returning naive ``datetime`` objects, the
effective timezone used will be the current value of
``os.environ['TZ']``; note that this is usually set from
Django's :setting:`TIME_ZONE`.
.. method:: accessed_time(name) .. method:: accessed_time(name)
Returns a ``datetime`` object containing the last accessed time of the Returns a naive ``datetime`` object containing the last
file. For storage systems that aren't able to return the last accessed accessed time of the file. For storage systems that aren't
time this will raise ``NotImplementedError`` instead. able to return the last accessed time this will raise
``NotImplementedError`` instead.
.. method:: created_time(name) .. method:: created_time(name)
Returns a ``datetime`` object containing the creation time of the file. Returns a naive ``datetime`` object containing the creation
For storage systems that aren't able to return the creation time this time of the file. For storage systems that aren't able to
will raise ``NotImplementedError`` instead. return the creation time this will raise
``NotImplementedError`` instead.
.. method:: delete(name) .. method:: delete(name)
@ -139,9 +147,10 @@ The Storage Class
.. method:: modified_time(name) .. method:: modified_time(name)
Returns a ``datetime`` object containing the last modified time. For Returns a naive ``datetime`` object containing the last
storage systems that aren't able to return the last modified time, this modified time. For storage systems that aren't able to return
will raise ``NotImplementedError`` instead. the last modified time, this will raise
``NotImplementedError`` instead.
.. method:: open(name, mode='rb') .. method:: open(name, mode='rb')