Mirror/pmbootstrap
1
0
Fork 1
mirror of https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git synced 2025-07-13 03:19:47 +03:00
Code Issues Wiki Activity

treewide: add a Chroot type and adopt pathlib.Path (MR 2252)

Browse source 
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.
This commit is contained in:
Caleb Connolly 2023-06-29 05:25:00 +01:00 • committed by Oliver Smith
parent b31dee9ec3
commit 198f302a36
No known key found for this signature in database
GPG key ID: 5AE7F5513E0885CB
90 changed files with 1600 additions and 1121 deletions
Download patch file Download diff file Expand all files Collapse all files

10
pmb/helpers/git.py
View file

@ -3,10 +3,12 @@
import configparser
import logging
import os
from pathlib import Path
import pmb.build
import pmb.chroot.apk
import pmb.config
from pmb.core.types import PmbArgs
import pmb.helpers.pmaports
import pmb.helpers.run
@ -20,7 +22,7 @@ def get_path(args, name_repo):
"""
if name_repo == "pmaports":
return args.aports
return args.work + "/cache_git/" + name_repo
return pmb.config.work / "cache_git/" + name_repo
def clone(args, name_repo):
@ -44,7 +46,7 @@ def clone(args, name_repo):
# Create parent dir and clone
logging.info("Clone git repository: " + url)
os.makedirs(args.work + "/cache_git", exist_ok=True)
os.makedirs(pmb.config.work / "cache_git", exist_ok=True)
pmb.helpers.run.user(args, command, output="stdout")
# FETCH_HEAD does not exist after initial clone. Create it, so
@ -68,7 +70,7 @@ def rev_parse(args, path, revision="HEAD", extra_args: list = []):
return rev.rstrip()
def can_fast_forward(args, path, branch_upstream, branch="HEAD"):
def can_fast_forward(args: PmbArgs, path, branch_upstream, branch="HEAD"):
command = ["git", "merge-base", "--is-ancestor", branch, branch_upstream]
ret = pmb.helpers.run.user(args, command, path, check=False)
if ret == 0:
@ -239,7 +241,7 @@ def pull(args, name_repo):
return 0
def get_topdir(args, path):
def get_topdir(args: PmbArgs, path: Path):
"""Get top-dir of git repo.
:returns: a string with the top dir of the git repository,