Source code for robot.output.librarylogger
# Copyright 2008-2015 Nokia Networks
# Copyright 2016- Robot Framework Foundation
#
# 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.
"""Implementation of the public logging API for libraries.
This is exposed via :py:mod:`robot.api.logger`. Implementation must reside
here to avoid cyclic imports.
"""
import threading
from typing import Callable
from .logger import LOGGER
from .loggerhelper import Message, write_to_console
LOGGING_THREADS = ('MainThread', 'RobotFrameworkTimeoutThread')
[docs]
def write(msg: 'str | Callable[[], str]', level: str, html: bool = False):
# Callable messages allow lazy logging internally, but we don't want to
# expose this functionality publicly. See the following issue for details:
# https://github.com/robotframework/robotframework/issues/1505
if callable(msg):
msg = str(msg)
if level.upper() not in ('TRACE', 'DEBUG', 'INFO', 'HTML', 'WARN', 'ERROR'):
if level.upper() == 'CONSOLE':
level = 'INFO'
console(msg)
else:
raise RuntimeError("Invalid log level '%s'." % level)
if threading.current_thread().name in LOGGING_THREADS:
LOGGER.log_message(Message(msg, level, html))
[docs]
def trace(msg, html=False):
write(msg, 'TRACE', html)
[docs]
def debug(msg, html=False):
write(msg, 'DEBUG', html)
[docs]
def info(msg, html=False, also_console=False):
write(msg, 'INFO', html)
if also_console:
console(msg)
[docs]
def warn(msg, html=False):
write(msg, 'WARN', html)
[docs]
def error(msg, html=False):
write(msg, 'ERROR', html)
[docs]
def console(msg: str, newline: bool = True, stream: str = 'stdout'):
write_to_console(msg, newline, stream)