mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-29 16:46:11 +00:00
Code Issues 32 Releases Wiki Activity

[1.11.x] Removed nonexistent methods from File's docs.

Browse Source 
read() and write() were removed in 68a890e79f.

Backport of 98ee57e343 from master
This commit is contained in:
Josh Schneier
2017-04-19 14:48:01 -04:00
committed by Tim Graham
parent 4a89000ccf
commit 1f1040aa54
2 changed files with 7 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/ref/files/file.txt
View File

@@ -56,11 +56,6 @@ The ``File`` class
was originally opened with; ``None`` means to reopen with the original was originally opened with; ``None`` means to reopen with the original
mode. mode.
.. method:: read(num_bytes=None)
Read content from the file. The optional ``size`` is the number of
bytes to read; if not specified, the file will be read to the end.
.. method:: __iter__() .. method:: __iter__()
Iterate over the file yielding one line at a time. Iterate over the file yielding one line at a time.
@@ -78,22 +73,16 @@ The ``File`` class
Returns ``True`` if the file is large enough to require multiple chunks Returns ``True`` if the file is large enough to require multiple chunks
to access all of its content give some ``chunk_size``. to access all of its content give some ``chunk_size``.
.. method:: write(content)
Writes the specified content string to the file. Depending on the
storage system behind the scenes, this content might not be fully
committed until :func:`close()` is called on the file.
.. method:: close() .. method:: close()
Close the file. Close the file.
In addition to the listed methods, :class:`~django.core.files.File` exposes In addition to the listed methods, :class:`~django.core.files.File` exposes
the following attributes and methods of its ``file`` object: the following attributes and methods of its ``file`` object:
``encoding``, ``fileno``, ``flush``, ``isatty``, ``newlines``, ``encoding``, ``fileno``, ``flush``, ``isatty``, ``newlines``, ``read``,
``read``, ``readinto``, ``readlines``, ``seek``, ``softspace``, ``tell``, ``readinto``, ``readline``, ``readlines``, ``seek``, ``softspace``,
``truncate``, ``writelines``, ``xreadlines``, ``readable()``, ``tell``, ``truncate``, ``write``, ``writelines``, ``xreadlines``,
``writable()``, and ``seekable()``. ``readable()``, ``writable()``, and ``seekable()``.
.. versionchanged:: 1.11 .. versionchanged:: 1.11

7
docs/ref/models/fields.txt
View File

@@ -777,10 +777,9 @@ the result of the :attr:`Storage.open()<django.core.files.storage.Storage.open>`
method, which may be a :class:`~django.core.files.File` object, or it may be a method, which may be a :class:`~django.core.files.File` object, or it may be a
custom storage's implementation of the :class:`~django.core.files.File` API. custom storage's implementation of the :class:`~django.core.files.File` API.
In addition to the API inherited from In addition to the API inherited from :class:`~django.core.files.File` such as
:class:`~django.core.files.File` such as :meth:`~django.core.files.File.read` ``read()`` and ``write()``, :class:`FieldFile` includes several methods that
and :meth:`~django.core.files.File.write`, :class:`FieldFile` includes several can be used to interact with the underlying file:
methods that can be used to interact with the underlying file:
.. warning:: .. warning::