summaryrefslogtreecommitdiff
path: root/docs/ref/files
diff options
context:
space:
mode:
authoryukihira1992 <hirayama@cancerscan.jp>2019-08-29 01:17:07 +0900
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2019-08-30 11:32:19 +0200
commit05457817647368be4b019314fcc655445a5b4c0c (patch)
tree91ca38fb0ba6a710929fa29fa772cb4cca5e334d /docs/ref/files
parent400ec5125ec32e3b18d267bbb4f3aab09d741ce4 (diff)
Fixed #30736 -- Added Storage.get_alternative_name() to allow customization.
Diffstat (limited to 'docs/ref/files')
-rw-r--r--docs/ref/files/storage.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/ref/files/storage.txt b/docs/ref/files/storage.txt
index 2a82402fac..0724a0cda1 100644
--- a/docs/ref/files/storage.txt
+++ b/docs/ref/files/storage.txt
@@ -105,6 +105,12 @@ The ``Storage`` class
If :setting:`USE_TZ` is ``True``, returns an aware ``datetime``,
otherwise returns a naive ``datetime`` in the local timezone.
+ .. method:: get_alternative_name(file_root, file_ext)
+
+ Returns an alternative filename based on the ``file_root`` and
+ ``file_ext`` parameters, an underscore plus a random 7 character
+ alphanumeric string is appended to the filename before the extension.
+
.. method:: get_available_name(name, max_length=None)
Returns a filename based on the ``name`` parameter that's free and
@@ -116,9 +122,8 @@ The ``Storage`` class
:exc:`SuspiciousFileOperation
<django.core.exceptions.SuspiciousOperation>` exception will be raised.
- If a file with ``name`` already exists, an underscore plus a random
- 7 character alphanumeric string is appended to the filename before
- the extension.
+ If a file with ``name`` already exists, :meth:`get_alternative_name` is
+ called to obtain an alternative name.
.. method:: get_created_time(name)