The File objectLink to this heading#

The File classLink to this heading#

class File(file_object)Link to this definition#

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:

nameLink to this definition#

The name of the file including the relative path from MEDIA_ROOT.

sizeLink to this definition#

The size of the file in bytes.

fileLink to this definition#

The underlying file object that this class wraps.

modeLink to this definition#

The read/write mode for the file.

open(mode=None)Link to this definition#

Open or reopen the file (which also does File.seek(0)). The mode argument allows the same values as Python’s built-in open().

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)Link to this definition#

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__()Link to this definition#

Iterate over the file yielding one line at a time.

chunks(chunk_size=None)Link to this definition#

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)Link to this definition#

Returns True if the file is large enough to require multiple chunks to access all of its content give some chunk_size.

write(content)Link to this definition#

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()Link to this definition#

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 ContentFile classLink to this heading#

class ContentFile(File)Link to this definition#

The ContentFile class inherits from File, but unlike File it operates on string content (bytes also supported), rather than an actual file. For example:

Code

from __future__ import unicode_literals
from django.core.files.base import ContentFile

f1 = ContentFile("esta sentencia está en español")
f2 = ContentFile(b"these are bytes")

The ImageFile classLink to this heading#

class ImageFile(file_object)Link to this definition#

Django provides a built-in class specifically for images. django.core.files.images.ImageFile inherits all the attributes and methods of File, and additionally provides the following:

widthLink to this definition#

Width of the image in pixels.

heightLink to this definition#

Height of the image in pixels.

Additional methods on files attached to objectsLink to this heading#

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)Link to this definition#

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 is True, the model’s save() method will be called once the file is saved. That is, these two lines:

Code

>>> car.photo.save('myphoto.jpg', content, save=False)
>>> car.save()

are equivalent to:

Code

>>> car.photo.save('myphoto.jpg', content, save=True)

Note that the content argument must be an instance of either File or of a subclass of File, such as ContentFile.

File.delete(save=True)Link to this definition#

Removes the file from the model instance and deletes the underlying file. If save is True, the model’s save() method will be called once the file is deleted.