Module: package_label

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.record_mixin import RecordMixin
from cl.runtime.settings.labels.package_label_key import PackageLabelKey


@dataclass(slots=True, kw_only=True)
class PackageLabel(PackageLabelKey, RecordMixin[PackageLabelKey]):
    """
    Custom package label overrides the standard 'package_alias' -> 'Package Alias' transformation.

    Notes:
        - There is no need to define package label unless package alias is defined in PackageAlias
        - This UI setting does not affect the REST API
    """

    package_label: str = missing()
    """Custom package label overrides the standard 'package_alias' -> 'Package Alias' transformation."""

    def get_key(self) -> PackageLabelKey:
        return PackageLabelKey(package_alias=self.package_alias)

Classes

class PackageLabel (*, package_alias: str = None, package_label: str = None)

Custom package label overrides the standard ‘package_alias’ -> ‘Package Alias’ transformation.

Notes

There is no need to define package label unless package alias is defined in PackageAlias
This UI setting does not affect the REST API

Expand source code

@dataclass(slots=True, kw_only=True)
class PackageLabel(PackageLabelKey, RecordMixin[PackageLabelKey]):
    """
    Custom package label overrides the standard 'package_alias' -> 'Package Alias' transformation.

    Notes:
        - There is no need to define package label unless package alias is defined in PackageAlias
        - This UI setting does not affect the REST API
    """

    package_label: str = missing()
    """Custom package label overrides the standard 'package_alias' -> 'Package Alias' transformation."""

    def get_key(self) -> PackageLabelKey:
        return PackageLabelKey(package_alias=self.package_alias)

Ancestors

PackageLabelKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Static methods

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

Return key type even when called from a record.

Fields

var package_alias -> str: Inherited from: PackageLabelKey.package_alias

Package alias for which the package label is defined.
var package_label -> str: Custom package label overrides the standard ‘package_alias’ -> ‘Package Alias’ transformation.

Methods

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