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

core/domain/wipeout_domain.py
102 строки4 KB
Gabriel Fuentes
Black formatter staging (#23456)
05 окт 2025, 06:15
05 окт 2025, 06:1562ec95a
# Copyright 2020 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 Wipeout."""

from __future__ import annotations

from core import feconf, utils

from typing import Dict, Optional

USER_DELETION_SUCCESS = 'SUCCESS'
USER_DELETION_ALREADY_DONE = 'ALREADY DONE'

USER_VERIFICATION_NOT_DELETED = 'NOT DELETED'
USER_VERIFICATION_SUCCESS = 'SUCCESS'
USER_VERIFICATION_FAILURE = 'FAILURE'


class PendingDeletionRequest:
    """Domain object for a PendingDeletionRequest."""

    def __init__(
        self,
        user_id: str,
        username: Optional[str],
        email: str,
        normalized_long_term_username: Optional[str],
        deletion_complete: bool,
        pseudonymizable_entity_mappings: Dict[str, Dict[str, str]],
    ) -> None:
        """Constructs a PendingDeletionRequest domain object.

        Args:
            user_id: str. The ID of the user who is being deleted.
            username: str. The username of the  user who is being deleted.
            email: str. The email of the user who is being deleted.
            normalized_long_term_username: str|None. The normalized username of
                the user who is being deleted. Can be None when the user was on
                the Oppia site only for a short time and thus the username
                hasn't been well-established yet.
            deletion_complete: bool. Whether the deletion is completed.
            pseudonymizable_entity_mappings: dict(str, dict(str, str)).
                Mapping between the entity IDs and pseudonymized user IDs.
        """
        self.user_id = user_id
        self.username = username
        self.email = email
        self.normalized_long_term_username = normalized_long_term_username
        self.deletion_complete = deletion_complete
        self.pseudonymizable_entity_mappings = pseudonymizable_entity_mappings

    @classmethod
    def create_default(
        cls,
        user_id: str,
        username: Optional[str],
        email: str,
        normalized_long_term_username: Optional[str] = None,
    ) -> PendingDeletionRequest:
        """Creates a PendingDeletionRequest object with default values.

        Args:
            user_id: str. The ID of the user who is being deleted.
            username: str. The username of the  user who is being deleted.
            email: str. The email of the user who is being deleted.
            normalized_long_term_username: str|None. The normalized username of
                the user who is being deleted. Can be None when the user was on
                the Oppia site only for a short time and thus the username
                hasn't been well-established yet.

        Returns:
            PendingDeletionRequest. The default pending deletion request
            domain object.
        """
        return cls(
            user_id, username, email, normalized_long_term_username, False, {}
        )

    def validate(self) -> None:
        """Checks that the domain object is valid.

        Raises:
            ValidationError. The field pseudonymizable_entity_mappings
                contains wrong key.
        """
        for key in self.pseudonymizable_entity_mappings.keys():
            if key not in [name.value for name in feconf.ValidModelNames]:
                raise utils.ValidationError(
                    'pseudonymizable_entity_mappings contain wrong key'
                )