Module: field_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.field_label_key import FieldLabelKey


@dataclass(slots=True, kw_only=True)
class FieldLabel(FieldLabelKey, RecordMixin[FieldLabelKey]):
    """
    Custom field label overrides the standard 'field_name' -> 'Field Name' transformation.

    Notes:
        - The setting will apply to this field name in every class
        - This UI setting does not affect the REST API
    """

    field_label: str = missing()
    """Custom field label overrides the standard 'field_name' -> 'Field Name' transformation."""

    def get_key(self) -> FieldLabelKey:
        return FieldLabelKey(field_name=self.field_name)

Classes

class FieldLabel (*, field_name: str = None, field_label: str = None)

Custom field label overrides the standard ‘field_name’ -> ‘Field Name’ transformation.

Notes

The setting will apply to this field name in every class
This UI setting does not affect the REST API

Expand source code

@dataclass(slots=True, kw_only=True)
class FieldLabel(FieldLabelKey, RecordMixin[FieldLabelKey]):
    """
    Custom field label overrides the standard 'field_name' -> 'Field Name' transformation.

    Notes:
        - The setting will apply to this field name in every class
        - This UI setting does not affect the REST API
    """

    field_label: str = missing()
    """Custom field label overrides the standard 'field_name' -> 'Field Name' transformation."""

    def get_key(self) -> FieldLabelKey:
        return FieldLabelKey(field_name=self.field_name)

Ancestors

FieldLabelKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Static methods

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

Return key type even when called from a record.

Fields

var field_label -> str: Custom field label overrides the standard ‘field_name’ -> ‘Field Name’ transformation.
var field_name -> str: Inherited from: FieldLabelKey.field_name

Field name without reference to a class (the setting will apply to this field name in every class).

Methods

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