Module: log_entry

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 import RecordMixin
from cl.runtime.log.log_entry_key import LogEntryKey
from cl.runtime.log.log_entry_level_enum import LogEntryLevelEnum
from cl.runtime.primitive.timestamp import Timestamp
from cl.runtime.records.dataclasses_extensions import missing


@dataclass(slots=True, kw_only=True)
class LogEntry(LogEntryKey, RecordMixin[LogEntryKey]):
    """
    Refers to a record that captures specific information
    about events or actions occurring within an application.
    """

    level: LogEntryLevelEnum = missing()
    """A type of event."""

    message: str = missing()
    """A descriptive message providing details about the event."""

    def get_key(self) -> LogEntryKey:
        return LogEntryKey(timestamp=self.timestamp)

    def init(self) -> None:
        """Same as __init__ but can be used when field values are set both during and after construction."""
        if self.timestamp is None:
            self.timestamp = Timestamp.create()

Classes

class LogEntry (*, timestamp: str = None, level: LogEntryLevelEnum = None, message: str = None)

Refers to a record that captures specific information about events or actions occurring within an application.

Expand source code

@dataclass(slots=True, kw_only=True)
class LogEntry(LogEntryKey, RecordMixin[LogEntryKey]):
    """
    Refers to a record that captures specific information
    about events or actions occurring within an application.
    """

    level: LogEntryLevelEnum = missing()
    """A type of event."""

    message: str = missing()
    """A descriptive message providing details about the event."""

    def get_key(self) -> LogEntryKey:
        return LogEntryKey(timestamp=self.timestamp)

    def init(self) -> None:
        """Same as __init__ but can be used when field values are set both during and after construction."""
        if self.timestamp is None:
            self.timestamp = Timestamp.create()

Ancestors

LogEntryKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Subclasses

UserLogEntry

Static methods

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

Return key type even when called from a record.

Fields

var level -> LogEntryLevelEnum: A type of event.
var message -> str: A descriptive message providing details about the event.
var timestamp -> str: Inherited from: LogEntryKey.timestamp

Time-ordered UUID.

Methods

def get_key(self) -> LogEntryKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init(self) -> None: Same as init but can be used when field values are set both during and after construction.
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.