psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

support for NO_COLOR env var

Browse source
This commit is contained in:
shivansh02 2024-03-04 18:21:28 +05:30
parent b6cb7da98e
commit 40c3a28620
3 changed files with 29 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
borgmatic/logger.py
View file

@ -41,6 +41,10 @@ def should_do_markup(no_color, configs):
if any(config.get('output', {}).get('color') is False for config in configs.values()): if any(config.get('output', {}).get('color') is False for config in configs.values()):
return False return False
no_color_env = os.environ.get('NO_COLOR', None)
if no_color_env is not None and to_bool(no_color_env):
return False
py_colors = os.environ.get('PY_COLORS', None) py_colors = os.environ.get('PY_COLORS', None)
if py_colors is not None: if py_colors is not None:

2
docs/how-to/set-up-backups.md
View file

@ -406,7 +406,7 @@ source /usr/share/fish/vendor_completions.d/borgmatic.fish
borgmatic produces colored terminal output by default. It is disabled when a borgmatic produces colored terminal output by default. It is disabled when a
non-interactive terminal is detected (like a cron job), or when you use the non-interactive terminal is detected (like a cron job), or when you use the
`--json` flag. Otherwise, you can disable it by passing the `--no-color` flag, `--json` flag. Otherwise, you can disable it by passing the `--no-color` flag,
setting the environment variable `PY_COLORS=False`, or setting the `color` setting the environment variables `PY_COLORS=False` or `NO_COLOR=True`, or setting the `color`
option to `false` in the `output` section of configuration. option to `false` in the `output` section of configuration.

28
tests/unit/test_logger.py
View file

@ -69,7 +69,9 @@ def test_should_do_markup_prefers_any_false_config_value():
def test_should_do_markup_respects_PY_COLORS_environment_variable(): def test_should_do_markup_respects_PY_COLORS_environment_variable():
flexmock(module.os.environ).should_receive('get').and_return('True') flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return('True')
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return(None)
flexmock(module).should_receive('to_bool').and_return(True) flexmock(module).should_receive('to_bool').and_return(True)
assert module.should_do_markup(no_color=False, configs={}) is True assert module.should_do_markup(no_color=False, configs={}) is True
@ -82,7 +84,7 @@ def test_should_do_markup_prefers_no_color_value_to_config_value():
) )
def test_should_do_markup_prefers_config_value_to_PY_COLORS(): def test_should_do_markup_prefers_config_value_to_environment_variables():
flexmock(module.os.environ).should_receive('get').and_return('True') flexmock(module.os.environ).should_receive('get').and_return('True')
flexmock(module).should_receive('to_bool').and_return(True) flexmock(module).should_receive('to_bool').and_return(True)
@ -92,7 +94,7 @@ def test_should_do_markup_prefers_config_value_to_PY_COLORS():
) )
def test_should_do_markup_prefers_no_color_value_to_PY_COLORS(): def test_should_do_markup_prefers_no_color_value_to_environment_variables():
flexmock(module.os.environ).should_receive('get').and_return('True') flexmock(module.os.environ).should_receive('get').and_return('True')
flexmock(module).should_receive('to_bool').and_return(True) flexmock(module).should_receive('to_bool').and_return(True)
@ -107,12 +109,30 @@ def test_should_do_markup_respects_interactive_console_value():
def test_should_do_markup_prefers_PY_COLORS_to_interactive_console_value(): def test_should_do_markup_prefers_PY_COLORS_to_interactive_console_value():
flexmock(module.os.environ).should_receive('get').and_return('True') flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return('True')
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return(None)
flexmock(module).should_receive('to_bool').and_return(True) flexmock(module).should_receive('to_bool').and_return(True)
flexmock(module).should_receive('interactive_console').and_return(False) flexmock(module).should_receive('interactive_console').and_return(False)
assert module.should_do_markup(no_color=False, configs={}) is True assert module.should_do_markup(no_color=False, configs={}) is True
def test_should_do_markup_prefers_NO_COLOR_to_interactive_console_value():
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(None)
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return('True')
flexmock(module).should_receive('to_bool').and_return(True)
flexmock(module).should_receive('interactive_console').and_return(False)
assert module.should_do_markup(no_color=False, configs={}) is False
def test_should_do_markup_respects_NO_COLOR_environment_variable():
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return('True')
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(None)
flexmock(module).should_receive('to_bool').and_return(True)
assert module.should_do_markup(no_color=False, configs={}) is False
def test_multi_stream_handler_logs_to_handler_for_log_level(): def test_multi_stream_handler_logs_to_handler_for_log_level():
error_handler = flexmock() error_handler = flexmock()