core, py3: integrate logging library

Author: lasers

docs/dev-guide/the-py3-helper.md

@@ -309,7 +309,9 @@ checking.
 ### log(message, level='info')
 
 Log the message.
-The level must be one of LOG_ERROR, LOG_INFO or LOG_WARNING
+The level can be any valid logging level name (e.g. "error", info",
+"warning") or integer (e.g. `10` -> `logging.INFO``). Constants
+LOG_ERROR, LOG_WARNING, and LOG_INFO are also supported.
 
 ### notify_user(msg, level='info', rate_limit=5, title=None, icon=None)
 

docs/dev-guide/writing-modules.md

@@ -817,42 +817,12 @@ Loadavg 1.41 1.61 1.82
 Modules are encouraged to use Python's standard
 [`logging`](https://docs.python.org/3/library/logging.config.html?highlight=logging#logging-config-dictschema)
 module for debugging. By default, logs will be written to
-[`syslog`](https://docs.python.org/3/library/logging.config.html?highlight=logging#logging-config-dictschema)
-with a minimum level of `INFO`.
+syslog with a minimum level of `INFO`.
 
-Several existing modules will write to logs, with varying levels of details.
+Several existing modules can write to logs, with varying levels of details.
 Therefore, when debugging a specific module, it may be useful to show only the
-one you're interested in. This can be done by using the `--log-config` flag to
-pass a JSON file that configures logging. This file must be in the format
-specified in
-[`logging`'s configuration schema](https://docs.python.org/3/library/logging.config.html?highlight=logging#logging-config-dictschema).
-For example, to show only logs from your module in a `DEBUG` level, while
-keeping all others at `WARNING`, you can use:
-
-```json
-{
-    "version": 1,
-    "handlers": {
-        "file": {
-            "class": "logging.handlers.RotatingFileHandler",
-            "filename": "/tmp/py3status_log.log",
-            "maxBytes": 2048,
-            "formatter": "default"
-        }
-    },
-    "formatters": {
-        "default": {
-            "validate": true,
-            "format":"%(asctime)s %(levelname)s %(module)s %(message)s",
-            "datefmt":"%Y-%m-%d %H:%M:%S"
-        }
-    },
-    "loggers": {
-        "root": {"handlers": ["file"], "level": "WARNING"},
-        "<my_module>": {"level": "DEBUG"}
-    }
-}
-```
+one you're interested in. Add a `logging` dict under the `py3status` section of
+your config following `logging`'s configuration schema.
 
 ## Publishing custom modules on PyPI
 

py3status/argparsers.py

@@ -82,6 +82,12 @@ def _format_action_invocation(self, action):
         metavar="FILE",
         type=Path,
     )
+    parser.add_argument(
+        "-d",
+        "--debug",
+        action="store_true",
+        help="enable debug logging in syslog or log file if --log-file option is passed",
+    )
     parser.add_argument(
         "-i",
         "--include",
@@ -91,6 +97,15 @@ def _format_action_invocation(self, action):
         metavar="PATH",
         type=Path,
     )
+    parser.add_argument(
+        "-l",
+        "--log-file",
+        action="store",
+        dest="log_file",
+        help="enable logging to FILE (this option is not set by default)",
+        metavar="FILE",
+        type=Path,
+    )
     parser.add_argument(
         "-s",
         "--standalone",
@@ -142,33 +157,6 @@ def _format_action_invocation(self, action):
         help="specify window manager i3 or sway",
     )
 
-    logging_args = parser.add_argument_group()
-    logging_args.add_argument(
-        "-d",
-        "--debug",
-        action="store_true",
-        help="enable debug logging in syslog or log file if --log-file option is passed",
-    )
-    logging_args.add_argument(
-        "-l",
-        "--log-file",
-        action="store",
-        dest="log_file",
-        help="enable logging to FILE (this option is not set by default)",
-        metavar="FILE",
-        type=Path,
-    )
-    logging_args.add_argument(
-        "--log-config",
-        action="store",
-        dest="log_config",
-        help="path to a file that fully configures the 'logging' module. This "
-        "must contain a JSON dictionary in the format expected by "
-        "logging.config.dictConfig.",
-        metavar="FILE",
-        type=Path,
-    )
-
     # parse options, command, etc
     options = parser.parse_args()
 

py3status/command.py

@@ -134,7 +134,6 @@ class CommandRunner:
     """
 
     def __init__(self, py3_wrapper):
-        self.debug = py3_wrapper.config["debug"]
         self.py3_wrapper = py3_wrapper
 
     def find_modules(self, requested_names):
@@ -157,8 +156,7 @@ def find_modules(self, requested_names):
                     if requested_name == name.split(" ")[0]:
                         found_modules.add(module_name)
 
-        if self.debug:
-            self.py3_wrapper.log(f"found {found_modules}")
+        self.py3_wrapper.log(f"found {found_modules}", level="debug")
         return found_modules
 
     def refresh(self, data):
@@ -170,8 +168,7 @@ def refresh(self, data):
         update_i3status = False
         for module_name in self.find_modules(modules):
             module = self.py3_wrapper.output_modules[module_name]
-            if self.debug:
-                self.py3_wrapper.log(f"refresh {module}")
+            self.py3_wrapper.log(f"refresh {module}", level="debug")
             if module["type"] == "py3status":
                 module["module"].force_update()
             else:
@@ -197,8 +194,7 @@ def click(self, data):
             for name, message in CLICK_OPTIONS:
                 event[name] = data.get(name)
 
-            if self.debug:
-                self.py3_wrapper.log(event)
+            self.py3_wrapper.log(event, level="debug")
             # trigger the event
             self.py3_wrapper.events_thread.dispatch_event(event)
 
@@ -207,8 +203,7 @@ def run_command(self, data):
         check the given command and send to the correct dispatcher
         """
         command = data.get("command")
-        if self.debug:
-            self.py3_wrapper.log(f"Running remote command {command}")
+        self.py3_wrapper.log(f"Running remote command {command}", level="debug")
         if command == "refresh":
             self.refresh(data)
         elif command == "refresh_all":
@@ -226,7 +221,6 @@ class CommandServer(threading.Thread):
     def __init__(self, py3_wrapper):
         threading.Thread.__init__(self)
 
-        self.debug = py3_wrapper.config["debug"]
         self.py3_wrapper = py3_wrapper
 
         self.command_runner = CommandRunner(py3_wrapper)
@@ -244,8 +238,7 @@ def __init__(self, py3_wrapper):
         sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
         sock.bind(server_address.as_posix())
 
-        if self.debug:
-            self.py3_wrapper.log(f"Unix domain socket at {server_address}")
+        self.py3_wrapper.log(f"Unix domain socket at {server_address}", level="debug")
 
         # Listen for incoming connections
         sock.listen(1)
@@ -270,19 +263,16 @@ def run(self):
             try:
                 data = None
                 # Wait for a connection
-                if self.debug:
-                    self.py3_wrapper.log("waiting for a connection")
+                self.py3_wrapper.log("waiting for a connection", level="debug")
 
                 connection, client_address = self.sock.accept()
                 try:
-                    if self.debug:
-                        self.py3_wrapper.log("connection from")
+                    self.py3_wrapper.log("connection from", level="debug")
 
                     data = connection.recv(MAX_SIZE)
                     if data:
                         data = json.loads(data.decode("utf-8"))
-                        if self.debug:
-                            self.py3_wrapper.log(f"received {data}")
+                        self.py3_wrapper.log(f"received {data}", level="debug")
                         self.command_runner.run_command(data)
                 finally:
                     # Clean up the connection

py3status/constants.py

@@ -10,6 +10,29 @@
     "output_format": None,
 }
 
+LOGGING_CONFIG = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "syslog": {
+            "formatter": "default",
+            "class": "logging.handlers.SysLogHandler",
+            "address": "/dev/log",
+        },
+    },
+    "formatters": {
+        "default": {
+            "format": "%(asctime)s %(levelname)s %(message)s",
+            "datefmt": "%Y-%m-%d %H:%M:%S",
+        }
+    },
+    "root": {"handlers": ["syslog"], "level": "INFO"},
+}
+
+LOG_FILE_CONFIG = {
+    "__log_file": {"formatter": "default", "class": "logging.FileHandler", "filename": None}
+}
+
 MAX_NESTING_LEVELS = 4
 
 TIME_FORMAT = "%Y-%m-%d %H:%M:%S"