Module: field_label_key
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 Type
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.key_mixin import KeyMixin
@dataclass(slots=True, kw_only=True)
class FieldLabelKey(KeyMixin):
"""
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_name: str = missing()
"""Field name without reference to a class (the setting will apply to this field name in every class)."""
@classmethod
def get_key_type(cls) -> Type:
return FieldLabelKey
Classes
class FieldLabelKey (*, field_name: 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 FieldLabelKey(KeyMixin): """ 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_name: str = missing() """Field name without reference to a class (the setting will apply to this field name in every class).""" @classmethod def get_key_type(cls) -> Type: return FieldLabelKey
Ancestors
- KeyMixin
- abc.ABC
Subclasses
Static methods
def get_key_type() -> Type
-
Inherited from:
KeyMixin
.get_key_type
Return key type even when called from a record.
Fields
var field_name -> str
-
Field name without reference to a class (the setting will apply to this field name in every class).