Reuse logging for scripts

.readthedocs.yml

@@ -19,5 +19,5 @@ mkdocs:
 formats: all
 
 python:
-   install:
-   - requirements: requirements.mkdocs.txt
+  install:
+    - requirements: requirements.mkdocs.txt

mypy_boto3_builder/logger.py

@@ -9,7 +9,7 @@
 __all__ = ("get_logger",)
 
 
-def get_logger(level: int | None = None) -> logging.Logger:
+def get_logger(level: int | None = None, name: str = LOGGER_NAME) -> logging.Logger:
     """
     Get Logger instance.
 
@@ -19,7 +19,7 @@ def get_logger(level: int | None = None) -> logging.Logger:
     Returns:
         Overriden Logger.
     """
-    logger = logging.getLogger(LOGGER_NAME)
+    logger = logging.getLogger(name)
     if not logger.handlers:
         stream_handler = logging.StreamHandler()
         formatter = logging.Formatter(

scripts/pull_static.py

@@ -9,31 +9,11 @@
 from pathlib import Path
 
 from mypy_boto3_builder.constants import StaticStubsPath, StaticStubsPullURL
+from mypy_boto3_builder.logger import get_logger
 from mypy_boto3_builder.utils.github import download_and_extract
 from mypy_boto3_builder.utils.path import print_path
 
-
-def setup_logging(level: int) -> logging.Logger:
-    """
-    Get Logger instance.
-
-    Arguments:
-        level -- Log level
-
-    Returns:
-        Overriden Logger.
-    """
-    logger = logging.getLogger(Path(__file__).stem)
-    stream_handler = logging.StreamHandler()
-    formatter = logging.Formatter("%(asctime)s %(levelname)-7s %(message)s", datefmt="%H:%M:%S")
-    stream_handler.setFormatter(formatter)
-    stream_handler.setLevel(level)
-    logger.addHandler(stream_handler)
-    logger.setLevel(level)
-    return logger
-
-
-logger = setup_logging(logging.DEBUG)
+logger = get_logger(logging.DEBUG, Path(__file__).stem)
 
 
 def pull_static(url: str, output_path: Path, temp_path: Path) -> None:

scripts/release.py

@@ -17,6 +17,7 @@
 from typing import Sequence, Tuple
 from unittest.mock import patch
 
+from mypy_boto3_builder.logger import get_logger
 from requests.exceptions import ConnectionError as RequestsConnectionError
 from requests.exceptions import HTTPError
 from twine.commands.upload import upload
@@ -36,25 +37,9 @@
 ]
 LOGGER_NAME = "release"
 
-
-def setup_logging(level: int) -> logging.Logger:
-    """
-    Get Logger instance.
-
-    Returns:
-        Overriden Logger.
-    """
-    logging.getLogger("twine").disabled = True
-    logging.getLogger("twine.commands.upload").disabled = True
-
-    logger = logging.getLogger(LOGGER_NAME)
-    stream_handler = logging.StreamHandler()
-    formatter = logging.Formatter("%(asctime)s %(levelname)-7s %(message)s", datefmt="%H:%M:%S")
-    stream_handler.setFormatter(formatter)
-    stream_handler.setLevel(level)
-    logger.addHandler(stream_handler)
-    logger.setLevel(level)
-    return logger
+logging.getLogger("twine").disabled = True
+logging.getLogger("twine.commands.upload").disabled = True
+logger = get_logger(logging.DEBUG, LOGGER_NAME)
 
 
 @dataclass
@@ -112,7 +97,6 @@ def check_call(cmd: Sequence[str], print_error: bool = True) -> str:
         return subprocess.check_output(cmd, stderr=subprocess.STDOUT, encoding="utf-8")
     except subprocess.CalledProcessError as e:
         if print_error:
-            logger = logging.getLogger(LOGGER_NAME)
             for line in e.output.splitlines():
                 logger.warning(line)
         raise
@@ -153,7 +137,6 @@ def build(path: Path, max_retries: int = 10) -> Path:
     """
     Build package.
     """
-    logger = logging.getLogger(LOGGER_NAME)
     attempt = 1
     last_error = Exception("Unknown error")
     while attempt <= max_retries:
@@ -185,7 +168,6 @@ def publish(path: Path, max_retries: int = 10) -> Path:
     attempt = 1
     dist_path = path / "dist"
     packages = [i.as_posix() for i in dist_path.glob("*")]
-    logger = logging.getLogger(LOGGER_NAME)
     last_error = Exception("Unknown error")
     while attempt <= max_retries:
         try:
@@ -264,8 +246,6 @@ def main() -> None:
     Run main logic.
     """
     args = parse_args()
-    setup_logging(logging.DEBUG)
-    logger = logging.getLogger(LOGGER_NAME)
     paths = [i for i in args.path.absolute().iterdir() if i.is_dir()]
     paths.sort(key=lambda x: x.name)
     if args.filter: