32b7f27c46
Adds API to fetch all legacy library content blocks that are ready to be updated to use library v2 and convert to item banks. Also adds API to update all the references via a user celery task and to fetch its status.
84 lines
2.9 KiB
Python
84 lines
2.9 KiB
Python
"""
|
|
Serializers to be used in APIs.
|
|
"""
|
|
|
|
|
|
from opaque_keys import InvalidKeyError
|
|
from opaque_keys.edx.keys import CourseKey, UsageKey
|
|
from rest_framework import serializers
|
|
from user_tasks.serializers import StatusSerializer
|
|
|
|
|
|
class CollapsedReferenceSerializer(serializers.HyperlinkedModelSerializer):
|
|
"""Serializes arbitrary models in a collapsed format, with just an id and url."""
|
|
url = serializers.HyperlinkedIdentityField(view_name='')
|
|
|
|
def __init__(self, model_class, view_name, id_source='id', lookup_field=None, *args, **kwargs): # lint-amnesty, pylint: disable=keyword-arg-before-vararg
|
|
"""Configures the serializer.
|
|
|
|
Args:
|
|
model_class (class): Model class to serialize.
|
|
view_name (string): Name of the Django view used to lookup the
|
|
model.
|
|
id_source (string): Optional name of the id field on the model.
|
|
Defaults to 'id'. Also used as the property name of the field
|
|
in the serialized representation.
|
|
lookup_field (string): Optional name of the model field used to
|
|
lookup the model in the view. Defaults to the value of
|
|
id_source.
|
|
"""
|
|
if not lookup_field:
|
|
lookup_field = id_source
|
|
|
|
self.Meta.model = model_class
|
|
|
|
super().__init__(*args, **kwargs)
|
|
|
|
self.fields[id_source] = serializers.CharField(read_only=True)
|
|
self.fields['url'].view_name = view_name
|
|
self.fields['url'].lookup_field = lookup_field
|
|
self.fields['url'].lookup_url_kwarg = lookup_field
|
|
|
|
class Meta:
|
|
fields = ("url",)
|
|
|
|
|
|
class CourseKeyField(serializers.Field):
|
|
""" Serializer field for a model CourseKey field. """
|
|
|
|
def to_representation(self, data): # lint-amnesty, pylint: disable=arguments-differ
|
|
"""Convert a course key to unicode. """
|
|
return str(data)
|
|
|
|
def to_internal_value(self, data):
|
|
"""Convert unicode to a course key. """
|
|
try:
|
|
return CourseKey.from_string(data)
|
|
except InvalidKeyError as err:
|
|
raise serializers.ValidationError("Invalid course key") from err
|
|
|
|
|
|
class UsageKeyField(serializers.Field):
|
|
""" Serializer field for a model UsageKey field. """
|
|
|
|
def to_representation(self, data): # lint-amnesty, pylint: disable=arguments-differ
|
|
"""Convert a usage key to unicode. """
|
|
return str(data)
|
|
|
|
def to_internal_value(self, data):
|
|
"""Convert unicode to a usage key. """
|
|
try:
|
|
return UsageKey.from_string(data)
|
|
except InvalidKeyError as err:
|
|
raise serializers.ValidationError("Invalid usage key") from err
|
|
|
|
|
|
class StatusSerializerWithUuid(StatusSerializer):
|
|
"""
|
|
Serializer for the user task status, including uuid.
|
|
"""
|
|
|
|
class Meta:
|
|
model = StatusSerializer.Meta.model
|
|
fields = [*StatusSerializer.Meta.fields, 'uuid']
|