|
| 1 | +import re |
| 2 | +from dataclasses import dataclass |
| 3 | +from typing import Any, Literal, Protocol, Self |
| 4 | + |
| 5 | +from pydantic import GetCoreSchemaHandler |
| 6 | +from pydantic_core import CoreSchema, core_schema |
| 7 | + |
| 8 | +from questionpy_common.constants import RE_SEMVER |
| 9 | + |
| 10 | +type _Operator = Literal["==", "!=", ">=", "<=", ">", "<"] |
| 11 | +_OPERATORS: set[_Operator] = {"==", "!=", ">=", "<=", ">", "<"} |
| 12 | + |
| 13 | +_SEMVER_PATTERN = re.compile(RE_SEMVER) |
| 14 | + |
| 15 | + |
| 16 | +class StringComparable(Protocol): |
| 17 | + def __gt__(self, other: str) -> bool: ... |
| 18 | + |
| 19 | + def __ge__(self, other: str) -> bool: ... |
| 20 | + |
| 21 | + def __lt__(self, other: str) -> bool: ... |
| 22 | + |
| 23 | + def __le__(self, other: str) -> bool: ... |
| 24 | + |
| 25 | + |
| 26 | +@dataclass(frozen=True) |
| 27 | +class QPyDependencyVersionSpecifier: |
| 28 | + """One or more clauses restricting allowed versions for a QPy package dependency.""" |
| 29 | + |
| 30 | + @dataclass(frozen=True) |
| 31 | + class Clause: |
| 32 | + """A single comparison clause such as `>= 1.2.2`.""" |
| 33 | + |
| 34 | + operator: _Operator |
| 35 | + operand: str |
| 36 | + |
| 37 | + def allows(self, version: StringComparable) -> bool: |
| 38 | + """Check if this clause is fulfilled by the given version.""" |
| 39 | + # Note: The semver package we use does already implement a `match` method, but we would like to validate |
| 40 | + # each clause early, before the matching needs to be done. |
| 41 | + match self.operator: |
| 42 | + case "<": |
| 43 | + return version < self.operand |
| 44 | + case "<=": |
| 45 | + return version <= self.operand |
| 46 | + case "==": |
| 47 | + return version == self.operand |
| 48 | + case ">=": |
| 49 | + return version >= self.operand |
| 50 | + case ">": |
| 51 | + return version > self.operand |
| 52 | + case _: |
| 53 | + # Shouldn't be reachable. |
| 54 | + msg = f"Invalid operator: {self.operator}" |
| 55 | + raise ValueError(msg) |
| 56 | + |
| 57 | + @classmethod |
| 58 | + def from_string(cls, string: str) -> Self: |
| 59 | + string = string.strip() |
| 60 | + |
| 61 | + operator = next(filter(string.startswith, _OPERATORS), None) |
| 62 | + if operator: |
| 63 | + version_string = string.removeprefix(operator).lstrip() |
| 64 | + if not _SEMVER_PATTERN.match(string): |
| 65 | + msg = f"Comparison version '{version_string}' of clause '{string}' does not conform to SemVer." |
| 66 | + raise ValueError(msg) |
| 67 | + |
| 68 | + operand = version_string |
| 69 | + else: |
| 70 | + # No operator. Check if string is a version, since we allow "==" to be omitted. |
| 71 | + if not _SEMVER_PATTERN.match(string): |
| 72 | + msg = ( |
| 73 | + f"Version specifier clause '{string}' does not start with a valid operator and isn't a " |
| 74 | + f"version itself. Valid operators are {', '.join(_OPERATORS)}." |
| 75 | + ) |
| 76 | + raise ValueError(msg) |
| 77 | + |
| 78 | + operator = "==" |
| 79 | + operand = string |
| 80 | + |
| 81 | + return cls(operator, operand) |
| 82 | + |
| 83 | + def __str__(self) -> str: |
| 84 | + return f"{self.operator} {self.operand}" |
| 85 | + |
| 86 | + clauses: tuple[Clause, ...] |
| 87 | + |
| 88 | + def __str__(self) -> str: |
| 89 | + return ", ".join(map(str, self.clauses)) |
| 90 | + |
| 91 | + @classmethod |
| 92 | + def from_string(cls, string: str) -> Self: |
| 93 | + return cls(tuple(map(cls.Clause.from_string, string.split(",")))) |
| 94 | + |
| 95 | + def allows(self, version: str) -> bool: |
| 96 | + """Checks if _all_ clauses allow the given version.""" |
| 97 | + return all(clause.allows(version) for clause in self.clauses) |
| 98 | + |
| 99 | + @classmethod |
| 100 | + def __get_pydantic_core_schema__(cls, source_type: Any, handler: GetCoreSchemaHandler) -> CoreSchema: |
| 101 | + return core_schema.json_or_python_schema( |
| 102 | + core_schema.no_info_after_validator_function(cls.from_string, handler(str)), |
| 103 | + core_schema.is_instance_schema(cls), |
| 104 | + serialization=core_schema.to_string_ser_schema() |
| 105 | + ) |
0 commit comments