pmbootstrap-meow/pmb/helpers/devices.py
Caleb Connolly 198f302a36
treewide: add a Chroot type and adopt pathlib.Path (MR 2252)
Introduce a new module: pmb.core to contain explicitly typed pmbootstrap
API. The first component being Suffix and SuffixType. This explicitly
defines what suffixes are possible, future changes should aim to further
constrain this API (e.g. by validating against available device
codenames or architectures for buildroot suffixes).

Additionally, migrate the entire codebase over to using pathlib.Path.
This is a relatively new part of the Python standard library that uses a
more object oriented model for path handling. It also uses strong type
hinting and has other features that make it much cleaner and easier to
work with than pure f-strings. The Chroot class overloads the "/"
operator the same way the Path object does, allowing one to write paths
relative to a given chroot as:

builddir = chroot / "home/pmos/build"

The Chroot class also has a string representation ("native", or
"rootfs_valve-jupiter"), and a .path property for directly accessing the
absolute path (as a Path object).

The general idea here is to encapsulate common patterns into type hinted
code, and gradually reduce the amount of assumptions made around the
codebase so that future changes are easier to implement.

As the chroot suffixes are now part of the Chroot class, we also
implement validation for them, this encodes the rules on suffix naming
and will cause a runtime exception if a suffix doesn't follow the rules.
2024-06-23 12:38:37 +02:00

71 lines
2.2 KiB
Python

# Copyright 2023 Oliver Smith
# SPDX-License-Identifier: GPL-3.0-or-later
import os
import glob
from pathlib import Path
from pmb.core.types import PmbArgs
import pmb.parse
def find_path(args: PmbArgs, codename: str, file='') -> Path:
"""Find path to device APKBUILD under `device/*/device-`.
:param codename: device codename
:param file: file to look for (e.g. APKBUILD or deviceinfo), may be empty
:returns: path to APKBUILD
"""
g = list((args.aports / "device").glob(f"*/device-{codename}/{file}"))
if not g:
return None
if len(g) != 1:
raise RuntimeError(codename + " found multiple times in the device"
" subdirectory of pmaports")
return g[0]
def list_codenames(args: PmbArgs, vendor=None, archived=True):
"""Get all devices, for which aports are available.
:param vendor: vendor name to choose devices from, or None for all vendors
:param archived: include archived devices
:returns: ["first-device", "second-device", ...]
"""
ret = []
for path in args.aports.glob("device/*/device-*"):
if not archived and 'archived' in path.parts:
continue
device = os.path.basename(path).split("-", 1)[1]
if (vendor is None) or device.startswith(vendor + '-'):
ret.append(device)
return ret
def list_vendors(args: PmbArgs):
"""Get all device vendors, for which aports are available.
:returns: {"vendor1", "vendor2", ...}
"""
ret = set()
for path in (args.aports / "device").glob("*/device-*"):
vendor = path.name.split("-", 2)[1]
ret.add(vendor)
return ret
def list_apkbuilds(args: PmbArgs):
""":returns: { "first-device": {"pkgname": ..., "pkgver": ...}, ... }"""
ret = {}
for device in list_codenames(args):
apkbuild_path = f"{args.aports}/device/*/device-{device}/APKBUILD"
ret[device] = pmb.parse.apkbuild(apkbuild_path)
return ret
def list_deviceinfos(args: PmbArgs):
""":returns: { "first-device": {"name": ..., "screen_width": ...}, ... }"""
ret = {}
for device in list_codenames(args):
ret[device] = pmb.parse.deviceinfo(args, device)
return ret