use importlib_resources instead of __file__ (#1107)

* use importlib_resources instead of __file__

Author: codeskyblue

pyproject.toml

@@ -15,6 +15,7 @@ lxml = "*"
 adbutils = "^2.9.1"
 Pillow = "*"
 retry2 = "^0.9.5"
+importlib-resources = {version = "*", markers = "python_version < \"3.9\""}
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.1.1"

tests/test_utils.py

@@ -88,4 +88,16 @@ def foo():
         pass
 
     with pytest.warns(DeprecationWarning):
-        foo()
+        foo()
+
+
+def test_with_package_resource():
+    with utils.with_package_resource("assets/sync.sh") as asset_path:
+        assert asset_path.exists()
+        assert asset_path.is_file()
+        assert asset_path.name == "sync.sh"
+    
+    # Test that the context manager works properly
+    with pytest.raises(FileNotFoundError):
+        with utils.with_package_resource("nonexistent_file.xyz") as _:
+            pass

uiautomator2/_input.py

@@ -18,7 +18,7 @@
 
 from uiautomator2.abstract import AbstractShell
 from uiautomator2.exceptions import AdbBroadcastError, DeviceError, InputIMEError
-from uiautomator2.utils import deprecated
+from uiautomator2.utils import deprecated, with_package_resource
 
 
 logger = logging.getLogger(__name__)
@@ -69,13 +69,12 @@ def is_input_ime_installed(self) -> bool:
 
     def _setup_ime(self):
         logger.debug("installing AdbKeyboard ime")
-        assets_dir = Path(__file__).parent / "assets"
-        ime_apk_path = assets_dir / 'app-uiautomator.apk'
-        try:
-            self.adb_device.install(str(ime_apk_path), nolaunch=True, uninstall=True)
-        except adbutils.AdbError as e:
-            self.adb_device.uninstall(self.__ime_id.split('/')[0])
-            self.adb_device.install(str(ime_apk_path), nolaunch=True, uninstall=True)
+        with with_package_resource("assets/app-uiautomator.apk") as ime_apk_path:
+            try:
+                self.adb_device.install(str(ime_apk_path), nolaunch=True, uninstall=True)
+            except adbutils.AdbError as e:
+                self.adb_device.uninstall(self.__ime_id.split('/')[0])
+                self.adb_device.install(str(ime_apk_path), nolaunch=True, uninstall=True)
 
         # wait for ime registered
         for _ in range(10):

uiautomator2/core.py

@@ -23,7 +23,7 @@
 from uiautomator2.exceptions import AccessibilityServiceAlreadyRegisteredError, APKSignatureError, HTTPError, \
     HTTPTimeoutError, LaunchUiAutomationError, RPCInvalidError, RPCStackOverflowError, RPCUnknownError, \
     UiAutomationNotConnectedError, UiObjectNotFoundError
-from uiautomator2.utils import is_version_compatiable
+from uiautomator2.utils import with_package_resource
 from uiautomator2.version import __apk_version__
 
 logger = logging.getLogger(__name__)
@@ -236,14 +236,13 @@ def start_uiautomator(self):
                 self._wait_ready()
 
     def _setup_jar(self):
-        assets_dir = Path(__file__).parent / "assets"
-        jar_path = assets_dir / "u2.jar"
-        target_path = "/data/local/tmp/u2.jar"
-        if self._check_device_file_hash(jar_path, target_path):
-            logger.debug("file u2.jar already pushed")
-        else:
-            logger.debug("push %s -> %s", jar_path, target_path)
-            self._dev.sync.push(jar_path, target_path, check=True)
+        with with_package_resource("assets/u2.jar") as jar_path:
+            target_path = "/data/local/tmp/u2.jar"
+            if self._check_device_file_hash(jar_path, target_path):
+                logger.debug("file u2.jar already pushed")
+            else:
+                logger.debug("push %s -> %s", jar_path, target_path)
+                self._dev.sync.push(jar_path, target_path, check=True)
 
     def _check_device_file_hash(self, local_file: Union[str, Path], remote_file: str) -> bool:
         """ check if remote file hash is correct """

uiautomator2/utils.py

@@ -1,19 +1,45 @@
 # coding: utf-8
 #
 
+import contextlib
 import functools
 import inspect
+import pathlib
 import shlex
 import threading
 import typing
-from typing import Union
 import warnings
+from typing import Union
+
 from PIL import Image
 
 from uiautomator2._proto import Direction
 from uiautomator2.exceptions import SessionBrokenError, UiObjectNotFoundError
 
 
+@contextlib.contextmanager
+def with_package_resource(filename: str) -> typing.Generator[pathlib.Path, None, None]:
+    """
+    Context manager to access a package asset file using importlib.resources.
+    
+    Args:
+        filename (str): The name of the file to locate.
+    
+    Yields:
+        str: The full path to the located file.
+    """
+    try:
+        from importlib.resources import as_file, files
+    except ImportError:
+        # For Python < 3.9
+        from importlib_resources import as_file, files
+    anchor = files("uiautomator2") / filename
+    with as_file(anchor) as f:
+        if not f.exists():
+            raise FileNotFoundError(f"Resource {filename} not found in uiautomator2 package.")
+        yield f
+    
+
 def check_alive(fn):
     @functools.wraps(fn)
     def inner(self, *args, **kwargs):