geonode.base.api.serializers

Attributes

`logger`
`api_bbox_settable_resource_models`

Classes

`BaseDynamicModelSerializer`
`ResourceBaseToRepresentationSerializerMixin`
`ResourceBaseTypesSerializer`
`PermSpecSerialiazer`
`GroupSerializer`
`GroupProfileSerializer`
`SimpleHierarchicalKeywordSerializer`
`_ThesaurusKeywordSerializerMixIn`
`SimpleThesaurusKeywordSerializer`
`SimpleRegionSerializer`
`SimpleTopicCategorySerializer`
`RestrictionCodeTypeSerializer`
`LicenseSerializer`
`SpatialRepresentationTypeSerializer`
`AvatarUrlField`
`EmbedUrlField`
`DetailUrlField`
`ExtraMetadataSerializer`
`ThumbnailUrlField`
`DownloadLinkField`
`DownloadArrayLinkField`
`FavoriteField`
`UserSerializer`
`ContactRoleField`
`ExtentBboxField`
`DataBlobField`
`DataBlobSerializer`
`ResourceExecutionRequestSerializer`
`ResourceBaseSerializer`
`FavoriteSerializer`
`BaseResourceCountSerializer`
`HierarchicalKeywordSerializer`
`ThesaurusKeywordSerializer`
`RegionSerializer`
`TopicCategorySerializer`
`OwnerSerializer`
`SimpleResourceSerializer`
`LinkedResourceSerializer`

Module Contents

geonode.base.api.serializers.logger[source]

class geonode.base.api.serializers.BaseDynamicModelSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

to_representation(instance)[source]

class geonode.base.api.serializers.ResourceBaseToRepresentationSerializerMixin[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

to_representation(instance)[source]

class geonode.base.api.serializers.ResourceBaseTypesSerializer[source]

Bases: dynamic_rest.serializers.DynamicEphemeralSerializer

name[source]

count[source]

class Meta[source]

name = 'resource-types'[source]

class geonode.base.api.serializers.PermSpecSerialiazer[source]

Bases: dynamic_rest.serializers.DynamicEphemeralSerializer

class Meta[source]

name = 'perm-spec'[source]

class PermSpecFieldSerialiazer[source]

Bases: dynamic_rest.serializers.DynamicEphemeralSerializer

perm_spec[source]

users[source]

groups[source]

class geonode.base.api.serializers.GroupSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'group'[source]

fields = ('pk', 'name')[source]

class geonode.base.api.serializers.GroupProfileSerializer[source]

Bases: BaseDynamicModelSerializer

class Meta[source]

model[source]

name = 'group_profile'[source]

view_name = 'group-profiles-list'[source]

fields = ('pk', 'title', 'group', 'slug', 'logo', 'description', 'email', 'keywords', 'access', 'categories')[source]

group[source]

keywords[source]

categories[source]

class geonode.base.api.serializers.SimpleHierarchicalKeywordSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'HierarchicalKeyword'[source]

fields = ('name', 'slug')[source]

to_representation(value)[source]

class geonode.base.api.serializers._ThesaurusKeywordSerializerMixIn[source]

to_representation(value)[source]

class geonode.base.api.serializers.SimpleThesaurusKeywordSerializer[source]

Bases: _ThesaurusKeywordSerializerMixIn, dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'ThesaurusKeyword'[source]

fields = ('alt_label',)[source]

class geonode.base.api.serializers.SimpleRegionSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'Region'[source]

fields = ('code', 'name')[source]

class geonode.base.api.serializers.SimpleTopicCategorySerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'TopicCategory'[source]

fields = ('identifier', 'gn_description')[source]

class geonode.base.api.serializers.RestrictionCodeTypeSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'RestrictionCodeType'[source]

fields = ('identifier',)[source]

class geonode.base.api.serializers.LicenseSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'License'[source]

fields = ('identifier',)[source]

class geonode.base.api.serializers.SpatialRepresentationTypeSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'SpatialRepresentationType'[source]

fields = ('identifier',)[source]

class geonode.base.api.serializers.AvatarUrlField(avatar_size, **kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

avatar_size[source]

get_attribute(instance)[source]

class geonode.base.api.serializers.EmbedUrlField(**kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

class geonode.base.api.serializers.DetailUrlField(**kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

class geonode.base.api.serializers.ExtraMetadataSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

name = 'ExtraMetadata'[source]

fields = ('pk', 'metadata')[source]

to_representation(obj)[source]

class geonode.base.api.serializers.ThumbnailUrlField(**kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

class geonode.base.api.serializers.DownloadLinkField(**kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

class geonode.base.api.serializers.DownloadArrayLinkField(**kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

class geonode.base.api.serializers.FavoriteField(**kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

class geonode.base.api.serializers.UserSerializer[source]

Bases: BaseDynamicModelSerializer

class Meta[source]

ref_name = 'UserProfile'[source]

model[source]

name = 'user'[source]

view_name = 'users-list'[source]

fields = ('pk', 'username', 'first_name', 'last_name', 'avatar', 'perms', 'is_superuser', 'is_staff', 'email')[source]

classmethod setup_eager_loading(queryset)[source]: Perform necessary eager loading of data.

to_representation(instance)[source]

avatar[source]

class geonode.base.api.serializers.ContactRoleField(contact_type, **kwargs)[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

default_error_messages[source]

contact_type[source]

get_attribute(instance)[source]

to_representation(value)[source]

get_pks_of_users_to_set(value)[source]

to_internal_value(value)[source]

class geonode.base.api.serializers.ExtentBboxField[source]

Bases: dynamic_rest.fields.fields.DynamicComputedField

get_attribute(instance)[source]

to_representation(value)[source]

class geonode.base.api.serializers.DataBlobField[source]

Bases: dynamic_rest.fields.fields.DynamicRelationField

value_to_string(obj)[source]

class geonode.base.api.serializers.DataBlobSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

fields = ('pk', 'blob')[source]

to_representation(value)[source]

class geonode.base.api.serializers.ResourceExecutionRequestSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

model[source]

fields = ('pk',)[source]

to_representation(instance)[source]

geonode.base.api.serializers.api_bbox_settable_resource_models[source]

class geonode.base.api.serializers.ResourceBaseSerializer(*args, **kwargs)[source]

Bases: ResourceBaseToRepresentationSerializerMixin, BaseDynamicModelSerializer

metadata[source]

class Meta[source]

model[source]

name = 'resource'[source]

view_name = 'base-resources-list'[source]

fields = ('pk', 'uuid', 'resource_type', 'polymorphic_ctype_id', 'perms', 'owner', 'poc',...[source]

extra_kwargs[source]

to_internal_value(data)[source]

save(**kwargs)[source]

data[source]

Deferred / not Embedded –> ?include[]=executions

executions[source]

class geonode.base.api.serializers.FavoriteSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

resource[source]

class Meta[source]

model[source]

name = 'favorites'[source]

fields = ('resource',)[source]

to_representation(value)[source]

get_resource(instance)[source]

class geonode.base.api.serializers.BaseResourceCountSerializer[source]

Bases: BaseDynamicModelSerializer

to_representation(instance)[source]

class geonode.base.api.serializers.HierarchicalKeywordSerializer[source]

Bases: BaseResourceCountSerializer

class Meta[source]

name = 'keywords'[source]

model[source]

count_type = 'keywords'[source]

view_name = 'keywords-list'[source]

fields = '__all__'[source]

class geonode.base.api.serializers.ThesaurusKeywordSerializer[source]

Bases: _ThesaurusKeywordSerializerMixIn, BaseResourceCountSerializer

class Meta[source]

model[source]

name = 'tkeywords'[source]

view_name = 'tkeywords-list'[source]

count_type = 'tkeywords'[source]

fields = '__all__'[source]

class geonode.base.api.serializers.RegionSerializer[source]

Bases: BaseResourceCountSerializer

class Meta[source]

name = 'regions'[source]

model[source]

count_type = 'regions'[source]

view_name = 'regions-list'[source]

fields = '__all__'[source]

class geonode.base.api.serializers.TopicCategorySerializer[source]

Bases: BaseResourceCountSerializer

class Meta[source]

name = 'categories'[source]

model[source]

count_type = 'category'[source]

view_name = 'categories-list'[source]

fields = '__all__'[source]

class geonode.base.api.serializers.OwnerSerializer[source]

Bases: BaseResourceCountSerializer

class Meta[source]

name = 'owners'[source]

count_type = 'owner'[source]

view_name = 'owners-list'[source]

model[source]

fields = ('pk', 'username', 'first_name', 'last_name', 'avatar', 'perms')[source]

avatar[source]

class geonode.base.api.serializers.SimpleResourceSerializer[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

class Meta[source]

name = 'linked_resources'[source]

model[source]

fields = ('pk', 'title', 'resource_type', 'detail_url', 'thumbnail_url')[source]

to_representation(instance: geonode.base.models.LinkedResource)[source]

class geonode.base.api.serializers.LinkedResourceSerializer(*kargs, serialize_source: bool = False, **kwargs)[source]

Bases: dynamic_rest.serializers.DynamicModelSerializer

serialize_target[source]

class Meta[source]

name = 'linked_resources'[source]

model[source]

fields = ('internal',)[source]

to_representation(instance: geonode.base.models.LinkedResource)[source]