Module: generic_key

Expand source code

# 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 cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.protocols import TKeyDict


@dataclass(slots=True, kw_only=True)
class GenericKey:
    """Generic key can be substituted for any key type other than itself."""

    key_type_str: str = missing()
    """Key type as dot-delimited string in module.ClassNameKey format inclusive of Key suffix if present."""

    key_dict: TKeyDict = missing()
    """Dictionary of key fields in the order of declaration."""

Classes

class GenericKey (*, key_type_str: str = None, key_dict: Dict[str, Union[Dict[str, ForwardRef('TKeyField')], str, float, bool, int, datetime.date, datetime.time, datetime.datetime, uuid.UUID, bytes, ForwardRef(None), enum.Enum]] = None)

Generic key can be substituted for any key type other than itself.

Expand source code

@dataclass(slots=True, kw_only=True)
class GenericKey:
    """Generic key can be substituted for any key type other than itself."""

    key_type_str: str = missing()
    """Key type as dot-delimited string in module.ClassNameKey format inclusive of Key suffix if present."""

    key_dict: TKeyDict = missing()
    """Dictionary of key fields in the order of declaration."""

Fields

var key_dict: Dictionary of key fields in the order of declaration.
var key_type_str: Key type as dot-delimited string in module.ClassNameKey format inclusive of Key suffix if present.