Module: module_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 cl.runtime.records.record_mixin import RecordMixin
from cl.runtime.schema.module_decl_key import ModuleDeclKey


@dataclass(slots=True, kw_only=True)
class ModuleDecl(ModuleDeclKey, RecordMixin[ModuleDeclKey]):
    """Specifies module path in dot-delimited format."""

    def get_key(self) -> ModuleDeclKey:
        return ModuleDeclKey(module_name=self.module_name)

Classes

class ModuleDecl (*, module_name: str = None)

Specifies module path in dot-delimited format.

Expand source code

@dataclass(slots=True, kw_only=True)
class ModuleDecl(ModuleDeclKey, RecordMixin[ModuleDeclKey]):
    """Specifies module path in dot-delimited format."""

    def get_key(self) -> ModuleDeclKey:
        return ModuleDeclKey(module_name=self.module_name)

Ancestors

ModuleDeclKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Static methods

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

Return key type even when called from a record.

Fields

var module_name -> str: Inherited from: ModuleDeclKey.module_name

Module name in dot-delimited format.

Methods

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