From b41c39e2913869e8676de669fefedbb2597c32bd Mon Sep 17 00:00:00 2001 From: Bruno Carrez Date: Tue, 18 Jan 2022 23:28:05 -0500 Subject: [PATCH 1/5] print version on debug verbosity level --- src/orion/core/cli/base.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/orion/core/cli/base.py b/src/orion/core/cli/base.py index 0bb2299f0..18fbf4904 100644 --- a/src/orion/core/cli/base.py +++ b/src/orion/core/cli/base.py @@ -9,6 +9,7 @@ import textwrap import orion +import orion.core from orion.core.io.database import DatabaseError from orion.core.utils.exceptions import ( BranchingEvent, @@ -71,6 +72,8 @@ def parse(self, argv): format="%(asctime)-15s::%(levelname)s::%(name)s::%(message)s", level=levels.get(verbose, logging.DEBUG), ) + if verbose >= 2: + print("Orion version : " + orion.core.__version__) if args["command"] is None: self.parser.parse_args(["--help"]) From 3e525d924c8fd4b8a29f48b7f7e486aa4ebbd9bb Mon Sep 17 00:00:00 2001 From: Bruno Carrez Date: Mon, 24 Jan 2022 17:30:41 -0500 Subject: [PATCH 2/5] added test --- src/orion/core/cli/base.py | 5 ++-- .../commands/test_verbose_messages.py | 28 +++++++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 tests/functional/commands/test_verbose_messages.py diff --git a/src/orion/core/cli/base.py b/src/orion/core/cli/base.py index 18fbf4904..5aa3da337 100644 --- a/src/orion/core/cli/base.py +++ b/src/orion/core/cli/base.py @@ -19,6 +19,8 @@ NoNameError, ) +logger = logging.getLogger(__name__) + CLI_DOC_HEADER = "Oríon CLI for asynchronous distributed optimization" @@ -72,8 +74,7 @@ def parse(self, argv): format="%(asctime)-15s::%(levelname)s::%(name)s::%(message)s", level=levels.get(verbose, logging.DEBUG), ) - if verbose >= 2: - print("Orion version : " + orion.core.__version__) + logger.debug("Orion version : " + orion.core.__version__) if args["command"] is None: self.parser.parse_args(["--help"]) diff --git a/tests/functional/commands/test_verbose_messages.py b/tests/functional/commands/test_verbose_messages.py new file mode 100644 index 000000000..29567b5ae --- /dev/null +++ b/tests/functional/commands/test_verbose_messages.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +"""Perform a functional test of the debug verbosity level.""" +import pytest +import logging + +import orion.core.cli + +def test_version_print_debug_verbosity(caplog): + """Tests that Orion version is printed in debug verbosity level""" + + caplog.set_level(logging.INFO) + with pytest.raises(SystemExit): + orion.core.cli.main(["-vv"]) + assert "Orion version : " not in caplog.text + + caplog.clear() + caplog.set_level(logging.DEBUG) + with pytest.raises(SystemExit): + orion.core.cli.main([""]) + assert "Orion version : " not in caplog.text + + caplog.clear() + caplog.set_level(logging.DEBUG) + with pytest.raises(SystemExit): + orion.core.cli.main(["-vv"]) + assert "Orion version : " in caplog.text + \ No newline at end of file From 7ff0d88c3c45d576fed9772b5f0606d2b928d6a1 Mon Sep 17 00:00:00 2001 From: Bruno Carrez Date: Tue, 25 Jan 2022 10:58:17 -0500 Subject: [PATCH 3/5] fixed isort --- tests/functional/commands/test_verbose_messages.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/tests/functional/commands/test_verbose_messages.py b/tests/functional/commands/test_verbose_messages.py index 29567b5ae..4fe15913b 100644 --- a/tests/functional/commands/test_verbose_messages.py +++ b/tests/functional/commands/test_verbose_messages.py @@ -1,11 +1,13 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- """Perform a functional test of the debug verbosity level.""" -import pytest import logging +import pytest + import orion.core.cli + def test_version_print_debug_verbosity(caplog): """Tests that Orion version is printed in debug verbosity level""" @@ -14,15 +16,14 @@ def test_version_print_debug_verbosity(caplog): orion.core.cli.main(["-vv"]) assert "Orion version : " not in caplog.text - caplog.clear() + caplog.clear() caplog.set_level(logging.DEBUG) with pytest.raises(SystemExit): orion.core.cli.main([""]) assert "Orion version : " not in caplog.text - caplog.clear() + caplog.clear() caplog.set_level(logging.DEBUG) with pytest.raises(SystemExit): orion.core.cli.main(["-vv"]) assert "Orion version : " in caplog.text - \ No newline at end of file From 6abe189a428f9ca1634b66082119346090c04d90 Mon Sep 17 00:00:00 2001 From: Bruno Carrez Date: Tue, 25 Jan 2022 12:43:35 -0500 Subject: [PATCH 4/5] fixed log formatting (reported by pylint) --- src/orion/core/cli/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/orion/core/cli/base.py b/src/orion/core/cli/base.py index 5aa3da337..bddc3157c 100644 --- a/src/orion/core/cli/base.py +++ b/src/orion/core/cli/base.py @@ -74,7 +74,7 @@ def parse(self, argv): format="%(asctime)-15s::%(levelname)s::%(name)s::%(message)s", level=levels.get(verbose, logging.DEBUG), ) - logger.debug("Orion version : " + orion.core.__version__) + logger.debug("Orion version : %s",orion.core.__version__) if args["command"] is None: self.parser.parse_args(["--help"]) From ea94a59599fbe23536a2ce04a23a7524cf461dd1 Mon Sep 17 00:00:00 2001 From: Bruno Carrez Date: Tue, 25 Jan 2022 21:28:59 -0500 Subject: [PATCH 5/5] test updated --- src/orion/core/cli/base.py | 2 +- tests/functional/commands/test_verbose_messages.py | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/orion/core/cli/base.py b/src/orion/core/cli/base.py index bddc3157c..2892beb04 100644 --- a/src/orion/core/cli/base.py +++ b/src/orion/core/cli/base.py @@ -74,7 +74,7 @@ def parse(self, argv): format="%(asctime)-15s::%(levelname)s::%(name)s::%(message)s", level=levels.get(verbose, logging.DEBUG), ) - logger.debug("Orion version : %s",orion.core.__version__) + logger.debug("Orion version : %s", orion.core.__version__) if args["command"] is None: self.parser.parse_args(["--help"]) diff --git a/tests/functional/commands/test_verbose_messages.py b/tests/functional/commands/test_verbose_messages.py index 4fe15913b..603507742 100644 --- a/tests/functional/commands/test_verbose_messages.py +++ b/tests/functional/commands/test_verbose_messages.py @@ -11,19 +11,17 @@ def test_version_print_debug_verbosity(caplog): """Tests that Orion version is printed in debug verbosity level""" - caplog.set_level(logging.INFO) - with pytest.raises(SystemExit): - orion.core.cli.main(["-vv"]) - assert "Orion version : " not in caplog.text - - caplog.clear() caplog.set_level(logging.DEBUG) + with pytest.raises(SystemExit): orion.core.cli.main([""]) assert "Orion version : " not in caplog.text caplog.clear() - caplog.set_level(logging.DEBUG) with pytest.raises(SystemExit): orion.core.cli.main(["-vv"]) + for (loggername, loggerlevel, text) in caplog.record_tuples: + assert not ( + text.startswith("Orion version : ") and (loggerlevel != logging.DEBUG) + ) assert "Orion version : " in caplog.text