class File(file_object)
[source]
The File
class is a thin wrapper around a Python file object with some Django-specific additions. Internally, Django uses this class when it needs to represent a file.
File
objects have the following attributes and methods:
-
name
-
The name of the file including the relative path from
MEDIA_ROOT
.
-
size
-
The size of the file in bytes.
-
file
-
The underlying file object that this class wraps.
Be careful with this attribute in subclasses.
Some subclasses of
File
, includingContentFile
andFieldFile
, may replace this attribute with an object other than a Python file object. In these cases, this attribute may itself be aFile
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’sfile
attribute.
-
mode
-
The read/write mode for the file.
-
open(mode=None)
[source] -
Open or reopen the file (which also does
File.seek(0)
). Themode
argument allows the same values as Python’s built-inopen()
.When reopening a file,
mode
will override whatever mode the file was originally opened with;None
means to reopen with the original mode.
-
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.
-
__iter__()
[source] -
Iterate over the file yielding one line at a time.
-
chunks(chunk_size=None)
[source] -
Iterate over the file yielding “chunks” of a given size.
chunk_size
defaults to 64 KB.This is especially useful with very large files since it allows them to be streamed off disk and avoids storing the whole file in memory.
-
multiple_chunks(chunk_size=None)
[source] -
Returns
True
if the file is large enough to require multiple chunks to access all of its content give somechunk_size
.
-
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
close()
is called on the file.
-
close()
[source] -
Close the file.
In addition to the listed methods, File
exposes the following attributes and methods of its file
object: encoding
, fileno
, flush
, isatty
, newlines
, read
, readinto
, readlines
, seek
, softspace
, tell
, truncate
, writelines
, xreadlines
. If you are using Python 3, the seekable
method is also available.
The seekable
method was added.
Please login to continue.