style: fix some typos and warnings

docs/advanced-usage/handlers.rst

@@ -44,7 +44,7 @@ The main functionality of the class is already described, but command is still n
 
        arguments = set_parser
 
-In addition, ``ahriman.application.handlers.handler.Handler.ALLOW_MULTI_ARCHITECTURE_RUN`` can be set to ``False`` in order to disable multiprocess run (e.g. in case if there are conflicting operations, like writting to stdout).
+In addition, ``ahriman.application.handlers.handler.Handler.ALLOW_MULTI_ARCHITECTURE_RUN`` can be set to ``False`` in order to disable multiprocess run (e.g. in case if there are conflicting operations, like writing to stdout).
 
 Save the file above as ``/usr/lib/python3.12/site-packages/ahriman/application/handlers/help_web.py`` (replace ``python3.12`` with actual python version) and you are set.
 

docs/architecture.rst

@@ -394,7 +394,7 @@ All extracted fields are packed as ``ahriman.models.pkgbuild_patch.PkgbuildPatch
 
 The PKGBUILD class also provides some additional functions on top of that:
 
-* Ability to extract fields defined inside ``package*()`` functions, which are in particular used for the multipackages.
+* Ability to extract fields defined inside ``package*()`` functions, which are in particular used for the multi-packages.
 * Shell substitution, which supports constructions ``$var`` (including ``${var}``), ``${var#(#)pattern}``, ``${var%(%)pattern}`` and ``${var/(/)pattern/replacement}`` (including ``#pattern`` and ``%pattern``).
 
 Additional features

docs/faq/docker.rst

@@ -97,7 +97,7 @@ Otherwise, you would need to pass ``AHRIMAN_PORT`` and mount container network t
 
 Simple server with authentication can be found in `examples <https://github.com/arcan1s/ahriman/tree/master/recipes/web>`__ too.
 
-Mutli-repository web service
+Multi-repository web service
 """"""""""""""""""""""""""""
 
 Idea is pretty same as to just run web service. However, it is required to run setup commands for each repository, except for one which is specified by ``AHRIMAN_REPOSITORY`` and ``AHRIMAN_ARCHITECTURE`` variables.

docs/migrations/2.16.0.rst

@@ -3,7 +3,7 @@ To 2.16.0
 
 This release replaces ``passlib`` dependency with ``bcrypt``.
 
-The reason behind this change is that python developers have deprecated and scheduled for removal ``crypt`` module, which is used by ``passlib``. (By the way, they recommend to use ``passlib`` as a replacement.) Unfortunately, it appears that ``passlib`` is unmaintained (see `the issue <https://foss.heptapod.net/python-libs/passlib/-/issues/187>`__), so the only solution is to migrate to anoher library.
+The reason behind this change is that python developers have deprecated and scheduled for removal ``crypt`` module, which is used by ``passlib``. (By the way, they recommend to use ``passlib`` as a replacement.) Unfortunately, it appears that ``passlib`` is unmaintained (see `the issue <https://foss.heptapod.net/python-libs/passlib/-/issues/187>`__), so the only solution is to migrate to another library.
 
 Because passwords are stored as hashes, it is near to impossible to shadow change passwords in database, the manual intervention is required if:
 

src/ahriman/application/handlers/setup.py

@@ -21,7 +21,7 @@ import argparse
 
 from pathlib import Path
 from pwd import getpwuid
-from urllib.parse import quote_plus as urlencode
+from urllib.parse import quote_plus as url_encode
 
 from ahriman.application.application import Application
 from ahriman.application.handlers.handler import Handler, SubParserAction
@@ -174,7 +174,7 @@ class Setup(Handler):
         if args.web_unix_socket is not None:
             unix_socket = str(args.web_unix_socket)
             configuration.set_option("web", "unix_socket", unix_socket)
-            configuration.set_option("status", "address", f"http+unix://{urlencode(unix_socket)}")
+            configuration.set_option("status", "address", f"http+unix://{url_encode(unix_socket)}")
 
         if args.generate_salt:
             configuration.set_option("auth", "salt", User.generate_password(20))

src/ahriman/core/alpm/pkgbuild_parser.py

@@ -146,7 +146,7 @@ class PkgbuildParser(shlex.shlex):
                     # reset state
                     buffer, prefix = [], None
 
-                # we have already prefix string, so we are in progress of expansion
+                # we have already got prefix string, so we are in progress of expansion
                 # we always operate the last element, so this matches ",", "next"
                 case (PkgbuildToken.Comma, _) if prefix is not None:
                     buffer.append(f"{prefix}{second}")
@@ -168,7 +168,7 @@ class PkgbuildParser(shlex.shlex):
     def _is_escaped(self) -> bool:
         """
         check if the last element was quoted. ``shlex.shlex`` parser doesn't provide information about was the token
-        quoted or not, thus there is no difference between "'#'" (diez in quotes) and "#" (diez without quotes). This
+        quoted or not, thus there is no difference between "'#'" (sharp in quotes) and "#" (sharp without quotes). This
         method simply rolls back to the last non-space character and check if it is a quotation mark
 
         Returns:

src/ahriman/core/formatters/event_stats_printer.py

@@ -58,8 +58,8 @@ class EventStatsPrinter(StringPrinter):
             mean = statistics.mean(self.events)
 
             if len(self.events) > 1:
-                stdev = statistics.stdev(self.events)
-                average = f"{mean:.3f} ± {stdev:.3f}"
+                st_dev = statistics.stdev(self.events)
+                average = f"{mean:.3f} ± {st_dev:.3f}"
             else:
                 average = f"{mean:.3f}"
 

src/ahriman/core/status/web_client.py

@@ -19,7 +19,7 @@
 #
 import contextlib
 
-from urllib.parse import quote_plus as urlencode
+from urllib.parse import quote_plus as url_encode
 
 from ahriman.core.configuration import Configuration
 from ahriman.core.http import SyncAhrimanClient
@@ -75,7 +75,7 @@ class WebClient(Client, SyncAhrimanClient):
         # legacy-style section
         if (unix_socket := configuration.get("web", "unix_socket", fallback=None)) is not None:
             # special pseudo-protocol which is used for unix sockets
-            return "web", f"http+unix://{urlencode(unix_socket)}"
+            return "web", f"http+unix://{url_encode(unix_socket)}"
         address = configuration.get("web", "address", fallback=None)
         if not address:
             # build address from host and port directly
@@ -94,7 +94,7 @@ class WebClient(Client, SyncAhrimanClient):
         Returns:
             str: full url for web service for changes
         """
-        return f"{self.address}/api/v1/packages/{urlencode(package_base)}/changes"
+        return f"{self.address}/api/v1/packages/{url_encode(package_base)}/changes"
 
     def _dependencies_url(self, package_base: str) -> str:
         """
@@ -106,7 +106,7 @@ class WebClient(Client, SyncAhrimanClient):
         Returns:
             str: full url for web service for dependencies
         """
-        return f"{self.address}/api/v1/packages/{urlencode(package_base)}/dependencies"
+        return f"{self.address}/api/v1/packages/{url_encode(package_base)}/dependencies"
 
     def _events_url(self) -> str:
         """
@@ -127,7 +127,7 @@ class WebClient(Client, SyncAhrimanClient):
         Returns:
             str: full url for web service for logs
         """
-        return f"{self.address}/api/v1/packages/{urlencode(package_base)}/logs"
+        return f"{self.address}/api/v1/packages/{url_encode(package_base)}/logs"
 
     def _package_url(self, package_base: str = "") -> str:
         """
@@ -139,7 +139,7 @@ class WebClient(Client, SyncAhrimanClient):
         Returns:
             str: full url of web service for specific package base
         """
-        suffix = f"/{urlencode(package_base)}" if package_base else ""
+        suffix = f"/{url_encode(package_base)}" if package_base else ""
         return f"{self.address}/api/v1/packages{suffix}"
 
     def _patches_url(self, package_base: str, variable: str = "") -> str:
@@ -153,8 +153,8 @@ class WebClient(Client, SyncAhrimanClient):
         Returns:
             str: full url of web service for the package patch
         """
-        suffix = f"/{urlencode(variable)}" if variable else ""
-        return f"{self.address}/api/v1/packages/{urlencode(package_base)}/patches{suffix}"
+        suffix = f"/{url_encode(variable)}" if variable else ""
+        return f"{self.address}/api/v1/packages/{url_encode(package_base)}/patches{suffix}"
 
     def _status_url(self) -> str:
         """

src/ahriman/models/pkgbuild.py

@@ -107,8 +107,8 @@ class Pkgbuild(Mapping[str, Any]):
 
     def __getitem__(self, item: str) -> Any:
         """
-        get the field of the PKGBUILD. This method tries to get exact key value if possible; if none found, it tries to
-        fetch function with the same name
+        get the field of the PKGBUILD. This method tries to get exact key value if possible; if none was found,
+        it tries to fetch function with the same name
 
         Args:
             item(str): key name

tests/ahriman/application/handlers/test_handler_copy.py

@@ -53,7 +53,7 @@ def test_run(args: argparse.Namespace, configuration: Configuration, repository:
 def test_run_remove(args: argparse.Namespace, configuration: Configuration, repository: Repository,
                     package_ahriman: Package, mocker: MockerFixture) -> None:
     """
-    must run command and remove packages afterwards
+    must run command and remove packages afterward
     """
     args = _default_args(args)
     args.remove = True

tests/ahriman/application/handlers/test_handler_rebuild.py

@@ -191,7 +191,7 @@ def test_extract_packages_by_status(application: Application, mocker: MockerFixt
 
 def test_extract_packages_from_database(application: Application, mocker: MockerFixture) -> None:
     """
-    must extract packages from database from database
+    must extract packages from database
     """
     packages_mock = mocker.patch("ahriman.core.database.SQLite.packages_get")
     Rebuild.extract_packages(application, None, from_database=True)

tests/ahriman/application/handlers/test_handler_setup.py

@@ -5,7 +5,7 @@ from pathlib import Path
 from pytest_mock import MockerFixture
 from typing import Any
 from unittest.mock import call as MockCall
-from urllib.parse import quote_plus as urlencode
+from urllib.parse import quote_plus as url_encode
 
 from ahriman.application.handlers.setup import Setup
 from ahriman.core.configuration import Configuration
@@ -148,7 +148,7 @@ def test_configuration_create_ahriman(args: argparse.Namespace, configuration: C
         MockCall("web", "port", str(args.web_port)),
         MockCall("status", "address", f"http://127.0.0.1:{str(args.web_port)}"),
         MockCall("web", "unix_socket", str(args.web_unix_socket)),
-        MockCall("status", "address", f"http+unix://{urlencode(str(args.web_unix_socket))}"),
+        MockCall("status", "address", f"http+unix://{url_encode(str(args.web_unix_socket))}"),
         MockCall("auth", "salt", pytest.helpers.anyvar(str, strict=True)),
     ])
     write_mock.assert_called_once_with(pytest.helpers.anyvar(int))

tests/ahriman/application/test_ahriman.py

@@ -392,7 +392,7 @@ def test_subparsers_package_status_update(parser: argparse.ArgumentParser) -> No
 
 def test_subparsers_package_status_update_option_status(parser: argparse.ArgumentParser) -> None:
     """
-    package-status-update command must convert status option to buildstatusenum instance
+    package-status-update command must convert status option to BuildStatusEnum instance
     """
     args = parser.parse_args(["-a", "x86_64", "-r", "repo", "package-status-update"])
     assert isinstance(args.status, BuildStatusEnum)

tests/ahriman/application/test_lock.py

@@ -115,7 +115,7 @@ def test_write_skip(lock: Lock) -> None:
 
 def test_write_locked(lock: Lock, mocker: MockerFixture) -> None:
     """
-    must raise DuplicateRunError if cannot lock file
+    must raise DuplicateRunError if it cannot lock file
     """
     mocker.patch("ahriman.application.lock.Lock.perform_lock", return_value=False)
     with pytest.raises(DuplicateRunError):

tests/ahriman/conftest.py

@@ -287,6 +287,7 @@ def local_client(database: SQLite, configuration: Configuration) -> Client:
 
     Args:
         database(SQLite): database fixture
+        configuration(Configuration): configuration fixture
 
     Returns:
         Client: local status client test instance

tests/ahriman/core/auth/test_pam.py

@@ -77,7 +77,7 @@ async def test_known_username(pam: PAM, user: User, mocker: MockerFixture) -> No
 
 async def test_known_username_mapping(pam: PAM, user: User, mocker: MockerFixture) -> None:
     """
-    must fallback to username checking to database if no user found in system
+    must fall back to username checking to database if no user found in system
     """
     mocker.patch("ahriman.core.auth.pam.getpwnam", side_effect=KeyError)
     mapping_mock = mocker.patch("ahriman.core.auth.mapping.Mapping.known_username")

tests/ahriman/core/repository/test_executor.py

@@ -32,6 +32,7 @@ def test_process_build(executor: Executor, package_ahriman: Package, passwd: Any
 
     executor.process_build([package_ahriman], Packagers("packager"), bump_pkgrel=False)
     init_mock.assert_called_once_with(pytest.helpers.anyvar(int), pytest.helpers.anyvar(int), None)
+    changes_mock.assert_called_once_with(package_ahriman.base)
     depends_on_mock.assert_called_once_with()
     dependencies_mock.assert_called_once_with(package_ahriman.base, Dependencies())
     # must move files (once)

tests/ahriman/core/status/test_web_client.py

@@ -136,7 +136,7 @@ def test_event_add_failed_http_error(web_client: WebClient, mocker: MockerFixtur
 
 def test_event_add_failed_suppress(web_client: WebClient, mocker: MockerFixture) -> None:
     """
-    must suppress any exception happened during events creaton and don't log
+    must suppress any exception happened during events creation and don't log
     """
     web_client.suppress_errors = True
     mocker.patch("requests.Session.request", side_effect=Exception())

tests/ahriman/models/test_scan_paths.py

@@ -5,7 +5,7 @@ from ahriman.models.scan_paths import ScanPaths
 
 def test_is_allowed() -> None:
     """
-    must check if path is subpath of one in allowed list
+    must check if path is sub-path of one in allowed list
     """
     assert ScanPaths(["usr"]).is_allowed(Path("usr"))
     assert ScanPaths(["usr"]).is_allowed(Path("usr") / "lib")

tests/ahriman/web/views/test_view_base.py

@@ -252,6 +252,6 @@ async def test_username_request(base: BaseView) -> None:
 
 async def test_username_request_exception(base: BaseView) -> None:
     """
-    must not fail in case if cannot read request
+    must not fail in case if it cannot read request
     """
     assert await base.username() is None