Swapped over to edq's logging.

Author: eriq-augustine

.gitignore

@@ -21,6 +21,7 @@ out*/
 /dist/
 *.egg-info
 /html/
+/.mypy_*/
 
 # Project-Specific
 *.gif

pacai/capture/board.py

@@ -487,7 +487,7 @@ def main() -> int:
                     + f" If not specified, a random number between {MIN_SIZE} and {MAX_RANDOM_SIZE} will be chosen."))
 
     args = parser.parse_args()
-    args = pacai.core.log.init_from_args(args)
+    args = pacai.core.log.init_from_args(parser, args)
 
     board = generate(args.seed, args.size)
     print(board)

pacai/core/log.py

@@ -1,96 +1,30 @@
 import argparse
-import logging
 import typing
 
-DEFAULT_LOGGING_LEVEL: str = logging.getLevelName(logging.INFO)
-DEFAULT_LOGGING_FORMAT: str = '%(asctime)s [%(levelname)-8s] - %(filename)s:%(lineno)s -- %(message)s'
+import edq.core.log
 
-LEVELS: list[str] = [
-    'TRACE',
-    logging.getLevelName(logging.DEBUG),
-    logging.getLevelName(logging.INFO),
-    logging.getLevelName(logging.WARNING),
-    logging.getLevelName(logging.ERROR),
-    logging.getLevelName(logging.CRITICAL),
+WARN_LOGGERS: typing.List[str] = [
+    "PIL",
 ]
-
-def init(level: str = DEFAULT_LOGGING_LEVEL, log_format: str = DEFAULT_LOGGING_FORMAT, **kwargs: typing.Any) -> None:
-    """
-    Initialize or re-initialize the logging infrastructure.
-    """
-
-    # Add trace.
-    _add_logging_level('TRACE', logging.DEBUG - 5)
-
-    logging.basicConfig(level = level, format = log_format, force = True)
-
-    # Ignore logging from third-party libraries.
-    logging.getLogger("PIL").setLevel(logging.WARNING)
+""" Loggers (usually third-party) to move up to warning on init. """
 
 def set_cli_args(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     """
     Set common CLI arguments.
     This is a sibling to init_from_args(), as the arguments set here can be interpreted there.
     """
 
-    parser.add_argument('--log-level', dest = 'log_level',
-            action = 'store', type = str, default = logging.getLevelName(logging.INFO),
-            choices = LEVELS,
-            help = 'Set the logging level (default: %(default)s).')
-
-    parser.add_argument('--quiet', dest = 'quiet',
-            action = 'store_true', default = False,
-            help = 'Set the logging level to warning (overrides --log-level) (default: %(default)s).')
-
-    parser.add_argument('--debug', dest = 'debug',
-            action = 'store_true', default = False,
-            help = 'Set the logging level to debug (overrides --log-level and --quiet) (default: %(default)s).')
-
+    edq.core.log.set_cli_args(parser, {})
     return parser
 
-def init_from_args(args: argparse.Namespace) -> argparse.Namespace:
+def init_from_args(parser: argparse.ArgumentParser, args: argparse.Namespace) -> argparse.Namespace:
     """
     Take in args from a parser that was passed to set_cli_args(),
     and call init() with the appropriate arguments.
     """
 
-    level = args.log_level
-
-    if (args.quiet):
-        level = logging.getLevelName(logging.WARNING)
-
-    if (args.debug):
-        level = logging.getLevelName(logging.DEBUG)
-
-    init(level)
-
+    edq.core.log.init_from_args(parser, args, {})
     return args
 
-def _add_logging_level(level_name: str, level_number: int, method_name: str | None = None) -> None:
-    """
-    Add a new logging level.
-
-    See https://stackoverflow.com/questions/2183233/how-to-add-a-custom-loglevel-to-pythons-logging-facility/35804945#35804945 .
-    """
-
-    if (method_name is None):
-        method_name = level_name.lower()
-
-    # Level has already been defined.
-    if hasattr(logging, level_name):
-        return
-
-    def log_for_level(self: typing.Any, message: str, *args: typing.Any, **kwargs: typing.Any) -> None:
-        if self.isEnabledFor(level_number):
-            self._log(level_number, message, args, **kwargs)
-
-    def log_to_root(message: str, *args: typing.Any, **kwargs: typing.Any) -> None:
-        logging.log(level_number, message, *args, **kwargs)
-
-    logging.addLevelName(level_number, level_name)
-    setattr(logging, level_name, level_number)
-    setattr(logging.getLoggerClass(), method_name, log_for_level)
-    setattr(logging, method_name, log_to_root)
-
 # Load the default logging when this module is loaded.
-init()
+edq.core.log.init(warn_loggers = WARN_LOGGERS)

pacai/eightpuzzle/bin.py

@@ -78,7 +78,7 @@ def _parse_args(parser: argparse.ArgumentParser) -> argparse.Namespace:
     args = parser.parse_args()
 
     # Parse logging arguments.
-    args = pacai.core.log.init_from_args(args)
+    args = pacai.core.log.init_from_args(parser, args)
 
     # Parse specific options.
     args = init_from_args(args)

pacai/ui/web.py

@@ -236,7 +236,7 @@ def _get_post_data(self) -> dict[str, typing.Any]:
         except Exception as ex:
             raise ValueError("Payload is not valid json.") from ex
 
-        return request
+        return request  # type: ignore[no-any-return]
 
 class WebUI(pacai.core.ui.UI):
     """

pacai/util/bin.py

@@ -192,7 +192,7 @@ def parse_args(
     args = parser.parse_args(args = argv)
 
     # Parse logging arguments.
-    args = pacai.core.log.init_from_args(args)
+    args = pacai.core.log.init_from_args(parser, args)
 
     # Parse custom options.
     base_agent_infos, remove_agent_indexes, board_options = custom_init_from_args(args)

requirements.txt

@@ -1,3 +1,3 @@
 Pillow>=8.3.2
-edq-utils>=0.0.3
+edq-utils>=0.0.4
 json5>=0.9.14

scripts/check_strict_types.sh

@@ -16,7 +16,7 @@ function main() {
 
     cd "${ROOT_DIR}"
 
-    mypy pacai --strict
+    mypy pacai --strict --cache-dir "${ROOT_DIR}/.mypy_strict_cache"
     return $?
 }