Module: user_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.log.log_entry import LogEntry
@dataclass(slots=True, kw_only=True)
class UserLogEntry(LogEntry):
"""User log entry."""
Classes
class UserLogEntry (*, timestamp: str = None, level: LogEntryLevelEnum = None, message: str = None)
-
User log entry.
Expand source code
@dataclass(slots=True, kw_only=True) class UserLogEntry(LogEntry): """User log entry."""
Ancestors
- LogEntry
- LogEntryKey
- KeyMixin
- abc.ABC
- RecordMixin
- typing.Generic
Static methods
def get_key_type() -> Type
-
Inherited from:
LogEntry
.get_key_type
Return key type even when called from a record.
Fields
var level -> LogEntryLevelEnum
-
Inherited from:
LogEntry
.level
A type of event.
var message -> str
-
Inherited from:
LogEntry
.message
A descriptive message providing details about the event.
var timestamp -> str
-
Inherited from:
LogEntry
.timestamp
Time-ordered UUID.
Methods
def get_key(self) -> LogEntryKey
-
Inherited from:
LogEntry
.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:
LogEntry
.init_all
Invoke ‘init’ for each class in the order from base to derived, then validate against schema.