From ae9f5caab70084fe34271bdd66096f06fbae9f85 Mon Sep 17 00:00:00 2001 From: Vladimir Kotal Date: Sun, 8 Jan 2023 22:41:49 +0100 Subject: [PATCH 1/5] use correct terminology for enable_logger() also improve the documentation --- adafruit_minimqtt/adafruit_minimqtt.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/adafruit_minimqtt/adafruit_minimqtt.py b/adafruit_minimqtt/adafruit_minimqtt.py index 00bace2b..36a5f10d 100644 --- a/adafruit_minimqtt/adafruit_minimqtt.py +++ b/adafruit_minimqtt/adafruit_minimqtt.py @@ -1074,14 +1074,15 @@ def is_connected(self): return self._is_connected and self._sock is not None # Logging - def enable_logger(self, logger, log_level=20): - """Enables library logging provided a logger object. + def enable_logger(self, log_pkg, log_level=20): + """Enables library logging by getting logger named "log" from the specified logging package + and setting its log level. - :param logger: A python logger pacakge. + :param log_pkg: A Python logging package. :param log_level: Numeric value of a logging level, defaults to INFO. """ - self.logger = logger.getLogger("log") + self.logger = log_pkg.getLogger("log") self.logger.setLevel(log_level) def disable_logger(self): From 5b440f5c422099c7a86dcd36d9f76318263f26ce Mon Sep 17 00:00:00 2001 From: Vladimir Kotal Date: Sun, 8 Jan 2023 22:48:09 +0100 Subject: [PATCH 2/5] return the logger --- adafruit_minimqtt/adafruit_minimqtt.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_minimqtt/adafruit_minimqtt.py b/adafruit_minimqtt/adafruit_minimqtt.py index 36a5f10d..83b31cc3 100644 --- a/adafruit_minimqtt/adafruit_minimqtt.py +++ b/adafruit_minimqtt/adafruit_minimqtt.py @@ -1080,11 +1080,13 @@ def enable_logger(self, log_pkg, log_level=20): :param log_pkg: A Python logging package. :param log_level: Numeric value of a logging level, defaults to INFO. - + :return logger object """ self.logger = log_pkg.getLogger("log") self.logger.setLevel(log_level) + return self.logger + def disable_logger(self): """Disables logging.""" if not self.logger: From a5284239401326785cfd24bcb31ce99140985ff2 Mon Sep 17 00:00:00 2001 From: Vladimir Kotal Date: Sun, 8 Jan 2023 22:52:14 +0100 Subject: [PATCH 3/5] allow to specify logger name --- adafruit_minimqtt/adafruit_minimqtt.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/adafruit_minimqtt/adafruit_minimqtt.py b/adafruit_minimqtt/adafruit_minimqtt.py index 83b31cc3..4314aa42 100644 --- a/adafruit_minimqtt/adafruit_minimqtt.py +++ b/adafruit_minimqtt/adafruit_minimqtt.py @@ -1074,15 +1074,16 @@ def is_connected(self): return self._is_connected and self._sock is not None # Logging - def enable_logger(self, log_pkg, log_level=20): - """Enables library logging by getting logger named "log" from the specified logging package + def enable_logger(self, log_pkg, log_level=20, logger_name="log"): + """Enables library logging by getting logger from the specified logging package and setting its log level. :param log_pkg: A Python logging package. :param log_level: Numeric value of a logging level, defaults to INFO. + :param logger_name: name of the logger, defaults to "log". :return logger object """ - self.logger = log_pkg.getLogger("log") + self.logger = log_pkg.getLogger(logger_name) self.logger.setLevel(log_level) return self.logger From b24bb81dec512405bd98969e8ae1d1416f3d03e1 Mon Sep 17 00:00:00 2001 From: Vladimir Kotal Date: Sun, 8 Jan 2023 22:56:18 +0100 Subject: [PATCH 4/5] field list should end with a blank line --- adafruit_minimqtt/adafruit_minimqtt.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_minimqtt/adafruit_minimqtt.py b/adafruit_minimqtt/adafruit_minimqtt.py index 4314aa42..f71b23ef 100644 --- a/adafruit_minimqtt/adafruit_minimqtt.py +++ b/adafruit_minimqtt/adafruit_minimqtt.py @@ -1082,6 +1082,7 @@ def enable_logger(self, log_pkg, log_level=20, logger_name="log"): :param log_level: Numeric value of a logging level, defaults to INFO. :param logger_name: name of the logger, defaults to "log". :return logger object + """ self.logger = log_pkg.getLogger(logger_name) self.logger.setLevel(log_level) From 9d66d9f553b8814be9149dc13e19075c4f5c2c7e Mon Sep 17 00:00:00 2001 From: Vladimir Kotal Date: Sun, 8 Jan 2023 22:59:26 +0100 Subject: [PATCH 5/5] another blank line --- adafruit_minimqtt/adafruit_minimqtt.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_minimqtt/adafruit_minimqtt.py b/adafruit_minimqtt/adafruit_minimqtt.py index f71b23ef..6132b54f 100644 --- a/adafruit_minimqtt/adafruit_minimqtt.py +++ b/adafruit_minimqtt/adafruit_minimqtt.py @@ -1081,6 +1081,7 @@ def enable_logger(self, log_pkg, log_level=20, logger_name="log"): :param log_pkg: A Python logging package. :param log_level: Numeric value of a logging level, defaults to INFO. :param logger_name: name of the logger, defaults to "log". + :return logger object """