Skip to content

Logging

LoggingConfig

Source code in python/opsml/logging/_logging.pyi 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class LoggingConfig:
    show_threads: bool
    log_level: LogLevel
    write_level: WriteLevel
    use_json: bool

    def __init__(
        self,
        show_threads: bool = True,
        log_level: LogLevel = LogLevel.Info,
        write_level: WriteLevel = WriteLevel.Stdout,
        use_json: bool = False,
    ) -> None:
        """
        Logging configuration options.

        Args:
            show_threads:
                Whether to include thread information in log messages.
                Default is True.

            log_level:
                Log level for the logger.
                Default is LogLevel.Info.

            write_level:
                Write level for the logger.
                Default is WriteLevel.Stdout.

            use_json:
                Whether to write log messages in JSON format.
                Default is False.
        """

    @staticmethod
    def json_default() -> "LoggingConfig":
        """Gets a default JSON configuration.

        show_threads: True
        log_level: Env or LogLevel.Info
        write_level: WriteLevel.Stdout
        use_json: True

        Returns:
            LoggingConfig:
                The default JSON configuration.
        """

    @staticmethod
    def default() -> "LoggingConfig":
        """Gets a default configuration.

        show_threads: True
        log_level: Env or LogLevel.Info
        write_level: WriteLevel.Stdout
        use_json: False

        Returns:
            LoggingConfig:
                The default JSON configuration.
        """

__init__(show_threads=True, log_level=LogLevel.Info, write_level=WriteLevel.Stdout, use_json=False)

Logging configuration options.

Parameters:

Name Type Description Default
show_threads bool

Whether to include thread information in log messages. Default is True.

 True
log_level LogLevel

Log level for the logger. Default is LogLevel.Info.

 Info
write_level WriteLevel

Write level for the logger. Default is WriteLevel.Stdout.

 Stdout
use_json bool

Whether to write log messages in JSON format. Default is False.

 False
Source code in python/opsml/logging/_logging.pyi 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(
    self,
    show_threads: bool = True,
    log_level: LogLevel = LogLevel.Info,
    write_level: WriteLevel = WriteLevel.Stdout,
    use_json: bool = False,
) -> None:
    """
    Logging configuration options.

    Args:
        show_threads:
            Whether to include thread information in log messages.
            Default is True.

        log_level:
            Log level for the logger.
            Default is LogLevel.Info.

        write_level:
            Write level for the logger.
            Default is WriteLevel.Stdout.

        use_json:
            Whether to write log messages in JSON format.
            Default is False.
    """

default() staticmethod

Gets a default configuration.

show_threads: True log_level: Env or LogLevel.Info write_level: WriteLevel.Stdout use_json: False

Returns:

Name Type Description
LoggingConfig LoggingConfig

The default JSON configuration.
Source code in python/opsml/logging/_logging.pyi 
62
63
64
65
66
67
68
69
70
71
72
73
74
@staticmethod
def default() -> "LoggingConfig":
    """Gets a default configuration.

    show_threads: True
    log_level: Env or LogLevel.Info
    write_level: WriteLevel.Stdout
    use_json: False

    Returns:
        LoggingConfig:
            The default JSON configuration.
    """

json_default() staticmethod

Gets a default JSON configuration.

show_threads: True log_level: Env or LogLevel.Info write_level: WriteLevel.Stdout use_json: True

Returns:

Name Type Description
LoggingConfig LoggingConfig

The default JSON configuration.
Source code in python/opsml/logging/_logging.pyi 
48
49
50
51
52
53
54
55
56
57
58
59
60
@staticmethod
def json_default() -> "LoggingConfig":
    """Gets a default JSON configuration.

    show_threads: True
    log_level: Env or LogLevel.Info
    write_level: WriteLevel.Stdout
    use_json: True

    Returns:
        LoggingConfig:
            The default JSON configuration.
    """

RustyLogger

The Rusty Logger class to use with your python and rust-backed projects.

Source code in python/opsml/logging/_logging.pyi 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
class RustyLogger:
    """The Rusty Logger class to use with your python and rust-backed projects."""

    @staticmethod
    def setup_logging(config: Optional[LoggingConfig] = None) -> None:
        """Sets up the logger with the given configuration.

        Args:
            config (LoggingConfig):
                The configuration to use for the logger.
        """

    @staticmethod
    def get_logger(config: Optional[LoggingConfig] = None) -> "RustyLogger":
        """Gets the logger instance.

        Args:
            config (LoggingConfig):
                The configuration to use for the logger.

        Returns:
            RustyLogger:
                The logger instance.
        """

    def debug(self, message: str, *args) -> None:
        """Logs a debug message.

        Args:
            message (str):
                The message to log.

            *args:
                Additional arguments to log.
        """

    def info(self, message: str, *args) -> None:
        """Logs an info message.

        Args:
            message (str):
                The message to log.

            *args:
                Additional arguments to log.
        """

    def warn(self, message: str, *args) -> None:
        """Logs a warning message.

        Args:
            message (str):
                The message to log.

            *args:
                Additional arguments to log.
        """

    def error(self, message: str, *args) -> None:
        """Logs an error message.

        Args:
            message (str):
                The message to log.

            *args:
                Additional arguments to log.
        """

    def trace(self, message: str, *args) -> None:
        """Logs a trace message.

        Args:
            message (str):
                The message to log.

            *args:
                Additional arguments to log.
        """

debug(message, *args)

Logs a debug message.

Parameters:

Name Type Description Default
message str

The message to log.

 required
*args

Additional arguments to log.

 ()
Source code in python/opsml/logging/_logging.pyi 
101
102
103
104
105
106
107
108
109
110
def debug(self, message: str, *args) -> None:
    """Logs a debug message.

    Args:
        message (str):
            The message to log.

        *args:
            Additional arguments to log.
    """

error(message, *args)

Logs an error message.

Parameters:

Name Type Description Default
message str

The message to log.

 required
*args

Additional arguments to log.

 ()
Source code in python/opsml/logging/_logging.pyi 
134
135
136
137
138
139
140
141
142
143
def error(self, message: str, *args) -> None:
    """Logs an error message.

    Args:
        message (str):
            The message to log.

        *args:
            Additional arguments to log.
    """

get_logger(config=None) staticmethod

Gets the logger instance.

Parameters:

Name Type Description Default
config LoggingConfig

The configuration to use for the logger.

 None

Returns:

Name Type Description
RustyLogger RustyLogger

The logger instance.
Source code in python/opsml/logging/_logging.pyi 
88
89
90
91
92
93
94
95
96
97
98
99
@staticmethod
def get_logger(config: Optional[LoggingConfig] = None) -> "RustyLogger":
    """Gets the logger instance.

    Args:
        config (LoggingConfig):
            The configuration to use for the logger.

    Returns:
        RustyLogger:
            The logger instance.
    """

info(message, *args)

Logs an info message.

Parameters:

Name Type Description Default
message str

The message to log.

 required
*args

Additional arguments to log.

 ()
Source code in python/opsml/logging/_logging.pyi 
112
113
114
115
116
117
118
119
120
121
def info(self, message: str, *args) -> None:
    """Logs an info message.

    Args:
        message (str):
            The message to log.

        *args:
            Additional arguments to log.
    """

setup_logging(config=None) staticmethod

Sets up the logger with the given configuration.

Parameters:

Name Type Description Default
config LoggingConfig

The configuration to use for the logger.

 None
Source code in python/opsml/logging/_logging.pyi 
79
80
81
82
83
84
85
86
@staticmethod
def setup_logging(config: Optional[LoggingConfig] = None) -> None:
    """Sets up the logger with the given configuration.

    Args:
        config (LoggingConfig):
            The configuration to use for the logger.
    """

trace(message, *args)

Logs a trace message.

Parameters:

Name Type Description Default
message str

The message to log.

 required
*args

Additional arguments to log.

 ()
Source code in python/opsml/logging/_logging.pyi 
145
146
147
148
149
150
151
152
153
154
def trace(self, message: str, *args) -> None:
    """Logs a trace message.

    Args:
        message (str):
            The message to log.

        *args:
            Additional arguments to log.
    """

warn(message, *args)

Logs a warning message.

Parameters:

Name Type Description Default
message str

The message to log.

 required
*args

Additional arguments to log.

 ()
Source code in python/opsml/logging/_logging.pyi 
123
124
125
126
127
128
129
130
131
132
def warn(self, message: str, *args) -> None:
    """Logs a warning message.

    Args:
        message (str):
            The message to log.

        *args:
            Additional arguments to log.
    """