NextcloudApp: setup_nextcloud_logging function for transparent logging

[bigcat88]

Usage:

import logging
from pathlib import Path
from os import environ

import nc_py_api


environ["APP_ID"] = "nc_py_api"
environ["APP_VERSION"] = "1.0.0"
environ["APP_SECRET"] = "12345"
environ["NEXTCLOUD_URL"] = "http://nextcloud.local"


if __name__ == "__main__":
    nc_app = nc_py_api.NextcloudApp()
    logging.basicConfig(
        level=logging.INFO,
        format="%(asctime)s: [%(funcName)s]:%(levelname)s: %(message)s",
        datefmt="%H:%M:%S",
    )
    logging.getLogger("httpx").setLevel(logging.ERROR)  # not needed, but better to hide spam to console
    nc_py_api.ex_app.setup_nextcloud_logging() # setup logging handler in one line of code
    logging.fatal("Fatal test")
    logging.error("Error test")
    logging.warning("Warning test")
    logging.info("Info test")
    logging.debug("Debug test")
    logging.fatal("Fatal test2")
    try:
        a = 0
        b = z
    except Exception as e:
        logging.exception("Exception test")

setup_nextcloud_logging

def setup_nextcloud_logging(logger_name: str | None = None, logging_level: int = logging.DEBUG):
     """Function to easily send all or selected log entries to Nextcloud."""
     logger = logging.getLogger(logger_name)
     nextcloud_handler = _NextcloudStorageHandler()
     nextcloud_handler.setLevel(logging_level)
     logger.addHandler(nextcloud_handler)
     return nextcloud_handler

[codecov]

Codecov Report

Attention: Patch coverage is 94.87179% with 2 lines in your changes missing coverage. Please review.

Project coverage is 94.81%. Comparing base (1471e90) to head (7cb959b).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
nc_py_api/ex_app/logging.py	92.30%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #294      +/-   ##
==========================================
- Coverage   94.82%   94.81%   -0.01%     
==========================================
  Files          45       46       +1     
  Lines        5312     5341      +29     
==========================================
+ Hits         5037     5064      +27     
- Misses        275      277       +2     

Files with missing lines	Coverage Δ
nc_py_api/ex_app/__init__.py	100.00% <100.00%> (ø)
nc_py_api/nextcloud.py	96.34% <100.00%> (+0.02%)	⬆️
nc_py_api/ex_app/logging.py	92.30% <92.30%> (ø)