beat.web.common.serializers module

class beat.web.common.serializers.DiffSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.Serializer

get_diff(obj)

class beat.web.common.serializers.CheckNameSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.Serializer

validate_name(name)

get_used(obj)

create(validated_data)

class beat.web.common.serializers.SharingSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.Serializer

validate_users(users)

validate_teams(teams)

class beat.web.common.serializers.DynamicFieldsSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

class Meta

Bases: object

default_fields = []

class beat.web.common.serializers.ShareableSerializer(*args, **kwargs)

Bases: beat.web.common.serializers.DynamicFieldsSerializer

class Meta

Bases: beat.web.common.serializers.Meta

model

alias of beat.web.common.models.Shareable

default_fields = ['is_owner', 'modifiable', 'deletable', 'sharing']

get_accessibility(obj)

get_sharing(obj)

get_is_owner(obj)

class beat.web.common.serializers.VersionableSerializer(*args, **kwargs)

Bases: beat.web.common.serializers.ShareableSerializer

class Meta

Bases: beat.web.common.serializers.Meta

model

alias of beat.web.common.models.Versionable

default_fields = ['is_owner', 'modifiable', 'deletable', 'sharing', 'name', 'version', 'last_version', 'short_description', 'fork_of', 'previous_version', 'accessibility', 'hash', 'creation_date']

get_fork_of(obj)

get_last_version(obj)

get_previous_version(obj)

get_history(obj)

class beat.web.common.serializers.ContributionSerializer(*args, **kwargs)

Bases: beat.web.common.serializers.VersionableSerializer

class Meta

Bases: beat.web.common.serializers.Meta

model

alias of beat.web.common.models.Contribution

extra_fields = ['description', 'declaration']

exclude = ['description_file', 'declaration_file']

get_description(obj)

get_declaration(obj)

get_html_description(obj)

class beat.web.common.serializers.ContributionModSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

class Meta

Bases: object

fields = ['short_description', 'description', 'declaration']

beat_core_class = None

validate_description(description)

validate_declaration(declaration)

update(instance, validated_data)

filter_representation(representation)

Filter out fields if given in query parameters

to_representation(instance)

Object instance -> Dict of primitive datatypes.

class beat.web.common.serializers.ContributionCreationSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: beat.web.common.serializers.ContributionModSerializer

class Meta

Bases: beat.web.common.serializers.Meta

fields = ['short_description', 'description', 'declaration', 'name', 'previous_version', 'fork_of', 'version']

validate_fork_of(fork_of)

validate_previous_version(previous_version)

validate_version(version)

validate(data)

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.