Skip to content

add format overriding by environment variables #722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 29, 2024
Merged

add format overriding by environment variables #722

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cef1ce3
add format overriding by environment variables
SammyRamone Jul 21, 2023
37a53a1
Merge remote-tracking branch 'upstream/master' into feature_launch_fo…
SammyRamone Dec 11, 2023
9eaeea4
add test for env var based formatting
SammyRamone Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions launch/launch/logging/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,21 @@ def set_screen_format(self, screen_format, *, screen_style=None):
:param screen_format: format specification used when logging to the screen,
as expected by the `logging.Formatter` constructor.
Alternatively, aliases for common formats are available, see above.
This format can also be overridden by the environment variable
'OVERRIDE_LAUNCH_SCREEN_FORMAT'.
:param screen_style: the screen style used if no alias is used for
screen_format.
No style can be provided if a format alias is given.
"""
# Check if the environment variable is set
screen_format_env = os.environ.get('OVERRIDE_LAUNCH_SCREEN_FORMAT')
# If the environment variable is set override the given format
if screen_format_env not in [None, '']:
# encoded escape characters correctly
screen_format = screen_format_env.encode(
'latin1').decode('unicode_escape')
# Set the style correspondingly
screen_style = '{'
if screen_format is not None:
if screen_format == 'default':
screen_format = '[{levelname}] [{name}]: {msg}'
Expand Down Expand Up @@ -258,9 +269,20 @@ def set_log_format(self, log_format, *, log_style=None):
as expected by the `logging.Formatter` constructor.
Alternatively, the 'default' alias can be given to log verbosity level,
logger name and logged message.
This format can also be overridden by the environment variable
'OVERRIDE_LAUNCH_LOG_FORMAT'.
:param log_style: the log style used if no alias is given for log_format.
No style can be provided if a format alias is given.
"""
# Check if the environment variable is set
log_format_env = os.environ.get('OVERRIDE_LAUNCH_LOG_FORMAT')
# If the environment variable is set override the given format
if log_format_env not in [None, '']:
# encoded escape characters correctly
log_format = log_format_env.encode(
'latin1').decode('unicode_escape')
# Set the style correspondingly
log_style = '{'
if log_format is not None:
if log_format == 'default':
log_format = '{created:.7f} [{levelname}] [{name}]: {msg}'
Expand Down