Module: entry_type

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 abc import ABC
from dataclasses import dataclass
from cl.runtime import RecordMixin
from cl.convince.entries.entry_type_key import EntryTypeKey


@dataclass(slots=True, kw_only=True)
class EntryType(EntryTypeKey, RecordMixin[EntryTypeKey], ABC):
    """Unique entry type is assigned to each purpose of user input."""

    description: str | None = None
    """Description of the entry type."""

    def get_key(self) -> EntryTypeKey:
        return EntryTypeKey(entry_type_id=self.entry_type_id)

Classes

class EntryType (*, entry_type_id: str = None, description: str | None = None)

Unique entry type is assigned to each purpose of user input.

Expand source code

@dataclass(slots=True, kw_only=True)
class EntryType(EntryTypeKey, RecordMixin[EntryTypeKey], ABC):
    """Unique entry type is assigned to each purpose of user input."""

    description: str | None = None
    """Description of the entry type."""

    def get_key(self) -> EntryTypeKey:
        return EntryTypeKey(entry_type_id=self.entry_type_id)

Ancestors

EntryTypeKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Static methods

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

Return key type even when called from a record.

Fields

var description -> str | None: Description of the entry type.
var entry_type_id -> str: Inherited from: EntryTypeKey.entry_type_id

Unique entry type identifier.

Methods

def get_key(self) -> EntryTypeKey: 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.