|
| 1 | +# Copyright (c) 2022 Tulir Asokan |
| 2 | +# |
| 3 | +# This Source Code Form is subject to the terms of the Mozilla Public |
| 4 | +# License, v. 2.0. If a copy of the MPL was not distributed with this |
| 5 | +# file, You can obtain one at http://mozilla.org/MPL/2.0/. |
| 6 | +from typing import Dict, List, NamedTuple, Optional, Union |
| 7 | +from enum import IntEnum |
| 8 | +import re |
| 9 | + |
| 10 | +from attr import dataclass |
| 11 | +import attr |
| 12 | + |
| 13 | +from . import JSON |
| 14 | +from .util import Serializable, SerializableAttrs |
| 15 | + |
| 16 | + |
| 17 | +class VersionFormat(IntEnum): |
| 18 | + UNKNOWN = -1 |
| 19 | + LEGACY = 0 |
| 20 | + MODERN = 1 |
| 21 | + |
| 22 | + def __repr__(self) -> str: |
| 23 | + return f"VersionFormat.{self.name}" |
| 24 | + |
| 25 | + |
| 26 | +legacy_version_regex = re.compile(r"^r(\d+)\.(\d+)\.(\d+)$") |
| 27 | +modern_version_regex = re.compile(r"^v(\d+)\.(\d+)$") |
| 28 | + |
| 29 | + |
| 30 | +@attr.dataclass(frozen=True) |
| 31 | +class Version(Serializable): |
| 32 | + format: VersionFormat |
| 33 | + major: int |
| 34 | + minor: int |
| 35 | + patch: int |
| 36 | + raw: str |
| 37 | + |
| 38 | + def __str__(self) -> str: |
| 39 | + if self.format == VersionFormat.MODERN: |
| 40 | + return f"v{self.major}.{self.minor}" |
| 41 | + elif self.format == VersionFormat.LEGACY: |
| 42 | + return f"r{self.major}.{self.minor}.{self.patch}" |
| 43 | + else: |
| 44 | + return self.raw |
| 45 | + |
| 46 | + def serialize(self) -> JSON: |
| 47 | + return str(self) |
| 48 | + |
| 49 | + @classmethod |
| 50 | + def deserialize(cls, raw: JSON) -> "Version": |
| 51 | + assert isinstance(raw, str), "versions must be strings" |
| 52 | + if modern := modern_version_regex.fullmatch(raw): |
| 53 | + major, minor = modern.groups() |
| 54 | + return Version(VersionFormat.MODERN, int(major), int(minor), 0, raw) |
| 55 | + elif legacy := legacy_version_regex.fullmatch(raw): |
| 56 | + major, minor, patch = legacy.groups() |
| 57 | + return Version(VersionFormat.LEGACY, int(major), int(minor), int(patch), raw) |
| 58 | + else: |
| 59 | + return Version(VersionFormat.UNKNOWN, 0, 0, 0, raw) |
| 60 | + |
| 61 | + |
| 62 | +class SpecVersions: |
| 63 | + R010 = Version.deserialize("r0.1.0") |
| 64 | + R020 = Version.deserialize("r0.2.0") |
| 65 | + R030 = Version.deserialize("r0.3.0") |
| 66 | + R040 = Version.deserialize("r0.4.0") |
| 67 | + R050 = Version.deserialize("r0.5.0") |
| 68 | + R060 = Version.deserialize("r0.6.0") |
| 69 | + R061 = Version.deserialize("r0.6.1") |
| 70 | + V11 = Version.deserialize("v1.1") |
| 71 | + V12 = Version.deserialize("v1.2") |
| 72 | + V13 = Version.deserialize("v1.3") |
| 73 | + |
| 74 | + |
| 75 | +@dataclass |
| 76 | +class VersionsResponse(SerializableAttrs): |
| 77 | + versions: List[Version] |
| 78 | + unstable_features: Dict[str, bool] = attr.ib(factory=lambda: {}) |
| 79 | + |
| 80 | + def supports(self, thing: Union[Version, str]) -> Optional[bool]: |
| 81 | + """ |
| 82 | + Check if the versions response contains the given spec version or unstable feature. |
| 83 | +
|
| 84 | + Args: |
| 85 | + thing: The spec version (as a :class:`Version` or string) |
| 86 | + or unstable feature name (as a string) to check. |
| 87 | +
|
| 88 | + Returns: |
| 89 | + ``True`` if the exact version or unstable feature is supported, |
| 90 | + ``False`` if it's not supported, |
| 91 | + ``None`` for unstable features which are not included in the response at all. |
| 92 | + """ |
| 93 | + if isinstance(thing, Version): |
| 94 | + return thing in self.versions |
| 95 | + elif (parsed_version := Version.deserialize(thing)).format != VersionFormat.UNKNOWN: |
| 96 | + return parsed_version in self.versions |
| 97 | + return self.unstable_features.get(thing) |
| 98 | + |
| 99 | + def supports_at_least(self, version: Union[Version, str]) -> bool: |
| 100 | + """ |
| 101 | + Check if the versions response contains the given spec version or any higher version. |
| 102 | +
|
| 103 | + Args: |
| 104 | + version: The spec version as a :class:`Version` or a string. |
| 105 | +
|
| 106 | + Returns: |
| 107 | + ``True`` if a version equal to or higher than the given version is found, |
| 108 | + ``False`` otherwise. |
| 109 | + """ |
| 110 | + if isinstance(version, str): |
| 111 | + version = Version.deserialize(version) |
| 112 | + return any(v for v in self.versions if v > version) |
| 113 | + |
| 114 | + @property |
| 115 | + def latest_version(self) -> Version: |
| 116 | + return max(self.versions) |
| 117 | + |
| 118 | + @property |
| 119 | + def has_legacy_versions(self) -> bool: |
| 120 | + """ |
| 121 | + Check if the response contains any legacy (r0.x.y) versions. |
| 122 | +
|
| 123 | + .. deprecated:: 0.16.10 |
| 124 | + :meth:`supports_at_least` and :meth:`supports` methods are now preferred. |
| 125 | + """ |
| 126 | + return any(v for v in self.versions if v.format == VersionFormat.LEGACY) |
| 127 | + |
| 128 | + @property |
| 129 | + def has_modern_versions(self) -> bool: |
| 130 | + """ |
| 131 | + Check if the response contains any modern (v1.1 or higher) versions. |
| 132 | +
|
| 133 | + .. deprecated:: 0.16.10 |
| 134 | + :meth:`supports_at_least` and :meth:`supports` methods are now preferred. |
| 135 | + """ |
| 136 | + return self.supports_at_least(SpecVersions.V11) |
0 commit comments