core/domain/activity_domain.py - develop - githubmirror/oppia

core/domain/activity_domain.py
127 строк4 KB
Gabriel Fuentes
Black formatter staging (#23456)
05 окт 2025, 06:15
05 окт 2025, 06:1562ec95a
# coding: utf-8
#
# Copyright 2016 The Oppia Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Domain object for a reference to an activity."""

from __future__ import annotations

from core.constants import constants

from typing import Dict, List


class ActivityReference:
    """Domain object for an activity reference.

    An activity is a piece of learning material that can be created in Oppia.
    Currently, the only available types of activities are explorations and
    collections.

    Attributes:
        type: str. The activity type.
        id: str. The activity id.
    """

    def __init__(self, activity_type: str, activity_id: str) -> None:
        """Constructs an ActivityReference domain object.

        Args:
            activity_type: str. The activity type.
            activity_id: str. The activity id.
        """
        self.type = activity_type
        self.id = activity_id

    def get_hash(self) -> str:
        """Returns a unique string for this ActivityReference domain object.

        Returns:
            str. A unique string hash for this ActivityReference domain object.
        """
        return '%s:%s' % (self.type, self.id)

    def validate(self) -> None:
        """Checks that all fields of this ActivityReference domain object
        are valid.

        Raises:
            Exception. The activity type is invalid.
        """
        if self.type not in (
            constants.ACTIVITY_TYPE_EXPLORATION,
            constants.ACTIVITY_TYPE_COLLECTION,
        ):
            raise Exception('Invalid activity type: %s' % self.type)
        if not isinstance(self.id, str):
            raise Exception('Expected id to be a string but found %s' % self.id)

    def to_dict(self) -> Dict[str, str]:
        """Returns a dict representing this ActivityReference domain object.

        Returns:
            dict. A dict, mapping type and id of an ActivityReference
            instance to corresponding keys 'type' and 'id'.
        """
        return {
            'type': self.type,
            'id': self.id,
        }

    @classmethod
    def from_dict(
        cls, activity_reference_dict: Dict[str, str]
    ) -> ActivityReference:
        """Return the ActivityReference object from a dict.

        Args:
            activity_reference_dict: dict. Dictionary representation
                of the object.

        Returns:
            ActivityReference. The corresponding ActivityReference object.
        """
        return cls(
            activity_reference_dict['type'], activity_reference_dict['id']
        )


class ActivityReferences:
    """Domain object for a list of activity references.

    Attributes:
        activity_reference_list: list(ActivityReference). A list of
            ActivityReference domain objects.
    """

    def __init__(self, activity_reference_list: List[ActivityReference]):
        """Constructs an ActivityReferences domain object.

        Args:
            activity_reference_list: list(ActivityReference). A list of
                ActivityReference domain objects.
        """
        self.activity_reference_list = activity_reference_list

    def validate(self) -> None:
        """Checks that all ActivityReference domain object in
        self.activity_reference_list are valid.

        Raises:
            Exception. Any ActivityReference in self.activity_reference_list
                is invalid.
        """
        for reference in self.activity_reference_list:
            reference.validate()