Module: package_alias_key

# Copyright (C) 2023-present The Project Contributors
#
# 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.

from dataclasses import dataclass
from typing import Type
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.key_mixin import KeyMixin


@dataclass(slots=True, kw_only=True)
class PackageAliasKey(KeyMixin):
    """
    Custom package alias defined using module glob pattern.

    Notes:
        - When specified, alias.ClassName is used in storage and REST API, otherwise ClassName is used without a prefix
        - Use to resolve conflicts when multiple packages use the same class name
        - Use to organize types and DB tables by package in large projects
    """

    package_pattern: str = missing()
    """Glob pattern for the dot-delimited module determines if the alias applies to a class."""

    @classmethod
    def get_key_type(cls) -> Type:
        return PackageAliasKey