onadata.libs.serializers.fields package

Submodules

onadata.libs.serializers.fields.hyperlinked_multi_identity_field module

class onadata.libs.serializers.fields.hyperlinked_multi_identity_field.HyperlinkedMultiIdentityField(*args, **kwargs)

Bases: rest_framework.relations.HyperlinkedIdentityField

get_url(obj, view_name, request, format)

Given an object, return the URL that hyperlinks to the object.

May raise a NoReverseMatch if the view_name and lookup_field attributes are not configured to correctly match the URL conf.

lookup_fields = (('pk', 'pk'),)

onadata.libs.serializers.fields.hyperlinked_multi_related_field module

class onadata.libs.serializers.fields.hyperlinked_multi_related_field.HyperlinkedMultiRelatedField(*args, **kwargs)

Bases: rest_framework.relations.HyperlinkedRelatedField

get_url(obj, view_name, request, format)

Given an object, return the URL that hyperlinks to the object.

May raise a NoReverseMatch if the view_name and lookup_field attributes are not configured to correctly match the URL conf.

lookup_fields = (('pk', 'pk'),)

onadata.libs.serializers.fields.hyperlinked_multi_related_field.get_obj_property_value(obj, field)

Given an object and a field which may have nested properties return value of nested property >>> class demo: pass >>> demo.ls = [] >>> get_obj_property_value(demo, ‘ls.__class__’) <<< list

onadata.libs.serializers.fields.instance_related_field module

InstanceRelatedField

class onadata.libs.serializers.fields.instance_related_field.InstanceRelatedField(**kwargs)

Bases: rest_framework.relations.RelatedField

A custom field to represent the content_object generic relationship

get_attribute(instance)

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

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(value)

Serialize instance object

onadata.libs.serializers.fields.json_field module

class onadata.libs.serializers.fields.json_field.JsonField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)

Bases: rest_framework.fields.Field

to_internal_value(value)

Transform the incoming primitive data into a native value.

classmethod to_json(data)

to_representation(value)

Transform the outgoing native value into primitive data.

onadata.libs.serializers.fields.organization_field module

class onadata.libs.serializers.fields.organization_field.OrganizationField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)

Bases: rest_framework.fields.Field

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(obj)

Transform the outgoing native value into primitive data.

onadata.libs.serializers.fields.project_field module

class onadata.libs.serializers.fields.project_field.ProjectField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)

Bases: rest_framework.fields.Field

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(obj)

Transform the outgoing native value into primitive data.

onadata.libs.serializers.fields.project_related_field module

ProjectRelatedField

class onadata.libs.serializers.fields.project_related_field.ProjectRelatedField(**kwargs)

Bases: rest_framework.relations.RelatedField

A custom field to represent the content_object generic relationship

get_attribute(instance)

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

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(value)

Serialize project object

onadata.libs.serializers.fields.team_field module

class onadata.libs.serializers.fields.team_field.TeamField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)

Bases: rest_framework.fields.Field

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(obj)

Transform the outgoing native value into primitive data.

onadata.libs.serializers.fields.xform_field module

class onadata.libs.serializers.fields.xform_field.XFormField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)

Bases: rest_framework.fields.Field

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(obj)

Transform the outgoing native value into primitive data.

onadata.libs.serializers.fields.xform_related_field module

XFormRelatedField

class onadata.libs.serializers.fields.xform_related_field.XFormRelatedField(**kwargs)

Bases: rest_framework.relations.RelatedField

A custom field to represent the content_object generic relationship

get_attribute(instance)

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

to_internal_value(data)

Transform the incoming primitive data into a native value.

to_representation(value)

Serialize xform object

Module contents