Compare commits

...
3 Commits
Author SHA1 Message Date
arcanis a428b62993 docs: fix types in docstrings 2026-11-19 15:50:36 +02:00
arcanis 0bd22a049c type: add type annotation pylint check
Also run pylint against tests tree
2026-11-18 14:30:17 +02:00
arcanis 71c5d58264 fix: remove packages with broken dependencies from build plan and mark
them as failed
2026-11-18 11:20:43 +02:00
82 changed files with 320 additions and 152 deletions

No files matched your search

+1
View File
@@ -8,6 +8,7 @@ load-plugins = [
"pylint.extensions.typing",
"pylint_plugins.definition_order",
"pylint_plugins.import_order",
"pylint_plugins.type_annotations",
]
[tool.pylint.classes]
@@ -45,7 +45,7 @@ class Application(ApplicationPackages, ApplicationRepository):
>>> application.add(["ahriman"], PackageSource.AUR)
>>>
>>> # check for updates
>>> updates = application.updates([], aur=True, local=True, manual=True, vcs=True)
>>> updates = application.updates([], aur=True, local=True, manual=True, vcs=True, check_files=False)
>>> # updates for specified packages
>>> application.update(updates)
@@ -170,6 +170,8 @@ class Application(ApplicationPackages, ApplicationRepository):
packages = new_packages(package)
except Exception:
self.logger.exception("could not process dependencies of %s, skip the package", package.base)
plan.remove(package.base)
self.reporter.set_failed(package.base)
continue
# update existing package
@@ -41,7 +41,7 @@ class UpdatesIterator(Iterator[list[str] | None]):
Typical usage of this class is something like:
>>> application = ...
>>> iterator = UpdatesIterator(application, None)
>>> iterator = UpdatesIterator(application, 3600)
>>>
>>> for updates in iterator:
>>> print(updates)
@@ -158,7 +158,7 @@ class Statistics(Handler):
Args:
event_type(str): event type
events(list[Event]): list of events
chart_path(Path): path to save plot if any
chart_path(Path | None): path to save plot if any
"""
# event statistics
Statistics.event_stats(event_type, events)
@@ -175,7 +175,7 @@ class Statistics(Handler):
Args:
event_type(str): event type
events(list[Event]): list of events
chart_path(Path): path to save plot if any
chart_path(Path | None): path to save plot if any
"""
key: Callable[[Event], str] = lambda event: event.object_id
by_object_id = {
@@ -77,7 +77,7 @@ class UnsafeCommands(Handler):
check if command is unsafe
Args:
command(str): command to check
command(list[str]): command and arguments to check
unsafe_commands(list[str]): list of unsafe commands
parser(argparse.ArgumentParser): generated argument parser
"""
+1 -1
View File
@@ -88,7 +88,7 @@ class _Context:
iterate over keys in local storage
Returns:
str: context key iterator
Iterator[str]: context key iterator
"""
return iter(self._content)
@@ -134,7 +134,7 @@ class Configuration(configparser.RawConfigParser):
repository identifier
Returns:
RepositoryId: repository unique identifier
RepositoryId | None: repository unique identifier
"""
return self._repository_id
@@ -58,7 +58,7 @@ class Migrations(LazyLogging):
configuration(Configuration): configuration instance
Returns:
MigrationResult: current schema version
MigrationResult: schema versions before and after migration
"""
return Migrations(connection, configuration).run()
@@ -144,8 +144,8 @@ class Migrations(LazyLogging):
"""
perform migrations
Return:
MigrationResult: current schema version
Returns:
MigrationResult: schema versions before and after migration
"""
migrations = self.migrations()
@@ -35,7 +35,7 @@ class BuildOperations(Operations):
Args:
package_base(str | None): optional filter by package base
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -57,9 +57,9 @@ class BuildOperations(Operations):
retrieve packages from build queue
Args:
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Return:
Returns:
list[Package]: list of packages to be built
"""
repository_id = repository_id or self._repository_id
@@ -81,7 +81,7 @@ class BuildOperations(Operations):
Args:
package(Package): package to be inserted
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -35,7 +35,7 @@ class ChangesOperations(Operations):
Args:
package_base(str): package base to search
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Returns:
Changes: changes for the package base if available
@@ -69,7 +69,7 @@ class ChangesOperations(Operations):
Args:
package_base(str): package base to insert
changes(Changes): package changes (as in patch format)
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -101,7 +101,7 @@ class ChangesOperations(Operations):
Args:
package_base(str | None): optional filter by package base
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -36,10 +36,10 @@ class DependenciesOperations(Operations):
Args:
package_base(str | None): package base to search
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Returns:
Dependencies: dependencies for the package base if available
dict[str, Dependencies]: dependencies keyed by package base, optionally filtered by package base
"""
repository_id = repository_id or self._repository_id
@@ -69,7 +69,7 @@ class DependenciesOperations(Operations):
Args:
package_base(str): package base
dependencies(Dependencies): package dependencies
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -97,7 +97,7 @@ class DependenciesOperations(Operations):
Args:
package_base(str | None): optional filter by package base
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -42,7 +42,7 @@ class EventOperations(Operations):
to_date(int | float | None, optional): maximal creation date, exclusive (Default value = None)
limit(int, optional): limit records to the specified count, -1 means unlimited (Default value = -1)
offset(int, optional): records offset (Default value = 0)
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Returns:
list[Event]: list of audit log events
@@ -84,7 +84,7 @@ class EventOperations(Operations):
Args:
event(Event): event to insert
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -40,9 +40,9 @@ class LogsOperations(Operations):
process_id(str | None, optional): process identifier to filter (Default value = None)
limit(int, optional): limit records to the specified count, -1 means unlimited (Default value = -1)
offset(int, optional): records offset (Default value = 0)
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Return:
Returns:
list[LogRecord]: sorted package log records
"""
repository_id = repository_id or self._repository_id
@@ -79,7 +79,7 @@ class LogsOperations(Operations):
Args:
log_record(LogRecord): log record object
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -106,7 +106,7 @@ class LogsOperations(Operations):
Args:
package_base(str): package base to remove logs
version(str | None): package version. If set it will remove only logs belonging to another version
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -133,7 +133,7 @@ class LogsOperations(Operations):
Args:
keep_last_records(int): number of last records to keep
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -66,7 +66,7 @@ class Operations(LazyLogging):
dictionary factory based on official documentation
Args:
cursor(Cursor): cursor descriptor
cursor(sqlite3.Cursor): cursor descriptor
row(tuple[Any, ...]): fetched row
Returns:
@@ -82,7 +82,7 @@ class Operations(LazyLogging):
perform operation in connection
Args:
query(Callable[[Connection], T]): function to be called with connection
query(Callable[[sqlite3.Connection], T]): function to be called with connection
commit(bool, optional): if ``True`` commit() will be called on success (Default value = False)
Returns:
@@ -225,7 +225,7 @@ class PackageOperations(Operations):
Args:
package_base(str): package base name
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
enabled(bool): new hold status
"""
repository_id = repository_id or self._repository_id
@@ -248,7 +248,7 @@ class PackageOperations(Operations):
Args:
package_base(str): package base name
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -264,7 +264,7 @@ class PackageOperations(Operations):
Args:
package(Package): package properties
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -280,9 +280,9 @@ class PackageOperations(Operations):
get package list and their build statuses from database
Args:
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Return:
Returns:
list[tuple[Package, BuildStatus]]: list of package properties and their statuses
"""
repository_id = repository_id or self._repository_id
@@ -303,7 +303,7 @@ class PackageOperations(Operations):
Args:
package_base(str): package base name
status(BuildStatus): new build status
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
@@ -116,7 +116,7 @@ class SQLite(
Args:
package_base(str): package base to remove
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
repository_id(RepositoryId | None, optional): repository unique identifier override (Default value = None)
Examples:
This method completely removes the package from all tables and must be used, e.g. on package removal::
+1 -1
View File
@@ -254,7 +254,7 @@ class PasswordError(ValueError):
def __init__(self, details: Any) -> None:
"""
Args:
details(Any); error details
details(Any): error details
"""
ValueError.__init__(self, f"Password error: {details}")
@@ -35,6 +35,7 @@ class RepositoryStatsPrinter(StringPrinter):
def __init__(self, repository_id: RepositoryId, statistics: RepositoryStats) -> None:
"""
Args:
repository_id(RepositoryId): repository unique identifier
statistics(RepositoryStats): repository statistics
"""
StringPrinter.__init__(self, str(repository_id))
@@ -90,6 +90,9 @@ class UpdatePrinter(StringPrinter):
"""
generate version property
Args:
package(Package): package whose current and updated versions are shown
Returns:
tuple[str, str]: extract current and updated versions for the package
"""
@@ -81,7 +81,7 @@ class SyncHttpClient(LazyLogging):
get or create session
Returns:
request.Session: created session object
requests.Session: created session object
"""
session = requests.Session()
@@ -107,10 +107,10 @@ class JinjaTemplate:
sort content before rendering
Args:
content(list[dict[str, str]]): content of the template
content(list[dict[str, Any]]): content of the template
Returns:
list[dict[str, str]]: sorted content according to comparator defined
list[dict[str, Any]]: sorted content according to comparator defined
"""
comparator: Callable[[dict[str, str]], Comparable] = lambda item: item["filename"]
return sorted(content, key=comparator)
@@ -122,6 +122,9 @@ class JinjaTemplate:
Args:
result(Result): build result
template_name(Path | str): name of the template or path to it (legacy configuration)
Returns:
str: rendered report
"""
templates = self.templates[:]
if isinstance(template_name, Path):
+2 -2
View File
@@ -82,10 +82,10 @@ class RSS(Report, JinjaTemplate):
sort content before rendering
Args:
content(list[dict[str, str]]): content of the template
content(list[dict[str, Any]]): content of the template
Returns:
list[dict[str, str]]: sorted content according to comparator defined
list[dict[str, Any]]: sorted content according to comparator defined
"""
comparator: Callable[[dict[str, str]], Comparable] = \
lambda item: parsedate_to_datetime(item["build_date"])
@@ -86,7 +86,7 @@ class RepositoryProperties(EventLogger, LazyLogging):
package_base(str): package base to lookup
Returns:
User | None: user found in database if any and empty object otherwise
User: user found in database if any and empty user object otherwise
"""
username = packagers.for_base(package_base)
if username is None: # none to search
+1 -1
View File
@@ -103,7 +103,7 @@ class GPG(SyncHttpClient):
filepath(Path): path to the file which will be signed
Returns:
str: path to signature file
Path: path to signature file
"""
return filepath.parent / f"{filepath.name}.sig"
@@ -164,7 +164,7 @@ class Client:
package_base(str): package base to retrieve
Returns:
list[Dependencies]: package implicit dependencies if available
Dependencies: package implicit dependencies if available
Raises:
NotImplementedError: not implemented method
@@ -114,7 +114,7 @@ class LocalClient(Client):
package_base(str): package base to retrieve
Returns:
list[Dependencies]: package implicit dependencies if available
Dependencies: package implicit dependencies if available
"""
return self.database.dependencies_get(package_base, self.repository_id).get(package_base, Dependencies())
@@ -151,7 +151,7 @@ class Watcher(LazyLogging):
package_base(str): package base to retrieve
Returns:
list[Dependencies]: package implicit dependencies if available
Dependencies: package implicit dependencies if available
"""
return self.client.package_dependencies_get(package_base)
@@ -269,7 +269,7 @@ class WebClient(Client, SyncAhrimanClient):
package_base(str): package base to retrieve
Returns:
list[Dependencies]: package implicit dependencies if available
Dependencies: package implicit dependencies if available
"""
with contextlib.suppress(Exception):
response = self.make_request("GET", self._dependencies_url(package_base),
@@ -57,7 +57,7 @@ class RemoteService(Upload, HttpUpload):
get or create session
Returns:
request.Session: created session object
requests.Session: created session object
"""
return self.client.session
+2 -2
View File
@@ -101,8 +101,8 @@ def check_output(*args: str, exception: Exception | Callable[[int, list[str], st
Args:
*args(str): command line arguments
exception(Exception | Callable[[int, list[str], str, str]] | None, optional): exception which has to be raised
instead of default subprocess exception. If callable us is supplied, the
exception(Exception | Callable[[int, list[str], str, str], Exception] | None, optional): exception to raise
instead of the default subprocess exception. If a callable is supplied, the
:exc:`subprocess.CalledProcessError` arguments will be passed (Default value = None)
cwd(Path | None, optional): current working directory (Default value = None)
input_data(str | None, optional): data which will be written to command stdin (Default value = None)
@@ -69,11 +69,13 @@ class AURPackage:
>>>
>>> from ahriman.core.alpm.pacman import Pacman
>>> from ahriman.core.configuration import Configuration
>>> from ahriman.models.pacman_synchronization import PacmanSynchronization
>>> from ahriman.models.repository_id import RepositoryId
>>>
>>> configuration = Configuration()
>>> pacman = Pacman(RepositoryId("x86_64", "aur"), configuration)
>>> metadata = pacman.package_get("pacman")
>>> pacman = Pacman(RepositoryId("x86_64", "aur"), configuration,
>>> refresh_database=PacmanSynchronization.DISABLED)
>>> metadata = pacman.package("pacman")
>>> package = AURPackage.from_pacman(next(metadata)) # load package from pyalpm wrapper
"""
+10 -1
View File
@@ -125,6 +125,15 @@ class BuildPlan(Iterable[Package]):
"""
return self._items[package_base]
def remove(self, package_base: str) -> None:
"""
remove a package from the plan
Args:
package_base(str): package base to remove
"""
del self._items[package_base]
def update(self, packages: Iterable[Package], reason: BuildPlanReason = BuildPlanReason.MANUAL_REQUEST,
requester: str | None = None) -> Self:
"""
@@ -173,7 +182,7 @@ class BuildPlan(Iterable[Package]):
iterate over selected packages in stable package-base order
Returns:
Package: selected package
Iterator[Package]: iterator over selected packages
"""
return iter(self.packages)
+1 -1
View File
@@ -61,7 +61,7 @@ class Event:
"""
def __init__(self, event: str | EventType, object_id: str, message: str | None = None, created: int | None = None,
**kwargs: Any):
**kwargs: Any) -> None:
"""
Args:
event(str | EventType): event type
@@ -34,7 +34,7 @@ class FilesystemPackage:
Attributes:
package_name(str): package name
depends(set[str]): list of package dependencies
directories(set[Path]): list of directories this package contains
directories(list[Path]): list of directories this package contains
files(list[Path]): list of files this package contains
opt_depends(set[str]): list of package optional dependencies
"""
@@ -80,7 +80,8 @@ class FilesystemPackage:
include_optional(bool): include optional dependencies to check
Returns:
bool: whether this package depends on any other package in the list of packages
bool: ``True`` if this package has no dependencies among the supplied packages, ignoring packages
that have a required dependency on this package
"""
return not any(
package
@@ -38,9 +38,9 @@ class MetricsTimer:
>>> with MetricsTimer() as timer:
>>> do_something()
>>> print("Time elapsed for first function: %f", timer.elapsed)
>>> print(f"Time elapsed for first function: {timer.elapsed:f}")
>>> do_something_different()
>>> print("Time elapsed for all functions: %f", timer.elapsed)
>>> print(f"Time elapsed for all functions: {timer.elapsed:f}")
"""
def __init__(self) -> None:
+3 -3
View File
@@ -44,8 +44,8 @@ class Package(LazyLogging):
Attributes:
base(str): package base name
packager(str | None): package packager if available
packages(dict[str, PackageDescription): map of package names to their properties.
Filled only on load from archive
packages(dict[str, PackageDescription]): map of package names to their properties.
Available properties depend on the source used to load the package
remote(RemoteSource): package remote source if applicable
version(str): package full version
@@ -56,7 +56,7 @@ class Package(LazyLogging):
it will contain every data available in the JSON body. Otherwise, if generate package from local archive::
>>> package = Package.from_archive(local_path, pacman)
>>> package = Package.from_archive(local_path)
it will probably miss file descriptions (in case if there are multiple packages which belong to the base).
@@ -57,11 +57,13 @@ class PackageDescription:
>>> from pathlib import Path
>>> from ahriman.core.alpm.pacman import Pacman
>>> from ahriman.core.configuration import Configuration
>>> from ahriman.models.pacman_synchronization import PacmanSynchronization
>>> from ahriman.models.repository_id import RepositoryId
>>>
>>> configuration = Configuration()
>>> pacman = Pacman(RepositoryId("x86_64", "aur"), configuration)
>>> pyalpm_description = next(package for package in pacman.package_get("pacman"))
>>> pacman = Pacman(RepositoryId("x86_64", "aur"), configuration,
>>> refresh_database=PacmanSynchronization.DISABLED)
>>> pyalpm_description = next(package for package in pacman.package("pacman"))
>>> description = PackageDescription.from_package(
>>> pyalpm_description, Path("/var/cache/pacman/pkg/pacman-6.0.1-4-x86_64.pkg.tar.zst"))
"""
+1 -1
View File
@@ -27,7 +27,7 @@ class Packagers:
Attributes:
default(str | None): default packager username if any to be used if no override for the specified base was found
overrides: dict[str, str | None]: packager username override for specific package base
overrides(dict[str, str | None]): packager username override for specific package base
"""
default: str | None = None
@@ -109,7 +109,7 @@ class PkgbuildPatch:
Args:
key(str | None): variable key
source(str): source value string to parse
source(str | list[str]): source string to parse or list to use as is
Returns:
Self: parsed patch object
@@ -56,7 +56,7 @@ class RepositoryStats:
construct statistics from list of repository packages
Args:
packages(list[Packages]): list of repository packages
packages(list[Package]): list of repository packages
Returns:
Self: constructed statistics object
@@ -41,7 +41,7 @@ class ScanPaths:
compiled regular expressions
Returns:
list[re.Pattern]: a list of compiled regular expressions
list[re.Pattern[str]]: a list of compiled regular expressions
"""
return [re.compile(path) for path in self.paths]
@@ -68,14 +68,14 @@ def test_with_dependencies(application: Application, package_ahriman: Package, p
"""
must append list of missing dependencies
"""
def create_package_mock(package_base) -> MagicMock:
def package(package_base: str) -> MagicMock:
mock = MagicMock()
mock.base = package_base
mock.depends_build = []
mock.packages_full = [package_base]
return mock
def get_package(name: str | Path, *args: Any, **kwargs: Any) -> Package:
def get_package(name: str | Path, *_args: Any, **_kwargs: Any) -> Package:
name = name if isinstance(name, str) else name.name
return packages[name]
@@ -88,8 +88,8 @@ def test_with_dependencies(application: Application, package_ahriman: Package, p
packages = {
package_ahriman.base: package_ahriman,
package_python_schedule.base: package_python_schedule,
"python": create_package_mock("python"),
"python-installer": create_package_mock("python-installer"),
"python": package("python"),
"python-installer": package("python-installer"),
}
mocker.patch("pathlib.Path.is_dir", autospec=True, side_effect=lambda p: p.name == "python")
@@ -124,12 +124,12 @@ def test_with_dependencies_split(application: Application, package_ahriman: Pack
"""
must preserve resolved subpackages during dependency resolution
"""
def package(base: str, name: str, dependencies: list[str]) -> Package:
def package(package_base: str, package_name: str, dependencies: list[str]) -> Package:
return Package(
base=base,
base=package_base,
version="1-1",
remote=package_ahriman.remote,
packages={name: PackageDescription(depends=dependencies)},
packages={package_name: PackageDescription(depends=dependencies)},
)
packages = {
@@ -161,7 +161,7 @@ def test_with_dependencies_exception(application: Application, package_ahriman:
"""
must skip packages if exception occurs
"""
def create_package_mock(package_base) -> MagicMock:
def package(package_base: str) -> MagicMock:
mock = MagicMock()
mock.base = package_base
mock.depends_build = []
@@ -171,26 +171,28 @@ def test_with_dependencies_exception(application: Application, package_ahriman:
package_python_schedule.packages = {
package_python_schedule.base: package_python_schedule.packages[package_python_schedule.base]
}
package_ahriman.packages[package_ahriman.base].depends = ["devtools", "python", package_python_schedule.base]
package_ahriman.packages[package_ahriman.base].depends = ["devtools", package_python_schedule.base]
package_ahriman.packages[package_ahriman.base].make_depends = ["python-build", "python-installer"]
package_python_installer = package("python-installer")
packages = {
package_ahriman.base: package_ahriman,
package_python_schedule.base: package_python_schedule,
"python": create_package_mock("python"),
"python-installer": create_package_mock("python-installer"),
"python": package("python"),
"python-installer": package_python_installer,
}
mocker.patch("pathlib.Path.is_dir", autospec=True, side_effect=lambda p: p.name == "python")
mocker.patch("ahriman.models.package.Package.from_aur", side_effect=lambda *args: packages[args[0]])
mocker.patch("ahriman.models.package.Package.from_build", side_effect=Exception)
mocker.patch("ahriman.application.application.Application._known_packages",
return_value={"devtools", "python-build", "python-pytest"})
return_value={"devtools", "python-build"})
failed_mock = mocker.patch("ahriman.core.status.Client.set_failed")
plan = BuildPlan()
plan.add(package_ahriman, BuildPlanReason.REGULAR_UPDATE)
assert application.with_dependencies(plan, process_dependencies=True) is plan
assert plan.packages == [package_ahriman]
plan = BuildPlan().update([package_ahriman, package_python_installer], BuildPlanReason.REGULAR_UPDATE)
application.with_dependencies(plan, process_dependencies=True)
assert plan.packages == [package_python_installer]
failed_mock.assert_called_once_with(package_ahriman.base)
def test_with_dependencies_skip(application: Application, package_ahriman: Package, mocker: MockerFixture) -> None:
@@ -1,5 +1,4 @@
import argparse
import pytest
from pytest_mock import MockerFixture
@@ -169,7 +169,7 @@ def test_patch_set_list(application: Application, mocker: MockerFixture) -> None
Patch.patch_set_list(application, "ahriman", ["version"], False)
get_mock.assert_called_once_with("ahriman", None)
print_mock.assert_called_once_with(verbose=True, log_fn=pytest.helpers.anyvar(int), separator=" = ")
check_mock.assert_called_once_with(False, [PkgbuildPatch(key='version', value='value')])
check_mock.assert_called_once_with(False, [PkgbuildPatch(key="version", value="value")])
def test_patch_set_list_all(application: Application, mocker: MockerFixture) -> None:
@@ -184,7 +184,7 @@ def test_patch_set_list_all(application: Application, mocker: MockerFixture) ->
Patch.patch_set_list(application, "ahriman", None, False)
get_mock.assert_called_once_with("ahriman", None)
print_mock.assert_called_once_with(verbose=True, log_fn=pytest.helpers.anyvar(int), separator=" = ")
check_mock.assert_called_once_with(False, [PkgbuildPatch(key=None, value='patch')])
check_mock.assert_called_once_with(False, [PkgbuildPatch(key=None, value="patch")])
def test_patch_set_list_empty_exception(application: Application, mocker: MockerFixture) -> None:
@@ -244,7 +244,7 @@ def test_configuration_create_directory(configuration: Configuration, mocker: Mo
"""
must create writable directory for includes
"""
configuration.set_option("settings", "include", f"/path1 /path2 /path3")
configuration.set_option("settings", "include", "/path1 /path2 /path3")
mkdir_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.ensure_exists",
side_effect=[OSError, "/path2", "/path3"])
access_mock = mocker.patch("os.access", side_effect=[False, True])
@@ -8,8 +8,8 @@ from ahriman.application.application import Application
from ahriman.application.handlers.update import Update
from ahriman.core.configuration import Configuration
from ahriman.core.repository import Repository
from ahriman.models.package import Package
from ahriman.models.build_plan import BuildPlan, BuildPlanReason
from ahriman.models.package import Package
from ahriman.models.packagers import Packagers
from ahriman.models.result import Result
+4 -4
View File
@@ -107,10 +107,10 @@ def passwd() -> MagicMock:
Returns:
MagicMock: passwd structure test instance
"""
passwd = MagicMock()
passwd.pw_dir = "home"
passwd.pw_name = "ahriman"
return passwd
mock = MagicMock()
mock.pw_dir = "home"
mock.pw_name = "ahriman"
return mock
@pytest.fixture
@@ -1,7 +1,7 @@
import pytest
from ahriman.core.alpm.pacman_database import PacmanDatabase
from ahriman.core.alpm.pacman import Pacman
from ahriman.core.alpm.pacman_database import PacmanDatabase
from ahriman.core.configuration import Configuration
@@ -15,7 +15,7 @@ def pacman_database(configuration: Configuration, pacman: Pacman) -> PacmanDatab
pacman(Pacman): pacman test instance
Returns:
DatabaseSync: database sync test instance
PacmanDatabase: pacman database test instance
"""
database = next(iter(pacman.handle.get_syncdbs()))
return PacmanDatabase(database, configuration)
@@ -76,7 +76,7 @@ def test_multisearch_empty(pacman: Pacman, mocker: MockerFixture) -> None:
terms = ["it", "is"]
search_mock = mocker.patch("ahriman.core.alpm.remote.Remote.package_search")
assert Remote.multisearch(*terms, pacman=pacman) == []
assert not Remote.multisearch(*terms, pacman=pacman)
search_mock.assert_not_called()
@@ -61,7 +61,7 @@ def test_extend_architectures_any(mocker: MockerFixture) -> None:
"""
mocker.patch("pathlib.Path.is_file", return_value=True)
mocker.patch("ahriman.models.pkgbuild.Pkgbuild.supported_architectures", return_value={"any"})
assert Sources.extend_architectures(Path("local"), "i686") == []
assert not Sources.extend_architectures(Path("local"), "i686")
def test_fetch_empty(remote_source: RemoteSource, mocker: MockerFixture) -> None:
@@ -347,7 +347,7 @@ def test_add_skip(sources: Sources, mocker: MockerFixture) -> None:
check_output_mock.assert_not_called()
def test_add_force(sources: Sources, tmp_path: Path, mocker: MockerFixture) -> None:
def test_add_force(sources: Sources, mocker: MockerFixture) -> None:
"""
must add files to git with --force flag
"""
@@ -1,6 +1,6 @@
import configparser
import pytest
import os
import pytest
from io import StringIO
from pathlib import Path
@@ -1,5 +1,3 @@
import pytest
from dataclasses import replace
from pathlib import Path
from pytest_mock import MockerFixture
@@ -38,7 +36,7 @@ def test_move_packages(repository_paths: RepositoryPaths, package_ahriman: Packa
must move packages to the archive directory
"""
def is_file(self: Path, *args: Any, **kwargs: Any) -> bool:
def is_file(self: Path, **_: Any) -> bool:
return "file" in self.name
mocker.patch("pathlib.Path.iterdir", return_value=[
@@ -144,7 +144,7 @@ def test_package_remove(database: SQLite, package_ahriman: Package, mocker: Mock
database._repository_id)
def test_package_update(database: SQLite, package_ahriman: Package, mocker: MockerFixture):
def test_package_update(database: SQLite, package_ahriman: Package, mocker: MockerFixture) -> None:
"""
must update package status
"""
@@ -69,7 +69,7 @@ def test_properties() -> None:
"""
must return empty properties list
"""
assert Printer().properties() == []
assert not Printer().properties()
def test_title() -> None:
@@ -98,7 +98,7 @@ def test_headers() -> None:
"""
must return empty additional headers
"""
assert SyncHttpClient().headers() == {}
assert not SyncHttpClient().headers()
def test_make_request(mocker: MockerFixture) -> None:
@@ -1,6 +1,5 @@
import smtplib
import pytest
import smtplib
from pytest_mock import MockerFixture
@@ -78,7 +78,7 @@ async def test_shutdown_queue_full(event_bus: EventBus, package_ahriman: Package
must handle shutdown when queue is full
"""
event_bus.max_size = 1
_, queue = await event_bus.subscribe()
await event_bus.subscribe()
await event_bus.broadcast(EventType.PACKAGE_UPDATED, package_ahriman.base)
await event_bus.shutdown()
@@ -1,7 +1,7 @@
import ahriman.web.views
from pathlib import Path
import ahriman.web.views
from ahriman.core.module_loader import _modules, implementations, optional_module
from ahriman.web.views.base import BaseView
@@ -11,7 +11,6 @@ from unittest.mock import MagicMock, call as MockCall
from ahriman.core.exceptions import BuildError, CalledProcessError, OptionError, UnsafeRunError
from ahriman.core.utils import *
from ahriman.models.package import Package
from ahriman.models.package_source import PackageSource
from ahriman.models.repository_id import RepositoryId
from ahriman.models.repository_paths import RepositoryPaths
@@ -44,7 +44,7 @@ def test_configuration_schema_no_section(configuration: Configuration) -> None:
"""
section = "abracadabra"
configuration.set_option("report", "target", section)
assert ReportTrigger.configuration_schema(configuration) == {}
assert not ReportTrigger.configuration_schema(configuration)
def test_configuration_schema_no_schema(configuration: Configuration) -> None:
@@ -55,7 +55,7 @@ def test_configuration_schema_no_schema(configuration: Configuration) -> None:
configuration.set_option("report", "target", section)
configuration.set_option(section, "key", "value")
assert ReportTrigger.configuration_schema(configuration) == {}
assert not ReportTrigger.configuration_schema(configuration)
def test_configuration_schema_empty() -> None:
@@ -69,14 +69,14 @@ def test_configuration_schema_variables() -> None:
"""
must return empty schema
"""
assert Trigger.CONFIGURATION_SCHEMA == {}
assert not Trigger.CONFIGURATION_SCHEMA
def test_configuration_sections(configuration: Configuration) -> None:
"""
must return empty section list
"""
assert Trigger.configuration_sections(configuration) == []
assert not Trigger.configuration_sections(configuration)
def test_on_result(trigger: Trigger) -> None:
@@ -33,4 +33,4 @@ def test_get_hashes_empty() -> None:
"""
must read empty body
"""
assert HttpUpload.get_hashes("") == {}
assert not HttpUpload.get_hashes("")
@@ -8,7 +8,7 @@ from ahriman.core.upload.s3 import S3
from ahriman.models.repository_paths import RepositoryPaths
_chunk_size = 8 * 1024 * 1024
_CHUNK_SIZE = 8 * 1024 * 1024
def test_object_path(configuration: Configuration, mocker: MockerFixture) -> None:
@@ -34,7 +34,7 @@ def test_calculate_etag_big(resource_path_root: Path) -> None:
must calculate checksum for path which is more than one chunk
"""
path = resource_path_root / "models" / "big_file_checksum"
assert S3.calculate_etag(path, _chunk_size) == "3b15154eaeed22ae19ae4667d4b98d28-2"
assert S3.calculate_etag(path, _CHUNK_SIZE) == "3b15154eaeed22ae19ae4667d4b98d28-2"
def test_calculate_etag_empty(resource_path_root: Path) -> None:
@@ -42,7 +42,7 @@ def test_calculate_etag_empty(resource_path_root: Path) -> None:
must calculate checksum for empty file correctly
"""
path = resource_path_root / "models" / "empty_file_checksum"
assert S3.calculate_etag(path, _chunk_size) == "d41d8cd98f00b204e9800998ecf8427e"
assert S3.calculate_etag(path, _CHUNK_SIZE) == "d41d8cd98f00b204e9800998ecf8427e"
def test_calculate_etag_small(resource_path_root: Path) -> None:
@@ -50,7 +50,7 @@ def test_calculate_etag_small(resource_path_root: Path) -> None:
must calculate checksum for path which is single chunk
"""
path = resource_path_root / "models" / "package_ahriman_pkgbuild"
assert S3.calculate_etag(path, _chunk_size) == "7136fc388980dc043f9f869d57c5ce0c"
assert S3.calculate_etag(path, _CHUNK_SIZE) == "7136fc388980dc043f9f869d57c5ce0c"
def test_files_remove(s3_remote_objects: list[Any]) -> None:
@@ -78,7 +78,6 @@ def test_files_upload(s3: S3, s3_remote_objects: list[Any], mocker: MockerFixtur
Path(item.key[:-1] + item.key[-1].replace("a", "d")): item.e_tag.replace("b", "d").replace("\"", "")
for item in s3_remote_objects
}
print(local_files)
remote_objects = {Path(item.key): item for item in s3_remote_objects}
mocker.patch("mimetypes.guess_type", side_effect=mimetype)
@@ -27,6 +27,20 @@ def test_add_preserves_first_reason(package_ahriman: Package) -> None:
assert plan.item(package_ahriman.base) == BuildPlanItem(updated, BuildPlanReason.REGULAR_UPDATE, "requester1")
def test_remove(package_ahriman: Package, package_python_schedule: Package) -> None:
"""
must remove a package while preserving the remaining plan items
"""
plan = BuildPlan().update([package_ahriman, package_python_schedule], BuildPlanReason.REGULAR_UPDATE)
plan.remove(package_ahriman.base)
assert package_ahriman not in plan
assert package_python_schedule in plan
plan.remove(package_python_schedule.base)
assert not plan
def test_update(package_ahriman: Package) -> None:
"""
must update instance with new packages
@@ -40,10 +54,12 @@ def test_eq(package_ahriman: Package) -> None:
must compare two plans
"""
plan1 = BuildPlan().update([package_ahriman], BuildPlanReason.REGULAR_UPDATE)
assert plan1 == plan1
plan2 = BuildPlan().update([package_ahriman], BuildPlanReason.MANUAL_REQUEST)
assert plan1 != plan2
plan2 = BuildPlan().update([package_ahriman], BuildPlanReason.REGULAR_UPDATE)
assert plan1 == plan2
plan3 = BuildPlan().update([package_ahriman], BuildPlanReason.MANUAL_REQUEST)
assert plan1 != plan3
def test_eq_other() -> None:
@@ -44,10 +44,12 @@ def test_eq() -> None:
must compare two events
"""
event1 = Event("1", "1", "1", 1, key="value")
assert event1 == event1
event2 = Event("2", "2", "2", 2, key="value")
assert event1 != event2
event2 = Event("1", "1", "1", 1, key="value")
assert event1 == event2
event3 = Event("2", "2", "2", 2, key="value")
assert event1 != event3
def test_eq_other() -> None:
@@ -147,7 +147,7 @@ def test_symlinks_fix_foreign_repository(archive_tree: ArchiveTree, mocker: Mock
])
remove_mock = mocker.patch("ahriman.core.alpm.repo.Repo.remove")
assert list(archive_tree.symlinks_fix()) == []
assert not list(archive_tree.symlinks_fix())
remove_mock.assert_not_called()
@@ -27,7 +27,7 @@ def package_creator(configuration: Configuration, mirrorlist_generator: Mirrorli
Args:
configuration(Configuration): configuration fixture
mirrorlist_generator(MirrorlistGenerator):
mirrorlist_generator(MirrorlistGenerator): mirrorlist pkgbuild generator fixture
Returns:
PackageCreator: package creator test instance
@@ -39,8 +39,8 @@ def _response_schema(response: Schema | type[Schema] | None, response_code: type
response(Schema | type[Schema] | None): response schema type, set ``None`` for empty responses
response_code(type[HTTPException] | None, optional): code for the success response. If none set it will be
defined automatically (Default value = None)
error_400_enabled(bool, optional): include response for 404 codes (Default value = False)
error_403_enabled(bool, optional): include response for 403 codes (Default value = False)
error_400_enabled(bool, optional): include response for 400 codes (Default value = False)
error_403_enabled(bool, optional): include response for 403 codes (Default value = True)
error_404_description(str | None, optional): description for 404 codes if available (Default value = None)
Returns:
@@ -98,7 +98,7 @@ def apidocs(*,
permission(UserAccess): permission to access endpoint
response_code(type[HTTPException] | None, optional): code for the success response. If none set it will be
defined automatically (Default value = None)
error_400_enabled(bool, optional): include response for 404 codes (Default value = False)
error_400_enabled(bool, optional): include response for 400 codes (Default value = False)
error_404_description(str | None, optional): description for 404 codes if available (Default value = None)
schema(Schema | type[Schema] | None): response schema type, set ``None`` for empty responses
(Default value = None)
@@ -88,7 +88,7 @@ def _auth_handler(allow_read_only: bool) -> Middleware:
authorization and authentication middleware
Args:
allow_read_only: allow
allow_read_only(bool): allow read-only requests without authentication
Returns:
Middleware: built middleware
@@ -55,7 +55,7 @@ def test_run(args: argparse.Namespace, configuration: Configuration, repository:
join_mock.assert_called_once_with()
def test_extract_arguments(args: argparse.Namespace, configuration: Configuration):
def test_extract_arguments(args: argparse.Namespace, configuration: Configuration) -> None:
"""
must extract correct args
"""
@@ -87,7 +87,7 @@ def test_extract_arguments(args: argparse.Namespace, configuration: Configuratio
assert list(Web.extract_arguments(probe, configuration)) == expected
def test_extract_arguments_full(parser: argparse.ArgumentParser, configuration: Configuration):
def test_extract_arguments_full(parser: argparse.ArgumentParser, configuration: Configuration) -> None:
"""
must extract all available args except for blacklisted
"""
@@ -13,9 +13,9 @@ def test_info() -> None:
"""
must generate info object for swagger
"""
info = _info()
assert info["title"] == "ahriman"
assert info["version"] == __version__
text = _info()
assert text["title"] == "ahriman"
assert text["version"] == __version__
def test_security() -> None:
+2 -2
View File
@@ -83,7 +83,7 @@ def schema_request(handler: Callable[..., Awaitable[Any]], *, location: str = "j
extract request schema from docs
Args:
handler(Callable[[], Awaitable[Any]]): request handler
handler(Callable[..., Awaitable[Any]]): request handler
location(str, optional): location of the request (Default value = "json")
Returns:
@@ -99,7 +99,7 @@ def schema_response(handler: Callable[..., Awaitable[Any]], *, code: int = 200)
extract response schema from docs
Args:
handler(Callable[[], Awaitable[Any]]): request handler
handler(Callable[..., Awaitable[Any]]): request handler
code(int, optional): return code of the request (Default value = 200)
Returns:
@@ -16,7 +16,7 @@ def authorization_policy(configuration: Configuration, database: SQLite) -> _Aut
database(SQLite): database fixture
Returns:
AuthorizationPolicy: authorization policy fixture
_AuthorizationPolicy: authorization policy fixture
"""
configuration.set_option("auth", "target", "configuration")
validator = Auth.load(configuration, database)
@@ -1,8 +1,8 @@
import logging
import pytest
from unittest.mock import AsyncMock, MagicMock
from typing import Any
from unittest.mock import AsyncMock, MagicMock
from ahriman.web.middlewares.request_id_handler import request_id_handler
@@ -36,7 +36,7 @@ def test_routes_dynamic_not_found(configuration: Configuration, mocker: MockerFi
must disable docs route if no apispec package found
"""
mocker.patch("ahriman.web.views.api.docs.aiohttp_apispec", None)
assert DocsView.routes(configuration) == []
assert not DocsView.routes(configuration)
async def test_get(client: TestClient) -> None:
@@ -106,7 +106,7 @@ def test_routes_dynamic_not_found(configuration: Configuration, mocker: MockerFi
must disable openapi route if no apispec package found
"""
mocker.patch("ahriman.web.views.api.swagger.aiohttp_apispec", None)
assert SwaggerView.routes(configuration) == []
assert not SwaggerView.routes(configuration)
async def test_get(client: TestClient, mocker: MockerFixture) -> None:
@@ -16,4 +16,4 @@ def test_routes_empty(configuration: Configuration) -> None:
"""
StatusViewGuard.ROUTES = ["route1", "route2"]
configuration.set_option("web", "service_only", "yes")
assert StatusViewGuard.routes(configuration) == []
assert not StatusViewGuard.routes(configuration)
@@ -17,7 +17,7 @@ def test_routes() -> None:
"""
must return correct routes
"""
assert BaseView.ROUTES == []
assert not BaseView.ROUTES
def test_configuration(base: BaseView) -> None:
@@ -42,7 +42,7 @@ def test_routes_dynamic_not_found(configuration: Configuration) -> None:
must disable upload route if option is not set
"""
configuration.set_option("web", "enable_archive_upload", "no")
assert UploadView.routes(configuration) == []
assert not UploadView.routes(configuration)
async def test_save_file(mocker: MockerFixture) -> None:
+1 -2
View File
@@ -27,8 +27,7 @@ def _test_path(source_root: Path, source_file: Path) -> Path:
case ("ahriman", "web", "views", *_, source_name):
if source_name.endswith("_guard.py"):
return relative_path.parent / f"test_{source_name}"
else:
return relative_path.parent / f"test_view_{source_name}"
return relative_path.parent / f"test_view_{source_name}"
case (*_, source_name) if source_name.startswith("__"):
return relative_path.parent / f"test_{source_name.replace("__", "")}"
case _:
@@ -206,13 +206,12 @@ class ImportOrder(BaseRawFileChecker):
Args:
node(nodes.Module): module node to check
"""
root_module, *_ = node.qname().split(".")
contexts: dict[tuple[nodes.NodeNG, str], list[nodes.Import | nodes.ImportFrom]] = {}
for statement in self.imports(node.values()):
contexts.setdefault(self.import_context(statement), []).append(statement)
for imports in contexts.values():
self.check_imports(imports, root_module)
self.check_imports(imports, self.linter.config.root_module)
def register(linter: PyLinter) -> None:
@@ -0,0 +1,106 @@
#
# Copyright (c) 2021-2026 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from astroid import nodes
from enum import StrEnum
from pylint.checkers import BaseChecker
from pylint.lint import PyLinter
class MethodType(StrEnum):
"""
method type enumeration
Attributes:
CLASS_METHOD(MethodType): (class attribute) class method
METHOD(MethodType): (class attribute) instance method
"""
CLASS_METHOD = "classmethod"
METHOD = "method"
class TypeAnnotations(BaseChecker):
"""
require explicit annotations on function parameters and return values
"""
msgs = {
"E5301": (
"Missing type annotation for parameter %s",
"missing-parameter-annotation",
"Function parameters must have explicit type annotations, except method receivers.",
),
"E5302": (
"Missing return type annotation for function %s",
"missing-return-annotation",
"Functions must have explicit return annotations, including constructors and local functions.",
),
}
name = "type-annotations"
def visit_asyncfunctiondef(self, node: nodes.AsyncFunctionDef) -> None:
"""
check an asynchronous function signature
Args:
node(nodes.AsyncFunctionDef): function to check
"""
self.visit_functiondef(node)
def visit_functiondef(self, node: nodes.FunctionDef) -> None:
"""
check a function signature
Args:
node(nodes.FunctionDef): function to check
"""
args = node.args
arguments = [*args.posonlyargs, *args.args, *args.kwonlyargs]
annotations = [*args.posonlyargs_annotations, *args.annotations, *args.kwonlyargs_annotations]
# remove receiver argument
if arguments:
match node.type:
case MethodType.CLASS_METHOD | MethodType.METHOD:
arguments.pop(0)
annotations.pop(0)
for argument, annotation in zip(arguments, annotations):
if annotation is None:
self.add_message("missing-parameter-annotation", node=argument, args=(argument.name,))
for name, annotation in (
(args.vararg, args.varargannotation),
(args.kwarg, args.kwargannotation),
):
if name is not None and annotation is None:
self.add_message("missing-parameter-annotation", node=node, args=(name,))
if node.returns is None:
self.add_message("missing-return-annotation", node=node, args=(node.name,))
def register(linter: PyLinter) -> None:
"""
register custom checker
Args:
linter(PyLinter): linter in which checker should be registered
"""
linter.register_checker(TypeAnnotations(linter))
+26
View File
@@ -148,6 +148,31 @@ commands = [
{ replace = "ref", of = ["flags", "pylint"], extend = true },
"{[project]name}",
],
[
"pylint",
{ replace = "ref", of = ["flags", "pylint"], extend = true },
"--disable",
"""broad-exception-raised,\
consider-using-f-string,\
consider-using-from-import,\
import-error,\
methods-out-of-order,\
no-member,\
protected-access,\
redefined-outer-name,\
too-many-lines,\
too-many-locals,\
too-many-return-statements,\
unnecessary-dunder-call,\
unused-wildcard-import,\
wildcard-import""",
"--recursive",
"y",
"ahriman-core/tests/{[project]name}",
"ahriman-triggers/tests/{[project]name}",
"ahriman-web/tests/{[project]name}",
"tests",
],
[
"bandit",
{ replace = "ref", of = ["flags", "bandit"], extend = true },
@@ -165,6 +190,7 @@ commands = [
"ahriman-core/tests/{[project]name}",
"ahriman-triggers/tests/{[project]name}",
"ahriman-web/tests/{[project]name}",
"tests",
],
[
"mypy",