Module: ui_type_state_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.backend.core.user_key import UserKey
from cl.runtime.records.dataclasses_extensions import field
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.key_mixin import KeyMixin
from cl.runtime.schema.type_decl_key import TypeDeclKey


@dataclass(slots=True, kw_only=True)
class UiTypeStateKey(KeyMixin):
    """Defines some default settings for a type."""

    type_: TypeDeclKey = missing()
    """Type reference."""

    user: UserKey | None = missing()
    """A user the app state is applied for."""

    @classmethod
    def get_key_type(cls) -> Type:
        return UiTypeStateKey

Classes

class UiTypeStateKey (*, type_: TypeDeclKey = None, user: UserKey | None = None)

Defines some default settings for a type.

Expand source code
@dataclass(slots=True, kw_only=True)
class UiTypeStateKey(KeyMixin):
    """Defines some default settings for a type."""

    type_: TypeDeclKey = missing()
    """Type reference."""

    user: UserKey | None = missing()
    """A user the app state is applied for."""

    @classmethod
    def get_key_type(cls) -> Type:
        return UiTypeStateKey

Ancestors

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 type_ -> TypeDeclKey

Type reference.

var user -> UserKey | None

A user the app state is applied for.