feat: simplify buildplan api and keep original reasons

This commit is contained in:
arcanis committed 2026-11-18 10:35:46 +02:00
1 parent a10b1a9364
commit 4f839a7e6a
5 files changed
+36 -32

No files matched your search

@@ -173,8 +173,7 @@ class Application(ApplicationPackages, ApplicationRepository):
continue
# update existing package
item = plan.item(package.base)
plan.add(packages.pop(package.base), item.reason, item.requester)
plan.add(packages.pop(package.base))
# append dependencies
plan.update(packages.values(), BuildPlanReason.RequiredBy, package.base)
@@ -202,12 +202,12 @@ class ApplicationRepository(ApplicationProperties):
# always add already built packages, because they will be always added
plan.update(self.repository.load_archives(self.repository.packages_built()), BuildPlanReason.PreBuilt)
if manual:
plan.update(self.repository.updates_manual(), BuildPlanReason.ManualRequest)
if aur:
plan.update(self.repository.updates_aur(filter_packages, vcs=vcs), BuildPlanReason.RegularUpdate)
if local:
plan.update(self.repository.updates_local(vcs=vcs), BuildPlanReason.LocalSourceUpdate)
if manual:
plan.update(self.repository.updates_manual(), BuildPlanReason.QueuedRequest)
if check_files:
plan.update(self.repository.updates_dependencies(filter_packages), BuildPlanReason.BrokenImplicitDependency)
+11 -7
View File
@@ -32,8 +32,8 @@ class BuildPlanReason(StrEnum):
Attributes:
BrokenImplicitDependency(BuildPlanReason): package has a broken implicit dependency
LocalSourceUpdate(BuildPlanReason): locally sourced package has an update
ManualRequest(BuildPlanReason): package was manually queued
PreBuilt(BuildPlanReason): package has already been built
QueuedRequest(BuildPlanReason): package was manually queued
Rebuild(BuildPlanReason): package was selected for rebuild
RegularUpdate(BuildPlanReason): package has an AUR update
RequiredBy(BuildPlanReason): package is required by another selected package
@@ -41,8 +41,8 @@ class BuildPlanReason(StrEnum):
BrokenImplicitDependency = "broken implicit dependency"
LocalSourceUpdate = "local source update"
ManualRequest = "manual request"
PreBuilt = "pre-built"
QueuedRequest = "queued request"
Rebuild = "rebuild"
RegularUpdate = "regular update"
RequiredBy = "required by"
@@ -95,18 +95,21 @@ class BuildPlan(Iterable[Package]):
"""
return [item.package for item in self.items]
def add(self, package: Package, reason: BuildPlanReason, requester: str | None = None) -> BuildPlanItem:
def add(self, package: Package, reason: BuildPlanReason = BuildPlanReason.ManualRequest,
requester: str | None = None) -> BuildPlanItem:
"""
add or update a package in the plan
add or update a package while preserving its first reason and requester
Args:
package(Package): package selected for the plan
reason(BuildPlanReason): reason for selecting it
reason(BuildPlanReason, optional): reason for selecting it (Default value = BuildPlanReason.ManualRequest)
requester(str | None, optional): package requiring this dependency (Default value = None)
Returns:
BuildPlanItem: plan item for the package
"""
if (existing := self._items.get(package.base)) is not None:
reason, requester = existing.reason, existing.requester
item = self._items[package.base] = BuildPlanItem(package, reason, requester)
return item
@@ -122,13 +125,14 @@ class BuildPlan(Iterable[Package]):
"""
return self._items[package_base]
def update(self, packages: Iterable[Package], reason: BuildPlanReason, requester: str | None = None) -> Self:
def update(self, packages: Iterable[Package], reason: BuildPlanReason = BuildPlanReason.ManualRequest,
requester: str | None = None) -> Self:
"""
bulk update packages with the same reason
Args:
packages(Iterable[Package]): list of new packages to be added
reason(BuildPlanReason): reason for selecting them
reason(BuildPlanReason, optional): reason for selecting it (Default value = BuildPlanReason.ManualRequest)
requester(str | None, optional): package requiring these dependencies (Default value = None)
Returns:
@@ -144,7 +144,7 @@ def test_with_dependencies_split(application: Application, package_ahriman: Pack
plan = BuildPlan().update([
package("ahriman", "ahriman", ["ahriman-core", "ahriman-web"])
], BuildPlanReason.QueuedRequest)
], BuildPlanReason.ManualRequest)
result = application.with_dependencies(plan, process_dependencies=True)
assert [[item.base for item in level] for level in Tree.resolve(result)] == [
["python-tree-sitter-bash"], ["ahriman"],
@@ -152,7 +152,7 @@ def test_with_dependencies_split(application: Application, package_ahriman: Pack
plan_item = result.item("ahriman")
assert plan_item.package.packages.keys() == {"ahriman", "ahriman-core", "ahriman-web"}
assert plan_item.reason == BuildPlanReason.QueuedRequest
assert plan_item.reason == BuildPlanReason.ManualRequest
assert plan_item.requester is None
@@ -1,29 +1,30 @@
from ahriman.models.build_plan import BuildPlan, BuildPlanReason
from dataclasses import replace
from ahriman.models.build_plan import BuildPlan, BuildPlanItem, BuildPlanReason
from ahriman.models.package import Package
def test_add(package_ahriman: Package, package_python_schedule: Package) -> None:
"""
must replace the package and reason for the same base
"""
plan = BuildPlan().update([package_ahriman], BuildPlanReason.RegularUpdate)
plan.add(package_ahriman, BuildPlanReason.QueuedRequest)
plan.add(package_python_schedule, BuildPlanReason.LocalSourceUpdate)
assert package_ahriman in plan
assert package_python_schedule in plan
assert plan.item(package_ahriman.base).reason == BuildPlanReason.QueuedRequest
def test_add_with_requester(package_python_schedule: Package) -> None:
"""
must keep the last requester for a dependency
must add package into plan
"""
plan = BuildPlan()
plan.add(package_python_schedule, BuildPlanReason.RequiredBy, requester="ahriman")
plan.add(package_python_schedule, BuildPlanReason.RequiredBy, requester="python-ahriman")
assert plan.item(package_python_schedule.base).requester == "python-ahriman"
plan.add(package_ahriman, BuildPlanReason.ManualRequest, requester="later-requester")
plan.add(package_python_schedule, BuildPlanReason.LocalSourceUpdate)
assert package_ahriman in plan
assert package_python_schedule in plan
def test_add_preserves_first_reason(package_ahriman: Package) -> None:
"""
must update package data while preserving the first reason and requester
"""
plan = BuildPlan().update([package_ahriman], BuildPlanReason.RegularUpdate, "requester1")
updated = replace(package_ahriman, version="42")
plan.add(updated, BuildPlanReason.ManualRequest, "requester2")
assert plan.item(package_ahriman.base) == BuildPlanItem(updated, BuildPlanReason.RegularUpdate, "requester1")
def test_update(package_ahriman: Package) -> None:
@@ -41,7 +42,7 @@ def test_eq(package_ahriman: Package) -> None:
plan1 = BuildPlan().update([package_ahriman], BuildPlanReason.RegularUpdate)
assert plan1 == plan1
plan2 = BuildPlan().update([package_ahriman], BuildPlanReason.QueuedRequest)
plan2 = BuildPlan().update([package_ahriman], BuildPlanReason.ManualRequest)
assert plan1 != plan2