django.core.files
module and its submodules contain built-in classesfor basic file handling in Django.File
class¶File
(file_object)[source]¶File
class is a thin wrapper around a Pythonfile 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
¶MEDIA_ROOT
.size
¶file
¶File
, includingContentFile
andFieldFile
, may replace thisattribute with an object other than a Python file object.In these cases, this attribute may itself be a File
subclass (and not necessarily the same subclass). Wheneverpossible, use the attributes and methods of the subclass itselfrather than the those of the subclass’s file
attribute.mode
¶open
(mode=None)[source]¶File.seek(0)
).The mode
argument allows the same valuesas Python’s built-in open()
.mode
will override whatever mode the filewas originally opened with; None
means to reopen with the originalmode.withfile.open()asf:
.__iter__
()[source]¶chunks
(chunk_size=None)[source]¶chunk_size
defaults to 64 KB.multiple_chunks
(chunk_size=None)[source]¶True
if the file is large enough to require multiple chunksto access all of its content give some chunk_size
.close
()[source]¶File
exposesthe following attributes and methods of its file
object:encoding
, fileno
, flush
, isatty
, newlines
, read
,readinto
, readline
, readlines
, seek
, tell
,truncate
, write
, writelines
, readable()
, writable()
,and seekable()
.ContentFile
class¶ContentFile
(File)[source]¶ContentFile
class inherits from File
,but unlike File
it operates on string content(bytes also supported), rather than an actual file. For example:ImageFile
class¶ImageFile
(file_object)[source]¶django.core.files.images.ImageFile
inherits all the attributesand methods of File
, and additionallyprovides the following:width
¶height
¶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)¶save
is True
, the model’s save()
method willbe called once the file is saved. That is, these two lines:content
argument must be an instance of eitherFile
or of a subclass of File
, such asContentFile
.File.
delete
(save=True)¶save
is True
, the model’s save()
method will be called oncethe file is deleted.