Remove pkg resources (#105)

* use importlib instead of pkg_resource, fix dump_hierarchy when ERROR appear

* do little fix on github actions

Author: codeskyblue

.github/dependabot.yml

@@ -3,5 +3,5 @@ updates:
 - package-ecosystem: pip
   directory: "/"
   schedule:
-    interval: daily
+    interval: weekly
   open-pull-requests-limit: 10

.github/workflows/publish-to-pypi.yml

@@ -1,5 +1,8 @@
 name: Publish Python 🐍 distributions 📦 to PyPI
-on: push
+on:
+  push:
+    tags:
+      - '*'
 jobs:
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI

adbutils/_device.py

@@ -786,7 +786,7 @@ def keyevent(self, key_code: typing.Union[int, str]) -> str:
     def __is_percent(self, v):
         return isinstance(v, float) and v <= 1.0
 
-    def click(self, x, y):
+    def click(self, x, y) -> None:
         """
         simulate android tap
 
@@ -799,9 +799,9 @@ def click(self, x, y):
             x = int(x * w) if is_percent(x) else x
             y = int(y * h) if is_percent(y) else y
         x, y = map(str, [x, y])
-        return self.shell(['input', 'tap', x, y])
+        self.shell(['input', 'tap', x, y])
 
-    def swipe(self, sx, sy, ex, ey, duration: float = 1.0):
+    def swipe(self, sx, sy, ex, ey, duration: float = 1.0) -> None:
         """
         swipe from start point to end point
 
@@ -817,7 +817,7 @@ def swipe(self, sx, sy, ex, ey, duration: float = 1.0):
             ex = int(ex * w) if is_percent(ex) else ex
             ey = int(ey * h) if is_percent(ey) else ey
         x1, y1, x2, y2 = map(str, [sx, sy, ex, ey])
-        return self.shell(
+        self.shell(
             ['input', 'swipe', x1, y1, x2, y2,
              str(int(duration * 1000))])
 
@@ -1225,15 +1225,19 @@ def dump_hierarchy(self) -> str:
         Raises:
             AdbError
         """
+        target = '/data/local/tmp/uidump.xml'
         output = self.shell(
-            'uiautomator dump /data/local/tmp/uidump.xml && echo success')
-        if "success" not in output:
+            f'rm -f {target}; uiautomator dump {target} && echo success')
+        if 'ERROR' in output or 'success' not in output:
             raise AdbError("uiautomator dump failed", output)
 
         buf = b''
-        for chunk in self.sync.iter_content("/data/local/tmp/uidump.xml"):
+        for chunk in self.sync.iter_content(target):
             buf += chunk
-        return buf.decode("utf-8")
+        xml_data = buf.decode("utf-8")
+        if not xml_data.startswith('<?xml'):
+            raise AdbError("dump output is not xml", xml_data)
+        return xml_data
 
     @retry(AdbError, delay=.5, tries=3, jitter=.1)
     def app_current(self) -> RunningAppInfo:

adbutils/_utils.py

@@ -1,4 +1,5 @@
 import hashlib
+import importlib.resources
 import os
 import random
 import shlex
@@ -16,7 +17,7 @@
 import whichcraft
 from apkutils2.axml.axmlparser import AXML
 from apkutils2.manifest import Manifest
-from pkg_resources import resource_filename
+
 
 MB = 1024 * 1024
 
@@ -74,6 +75,18 @@ def current_ip():
     finally:
         s.close()
 
+def _get_bin_dir():
+    if sys.version_info < (3, 9):
+        context = importlib.resources.path("adbutils.binaries", "__init__.py")
+    else:
+        ref = importlib.resources.files("adbutils.binaries") / "__init__.py"
+        context = importlib.resources.as_file(ref)
+    with context as path:
+        pass
+    # Return the dir. We assume that the data files are on a normal dir on the fs.
+    return str(path.parent)
+
+
 def adb_path():
     # 0. check env: ADBUTILS_ADB_PATH
     if os.getenv("ADBUTILS_ADB_PATH"):
@@ -85,7 +98,7 @@ def adb_path():
         return exe
 
     # 2. use buildin adb
-    bin_dir = resource_filename("adbutils", "binaries")
+    bin_dir = _get_bin_dir()
     exe = os.path.join(bin_dir, "adb.exe" if os.name == 'nt' else 'adb')
     if os.path.isfile(exe) and _is_valid_exe(exe):
         return exe

adbutils/_version.py

@@ -4,10 +4,10 @@
 """Created on Fri May 06 2022 10:54:04 by codeskyblue
 """
 
-import pkg_resources
 
+from importlib.metadata import version, PackageNotFoundError
 
 try:
-    __version__ = pkg_resources.get_distribution("adbutils").version
-except pkg_resources.DistributionNotFound:
+    __version__ = version("adbutils")
+except PackageNotFoundError:
     __version__ = "unknown"

adbutils/binaries/__init__.py

@@ -0,0 +1 @@
+# Just here to make importlib.resources work

setup.py

@@ -16,4 +16,4 @@
 if sys.argv[-1] == "build_wheel":
     subprocess.call([sys.executable, "build_wheel.py"])
 else:
-    setuptools.setup(setup_requires=['pbr'], python_requires='>=3.7', pbr=True)
+    setuptools.setup(setup_requires=['pbr'], python_requires='>=3.8', pbr=True)

tests/test_utils.py

@@ -4,9 +4,10 @@
 """Created on Fri Dec 02 2022 17:00:03 by codeskyblue
 """
 
+import os
 import pytest
 from adbutils import StopEvent
-from adbutils._utils import get_free_port
+from adbutils._utils import get_free_port, _get_bin_dir
 
 
 def test_stop_event():
@@ -28,4 +29,10 @@ def test_stop_event():
 
 def test_get_free_port():
     port = get_free_port()
-    assert port > 0
+    assert port > 0
+
+
+def test_get_bin_dir():
+    _dir = _get_bin_dir()
+    assert isinstance(_dir, str)
+    assert "README.md" in os.listdir(_dir)