From 6182930c3ea53932c6153dd101264cb90c90f979 Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Fri, 14 Feb 2025 13:44:57 +0000 Subject: add universal logging for debugging --- obfuscator/logger.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 obfuscator/logger.py (limited to 'obfuscator/logger.py') diff --git a/obfuscator/logger.py b/obfuscator/logger.py new file mode 100644 index 0000000..52c4f5e --- /dev/null +++ b/obfuscator/logger.py @@ -0,0 +1,21 @@ +import logging +import os + +def get_logger(name: str) -> logging.Logger: + logger = logging.getLogger(name) + + if not logger.hasHandlers(): + if os.getenv("DEBUG", "FALSE").upper() == "TRUE": + log_level = logging.DEBUG + else: + log_level = logging.INFO + + logger.setLevel(log_level) + + handler = logging.StreamHandler() + format = logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s") + handler.setFormatter(format) + + logger.addHandler(handler) + + return logger \ No newline at end of file -- cgit v1.2.3 From 0f29d52ba932eeed2ae5826c31cbe9a379fd4579 Mon Sep 17 00:00:00 2001 From: "deepsource-autofix[bot]" <62050782+deepsource-autofix[bot]@users.noreply.github.com> Date: Fri, 14 Feb 2025 13:47:05 +0000 Subject: style: format code with Autopep8, Black and Ruff Formatter This commit fixes the style issues introduced in 6182930 according to the output from Autopep8, Black and Ruff Formatter. Details: https://github.com/ajschofield/gdpr-obfuscator/pull/1 --- cli.py | 2 ++ obfuscator/csv_reader.py | 4 +--- obfuscator/logger.py | 7 +++++-- test/test_csv_reader.py | 15 ++++++++++----- 4 files changed, 18 insertions(+), 10 deletions(-) (limited to 'obfuscator/logger.py') diff --git a/cli.py b/cli.py index 23c9057..652830e 100644 --- a/cli.py +++ b/cli.py @@ -4,6 +4,7 @@ from obfuscator.logger import get_logger logger = get_logger("CLI") + def main(): parser = argparse.ArgumentParser(description="gdpr-obfuscator") # Require user to either choose a local file or an S3 object @@ -20,5 +21,6 @@ def main(): else: logger.debug("User chose to read CSV from S3") + if __name__ == "__main__": main() diff --git a/obfuscator/csv_reader.py b/obfuscator/csv_reader.py index 42e8f8a..5bc91dc 100644 --- a/obfuscator/csv_reader.py +++ b/obfuscator/csv_reader.py @@ -4,6 +4,7 @@ from logger import get_logger logger = get_logger("CSVReader") + class CSVReader: def __init__(self, path: str): self.path = path @@ -27,6 +28,3 @@ class CSVReader: def read_s3(self) -> List[Dict[str, str]]: return [] - - - diff --git a/obfuscator/logger.py b/obfuscator/logger.py index 52c4f5e..61a75ec 100644 --- a/obfuscator/logger.py +++ b/obfuscator/logger.py @@ -1,6 +1,7 @@ import logging import os + def get_logger(name: str) -> logging.Logger: logger = logging.getLogger(name) @@ -13,9 +14,11 @@ def get_logger(name: str) -> logging.Logger: logger.setLevel(log_level) handler = logging.StreamHandler() - format = logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s") + format = logging.Formatter( + "%(asctime)s - %(levelname)s - %(name)s - %(message)s" + ) handler.setFormatter(format) logger.addHandler(handler) - return logger \ No newline at end of file + return logger diff --git a/test/test_csv_reader.py b/test/test_csv_reader.py index d245d7c..ac43b04 100644 --- a/test/test_csv_reader.py +++ b/test/test_csv_reader.py @@ -4,34 +4,38 @@ from main import csv_reader import pytest + def test_empty_csv_should_return_no_content(): content = "" result = csv_reader(content) expected = [] assert result == expected + def test_csv_with_header_only_should_return_no_content(): content = "student_id,name,course\n" result = csv_reader(content) expected = [] assert result == expected + def test_csv_with_valid_data(): content = ( "student_id,name,course\n" "1234,Student 1,Course 1\n" "5678,Student 2,Course 2\n" - ) + ) result = csv_reader(content) expected = [ {"student_id": "1234", "name": "Student 1", "course": "Course 1"}, {"student_id": "5678", "name": "Student 2", "course": "Course 2"}, - ] - assert result == expected + ] + assert result == expected + def test_csv_with_quoted_fields_should_run_as_expected(): content = ( - 'student_id,name,course\n' + "student_id,name,course\n" '1234,"Student 1","Course 1"\n' '5678,"Student 2","Course 2"\n' ) @@ -42,8 +46,9 @@ def test_csv_with_quoted_fields_should_run_as_expected(): ] assert result == expected + def test_non_csv_file_should_return_no_content(): content = "" result = csv_reader(content) expected = [] - assert result == expected \ No newline at end of file + assert result == expected -- cgit v1.2.3 From 3c0d24558db94e359fbcde89a48526b8b36218e4 Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Mon, 17 Feb 2025 01:10:17 +0000 Subject: anti-pattern: fix re-definition of format variable in logger.py --- obfuscator/logger.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'obfuscator/logger.py') diff --git a/obfuscator/logger.py b/obfuscator/logger.py index 61a75ec..ca41e95 100644 --- a/obfuscator/logger.py +++ b/obfuscator/logger.py @@ -14,10 +14,10 @@ def get_logger(name: str) -> logging.Logger: logger.setLevel(log_level) handler = logging.StreamHandler() - format = logging.Formatter( + formatting = logging.Formatter( "%(asctime)s - %(levelname)s - %(name)s - %(message)s" ) - handler.setFormatter(format) + handler.setFormatter(formatting) logger.addHandler(handler) -- cgit v1.2.3