Module: enum_decl

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 typing import List
from cl.runtime.records.dataclasses_extensions import field
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.record_mixin import RecordMixin
from cl.runtime.schema.enum_decl_key import EnumDeclKey
from cl.runtime.schema.enum_item_decl import EnumItemDecl


@dataclass(slots=True, kw_only=True)
class EnumDecl(EnumDeclKey, RecordMixin[EnumDeclKey]):
    """Enum declaration."""

    label: str | None = missing()
    """Enum label."""

    comment: str | None = missing()
    """Enum comment."""

    items: List[EnumItemDecl] = missing()
    """Array of enum items."""

    def get_key(self) -> EnumDeclKey:
        return EnumDeclKey(module=self.module, name=self.name)

Classes

class EnumDecl (*, module: ModuleDeclKey = None, name: str = None, label: str | None = None, comment: str | None = None, items: List[EnumItemDecl] = None)

Enum declaration.

Expand source code

@dataclass(slots=True, kw_only=True)
class EnumDecl(EnumDeclKey, RecordMixin[EnumDeclKey]):
    """Enum declaration."""

    label: str | None = missing()
    """Enum label."""

    comment: str | None = missing()
    """Enum comment."""

    items: List[EnumItemDecl] = missing()
    """Array of enum items."""

    def get_key(self) -> EnumDeclKey:
        return EnumDeclKey(module=self.module, name=self.name)

Ancestors

EnumDeclKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Static methods

def get_key_type() -> Type: Inherited from: EnumDeclKey.get_key_type

Return key type even when called from a record.

Fields

var comment -> str | None: Enum comment.
var items -> List[EnumItemDecl]: Array of enum items.
var label -> str | None: Enum label.
var module -> ModuleDeclKey: Inherited from: EnumDeclKey.module

Module reference.
var name -> str: Inherited from: EnumDeclKey.name

Enum name is unique when combined with module.

Methods

def get_key(self) -> EnumDeclKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.