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

core/domain/learner_goals_services.py
166 строк5 KB
Gabriel Fuentes
Black formatter staging (#23456)
05 окт 2025, 06:15
05 окт 2025, 06:1562ec95a
# coding: utf-8
#
# Copyright 2021 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.

"""Services for the learner goals feature of the learner dashboard."""

from __future__ import annotations

from core import feconf
from core.domain import user_domain
from core.platform import models

from typing import List

MYPY = False
if MYPY:  # pragma: no cover
    from mypy_imports import user_models

(user_models,) = models.Registry.import_models([models.Names.USER])


def get_learner_goals_from_model(
    learner_goals_model: user_models.LearnerGoalsModel,
) -> user_domain.LearnerGoals:
    """Returns the learner goals domain object given the learner goals
    model loaded from the datastore.

    Args:
        learner_goals_model: LearnerGoalsModel. The
            learner goals model from the datastore.

    Returns:
        LearnerGoals. The learner goals domain object corresponding to the
        given model.
    """
    return user_domain.LearnerGoals(
        learner_goals_model.id,
        learner_goals_model.topic_ids_to_learn,
        learner_goals_model.topic_ids_to_master,
    )


def save_learner_goals(learner_goals: user_domain.LearnerGoals) -> None:
    """Save a learner goals domain object as an LearnerGoalsModel entity
    in the datastore.

    Args:
        learner_goals: LearnerGoals. The learner goals domain object to
            be saved in the datastore.
    """
    learner_goals_dict = learner_goals.to_dict()

    learner_goals_model = user_models.LearnerGoalsModel.get(
        learner_goals.id, strict=False
    )
    if learner_goals_model is not None:
        learner_goals_model.populate(**learner_goals_dict)
        learner_goals_model.update_timestamps()
        learner_goals_model.put()
    else:
        user_models.LearnerGoalsModel(
            id=learner_goals.id, **learner_goals_dict
        ).put()


def mark_topic_to_learn(user_id: str, topic_id: str) -> bool:
    """Adds the topic id to the learner goals of the user. If the count exceeds
    feconf.MAX_CURRENT_GOALS_COUNT, the topic is not added.

    Args:
        user_id: str. The id of the user.
        topic_id: str. The id of the topic to be added to the
            learner goals.

    Returns:
        bool. The boolean indicates whether the learner goals limit
        of the user has been exceeded.

    Raises:
        Exception. Given topic is already present.
    """
    learner_goals_model = user_models.LearnerGoalsModel.get(
        user_id, strict=False
    )
    if not learner_goals_model:
        learner_goals_model = user_models.LearnerGoalsModel(id=user_id)

    learner_goals = get_learner_goals_from_model(learner_goals_model)

    goals_limit_exceeded = False
    topic_ids_count = len(learner_goals.topic_ids_to_learn)
    if topic_id not in learner_goals.topic_ids_to_learn:
        if topic_ids_count < feconf.MAX_CURRENT_GOALS_COUNT:
            learner_goals.add_topic_id_to_learn(topic_id)
        else:
            goals_limit_exceeded = True
        save_learner_goals(learner_goals)
        return goals_limit_exceeded
    else:
        raise Exception(
            'The topic id %s is already present in the learner goals'
            % (topic_id)
        )


def remove_topics_from_learn_goal(
    user_id: str, topic_ids_to_remove: List[str]
) -> None:
    """Removes topics from the learner goals of the user (if present).

    Args:
        user_id: str. The id of the user.
        topic_ids_to_remove: list(str). The ids of the topics to be removed.

    Raises:
        Exception. Given topic does not exist.
    """
    learner_goals_model = user_models.LearnerGoalsModel.get(
        user_id, strict=False
    )

    if learner_goals_model:
        learner_goals = get_learner_goals_from_model(learner_goals_model)
        for topic_id in topic_ids_to_remove:
            if topic_id in learner_goals.topic_ids_to_learn:
                learner_goals.remove_topic_id_from_learn(topic_id)
            else:
                raise Exception(
                    'The topic id %s is not present in LearnerGoalsModel'
                    % (topic_id)
                )
        save_learner_goals(learner_goals)


def get_all_topic_ids_to_learn(user_id: str) -> List[str]:
    """Returns a list with the ids of all the topics that are in the
    goals of the user.

    Args:
        user_id: str. The id of the user.

    Returns:
        list(str). A list of the ids of the topics that are in the
        learner goals of the user.
    """
    learner_goals_model = user_models.LearnerGoalsModel.get(
        user_id, strict=False
    )

    if learner_goals_model:
        learner_goals = get_learner_goals_from_model(learner_goals_model)

        return learner_goals.topic_ids_to_learn
    return []