beat.web.reports.serializers module

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

Bases: rest_framework.serializers.ModelSerializer

class Meta

Bases: object

model

alias of beat.web.reports.models.Report

fields = ['short_description', 'status', 'is_owner', 'accessibility']

get_name(obj)

get_author(obj)

get_is_owner(obj)

get_content(obj)

get_status(obj)

get_experiments(obj)

get_experiment_access_map(obj)

get_analyzers_access_map(obj)

get_analyzer(obj)

get_html_description(obj)

get_add_url(obj)

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

Bases: beat.web.reports.serializers.BasicReportSerializer

class Meta

Bases: beat.web.reports.serializers.Meta

fields = ['name', 'number', 'short_description', 'is_owner', 'author', 'status', 'description', 'creation_date', 'html_description', 'add_url', 'content']

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

Bases: beat.web.reports.serializers.BasicReportSerializer

class Meta

Bases: beat.web.reports.serializers.Meta

fields = ['name', 'number', 'short_description', 'description', 'is_owner', 'author', 'status', 'creation_date', 'publication_date', 'experiments', 'analyzer', 'content', 'html_description', 'experiment_access_map', 'analyzers_access_map']

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

Bases: beat.web.reports.serializers.BasicReportSerializer

class Meta

Bases: beat.web.reports.serializers.Meta

fields = ['name', 'short_description', 'experiments']

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

Bases: beat.web.reports.serializers.BasicReportSerializer

class Meta

Bases: beat.web.reports.serializers.Meta

fields = ['short_description', 'description', 'experiments', 'content']

exception beat.web.reports.serializers.ReportCreationFailedException

Bases: Exception

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

Bases: rest_framework.serializers.ModelSerializer

class Meta

Bases: object

model

alias of beat.web.reports.models.Report

fields = ['name', 'short_description', 'description', 'content', 'experiments']

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.

update(instance, validated_data)

validate_name(value)

validate_content(value)

validate_experiments(value)

validate_description(value)

to_representation(obj)

Object instance -> Dict of primitive datatypes.

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

Bases: beat.web.reports.serializers.ReportCreationSerializer

class Meta

Bases: beat.web.reports.serializers.Meta

fields = ['short_description', 'description', 'content', 'experiments']

to_representation(obj)

Object instance -> Dict of primitive datatypes.