Major rework (#2)

- drop 3.9 support
- make `_ELFDeps` class internal
- support streaming IO, zipfile, and tarfile
- move settings to `ELFAnalyzeSettings`

Signed-off-by: Christian Heimes <christian@python.org>

Author: tiran

.github/workflows/ci.yaml

@@ -16,7 +16,6 @@ jobs:
     strategy:
       matrix:
         python:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"

.github/workflows/pypi.yaml

@@ -4,9 +4,17 @@
 name: Build, test, and upload PyPI package
 
 on:
-    - push
-    - pull_request
-    - release
+    push:
+        branches:
+            - main
+        tags:
+            - "v*"
+    pull_request:
+        branches:
+            - main
+    release:
+        types:
+            - published
 
 permissions:
     contents: read

README.md

@@ -66,3 +66,14 @@ Dependencies resolved.
 Nothing to do.
 Complete!
 ```
+
+## Public API
+
+* dataclass `elfdeps.ELFAnalyzeSettings`
+* exception `elfdeps.ELFError`
+* dataclass `elfdeps.ELFInfo`
+* dataclass `elfdeps.SOInfo`
+* `elfdeps.analyze_elffile(elffile, *, filename, is_exec, settings=None) -> ELFInfo`
+* `elfdeps.analyze_file(filename, *, settings=None) -> ELFInfo`
+* `elfdeps.analyze_tarmember(tfile, tarinfo, *, settings=None) -> ELFInfo`
+* `elfdeps.analyze_zipmember(zfile, zipinfo, *, settings=None) -> ELFInfo`

pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Utilities",
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
     "pyelftools",
 ]
@@ -54,8 +54,9 @@ line-length = 88
 
 [tool.ruff.lint]
 # Allow fix for all enabled rules (when `--fix`) is provided.
-fixable = ["ALL"]
+fixable = ["ALL", "UP006"]
 unfixable = []
+extend-safe-fixes = ["UP006", "UP007"]
 select = [
   "B",  # flake8-bugbear
   "E",  # pycodestyle
@@ -68,15 +69,12 @@ select = [
   "UP",  # pyupgrade
   "TID", # flake8-tidy-imports
 ]
-ignore = [
-    "UP006",  # not compatible with 3.9 type annotations
-]
 
 [tool.ruff.lint.isort]
 known-first-party = ["elfdeps"]
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
 

src/elfdeps/__init__.py

@@ -1,5 +1,26 @@
 # SPDX-License-Identifier: Apache-2.0
 
-__all__ = ("ELFDeps",)
+__all__ = (
+    "ELFAnalyzeSettings",
+    "ELFError",
+    "ELFInfo",
+    "SOInfo",
+    "analyze_elffile",
+    "analyze_file",
+    "analyze_tarmember",
+    "analyze_zipmember",
+)
 
-from ._elfdeps import ELFDeps
+from elftools.common.exceptions import ELFError
+
+from ._archives import (
+    analyze_tarmember,
+    analyze_zipmember,
+)
+from ._elfdeps import (
+    ELFAnalyzeSettings,
+    ELFInfo,
+    SOInfo,
+    analyze_elffile,
+    analyze_file,
+)

src/elfdeps/__main__.py

@@ -3,9 +3,14 @@
 import argparse
 import pathlib
 import pprint
+import tarfile
 import typing
+import zipfile
 
-from ._elfdeps import ELFDeps
+from . import _archives, _elfdeps
+
+ZIPEXT = frozenset({".zip", ".whl"})
+TAREXT = frozenset({".tar", ".tar.gz", ".tgz", ".tar.bz2", "tbz2", "tar.xz", "txz"})
 
 parser = argparse.ArgumentParser("elfdeps")
 parser.add_argument("filename", type=pathlib.Path)
@@ -56,24 +61,55 @@
 )
 
 
-def main(argv: typing.Optional[typing.List[str]] = None) -> None:
+def zip_requires(
+    filename: pathlib.Path, settings: _elfdeps.ELFAnalyzeSettings
+) -> typing.Iterable[_elfdeps.ELFInfo]:
+    with zipfile.ZipFile(filename) as zf:
+        for zipinfo in zf.infolist():
+            if zipinfo.filename.endswith(".so"):
+                yield _archives.analyze_zipmember(zf, zipinfo, settings=settings)
+
+
+def tar_requires(
+    filename: pathlib.Path, settings: _elfdeps.ELFAnalyzeSettings
+) -> typing.Iterable[_elfdeps.ELFInfo]:
+    with tarfile.TarFile.open(filename, mode="r:*") as tf:
+        for tarinfo in tf.getmembers():
+            if tarinfo.name.endswith(".so"):
+                yield _archives.analyze_tarmember(tf, tarinfo, settings=settings)
+
+
+def main(argv: list[str] | None = None) -> None:
     args = parser.parse_args(argv)
-    e = ELFDeps(
-        args.filename,
+    settings = _elfdeps.ELFAnalyzeSettings(
         soname_only=args.soname_only,
         fake_soname=args.fake_soname,
         filter_soname=args.filter_soname,
         require_interp=args.require_interp,
         unique=args.unique,
     )
+    filename: pathlib.Path = args.filename
+    if filename.suffix in ZIPEXT:
+        infos = list(zip_requires(filename, settings=settings))
+    elif filename.suffix in TAREXT:
+        infos = list(tar_requires(filename, settings=settings))
+    else:
+        infos = [_elfdeps.analyze_file(filename, settings=settings)]
     if args.provides:
-        for p in e.info.provides:
+        provides = set()
+        for info in infos:
+            provides.update(info.provides)
+        for p in sorted(provides):
             print(p)
-    if args.requires:
-        for r in e.info.requires:
+    elif args.requires:
+        requires = set()
+        for info in infos:
+            requires.update(info.requires)
+        for r in sorted(requires):
             print(r)
-    if not args.requires and not args.provides:
-        pprint.pprint(e.info)
+    else:
+        for info in infos:
+            pprint.pprint(info)
 
 
 if __name__ == "__main__":

src/elfdeps/_archives.py

@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: Apache-2.0
+"""Analyze archive members"""
+
+import pathlib
+import stat
+import tarfile
+import typing
+import zipfile
+
+from elftools.elf.elffile import ELFFile
+
+from ._elfdeps import ELFAnalyzeSettings, ELFInfo, analyze_elffile
+
+
+def analyze_zipmember(
+    zfile: zipfile.ZipFile,
+    zipinfo: zipfile.ZipInfo,
+    *,
+    settings: ELFAnalyzeSettings | None = None,
+) -> ELFInfo:
+    """Analyze a zipfile member"""
+    mode = zipinfo.external_attr >> 16
+    is_exec = bool(mode & (stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH))
+    filename = pathlib.Path(zipinfo.filename)
+    with zfile.open(zipinfo, mode="r") as f:
+        elffile = ELFFile(f)
+        return analyze_elffile(
+            elffile, filename=filename, is_exec=is_exec, settings=settings
+        )
+
+
+def analyze_tarmember(
+    tfile: tarfile.TarFile,
+    tarinfo: tarfile.TarInfo,
+    *,
+    settings: ELFAnalyzeSettings | None = None,
+) -> ELFInfo:
+    """Analze a tarfile member"""
+    mode = tarinfo.mode
+    is_exec = bool(mode & (stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH))
+    filename = pathlib.Path(tarinfo.name)
+    f = tfile.extractfile(tarinfo)
+    if typing.TYPE_CHECKING:
+        assert f is not None
+    with f:
+        elffile = ELFFile(f)
+        return analyze_elffile(
+            elffile, filename=filename, is_exec=is_exec, settings=settings
+        )