diff options
| author | Tobias McNulty <tobias@caktusgroup.com> | 2016-04-27 14:45:22 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2016-05-07 12:22:21 -0400 |
| commit | d2dc1886529b869a2f4b7b26b1a0d8794f80a8bb (patch) | |
| tree | 57c4fcefe701cf62e8d2418e4eb31a62f7c4d81c /docs/ref/files | |
| parent | bb95d409a8c90e5ec7a4aa0f8575c0256a806264 (diff) | |
[1.9.x] Fixed #26508 -- Clarified docs for various FieldFile methods.
Backport of dbd99de6fa006798ca81ef43cbc83d88e5e6a377 from master
Diffstat (limited to 'docs/ref/files')
| -rw-r--r-- | docs/ref/files/file.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/ref/files/file.txt b/docs/ref/files/file.txt index c3b0474550..02207361bd 100644 --- a/docs/ref/files/file.txt +++ b/docs/ref/files/file.txt @@ -31,6 +31,17 @@ The ``File`` class The underlying :py:term:`file object` that this class wraps. + .. admonition:: Be careful with this attribute in subclasses. + + Some subclasses of :class:`File`, including + :class:`~django.core.files.base.ContentFile` and + :class:`~django.db.models.fields.files.FieldFile`, may replace this + attribute with an object other than a Python :py:term:`file object`. + In these cases, this attribute may itself be a :class:`File` + subclass (and not necessarily the same subclass). Whenever + possible, use the attributes and methods of the subclass itself + rather than the those of the subclass's ``file`` attribute. + .. attribute:: mode The read/write mode for the file. |
