classroom.serializers.courses module

class classroom.serializers.courses.CourseRoleRequestSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.Serializer

class EmailUserValidator

Bases: object

class Meta

Bases: object

fields = ['email', 'type']

create(validated_data)

create_or_update(validated_data)

update(instance, validated_data)

class classroom.serializers.courses.CourseRoleSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

class Meta

Bases: object

extra_kwargs = {'type': {'required': False}}

fields = ['id', 'name', 'email', 'joinedAt']

model

alias of classroom.models.courses.CourseRole

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.

run_validation(data=<class 'rest_framework.fields.empty'>)

We override the default run_validation, because the validation performed by validators and the .validate() method should be coerced into an error dictionary with a 'non_fields_error' key.

class classroom.serializers.courses.CourseSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: classroom.serializers.mixins.RemoveNullFieldsMixin, rest_framework.serializers.ModelSerializer

class Meta

Bases: object

extra_kwargs = {'link': {'view_name': 'courses-detail', 'lookup_field': 'id', 'lookup_url_kwarg': 'pk', 'read_only': True}}

fields = ['link', 'id', 'name', 'path', 'description', 'webUrl', 'inviteUrl', 'summary', 'summaryFormat', 'startDate', 'endDate', 'staffs', 'createdAt', 'modifiedAt', 'students', 'assignmentStatus']

model

alias of classroom.models.courses.Course

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.

get_inviteUrl(instance)

get_refs(instance)

get_webUrl(instance)

update(instance: classroom.models.courses.Course, validated_data)

class classroom.serializers.courses.CourseStudentSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: classroom.serializers.courses.CourseRoleSerializer

class Meta

Bases: object

extra_kwargs = {'type': {'required': False}}

fields = ['id', 'name', 'email', 'idNumber', 'joinedAt']

model

alias of classroom.models.courses.CourseRole

get_idNumber(instance)

class classroom.serializers.courses.CourseUserSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

class Meta

Bases: object

extra_kwargs = {'type': {'required': True}}

fields = ['id', 'name', 'email', 'type']

model

alias of classroom.models.courses.CourseRole

class classroom.serializers.courses.EmailUserValidator

Bases: object