class documentation
Relationships with `many=True` transparently get coerced into instead being a ManyRelatedField with a child relationship. The `ManyRelatedField` class is responsible for handling iterating through the values and passing each one to the child relationship. This class is treated as private API. You shouldn't generally need to be using this class directly yourself, and should instead simply set 'many=True' on the relationship.
Method | __init__ |
Undocumented |
Method | get |
Given the *outgoing* object instance, return the primitive value that should be used for this field. |
Method | get |
Undocumented |
Method | get |
Given the *incoming* primitive data, return the value for this field that should be validated and transformed to a native value. |
Method | iter |
Undocumented |
Method | to |
Transform the *incoming* primitive data into a native value. |
Method | to |
Transform the *outgoing* native value into primitive data. |
Class Variable | default |
Undocumented |
Class Variable | default |
Undocumented |
Class Variable | initial |
Undocumented |
Instance Variable | allow |
Undocumented |
Instance Variable | child |
Undocumented |
Instance Variable | html |
Undocumented |
Instance Variable | html |
Undocumented |
Property | choices |
Undocumented |
Property | grouped |
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 | __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 |
Return the default value to use when validating data if no input is provided for this field. |
Method | get |
Return a value to use when the field is being returned as a primitive value, without any object instance. |
Method | get |
Undocumented |
Method | run |
Validate a simple representation and return the internal value. |
Method | run |
Test the given value against all the validators on the field, and either raise a `ValidationError` or simply return. |
Method | validate |
Validate empty values, and either: |
Method | validators |
Undocumented |
Class Variable | default |
Undocumented |
Instance Variable | allow |
Undocumented |
Instance Variable | default |
Undocumented |
Instance Variable | error |
Undocumented |
Instance Variable | field |
Undocumented |
Instance Variable | help |
Undocumented |
Instance Variable | label |
Undocumented |
Instance Variable | parent |
Undocumented |
Instance Variable | read |
Undocumented |
Instance Variable | required |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | style |
Undocumented |
Instance Variable | write |
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 |
Undocumented |
Instance Variable | _validators |
Undocumented |
Given the *outgoing* object instance, return the primitive value that should be used for this field.
overrides
rest_framework.fields.Field.get_value
Given the *incoming* primitive data, return the value for this field that should be validated and transformed to a native value.