The File
object¶
The django.core.files
module and its submodules contain built-in classes
for basic file handling in Django.
The File
class¶
-
class
File
(file_object, name=None)[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.It can be used as a context manager, e.g.
with file.open() as f:
.
-
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
.
In addition to the listed methods,
File
exposes the following attributes and methods of itsfile
object:encoding
,fileno
,flush
,isatty
,newlines
,read
,readinto
,readline
,readlines
,seek
,tell
,truncate
,write
,writelines
,readable()
,writable()
, andseekable()
.-
The ContentFile
class¶
-
class
ContentFile
(content, name=None)[source]¶ The
ContentFile
class inherits fromFile
, but unlikeFile
it operates on string content (bytes also supported), rather than an actual file. For example:from django.core.files.base import ContentFile f1 = ContentFile("esta frase está en español") f2 = ContentFile(b"these are bytes")
The ImageFile
class¶
-
class
ImageFile
(file_object, name=None)[source]¶ Django provides a built-in class specifically for images.
django.core.files.images.ImageFile
inherits all the attributes and methods ofFile
, and additionally provides the following:-
width
¶ Width of the image in pixels.
-
height
¶ Height of the image in pixels.
-
Additional methods on files attached to objects¶
Any File
that is associated with an object (as with Car.photo
,
below) will also have a couple of extra methods:
-
File.
save
(name, content, save=True)¶ Saves a new file with the file name and contents provided. This will not replace the existing file, but will create a new file and update the object to point to it. If
save
isTrue
, the model’ssave()
method will be called once the file is saved. That is, these two lines:>>> car.photo.save('myphoto.jpg', content, save=False) >>> car.save()
are equivalent to:
>>> car.photo.save('myphoto.jpg', content, save=True)
Note that the
content
argument must be an instance of eitherFile
or of a subclass ofFile
, such asContentFile
.
-
File.
delete
(save=True)¶ Removes the file from the model instance and deletes the underlying file. If
save
isTrue
, the model’ssave()
method will be called once the file is deleted.