pmb.helpers.logging: wrap logging module (MR 2252)

We use a custom verbose log level in pmbootstrap, unfortunately it isn't
possible to correctly type this due to some limitations in the logging
library [1], [2].

Given that our usecase is fairly simple, we can just wrap the module
with our own so we only have to tell mypy to ignore the error once
instead of at every callsite.

[1]: https://github.com/cryptax/droidlysis/issues/15
[2]: https://github.com/python/typing/discussions/980

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>

pmb/__init__.py

@@ -13,7 +13,7 @@ from . import config
 from . import parse
 from .config import init as config_init
 from .helpers import frontend
-from .helpers import logging as pmb_logging
+from .helpers import logging
 from .helpers import mount
 from .helpers import other
 from .core import Chroot
@@ -98,7 +98,8 @@ def main() -> int:
     except Exception as e:
         # Dump log to stdout when args (and therefore logging) init failed
         if not args:
-            logging.getLogger().setLevel(logging.DEBUG)
+            import logging as pylogging
+            pylogging.getLogger().setLevel(logging.DEBUG)
 
         logging.info("ERROR: " + str(e))
         logging.info("See also: <https://postmarketos.org/troubleshooting>")

pmb/aportgen/__init__.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 import pmb.aportgen.busybox_static
 import pmb.aportgen.device
 import pmb.aportgen.gcc

pmb/aportgen/core.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import fnmatch
-import logging
+from pmb.helpers import logging
 import re
 from pmb.core.types import PmbArgs
 import pmb.helpers.git

pmb/aportgen/device.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pmb.core.types import PmbArgs
 import pmb.helpers.cli

pmb/build/_package.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import datetime
 import enum
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 
 import pmb.build

pmb/build/autodetect.py

@@ -1,8 +1,8 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
-import os
-from typing import Dict
+from pathlib import Path
+from pmb.helpers import logging
+from typing import Dict, Optional
 
 import pmb.config
 import pmb.chroot.apk

pmb/build/checksum.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 

pmb/build/envkernel.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Robert Yang
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import re

pmb/build/init.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 import pathlib
 

pmb/build/kconfig.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 from typing import Any, Dict
 

pmb/build/newapkbuild.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 import pmb.chroot.user
 from pmb.core.types import PmbArgs

pmb/build/other.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import shlex

pmb/chroot/apk.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import shlex
 from typing import List
 

pmb/chroot/apk_static.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 import shutil
 import tarfile
 import tempfile

pmb/chroot/binfmt.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 
 from pmb.core.types import PmbArgs
 import pmb.helpers.run

pmb/chroot/init.py

@@ -2,8 +2,8 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import enum
 import filecmp
-import glob
-import logging
+from typing import List
+from pmb.helpers import logging
 import os
 import filecmp
 

pmb/chroot/initfs.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 import pmb.chroot.initfs_hooks
 import pmb.chroot.other

pmb/chroot/initfs_hooks.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
 import glob
-import logging
+from pmb.helpers import logging
 
 import pmb.config
 import pmb.chroot.apk

pmb/chroot/mount.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 from typing import Dict

pmb/chroot/other.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 import pmb.chroot.apk
 from pmb.core.types import PmbArgs

pmb/chroot/shutdown.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import socket
 from contextlib import closing
 

pmb/chroot/zap.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import glob
-import logging
+from pmb.helpers import logging
 import os
 
 import pmb.chroot

pmb/ci/__init__.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import collections
 import glob
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import pmb.chroot

pmb/config/init.py

@@ -1,6 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.core.chroot import Chroot
+from pmb.helpers import logging
 import glob
 import json
 import os

pmb/config/load.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import configparser
 import os
 import sys

pmb/config/pmaports.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import configparser
-import logging
+from pmb.helpers import logging
 import os
 import sys
 

pmb/config/save.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 
 from pmb.core.types import PmbArgs
 

pmb/export/frontend.py

@@ -1,4 +1,4 @@
-import logging
+from pmb.helpers import logging
 import os
 
 from pmb.core.types import PmbArgs

pmb/export/odin.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 
 import pmb.build

pmb/export/symlinks.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 from typing import List
 

pmb/flasher/frontend.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 
 import pmb.config
 from pmb.core.types import PmbArgs

pmb/helpers/aportupgrade.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import datetime
 import fnmatch
-import logging
+from pmb.helpers import logging
 import os
 import re
 import urllib.parse

pmb/helpers/cli.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import datetime
-import logging
+from pmb.helpers import logging
 import os
 import re
 import readline

pmb/helpers/frontend.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import json
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import sys

pmb/helpers/git.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import configparser
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 

pmb/helpers/http.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import hashlib
 import json
-import logging
+from pmb.helpers import logging
 import os
 import shutil
 import urllib.request

pmb/helpers/lint.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Danct12 <danct12@disroot.org>
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 
 import pmb.chroot

pmb/helpers/logging.py

@@ -130,3 +130,38 @@ def init(args: PmbArgs):
 def disable():
     logger = logging.getLogger()
     logger.disabled = True
+
+
+# We have our own logging wrappers so we can make mypy happy
+# by not calling the (undefined) logging.verbose() function.
+
+def critical(msg: object, *args, **kwargs):
+    logging.critical(msg, *args, **kwargs)
+
+
+def fatal(msg: object, *args, **kwargs):
+    logging.fatal(msg, *args, **kwargs)
+
+
+def error(msg: object, *args, **kwargs):
+    logging.error(msg, *args, **kwargs)
+
+
+def warning(msg: object, *args, **kwargs):
+    logging.warning(msg, *args, **kwargs)
+
+
+def info(msg: object, *args, **kwargs):
+    logging.info(msg, *args, **kwargs)
+
+
+def debug(msg: object, *args, **kwargs):
+    logging.debug(msg, *args, **kwargs)
+
+
+def verbose(msg: object, *args, **kwargs):
+    logging.verbose(msg, *args, **kwargs) # type: ignore[attr-defined]
+
+
+def log(level: int, msg: object, *args, **kwargs):
+    logging.log(level, msg, *args, **kwargs)

pmb/helpers/other.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import re

pmb/helpers/package.py

@@ -9,7 +9,7 @@ See also:
     - pmb/helpers/repo.py (work with binary package repos)
 """
 import copy
-import logging
+from pmb.helpers import logging
 
 from pmb.core.types import PmbArgs
 import pmb.helpers.pmaports

pmb/helpers/pkgrel_bump.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 
 from pmb.core.types import PmbArgs
 import pmb.helpers.file

pmb/helpers/pmaports.py

@@ -7,7 +7,7 @@ See also:
 - pmb/helpers/package.py (work with both)
 """
 import glob
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 from typing import Optional, Sequence, Dict

pmb/helpers/repo.py

@@ -9,7 +9,7 @@ See also:
 """
 import os
 import hashlib
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 from typing import List
 

pmb/helpers/repo_bootstrap.py

@@ -1,6 +1,6 @@
 # Copyright 2024 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import glob
 
 import pmb.config.pmaports

pmb/helpers/repo_missing.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 
 import pmb.build
 from pmb.core.types import PmbArgs

pmb/helpers/run_core.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import fcntl
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import selectors

pmb/install/_install.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 import re
 import glob

pmb/install/blockdevice.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 import glob
 from pathlib import Path

pmb/install/format.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import pmb.chroot
 from pmb.core import Chroot
 from pmb.core.types import PmbArgs

pmb/install/losetup.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import glob
 import json
-import logging
+from pmb.helpers import logging
 import os
 import time
 

pmb/install/partition.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 import time
 import pmb.chroot

pmb/install/recovery.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Attila Szollosi
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 
 import pmb.chroot
 import pmb.config.pmaports

pmb/install/ui.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Dylan Van Assche
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 
 from pmb.core.types import PmbArgs
 import pmb.helpers.pmaports

pmb/netboot/__init__.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Mark Hargreaves, Luca Weiss
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 import socket
 import time

pmb/parse/_apkbuild.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 # mypy: disable-error-code="attr-defined"
-import logging
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import re

pmb/parse/apkindex.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import collections
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 import tarfile
 import pmb.chroot.apk

pmb/parse/binfmt_info.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import pmb.config
 
 # Get magic and mask from binfmt info file

pmb/parse/bootimg.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from pmb.helpers import logging
 from pathlib import Path
 from pmb.core.types import PmbArgs
 import pmb.helpers.run

pmb/parse/depends.py

@@ -1,6 +1,7 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from typing import Dict, List, Sequence, Set
+from pmb.helpers import logging
 import pmb.chroot
 import pmb.chroot.apk
 from pmb.core.types import PmbArgs

pmb/parse/deviceinfo.py

@@ -1,7 +1,8 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
 import copy
-import logging
+from typing import Dict
+from pmb.helpers import logging
 import os
 import pmb.config
 from pmb.core.types import PmbArgs

pmb/parse/kconfig.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Attila Szollosi
 # SPDX-License-Identifier: GPL-3.0-or-later
-import glob
-import logging
+from pathlib import Path
+from pmb.helpers import logging
 import re
 import os
 

pmb/qemu/run.py

@@ -1,6 +1,7 @@
 # Copyright 2023 Pablo Castellano, Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from typing import Sequence
+from pmb.helpers import logging
 import os
 from pathlib import Path
 import re

pmb/sideload/__init__.py

@@ -1,7 +1,8 @@
 # Copyright 2023 Martijn Braam
 # SPDX-License-Identifier: GPL-3.0-or-later
 import os
-import logging
+from typing import List
+from pmb.helpers import logging
 import shlex
 from argparse import Namespace
 

test/test_aportgen_device_wizard.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 from pmb.core.types import PmbArgs
 import pytest
 import sys

test/test_questions.py

@@ -1,6 +1,6 @@
 # Copyright 2023 Oliver Smith
 # SPDX-License-Identifier: GPL-3.0-or-later
-import logging
+from pmb.helpers import logging
 import os
 from pmb.core.types import PmbArgs
 import pytest