rest_framework.fields.Field

class documentation

class Field: (source)

Known subclasses: rest_framework.fields.BooleanField, rest_framework.fields.CharField, rest_framework.fields.ChoiceField, rest_framework.fields.DateField, rest_framework.fields.DateTimeField, rest_framework.fields.DecimalField, rest_framework.fields.DictField, rest_framework.fields.DurationField, rest_framework.fields.FileField, rest_framework.fields.FloatField, rest_framework.fields.HiddenField, rest_framework.fields.IntegerField, rest_framework.fields.JSONField, rest_framework.fields.ListField, rest_framework.fields.ModelField, rest_framework.fields.ReadOnlyField, rest_framework.fields.SerializerMethodField, rest_framework.fields.TimeField, rest_framework.fields.UUIDField, rest_framework.relations.ManyRelatedField, rest_framework.relations.RelatedField, rest_framework.serializers.BaseSerializer, rest_framework.fields._UnvalidatedField

View In Hierarchy

Undocumented

Method __deepcopy__ When cloning fields we instantiate using the arguments it was originally created with, rather than copying the complete state.
Method __init__ Undocumented
Method __new__ When a field is instantiated, we store the arguments that were used, so that we can present a helpful representation of the object.
Method __repr__ Fields are represented using their initial calling arguments. This allows us to create descriptive representations for serializer instances that show all the declared fields on the serializer.
Method bind Initializes the field name and parent for the field instance. Called when a field is added to the parent serializer instance.
Method fail A helper method that simply raises a validation error.
Method get_attribute Given the *outgoing* object instance, return the primitive value that should be used for this field.
Method get_default Return the default value to use when validating data if no input is provided for this field.
Method get_initial Return a value to use when the field is being returned as a primitive value, without any object instance.
Method get_validators Undocumented
Method get_value Given the *incoming* primitive data, return the value for this field that should be validated and transformed to a native value.
Method run_validation Validate a simple representation and return the internal value.
Method run_validators Test the given value against all the validators on the field, and either raise a `ValidationError` or simply return.
Method to_internal_value Transform the *incoming* primitive data into a native value.
Method to_representation Transform the *outgoing* native value into primitive data.
Method validate_empty_values Validate empty values, and either:
Method validators.setter Undocumented
Class Variable default_error_messages Undocumented
Class Variable default_validators Undocumented
Instance Variable allow_null Undocumented
Instance Variable default Undocumented
Instance Variable default_empty_html Undocumented
Instance Variable error_messages Undocumented
Instance Variable field_name Undocumented
Instance Variable help_text Undocumented
Instance Variable initial Undocumented
Instance Variable label Undocumented
Instance Variable parent Undocumented
Instance Variable read_only Undocumented
Instance Variable required Undocumented
Instance Variable source Undocumented
Instance Variable source_attrs Undocumented
Instance Variable style Undocumented
Instance Variable write_only Undocumented
Property context Returns the context as passed to the root serializer on initialization.
Property root Returns the top-level serializer for this field.
Property validators Undocumented
Instance Variable _creation_counter Undocumented
Instance Variable _validators Undocumented
def __deepcopy__(self, memo): (source)

When cloning fields we instantiate using the arguments it was originally created with, rather than copying the complete state.

def __init__(self, *, read_only=False, write_only=False, required=None, default=empty, initial=empty, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False): (source)
overridden in rest_framework.fields.CharField, rest_framework.fields.ChoiceField, rest_framework.fields.DateField, rest_framework.fields.DateTimeField, rest_framework.fields.DecimalField, rest_framework.fields.DictField, rest_framework.fields.DurationField, rest_framework.fields.FileField, rest_framework.fields.FloatField, rest_framework.fields.HiddenField, rest_framework.fields.IntegerField, rest_framework.fields.JSONField, rest_framework.fields.ListField, rest_framework.fields.ModelField, rest_framework.fields.ReadOnlyField, rest_framework.fields.SerializerMethodField, rest_framework.fields.TimeField, rest_framework.fields.UUIDField, rest_framework.relations.ManyRelatedField, rest_framework.relations.RelatedField, rest_framework.serializers.BaseSerializer, rest_framework.fields._UnvalidatedField

Undocumented

def __new__(cls, *args, **kwargs): (source)
overridden in rest_framework.relations.RelatedField, rest_framework.serializers.BaseSerializer

When a field is instantiated, we store the arguments that were used, so that we can present a helpful representation of the object.

def __repr__(self): (source)
overridden in rest_framework.serializers.ListSerializer, rest_framework.serializers.Serializer

Fields are represented using their initial calling arguments. This allows us to create descriptive representations for serializer instances that show all the declared fields on the serializer.

def bind(self, field_name, parent): (source)
overridden in rest_framework.fields.SerializerMethodField

Initializes the field name and parent for the field instance. Called when a field is added to the parent serializer instance.

def fail(self, key, **kwargs): (source)

A helper method that simply raises a validation error.

def get_attribute(self, instance): (source)
overridden in rest_framework.fields.ModelField, rest_framework.relations.ManyRelatedField, rest_framework.relations.RelatedField

Given the *outgoing* object instance, return the primitive value that should be used for this field.

def get_default(self): (source)

Return the default value to use when validating data if no input is provided for this field. If a default has not been set for this field then this will simply raise `SkipField`, indicating that no value should be set in the validated data for this field.

def get_initial(self): (source)
overridden in rest_framework.serializers.ListSerializer, rest_framework.serializers.Serializer

Return a value to use when the field is being returned as a primitive value, without any object instance.

def get_validators(self): (source)
overridden in rest_framework.serializers.Serializer

Undocumented

def get_value(self, dictionary): (source)
overridden in rest_framework.fields.DictField, rest_framework.fields.HiddenField, rest_framework.fields.JSONField, rest_framework.fields.ListField, rest_framework.fields.MultipleChoiceField, rest_framework.relations.ManyRelatedField, rest_framework.serializers.ListSerializer, rest_framework.serializers.Serializer

Given the *incoming* primitive data, return the value for this field that should be validated and transformed to a native value.

def run_validation(self, data=empty): (source)
overridden in rest_framework.fields.CharField, rest_framework.relations.RelatedField, rest_framework.serializers.ListSerializer, rest_framework.serializers.Serializer

Validate a simple representation and return the internal value. The provided data may be `empty` if no representation was included in the input. May raise `SkipField` if the field should not be included in the validated data.

def run_validators(self, value): (source)
overridden in rest_framework.serializers.Serializer

Test the given value against all the validators on the field, and either raise a `ValidationError` or simply return.

def to_internal_value(self, data): (source)
overridden in rest_framework.fields.BooleanField, rest_framework.fields.CharField, rest_framework.fields.ChoiceField, rest_framework.fields.DateField, rest_framework.fields.DateTimeField, rest_framework.fields.DecimalField, rest_framework.fields.DictField, rest_framework.fields.DurationField, rest_framework.fields.FileField, rest_framework.fields.FloatField, rest_framework.fields.HiddenField, rest_framework.fields.IntegerField, rest_framework.fields.JSONField, rest_framework.fields.ListField, rest_framework.fields.ModelField, rest_framework.fields.TimeField, rest_framework.fields.UUIDField, rest_framework.relations.HyperlinkedRelatedField, rest_framework.relations.ManyRelatedField, rest_framework.relations.PrimaryKeyRelatedField, rest_framework.relations.SlugRelatedField, rest_framework.serializers.BaseSerializer, rest_framework.fields._UnvalidatedField

Transform the *incoming* primitive data into a native value.

def to_representation(self, value): (source)
overridden in rest_framework.fields.BooleanField, rest_framework.fields.CharField, rest_framework.fields.ChoiceField, rest_framework.fields.DateField, rest_framework.fields.DateTimeField, rest_framework.fields.DecimalField, rest_framework.fields.DictField, rest_framework.fields.DurationField, rest_framework.fields.FileField, rest_framework.fields.FloatField, rest_framework.fields.IntegerField, rest_framework.fields.JSONField, rest_framework.fields.ListField, rest_framework.fields.ModelField, rest_framework.fields.ReadOnlyField, rest_framework.fields.SerializerMethodField, rest_framework.fields.TimeField, rest_framework.fields.UUIDField, rest_framework.relations.HyperlinkedRelatedField, rest_framework.relations.ManyRelatedField, rest_framework.relations.PrimaryKeyRelatedField, rest_framework.relations.SlugRelatedField, rest_framework.relations.StringRelatedField, rest_framework.serializers.BaseSerializer, rest_framework.fields._UnvalidatedField

Transform the *outgoing* native value into primitive data.

def validate_empty_values(self, data): (source)
overridden in rest_framework.fields.DecimalField

Validate empty values, and either: * Raise `ValidationError`, indicating invalid data. * Raise `SkipField`, indicating that the field should be ignored. * Return (True, data), indicating an empty value that should be returned without any further validation being applied. * Return (False, data), indicating a non-empty value, that should have validation applied as normal.

@validators.setter
def validators(self, validators): (source)

Undocumented

default_error_messages = (source)
overridden in rest_framework.fields.BooleanField, rest_framework.fields.CharField, rest_framework.fields.ChoiceField, rest_framework.fields.DateField, rest_framework.fields.DateTimeField, rest_framework.fields.DecimalField, rest_framework.fields.DictField, rest_framework.fields.DurationField, rest_framework.fields.FileField, rest_framework.fields.FloatField, rest_framework.fields.IntegerField, rest_framework.fields.JSONField, rest_framework.fields.ListField, rest_framework.fields.ModelField, rest_framework.fields.TimeField, rest_framework.fields.UUIDField, rest_framework.relations.HyperlinkedRelatedField, rest_framework.relations.ManyRelatedField, rest_framework.relations.PrimaryKeyRelatedField, rest_framework.relations.SlugRelatedField, rest_framework.serializers.ListSerializer, rest_framework.serializers.Serializer

Undocumented

default_validators: list = (source)

Undocumented

allow_null = (source)
overridden in rest_framework.fields._UnvalidatedField

Undocumented

default = (source)

Undocumented

default_empty_html = (source)
overridden in rest_framework.fields.BooleanField, rest_framework.fields.MultipleChoiceField, rest_framework.relations.ManyRelatedField

Undocumented

error_messages = (source)

Undocumented

field_name = (source)

Undocumented

help_text = (source)

Undocumented

initial = (source)
overridden in rest_framework.fields.BooleanField, rest_framework.fields.CharField, rest_framework.fields.DictField, rest_framework.fields.ListField, rest_framework.relations.ManyRelatedField

Undocumented

label = (source)

Undocumented

parent = (source)

Undocumented

read_only = (source)

Undocumented

required = (source)

Undocumented

source = (source)

Undocumented

source_attrs: list = (source)

Undocumented

style = (source)

Undocumented

write_only = (source)

Undocumented

@property
context = (source)

Returns the context as passed to the root serializer on initialization.

@property
root = (source)

Returns the top-level serializer for this field.

@property
validators = (source)

Undocumented

_creation_counter = (source)

Undocumented

_validators = (source)

Undocumented