mirror of
https://github.com/openswarm-ai/openswarm.git
synced 2026-09-22 17:44:53 +02:00
* [eric] ci: gitleaks-ignore the known historical secrets so our branch stops failing on leaks it didnt add * [eric] workflows: restore scheduled-tasks on the workflow line (revert removal, keep windows fixes + 1.1.69) * [eric] workflows: re-apply uncommitted scheduling wip (schedule pill, calendar view, slice) * [eric] ops: gitignore dev-team local state files * [eric] ops: backlog item for download-tracking visibility * [eric] ci: allowlist the cdp-routes redaction-test token in gitleaks * [aidan] feat/scheduled-tasks: keep step labels in sync on edit and show chevron on every step * [aidan] fix: schedule time in chat * [aidan] ux/workflows: add workflow step removal (#91) * [aidan] feat/scheduled-tasks: remember workflow tool permissions across runs * [aidan] feat/task-scheduling: add hourly and minute (15-min minimum) schedule intervals (#93) * [aidan] feat/scheduled-tasks: calendar, rename, and edit workflows (#94) * [aidan] bug: fix schedule button * [aidan] fix/agent-errors: surface provider rate limits * [aidan] ux/cards: click-to-rename for chat and workflow titles Single-click a card's title to enter edit mode inline. Commit on Enter/blur, cancel on Escape. Rename persists via PATCH for workflows and sessions. * [aidan] feat/workflows: seed build prompt for zero-step workflows When a new workflow has no steps, seed the agent with a prompt asking the user to describe what the workflow should do, rather than starting blank. * [aidan] feat/workflows: add-to-schedule popover for unscheduled workflows Clicking the "+" on an unscheduled workflow row opens a popover with two options: - Keep this schedule: enables the workflow's existing cadence and moves it to Scheduled - Change schedule: opens the scheduling editor to pick a different time * [aidan] ux/workflows: wire add-to-schedule popover and simplify New button - Made the "+" icon on unscheduled workflow rows clickable, opening a popover to keep or change the schedule - Removed AddIcon from toolbar "New" button (now reads "New" instead of "+ New") * [aidan] fix/scheduled-tasks: open schedule calendar when Schedule pill clicked Fixed the Schedule pill click being swallowed by the toolbar's dismiss handler. Exempted the toolbar pills via data-toolbar-pills so their click handlers fire. * [aidan] ux/workflows: open New workflow in agent build chat instead of empty card When creating a new workflow from the hub, open it in edit_agent view (with the agent builder chat) instead of a preview card. The workflow is created on the backend first so the embedded session has a real ID. * [aidan] feat/workflow-edit: add draft testing save flow * [aidan] ux/chat: remove continue chat button * [aidan] ux/workflows: polish workflow card interactions * [aidan] fix/workflow-scheduling: save unscheduled workflows as drafts * aidan ui: schedule naming changes * [aidan] ui: tool calling desc/naming * [aidan] ui: calendar sidebar naming * [aidan] ui: fix stop viewing closing chat * [aidan] feat/workflows: auto-name workflows and polish the build flow (#95) * [aidan] feat/workflow-auto-naming: auto-generate workflow titles from steps Generate a title + description from a workflow's steps (one aux call, reused for step labels) whenever it is still auto_named, so a workflow built in the Edit Agent names itself on commit instead of staying "New workflow". A manual rename sets auto_named=False and is never overwritten. Stream the aux call (non-streaming drops content on some 9router lanes) and fall back to a step-derived title when the model is unavailable. * [aidan] feat/workflows: hide unsaved new workflows until first save A brand-new "+ New" workflow is created with unsaved=true and kept out of the hub's scheduled/unscheduled lists while the user is still building it in the Edit Agent. The first commit (Save) clears the flag and the workflow appears. Every other create path stays visible immediately. * [aidan] ux/workflows: remove redundant save workflow button The Edit Agent already has Discard/Save controls in its strip, so the header "Save Workflow" button was a duplicate save path. Remove it and its pulse/edit-session-id wiring; the model/time subtitle stays. * [aidan] ux/workflows: animate title on auto-rename Wrap the workflow card title in the same Typewriter the chat card uses, so when the auto-generated name replaces the placeholder after Save it retypes letter-by-letter. Gated on a real (non-placeholder) title so it never animates on mount or for already-named workflows. * [aidan] ux/workflows: animate sidebar title on auto-rename Wrap the calendar hub's sidebar row title in the same Typewriter the workflow card uses, so a title that auto-renames retypes letter-by-letter in the sidebar too. Extract the placeholder/isRealTitle guard into the shared workflowVisuals so the card and sidebar stay in sync. * [aidan] fix/workflows: connect watch tether, keep watched chat open, wire draft run/history * [aidan] ui: grey out chat pill when not selected * [aidan] ui: fix running agent display * [aidan] feat/history-popover: add chat history and scheduled tasks run log tabs (#96) * [aidan] ux/schedule: toast when calendar view already open on expand * [aidan] ui: fix popover descs * [aidan] feat/workflow-runs: add pause, resume, and stop controls for live runs * [aidan] feat/schedule-calendar: add calendar occurrences endpoint and concrete timezones * [aidan] feat/workflows: require at least one step to save a workflow * [aidan] ux/edit-agent: hide Discard for an unsaved new workflow * [aidan] ux/edit-agent: move fix-prefix card below the step list * [aidan] feat/workflows: toast when an unattended scheduled run starts * [aidan] fix/dashboard-tethers: anchor workflow-sidecar tethers to measured card rects * [aidan] feat/workflows: validate steps before scheduling and keep chat tool memory * [aidan] feat/mcp-suggestions: dismissable integration banner with per-session cooldown * [aidan] feat/workflows: add scheduled-run "running now" toast with click-to-view (#97) * [aidan] ux/workflows: surface paused state on card, sidebar, and calendar; tidy run history * [aidan] feat/mcp-suggestions: suggest both Google and Microsoft when provider is ambiguous * [aidan] fix/agent-tokens: friendly out-of-tokens card across all agent surfaces * [aidan] feat/workflow-model: persist edit-agent model on save with switch notice and fresh drafts * [aidan] fix/workflow-chat: force stop on watched run mirrors workflow card stop * [aidan] fix/workflow-cards: keep watched run tethered on finish to avoid duplicate chat * [aidan] feat/schedule-calendar: mark current time with a now line in week view * [aidan] refactor/private-names: rename error and schedule classifiers from _ to p_ * [aidan] feat/scheduled-tasks: agent workflow scheduling and in-chat convert (#98) * [aidan] feat/workflow-suggest: nudge user to convert repeatable chat to workflow Add SuggestConvertToWorkflow MCP tool that agents call at the end of a task when they've completed something worth repeating (daily report, weekly check, recurring data pull). Frontend detects the tool call and glows the "Convert to workflow" button 3 times to draw the eye. When user clicks it, the suggested cadence (e.g. "every weekday at 9am") is stored in the draft and seeded into the scheduling agent's first prompt, so the agent can act on the suggestion rather than asking the user again. Tool is never auto-called — agents decide when a task is genuinely repeatable (not debugging, creative work, one-off lookup). Tool description emphasizes sparse, high-confidence use only (once per session max). Files changed: - backend/apps/agents/schedule_mcp_server.py: add SuggestConvertToWorkflow tool - frontend/src/shared/mcpToolMeta.ts: add label for new tool - frontend/src/app/pages/Dashboard/cards/AgentCard.tsx: detect suggestion in session messages, show+glow "Convert to workflow" button, pass cadence to draft - frontend/src/shared/state/workflowsSlice.ts: add suggested_cadence field to Workflow interface - frontend/src/app/pages/Workflows/SchedulingView.tsx: seed scheduling agent prompt with suggested cadence hint * [aidan] feat/agent-scheduling: route recurring asks through native workflows, deny claude cron skill * [aidan] feat/workflow-convert: in-chat convert popup and auto-open scheduled workflow card * [aidan] ux/calendar-page: schedule calendar restyle + popover fixes (#99) * [aidan] fix/dashboard-delete: remove workflows calendar panel on delete key * [aidan] ux/workflows-calendar: restyle hub, fix today highlight, add toolbar toggle * [aidan] ux/schedule-popover: compact density, fix sticky header bleed, add header spacing * [aidan] ux/schedule-calendar: hollow ring dot for past fires in month view * [aidan] ux/schedule-calendar: clickable +N more opens day's full run list * [aidan] feat/run-log-filters: add success and skipped pills to scheduled task history * [aidan] fix/convert-button: stop drag capture so convert-to-workflow click fires * [aidan] ux/calendar-card: match border color and radius to chat and workflow cards * [aidan] fix/minimap: render missed-runs card on the minimap * [aidan] ux/run-sparkline: simplify tooltip to plain run tally * [aidan] ux/run-history: collapse expanded run view to one clickable line * [aidan] ux/calendar-card: match corner radius to browser cards * [aidan] feat/workflows: launch-time scheduling UX and workflow-card polish (#101) * [aidan] feat/schedule-list: lazy-load list view via scroll sentinel * [aidan] feat/missed-runs: launch toast with per-workflow counts and pan-to-card * [aidan] fix/dashboard-tethers: keep watching line anchored on canvas zoom * [aidan] feat/scheduled-tasks: review missed runs at launch instead of auto-firing on_missed * [aidan] refactor/workflow-cards: use radius and status design tokens, polish card chrome * [aidan] ux/agent-card: keep convert-to-workflow visible during runs with mid-turn toast * [aidan] ux/mcp-bubble: drop redundant verb label when a workflow label is shown * [aidan] chore/backend: remove stale explanatory comments * [aidan] fix/workflows-hub: load workflows on hub mount so calendar fills at launch * [aidan] feat/workflows: generate title, description, step labels at convert time * [aidan] fix/tidy-layout: include workflows hub in tidy and fit-to-view * [aidan] feat/schedule-list: window long list via measured-height virtualizer * [aidan] ux/workflows-hub: remove time-saved badge from calendar header * [aidan] fix/types: add missing semantic-type labels and drop stray fade arg * [aidan] feat/schedule: pin monthly day-of-month and honor repeat-every intervals * [aidan] feat/schedule: inherit source-session tool surface for scheduled runs * [aidan] ux/calendar: restack hour-cell events as bars with overflow affordance * [aidan] feat/calendar: open the run card when clicking a scheduled occurrence * [aidan] ux/missed-runs: add per-group select-all toggle and rename skip action * [aidan] feat: new scheduled task design ported * [aidan] ui: sidebar reorder, repeat controls on schedule card * [aidan] ui: sidebar, scheduling time * [aidan] feat/schedule: pin monthly last-day-of-month * [aidan] feat/steps: per-step enable toggle * [aidan] feat/workflows: per-workflow color swatch * [aidan] feat/trash: soft-delete workflows with restore and purge * [aidan] feat/run-monitor: live run monitor card on the canvas * [aidan] feat/run-context: attach a run as removable chat context * [aidan] feat/compose: new-workflow landing page and auto-commit build flow * [aidan] ui/workflows: dark mode and design-system cohesion * [aidan] ui/calendar: overflow popover, condensed week view, scroll fix * [aidan] feat/home: ongoing runs, missed review, and accurate Coming-up counts * [aidan] fix/run-status: sync ongoing runs and heal stuck/interrupted runs * [aidan] ux/schedule: last-day-of-month UI, Run-at time typing, interval input * [aidan] ux/workflows: default window size and toolbar icon * [aidan] fix/schedule: measure ran_late from start and anchor recurrences to created_at * [aidan] feat/calendar: render fire times from backend, drop JS recurrence reimpl * [aidan] chore/dashboard: drop dead configure/missed-run cards, refetch on reconnect * [aidan] chore/agent-card: remove unreachable convert-to-workflow action * [aidan] fix/workflows: don't bump updated_at on a no-op draft commit so viewing a workflow doesn't reorder the sidebar * [aidan] feat/schedule: warn when scheduling a workflow that has no steps * [aidan] fix/selection-tool: never select the workflows app, and exit the tool on Escape without dropping selections * [aidan] ux/compose: diversify new-workflow starter prompts across personas * [aidan] ux/run-monitor: spawn the run card a bit farther right of the workflows app * [aidan] fix/schedule: harden run recovery and storage writes against crashes * [aidan] ux/compose: restyle new-workflow starters as a clean pill cluster with rich prompts * [aidan] fix/workflows: optimistically apply edits so the schedule banner updates instantly * [aidan] ui/workflows: three-tone surface depth so the window lifts off the canvas in both themes * [aidan] ui/workflows: close buttons turn red on hover, matching the chat card * [aidan] test/schedule: cover executor pipeline, storage durability, and recurrence gaps * [aidan] fix: remove package-lock json * [aidan] fix/workflows-compose: keep compose view until edit agent replies * [aidan] feat/workflows: auto-generate workflow + step titles with typewriter animation * [eric] deps: restore frontend/package-lock.json (PR #105 deletion broke npm ci) --------- Co-authored-by: Eric <ciregenz@berkeley.edu> Co-authored-by: cire <134991075+ciregenz@users.noreply.github.com>
1232 lines
38 KiB
Python
1232 lines
38 KiB
Python
# This file is dual licensed under the terms of the Apache License, Version
|
|
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
|
|
# for complete details.
|
|
"""
|
|
.. testsetup::
|
|
|
|
from packaging.version import parse, normalize_pre, Version, _cmpkey
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
import sys
|
|
import typing
|
|
from typing import (
|
|
Any,
|
|
Callable,
|
|
Literal,
|
|
NamedTuple,
|
|
SupportsInt,
|
|
Tuple,
|
|
TypedDict,
|
|
Union,
|
|
)
|
|
|
|
if typing.TYPE_CHECKING:
|
|
from typing_extensions import Self, Unpack
|
|
|
|
if sys.version_info >= (3, 13): # pragma: no cover
|
|
from warnings import deprecated as _deprecated
|
|
elif typing.TYPE_CHECKING:
|
|
from typing_extensions import deprecated as _deprecated
|
|
else: # pragma: no cover
|
|
import functools
|
|
import warnings
|
|
|
|
def _deprecated(message: str) -> object:
|
|
def decorator(func: Callable[[...], object]) -> object:
|
|
@functools.wraps(func)
|
|
def wrapper(*args: object, **kwargs: object) -> object:
|
|
warnings.warn(
|
|
message,
|
|
category=DeprecationWarning,
|
|
stacklevel=2,
|
|
)
|
|
return func(*args, **kwargs)
|
|
|
|
return wrapper
|
|
|
|
return decorator
|
|
|
|
|
|
_LETTER_NORMALIZATION = {
|
|
"alpha": "a",
|
|
"beta": "b",
|
|
"c": "rc",
|
|
"pre": "rc",
|
|
"preview": "rc",
|
|
"rev": "post",
|
|
"r": "post",
|
|
}
|
|
|
|
__all__ = ["VERSION_PATTERN", "InvalidVersion", "Version", "normalize_pre", "parse"]
|
|
|
|
|
|
def __dir__() -> list[str]:
|
|
return __all__
|
|
|
|
|
|
LocalType = Tuple[Union[int, str], ...]
|
|
|
|
CmpLocalType = Tuple[Tuple[int, str], ...]
|
|
CmpSuffix = Tuple[int, int, int, int, int, int]
|
|
CmpKey = Union[
|
|
Tuple[int, Tuple[int, ...], CmpSuffix],
|
|
Tuple[int, Tuple[int, ...], CmpSuffix, CmpLocalType],
|
|
]
|
|
VersionComparisonMethod = Callable[[CmpKey, CmpKey], bool]
|
|
|
|
|
|
class _VersionReplace(TypedDict, total=False):
|
|
epoch: int | None
|
|
release: tuple[int, ...] | None
|
|
pre: tuple[str, int] | None
|
|
post: int | None
|
|
dev: int | None
|
|
local: str | None
|
|
|
|
|
|
def normalize_pre(letter: str, /) -> str:
|
|
"""Normalize the pre-release segment of a version string.
|
|
|
|
Returns a lowercase version of the string if not a known pre-release
|
|
identifier.
|
|
|
|
>>> normalize_pre('alpha')
|
|
'a'
|
|
>>> normalize_pre('BETA')
|
|
'b'
|
|
>>> normalize_pre('rc')
|
|
'rc'
|
|
|
|
:param letter:
|
|
|
|
.. versionadded:: 26.1
|
|
"""
|
|
letter = letter.lower()
|
|
return _LETTER_NORMALIZATION.get(letter, letter)
|
|
|
|
|
|
def parse(version: str) -> Version:
|
|
"""Parse the given version string.
|
|
|
|
This is identical to the :class:`Version` constructor.
|
|
|
|
>>> parse('1.0.dev1')
|
|
<Version('1.0.dev1')>
|
|
|
|
:param version: The version string to parse.
|
|
:raises InvalidVersion: When the version string is not a valid version.
|
|
"""
|
|
return Version(version)
|
|
|
|
|
|
class InvalidVersion(ValueError):
|
|
"""Raised when a version string is not a valid version.
|
|
|
|
>>> Version("invalid")
|
|
Traceback (most recent call last):
|
|
...
|
|
packaging.version.InvalidVersion: Invalid version: 'invalid'
|
|
"""
|
|
|
|
|
|
class _BaseVersion:
|
|
__slots__ = ()
|
|
|
|
# This can also be a normal member (see the packaging_legacy package);
|
|
# we are just requiring it to be readable. Actually defining a property
|
|
# has runtime effect on subclasses, so it's typing only.
|
|
if typing.TYPE_CHECKING:
|
|
|
|
@property
|
|
def _key(self) -> tuple[Any, ...]: ...
|
|
|
|
def __hash__(self) -> int:
|
|
return hash(self._key)
|
|
|
|
# Please keep the duplicated `isinstance` check
|
|
# in the six comparisons hereunder
|
|
# unless you find a way to avoid adding overhead function calls.
|
|
def __lt__(self, other: _BaseVersion) -> bool:
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return self._key < other._key
|
|
|
|
def __le__(self, other: _BaseVersion) -> bool:
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return self._key <= other._key
|
|
|
|
def __eq__(self, other: object) -> bool:
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return self._key == other._key
|
|
|
|
def __ge__(self, other: _BaseVersion) -> bool:
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return self._key >= other._key
|
|
|
|
def __gt__(self, other: _BaseVersion) -> bool:
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return self._key > other._key
|
|
|
|
def __ne__(self, other: object) -> bool:
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return self._key != other._key
|
|
|
|
|
|
# Deliberately not anchored to the start and end of the string, to make it
|
|
# easier for 3rd party code to reuse
|
|
|
|
# Note that ++ doesn't behave identically on CPython and PyPy, so not using it here
|
|
_VERSION_PATTERN = r"""
|
|
v?+ # optional leading v
|
|
(?a:
|
|
(?:(?P<epoch>[0-9]+)!)?+ # epoch
|
|
(?P<release>[0-9]+(?:\.[0-9]+)*+) # release segment
|
|
(?P<pre> # pre-release
|
|
[._-]?+
|
|
(?P<pre_l>alpha|a|beta|b|preview|pre|c|rc)
|
|
[._-]?+
|
|
(?P<pre_n>[0-9]+)?
|
|
)?+
|
|
(?P<post> # post release
|
|
(?:-(?P<post_n1>[0-9]+))
|
|
|
|
|
(?:
|
|
[._-]?
|
|
(?P<post_l>post|rev|r)
|
|
[._-]?
|
|
(?P<post_n2>[0-9]+)?
|
|
)
|
|
)?+
|
|
(?P<dev> # dev release
|
|
[._-]?+
|
|
(?P<dev_l>dev)
|
|
[._-]?+
|
|
(?P<dev_n>[0-9]+)?
|
|
)?+
|
|
)
|
|
(?a:\+
|
|
(?P<local> # local version
|
|
[a-z0-9]+
|
|
(?:[._-][a-z0-9]+)*+
|
|
)
|
|
)?+
|
|
"""
|
|
|
|
_VERSION_PATTERN_OLD = _VERSION_PATTERN.replace("*+", "*").replace("?+", "?")
|
|
|
|
# Possessive qualifiers were added in Python 3.11.
|
|
# CPython 3.11.0-3.11.4 had a bug: https://github.com/python/cpython/pull/107795
|
|
# Older PyPy also had a bug.
|
|
VERSION_PATTERN = (
|
|
_VERSION_PATTERN_OLD
|
|
if (sys.implementation.name == "cpython" and sys.version_info < (3, 11, 5))
|
|
or (sys.implementation.name == "pypy" and sys.version_info < (3, 11, 13))
|
|
or sys.version_info < (3, 11)
|
|
else _VERSION_PATTERN
|
|
)
|
|
"""
|
|
A string containing the regular expression used to match a valid version.
|
|
|
|
The pattern is not anchored at either end, and is intended for embedding in larger
|
|
expressions (for example, matching a version number as part of a file name). The
|
|
regular expression should be compiled with the ``re.VERBOSE`` and ``re.IGNORECASE``
|
|
flags set.
|
|
|
|
.. versionchanged:: 26.0
|
|
|
|
The regex now uses possessive qualifiers on Python 3.11 if they are
|
|
supported (CPython 3.11.5+, PyPy 3.11.13+).
|
|
|
|
:meta hide-value:
|
|
"""
|
|
|
|
|
|
# Validation pattern for local version in replace()
|
|
_LOCAL_PATTERN = re.compile(r"[a-z0-9]+(?:[._-][a-z0-9]+)*", re.IGNORECASE | re.ASCII)
|
|
|
|
# Fast path: If a version has only digits and dots then we
|
|
# can skip the regex and parse it as a release segment
|
|
_SIMPLE_VERSION_INDICATORS = frozenset(".0123456789")
|
|
|
|
|
|
def _validate_epoch(value: object, /) -> int:
|
|
epoch = value or 0
|
|
if isinstance(epoch, int) and epoch >= 0:
|
|
return epoch
|
|
msg = f"epoch must be non-negative integer, got {epoch}"
|
|
raise InvalidVersion(msg)
|
|
|
|
|
|
def _validate_release(value: object, /) -> tuple[int, ...]:
|
|
release = (0,) if value is None else value
|
|
if (
|
|
isinstance(release, tuple)
|
|
and len(release) > 0
|
|
and all(isinstance(i, int) and i >= 0 for i in release)
|
|
):
|
|
return release
|
|
msg = f"release must be a non-empty tuple of non-negative integers, got {release}"
|
|
raise InvalidVersion(msg)
|
|
|
|
|
|
def _validate_pre(value: object, /) -> tuple[Literal["a", "b", "rc"], int] | None:
|
|
if value is None:
|
|
return value
|
|
if isinstance(value, tuple) and len(value) == 2:
|
|
letter, number = value
|
|
letter = normalize_pre(letter)
|
|
if letter in {"a", "b", "rc"} and isinstance(number, int) and number >= 0:
|
|
# type checkers can't infer the Literal type here on letter
|
|
return (letter, number) # type: ignore[return-value]
|
|
msg = f"pre must be a tuple of ('a'|'b'|'rc', non-negative int), got {value}"
|
|
raise InvalidVersion(msg)
|
|
|
|
|
|
def _validate_post(value: object, /) -> tuple[Literal["post"], int] | None:
|
|
if value is None:
|
|
return value
|
|
if isinstance(value, int) and value >= 0:
|
|
return ("post", value)
|
|
msg = f"post must be non-negative integer, got {value}"
|
|
raise InvalidVersion(msg)
|
|
|
|
|
|
def _validate_dev(value: object, /) -> tuple[Literal["dev"], int] | None:
|
|
if value is None:
|
|
return value
|
|
if isinstance(value, int) and value >= 0:
|
|
return ("dev", value)
|
|
msg = f"dev must be non-negative integer, got {value}"
|
|
raise InvalidVersion(msg)
|
|
|
|
|
|
def _validate_local(value: object, /) -> LocalType | None:
|
|
if value is None:
|
|
return value
|
|
if isinstance(value, str) and _LOCAL_PATTERN.fullmatch(value):
|
|
return _parse_local_version(value)
|
|
msg = f"local must be a valid version string, got {value!r}"
|
|
raise InvalidVersion(msg)
|
|
|
|
|
|
# Backward compatibility for internals before 26.0. Do not use.
|
|
class _Version(NamedTuple):
|
|
epoch: int
|
|
release: tuple[int, ...]
|
|
dev: tuple[Literal["dev"], int] | None
|
|
pre: tuple[Literal["a", "b", "rc"], int] | None
|
|
post: tuple[Literal["post"], int] | None
|
|
local: LocalType | None
|
|
|
|
|
|
class Version(_BaseVersion):
|
|
"""This class abstracts handling of a project's versions.
|
|
|
|
A :class:`Version` instance is comparison aware and can be compared and
|
|
sorted using the standard Python interfaces.
|
|
|
|
>>> v1 = Version("1.0a5")
|
|
>>> v2 = Version("1.0")
|
|
>>> v1
|
|
<Version('1.0a5')>
|
|
>>> v2
|
|
<Version('1.0')>
|
|
>>> v1 < v2
|
|
True
|
|
>>> v1 == v2
|
|
False
|
|
>>> v1 > v2
|
|
False
|
|
>>> v1 >= v2
|
|
False
|
|
>>> v1 <= v2
|
|
True
|
|
|
|
:class:`Version` is immutable; use :meth:`__replace__` to change
|
|
part of a version.
|
|
|
|
Instances are safe to serialize with :mod:`pickle`. They use a stable
|
|
format so the same pickle can be loaded in future packaging releases.
|
|
|
|
.. versionchanged:: 26.2
|
|
|
|
Added a stable pickle format. Pickles created with packaging 26.2+ can
|
|
be unpickled with future releases. Backward compatibility with pickles
|
|
from packaging < 26.2 is supported but may be removed in a future
|
|
release.
|
|
"""
|
|
|
|
__slots__ = (
|
|
"_dev",
|
|
"_epoch",
|
|
"_hash_cache",
|
|
"_key_cache",
|
|
"_local",
|
|
"_post",
|
|
"_pre",
|
|
"_release",
|
|
)
|
|
__match_args__ = ("_str",)
|
|
"""
|
|
Pattern matching is supported on Python 3.10+.
|
|
|
|
.. versionadded:: 26.0
|
|
|
|
:meta hide-value:
|
|
"""
|
|
|
|
_regex = re.compile(r"\s*" + VERSION_PATTERN + r"\s*", re.VERBOSE | re.IGNORECASE)
|
|
|
|
_epoch: int
|
|
_release: tuple[int, ...]
|
|
_dev: tuple[Literal["dev"], int] | None
|
|
_pre: tuple[Literal["a", "b", "rc"], int] | None
|
|
_post: tuple[Literal["post"], int] | None
|
|
_local: LocalType | None
|
|
|
|
_hash_cache: int | None
|
|
_key_cache: CmpKey | None
|
|
|
|
def __init__(self, version: str) -> None:
|
|
"""Initialize a Version object.
|
|
|
|
:param version:
|
|
The string representation of a version which will be parsed and normalized
|
|
before use.
|
|
:raises InvalidVersion:
|
|
If the ``version`` does not conform to PEP 440 in any way then this
|
|
exception will be raised.
|
|
"""
|
|
if _SIMPLE_VERSION_INDICATORS.issuperset(version):
|
|
try:
|
|
self._release = tuple(map(int, version.split(".")))
|
|
except ValueError:
|
|
# Empty parts (from "1..2", ".1", etc.) are invalid versions.
|
|
# Any other ValueError (e.g. int str-digits limit) should
|
|
# propagate to the caller.
|
|
if "" in version.split("."):
|
|
raise InvalidVersion(f"Invalid version: {version!r}") from None
|
|
# TODO: remove "no cover" when Python 3.9 is dropped.
|
|
raise # pragma: no cover
|
|
|
|
self._epoch = 0
|
|
self._pre = None
|
|
self._post = None
|
|
self._dev = None
|
|
self._local = None
|
|
self._key_cache = None
|
|
self._hash_cache = None
|
|
return
|
|
|
|
# Validate the version and parse it into pieces
|
|
match = self._regex.fullmatch(version)
|
|
if not match:
|
|
raise InvalidVersion(f"Invalid version: {version!r}")
|
|
self._epoch = int(match.group("epoch")) if match.group("epoch") else 0
|
|
self._release = tuple(map(int, match.group("release").split(".")))
|
|
# We can type ignore the assignments below because the regex guarantees
|
|
# the correct strings
|
|
self._pre = _parse_letter_version(match.group("pre_l"), match.group("pre_n")) # type: ignore[assignment]
|
|
self._post = _parse_letter_version( # type: ignore[assignment]
|
|
match.group("post_l"), match.group("post_n1") or match.group("post_n2")
|
|
)
|
|
self._dev = _parse_letter_version(match.group("dev_l"), match.group("dev_n")) # type: ignore[assignment]
|
|
self._local = _parse_local_version(match.group("local"))
|
|
|
|
# Key which will be used for sorting
|
|
self._key_cache = None
|
|
self._hash_cache = None
|
|
|
|
@classmethod
|
|
def from_parts(
|
|
cls,
|
|
*,
|
|
epoch: int = 0,
|
|
release: tuple[int, ...],
|
|
pre: tuple[str, int] | None = None,
|
|
post: int | None = None,
|
|
dev: int | None = None,
|
|
local: str | None = None,
|
|
) -> Self:
|
|
"""
|
|
Return a new version composed of the various parts.
|
|
|
|
This allows you to build a version without going though a string and
|
|
running a regular expression. It normalizes pre-release strings. The
|
|
``release=`` keyword argument is required.
|
|
|
|
>>> Version.from_parts(release=(1,2,3))
|
|
<Version('1.2.3')>
|
|
>>> Version.from_parts(release=(0,1,0), pre=("b", 1))
|
|
<Version('0.1.0b1')>
|
|
|
|
:param epoch:
|
|
:param release: This version tuple is required
|
|
|
|
.. versionadded:: 26.1
|
|
"""
|
|
_epoch = _validate_epoch(epoch)
|
|
_release = _validate_release(release)
|
|
_pre = _validate_pre(pre) if pre is not None else None
|
|
_post = _validate_post(post) if post is not None else None
|
|
_dev = _validate_dev(dev) if dev is not None else None
|
|
_local = _validate_local(local) if local is not None else None
|
|
|
|
new_version = cls.__new__(cls)
|
|
new_version._key_cache = None
|
|
new_version._hash_cache = None
|
|
new_version._epoch = _epoch
|
|
new_version._release = _release
|
|
new_version._pre = _pre
|
|
new_version._post = _post
|
|
new_version._dev = _dev
|
|
new_version._local = _local
|
|
|
|
return new_version
|
|
|
|
def __replace__(self, **kwargs: Unpack[_VersionReplace]) -> Self:
|
|
"""
|
|
__replace__(*, epoch=..., release=..., pre=..., post=..., dev=..., local=...)
|
|
|
|
Return a new version with parts replaced.
|
|
|
|
This returns a new version (unless no parts were changed). The
|
|
pre-release is normalized. Setting a value to ``None`` clears it.
|
|
|
|
>>> v = Version("1.2.3")
|
|
>>> v.__replace__(pre=("a", 1))
|
|
<Version('1.2.3a1')>
|
|
|
|
:param int | None epoch:
|
|
:param tuple[int, ...] | None release:
|
|
:param tuple[str, int] | None pre:
|
|
:param int | None post:
|
|
:param int | None dev:
|
|
:param str | None local:
|
|
|
|
.. versionadded:: 26.0
|
|
.. versionchanged:: 26.1
|
|
|
|
The pre-release portion is now normalized.
|
|
"""
|
|
epoch = _validate_epoch(kwargs["epoch"]) if "epoch" in kwargs else self._epoch
|
|
release = (
|
|
_validate_release(kwargs["release"])
|
|
if "release" in kwargs
|
|
else self._release
|
|
)
|
|
pre = _validate_pre(kwargs["pre"]) if "pre" in kwargs else self._pre
|
|
post = _validate_post(kwargs["post"]) if "post" in kwargs else self._post
|
|
dev = _validate_dev(kwargs["dev"]) if "dev" in kwargs else self._dev
|
|
local = _validate_local(kwargs["local"]) if "local" in kwargs else self._local
|
|
|
|
if (
|
|
epoch == self._epoch
|
|
and release == self._release
|
|
and pre == self._pre
|
|
and post == self._post
|
|
and dev == self._dev
|
|
and local == self._local
|
|
):
|
|
return self
|
|
|
|
new_version = self.__class__.__new__(self.__class__)
|
|
new_version._key_cache = None
|
|
new_version._hash_cache = None
|
|
new_version._epoch = epoch
|
|
new_version._release = release
|
|
new_version._pre = pre
|
|
new_version._post = post
|
|
new_version._dev = dev
|
|
new_version._local = local
|
|
|
|
return new_version
|
|
|
|
@property
|
|
def _key(self) -> CmpKey:
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
return self._key_cache
|
|
|
|
# __hash__ must be defined when __eq__ is overridden,
|
|
# otherwise Python sets __hash__ to None.
|
|
def __hash__(self) -> int:
|
|
if (cached_hash := self._hash_cache) is not None:
|
|
return cached_hash
|
|
|
|
if (key := self._key_cache) is None:
|
|
self._key_cache = key = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
self._hash_cache = cached_hash = hash(key)
|
|
return cached_hash
|
|
|
|
# Override comparison methods to use direct _key_cache access
|
|
# This is faster than property access, especially before Python 3.12
|
|
def __lt__(self, other: _BaseVersion) -> bool:
|
|
if isinstance(other, Version):
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
if other._key_cache is None:
|
|
other._key_cache = _cmpkey(
|
|
other._epoch,
|
|
other._release,
|
|
other._pre,
|
|
other._post,
|
|
other._dev,
|
|
other._local,
|
|
)
|
|
return self._key_cache < other._key_cache
|
|
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return super().__lt__(other)
|
|
|
|
def __le__(self, other: _BaseVersion) -> bool:
|
|
if isinstance(other, Version):
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
if other._key_cache is None:
|
|
other._key_cache = _cmpkey(
|
|
other._epoch,
|
|
other._release,
|
|
other._pre,
|
|
other._post,
|
|
other._dev,
|
|
other._local,
|
|
)
|
|
return self._key_cache <= other._key_cache
|
|
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return super().__le__(other)
|
|
|
|
def __eq__(self, other: object) -> bool:
|
|
if isinstance(other, Version):
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
if other._key_cache is None:
|
|
other._key_cache = _cmpkey(
|
|
other._epoch,
|
|
other._release,
|
|
other._pre,
|
|
other._post,
|
|
other._dev,
|
|
other._local,
|
|
)
|
|
return self._key_cache == other._key_cache
|
|
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return super().__eq__(other)
|
|
|
|
def __ge__(self, other: _BaseVersion) -> bool:
|
|
if isinstance(other, Version):
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
if other._key_cache is None:
|
|
other._key_cache = _cmpkey(
|
|
other._epoch,
|
|
other._release,
|
|
other._pre,
|
|
other._post,
|
|
other._dev,
|
|
other._local,
|
|
)
|
|
return self._key_cache >= other._key_cache
|
|
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return super().__ge__(other)
|
|
|
|
def __gt__(self, other: _BaseVersion) -> bool:
|
|
if isinstance(other, Version):
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
if other._key_cache is None:
|
|
other._key_cache = _cmpkey(
|
|
other._epoch,
|
|
other._release,
|
|
other._pre,
|
|
other._post,
|
|
other._dev,
|
|
other._local,
|
|
)
|
|
return self._key_cache > other._key_cache
|
|
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return super().__gt__(other)
|
|
|
|
def __ne__(self, other: object) -> bool:
|
|
if isinstance(other, Version):
|
|
if self._key_cache is None:
|
|
self._key_cache = _cmpkey(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
if other._key_cache is None:
|
|
other._key_cache = _cmpkey(
|
|
other._epoch,
|
|
other._release,
|
|
other._pre,
|
|
other._post,
|
|
other._dev,
|
|
other._local,
|
|
)
|
|
return self._key_cache != other._key_cache
|
|
|
|
if not isinstance(other, _BaseVersion):
|
|
return NotImplemented
|
|
|
|
return super().__ne__(other)
|
|
|
|
def __getstate__(
|
|
self,
|
|
) -> tuple[
|
|
int,
|
|
tuple[int, ...],
|
|
tuple[str, int] | None,
|
|
tuple[str, int] | None,
|
|
tuple[str, int] | None,
|
|
LocalType | None,
|
|
]:
|
|
# Return state as a 6-item tuple for compactness:
|
|
# (epoch, release, pre, post, dev, local)
|
|
# Cache members are excluded and will be recomputed on demand
|
|
return (
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
)
|
|
|
|
def __setstate__(self, state: object) -> None:
|
|
# Always discard cached values — they may contain stale references
|
|
# (e.g. packaging._structures.InfinityType from pre-26.1 pickles)
|
|
# and will be recomputed on demand from the core fields above.
|
|
self._key_cache = None
|
|
self._hash_cache = None
|
|
|
|
if isinstance(state, tuple):
|
|
if len(state) == 6:
|
|
# New format (26.2+): (epoch, release, pre, post, dev, local)
|
|
(
|
|
self._epoch,
|
|
self._release,
|
|
self._pre,
|
|
self._post,
|
|
self._dev,
|
|
self._local,
|
|
) = state
|
|
return
|
|
if len(state) == 2:
|
|
# Format (packaging 26.0-26.1): (None, {slot: value}).
|
|
_, slot_dict = state
|
|
if isinstance(slot_dict, dict):
|
|
self._epoch = slot_dict["_epoch"]
|
|
self._release = slot_dict["_release"]
|
|
self._pre = slot_dict.get("_pre")
|
|
self._post = slot_dict.get("_post")
|
|
self._dev = slot_dict.get("_dev")
|
|
self._local = slot_dict.get("_local")
|
|
return
|
|
if isinstance(state, dict):
|
|
# Old format (packaging <= 25.x, no __slots__): state is a plain
|
|
# dict with "_version" (_Version NamedTuple) and "_key" entries.
|
|
version_nt = state.get("_version")
|
|
if version_nt is not None:
|
|
self._epoch = version_nt.epoch
|
|
self._release = version_nt.release
|
|
self._pre = version_nt.pre
|
|
self._post = version_nt.post
|
|
self._dev = version_nt.dev
|
|
self._local = version_nt.local
|
|
return
|
|
|
|
raise TypeError(f"Cannot restore Version from {state!r}")
|
|
|
|
@property
|
|
@_deprecated("Version._version is private and will be removed soon")
|
|
def _version(self) -> _Version:
|
|
return _Version(
|
|
self._epoch, self._release, self._dev, self._pre, self._post, self._local
|
|
)
|
|
|
|
@_version.setter
|
|
@_deprecated("Version._version is private and will be removed soon")
|
|
def _version(self, value: _Version) -> None:
|
|
self._epoch = value.epoch
|
|
self._release = value.release
|
|
self._dev = value.dev
|
|
self._pre = value.pre
|
|
self._post = value.post
|
|
self._local = value.local
|
|
self._key_cache = None
|
|
self._hash_cache = None
|
|
|
|
def __repr__(self) -> str:
|
|
"""A representation of the Version that shows all internal state.
|
|
|
|
>>> Version('1.0.0')
|
|
<Version('1.0.0')>
|
|
"""
|
|
return f"<{self.__class__.__name__}({str(self)!r})>"
|
|
|
|
def __str__(self) -> str:
|
|
"""A string representation of the version that can be round-tripped.
|
|
|
|
>>> str(Version("1.0a5"))
|
|
'1.0a5'
|
|
"""
|
|
# This is a hot function, so not calling self.base_version
|
|
version = ".".join(map(str, self.release))
|
|
|
|
# Epoch
|
|
if self.epoch:
|
|
version = f"{self.epoch}!{version}"
|
|
|
|
# Pre-release
|
|
if self.pre is not None:
|
|
version += "".join(map(str, self.pre))
|
|
|
|
# Post-release
|
|
if self.post is not None:
|
|
version += f".post{self.post}"
|
|
|
|
# Development release
|
|
if self.dev is not None:
|
|
version += f".dev{self.dev}"
|
|
|
|
# Local version segment
|
|
if self.local is not None:
|
|
version += f"+{self.local}"
|
|
|
|
return version
|
|
|
|
@property
|
|
def _str(self) -> str:
|
|
"""Internal property for match_args"""
|
|
return str(self)
|
|
|
|
@property
|
|
def epoch(self) -> int:
|
|
"""The epoch of the version.
|
|
|
|
>>> Version("2.0.0").epoch
|
|
0
|
|
>>> Version("1!2.0.0").epoch
|
|
1
|
|
"""
|
|
return self._epoch
|
|
|
|
@property
|
|
def release(self) -> tuple[int, ...]:
|
|
"""The components of the "release" segment of the version.
|
|
|
|
>>> Version("1.2.3").release
|
|
(1, 2, 3)
|
|
>>> Version("2.0.0").release
|
|
(2, 0, 0)
|
|
>>> Version("1!2.0.0.post0").release
|
|
(2, 0, 0)
|
|
|
|
Includes trailing zeroes but not the epoch or any pre-release / development /
|
|
post-release suffixes.
|
|
"""
|
|
return self._release
|
|
|
|
@property
|
|
def pre(self) -> tuple[Literal["a", "b", "rc"], int] | None:
|
|
"""The pre-release segment of the version.
|
|
|
|
>>> print(Version("1.2.3").pre)
|
|
None
|
|
>>> Version("1.2.3a1").pre
|
|
('a', 1)
|
|
>>> Version("1.2.3b1").pre
|
|
('b', 1)
|
|
>>> Version("1.2.3rc1").pre
|
|
('rc', 1)
|
|
"""
|
|
return self._pre
|
|
|
|
@property
|
|
def post(self) -> int | None:
|
|
"""The post-release number of the version.
|
|
|
|
>>> print(Version("1.2.3").post)
|
|
None
|
|
>>> Version("1.2.3.post1").post
|
|
1
|
|
"""
|
|
return self._post[1] if self._post else None
|
|
|
|
@property
|
|
def dev(self) -> int | None:
|
|
"""The development number of the version.
|
|
|
|
>>> print(Version("1.2.3").dev)
|
|
None
|
|
>>> Version("1.2.3.dev1").dev
|
|
1
|
|
"""
|
|
return self._dev[1] if self._dev else None
|
|
|
|
@property
|
|
def local(self) -> str | None:
|
|
"""The local version segment of the version.
|
|
|
|
>>> print(Version("1.2.3").local)
|
|
None
|
|
>>> Version("1.2.3+abc").local
|
|
'abc'
|
|
"""
|
|
if self._local:
|
|
return ".".join(str(x) for x in self._local)
|
|
else:
|
|
return None
|
|
|
|
@property
|
|
def public(self) -> str:
|
|
"""The public portion of the version.
|
|
|
|
This returns a string. If you want a :class:`Version` again and care
|
|
about performance, use ``v.__replace__(local=None)`` instead.
|
|
|
|
>>> Version("1.2.3").public
|
|
'1.2.3'
|
|
>>> Version("1.2.3+abc").public
|
|
'1.2.3'
|
|
>>> Version("1!1.2.3dev1+abc").public
|
|
'1!1.2.3.dev1'
|
|
"""
|
|
return str(self).split("+", 1)[0]
|
|
|
|
@property
|
|
def base_version(self) -> str:
|
|
"""The "base version" of the version.
|
|
|
|
This returns a string. If you want a :class:`Version` again and care
|
|
about performance, use
|
|
``v.__replace__(pre=None, post=None, dev=None, local=None)`` instead.
|
|
|
|
>>> Version("1.2.3").base_version
|
|
'1.2.3'
|
|
>>> Version("1.2.3+abc").base_version
|
|
'1.2.3'
|
|
>>> Version("1!1.2.3dev1+abc").base_version
|
|
'1!1.2.3'
|
|
|
|
The "base version" is the public version of the project without any pre or post
|
|
release markers.
|
|
"""
|
|
release_segment = ".".join(map(str, self.release))
|
|
return f"{self.epoch}!{release_segment}" if self.epoch else release_segment
|
|
|
|
@property
|
|
def is_prerelease(self) -> bool:
|
|
"""Whether this version is a pre-release.
|
|
|
|
>>> Version("1.2.3").is_prerelease
|
|
False
|
|
>>> Version("1.2.3a1").is_prerelease
|
|
True
|
|
>>> Version("1.2.3b1").is_prerelease
|
|
True
|
|
>>> Version("1.2.3rc1").is_prerelease
|
|
True
|
|
>>> Version("1.2.3dev1").is_prerelease
|
|
True
|
|
"""
|
|
return self.dev is not None or self.pre is not None
|
|
|
|
@property
|
|
def is_postrelease(self) -> bool:
|
|
"""Whether this version is a post-release.
|
|
|
|
>>> Version("1.2.3").is_postrelease
|
|
False
|
|
>>> Version("1.2.3.post1").is_postrelease
|
|
True
|
|
"""
|
|
return self.post is not None
|
|
|
|
@property
|
|
def is_devrelease(self) -> bool:
|
|
"""Whether this version is a development release.
|
|
|
|
>>> Version("1.2.3").is_devrelease
|
|
False
|
|
>>> Version("1.2.3.dev1").is_devrelease
|
|
True
|
|
"""
|
|
return self.dev is not None
|
|
|
|
@property
|
|
def major(self) -> int:
|
|
"""The first item of :attr:`release` or ``0`` if unavailable.
|
|
|
|
>>> Version("1.2.3").major
|
|
1
|
|
"""
|
|
return self.release[0] if len(self.release) >= 1 else 0
|
|
|
|
@property
|
|
def minor(self) -> int:
|
|
"""The second item of :attr:`release` or ``0`` if unavailable.
|
|
|
|
>>> Version("1.2.3").minor
|
|
2
|
|
>>> Version("1").minor
|
|
0
|
|
"""
|
|
return self.release[1] if len(self.release) >= 2 else 0
|
|
|
|
@property
|
|
def micro(self) -> int:
|
|
"""The third item of :attr:`release` or ``0`` if unavailable.
|
|
|
|
>>> Version("1.2.3").micro
|
|
3
|
|
>>> Version("1").micro
|
|
0
|
|
"""
|
|
return self.release[2] if len(self.release) >= 3 else 0
|
|
|
|
|
|
class _TrimmedRelease(Version):
|
|
__slots__ = ()
|
|
|
|
def __init__(self, version: str | Version) -> None:
|
|
if isinstance(version, Version):
|
|
self._epoch = version._epoch
|
|
self._release = version._release
|
|
self._dev = version._dev
|
|
self._pre = version._pre
|
|
self._post = version._post
|
|
self._local = version._local
|
|
self._key_cache = version._key_cache
|
|
return
|
|
super().__init__(version) # pragma: no cover
|
|
|
|
@property
|
|
def release(self) -> tuple[int, ...]:
|
|
"""
|
|
Release segment without any trailing zeros.
|
|
|
|
>>> _TrimmedRelease('1.0.0').release
|
|
(1,)
|
|
>>> _TrimmedRelease('0.0').release
|
|
(0,)
|
|
"""
|
|
# This leaves one 0.
|
|
rel = super().release
|
|
len_release = len(rel)
|
|
i = len_release
|
|
while i > 1 and rel[i - 1] == 0:
|
|
i -= 1
|
|
return rel if i == len_release else rel[:i]
|
|
|
|
|
|
def _parse_letter_version(
|
|
letter: str | None, number: str | bytes | SupportsInt | None
|
|
) -> tuple[str, int] | None:
|
|
if letter:
|
|
# We normalize any letters to their lower case form
|
|
letter = letter.lower()
|
|
|
|
# We consider some words to be alternate spellings of other words and
|
|
# in those cases we want to normalize the spellings to our preferred
|
|
# spelling.
|
|
letter = _LETTER_NORMALIZATION.get(letter, letter)
|
|
|
|
# We consider there to be an implicit 0 in a pre-release if there is
|
|
# not a numeral associated with it.
|
|
return letter, int(number or 0)
|
|
|
|
if number:
|
|
# We assume if we are given a number, but we are not given a letter
|
|
# then this is using the implicit post release syntax (e.g. 1.0-1)
|
|
return "post", int(number)
|
|
|
|
return None
|
|
|
|
|
|
_local_version_separators = re.compile(r"[\._-]")
|
|
|
|
|
|
def _parse_local_version(local: str | None) -> LocalType | None:
|
|
"""
|
|
Takes a string like ``"abc.1.twelve"`` and turns it into
|
|
``("abc", 1, "twelve")``.
|
|
"""
|
|
if local is not None:
|
|
return tuple(
|
|
part.lower() if not part.isdigit() else int(part)
|
|
for part in _local_version_separators.split(local)
|
|
)
|
|
return None
|
|
|
|
|
|
# Sort ranks for pre-release: dev-only < a < b < rc < stable (no pre-release).
|
|
_PRE_RANK = {"a": 0, "b": 1, "rc": 2}
|
|
_PRE_RANK_DEV_ONLY = -1 # sorts before a(0)
|
|
_PRE_RANK_STABLE = 3 # sorts after rc(2)
|
|
|
|
# In local version segments, strings sort before ints per PEP 440.
|
|
_LOCAL_STR_RANK = -1 # sorts before all non-negative ints
|
|
|
|
# Pre-computed suffix for stable releases (no pre, post, or dev segments).
|
|
# See _cmpkey() for the suffix layout.
|
|
_STABLE_SUFFIX = (_PRE_RANK_STABLE, 0, 0, 0, 1, 0)
|
|
|
|
|
|
def _cmpkey(
|
|
epoch: int,
|
|
release: tuple[int, ...],
|
|
pre: tuple[str, int] | None,
|
|
post: tuple[str, int] | None,
|
|
dev: tuple[str, int] | None,
|
|
local: LocalType | None,
|
|
) -> CmpKey:
|
|
"""Build a comparison key for PEP 440 ordering.
|
|
|
|
Returns ``(epoch, release, suffix)`` or
|
|
``(epoch, release, suffix, local)`` so that plain tuple
|
|
comparison gives the correct order.
|
|
|
|
Trailing zeros are stripped from the release so that ``1.0.0 == 1``.
|
|
|
|
The suffix is a flat 6-int tuple that encodes pre/post/dev:
|
|
``(pre_rank, pre_n, post_rank, post_n, dev_rank, dev_n)``
|
|
|
|
pre_rank: dev-only=-1, a=0, b=1, rc=2, no-pre=3
|
|
Dev-only releases (no pre or post) get -1 so they sort before
|
|
any alpha/beta/rc. Releases without a pre-release tag get 3
|
|
so they sort after rc.
|
|
post_rank: no-post=0, post=1
|
|
Releases without a post segment sort before those with one.
|
|
dev_rank: dev=0, no-dev=1
|
|
Releases without a dev segment sort after those with one.
|
|
|
|
Local segments use ``(n, "")`` for ints and ``(-1, s)`` for strings,
|
|
following PEP 440: strings sort before ints, strings compare
|
|
lexicographically, ints compare numerically, and shorter segments
|
|
sort before longer when prefixes match. Versions without a local
|
|
segment sort before those with one (3-tuple < 4-tuple).
|
|
|
|
>>> _cmpkey(0, (1, 0, 0), None, None, None, None)
|
|
(0, (1,), (3, 0, 0, 0, 1, 0))
|
|
>>> _cmpkey(0, (1,), ("a", 1), None, None, None)
|
|
(0, (1,), (0, 1, 0, 0, 1, 0))
|
|
>>> _cmpkey(0, (1,), None, None, None, ("ubuntu", 1))
|
|
(0, (1,), (3, 0, 0, 0, 1, 0), ((-1, 'ubuntu'), (1, '')))
|
|
"""
|
|
# Strip trailing zeros: 1.0.0 compares equal to 1.
|
|
len_release = len(release)
|
|
i = len_release
|
|
while i and release[i - 1] == 0:
|
|
i -= 1
|
|
trimmed = release if i == len_release else release[:i]
|
|
|
|
# Fast path: stable release with no local segment.
|
|
if pre is None and post is None and dev is None and local is None:
|
|
return epoch, trimmed, _STABLE_SUFFIX
|
|
|
|
if pre is None and post is None and dev is not None:
|
|
# dev-only (e.g. 1.0.dev1) sorts before all pre-releases.
|
|
pre_rank, pre_n = _PRE_RANK_DEV_ONLY, 0
|
|
elif pre is None:
|
|
pre_rank, pre_n = _PRE_RANK_STABLE, 0
|
|
else:
|
|
pre_rank, pre_n = _PRE_RANK[pre[0]], pre[1]
|
|
|
|
post_rank = 0 if post is None else 1
|
|
post_n = 0 if post is None else post[1]
|
|
|
|
dev_rank = 1 if dev is None else 0
|
|
dev_n = 0 if dev is None else dev[1]
|
|
|
|
suffix = (pre_rank, pre_n, post_rank, post_n, dev_rank, dev_n)
|
|
|
|
if local is None:
|
|
return epoch, trimmed, suffix
|
|
|
|
cmp_local: CmpLocalType = tuple(
|
|
(seg, "") if isinstance(seg, int) else (_LOCAL_STR_RANK, seg) for seg in local
|
|
)
|
|
return epoch, trimmed, suffix, cmp_local
|