File オブジェクトLink to this heading#

File クラスLink to this heading#

class File(file_object, name=None)Link to this definition#

File クラスは、Python の file object に Django 特有の追加機能を付け加えた薄いラッパーです。内部的でファイルを表現する必要がある場合には、Django はこのクラスを使います。

File オブジェクトには次の属性とメソッドを持ちます。

nameLink to this definition#

MEDIA_ROOT からの相対パスを含むファイル名です。

sizeLink to this definition#

バイト単位で表されたファイルサイズ。

fileLink to this definition#

このクラスがラッピングしている、素の file object クラスです。

modeLink to this definition#

ファイルの読み込み/書き込みのモードです。

open(mode=None, *args, **kwargs)Link to this definition#

ファイルを開くか再オープンします（これは File.seek(0) も行います）。 mode 引数は、Python の組み込み関数 open() と同じ値を許可します。 *args と **kwargs は、mode の後に、Python の組み込み関数 open() に渡されます。

ファイルを再オープンする際、 mode はファイルが元々開かれていたモードを上書きします。 None はオリジナルのモードで再オープンすることを意味します。

コンテキストマネージャとして使用できます。たとえば、 with file.open() as f: のようにです。

__iter__()Link to this definition#

ファイルをイテレートして、1行ずつ返します。

chunks(chunk_size=None)Link to this definition#

ファイルをイテレートし、指定されたサイズの「チャンク」を生成します。 chunk_size のデフォルトは 64 KB です。

これは非常に大きなファイルに特に便利であり、ディスクからストリーミングしてメモリ全体にファイルを保存することを避けることができます。

multiple_chunks(chunk_size=None)Link to this definition#

chunk_size (一括サイズ) で指定されたファイルの全内容にアクセスするために複数のチャンクが必要な場合は True を返します。

close()Link to this definition#

ファイルを閉じてください。

リストされたメソッドに加えて、File は、その file オブジェクトの以下の属性とメソッドを公開しています: encoding, fileno, flush, isatty, newlines, read, readinto, readline, readlines, seek, tell, truncate, write, writelines, readable(), writable(), および seekable() 。

ContentFile クラスLink to this heading#

class ContentFile(content, name=None)Link to this definition#

ContentFile クラスは File を継承していますが、File とは異なり、実際のファイルではなく文字列コンテンツ(バイトもサポート)で操作します。例えば：

Code

from django.core.files.base import ContentFile

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

ImageFile クラスLink to this heading#

class ImageFile(file_object, name=None)Link to this definition#

Django には画像専用の組み込みクラスがあります。 django.core.files.images.ImageFile は File のすべての属性とメソッドを継承し、さらに次のものを提供します:

widthLink to this definition#

画像の幅 (ピクセル単位)。

heightLink to this definition#

画像の高さ(ピクセル単位)。

オブジェクトに添付されたファイルに関する追加メソッドLink to this heading#

オブジェクト（以下の Car.photo のように）に関連付けられた File には、いくつかの追加メソッドも用意されています。

File.save(name, content, save=True)Link to this definition#

提供されたファイル名と内容で新しいファイルを保存します。これは既存のファイルを置き換えるものではありませんが、新しいファイルを作成し、オブジェクトがそれを指すように更新します。 save が True の場合、ファイルが保存されたらモデルの save() メソッドが一度呼び出されます。つまり、次の二行です:

Python console

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

これは以下と同等です:

Python console

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

content 引数は、 File または File のサブクラス（例えば、 ContentFile など）のインスタンスでなければなりません。

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

モデルインスタンスからファイルを削除し、基になるファイルも削除します。 save が True の場合、ファイルが削除された後にモデルの save() メソッドが一度呼び出されます。