|
| 1 | +type PythonReleaseLevel = 'alpha' | 'beta' | 'candidate' | 'final'; |
| 2 | + |
| 3 | +export class PythonVersion { |
| 4 | + private static readonly VERSION_PATTERN = |
| 5 | + /^(?<major>\d+)(?:\.(?<minor>\d+))?(?:\.(?<patch>\d+))?(?:(?:\.(?<longLevel>alpha|beta|candidate|final)\.(?<longSerial>\d+))|(?:(?<shortLevel>a|b|rc)(?<shortSerial>\d+)))?$/i; |
| 6 | + |
| 7 | + private static readonly WILDCARD_PATTERN = /^(\d+)(?:\.(\d+))?(?:\.(\d+))?\.\*$/; |
| 8 | + |
| 9 | + private static readonly SPECIFIER_PATTERN = /^(===|~=|==|!=|>=|<=|>|<)\s*(.+)$/; |
| 10 | + |
| 11 | + private static readonly RELEASE_LEVEL_ALIASES: Readonly<Record<string, PythonReleaseLevel>> = { |
| 12 | + a: 'alpha', |
| 13 | + alpha: 'alpha', |
| 14 | + b: 'beta', |
| 15 | + beta: 'beta', |
| 16 | + rc: 'candidate', |
| 17 | + candidate: 'candidate', |
| 18 | + final: 'final', |
| 19 | + }; |
| 20 | + |
| 21 | + private static readonly RELEASE_LEVEL_ORDER: Readonly<Record<PythonReleaseLevel, number>> = { |
| 22 | + alpha: 0, |
| 23 | + beta: 1, |
| 24 | + candidate: 2, |
| 25 | + final: 3, |
| 26 | + }; |
| 27 | + |
| 28 | + /** |
| 29 | + * Creates a normalized Python release version. |
| 30 | + * |
| 31 | + * Missing minor and patch components are normalized to zero. Python |
| 32 | + * `sys.version_info` suffixes and compact prerelease suffixes are |
| 33 | + * normalized, so `3.14.0.beta.1` and `3.14.0b1` are both represented as |
| 34 | + * `3.14.0b1`. |
| 35 | + * |
| 36 | + * @param version A Python release version. |
| 37 | + */ |
| 38 | + constructor(version: string) { |
| 39 | + const normalizedVersion = version.trim(); |
| 40 | + const match = PythonVersion.VERSION_PATTERN.exec(normalizedVersion); |
| 41 | + if (!match) { |
| 42 | + throw new TypeError(`Invalid Python version: ${version}`); |
| 43 | + } |
| 44 | + |
| 45 | + const groups = match.groups!; |
| 46 | + this.original = normalizedVersion; |
| 47 | + this.releaseComponentCount = groups.patch !== undefined ? 3 : groups.minor !== undefined ? 2 : 1; |
| 48 | + this.major = parseNumericComponent(groups.major, version); |
| 49 | + this.minor = parseNumericComponent(groups.minor, version); |
| 50 | + this.patch = parseNumericComponent(groups.patch, version); |
| 51 | + this.releaseLevel = PythonVersion.normalizeReleaseLevel(groups.longLevel ?? groups.shortLevel); |
| 52 | + this.releaseSerial = parseNumericComponent(groups.longSerial ?? groups.shortSerial, version); |
| 53 | + if (this.releaseLevel === 'final' && this.releaseSerial !== 0) { |
| 54 | + throw new TypeError(`Invalid Python version: ${version}`); |
| 55 | + } |
| 56 | + } |
| 57 | + |
| 58 | + readonly major: number; |
| 59 | + readonly minor: number; |
| 60 | + readonly patch: number; |
| 61 | + readonly releaseLevel: PythonReleaseLevel; |
| 62 | + readonly releaseSerial: number; |
| 63 | + private readonly original: string; |
| 64 | + private readonly releaseComponentCount: number; |
| 65 | + |
| 66 | + /** |
| 67 | + * Attempts to parse a Python version without propagating malformed input errors. |
| 68 | + * |
| 69 | + * @param version The value to parse. |
| 70 | + * @returns A normalized version, or `undefined` when the value is unsupported. |
| 71 | + */ |
| 72 | + static tryParse(version: unknown): PythonVersion | undefined { |
| 73 | + if (typeof version !== 'string') { |
| 74 | + return undefined; |
| 75 | + } |
| 76 | + |
| 77 | + try { |
| 78 | + return new PythonVersion(version); |
| 79 | + } catch { |
| 80 | + return undefined; |
| 81 | + } |
| 82 | + } |
| 83 | + |
| 84 | + /** |
| 85 | + * Compares this version with another normalized Python version. |
| 86 | + * |
| 87 | + * @param other The version to compare against. |
| 88 | + * @returns A negative number when this version is older, zero when both |
| 89 | + * versions are equal, and a positive number when this version is newer. |
| 90 | + */ |
| 91 | + compareTo(other: PythonVersion): number { |
| 92 | + return ( |
| 93 | + this.compareReleaseTo(other) || |
| 94 | + compareNumbers( |
| 95 | + PythonVersion.RELEASE_LEVEL_ORDER[this.releaseLevel], |
| 96 | + PythonVersion.RELEASE_LEVEL_ORDER[other.releaseLevel], |
| 97 | + ) || |
| 98 | + compareNumbers(this.releaseSerial, other.releaseSerial) |
| 99 | + ); |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * Tests whether this version satisfies a Python version specifier. |
| 104 | + * |
| 105 | + * Supports `==`, `!=`, `>=`, `<=`, `>`, `<`, `~=`, and `===` operators, |
| 106 | + * comma-separated AND clauses, and terminal wildcards with `==` or `!=`. |
| 107 | + * Prerelease suffixes are ignored for ordered and release-equality |
| 108 | + * comparisons, matching the inline-script interpreter behavior. |
| 109 | + * |
| 110 | + * @param specifier A version specifier such as `>=3.11,<3.14` or `==3.12.*`. |
| 111 | + * @returns Whether every clause matches, or `undefined` when the specifier is invalid. |
| 112 | + */ |
| 113 | + satisfies(specifier: unknown): boolean | undefined { |
| 114 | + if (typeof specifier !== 'string') { |
| 115 | + return undefined; |
| 116 | + } |
| 117 | + |
| 118 | + const clauses = specifier.split(',').map((clause) => clause.trim()); |
| 119 | + if (clauses.some((clause) => clause.length === 0)) { |
| 120 | + return undefined; |
| 121 | + } |
| 122 | + |
| 123 | + let satisfiesAll = true; |
| 124 | + for (const clause of clauses) { |
| 125 | + const result = this.matchClause(clause); |
| 126 | + if (result === undefined) { |
| 127 | + return undefined; |
| 128 | + } |
| 129 | + satisfiesAll &&= result; |
| 130 | + } |
| 131 | + return satisfiesAll; |
| 132 | + } |
| 133 | + |
| 134 | + /** Returns the normalized Python version representation. */ |
| 135 | + toString(): string { |
| 136 | + const release = `${this.major}.${this.minor}.${this.patch}`; |
| 137 | + switch (this.releaseLevel) { |
| 138 | + case 'alpha': |
| 139 | + return `${release}a${this.releaseSerial}`; |
| 140 | + case 'beta': |
| 141 | + return `${release}b${this.releaseSerial}`; |
| 142 | + case 'candidate': |
| 143 | + return `${release}rc${this.releaseSerial}`; |
| 144 | + case 'final': |
| 145 | + return release; |
| 146 | + } |
| 147 | + } |
| 148 | + |
| 149 | + private static normalizeReleaseLevel(value: string | undefined): PythonReleaseLevel { |
| 150 | + return value ? (PythonVersion.RELEASE_LEVEL_ALIASES[value.toLowerCase()] ?? 'final') : 'final'; |
| 151 | + } |
| 152 | + |
| 153 | + private matchClause(clause: string): boolean | undefined { |
| 154 | + const match = PythonVersion.SPECIFIER_PATTERN.exec(clause); |
| 155 | + if (!match) { |
| 156 | + return undefined; |
| 157 | + } |
| 158 | + |
| 159 | + const operator = match[1]; |
| 160 | + const expected = match[2].trim(); |
| 161 | + if (operator === '===') { |
| 162 | + return expected ? this.original.replace(/^v/i, '') === expected.replace(/^v/i, '') : undefined; |
| 163 | + } |
| 164 | + if (expected.endsWith('.*')) { |
| 165 | + const wildcard = PythonVersion.parseWildcard(expected); |
| 166 | + if ((operator !== '==' && operator !== '!=') || !wildcard) { |
| 167 | + return undefined; |
| 168 | + } |
| 169 | + const matches = this.matchesReleaseComponents(wildcard); |
| 170 | + return operator === '==' ? matches : !matches; |
| 171 | + } |
| 172 | + |
| 173 | + const expectedVersion = PythonVersion.tryParse(expected); |
| 174 | + if (!expectedVersion || (operator === '~=' && expectedVersion.releaseComponentCount < 2)) { |
| 175 | + return undefined; |
| 176 | + } |
| 177 | + |
| 178 | + const comparison = this.compareReleaseTo(expectedVersion); |
| 179 | + switch (operator) { |
| 180 | + case '==': |
| 181 | + return comparison === 0; |
| 182 | + case '!=': |
| 183 | + return comparison !== 0; |
| 184 | + case '>=': |
| 185 | + return comparison >= 0; |
| 186 | + case '<=': |
| 187 | + return comparison <= 0; |
| 188 | + case '>': |
| 189 | + return comparison > 0; |
| 190 | + case '<': |
| 191 | + return comparison < 0; |
| 192 | + case '~=': |
| 193 | + return ( |
| 194 | + comparison >= 0 && |
| 195 | + this.matchesReleaseComponents( |
| 196 | + expectedVersion.releasePrefix(expectedVersion.releaseComponentCount - 1), |
| 197 | + ) |
| 198 | + ); |
| 199 | + default: |
| 200 | + return false; |
| 201 | + } |
| 202 | + } |
| 203 | + |
| 204 | + private compareReleaseTo(other: PythonVersion): number { |
| 205 | + return ( |
| 206 | + compareNumbers(this.major, other.major) || |
| 207 | + compareNumbers(this.minor, other.minor) || |
| 208 | + compareNumbers(this.patch, other.patch) |
| 209 | + ); |
| 210 | + } |
| 211 | + |
| 212 | + private releasePrefix(length: number): readonly number[] { |
| 213 | + return [this.major, this.minor, this.patch].slice(0, length); |
| 214 | + } |
| 215 | + |
| 216 | + private matchesReleaseComponents(expected: readonly number[]): boolean { |
| 217 | + return ( |
| 218 | + expected[0] === this.major && |
| 219 | + (expected.length < 2 || expected[1] === this.minor) && |
| 220 | + (expected.length < 3 || expected[2] === this.patch) |
| 221 | + ); |
| 222 | + } |
| 223 | + |
| 224 | + private static parseWildcard(wildcard: unknown): number[] | undefined { |
| 225 | + if (typeof wildcard !== 'string') { |
| 226 | + return undefined; |
| 227 | + } |
| 228 | + |
| 229 | + const match = PythonVersion.WILDCARD_PATTERN.exec(wildcard.trim()); |
| 230 | + if (!match) { |
| 231 | + return undefined; |
| 232 | + } |
| 233 | + |
| 234 | + const components = match |
| 235 | + .slice(1) |
| 236 | + .filter((component): component is string => component !== undefined) |
| 237 | + .map(Number); |
| 238 | + return components.every(Number.isSafeInteger) ? components : undefined; |
| 239 | + } |
| 240 | +} |
| 241 | + |
| 242 | +function parseNumericComponent(value: string | undefined, version: string): number { |
| 243 | + const parsed = Number(value ?? 0); |
| 244 | + if (!Number.isSafeInteger(parsed)) { |
| 245 | + throw new TypeError(`Invalid Python version: ${version}`); |
| 246 | + } |
| 247 | + return parsed; |
| 248 | +} |
| 249 | + |
| 250 | +function compareNumbers(left: number, right: number): number { |
| 251 | + return left === right ? 0 : left < right ? -1 : 1; |
| 252 | +} |
0 commit comments