diff --git a/ahriman-core/src/ahriman/application/application/application.py b/ahriman-core/src/ahriman/application/application/application.py index 7ac4ea62..eb35979e 100644 --- a/ahriman-core/src/ahriman/application/application/application.py +++ b/ahriman-core/src/ahriman/application/application/application.py @@ -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) diff --git a/ahriman-core/src/ahriman/application/application/updates_iterator.py b/ahriman-core/src/ahriman/application/application/updates_iterator.py index 2e0b2cb3..afc4c54d 100644 --- a/ahriman-core/src/ahriman/application/application/updates_iterator.py +++ b/ahriman-core/src/ahriman/application/application/updates_iterator.py @@ -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) diff --git a/ahriman-core/src/ahriman/application/handlers/statistics.py b/ahriman-core/src/ahriman/application/handlers/statistics.py index 8bc8dd73..ccd644f5 100644 --- a/ahriman-core/src/ahriman/application/handlers/statistics.py +++ b/ahriman-core/src/ahriman/application/handlers/statistics.py @@ -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 = { diff --git a/ahriman-core/src/ahriman/application/handlers/unsafe_commands.py b/ahriman-core/src/ahriman/application/handlers/unsafe_commands.py index 687f8d8b..5904bbb5 100644 --- a/ahriman-core/src/ahriman/application/handlers/unsafe_commands.py +++ b/ahriman-core/src/ahriman/application/handlers/unsafe_commands.py @@ -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 """ diff --git a/ahriman-core/src/ahriman/core/__init__.py b/ahriman-core/src/ahriman/core/__init__.py index 83a938e4..c0341500 100644 --- a/ahriman-core/src/ahriman/core/__init__.py +++ b/ahriman-core/src/ahriman/core/__init__.py @@ -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) diff --git a/ahriman-core/src/ahriman/core/configuration/configuration.py b/ahriman-core/src/ahriman/core/configuration/configuration.py index 7090c924..0d9038c1 100644 --- a/ahriman-core/src/ahriman/core/configuration/configuration.py +++ b/ahriman-core/src/ahriman/core/configuration/configuration.py @@ -134,7 +134,7 @@ class Configuration(configparser.RawConfigParser): repository identifier Returns: - RepositoryId: repository unique identifier + RepositoryId | None: repository unique identifier """ return self._repository_id diff --git a/ahriman-core/src/ahriman/core/database/migrations/__init__.py b/ahriman-core/src/ahriman/core/database/migrations/__init__.py index 700a7d21..c5c61167 100644 --- a/ahriman-core/src/ahriman/core/database/migrations/__init__.py +++ b/ahriman-core/src/ahriman/core/database/migrations/__init__.py @@ -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() diff --git a/ahriman-core/src/ahriman/core/database/operations/build_operations.py b/ahriman-core/src/ahriman/core/database/operations/build_operations.py index 32564697..b086df38 100644 --- a/ahriman-core/src/ahriman/core/database/operations/build_operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/build_operations.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/database/operations/changes_operations.py b/ahriman-core/src/ahriman/core/database/operations/changes_operations.py index 8ce16333..d760f4ee 100644 --- a/ahriman-core/src/ahriman/core/database/operations/changes_operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/changes_operations.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/database/operations/dependencies_operations.py b/ahriman-core/src/ahriman/core/database/operations/dependencies_operations.py index dbdb2064..ae1d3072 100644 --- a/ahriman-core/src/ahriman/core/database/operations/dependencies_operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/dependencies_operations.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/database/operations/event_operations.py b/ahriman-core/src/ahriman/core/database/operations/event_operations.py index 5cb39293..5627b7e1 100644 --- a/ahriman-core/src/ahriman/core/database/operations/event_operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/event_operations.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/database/operations/logs_operations.py b/ahriman-core/src/ahriman/core/database/operations/logs_operations.py index e48791e8..f27537a5 100644 --- a/ahriman-core/src/ahriman/core/database/operations/logs_operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/logs_operations.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/database/operations/operations.py b/ahriman-core/src/ahriman/core/database/operations/operations.py index 313f56de..38a49d9e 100644 --- a/ahriman-core/src/ahriman/core/database/operations/operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/operations.py @@ -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: diff --git a/ahriman-core/src/ahriman/core/database/operations/package_operations.py b/ahriman-core/src/ahriman/core/database/operations/package_operations.py index a1371a12..91b24dde 100644 --- a/ahriman-core/src/ahriman/core/database/operations/package_operations.py +++ b/ahriman-core/src/ahriman/core/database/operations/package_operations.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/database/sqlite.py b/ahriman-core/src/ahriman/core/database/sqlite.py index e649dc38..2aac8930 100644 --- a/ahriman-core/src/ahriman/core/database/sqlite.py +++ b/ahriman-core/src/ahriman/core/database/sqlite.py @@ -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:: diff --git a/ahriman-core/src/ahriman/core/exceptions.py b/ahriman-core/src/ahriman/core/exceptions.py index a10f46f3..b1c0dec5 100644 --- a/ahriman-core/src/ahriman/core/exceptions.py +++ b/ahriman-core/src/ahriman/core/exceptions.py @@ -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}") diff --git a/ahriman-core/src/ahriman/core/formatters/repository_stats_printer.py b/ahriman-core/src/ahriman/core/formatters/repository_stats_printer.py index a9267112..400fd79f 100644 --- a/ahriman-core/src/ahriman/core/formatters/repository_stats_printer.py +++ b/ahriman-core/src/ahriman/core/formatters/repository_stats_printer.py @@ -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)) diff --git a/ahriman-core/src/ahriman/core/formatters/update_printer.py b/ahriman-core/src/ahriman/core/formatters/update_printer.py index 0bf48635..3e7ef8ad 100644 --- a/ahriman-core/src/ahriman/core/formatters/update_printer.py +++ b/ahriman-core/src/ahriman/core/formatters/update_printer.py @@ -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 """ diff --git a/ahriman-core/src/ahriman/core/http/sync_http_client.py b/ahriman-core/src/ahriman/core/http/sync_http_client.py index 6c6f5057..3b3e245d 100644 --- a/ahriman-core/src/ahriman/core/http/sync_http_client.py +++ b/ahriman-core/src/ahriman/core/http/sync_http_client.py @@ -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() diff --git a/ahriman-core/src/ahriman/core/report/jinja_template.py b/ahriman-core/src/ahriman/core/report/jinja_template.py index ce4a4040..8bd71d0b 100644 --- a/ahriman-core/src/ahriman/core/report/jinja_template.py +++ b/ahriman-core/src/ahriman/core/report/jinja_template.py @@ -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): diff --git a/ahriman-core/src/ahriman/core/report/rss.py b/ahriman-core/src/ahriman/core/report/rss.py index 48433d1b..92c1bd70 100644 --- a/ahriman-core/src/ahriman/core/report/rss.py +++ b/ahriman-core/src/ahriman/core/report/rss.py @@ -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"]) diff --git a/ahriman-core/src/ahriman/core/repository/repository_properties.py b/ahriman-core/src/ahriman/core/repository/repository_properties.py index 53e82de0..93bad0fd 100644 --- a/ahriman-core/src/ahriman/core/repository/repository_properties.py +++ b/ahriman-core/src/ahriman/core/repository/repository_properties.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/sign/gpg.py b/ahriman-core/src/ahriman/core/sign/gpg.py index 2ecbc4c3..bbba2254 100644 --- a/ahriman-core/src/ahriman/core/sign/gpg.py +++ b/ahriman-core/src/ahriman/core/sign/gpg.py @@ -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" diff --git a/ahriman-core/src/ahriman/core/status/client.py b/ahriman-core/src/ahriman/core/status/client.py index 1539f8bc..aa9228e6 100644 --- a/ahriman-core/src/ahriman/core/status/client.py +++ b/ahriman-core/src/ahriman/core/status/client.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/status/local_client.py b/ahriman-core/src/ahriman/core/status/local_client.py index 1a4e7d26..82370ce2 100644 --- a/ahriman-core/src/ahriman/core/status/local_client.py +++ b/ahriman-core/src/ahriman/core/status/local_client.py @@ -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()) diff --git a/ahriman-core/src/ahriman/core/status/watcher.py b/ahriman-core/src/ahriman/core/status/watcher.py index 13b1df38..485a8dde 100644 --- a/ahriman-core/src/ahriman/core/status/watcher.py +++ b/ahriman-core/src/ahriman/core/status/watcher.py @@ -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) diff --git a/ahriman-core/src/ahriman/core/status/web_client.py b/ahriman-core/src/ahriman/core/status/web_client.py index 83b9dfb9..6e6d2bf4 100644 --- a/ahriman-core/src/ahriman/core/status/web_client.py +++ b/ahriman-core/src/ahriman/core/status/web_client.py @@ -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), diff --git a/ahriman-core/src/ahriman/core/upload/remote_service.py b/ahriman-core/src/ahriman/core/upload/remote_service.py index e43d1945..31b4bb5a 100644 --- a/ahriman-core/src/ahriman/core/upload/remote_service.py +++ b/ahriman-core/src/ahriman/core/upload/remote_service.py @@ -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 diff --git a/ahriman-core/src/ahriman/core/utils.py b/ahriman-core/src/ahriman/core/utils.py index cd782ea6..a85a7ee4 100644 --- a/ahriman-core/src/ahriman/core/utils.py +++ b/ahriman-core/src/ahriman/core/utils.py @@ -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) diff --git a/ahriman-core/src/ahriman/models/aur_package.py b/ahriman-core/src/ahriman/models/aur_package.py index cfe60386..ef70afcf 100644 --- a/ahriman-core/src/ahriman/models/aur_package.py +++ b/ahriman-core/src/ahriman/models/aur_package.py @@ -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 """ diff --git a/ahriman-core/src/ahriman/models/build_plan.py b/ahriman-core/src/ahriman/models/build_plan.py index d962a047..3a927fc7 100644 --- a/ahriman-core/src/ahriman/models/build_plan.py +++ b/ahriman-core/src/ahriman/models/build_plan.py @@ -182,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) diff --git a/ahriman-core/src/ahriman/models/filesystem_package.py b/ahriman-core/src/ahriman/models/filesystem_package.py index d4af0fcc..e4abd218 100644 --- a/ahriman-core/src/ahriman/models/filesystem_package.py +++ b/ahriman-core/src/ahriman/models/filesystem_package.py @@ -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 diff --git a/ahriman-core/src/ahriman/models/metrics_timer.py b/ahriman-core/src/ahriman/models/metrics_timer.py index ca16ef2c..4ebe86ff 100644 --- a/ahriman-core/src/ahriman/models/metrics_timer.py +++ b/ahriman-core/src/ahriman/models/metrics_timer.py @@ -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: diff --git a/ahriman-core/src/ahriman/models/package.py b/ahriman-core/src/ahriman/models/package.py index e776c86f..20f04433 100644 --- a/ahriman-core/src/ahriman/models/package.py +++ b/ahriman-core/src/ahriman/models/package.py @@ -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). diff --git a/ahriman-core/src/ahriman/models/package_description.py b/ahriman-core/src/ahriman/models/package_description.py index 15a90050..91dffaf7 100644 --- a/ahriman-core/src/ahriman/models/package_description.py +++ b/ahriman-core/src/ahriman/models/package_description.py @@ -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")) """ diff --git a/ahriman-core/src/ahriman/models/packagers.py b/ahriman-core/src/ahriman/models/packagers.py index 14109665..b66f84d8 100644 --- a/ahriman-core/src/ahriman/models/packagers.py +++ b/ahriman-core/src/ahriman/models/packagers.py @@ -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 diff --git a/ahriman-core/src/ahriman/models/pkgbuild_patch.py b/ahriman-core/src/ahriman/models/pkgbuild_patch.py index ab3f4f4c..7ffe9535 100644 --- a/ahriman-core/src/ahriman/models/pkgbuild_patch.py +++ b/ahriman-core/src/ahriman/models/pkgbuild_patch.py @@ -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 diff --git a/ahriman-core/src/ahriman/models/repository_stats.py b/ahriman-core/src/ahriman/models/repository_stats.py index 46065a57..fc6ac4ea 100644 --- a/ahriman-core/src/ahriman/models/repository_stats.py +++ b/ahriman-core/src/ahriman/models/repository_stats.py @@ -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 diff --git a/ahriman-core/src/ahriman/models/scan_paths.py b/ahriman-core/src/ahriman/models/scan_paths.py index 6c5d3c5a..f168f63b 100644 --- a/ahriman-core/src/ahriman/models/scan_paths.py +++ b/ahriman-core/src/ahriman/models/scan_paths.py @@ -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] diff --git a/ahriman-core/tests/ahriman/core/alpm/conftest.py b/ahriman-core/tests/ahriman/core/alpm/conftest.py index 5a7af0a2..8331b976 100644 --- a/ahriman-core/tests/ahriman/core/alpm/conftest.py +++ b/ahriman-core/tests/ahriman/core/alpm/conftest.py @@ -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) diff --git a/ahriman-web/src/ahriman/web/apispec/decorators.py b/ahriman-web/src/ahriman/web/apispec/decorators.py index 1e667463..6587c7f3 100644 --- a/ahriman-web/src/ahriman/web/apispec/decorators.py +++ b/ahriman-web/src/ahriman/web/apispec/decorators.py @@ -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) diff --git a/ahriman-web/src/ahriman/web/middlewares/auth_handler.py b/ahriman-web/src/ahriman/web/middlewares/auth_handler.py index b0d8321a..40eb21ad 100644 --- a/ahriman-web/src/ahriman/web/middlewares/auth_handler.py +++ b/ahriman-web/src/ahriman/web/middlewares/auth_handler.py @@ -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 diff --git a/ahriman-web/tests/ahriman/web/conftest.py b/ahriman-web/tests/ahriman/web/conftest.py index dbc2868a..dfc1799c 100644 --- a/ahriman-web/tests/ahriman/web/conftest.py +++ b/ahriman-web/tests/ahriman/web/conftest.py @@ -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: diff --git a/ahriman-web/tests/ahriman/web/middlewares/conftest.py b/ahriman-web/tests/ahriman/web/middlewares/conftest.py index 02779cff..2b933691 100644 --- a/ahriman-web/tests/ahriman/web/middlewares/conftest.py +++ b/ahriman-web/tests/ahriman/web/middlewares/conftest.py @@ -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) diff --git a/tools/pylint_plugins/type_annotations/__init__.py b/tools/pylint_plugins/type_annotations/__init__.py index f3de974f..f6ae55cc 100644 --- a/tools/pylint_plugins/type_annotations/__init__.py +++ b/tools/pylint_plugins/type_annotations/__init__.py @@ -29,7 +29,7 @@ class MethodType(StrEnum): Attributes: CLASS_METHOD(MethodType): (class attribute) class method - METHOD(MethodType): (class attribute) class method + METHOD(MethodType): (class attribute) instance method """ CLASS_METHOD = "classmethod" METHOD = "method"