Source code for kappa_sdk.user_tasks.log
from typing import runtime_checkable, Protocol
[docs]
@runtime_checkable
class Log(Protocol):
"""User task logger.
Performs user task logging (writes to the standard output if run in simulation mode).
.. note:: Should not be instantiated directly.
"""
[docs]
def info(self, message: str) -> None:
"""Logs an info message using a logger, associated with a running user task.
Parameters
----------
message:
The message to log.
Raises
------
TypeError
If parameter has an unexpected type.
"""
[docs]
def debug(self, message: str) -> None:
"""Logs a debug message using a logger, associated with a running user task.
Parameters
----------
message:
The message to log.
Raises
------
TypeError
If parameter has an unexpected type.
"""
[docs]
def warning(self, message: str) -> None:
"""Logs a warning message using a logger, associated with a running user task.
Parameters
----------
message:
The message to log.
Raises
------
TypeError
If parameter has an unexpected type.
"""
[docs]
def error(self, message: str) -> None:
"""Logs an error message using a logger, associated with a running User Task.
Parameters
----------
message:
The message to log.
Raises
------
TypeError
If parameter has an unexpected type.
"""
[docs]
def fatal(self, message: str) -> None:
"""Logs a fatal message using a logger, associated with a running user task.
Parameters
----------
message:
The message to log.
Raises
------
TypeError
If parameter has an unexpected type.
"""
