model reference ` のドキュメントには、Djangoの標準フィールドクラスの使用方法が説明されています--:class:`~django.db.models.CharField`や、:class:`~django.db.models.DateField などです。多くの目的、それらのクラスはあなたが必要とするすべてです。 ただし、Djangoバージョンが正確な要件を満たしていない場合や、Djangoに同梱されているものとはまったく異なるフィールドを使用したい場合があります。
Djangoの組み込みフィールドタイプは、可能なすべてのデータベース列タイプをカバーしているわけではありません-VARCHAR や INTEGER などの一般的なタイプのみです。 地理的なポリゴンや、 PostgreSQL custom types`_などのユーザー作成タイプなど、より不明瞭な列タイプについては、独自のDjangoの ``Field` サブクラスを定義できます。
あるいは、標準のデータベース列タイプに適合するように何らかの方法でシリアル化できる複雑なPythonオブジェクトがある場合があります。 これは Field サブクラスがオブジェクトをモデルで使用するのに役立つ別のケースです。
カスタムフィールドを作成するには、詳細に少し注意する必要があります。 物事をわかりやすくするために、このドキュメント全体で一貫した例を使用します: Bridge_の手でカードの取引を表すPythonオブジェクトをラップします。 心配しないでください。この例に従うためにBridgeをプレイする方法を知る必要はありません。 52枚のカードが、伝統的に*北*、東、*南*および*西*と呼ばれる4人のプレイヤーに均等に配られることだけを知っておく必要があります。 クラスは次のようになります:
class Hand:
"""A hand of cards (bridge style)"""
def __init__(self, north, east, south, west):
# Input parameters are lists of cards ('Ah', '9s', etc.)
self.north = north
self.east = east
self.south = south
self.west = west
# ... (other possibly useful methods omitted) ...
これはDjangoの仕様を使っていない、普通のPythonクラスです。モデルでこれと同じようなことを実行できるようにしたいと思います（モデルの中の``hand``属性は``Hand``インスタンスだと想定しています）
example = MyModel.objects.get(pk=1)
print(example.hand.north)
new_hand = Hand(north, east, south, west)
example.hand = new_hand
example.save()
他のPythonクラスと同様に、モデルの hand 属性に割り当てたり、そこから取得したりします。コツは、そのようなオブジェクトの保存と読み込みの処理方法をDjangoに伝えることです。
モデルで Hand クラスを使用するために、このクラスを変更する必要はありません。 これは、ソースコードを変更できない既存のクラスのモデルサポートを簡単に記述できるため、理想的です。
注釈
カスタムデータベースの列タイプのみを利用し、データをモデル内の標準Pythonタイプとして処理したい場合があります。 たとえば、文字列または浮動小数点数です。 このケースは Hand の例に似ており、今後の相違点に注意します。
モデルフィールドを始めてみましょう。まず、モデルフィールドを分解してみます。モデルフィールドは普通のPythonオブジェクト（string,boolean,``datetime``,それに``Hand``のような複雑なもの）を取得し、それをフォーマットとの間で変換する方法を提供します。これはデータベースとやりとりするときに役立ちます。（このような形式はシリアル化にも役立ちますが、後で説明するように、データベース側の制御を知っていると、より簡単になります）
モデルのフィールドは、何らかの方法で既存のデータベース列タイプに適合するように変換する必要があります。 データベースが異なれば有効な列タイプのセットも異なりますが、ルールは同じです。使用する必要があるのはこれらのタイプのみです。 データベースに保存するものはすべて、これらのタイプのいずれかに収まる必要があります。
通常、特定のデータベースの列タイプに一致するようにDjangoフィールドを作成するか、データを文字列などに変換する方法が必要になります。
Hand の例では、すべてのカードをあらかじめ決められた順序で連結することで、カードデータを104文字の文字列に変換できます。たとえば、すべての*北*カード、次に*東* 、*南*および*西*カードです。 したがって、Hand オブジェクトをデータベースのテキストまたは文字列に保存できます。
Djangoのすべてのフィールド（およびこのドキュメントで fields と言うときは、常に form fields ではなくモデルフィールドを意味します）は django.db.models.Field のサブクラスです。 Djangoがフィールドについて記録する情報のほとんどは、名前、ヘルプテキスト、一意性など、すべてのフィールドに共通です。 すべての情報を保存することは Field によって処理されます。 Field ができることの詳細については、後で詳しく説明します。 とりあえず、すべてが Field から派生し、クラスの動作の重要な部分をカスタマイズすると言うだけで十分です。
Djangoフィールドクラスは、モデル属性に格納されているものではないことを理解することが重要です。 モデル属性には通常のPythonオブジェクトが含まれます。 モデルで定義するフィールドクラスは、モデルクラスが作成されるときに実際に Meta クラスに保存されます（これを行う方法の正確な詳細はここでは重要ではありません）。 これは、属性を作成および変更するだけの場合、フィールドクラスは必要ないためです。 代わりに、属性値とデータベースに保存されているもの、または serializer に送信されるものとの間で変換するための機構を提供します。
独自のカスタムフィールドを作成する場合は、このことに留意してください。 作成するDjangoの Field サブクラスは、Pythonインスタンスとデータベース/シリアライザーの値をさまざまな方法で変換するための機構を提供します（たとえば、値の保存とルックアップでの値の使用には違いがあります）。 これが少しトリッキーに聞こえる場合でも、心配しないでください。以下の例で明らかになります。 カスタムフィールドが必要な場合、しばしば2つのクラスを作成することになります:
Hand クラスです。Field サブクラスです。これは、最初のクラスを永続ストレージ形式とPython形式の間で変換する方法を知っているクラスです。When planning your Field subclass, first give some
thought to which existing Field class your new field
is most similar to. Can you subclass an existing Django field and save yourself
some work? If not, you should subclass the Field
class, from which everything is descended.
新しいフィールドの初期化は、ケース固有の引数を共通の引数から分離し、後者を Field の __init__() メソッドに渡すことです。 （または親クラスに対して）。
この例では HandField を呼び出しています。（ Field サブクラス <Something>Field と名付けることをオススメします。 Field サブクラスであることが簡単にわかるためです）
既存のフィールドのようには動作しないため、この例では Field から直接サブクラス化しています。
from django.db import models
class HandField(models.Field):
description = "A hand of cards (bridge style)"
def __init__(self, *args, **kwargs):
kwargs['max_length'] = 104
super().__init__(*args, **kwargs)
Our HandField accepts most of the standard field options (see the list
below), but we ensure it has a fixed length, since it only needs to hold 52
card values plus their suits; 104 characters in total.
注釈
多くのDjangoのモデルフィールドは、受け取ってもなにも起こらないオプションを受け取ります。例えば、 editable と auto_now は django.db.models.DateField に渡すことができますが、 editable のパラメーターを無視します。（ auto_now には editable=False がセットされています）
この場合、エラーは発生しません。
この振る舞いはフィールドクラスをシンプルにします。なぜなら、必要のないオプションをチェックする必要がないからです。すべてのオプションを親クラスに渡し、オプションを使用しないのです。フィールドにより厳密にオプションを扱ってほしいのか、より柔軟なカレントフィールドの動作を使うのかは、使う人次第です。
The Field.__init__() method takes the following parameters:
verbose_namenameprimary_keymax_lengthuniqueblanknulldb_indexrel: 関連フィールドに使用される (ForeignKey など)。上級者向けです。defaulteditableserialize: False の場合、Django の serializers にモデルが渡されたときに、フィールドをシリアライズしません。デフォルトの値は True です。unique_for_dateunique_for_monthunique_for_yearchoiceshelp_textdb_columndb_tablespace: はインデックスの作成のみ行います。通常、このオプションは無視できます。OneToOneField のように、フィールドが自動的に作成された場合は、auto_created は True です。 高度な使用向けです。上記のリストに説明のないオプションはすべて、通常のDjangoフィールドと同じ意味を持ちます。例と詳細については、 field documentation を参照してください。
__init__() メソッドとは対照的なものとして、~.Field.deconstruct`メソッドがあります。これは:doc:`model migrations 中に使用されるもので、新しいフィールドのインスタンスを取得する方法、インスタンスをどのようにシリアル化して減らすかの方法をDjangoに指示します。（特に、インスタンスを再生成するためにどの引数を``__init__()``に渡すかを指示します）
継承元のフィールドの上に追加のオプションを追加していない場合、新しい deconstruct() メソッドを記述する必要はありません。 ただし、__init__() で渡される引数を変更する場合（HandField のように）、渡される値を補足する必要があります。
deconstruct() 関数は4つのアイテムを含むタプルを返します。それは、フィールドの属性、インポートするフィールドクラスのフルパス、位置引数（リスト型）、キーワード引数（辞書型）です。
この関数は deconstruct() メソッドとは異なることに注意してください。 deconstruct() メソッドは for custom classes で、3つのアイテムを含むタプルを返します。
カスタムフィールドの作成者は、最初の2つの値を気にする必要はありません。 ベース Field クラスには、フィールドの属性名とインポートパスを計算するためのすべてのコードがあります。 ただし、位置引数とキーワード引数は、変更する可能性が高いため、注意する必要があります。
たとえば、 HandField クラスでは、常に __init__() でmax_lengthを強制的に設定しています。 Field ベースクラスの deconstruct() メソッドはこれを見て、キーワード引数でそれを返そうとします。 したがって、読みやすくするためにキーワード引数から削除できます:
from django.db import models
class HandField(models.Field):
def __init__(self, *args, **kwargs):
kwargs['max_length'] = 104
super().__init__(*args, **kwargs)
def deconstruct(self):
name, path, args, kwargs = super().deconstruct()
del kwargs["max_length"]
return name, path, args, kwargs
新しいキーワード引数を追加する場合、自分で kwargs に値を設定する deconstruct() でコードを記述する必要があります。 また、デフォルト値が使用されている場合など、フィールドの状態を再構築する必要がない場合は、kwargs から値を省略してください:
from django.db import models
class CommaSepField(models.Field):
"Implements comma-separated storage of lists"
def __init__(self, separator=",", *args, **kwargs):
self.separator = separator
super().__init__(*args, **kwargs)
def deconstruct(self):
name, path, args, kwargs = super().deconstruct()
# Only include kwarg if it's not the default
if self.separator != ",":
kwargs['separator'] = self.separator
return name, path, args, kwargs
More complex examples are beyond the scope of this document, but remember -
for any configuration of your Field instance, deconstruct() must return
arguments that you can pass to __init__ to reconstruct that state.
Pay extra attention if you set new default values for arguments in the
Field superclass; you want to make sure they're always included, rather
than disappearing if they take on the old default value.
In addition, try to avoid returning values as positional arguments; where possible, return values as keyword arguments for maximum future compatibility. If you change the names of things more often than their position in the constructor's argument list, you might prefer positional, but bear in mind that people will be reconstructing your field from the serialized version for quite a while (possibly years), depending how long your migrations live for.
You can see the results of deconstruction by looking in migrations that include the field, and you can test deconstruction in unit tests by deconstructing and reconstructing the field:
name, path, args, kwargs = my_field_instance.deconstruct()
new_instance = MyField(*args, **kwargs)
self.assertEqual(my_field_instance.some_attribute, new_instance.some_attribute)
Djangoは変更を検出して移行を行わないため、カスタムフィールドの基本クラスを変更することはできません。たとえば、次で始まる場合:
class CustomCharField(models.CharField):
...
そして、代わりに TextField を使用することに決めた場合、サブクラスを次のように変更することはできません:
class CustomCharField(models.TextField):
...
代わりに、新しいカスタムフィールドクラスを作成し、モデルを更新してそれを参照する必要があります:
class CustomCharField(models.CharField):
...
class CustomTextField(models.TextField):
...
As discussed in removing fields, you
must retain the original CustomCharField class as long as you have
migrations that reference it.
As always, you should document your field type, so users will know what it is.
In addition to providing a docstring for it, which is useful for developers,
you can also allow users of the admin app to see a short description of the
field type via the django.contrib.admindocs application. To do this provide descriptive
text in a description class attribute of your custom field. In
the above example, the description displayed by the admindocs application
for a HandField will be 'A hand of cards (bridge style)'.
In the django.contrib.admindocs display, the field description is
interpolated with field.__dict__ which allows the description to
incorporate arguments of the field. For example, the description for
CharField is:
description = _("String (up to %(max_length)s)")
Field サブクラスを作成したら、フィールドの動作に応じて、いくつかの標準メソッドをオーバーライドすることを検討できます。以下のメソッドのリストは、おおよそ重要度の高いものから順に並んでいるので、上から始めてください。
Say you've created a PostgreSQL custom type called mytype. You can
subclass Field and implement the db_type() method, like so:
from django.db import models
class MytypeField(models.Field):
def db_type(self, connection):
return 'mytype'
MytypeField を取得したら、他の``Field`` タイプと同様に、どのモデルでも使用できます:
class Person(models.Model):
name = models.CharField(max_length=80)
something_else = MytypeField()
If you aim to build a database-agnostic application, you should account for
differences in database column types. For example, the date/time column type
in PostgreSQL is called timestamp, while the same column in MySQL is called
datetime. You can handle this in a db_type() method by
checking the connection.vendor attribute. Current built-in vendor names
are: sqlite, postgresql, mysql, and oracle.
例:
class MyDateField(models.Field):
def db_type(self, connection):
if connection.vendor == 'mysql':
return 'datetime'
else:
return 'timestamp'
The db_type() and rel_db_type() methods are called by
Django when the framework constructs the CREATE TABLE statements for your
application -- that is, when you first create your tables. The methods are also
called when constructing a WHERE clause that includes the model field --
that is, when you retrieve data using QuerySet methods like get(),
filter(), and exclude() and have the model field as an argument. They
are not called at any other time, so it can afford to execute slightly complex
code, such as the connection.settings_dict check in the above example.
Some database column types accept parameters, such as CHAR(25), where the
parameter 25 represents the maximum column length. In cases like these,
it's more flexible if the parameter is specified in the model rather than being
hard-coded in the db_type() method. For example, it wouldn't make much
sense to have a CharMaxlength25Field, shown here:
# This is a silly example of hard-coded parameters.
class CharMaxlength25Field(models.Field):
def db_type(self, connection):
return 'char(25)'
# In the model:
class MyModel(models.Model):
# ...
my_field = CharMaxlength25Field()
The better way of doing this would be to make the parameter specifiable at run
time -- i.e., when the class is instantiated. To do that, implement
Field.__init__(), like so:
# This is a much more flexible example.
class BetterCharField(models.Field):
def __init__(self, max_length, *args, **kwargs):
self.max_length = max_length
super().__init__(*args, **kwargs)
def db_type(self, connection):
return 'char(%s)' % self.max_length
# In the model:
class MyModel(models.Model):
# ...
my_field = BetterCharField(25)
Finally, if your column requires truly complex SQL setup, return None from
db_type(). This will cause Django's SQL creation code to skip
over this field. You are then responsible for creating the column in the right
table in some other way, but this gives you a way to tell Django to get out of
the way.
The rel_db_type() method is called by fields such as ForeignKey
and OneToOneField that point to another field to determine their database
column data types. For example, if you have an UnsignedAutoField, you also
need the foreign keys that point to that field to use the same data type:
# MySQL unsigned integer (range 0 to 4294967295).
class UnsignedAutoField(models.AutoField):
def db_type(self, connection):
return 'integer UNSIGNED AUTO_INCREMENT'
def rel_db_type(self, connection):
return 'integer UNSIGNED'
If your custom Field class deals with data structures that are more
complex than strings, dates, integers, or floats, then you may need to override
from_db_value() and to_python().
If present for the field subclass, from_db_value() will be called in all
circumstances when the data is loaded from the database, including in
aggregates and values() calls.
to_python() is called by deserialization and during the
clean() method used from forms.
As a general rule, to_python() should deal gracefully with any of the
following arguments:
Hand in our ongoing example).None (フィールドが null=True を許す場合)In our HandField class, we're storing the data as a VARCHAR field in the
database, so we need to be able to process strings and None in the
from_db_value(). In to_python(), we need to also handle Hand
instances:
import re
from django.core.exceptions import ValidationError
from django.db import models
from django.utils.translation import gettext_lazy as _
def parse_hand(hand_string):
"""Takes a string of cards and splits into a full hand."""
p1 = re.compile('.{26}')
p2 = re.compile('..')
args = [p2.findall(x) for x in p1.findall(hand_string)]
if len(args) != 4:
raise ValidationError(_("Invalid input for a Hand instance"))
return Hand(*args)
class HandField(models.Field):
# ...
def from_db_value(self, value, expression, connection):
if value is None:
return value
return parse_hand(value)
def to_python(self, value):
if isinstance(value, Hand):
return value
if value is None:
return value
return parse_hand(value)
Notice that we always return a Hand instance from these methods. That's the
Python object type we want to store in the model's attribute.
For to_python(), if anything goes wrong during value conversion, you should
raise a ValidationError exception.
Since using a database requires conversion in both ways, if you override
from_db_value() you also have to override
get_prep_value() to convert Python objects back to query values.
例:
class HandField(models.Field):
# ...
def get_prep_value(self, value):
return ''.join([''.join(l) for l in (value.north,
value.east, value.south, value.west)])
警告
If your custom field uses the CHAR, VARCHAR or TEXT
types for MySQL, you must make sure that get_prep_value()
always returns a string type. MySQL performs flexible and unexpected
matching when a query is performed on these types and the provided
value is an integer, which can cause queries to include unexpected
objects in their results. This problem cannot occur if you always
return a string type from get_prep_value().
Some data types (for example, dates) need to be in a specific format
before they can be used by a database backend.
get_db_prep_value() is the method where those conversions should
be made. The specific connection that will be used for the query is
passed as the connection parameter. This allows you to use
backend-specific conversion logic if it is required.
For example, Django uses the following method for its
BinaryField:
def get_db_prep_value(self, value, connection, prepared=False):
value = super().get_db_prep_value(value, connection, prepared)
if value is not None:
return connection.Database.Binary(value)
return value
In case your custom field needs a special conversion when being saved that is
not the same as the conversion used for normal query parameters, you can
override get_db_prep_save().
If you want to preprocess the value just before saving, you can use
pre_save(). For example, Django's
DateTimeField uses this method to set the attribute
correctly in the case of auto_now or
auto_now_add.
もしこのメソッドをオーバーライドするならば、最後にその属性の値を返す必要があります。さらに、もしその値になんらかの変更を加えたならば、そのモデルへの参照を含んでいるコードが常に正しい値を指すように、モデルの属性を更新しなくてはなりません。
To customize the form field used by ModelForm, you can
override formfield().
The form field class can be specified via the form_class and
choices_form_class arguments; the latter is used if the field has choices
specified, the former otherwise. If these arguments are not provided,
CharField or TypedChoiceField
will be used.
All of the kwargs dictionary is passed directly to the form field's
__init__() method. Normally, all you need to do is set up a good default
for the form_class (and maybe choices_form_class) argument and then
delegate further handling to the parent class. This might require you to write
a custom form field (and even a form widget). See the forms documentation for information about this.
Continuing our ongoing example, we can write the formfield() method
as:
class HandField(models.Field):
# ...
def formfield(self, **kwargs):
# This is a fairly standard way to set up some defaults
# while letting the caller override them.
defaults = {'form_class': MyFormField}
defaults.update(kwargs)
return super().formfield(**defaults)
This assumes we've imported a MyFormField field class (which has its own
default widget). This document doesn't cover the details of writing custom form
fields.
If you have created a db_type() method, you don't need to worry about
get_internal_type() -- it won't be used much. Sometimes, though, your
database storage is similar in type to some other field, so you can use that
other field's logic to create the right column.
例:
class HandField(models.Field):
# ...
def get_internal_type(self):
return 'CharField'
No matter which database backend we are using, this will mean that
migrate and other SQL commands create the right column type for
storing a string.
If get_internal_type() returns a string that is not known to Django for
the database backend you are using -- that is, it doesn't appear in
django.db.backends.<db_name>.base.DatabaseWrapper.data_types -- the string
will still be used by the serializer, but the default db_type()
method will return None. See the documentation of db_type()
for reasons why this might be useful. Putting a descriptive string in as the
type of the field for the serializer is a useful idea if you're ever going to
be using the serializer output in some other place, outside of Django.
To customize how the values are serialized by a serializer, you can override
value_to_string(). Using value_from_object() is the
best way to get the field's value prior to serialization. For example, since
HandField uses strings for its data storage anyway, we can reuse some
existing conversion code:
class HandField(models.Field):
# ...
def value_to_string(self, obj):
value = self.value_from_object(obj)
return self.get_prep_value(value)
Writing a custom field can be a tricky process, particularly if you're doing complex conversions between your Python types and your database and serialization formats. Here are a couple of tips to make things go more smoothly:
django/db/models/fields/__init__.py) for inspiration. Try to find
a field that's similar to what you want and extend it a little bit,
instead of creating an entirely new field from scratch.__str__() method on the class you're wrapping up as a field. There
are a lot of places where the default behavior of the field code is to call
str() on the value. (In our examples in this document, value would
be a Hand instance, not a HandField). So if your __str__()
method automatically converts to the string form of your Python object, you
can save yourself a lot of work.FileField サブクラスを書く¶In addition to the above methods, fields that deal with files have a few other
special requirements which must be taken into account. The majority of the
mechanics provided by FileField, such as controlling database storage and
retrieval, can remain unchanged, leaving subclasses to deal with the challenge
of supporting a particular type of file.
Django provides a File class, which is used as a proxy to the file's
contents and operations. This can be subclassed to customize how the file is
accessed, and what methods are available. It lives at
django.db.models.fields.files, and its default behavior is explained in the
file documentation.
Once a subclass of File is created, the new FileField subclass must be
told to use it. To do so, assign the new File subclass to the special
attr_class attribute of the FileField subclass.
上記の詳細に加えて、フィールドのコードの効率と読みやすさを劇的に改善するいくつかのガイドラインがあります。
ImageField (in
django/db/models/fields/files.py) is a great example of how to
subclass FileField to support a particular type of file, as it
incorporates all of the techniques described above.2022年6月01日