From 16c1b87007efafd52fb5036de65b9a1990dd732b Mon Sep 17 00:00:00 2001 From: tsmorz Date: Fri, 31 Oct 2025 11:15:47 +0100 Subject: [PATCH 1/3] bug fix when creating logger levels list --- .coverage | Bin 53248 -> 53248 bytes src/change_me/__main__.py | 6 +++--- tests/main_test.py | 10 ++++++++++ tests/utils_test.py | 12 +++++++++++- 4 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 tests/main_test.py diff --git a/.coverage b/.coverage index ade57272641b575e588ae1bec4368a66d469f76d..fde3bfd3160a5097e308ca854966c3b7285397fc 100644 GIT binary patch delta 276 zcmZozz}&Eac>}KlGb7)I%>oW#d`up!llS;}va+x+G%8O%;Ac7cwLjNnUw;m!Am+*I z{5|<|6EpMT?fro|v3IqR7{`dTk_^$wsKEiLq!@|PI zDaEo&=)+IOTe95DK%N9s)W?u_>sdIMfE*#_Rhdkzj4Yg-d`w&n3=Ay%&lvcB^S|Z) e!v73t!Zm&oHlQj-78WqY#0;jGH~*T?W&i-n<4#5Z delta 232 zcmZozz}&Eac>}KlGYj9Y%>oW#d`v;Clh^rsPWJKVWb$B{oZ;um%FM#hs608x&vLSZ zKNnwVNoG#5UO{Cj6Hr(mCOmnbe>UfC{ zL0lI`mdP9A0@#?tSQ_ None: +def main(log_level: str = DEFAULT_LOG_LEVEL) -> None: """Run the pipeline.""" setup_logger(filename="log_file", log_dir=None, log_level=log_level) logger.info("Hello world!") -if __name__ == "__main__": +if __name__ == "__main__": # pragma: no cover parser = argparse.ArgumentParser() parser.add_argument( "--log-level", default=DEFAULT_LOG_LEVEL, - choices=list(LogLevel), + choices=list(LogLevel()), help="Log level.", ) args = parser.parse_args() diff --git a/tests/main_test.py b/tests/main_test.py new file mode 100644 index 0000000..add1078 --- /dev/null +++ b/tests/main_test.py @@ -0,0 +1,10 @@ +"""Test the main program.""" + +from change_me.__main__ import main + + +def test_main(): + """Test the main function.""" + result = main() + + assert result is None diff --git a/tests/utils_test.py b/tests/utils_test.py index e5ddf72..8da207f 100644 --- a/tests/utils_test.py +++ b/tests/utils_test.py @@ -3,13 +3,23 @@ from pathlib import Path from tempfile import TemporaryDirectory +from change_me.definitions import LogLevel from change_me.utils import setup_logger -def test_logger_init(): +def test_logger_init() -> None: """Test logger initialization.""" with TemporaryDirectory() as log_dir: log_dir_path = Path(log_dir) log_filepath = setup_logger(filename="log_file", log_dir=log_dir_path) assert Path(log_filepath).exists() assert not Path(log_filepath).exists() + + +def test_log_level() -> None: + """Test the log level.""" + # Act + log_levels = list(LogLevel()) + + # Assert + assert type(log_levels) is list From 6dd0d90a26579ed42e8bb408b6a3895958e8f8e7 Mon Sep 17 00:00:00 2001 From: tsmorz Date: Fri, 31 Oct 2025 11:22:46 +0100 Subject: [PATCH 2/3] update readme --- README.md | 7 ++++++- src/change_me/__main__.py | 6 +++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8eb8aee..55ae526 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ To install the library run: `pip install change-me` 5. `poetry publish --build` to build and publish to https://pypi.org/project/change-me -## Usage +## Module Usage ``` """Basic docstring for my module.""" @@ -26,3 +26,8 @@ logger.info("Hello World!") if __name__ == "__main__": main() ``` + +## Program Usage +```bash +poetry run python -m change_me +``` diff --git a/src/change_me/__main__.py b/src/change_me/__main__.py index 8e45e15..2161425 100644 --- a/src/change_me/__main__.py +++ b/src/change_me/__main__.py @@ -11,16 +11,16 @@ def main(log_level: str = DEFAULT_LOG_LEVEL) -> None: """Run the pipeline.""" setup_logger(filename="log_file", log_dir=None, log_level=log_level) - logger.info("Hello world!") + logger.info("Hello, world!") if __name__ == "__main__": # pragma: no cover - parser = argparse.ArgumentParser() + parser = argparse.ArgumentParser("Run the pipeline.") parser.add_argument( "--log-level", default=DEFAULT_LOG_LEVEL, choices=list(LogLevel()), - help="Log level.", + help="Set the log level.", ) args = parser.parse_args() From 558ae8e8edf0243358fa0c10993ed4de0400767b Mon Sep 17 00:00:00 2001 From: tsmorz Date: Fri, 31 Oct 2025 11:23:59 +0100 Subject: [PATCH 3/3] add app shortcut to make file --- Makefile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Makefile b/Makefile index 9beb8a4..2b74d48 100644 --- a/Makefile +++ b/Makefile @@ -34,3 +34,6 @@ update: docker: docker build --no-cache -f Dockerfile -t change_me-smoke . docker run --rm change_me-smoke + +app: + poetry run python -m change_me