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

core/domain/learner_progress_domain.py
224 строки10 KB
tanmaygoyal2007
Fix part of #26609: Removed play later functionality (#26610)
03 авг 2026, 09:18
03 авг 2026, 09:183d1dd30
# coding: utf-8
#
# Copyright 2017 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 objects for learner progress."""

from __future__ import annotations

from core.domain import (
    collection_domain,
    exp_domain,
    story_domain,
    topic_domain,
)

from typing import Dict, List


class LearnerProgressInTopicsAndStories:
    """Domain object for the progress of the learner in topics and stories."""

    def __init__(
        self,
        partially_learnt_topic_summaries: List[topic_domain.TopicSummary],
        completed_story_summaries: List[story_domain.StorySummary],
        learnt_topic_summaries: List[topic_domain.TopicSummary],
        topics_to_learn_summaries: List[topic_domain.TopicSummary],
        all_topic_summaries: List[topic_domain.TopicSummary],
        untracked_topic_summaries: List[topic_domain.TopicSummary],
        completed_to_incomplete_story_titles: List[str],
        learnt_to_partially_learnt_topic_titles: List[str],
    ) -> None:
        """Constructs a LearnerProgress domain object.

        Args:
            partially_learnt_topic_summaries: list(TopicSummary). The
                summaries of the topics partially learnt by the
                learner.
            completed_story_summaries: list(StorySummary). The
                summaries of the stories completed by the learner.
            learnt_topic_summaries: list(TopicSummary). The
                summaries of the topics learnt by the learner.
            topics_to_learn_summaries: list(TopicSummary). The
                summaries of the topics to learn.
            all_topic_summaries: list(TopicSummary). The summaries of the topics
                in the edit goals.
            untracked_topic_summaries: list(TopicSummary). The summaries of the
                topics not tracked for the user.
            completed_to_incomplete_story_titles: list(str).
                The titles of summaries corresponding to those stories which
                have been moved to the in progress section on account of new
                nodes being added to them.
            learnt_to_partially_learnt_topic_titles: list(str).
                The titles of summaries corresponding to those topics which have
                been moved to the in progress section on account of new
                stories being added to them.
        """
        self.partially_learnt_topic_summaries = partially_learnt_topic_summaries
        self.completed_story_summaries = completed_story_summaries
        self.learnt_topic_summaries = learnt_topic_summaries
        self.topics_to_learn_summaries = topics_to_learn_summaries
        self.all_topic_summaries = all_topic_summaries
        self.untracked_topic_summaries = untracked_topic_summaries
        self.completed_to_incomplete_stories = (
            completed_to_incomplete_story_titles
        )
        self.learnt_to_partially_learnt_topics = (
            learnt_to_partially_learnt_topic_titles
        )


class LearnerProgressInCollections:
    """Domain object for the progress of the learner in collections."""

    def __init__(
        self,
        incomplete_collection_summaries: List[
            collection_domain.CollectionSummary
        ],
        completed_collection_summaries: List[
            collection_domain.CollectionSummary
        ],
        completed_to_incomplete_collection_titles: List[str],
    ) -> None:
        """Constructs a LearnerProgress domain object.

        Args:
            incomplete_collection_summaries: list(CollectionSummary). The
                summaries of the collections partially completed by the
                learner.
            completed_collection_summaries: list(CollectionSummary). The
                summaries of the collections partially completed by the learner.
            completed_to_incomplete_collection_titles: list(CollectionSummary).
                The summaries corresponding to those collections which have
                been moved to the in progress section on account of new
                explorations being added to them.
        """
        self.incomplete_collection_summaries = incomplete_collection_summaries
        self.completed_collection_summaries = completed_collection_summaries
        self.completed_to_incomplete_collections = (
            completed_to_incomplete_collection_titles
        )


class LearnerProgressInExplorations:
    """Domain object for the progress of the learner in explorations."""

    def __init__(
        self,
        incomplete_exp_summaries: List[exp_domain.ExplorationSummary],
        completed_exp_summaries: List[exp_domain.ExplorationSummary],
    ) -> None:
        """Constructs a LearnerProgress domain object.

        Args:
            incomplete_exp_summaries: list(ExplorationSummary). The summaries
                of the explorations partially completed by the learner.
            completed_exp_summaries: list(ExplorationSummary). The summaries of
                the explorations partially completed by the learner.
        """
        self.incomplete_exp_summaries = incomplete_exp_summaries
        self.completed_exp_summaries = completed_exp_summaries


class ActivityIdsInLearnerDashboard:
    """Domain object for ids of the activities completed, currently being
    completed, or goals of the user.
    """

    def __init__(
        self,
        completed_exploration_ids: List[str],
        completed_collection_ids: List[str],
        completed_story_ids: List[str],
        learnt_topic_ids: List[str],
        incomplete_exploration_ids: List[str],
        incomplete_collection_ids: List[str],
        partially_learnt_topic_ids: List[str],
        topic_ids_to_learn: List[str],
        all_topic_ids: List[str],
        untracked_topic_ids: List[str],
    ) -> None:
        """Constructs a ActivityIdsInLearnerDashboard domain object.

        Args:
            completed_exploration_ids: list(str). The ids of the explorations
                completed by the user.
            completed_collection_ids: list(str). The ids of the collections
                completed by the user.
            completed_story_ids: list(str). The ids of the stories
                completed by the user.
            learnt_topic_ids: list(str). The ids of the topics
                learnt by the user.
            incomplete_exploration_ids: list(str). The ids of the explorations
                currently in progress.
            incomplete_collection_ids: list(str). The ids of the collections
                currently in progress.
            partially_learnt_topic_ids: list(str). The ids of the topics
                partially learnt.
            topic_ids_to_learn: list(str). The ids of the topics to learn.
            all_topic_ids: list(str). The ids of the all the topics.
            untracked_topic_ids: list(str). The ids of the untracked topics.
        """
        self.completed_exploration_ids = completed_exploration_ids
        self.completed_collection_ids = completed_collection_ids
        self.completed_story_ids = completed_story_ids
        self.learnt_topic_ids = learnt_topic_ids
        self.incomplete_exploration_ids = incomplete_exploration_ids
        self.incomplete_collection_ids = incomplete_collection_ids
        self.partially_learnt_topic_ids = partially_learnt_topic_ids
        self.topic_ids_to_learn = topic_ids_to_learn
        self.all_topic_ids = all_topic_ids
        self.untracked_topic_ids = untracked_topic_ids

    def to_dict(self) -> Dict[str, List[str]]:
        """Return dictionary representation of ActivityIdsInLearnerDashboard.

        Returns:
            dict. The keys of the dict are:
                'completed_exploration_ids': list(str). The ids of the
                    explorations that are completed.
                'completed_collection_ids': list(str). The ids of the
                    collections that are completed.
                'completed_story_ids': list(str). The ids of the
                    stories that are completed.
                'learnt_topic_ids': list(str). The ids of the
                    topics that are learnt.
                'incomplete_exploration_ids': list(str). The ids of the
                    explorations that are incomplete.
                'incomplete_collection_ids': list(str). The ids of the
                    collections that are incomplete.
                'partially_learnt_topic_ids': list(str). The ids of the
                    topics that are partially learnt.
                'topic_ids_to_learn': list(str). The ids of the topics
                    to learn.
                'all_topic_ids': list(str). The ids of all the topics.
                'untracked_topic_ids': list(str). The ids of the untracked
                    topics.
        """

        return {
            'completed_exploration_ids': self.completed_exploration_ids,
            'completed_collection_ids': self.completed_collection_ids,
            'completed_story_ids': self.completed_story_ids,
            'learnt_topic_ids': self.learnt_topic_ids,
            'incomplete_exploration_ids': self.incomplete_exploration_ids,
            'incomplete_collection_ids': self.incomplete_collection_ids,
            'partially_learnt_topic_ids': self.partially_learnt_topic_ids,
            'topic_ids_to_learn': self.topic_ids_to_learn,
            'all_topic_ids': self.all_topic_ids,
            'untracked_topic_ids': self.untracked_topic_ids,
        }