rest_framework.relations.RelatedField

class documentation

class RelatedField(Field): (source)

Known subclasses: rest_framework.relations.HyperlinkedRelatedField, rest_framework.relations.PrimaryKeyRelatedField, rest_framework.relations.SlugRelatedField, rest_framework.relations.StringRelatedField

View In Hierarchy

Undocumented

Class Method many_init This method handles creating a parent `ManyRelatedField` instance when the `many=True` keyword argument is passed.
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 display_value Undocumented
Method get_attribute Given the *outgoing* object instance, return the primitive value that should be used for this field.
Method get_choices Undocumented
Method get_queryset Undocumented
Method iter_options Undocumented
Method run_validation Validate a simple representation and return the internal value.
Method use_pk_only_optimization Undocumented
Instance Variable html_cutoff Undocumented
Instance Variable html_cutoff_text Undocumented
Instance Variable queryset Undocumented
Property choices Undocumented
Property grouped_choices Undocumented

Inherited from Field:

Method __deepcopy__ When cloning fields we instantiate using the arguments it was originally created with, rather than copying the complete state.
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_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_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
@classmethod
def many_init(cls, *args, **kwargs): (source)

This method handles creating a parent `ManyRelatedField` instance when the `many=True` keyword argument is passed. Typically you won't need to override this method. Note that we're over-cautious in passing most arguments to both parent and child classes in order to try to cover the general case. If you're overriding this method you'll probably want something much simpler, eg: @classmethod def many_init(cls, *args, **kwargs): kwargs['child'] = cls() return CustomManyRelatedField(*args, **kwargs)

def __init__(self, **kwargs): (source)
overrides rest_framework.fields.Field.__init__
overridden in rest_framework.relations.HyperlinkedRelatedField, rest_framework.relations.PrimaryKeyRelatedField, rest_framework.relations.SlugRelatedField, rest_framework.relations.StringRelatedField

Undocumented

def __new__(cls, *args, **kwargs): (source)
overrides rest_framework.fields.Field.__new__

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

def display_value(self, instance): (source)

Undocumented

def get_attribute(self, instance): (source)
overrides rest_framework.fields.Field.get_attribute

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

def get_choices(self, cutoff=None): (source)

Undocumented

def get_queryset(self): (source)

Undocumented

def iter_options(self): (source)

Undocumented

def run_validation(self, data=empty): (source)
overrides rest_framework.fields.Field.run_validation

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 use_pk_only_optimization(self): (source)
overridden in rest_framework.relations.HyperlinkedRelatedField, rest_framework.relations.PrimaryKeyRelatedField

Undocumented

html_cutoff = (source)

Undocumented

html_cutoff_text = (source)

Undocumented

queryset = (source)

Undocumented

@property
choices = (source)

Undocumented

@property
grouped_choices = (source)

Undocumented