From: Joerg Behrmann <behrmann@physik.fu-berlin.de>
Date: Thu, 7 Dec 2023 18:09:34 +0000 (+0100)
Subject: Move off of the deprecated importlib.resources API
X-Git-Tag: v20~102
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=99bb1e1c96ec8f9e4475a8f536afb759c19a9c9b;p=thirdparty%2Fmkosi.git

Move off of the deprecated importlib.resources API

Python 3.9 brought a new importlib.resources API and deprecated the old
one. This introduces a small shim to use the part of the APi that guarantees a
Path object, thus making our usage of this just pathlike.
---

diff --git a/mkosi/__init__.py b/mkosi/__init__.py
index 68a0c62ad..8c4ce9b3a 100644
--- a/mkosi/__init__.py
+++ b/mkosi/__init__.py
@@ -4,7 +4,6 @@ import contextlib
 import dataclasses
 import datetime
 import hashlib
-import importlib.resources
 import itertools
 import json
 import logging
@@ -21,6 +20,7 @@ from collections.abc import Iterator, Mapping, Sequence
 from pathlib import Path
 from typing import Optional, TextIO, Union
 
+import mkosi.resources
 from mkosi.architecture import Architecture
 from mkosi.archive import extract_tar, make_cpio, make_tar
 from mkosi.burn import run_burn
@@ -72,6 +72,7 @@ from mkosi.util import (
     one_zero,
     read_env_file,
     read_os_release,
+    resource_path,
     scopedenv,
     try_import,
     umask,
@@ -2276,10 +2277,10 @@ def make_extension_image(state: MkosiState, output: Path) -> None:
     }
 
     with (
-        importlib.resources.path("mkosi.resources.repart.definitions", f"{state.config.output_format}.repart.d") as d,
+        resource_path(mkosi.resources) as r,
         complete_step(f"Building {state.config.output_format} extension image")
     ):
-        run(cmdline + ["--definitions", d], env=env)
+        run(cmdline + ["--definitions", r / f"repart/definitions/{state.config.output_format}.repart.d"], env=env)
 
 
 def finalize_staging(state: MkosiState) -> None:
@@ -2691,26 +2692,27 @@ def show_docs(args: MkosiArgs) -> None:
     while formats:
         form = formats.pop(0)
         try:
-            if form == DocFormat.man:
-                with importlib.resources.path("mkosi.resources", "mkosi.1") as man:
+            with resource_path(mkosi.resources) as r:
+                if form == DocFormat.man:
+                    man = r / "mkosi.1"
                     if not man.exists():
                         raise FileNotFoundError()
                     run(["man", "--local-file", man])
                     return
-            elif form == DocFormat.pandoc:
-                if not shutil.which("pandoc"):
-                    logging.debug("pandoc is not available")
-                with importlib.resources.path("mkosi.resources", "mkosi.md") as mdr:
+                elif form == DocFormat.pandoc:
+                    if not shutil.which("pandoc"):
+                        logging.error("pandoc is not available")
+                    mdr = r / "mkosi.md"
                     pandoc = run(["pandoc", "-t", "man", "-s", mdr], stdout=subprocess.PIPE)
                     run(["man", "--local-file", "-"], input=pandoc.stdout)
                     return
-            elif form == DocFormat.markdown:
-                md = importlib.resources.read_text("mkosi.resources", "mkosi.md")
-                page(md, args.pager)
-                return
-            elif form == DocFormat.system:
-                run(["man", "mkosi"])
-                return
+                elif form == DocFormat.markdown:
+                    md = (r / "mkosi.md").read_text()
+                    page(md, args.pager)
+                    return
+                elif form == DocFormat.system:
+                    run(["man", "mkosi"])
+                    return
         except (FileNotFoundError, subprocess.CalledProcessError) as e:
             if not formats:
                 if isinstance(e, FileNotFoundError):
diff --git a/mkosi/util.py b/mkosi/util.py
index d3c2f178d..e478e1b95 100644
--- a/mkosi/util.py
+++ b/mkosi/util.py
@@ -7,6 +7,7 @@ import enum
 import fcntl
 import functools
 import importlib
+import importlib.resources
 import itertools
 import logging
 import os
@@ -17,6 +18,7 @@ import stat
 import tempfile
 from collections.abc import Iterable, Iterator, Mapping, Sequence
 from pathlib import Path
+from types import ModuleType
 from typing import Any, Callable, TypeVar
 
 from mkosi.types import PathString
@@ -185,3 +187,10 @@ def umask(mask: int) -> Iterator[None]:
 
 def is_power_of_2(x: int) -> bool:
     return x > 0 and (x & x - 1 == 0)
+
+
+@contextlib.contextmanager
+def resource_path(mod: ModuleType) -> Iterator[Path]:
+    t = importlib.resources.files(mod)
+    with importlib.resources.as_file(t) as p:
+        yield p