wip

Author: MHajoha

questionpy_common/manifest.py

@@ -3,11 +3,22 @@
 #  (c) Technische Universität Berlin, innoCampus <info@isis.tu-berlin.de>
 
 from abc import ABC
+from collections.abc import MutableMapping
 from enum import StrEnum
 from keyword import iskeyword, issoftkeyword
 from typing import Annotated, Literal, NewType
 
-from pydantic import AfterValidator, BaseModel, ByteSize, PositiveInt, StringConstraints, conset, field_validator
+from pydantic import (
+    AfterValidator,
+    BaseModel,
+    ByteSize,
+    PositiveInt,
+    StringConstraints,
+    computed_field,
+    conset,
+    field_validator,
+    model_validator,
+)
 from pydantic.fields import Field
 
 from questionpy_common import PackageNamespaceAndShortName
@@ -135,14 +146,19 @@ class PackageFile(BaseModel):
     mime_type: str | None
     size: int
 
-
 class DistStaticQPyDependency(BaseModel):
-    dir_name: str
-    """Name (without `dist/dependencies/qpy/`) of the directory the dependency package contents reside in."""
+    namespace: Annotated[str, AfterValidator(ensure_is_valid_name)]
+    short_name: Annotated[str, AfterValidator(ensure_is_valid_name)]
+    version: Annotated[str, Field(pattern=RE_SEMVER)]
+
+    dependencies: "DistDependencies"
+    """Transitive dependencies of this dependency."""
+
     hash: str
     """Hash of the ZIP package whose contents lie in `dir_name`."""
 
 
+
 type DependencyLockStrategy = Literal["required", "preferred-no-downgrade", "preferred-allow-downgrade"]
 
 
@@ -158,9 +174,6 @@ class AbstractDynamicQPyDependency(BaseModel, ABC):
     version: QPyDependencyVersionSpecifier | None = None
     include_prereleases: bool = False
 
-    def to_specifier_str(self) -> str:
-        return f"@{self.namespace}/{self.short_name}{" " + str(self.version) if self.version else ""}"
-
 
 class DistDynamicQPyDependency(AbstractDynamicQPyDependency):
     locked: LockedDependencyInfo | None = None

questionpy_common/version_specifiers.py

@@ -1,4 +1,5 @@
 import re
+from collections.abc import Iterable
 from dataclasses import dataclass
 from typing import Any, Literal, Protocol, Self
 
@@ -81,7 +82,7 @@ def from_string(cls, string: str) -> Self:
             operator = next(filter(string.startswith, _OPERATORS), None)
             if operator:
                 version_string = string.removeprefix(operator).lstrip()
-                if not _SEMVER_PATTERN.match(string):
+                if not _SEMVER_PATTERN.match(version_string):
                     msg = f"Comparison version '{version_string}' of clause '{string}' does not conform to SemVer."
                     raise ValueError(msg)
 
@@ -91,7 +92,7 @@ def from_string(cls, string: str) -> Self:
                 if not _SEMVER_PATTERN.match(string):
                     msg = (
                         f"Version specifier clause '{string}' does not start with a valid operator and isn't a "
-                        f"version itself. Valid operators are {', '.join(_OPERATORS)}."
+                        f"version itself. Valid operators are {", ".join(_OPERATORS)}."
                     )
                     raise ValueError(msg)
 
@@ -103,10 +104,18 @@ def from_string(cls, string: str) -> Self:
         def __str__(self) -> str:
             return f"{self.operator} {self.operand}"
 
-    clauses: tuple[Clause, ...]
+    # Dict because we want to preserve order (for readability) but not compare order or allow dupes.
+    _clauses: dict[Clause, None]
+
+    def __init__(self, clauses: Iterable[Clause]) -> None:
+        super().__setattr__("_clauses", dict.fromkeys(clauses))
+
+    @property
+    def clauses(self) -> tuple[Clause, ...]:
+        return tuple(self._clauses)
 
     def __str__(self) -> str:
-        return ", ".join(map(str, self.clauses))
+        return ", ".join(map(str, self._clauses))
 
     @classmethod
     def from_string(cls, string: str) -> Self:
@@ -116,7 +125,7 @@ def from_string(cls, string: str) -> Self:
 
     def allows(self, version: VersionProtocol) -> bool:
         """Checks if _all_ clauses allow the given version."""
-        return all(clause.allows(version) for clause in self.clauses)
+        return all(clause.allows(version) for clause in self._clauses)
 
     @classmethod
     def __get_pydantic_core_schema__(cls, source_type: Any, handler: GetCoreSchemaHandler) -> CoreSchema:

questionpy_server/repository/__init__.py

@@ -16,9 +16,11 @@
 _SCHEME_AND_AUTH_PATTERN = re.compile(r"^https?://(?:[^/@]+@)?")
 _FILENAME_SPECIAL_CHARACTERS_PATTERN = re.compile(r"[/\\?%*:|\"<>,;=\s]+")
 
+
 def _url_to_safe_path_part(url: str) -> str:
     return _FILENAME_SPECIAL_CHARACTERS_PATTERN.sub("-", _SCHEME_AND_AUTH_PATTERN.sub("", url))
 
+
 class Repository:
     def __init__(self, url: str, cache: FileCache):
         self._url_base = url

questionpy_server/utils/logger.py

@@ -10,5 +10,5 @@
 class URLAdapter(logging.LoggerAdapter):
     def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, MutableMapping[str, Any]]:
         if self.extra and "url" in self.extra:
-            return f"({self.extra['url']}): {msg}", kwargs
+            return f"({self.extra["url"]}): {msg}", kwargs
         return msg, kwargs

questionpy_server/worker/runtime/manager.py

@@ -11,6 +11,7 @@
 from types import MappingProxyType
 from typing import TYPE_CHECKING, NoReturn, TypeVar, cast
 
+from questionpy_common import PackageNamespaceAndShortName
 from questionpy_common.constants import MAX_QPY_DEPENDENCY_LEVELS
 from questionpy_common.environment import (
     Environment,
@@ -21,7 +22,6 @@
     RequestInfo,
     set_qpy_environment,
 )
-from questionpy_common import PackageNamespaceAndShortName
 from questionpy_common.manifest import PackageType
 from questionpy_server.worker.runtime.connection import WorkerToServerConnection
 from questionpy_server.worker.runtime.messages import (

questionpy_server/worker/runtime/messages.py

@@ -10,12 +10,12 @@
 
 from pydantic import BaseModel, JsonValue
 
+from questionpy_common import PackageNamespaceAndShortName
 from questionpy_common.api.attempt import AttemptModel, AttemptScoredModel, AttemptStartedModel
 from questionpy_common.api.qtype import InvalidQuestionStateError, OptionsFormValidationError
 from questionpy_common.api.question import QuestionModel
 from questionpy_common.elements import OptionsFormDefinition
 from questionpy_common.environment import PackagePermissions, RequestInfo
-from questionpy_common import PackageNamespaceAndShortName
 from questionpy_common.error import QPyBaseError
 from questionpy_common.manifest import Manifest
 from questionpy_server.worker.runtime.package_location import PackageLocation

questionpy_server/worker/runtime/package.py

@@ -5,12 +5,14 @@
 import logging
 import sys
 from abc import ABC, abstractmethod
+from collections.abc import Iterable
 from importlib import import_module, resources
 from importlib.resources.abc import Traversable
 from pathlib import Path
 from types import ModuleType
 from zipfile import ZipFile
 
+from questionpy_common import PackageNamespaceAndShortName
 from questionpy_common.api.package import QPyPackageInterface
 from questionpy_common.constants import DIST_DIR, MANIFEST_FILENAME
 from questionpy_common.environment import (
@@ -20,7 +22,6 @@
     PackageNotLoadedError,
     PackageState,
 )
-from questionpy_common import PackageNamespaceAndShortName
 from questionpy_common.manifest import DistStaticQPyDependency, Manifest
 from questionpy_server.worker.runtime.package_location import (
     DirPackageLocation,
@@ -81,7 +82,7 @@ def init(self, env: Environment) -> None:
         """
 
     @abstractmethod
-    def resolve_static_dependencies(self) -> list[PackageLocation]:
+    def resolve_static_dependencies(self) -> Iterable[PackageLocation]:
         pass
 
 

tests/questionpy_common/test_manifest.py

@@ -165,6 +165,6 @@ def test_valid_permissions() -> None:
     )
 
     for permission, type_hint in partial.items():
-        assert type_hint == complete[permission] | None, (
-            "Custom permissions must be of the same type as the server permissions."
-        )
+        assert (
+            type_hint == complete[permission] | None
+        ), "Custom permissions must be of the same type as the server permissions."

tests/questionpy_server/test_settings.py

@@ -112,9 +112,9 @@ def test_multiline_env_var_gets_parsed_correctly(path_with_empty_config_file: Pa
 
 
 def test_standard_package_permissions_default_main_process_execution_modes_is_valid() -> None:
-    assert MainProcessExecutionModeValues.issuperset(CompletePackagePermissions().main_process_execution_modes), (
-        "The default value for 'main_process_execution_modes' is invalid."
-    )
+    assert MainProcessExecutionModeValues.issuperset(
+        CompletePackagePermissions().main_process_execution_modes
+    ), "The default value for 'main_process_execution_modes' is invalid."
 
 
 def test_standard_package_permissions_can_convert_to_package_permissions() -> None:

tests/questionpy_server/web/routes/test_packages.py

@@ -67,9 +67,9 @@ async def add_package_version(server: QPyServer, manifest: ComparableManifest) -
         # Assert that the actual package info is a subset of the manifest of the latest package version.
         actual_package_info_items = actual_package_info.model_dump().items()
         latest_manifest_items = manifests[actual_package_info.namespace][actual_versions[0]].model_dump().items()
-        assert actual_package_info_items <= latest_manifest_items, (
-            "Actual package info was not derived from the latest package version."
-        )
+        assert (
+            actual_package_info_items <= latest_manifest_items
+        ), "Actual package info was not derived from the latest package version."
 
         actual_namespaces.append(actual_package_info.namespace)