Module: user

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.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.record_mixin import RecordMixin


@dataclass(slots=True, kw_only=True)
class User(UserKey, RecordMixin[UserKey]):
    """User which is allowed to log in."""

    first_name: str = missing()
    """First name of the user."""

    last_name: str = missing()
    """Last name of the user."""

    email: str | None = None
    """Email of the user."""

    def get_key(self) -> UserKey:
        return UserKey(username=self.username)

Classes

class User (*, username: str = None, first_name: str = None, last_name: str = None, email: str | None = None)

User which is allowed to log in.

Expand source code

@dataclass(slots=True, kw_only=True)
class User(UserKey, RecordMixin[UserKey]):
    """User which is allowed to log in."""

    first_name: str = missing()
    """First name of the user."""

    last_name: str = missing()
    """Last name of the user."""

    email: str | None = None
    """Email of the user."""

    def get_key(self) -> UserKey:
        return UserKey(username=self.username)

Ancestors

UserKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Static methods

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

Return key type even when called from a record.

Fields

var email -> str | None: Email of the user.
var first_name -> str: First name of the user.
var last_name -> str: Last name of the user.
var username -> str: Inherited from: UserKey.username

Unique user identifier.

Methods

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