From 39a7927f2fa44ecb1802cef5c76dc8350c65ae14 Mon Sep 17 00:00:00 2001 From: Phil Underwood Date: Thu, 20 Jun 2024 13:12:13 +0100 Subject: [PATCH 01/13] Add support for multiline logs and exceptions --- adafruit_logging.py | 42 ++++++++++++++++++++++++++++------ examples/logging_simpletest.py | 9 +++++++- 2 files changed, 43 insertions(+), 8 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index f1e171f..6394f16 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -202,6 +202,15 @@ def __init__(self, stream: Optional[WriteableStream] = None) -> None: self.stream = stream """The stream to log to""" + def format(self, record: LogRecord) -> str: + """Generate a string to log + + :param record: The record (message object) to be logged + """ + text = super().format(record) + lines = text.splitlines() + return self.terminator.join(lines) + self.terminator + def emit(self, record: LogRecord) -> None: """Send a message to the console. @@ -224,6 +233,8 @@ class FileHandler(StreamHandler): :param str mode: Whether to write ('w') or append ('a'); default is to append """ + terminator = "\r\n" + def __init__(self, filename: str, mode: str = "a") -> None: # pylint: disable=consider-using-with if mode == "r": @@ -235,13 +246,6 @@ def close(self) -> None: self.stream.flush() self.stream.close() - def format(self, record: LogRecord) -> str: - """Generate a string to log - - :param record: The record (message object) to be logged - """ - return super().format(record) + "\r\n" - def emit(self, record: LogRecord) -> None: """Generate the message and write it to the file. @@ -538,3 +542,27 @@ def critical(self, msg: str, *args) -> None: can be empty """ self._log(CRITICAL, msg, *args) + + # pylint: disable=no-value-for-parameter; value and tb are optional for traceback + def exception(self, err: Exception) -> None: + """Convenience method for logging an ERROR with exception information. + + :param Exception err: the exception to be logged + """ + try: + # pylint: disable=import-outside-toplevel; not available on all boards + import traceback + except ImportError: + self._log( + ERROR, + "%s: %s (No traceback on this board)", + err.__class__.__name__, + str(err), + ) + else: + lines = [str(err)] + traceback.format_exception(err) + lines = str(err) + "\n".join(lines) + # some of the returned strings from format_exception already have newlines in them, + # so we can't add the indent in the above line - needs to be done separately + lines = lines.replace("\n", "\n ") + self._log(ERROR, lines) diff --git a/examples/logging_simpletest.py b/examples/logging_simpletest.py index c8099a1..3bb25e1 100644 --- a/examples/logging_simpletest.py +++ b/examples/logging_simpletest.py @@ -25,7 +25,10 @@ logger.setLevel(logging.ERROR) logger.info("Stream Handler: Info message") logger.error("Stream Handler: Error message") - +try: + raise RuntimeError("Test exception handling") +except RuntimeError as e: + logger.exception(e) # This should produce no output at all. null_logger = logging.getLogger("null") @@ -36,3 +39,7 @@ null_logger.setLevel(logging.ERROR) null_logger.info("Null Handler: Info message") null_logger.error("Null Handler: Error message") +try: + raise RuntimeError("Test exception handling") +except RuntimeError as e: + null_logger.exception(e) From f7dc544add8acc98fb76696b9aa2cb0cfd54a684 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 5 Aug 2024 18:15:36 -0500 Subject: [PATCH 02/13] adding Formatter and example including timestamp --- adafruit_logging.py | 68 ++++++++++++++++++++++++++- examples/logging_formatter_example.py | 33 +++++++++++++ 2 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 examples/logging_formatter_example.py diff --git a/adafruit_logging.py b/adafruit_logging.py index 6394f16..4d0ae46 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -148,12 +148,71 @@ def _logRecordFactory(name, level, msg, args): return LogRecord(name, level, _level_for(level), msg, time.monotonic(), args) +class Formatter: + """ + Responsible for converting a LogRecord to an output string to be + interpreted by a human or external system. + + Only implements a sub-set of CPython logging.Formatter behavior, + but retains all the same arguments in order to match the API. + + The only init arguments currently supported are: fmt and defaults. + All others are currently ignored + + The only style value currently supported is '{'. CPython has support + for some others, but this implementation does not. Additionally, the + default value for style in this implementation is '{' whereas the default + style value in CPython is '%' + """ + + def __init__( # pylint: disable=too-many-arguments + self, fmt=None, datefmt=None, style="{", validate=True, defaults=None + ): + self.fmt = fmt + self.datefmt = datefmt + self.style = style + if self.style != "{": + raise ValueError("Only '{' formatting sytle is supported at this time.") + + self.validate = validate + self.defaults = defaults + + def format(self, record: LogRecord) -> str: + """ + Format the given LogRecord into an output string + """ + if self.fmt is None: + return record.msg + + vals = { + "name": record.name, + "levelno": record.levelno, + "levelname": record.levelname, + "message": record.msg, + "created": record.created, + "args": record.args, + } + if "{asctime}" in self.fmt: + now = time.localtime() + vals["asctime"] = ( + f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} " + f"{now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" + ) + + if self.defaults: + for key, val in self.defaults.items(): + vals[key] = val + + return self.fmt.format(**vals) + + class Handler: """Base logging message handler.""" def __init__(self, level: int = NOTSET) -> None: """Create Handler instance""" self.level = level + self.formatter = None def setLevel(self, level: int) -> None: """ @@ -167,7 +226,8 @@ def format(self, record: LogRecord) -> str: :param record: The record (message object) to be logged """ - + if self.formatter: + return self.formatter.format(record) return f"{record.created:<0.3f}: {record.levelname} - {record.msg}" def emit(self, record: LogRecord) -> None: @@ -182,6 +242,12 @@ def emit(self, record: LogRecord) -> None: def flush(self) -> None: """Placeholder for flush function in subclasses.""" + def setFormatter(self, formatter: Formatter) -> None: + """ + Set the Formatter to be used by this Handler. + """ + self.formatter = formatter + # pylint: disable=too-few-public-methods class StreamHandler(Handler): diff --git a/examples/logging_formatter_example.py b/examples/logging_formatter_example.py new file mode 100644 index 0000000..5e35e37 --- /dev/null +++ b/examples/logging_formatter_example.py @@ -0,0 +1,33 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks +# SPDX-License-Identifier: MIT + + +"""Briefly exercise the logger and null logger.""" + +import adafruit_logging as logging +# To test on CPython, un-comment below and comment out above +# import logging + + +logger = logging.getLogger("example") +logger.setLevel(logging.INFO) +print_handler = logging.StreamHandler() +logger.addHandler(print_handler) + +default_formatter = logging.Formatter() +print_handler.setFormatter(default_formatter) +logger.info("Default formatter example") + + +timestamp_formatter = logging.Formatter( + fmt="{asctime} {levelname}: {message}", style="{" +) +print_handler.setFormatter(timestamp_formatter) +logger.info("Timestamp formatter example") + + +custom_vals_formatter = logging.Formatter( + fmt="{ip} {levelname}: {message}", style="{", defaults={"ip": "192.168.1.188"} +) +print_handler.setFormatter(custom_vals_formatter) +logger.info("Custom formatter example") From 8f53ae15afafde6bb0c3e7abefdc079d43e18296 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 5 Aug 2024 18:33:48 -0500 Subject: [PATCH 03/13] update comment --- examples/logging_formatter_example.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/logging_formatter_example.py b/examples/logging_formatter_example.py index 5e35e37..460e028 100644 --- a/examples/logging_formatter_example.py +++ b/examples/logging_formatter_example.py @@ -2,9 +2,11 @@ # SPDX-License-Identifier: MIT -"""Briefly exercise the logger and null logger.""" +"""Illustrate usage of default and custom Formatters including +one with timestamps.""" import adafruit_logging as logging + # To test on CPython, un-comment below and comment out above # import logging From 555981ac12e5937b3fa05560b214242ca277edc2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 5 Aug 2024 18:38:38 -0500 Subject: [PATCH 04/13] fix unsupported syntx --- adafruit_logging.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index 4d0ae46..f2041b8 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -194,10 +194,10 @@ def format(self, record: LogRecord) -> str: } if "{asctime}" in self.fmt: now = time.localtime() - vals["asctime"] = ( - f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} " - f"{now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" - ) + # pylint: disable=line-too-long + vals[ + "asctime" + ] = f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" if self.defaults: for key, val in self.defaults.items(): From 48fd4412ed46114e61fb1c9ab7c7aba918d236df Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 5 Aug 2024 19:04:29 -0500 Subject: [PATCH 05/13] remove extra newlines --- adafruit_logging.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index 6394f16..117c1bf 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -209,7 +209,7 @@ def format(self, record: LogRecord) -> str: """ text = super().format(record) lines = text.splitlines() - return self.terminator.join(lines) + self.terminator + return self.terminator.join(lines) def emit(self, record: LogRecord) -> None: """Send a message to the console. @@ -561,7 +561,7 @@ def exception(self, err: Exception) -> None: ) else: lines = [str(err)] + traceback.format_exception(err) - lines = str(err) + "\n".join(lines) + lines = str(err) + "".join(lines) # some of the returned strings from format_exception already have newlines in them, # so we can't add the indent in the above line - needs to be done separately lines = lines.replace("\n", "\n ") From ef8c237e276e34af2a54b17a4e6d9eae899b5b9f Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 6 Aug 2024 10:52:17 -0500 Subject: [PATCH 06/13] implement % sytle and change default to it --- adafruit_logging.py | 35 ++++++++++++++++++--------- examples/logging_formatter_example.py | 21 +++++++++++++--- 2 files changed, 41 insertions(+), 15 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index f2041b8..029b834 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -64,7 +64,7 @@ try: # pylint: disable=deprecated-class - from typing import Optional, Hashable + from typing import Optional, Hashable, Dict from typing_extensions import Protocol class WriteableStream(Protocol): @@ -156,23 +156,28 @@ class Formatter: Only implements a sub-set of CPython logging.Formatter behavior, but retains all the same arguments in order to match the API. - The only init arguments currently supported are: fmt and defaults. - All others are currently ignored + The only init arguments currently supported are: fmt, defaults and + style. All others are currently ignored - The only style value currently supported is '{'. CPython has support - for some others, but this implementation does not. Additionally, the - default value for style in this implementation is '{' whereas the default - style value in CPython is '%' + The only two styles currently supported are '%' and '{'. The default + style is '{' """ def __init__( # pylint: disable=too-many-arguments - self, fmt=None, datefmt=None, style="{", validate=True, defaults=None + self, + fmt: Optional[str] = None, + datefmt: Optional[str] = None, + style: str = "%", + validate: bool = True, + defaults: Dict = None, ): self.fmt = fmt self.datefmt = datefmt self.style = style - if self.style != "{": - raise ValueError("Only '{' formatting sytle is supported at this time.") + if self.style not in ("{", "%"): + raise ValueError( + "Only '%' and '{' formatting style are supported at this time." + ) self.validate = validate self.defaults = defaults @@ -192,7 +197,7 @@ def format(self, record: LogRecord) -> str: "created": record.created, "args": record.args, } - if "{asctime}" in self.fmt: + if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt: now = time.localtime() # pylint: disable=line-too-long vals[ @@ -203,6 +208,14 @@ def format(self, record: LogRecord) -> str: for key, val in self.defaults.items(): vals[key] = val + if self.style not in ("{", "%"): + raise ValueError( + "Only '%' and '{' formatting style are supported at this time." + ) + + if self.style == "%": + return self.fmt % vals + return self.fmt.format(**vals) diff --git a/examples/logging_formatter_example.py b/examples/logging_formatter_example.py index 460e028..ccd2eea 100644 --- a/examples/logging_formatter_example.py +++ b/examples/logging_formatter_example.py @@ -17,19 +17,32 @@ logger.addHandler(print_handler) default_formatter = logging.Formatter() + print_handler.setFormatter(default_formatter) logger.info("Default formatter example") -timestamp_formatter = logging.Formatter( - fmt="{asctime} {levelname}: {message}", style="{" -) +timestamp_formatter = logging.Formatter(fmt="%(asctime)s %(levelname)s: %(message)s") print_handler.setFormatter(timestamp_formatter) logger.info("Timestamp formatter example") custom_vals_formatter = logging.Formatter( - fmt="{ip} {levelname}: {message}", style="{", defaults={"ip": "192.168.1.188"} + fmt="%(ip)s %(levelname)s: %(message)s", defaults={"ip": "192.168.1.188"} ) print_handler.setFormatter(custom_vals_formatter) logger.info("Custom formatter example") + + +bracket_timestamp_formatter = logging.Formatter( + fmt="{asctime} {levelname}: {message}", style="{" +) +print_handler.setFormatter(bracket_timestamp_formatter) +logger.info("Timestamp formatter bracket style example") + + +bracket_custom_vals_formatter = logging.Formatter( + fmt="{ip} {levelname}: {message}", style="{", defaults={"ip": "192.168.1.188"} +) +print_handler.setFormatter(bracket_custom_vals_formatter) +logger.info("Custom formatter bracket style example") From c9ae545190816800bb564892e1fd786ab7adba14 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 6 Aug 2024 13:12:53 -0500 Subject: [PATCH 07/13] prevent defaults from clobbering --- adafruit_logging.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index 029b834..d037b15 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -206,7 +206,8 @@ def format(self, record: LogRecord) -> str: if self.defaults: for key, val in self.defaults.items(): - vals[key] = val + if key not in vals: + vals[key] = val if self.style not in ("{", "%"): raise ValueError( From 66e3cfd3b445e381985641a0a6c6ad3fbe7d2599 Mon Sep 17 00:00:00 2001 From: aggieNick02 Date: Thu, 26 Sep 2024 12:30:43 -0500 Subject: [PATCH 08/13] Fix log files not containing any newlines ever (affects FileHandler and RotatingFileHandler) --- adafruit_logging.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index dc3c652..6bf8de2 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -331,7 +331,7 @@ def emit(self, record: LogRecord) -> None: :param record: The record (message object) to be logged """ - self.stream.write(self.format(record)) + super().emit(record) self.stream.flush() @@ -431,9 +431,7 @@ def emit(self, record: LogRecord) -> None: and (self._backupCount > 0) ): self.doRollover() - self.stream.write(self.format(record)) - self.stream.flush() - + super().emit(record) class NullHandler(Handler): """Provide an empty log handler. From 633045a39746750c021b9632bcb977b76fa58e5a Mon Sep 17 00:00:00 2001 From: aggieNick02 Date: Thu, 26 Sep 2024 12:42:32 -0500 Subject: [PATCH 09/13] fix formatting --- adafruit_logging.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index 6bf8de2..d70c306 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -200,9 +200,9 @@ def format(self, record: LogRecord) -> str: if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt: now = time.localtime() # pylint: disable=line-too-long - vals[ - "asctime" - ] = f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" + vals["asctime"] = ( + f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" + ) if self.defaults: for key, val in self.defaults.items(): @@ -433,6 +433,7 @@ def emit(self, record: LogRecord) -> None: self.doRollover() super().emit(record) + class NullHandler(Handler): """Provide an empty log handler. From bbef817f2ff82243949378479b29505ad2ee8cc5 Mon Sep 17 00:00:00 2001 From: aggieNick02 Date: Thu, 26 Sep 2024 12:50:41 -0500 Subject: [PATCH 10/13] one more attempt at fixing formatting --- adafruit_logging.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_logging.py b/adafruit_logging.py index d70c306..28d1021 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -200,9 +200,9 @@ def format(self, record: LogRecord) -> str: if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt: now = time.localtime() # pylint: disable=line-too-long - vals["asctime"] = ( - f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" - ) + vals[ + "asctime" + ] = f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" if self.defaults: for key, val in self.defaults.items(): From 618da53a108507ff95d201719ccc0d3c03685e23 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 11/13] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index f52e773..8afefaa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 3440b399e5999fd76a1bd09e13a5c1e9bef53eb1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 12/13] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From 2e410bada543e2b444d2ea925a564138ca5a16c8 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 16 May 2025 16:34:03 +0000 Subject: [PATCH 13/13] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 -------------------------- README.rst | 6 +- adafruit_logging.py | 62 ++-- docs/api.rst | 3 + docs/conf.py | 8 +- examples/logging_filehandler.py | 5 +- examples/logging_formatter_example.py | 4 +- examples/logging_mqtt_handler.py | 1 - examples/logging_simpletest.py | 3 - ruff.toml | 108 +++++++ 12 files changed, 159 insertions(+), 494 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/README.rst b/README.rst index cc26428..eecf292 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_Logger :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff Logging module for CircuitPython diff --git a/adafruit_logging.py b/adafruit_logging.py index 28d1021..5aba5f4 100644 --- a/adafruit_logging.py +++ b/adafruit_logging.py @@ -55,16 +55,14 @@ """ -# pylint: disable=invalid-name,undefined-variable - -import time -import sys import os +import sys +import time from collections import namedtuple try: - # pylint: disable=deprecated-class - from typing import Optional, Hashable, Dict + from typing import Dict, Hashable, Optional + from typing_extensions import Protocol class WriteableStream(Protocol): @@ -82,7 +80,6 @@ def write(self, buf: str) -> int: __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git" -# pylint:disable=undefined-all-variable __all__ = [ "LEVELS", "NOTSET", @@ -129,9 +126,7 @@ def _level_for(value: int) -> str: return LEVELS[0][1] -LogRecord = namedtuple( - "_LogRecord", ("name", "levelno", "levelname", "msg", "created", "args") -) +LogRecord = namedtuple("_LogRecord", ("name", "levelno", "levelname", "msg", "created", "args")) """An object used to hold the contents of a log record. The following attributes can be retrieved from it: @@ -163,7 +158,7 @@ class Formatter: style is '{' """ - def __init__( # pylint: disable=too-many-arguments + def __init__( self, fmt: Optional[str] = None, datefmt: Optional[str] = None, @@ -174,10 +169,8 @@ def __init__( # pylint: disable=too-many-arguments self.fmt = fmt self.datefmt = datefmt self.style = style - if self.style not in ("{", "%"): - raise ValueError( - "Only '%' and '{' formatting style are supported at this time." - ) + if self.style not in {"{", "%"}: + raise ValueError("Only '%' and '{' formatting style are supported at this time.") self.validate = validate self.defaults = defaults @@ -199,20 +192,17 @@ def format(self, record: LogRecord) -> str: } if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt: now = time.localtime() - # pylint: disable=line-too-long - vals[ - "asctime" - ] = f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" + vals["asctime"] = ( + f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" # noqa: E501 + ) if self.defaults: for key, val in self.defaults.items(): if key not in vals: vals[key] = val - if self.style not in ("{", "%"): - raise ValueError( - "Only '%' and '{' formatting style are supported at this time." - ) + if self.style not in {"{", "%"}: + raise ValueError("Only '%' and '{' formatting style are supported at this time.") if self.style == "%": return self.fmt % vals @@ -234,7 +224,6 @@ def setLevel(self, level: int) -> None: """ self.level = level - # pylint: disable=no-self-use def format(self, record: LogRecord) -> str: """Generate a timestamped message. @@ -263,7 +252,6 @@ def setFormatter(self, formatter: Formatter) -> None: self.formatter = formatter -# pylint: disable=too-few-public-methods class StreamHandler(Handler): """Send logging messages to a stream, `sys.stderr` (typically the serial console) by default. @@ -316,7 +304,6 @@ class FileHandler(StreamHandler): terminator = "\r\n" def __init__(self, filename: str, mode: str = "a") -> None: - # pylint: disable=consider-using-with if mode == "r": raise ValueError("Can't write to a read only file") super().__init__(open(filename, mode=mode)) @@ -404,7 +391,6 @@ def doRollover(self) -> None: os.rename(self._LogFileName, CurrentFileName) # Reopen the file. - # pylint: disable=consider-using-with self.stream = open(self._LogFileName, mode=self._WriteMode) def GetLogSize(self) -> int: @@ -522,9 +508,7 @@ def hasHandlers(self) -> bool: return len(self._handlers) > 0 def _log(self, level: int, msg: str, *args) -> None: - record = _logRecordFactory( - self.name, level, (msg % args) if args else msg, args - ) + record = _logRecordFactory(self.name, level, (msg % args) if args else msg, args) self.handle(record) def handle(self, record: LogRecord) -> None: @@ -532,14 +516,8 @@ def handle(self, record: LogRecord) -> None: :param LogRecord record: log record """ - if ( - _default_handler is None - and not self.hasHandlers() - and not self.emittedNoHandlerWarning - ): - sys.stderr.write( - f"Logger '{self.name}' has no handlers and default handler is None\n" - ) + if _default_handler is None and not self.hasHandlers() and not self.emittedNoHandlerWarning: + sys.stderr.write(f"Logger '{self.name}' has no handlers and default handler is None\n") self.emittedNoHandlerWarning = True return @@ -550,11 +528,7 @@ def handle(self, record: LogRecord) -> None: handler.emit(record) emitted = True - if ( - not emitted - and _default_handler - and record.levelno >= _default_handler.level - ): + if not emitted and _default_handler and record.levelno >= _default_handler.level: _default_handler.emit(record) def log(self, level: int, msg: str, *args) -> None: @@ -622,14 +596,12 @@ def critical(self, msg: str, *args) -> None: """ self._log(CRITICAL, msg, *args) - # pylint: disable=no-value-for-parameter; value and tb are optional for traceback def exception(self, err: Exception) -> None: """Convenience method for logging an ERROR with exception information. :param Exception err: the exception to be logged """ try: - # pylint: disable=import-outside-toplevel; not available on all boards import traceback except ImportError: self._log( diff --git a/docs/api.rst b/docs/api.rst index aced610..fe3e4ee 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_logging :members: diff --git a/docs/conf.py b/docs/conf.py index 8afefaa..a7b784c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -48,9 +46,7 @@ creation_year = "2019" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Dave Astels" author = "Dave Astels" diff --git a/examples/logging_filehandler.py b/examples/logging_filehandler.py index 92f9d0d..fc56a7a 100644 --- a/examples/logging_filehandler.py +++ b/examples/logging_filehandler.py @@ -1,11 +1,12 @@ # SPDX-FileCopyrightText: 2021 Alec Delaney # SPDX-License-Identifier: MIT +import adafruit_sdcard import board import busio -from digitalio import DigitalInOut import storage -import adafruit_sdcard +from digitalio import DigitalInOut + import adafruit_logging as logging from adafruit_logging import FileHandler diff --git a/examples/logging_formatter_example.py b/examples/logging_formatter_example.py index ccd2eea..02dd640 100644 --- a/examples/logging_formatter_example.py +++ b/examples/logging_formatter_example.py @@ -34,9 +34,7 @@ logger.info("Custom formatter example") -bracket_timestamp_formatter = logging.Formatter( - fmt="{asctime} {levelname}: {message}", style="{" -) +bracket_timestamp_formatter = logging.Formatter(fmt="{asctime} {levelname}: {message}", style="{") print_handler.setFormatter(bracket_timestamp_formatter) logger.info("Timestamp formatter bracket style example") diff --git a/examples/logging_mqtt_handler.py b/examples/logging_mqtt_handler.py index 9db578e..6de8309 100755 --- a/examples/logging_mqtt_handler.py +++ b/examples/logging_mqtt_handler.py @@ -14,7 +14,6 @@ import adafruit_logging as logging # adafruit_logging defines log levels dynamically. -# pylint: disable=no-name-in-module from adafruit_logging import NOTSET, Handler, LogRecord diff --git a/examples/logging_simpletest.py b/examples/logging_simpletest.py index 3bb25e1..8bdda9b 100644 --- a/examples/logging_simpletest.py +++ b/examples/logging_simpletest.py @@ -1,9 +1,6 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint:disable=undefined-variable,wildcard-import,no-name-in-module -# pylint:disable=no-member,invalid-name - """Briefly exercise the logger and null logger.""" import adafruit_logging as logging diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..73e9efc --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "PLC2701", # private import +] + +[format] +line-ending = "lf"