"""Version comparison utilities for component versioning. This module provides utilities for comparing component versions. Versions are strings that are first attempted to be parsed as PEP 440 versions (using the `packaging` library), falling back to lexicographic string comparison. Examples: - "1", "2", "10" → parsed as PEP 440, compared semantically (1 < 2 < 10) - "1.0", "2.0" → parsed as PEP 440 - "v1.0" → 'v' prefix stripped, parsed as "1.0" - "2025-01-15" → not valid PEP 440, compared as strings - None → sorts lowest (unversioned components) """ from __future__ import annotations from collections.abc import Callable, Sequence from dataclasses import dataclass from functools import total_ordering from typing import TYPE_CHECKING, Any, TypeVar from packaging.version import InvalidVersion, Version if TYPE_CHECKING: from fastmcp.utilities.components import FastMCPComponent C = TypeVar("C", bound=Any) @dataclass class VersionSpec: """Specification for filtering components by version. Used by transforms and providers to filter components to a specific version or version range. Unversioned components (version=None) always match any spec. Args: gte: If set, only versions >= this value match. lt: If set, only versions < this value match. eq: If set, only this exact version matches (gte/lt ignored). Matching is PEP 440-normalized and `v`-prefix insensitive, so `eq="v1.0"` matches a component versioned `"1.0"`, and `eq="1.0"` matches `"1"` (PEP 440 treats `1` and `1.0` as the same version). If a server registers two PEP 440-equivalent spellings of the same component (e.g. both `"1"` and `"1.0"`), they are the same version under this spec; selection among them is deterministic (see `version_sort_key`), not registration-order dependent. """ gte: str | None = None lt: str | None = None eq: str | None = None def matches(self, version: str | None, *, match_none: bool = True) -> bool: """Check if a version matches this spec. Args: version: The version to check, or None for unversioned. match_none: Whether unversioned (None) components match. Defaults to True for backward compatibility with retrieval operations. Set to False when filtering (e.g., enable/disable) to exclude unversioned components from version-specific rules. Returns: True if the version matches the spec. """ if version is None: return match_none if self.eq is not None: return parse_version_key(version) == parse_version_key(self.eq) key = parse_version_key(version) if self.gte is not None: gte_key = parse_version_key(self.gte) if key < gte_key: return False if self.lt is not None: lt_key = parse_version_key(self.lt) if not key < lt_key: return False return True def intersect(self, other: VersionSpec | None) -> VersionSpec: """Return a spec that satisfies both this spec and other. Used by transforms to combine caller constraints with filter constraints. For example, if a VersionFilter has lt="3.0" and caller requests eq="1.0", the intersection validates "1.0" is in range and returns the exact spec. Args: other: Another spec to intersect with, or None. Returns: A VersionSpec that matches only versions satisfying both specs. """ if other is None: return self if self.eq is not None: # This spec wants exact - validate against other's range if other.matches(self.eq): return self return VersionSpec(eq="__impossible__") if other.eq is not None: # Other wants exact - validate against our range if self.matches(other.eq): return other return VersionSpec(eq="__impossible__") # Both are ranges - take tighter bounds return VersionSpec( gte=max_version(self.gte, other.gte), lt=min_version(self.lt, other.lt), ) @total_ordering class VersionKey: """A comparable version key that handles None, PEP 440 versions, and strings. Comparison order: 1. None (unversioned) sorts lowest 2. PEP 440 versions sort by semantic version order 3. Invalid versions (strings) sort lexicographically 4. When comparing PEP 440 vs string, PEP 440 comes first """ __slots__ = ("_is_none", "_is_pep440", "_parsed", "_raw") def __init__(self, version: str | None) -> None: self._raw = version self._is_none = version is None self._is_pep440 = False self._parsed: Version | str | None = None if version is not None: # Strip leading 'v' if present (common convention like "v1.0") normalized = version.lstrip("v") if version.startswith("v") else version try: self._parsed = Version(normalized) self._is_pep440 = True except InvalidVersion: # Fall back to string comparison for non-PEP 440 versions self._parsed = version def __eq__(self, other: object) -> bool: if not isinstance(other, VersionKey): return NotImplemented if self._is_none and other._is_none: return True if self._is_none != other._is_none: return False # Both are not None if self._is_pep440 and other._is_pep440: return self._parsed == other._parsed if not self._is_pep440 and not other._is_pep440: return self._parsed == other._parsed # One is PEP 440, other is string - never equal return False def __lt__(self, other: object) -> bool: if not isinstance(other, VersionKey): return NotImplemented # None sorts lowest if self._is_none and other._is_none: return False # Equal if self._is_none: return True # None < anything if other._is_none: return False # anything > None # Both are not None if self._is_pep440 and other._is_pep440: # Both PEP 440 - compare normally assert isinstance(self._parsed, Version) assert isinstance(other._parsed, Version) return self._parsed < other._parsed if not self._is_pep440 and not other._is_pep440: # Both strings - lexicographic assert isinstance(self._parsed, str) assert isinstance(other._parsed, str) return self._parsed < other._parsed # Mixed: PEP 440 sorts before strings # (arbitrary but consistent choice) return self._is_pep440 def __repr__(self) -> str: return f"VersionKey({self._raw!r})" def parse_version_key(version: str | None) -> VersionKey: """Parse a version string into a sortable key. Args: version: The version string, or None for unversioned. Returns: A VersionKey suitable for sorting. """ return VersionKey(version) def version_sort_key(component: FastMCPComponent) -> tuple[VersionKey, str]: """Get a sort key for a component based on its version. Use with sorted() or max() to order components by version. The key is a `(VersionKey, raw)` tuple. The `VersionKey` orders by PEP 440 semantics (or lexicographically for non-PEP 440 strings); the raw version string is a deterministic tie-breaker so that two components whose versions are PEP 440-equivalent but spelled differently (e.g. `"1"` and `"1.0"`) are ordered reproducibly instead of by registration order. The raw tie-breaker only affects equivalent-version ties and never the primary version order, so range/equality matching (which uses `VersionKey` directly) is unchanged. Args: component: The component to get a sort key for. Returns: A deterministic, sortable `(VersionKey, raw)` tuple. Example: ```python tools = [tool_v1, tool_v2, tool_unversioned] highest = max(tools, key=version_sort_key) # Returns tool_v2 ``` """ return (parse_version_key(component.version), component.version or "") def compare_versions(a: str | None, b: str | None) -> int: """Compare two version strings. Args: a: First version string (or None). b: Second version string (or None). Returns: -1 if a < b, 0 if a == b, 1 if a > b. Example: ```python compare_versions("1.0", "2.0") # Returns -1 compare_versions("2.0", "1.0") # Returns 1 compare_versions(None, "1.0") # Returns -1 (None < any version) ``` """ key_a = parse_version_key(a) key_b = parse_version_key(b) return (key_a > key_b) - (key_a < key_b) def is_version_greater(a: str | None, b: str | None) -> bool: """Check if version a is greater than version b. Args: a: First version string (or None). b: Second version string (or None). Returns: True if a > b, False otherwise. """ return compare_versions(a, b) > 0 def max_version(a: str | None, b: str | None) -> str | None: """Return the greater of two versions. Args: a: First version string (or None). b: Second version string (or None). Returns: The greater version, or None if both are None. """ if a is None: return b if b is None: return a return a if compare_versions(a, b) >= 0 else b def min_version(a: str | None, b: str | None) -> str | None: """Return the lesser of two versions. Args: a: First version string (or None). b: Second version string (or None). Returns: The lesser version, or None if both are None. """ if a is None: return b if b is None: return a return a if compare_versions(a, b) <= 0 else b def dedupe_with_versions( components: Sequence[C], key_fn: Callable[[C], str], ) -> list[C]: """Deduplicate components by key, keeping highest version. Groups components by key, selects the highest version from each group, and injects available versions into meta if any component is versioned. Args: components: Sequence of components to deduplicate. key_fn: Function to extract the grouping key from a component. Returns: Deduplicated list with versions injected into meta. """ by_key: dict[str, list[C]] = {} for c in components: by_key.setdefault(key_fn(c), []).append(c) result: list[C] = [] for versions in by_key.values(): highest: C = max(versions, key=version_sort_key) if any(c.version is not None for c in versions): all_versions = sorted( [c.version for c in versions if c.version is not None], key=parse_version_key, reverse=True, ) meta = highest.meta or {} highest = highest.model_copy( update={ "meta": { **meta, "fastmcp": { **meta.get("fastmcp", {}), "versions": all_versions, }, } } ) result.append(highest) return result