Files
openswarm/.venv/lib/python3.12/site-packages/packaging/specifiers.py
T
3008f083ca [aidan] feat: scheduled tasks (#105)
* [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>
2026-06-24 18:58:43 -07:00

1944 lines
70 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.specifiers import Specifier, SpecifierSet, InvalidSpecifier
from packaging.version import Version
"""
from __future__ import annotations
import abc
import enum
import functools
import itertools
import re
import sys
import typing
from typing import (
TYPE_CHECKING,
Any,
Callable,
Final,
Iterable,
Iterator,
Sequence,
TypeVar,
Union,
)
from .utils import canonicalize_version
from .version import InvalidVersion, Version
if sys.version_info >= (3, 10):
from typing import TypeGuard # pragma: no cover
elif TYPE_CHECKING:
from typing_extensions import TypeGuard
__all__ = [
"BaseSpecifier",
"InvalidSpecifier",
"Specifier",
"SpecifierSet",
]
def __dir__() -> list[str]:
return __all__
def _validate_spec(spec: object, /) -> TypeGuard[tuple[str, str]]:
return (
isinstance(spec, tuple)
and len(spec) == 2
and isinstance(spec[0], str)
and isinstance(spec[1], str)
)
def _validate_pre(pre: object, /) -> TypeGuard[bool | None]:
return pre is None or isinstance(pre, bool)
T = TypeVar("T")
UnparsedVersion = Union[Version, str]
UnparsedVersionVar = TypeVar("UnparsedVersionVar", bound=UnparsedVersion)
CallableOperator = Callable[[Version, str], bool]
# The smallest possible PEP 440 version. No valid version is less than this.
_MIN_VERSION: Final[Version] = Version("0.dev0")
def _trim_release(release: tuple[int, ...]) -> tuple[int, ...]:
"""Strip trailing zeros from a release tuple for normalized comparison."""
end = len(release)
while end > 1 and release[end - 1] == 0:
end -= 1
return release if end == len(release) else release[:end]
class _BoundaryKind(enum.Enum):
"""Where a boundary marker sits in the version ordering."""
AFTER_LOCALS = enum.auto() # after V+local, before V.post0
AFTER_POSTS = enum.auto() # after V.postN, before next release
@functools.total_ordering
class _BoundaryVersion:
"""A point on the version line between two real PEP 440 versions.
Some specifier semantics imply boundaries between real versions:
``<=1.0`` includes ``1.0+local`` and ``>1.0`` excludes
``1.0.post0``. No real :class:`Version` falls on those boundaries,
so this class creates values that sort between the real versions
on either side.
Two kinds exist, shown relative to a base version V::
V < V+local < AFTER_LOCALS(V) < V.post0 < AFTER_POSTS(V)
``AFTER_LOCALS`` sits after V and every V+local, but before
V.post0. Upper bound of ``<=V``, ``==V``, ``!=V``.
``AFTER_POSTS`` sits after every V.postN, but before the next
release segment. Lower bound of ``>V`` (final or pre-release V)
to exclude post-releases per PEP 440.
"""
__slots__ = ("_kind", "_trimmed_release", "version")
def __init__(self, version: Version, kind: _BoundaryKind) -> None:
self.version = version
self._kind = kind
self._trimmed_release = _trim_release(version.release)
def _is_family(self, other: Version) -> bool:
"""Is ``other`` a version that this boundary sorts above?"""
v = self.version
if not (
other.epoch == v.epoch
and _trim_release(other.release) == self._trimmed_release
and other.pre == v.pre
):
return False
if self._kind == _BoundaryKind.AFTER_LOCALS:
# Local family: exact same public version (any local label).
return other.post == v.post and other.dev == v.dev
# Post family: same base + any post-release (or identical).
return other.dev == v.dev or other.post is not None
def __eq__(self, other: object) -> bool:
if isinstance(other, _BoundaryVersion):
return self.version == other.version and self._kind == other._kind
return NotImplemented
def __lt__(self, other: _BoundaryVersion | Version) -> bool:
if isinstance(other, _BoundaryVersion):
if self.version != other.version:
return self.version < other.version
return self._kind.value < other._kind.value
return not self._is_family(other) and self.version < other
def __hash__(self) -> int:
return hash((self.version, self._kind))
def __repr__(self) -> str:
return f"{self.__class__.__name__}({self.version!r}, {self._kind.name})"
@functools.total_ordering
class _LowerBound:
"""Lower bound of a version range.
A version *v* of ``None`` means unbounded below (-inf).
At equal versions, ``[v`` sorts before ``(v`` because an inclusive
bound starts earlier.
"""
__slots__ = ("inclusive", "version")
def __init__(self, version: _VersionOrBoundary, inclusive: bool) -> None:
self.version = version
self.inclusive = inclusive
def __eq__(self, other: object) -> bool:
if not isinstance(other, _LowerBound):
return NotImplemented # pragma: no cover
return self.version == other.version and self.inclusive == other.inclusive
def __lt__(self, other: _LowerBound) -> bool:
if not isinstance(other, _LowerBound): # pragma: no cover
return NotImplemented
# -inf < anything (except -inf).
if self.version is None:
return other.version is not None
if other.version is None:
return False
if self.version != other.version:
return self.version < other.version
# [v < (v: inclusive starts earlier.
return self.inclusive and not other.inclusive
def __hash__(self) -> int:
return hash((self.version, self.inclusive))
def __repr__(self) -> str:
bracket = "[" if self.inclusive else "("
return f"<{self.__class__.__name__} {bracket}{self.version!r}>"
@functools.total_ordering
class _UpperBound:
"""Upper bound of a version range.
A version *v* of ``None`` means unbounded above (+inf).
At equal versions, ``v)`` sorts before ``v]`` because an exclusive
bound ends earlier.
"""
__slots__ = ("inclusive", "version")
def __init__(self, version: _VersionOrBoundary, inclusive: bool) -> None:
self.version = version
self.inclusive = inclusive
def __eq__(self, other: object) -> bool:
if not isinstance(other, _UpperBound):
return NotImplemented # pragma: no cover
return self.version == other.version and self.inclusive == other.inclusive
def __lt__(self, other: _UpperBound) -> bool:
if not isinstance(other, _UpperBound): # pragma: no cover
return NotImplemented
# Nothing < +inf (except +inf itself).
if self.version is None:
return False
if other.version is None:
return True
if self.version != other.version:
return self.version < other.version
# v) < v]: exclusive ends earlier.
return not self.inclusive and other.inclusive
def __hash__(self) -> int:
return hash((self.version, self.inclusive))
def __repr__(self) -> str:
bracket = "]" if self.inclusive else ")"
return f"<{self.__class__.__name__} {self.version!r}{bracket}>"
if typing.TYPE_CHECKING:
_VersionOrBoundary = Union[Version, _BoundaryVersion, None]
#: A single contiguous version range, represented as a
#: (lower bound, upper bound) pair.
_VersionRange = tuple[_LowerBound, _UpperBound]
_NEG_INF = _LowerBound(None, False)
_POS_INF = _UpperBound(None, False)
_FULL_RANGE: tuple[_VersionRange] = ((_NEG_INF, _POS_INF),)
def _range_is_empty(lower: _LowerBound, upper: _UpperBound) -> bool:
"""True when the range defined by *lower* and *upper* contains no versions."""
if lower.version is None or upper.version is None:
return False
if lower.version == upper.version:
return not (lower.inclusive and upper.inclusive)
return lower.version > upper.version
def _intersect_ranges(
left: Sequence[_VersionRange],
right: Sequence[_VersionRange],
) -> list[_VersionRange]:
"""Intersect two sorted, non-overlapping range lists (two-pointer merge)."""
result: list[_VersionRange] = []
left_index = right_index = 0
while left_index < len(left) and right_index < len(right):
left_lower, left_upper = left[left_index]
right_lower, right_upper = right[right_index]
lower = max(left_lower, right_lower)
upper = min(left_upper, right_upper)
if not _range_is_empty(lower, upper):
result.append((lower, upper))
# Advance whichever side has the smaller upper bound.
if left_upper < right_upper:
left_index += 1
else:
right_index += 1
return result
def _next_prefix_dev0(version: Version) -> Version:
"""Smallest version in the next prefix: 1.2 -> 1.3.dev0."""
release = (*version.release[:-1], version.release[-1] + 1)
return Version.from_parts(epoch=version.epoch, release=release, dev=0)
def _base_dev0(version: Version) -> Version:
"""The .dev0 of a version's base release: 1.2 -> 1.2.dev0."""
return Version.from_parts(epoch=version.epoch, release=version.release, dev=0)
def _coerce_version(version: UnparsedVersion) -> Version | None:
if not isinstance(version, Version):
try:
version = Version(version)
except InvalidVersion:
return None
return version
def _public_version(version: Version) -> Version:
if version.local is None:
return version
return version.__replace__(local=None)
def _post_base(version: Version) -> Version:
"""The version that *version* is a post-release of.
1.0.post1 -> 1.0, 1.0a1.post0 -> 1.0a1, 1.0.post0.dev1 -> 1.0.
"""
return version.__replace__(post=None, dev=None, local=None)
def _earliest_prerelease(version: Version) -> Version:
"""Earliest pre-release of *version*.
1.2 -> 1.2.dev0, 1.2.post1 -> 1.2.post1.dev0.
"""
return version.__replace__(dev=0, local=None)
def _nearest_non_prerelease(
v: _VersionOrBoundary,
) -> Version | None:
"""Smallest non-pre-release version at or above *v*, or None."""
if v is None:
return None
if isinstance(v, _BoundaryVersion):
inner = v.version
if inner.is_prerelease:
# AFTER_LOCALS(1.0a1) -> nearest non-pre is 1.0
return inner.__replace__(pre=None, dev=None, local=None)
# AFTER_LOCALS(1.0) -> nearest non-pre is 1.0.post0
# AFTER_LOCALS(1.0.post0) -> nearest non-pre is 1.0.post1
k = (inner.post + 1) if inner.post is not None else 0
return inner.__replace__(post=k, local=None)
if not v.is_prerelease:
return v
# Strip pre/dev to get the final or post-release form.
return v.__replace__(pre=None, dev=None, local=None)
class InvalidSpecifier(ValueError):
"""
Raised when attempting to create a :class:`Specifier` with a specifier
string that is invalid.
>>> Specifier("lolwat")
Traceback (most recent call last):
...
packaging.specifiers.InvalidSpecifier: Invalid specifier: 'lolwat'
"""
class BaseSpecifier(metaclass=abc.ABCMeta):
__slots__ = ()
__match_args__ = ("_str",)
@property
def _str(self) -> str:
"""Internal property for match_args"""
return str(self)
@abc.abstractmethod
def __str__(self) -> str:
"""
Returns the str representation of this Specifier-like object. This
should be representative of the Specifier itself.
"""
@abc.abstractmethod
def __hash__(self) -> int:
"""
Returns a hash value for this Specifier-like object.
"""
@abc.abstractmethod
def __eq__(self, other: object) -> bool:
"""
Returns a boolean representing whether or not the two Specifier-like
objects are equal.
:param other: The other object to check against.
"""
@property
@abc.abstractmethod
def prereleases(self) -> bool | None:
"""Whether or not pre-releases as a whole are allowed.
This can be set to either ``True`` or ``False`` to explicitly enable or disable
prereleases or it can be set to ``None`` (the default) to use default semantics.
"""
@prereleases.setter # noqa: B027
def prereleases(self, value: bool) -> None:
"""Setter for :attr:`prereleases`.
:param value: The value to set.
"""
@abc.abstractmethod
def contains(self, item: str, prereleases: bool | None = None) -> bool:
"""
Determines if the given item is contained within this specifier.
"""
@typing.overload
def filter(
self,
iterable: Iterable[UnparsedVersionVar],
prereleases: bool | None = None,
key: None = ...,
) -> Iterator[UnparsedVersionVar]: ...
@typing.overload
def filter(
self,
iterable: Iterable[T],
prereleases: bool | None = None,
key: Callable[[T], UnparsedVersion] = ...,
) -> Iterator[T]: ...
@abc.abstractmethod
def filter(
self,
iterable: Iterable[Any],
prereleases: bool | None = None,
key: Callable[[Any], UnparsedVersion] | None = None,
) -> Iterator[Any]:
"""
Takes an iterable of items and filters them so that only items which
are contained within this specifier are allowed in it.
"""
class Specifier(BaseSpecifier):
"""This class abstracts handling of version specifiers.
.. tip::
It is generally not required to instantiate this manually. You should instead
prefer to work with :class:`SpecifierSet` instead, which can parse
comma-separated version specifiers (which is what package metadata contains).
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__ = (
"_prereleases",
"_ranges",
"_spec",
"_spec_version",
"_wildcard_split",
)
_specifier_regex_str = r"""
(?:
(?:
# The identity operators allow for an escape hatch that will
# do an exact string match of the version you wish to install.
# This will not be parsed by PEP 440 and we cannot determine
# any semantic meaning from it. This operator is discouraged
# but included entirely as an escape hatch.
=== # Only match for the identity operator
\s*
[^\s;)]* # The arbitrary version can be just about anything,
# we match everything except for whitespace, a
# semi-colon for marker support, and a closing paren
# since versions can be enclosed in them.
)
|
(?:
# The (non)equality operators allow for wild card and local
# versions to be specified so we have to define these two
# operators separately to enable that.
(?:==|!=) # Only match for equals and not equals
\s*
v?
(?:[0-9]+!)? # epoch
[0-9]+(?:\.[0-9]+)* # release
# You cannot use a wild card and a pre-release, post-release, a dev or
# local version together so group them with a | and make them optional.
(?:
\.\* # Wild card syntax of .*
|
(?a: # pre release
[-_\.]?
(alpha|beta|preview|pre|a|b|c|rc)
[-_\.]?
[0-9]*
)?
(?a: # post release
(?:-[0-9]+)|(?:[-_\.]?(post|rev|r)[-_\.]?[0-9]*)
)?
(?a:[-_\.]?dev[-_\.]?[0-9]*)? # dev release
(?a:\+[a-z0-9]+(?:[-_\.][a-z0-9]+)*)? # local
)?
)
|
(?:
# The compatible operator requires at least two digits in the
# release segment.
(?:~=) # Only match for the compatible operator
\s*
v?
(?:[0-9]+!)? # epoch
[0-9]+(?:\.[0-9]+)+ # release (We have a + instead of a *)
(?: # pre release
[-_\.]?
(alpha|beta|preview|pre|a|b|c|rc)
[-_\.]?
[0-9]*
)?
(?: # post release
(?:-[0-9]+)|(?:[-_\.]?(post|rev|r)[-_\.]?[0-9]*)
)?
(?:[-_\.]?dev[-_\.]?[0-9]*)? # dev release
)
|
(?:
# All other operators only allow a sub set of what the
# (non)equality operators do. Specifically they do not allow
# local versions to be specified nor do they allow the prefix
# matching wild cards.
(?:<=|>=|<|>)
\s*
v?
(?:[0-9]+!)? # epoch
[0-9]+(?:\.[0-9]+)* # release
(?a: # pre release
[-_\.]?
(alpha|beta|preview|pre|a|b|c|rc)
[-_\.]?
[0-9]*
)?
(?a: # post release
(?:-[0-9]+)|(?:[-_\.]?(post|rev|r)[-_\.]?[0-9]*)
)?
(?a:[-_\.]?dev[-_\.]?[0-9]*)? # dev release
)
)
"""
_regex = re.compile(
r"\s*" + _specifier_regex_str + r"\s*", re.VERBOSE | re.IGNORECASE
)
_operators: Final = {
"~=": "compatible",
"==": "equal",
"!=": "not_equal",
"<=": "less_than_equal",
">=": "greater_than_equal",
"<": "less_than",
">": "greater_than",
"===": "arbitrary",
}
def __init__(self, spec: str = "", prereleases: bool | None = None) -> None:
"""Initialize a Specifier instance.
:param spec:
The string representation of a specifier which will be parsed and
normalized before use.
:param prereleases:
This tells the specifier if it should accept prerelease versions if
applicable or not. The default of ``None`` will autodetect it from the
given specifiers.
:raises InvalidSpecifier:
If the given specifier is invalid (i.e. bad syntax).
"""
if not self._regex.fullmatch(spec):
raise InvalidSpecifier(f"Invalid specifier: {spec!r}")
spec = spec.strip()
if spec.startswith("==="):
operator, version = spec[:3], spec[3:].strip()
elif spec.startswith(("~=", "==", "!=", "<=", ">=")):
operator, version = spec[:2], spec[2:].strip()
else:
operator, version = spec[:1], spec[1:].strip()
self._spec: tuple[str, str] = (operator, version)
# Store whether or not this Specifier should accept prereleases
self._prereleases = prereleases
# Specifier version cache
self._spec_version: tuple[str, Version] | None = None
# Populated on first wildcard (==X.*) comparison
self._wildcard_split: tuple[list[str], int] | None = None
# Version range cache (populated by _to_ranges)
self._ranges: Sequence[_VersionRange] | None = None
def _get_spec_version(self, version: str) -> Version | None:
"""One element cache, as only one spec Version is needed per Specifier."""
if self._spec_version is not None and self._spec_version[0] == version:
return self._spec_version[1]
version_specifier = _coerce_version(version)
if version_specifier is None:
return None
self._spec_version = (version, version_specifier)
return version_specifier
def _require_spec_version(self, version: str) -> Version:
"""Get spec version, asserting it's valid (not for === operator).
This method should only be called for operators where version
strings are guaranteed to be valid PEP 440 versions (not ===).
"""
spec_version = self._get_spec_version(version)
assert spec_version is not None
return spec_version
def _to_ranges(self) -> Sequence[_VersionRange]:
"""Convert this specifier to sorted, non-overlapping version ranges.
Each standard operator maps to one or two ranges. ``===`` is
modeled as full range (actual check done separately). Cached.
"""
if self._ranges is not None:
return self._ranges
op = self.operator
ver_str = self.version
if op == "===":
self._ranges = _FULL_RANGE
return _FULL_RANGE
if ver_str.endswith(".*"):
result = self._wildcard_ranges(op, ver_str)
else:
result = self._standard_ranges(op, ver_str)
self._ranges = result
return result
def _wildcard_ranges(self, op: str, ver_str: str) -> list[_VersionRange]:
# ==1.2.* -> [1.2.dev0, 1.3.dev0); !=1.2.* -> complement.
base = self._require_spec_version(ver_str[:-2])
lower = _base_dev0(base)
upper = _next_prefix_dev0(base)
if op == "==":
return [(_LowerBound(lower, True), _UpperBound(upper, False))]
# !=
return [
(_NEG_INF, _UpperBound(lower, False)),
(_LowerBound(upper, True), _POS_INF),
]
def _standard_ranges(self, op: str, ver_str: str) -> list[_VersionRange]:
v = self._require_spec_version(ver_str)
if op == ">=":
return [(_LowerBound(v, True), _POS_INF)]
if op == "<=":
return [
(
_NEG_INF,
_UpperBound(_BoundaryVersion(v, _BoundaryKind.AFTER_LOCALS), True),
)
]
if op == ">":
if v.dev is not None:
# >V.devN: dev versions have no post-releases, so the
# next real version is V.dev(N+1).
lower_ver = v.__replace__(dev=v.dev + 1, local=None)
return [(_LowerBound(lower_ver, True), _POS_INF)]
if v.post is not None:
# >V.postN: next real version is V.post(N+1).dev0.
lower_ver = v.__replace__(post=v.post + 1, dev=0, local=None)
return [(_LowerBound(lower_ver, True), _POS_INF)]
# >V (final or pre-release): skip V+local and all V.postN.
return [
(
_LowerBound(_BoundaryVersion(v, _BoundaryKind.AFTER_POSTS), False),
_POS_INF,
)
]
if op == "<":
# <V excludes prereleases of V when V is not a prerelease.
# V.dev0 is the earliest prerelease of V (final, post, etc.).
bound = v if v.is_prerelease else v.__replace__(dev=0, local=None)
if bound <= _MIN_VERSION:
return []
return [(_NEG_INF, _UpperBound(bound, False))]
# ==, !=: local versions of V match when spec has no local segment.
has_local = "+" in ver_str
after_locals = _BoundaryVersion(v, _BoundaryKind.AFTER_LOCALS)
upper = v if has_local else after_locals
if op == "==":
return [(_LowerBound(v, True), _UpperBound(upper, True))]
if op == "!=":
return [
(_NEG_INF, _UpperBound(v, False)),
(_LowerBound(upper, False), _POS_INF),
]
if op == "~=":
prefix = v.__replace__(release=v.release[:-1])
return [
(_LowerBound(v, True), _UpperBound(_next_prefix_dev0(prefix), False))
]
raise ValueError(f"Unknown operator: {op!r}") # pragma: no cover
@property
def prereleases(self) -> bool | None:
# If there is an explicit prereleases set for this, then we'll just
# blindly use that.
if self._prereleases is not None:
return self._prereleases
# Only the "!=" operator does not imply prereleases when
# the version in the specifier is a prerelease.
operator, version_str = self._spec
if operator == "!=":
return False
# The == specifier with trailing .* cannot include prereleases
# e.g. "==1.0a1.*" is not valid.
if operator == "==" and version_str.endswith(".*"):
return False
# "===" can have arbitrary string versions, so we cannot parse
# those, we take prereleases as unknown (None) for those.
version = self._get_spec_version(version_str)
if version is None:
return None
# For all other operators, use the check if spec Version
# object implies pre-releases.
return version.is_prerelease
@prereleases.setter
def prereleases(self, value: bool | None) -> None:
self._prereleases = value
def __getstate__(self) -> tuple[tuple[str, str], bool | None]:
# Return state as a 2-item tuple for compactness:
# ((operator, version), prereleases)
# Cache members are excluded and will be recomputed on demand.
return (self._spec, self._prereleases)
def __setstate__(self, state: object) -> None:
# Always discard cached values - they will be recomputed on demand.
self._spec_version = None
self._wildcard_split = None
self._ranges = None
if isinstance(state, tuple):
if len(state) == 2:
# New format (26.2+): ((operator, version), prereleases)
spec, prereleases = state
if _validate_spec(spec) and _validate_pre(prereleases):
self._spec = spec
self._prereleases = prereleases
return
if len(state) == 2 and isinstance(state[1], dict):
# Format (packaging 26.0-26.1): (None, {slot: value}).
_, slot_dict = state
spec = slot_dict.get("_spec")
prereleases = slot_dict.get("_prereleases", "invalid")
if _validate_spec(spec) and _validate_pre(prereleases):
self._spec = spec
self._prereleases = prereleases
return
if isinstance(state, dict):
# Old format (packaging <= 25.x, no __slots__): state is a plain dict.
spec = state.get("_spec")
prereleases = state.get("_prereleases", "invalid")
if _validate_spec(spec) and _validate_pre(prereleases):
self._spec = spec
self._prereleases = prereleases
return
raise TypeError(f"Cannot restore Specifier from {state!r}")
@property
def operator(self) -> str:
"""The operator of this specifier.
>>> Specifier("==1.2.3").operator
'=='
"""
return self._spec[0]
@property
def version(self) -> str:
"""The version of this specifier.
>>> Specifier("==1.2.3").version
'1.2.3'
"""
return self._spec[1]
def __repr__(self) -> str:
"""A representation of the Specifier that shows all internal state.
>>> Specifier('>=1.0.0')
<Specifier('>=1.0.0')>
>>> Specifier('>=1.0.0', prereleases=False)
<Specifier('>=1.0.0', prereleases=False)>
>>> Specifier('>=1.0.0', prereleases=True)
<Specifier('>=1.0.0', prereleases=True)>
"""
pre = (
f", prereleases={self.prereleases!r}"
if self._prereleases is not None
else ""
)
return f"<{self.__class__.__name__}({str(self)!r}{pre})>"
def __str__(self) -> str:
"""A string representation of the Specifier that can be round-tripped.
>>> str(Specifier('>=1.0.0'))
'>=1.0.0'
>>> str(Specifier('>=1.0.0', prereleases=False))
'>=1.0.0'
"""
return "{}{}".format(*self._spec)
@property
def _canonical_spec(self) -> tuple[str, str]:
operator, version = self._spec
if operator == "===" or version.endswith(".*"):
return operator, version
spec_version = self._require_spec_version(version)
canonical_version = canonicalize_version(
spec_version, strip_trailing_zero=(operator != "~=")
)
return operator, canonical_version
def __hash__(self) -> int:
return hash(self._canonical_spec)
def __eq__(self, other: object) -> bool:
"""Whether or not the two Specifier-like objects are equal.
:param other: The other object to check against.
The value of :attr:`prereleases` is ignored.
>>> Specifier("==1.2.3") == Specifier("== 1.2.3.0")
True
>>> (Specifier("==1.2.3", prereleases=False) ==
... Specifier("==1.2.3", prereleases=True))
True
>>> Specifier("==1.2.3") == "==1.2.3"
True
>>> Specifier("==1.2.3") == Specifier("==1.2.4")
False
>>> Specifier("==1.2.3") == Specifier("~=1.2.3")
False
"""
if isinstance(other, str):
try:
other = self.__class__(str(other))
except InvalidSpecifier:
return NotImplemented
elif not isinstance(other, self.__class__):
return NotImplemented
return self._canonical_spec == other._canonical_spec
def _get_operator(self, op: str) -> CallableOperator:
operator_callable: CallableOperator = getattr(
self, f"_compare_{self._operators[op]}"
)
return operator_callable
def _compare_compatible(self, prospective: Version, spec: str) -> bool:
# Compatible releases have an equivalent combination of >= and ==. That
# is that ~=2.2 is equivalent to >=2.2,==2.*. This allows us to
# implement this in terms of the other specifiers instead of
# implementing it ourselves. The only thing we need to do is construct
# the other specifiers.
# We want everything but the last item in the version, but we want to
# ignore suffix segments.
prefix = _version_join(
list(itertools.takewhile(_is_not_suffix, _version_split(spec)))[:-1]
)
# Add the prefix notation to the end of our string
prefix += ".*"
return (self._compare_greater_than_equal(prospective, spec)) and (
self._compare_equal(prospective, prefix)
)
def _get_wildcard_split(self, spec: str) -> tuple[list[str], int]:
"""Cached split of a wildcard spec into components and numeric length.
>>> Specifier("==1.*")._get_wildcard_split("1.*")
(['0', '1'], 2)
>>> Specifier("==3.10.*")._get_wildcard_split("3.10.*")
(['0', '3', '10'], 3)
"""
wildcard_split = self._wildcard_split
if wildcard_split is None:
normalized = canonicalize_version(spec[:-2], strip_trailing_zero=False)
split_spec = _version_split(normalized)
wildcard_split = (split_spec, _numeric_prefix_len(split_spec))
self._wildcard_split = wildcard_split
return wildcard_split
def _compare_equal(self, prospective: Version, spec: str) -> bool:
# We need special logic to handle prefix matching
if spec.endswith(".*"):
split_spec, spec_numeric_len = self._get_wildcard_split(spec)
# In the case of prefix matching we want to ignore local segment.
normalized_prospective = canonicalize_version(
_public_version(prospective), strip_trailing_zero=False
)
# Split the prospective version out by bangs and dots, and pretend
# that there is an implicit dot in between a release segment and
# a pre-release segment.
split_prospective = _version_split(normalized_prospective)
# 0-pad the prospective version before shortening it to get the correct
# shortened version.
padded_prospective = _left_pad(split_prospective, spec_numeric_len)
# Shorten the prospective version to be the same length as the spec
# so that we can determine if the specifier is a prefix of the
# prospective version or not.
shortened_prospective = padded_prospective[: len(split_spec)]
return shortened_prospective == split_spec
else:
# Convert our spec string into a Version
spec_version = self._require_spec_version(spec)
# If the specifier does not have a local segment, then we want to
# act as if the prospective version also does not have a local
# segment.
if not spec_version.local:
prospective = _public_version(prospective)
return prospective == spec_version
def _compare_not_equal(self, prospective: Version, spec: str) -> bool:
return not self._compare_equal(prospective, spec)
def _compare_less_than_equal(self, prospective: Version, spec: str) -> bool:
# NB: Local version identifiers are NOT permitted in the version
# specifier, so local version labels can be universally removed from
# the prospective version.
return _public_version(prospective) <= self._require_spec_version(spec)
def _compare_greater_than_equal(self, prospective: Version, spec: str) -> bool:
# NB: Local version identifiers are NOT permitted in the version
# specifier, so local version labels can be universally removed from
# the prospective version.
return _public_version(prospective) >= self._require_spec_version(spec)
def _compare_less_than(self, prospective: Version, spec_str: str) -> bool:
# Convert our spec to a Version instance, since we'll want to work with
# it as a version.
spec = self._require_spec_version(spec_str)
# Check to see if the prospective version is less than the spec
# version. If it's not we can short circuit and just return False now
# instead of doing extra unneeded work.
if not prospective < spec:
return False
# The spec says: "<V MUST NOT allow a pre-release of the specified
# version unless the specified version is itself a pre-release."
if (
not spec.is_prerelease
and prospective.is_prerelease
and prospective >= _earliest_prerelease(spec)
):
return False
# If we've gotten to here, it means that prospective version is both
# less than the spec version *and* it's not a pre-release of the same
# version in the spec.
return True
def _compare_greater_than(self, prospective: Version, spec_str: str) -> bool:
# Convert our spec to a Version instance, since we'll want to work with
# it as a version.
spec = self._require_spec_version(spec_str)
# Check to see if the prospective version is greater than the spec
# version. If it's not we can short circuit and just return False now
# instead of doing extra unneeded work.
if not prospective > spec:
return False
# The spec says: ">V MUST NOT allow a post-release of the specified
# version unless the specified version is itself a post-release."
if (
not spec.is_postrelease
and prospective.is_postrelease
and _post_base(prospective) == spec
):
return False
# Per the spec: ">V MUST NOT match a local version of the specified
# version". A "local version of V" is any version whose public part
# equals V. So >1.0a1 must not match 1.0a1+local, but must still
# match 1.0a2+local.
if prospective.local is not None and _public_version(prospective) == spec:
return False
# If we've gotten to here, it means that prospective version is both
# greater than the spec version *and* it's not a pre-release of the
# same version in the spec.
return True
def _compare_arbitrary(self, prospective: Version | str, spec: str) -> bool:
return str(prospective).lower() == str(spec).lower()
def __contains__(self, item: str | Version) -> bool:
"""Return whether or not the item is contained in this specifier.
:param item: The item to check for.
This is used for the ``in`` operator and behaves the same as
:meth:`contains` with no ``prereleases`` argument passed.
>>> "1.2.3" in Specifier(">=1.2.3")
True
>>> Version("1.2.3") in Specifier(">=1.2.3")
True
>>> "1.0.0" in Specifier(">=1.2.3")
False
>>> "1.3.0a1" in Specifier(">=1.2.3")
True
>>> "1.3.0a1" in Specifier(">=1.2.3", prereleases=True)
True
"""
return self.contains(item)
def contains(self, item: UnparsedVersion, prereleases: bool | None = None) -> bool:
"""Return whether or not the item is contained in this specifier.
:param item:
The item to check for, which can be a version string or a
:class:`Version` instance.
:param prereleases:
Whether or not to match prereleases with this Specifier. If set to
``None`` (the default), it will follow the recommendation from
:pep:`440` and match prereleases, as there are no other versions.
>>> Specifier(">=1.2.3").contains("1.2.3")
True
>>> Specifier(">=1.2.3").contains(Version("1.2.3"))
True
>>> Specifier(">=1.2.3").contains("1.0.0")
False
>>> Specifier(">=1.2.3").contains("1.3.0a1")
True
>>> Specifier(">=1.2.3", prereleases=False).contains("1.3.0a1")
False
>>> Specifier(">=1.2.3").contains("1.3.0a1")
True
"""
return bool(list(self.filter([item], prereleases=prereleases)))
@typing.overload
def filter(
self,
iterable: Iterable[UnparsedVersionVar],
prereleases: bool | None = None,
key: None = ...,
) -> Iterator[UnparsedVersionVar]: ...
@typing.overload
def filter(
self,
iterable: Iterable[T],
prereleases: bool | None = None,
key: Callable[[T], UnparsedVersion] = ...,
) -> Iterator[T]: ...
def filter(
self,
iterable: Iterable[Any],
prereleases: bool | None = None,
key: Callable[[Any], UnparsedVersion] | None = None,
) -> Iterator[Any]:
"""Filter items in the given iterable, that match the specifier.
:param iterable:
An iterable that can contain version strings and :class:`Version` instances.
The items in the iterable will be filtered according to the specifier.
:param prereleases:
Whether or not to allow prereleases in the returned iterator. If set to
``None`` (the default), it will follow the recommendation from :pep:`440`
and match prereleases if there are no other versions.
:param key:
A callable that takes a single argument (an item from the iterable) and
returns a version string or :class:`Version` instance to be used for
filtering.
>>> list(Specifier(">=1.2.3").filter(["1.2", "1.3", "1.5a1"]))
['1.3']
>>> list(Specifier(">=1.2.3").filter(["1.2", "1.2.3", "1.3", Version("1.4")]))
['1.2.3', '1.3', <Version('1.4')>]
>>> list(Specifier(">=1.2.3").filter(["1.2", "1.5a1"]))
['1.5a1']
>>> list(Specifier(">=1.2.3").filter(["1.3", "1.5a1"], prereleases=True))
['1.3', '1.5a1']
>>> list(Specifier(">=1.2.3", prereleases=True).filter(["1.3", "1.5a1"]))
['1.3', '1.5a1']
>>> list(Specifier(">=1.2.3").filter(
... [{"ver": "1.2"}, {"ver": "1.3"}],
... key=lambda x: x["ver"]))
[{'ver': '1.3'}]
"""
prereleases_versions = []
found_non_prereleases = False
# Determine if to include prereleases by default
include_prereleases = (
prereleases if prereleases is not None else self.prereleases
)
# Get the matching operator
operator_callable = self._get_operator(self.operator)
# Filter versions
for version in iterable:
parsed_version = _coerce_version(version if key is None else key(version))
match = False
if parsed_version is None:
# === operator can match arbitrary (non-version) strings
if self.operator == "===" and self._compare_arbitrary(
version, self.version
):
yield version
elif self.operator == "===":
match = self._compare_arbitrary(
version if key is None else key(version), self.version
)
else:
match = operator_callable(parsed_version, self.version)
if match and parsed_version is not None:
# If it's not a prerelease or prereleases are allowed, yield it directly
if not parsed_version.is_prerelease or include_prereleases:
found_non_prereleases = True
yield version
# Otherwise collect prereleases for potential later use
elif prereleases is None and self._prereleases is not False:
prereleases_versions.append(version)
# If no non-prereleases were found and prereleases weren't
# explicitly forbidden, yield the collected prereleases
if (
not found_non_prereleases
and prereleases is None
and self._prereleases is not False
):
yield from prereleases_versions
_prefix_regex = re.compile(r"([0-9]+)((?:a|b|c|rc)[0-9]+)")
def _pep440_filter_prereleases(
iterable: Iterable[Any], key: Callable[[Any], UnparsedVersion] | None
) -> Iterator[Any]:
"""Filter per PEP 440: exclude prereleases unless no finals exist."""
# Two lists used:
# * all_nonfinal to preserve order if no finals exist
# * arbitrary_strings for streaming when first final found
all_nonfinal: list[Any] = []
arbitrary_strings: list[Any] = []
found_final = False
for item in iterable:
parsed = _coerce_version(item if key is None else key(item))
if parsed is None:
# Arbitrary strings are always included as it is not
# possible to determine if they are prereleases,
# and they have already passed all specifiers.
if found_final:
yield item
else:
arbitrary_strings.append(item)
all_nonfinal.append(item)
continue
if not parsed.is_prerelease:
# Final release found - flush arbitrary strings, then yield
if not found_final:
yield from arbitrary_strings
found_final = True
yield item
continue
# Prerelease - buffer if no finals yet, otherwise skip
if not found_final:
all_nonfinal.append(item)
# No finals found - yield all buffered items
if not found_final:
yield from all_nonfinal
def _version_split(version: str) -> list[str]:
"""Split version into components.
The split components are intended for version comparison. The logic does
not attempt to retain the original version string, so joining the
components back with :func:`_version_join` may not produce the original
version string.
"""
result: list[str] = []
epoch, _, rest = version.rpartition("!")
result.append(epoch or "0")
for item in rest.split("."):
match = _prefix_regex.fullmatch(item)
if match:
result.extend(match.groups())
else:
result.append(item)
return result
def _version_join(components: list[str]) -> str:
"""Join split version components into a version string.
This function assumes the input came from :func:`_version_split`, where the
first component must be the epoch (either empty or numeric), and all other
components numeric.
"""
epoch, *rest = components
return f"{epoch}!{'.'.join(rest)}"
def _is_not_suffix(segment: str) -> bool:
return not any(
segment.startswith(prefix) for prefix in ("dev", "a", "b", "rc", "post")
)
def _numeric_prefix_len(split: list[str]) -> int:
"""Count leading numeric components in a :func:`_version_split` result.
>>> _numeric_prefix_len(["0", "1", "2", "a1"])
3
"""
count = 0
for segment in split:
if not segment.isdigit():
break
count += 1
return count
def _left_pad(split: list[str], target_numeric_len: int) -> list[str]:
"""Pad a :func:`_version_split` result with ``"0"`` segments to reach
``target_numeric_len`` numeric components. Suffix segments are preserved.
>>> _left_pad(["0", "1", "a1"], 4)
['0', '1', '0', '0', 'a1']
"""
numeric_len = _numeric_prefix_len(split)
pad_needed = target_numeric_len - numeric_len
if pad_needed <= 0:
return split
return [*split[:numeric_len], *(["0"] * pad_needed), *split[numeric_len:]]
def _operator_cost(op_entry: tuple[CallableOperator, str, str]) -> int:
"""Sort key for Cost Based Ordering of specifier operators in _filter_versions.
Operators run sequentially on a shrinking candidate set, so operators that
reject the most versions should run first to minimize work for later ones.
Tier 0: Exact equality (==, ===), likely to narrow candidates to one version
Tier 1: Range checks (>=, <=, >, <), cheap and usually reject a large portion
Tier 2: Wildcard equality (==.*) and compatible release (~=), more expensive
Tier 3: Exact !=, cheap but rarely rejects
Tier 4: Wildcard !=.*, expensive and rarely rejects
"""
_, ver, op = op_entry
if op == "==":
return 0 if not ver.endswith(".*") else 2
if op in (">=", "<=", ">", "<"):
return 1
if op == "~=":
return 2
if op == "!=":
return 3 if not ver.endswith(".*") else 4
if op == "===":
return 0
raise ValueError(f"Unknown operator: {op!r}") # pragma: no cover
class SpecifierSet(BaseSpecifier):
"""This class abstracts handling of a set of version specifiers.
It can be passed a single specifier (``>=3.0``), a comma-separated list of
specifiers (``>=3.0,!=3.1``), or no specifier at all.
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__ = (
"_canonicalized",
"_has_arbitrary",
"_is_unsatisfiable",
"_prereleases",
"_resolved_ops",
"_specs",
)
def __init__(
self,
specifiers: str | Iterable[Specifier] = "",
prereleases: bool | None = None,
) -> None:
"""Initialize a SpecifierSet instance.
:param specifiers:
The string representation of a specifier or a comma-separated list of
specifiers which will be parsed and normalized before use.
May also be an iterable of ``Specifier`` instances, which will be used
as is.
:param prereleases:
This tells the SpecifierSet if it should accept prerelease versions if
applicable or not. The default of ``None`` will autodetect it from the
given specifiers.
:raises InvalidSpecifier:
If the given ``specifiers`` are not parseable than this exception will be
raised.
"""
if isinstance(specifiers, str):
# Split on `,` to break each individual specifier into its own item, and
# strip each item to remove leading/trailing whitespace.
split_specifiers = [s.strip() for s in specifiers.split(",") if s.strip()]
self._specs: tuple[Specifier, ...] = tuple(map(Specifier, split_specifiers))
# Fast substring check; avoids iterating parsed specs.
self._has_arbitrary = "===" in specifiers
else:
self._specs = tuple(specifiers)
# Substring check works for both Specifier objects and plain
# strings (setuptools passes lists of strings).
self._has_arbitrary = any("===" in str(s) for s in self._specs)
self._canonicalized = len(self._specs) <= 1
self._resolved_ops: list[tuple[CallableOperator, str, str]] | None = None
# Store our prereleases value so we can use it later to determine if
# we accept prereleases or not.
self._prereleases = prereleases
self._is_unsatisfiable: bool | None = None
def _canonical_specs(self) -> tuple[Specifier, ...]:
"""Deduplicate, sort, and cache specs for order-sensitive operations."""
if not self._canonicalized:
self._specs = tuple(dict.fromkeys(sorted(self._specs, key=str)))
self._canonicalized = True
self._resolved_ops = None
self._is_unsatisfiable = None
return self._specs
@property
def prereleases(self) -> bool | None:
# If we have been given an explicit prerelease modifier, then we'll
# pass that through here.
if self._prereleases is not None:
return self._prereleases
# If we don't have any specifiers, and we don't have a forced value,
# then we'll just return None since we don't know if this should have
# pre-releases or not.
if not self._specs:
return None
# Otherwise we'll see if any of the given specifiers accept
# prereleases, if any of them do we'll return True, otherwise False.
if any(s.prereleases for s in self._specs):
return True
return None
@prereleases.setter
def prereleases(self, value: bool | None) -> None:
self._prereleases = value
self._is_unsatisfiable = None
def __getstate__(self) -> tuple[tuple[Specifier, ...], bool | None]:
# Return state as a 2-item tuple for compactness:
# (specs, prereleases)
# Cache members are excluded and will be recomputed on demand.
return (self._specs, self._prereleases)
def __setstate__(self, state: object) -> None:
# Always discard cached values - they will be recomputed on demand.
self._resolved_ops = None
self._is_unsatisfiable = None
if isinstance(state, tuple):
if len(state) == 2:
# New format (26.2+): (specs, prereleases)
specs, prereleases = state
if (
isinstance(specs, tuple)
and all(isinstance(s, Specifier) for s in specs)
and _validate_pre(prereleases)
):
self._specs = specs
self._prereleases = prereleases
self._canonicalized = len(specs) <= 1
self._has_arbitrary = any("===" in str(s) for s in specs)
return
if len(state) == 2 and isinstance(state[1], dict):
# Format (packaging 26.0-26.1): (None, {slot: value}).
_, slot_dict = state
specs = slot_dict.get("_specs", ())
prereleases = slot_dict.get("_prereleases")
# Convert frozenset to tuple (26.0 stored as frozenset)
if isinstance(specs, frozenset):
specs = tuple(sorted(specs, key=str))
if (
isinstance(specs, tuple)
and all(isinstance(s, Specifier) for s in specs)
and _validate_pre(prereleases)
):
self._specs = specs
self._prereleases = prereleases
self._canonicalized = len(self._specs) <= 1
self._has_arbitrary = any("===" in str(s) for s in self._specs)
return
if isinstance(state, dict):
# Old format (packaging <= 25.x, no __slots__): state is a plain dict.
specs = state.get("_specs", ())
prereleases = state.get("_prereleases")
# Convert frozenset to tuple (26.0 stored as frozenset)
if isinstance(specs, frozenset):
specs = tuple(sorted(specs, key=str))
if (
isinstance(specs, tuple)
and all(isinstance(s, Specifier) for s in specs)
and _validate_pre(prereleases)
):
self._specs = specs
self._prereleases = prereleases
self._canonicalized = len(self._specs) <= 1
self._has_arbitrary = any("===" in str(s) for s in self._specs)
return
raise TypeError(f"Cannot restore SpecifierSet from {state!r}")
def __repr__(self) -> str:
"""A representation of the specifier set that shows all internal state.
Note that the ordering of the individual specifiers within the set may not
match the input string.
>>> SpecifierSet('>=1.0.0,!=2.0.0')
<SpecifierSet('!=2.0.0,>=1.0.0')>
>>> SpecifierSet('>=1.0.0,!=2.0.0', prereleases=False)
<SpecifierSet('!=2.0.0,>=1.0.0', prereleases=False)>
>>> SpecifierSet('>=1.0.0,!=2.0.0', prereleases=True)
<SpecifierSet('!=2.0.0,>=1.0.0', prereleases=True)>
"""
pre = (
f", prereleases={self.prereleases!r}"
if self._prereleases is not None
else ""
)
return f"<{self.__class__.__name__}({str(self)!r}{pre})>"
def __str__(self) -> str:
"""A string representation of the specifier set that can be round-tripped.
Note that the ordering of the individual specifiers within the set may not
match the input string.
>>> str(SpecifierSet(">=1.0.0,!=1.0.1"))
'!=1.0.1,>=1.0.0'
>>> str(SpecifierSet(">=1.0.0,!=1.0.1", prereleases=False))
'!=1.0.1,>=1.0.0'
"""
return ",".join(str(s) for s in self._canonical_specs())
def __hash__(self) -> int:
return hash(self._canonical_specs())
def __and__(self, other: SpecifierSet | str) -> SpecifierSet:
"""Return a SpecifierSet which is a combination of the two sets.
:param other: The other object to combine with.
>>> SpecifierSet(">=1.0.0,!=1.0.1") & '<=2.0.0,!=2.0.1'
<SpecifierSet('!=1.0.1,!=2.0.1,<=2.0.0,>=1.0.0')>
>>> SpecifierSet(">=1.0.0,!=1.0.1") & SpecifierSet('<=2.0.0,!=2.0.1')
<SpecifierSet('!=1.0.1,!=2.0.1,<=2.0.0,>=1.0.0')>
"""
if isinstance(other, str):
other = SpecifierSet(other)
elif not isinstance(other, SpecifierSet):
return NotImplemented
specifier = SpecifierSet()
specifier._specs = self._specs + other._specs
specifier._canonicalized = len(specifier._specs) <= 1
specifier._has_arbitrary = self._has_arbitrary or other._has_arbitrary
specifier._resolved_ops = None
# Combine prerelease settings: use common or non-None value
if self._prereleases is None or self._prereleases == other._prereleases:
specifier._prereleases = other._prereleases
elif other._prereleases is None:
specifier._prereleases = self._prereleases
else:
raise ValueError(
"Cannot combine SpecifierSets with True and False prerelease overrides."
)
return specifier
def __eq__(self, other: object) -> bool:
"""Whether or not the two SpecifierSet-like objects are equal.
:param other: The other object to check against.
The value of :attr:`prereleases` is ignored.
>>> SpecifierSet(">=1.0.0,!=1.0.1") == SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> (SpecifierSet(">=1.0.0,!=1.0.1", prereleases=False) ==
... SpecifierSet(">=1.0.0,!=1.0.1", prereleases=True))
True
>>> SpecifierSet(">=1.0.0,!=1.0.1") == ">=1.0.0,!=1.0.1"
True
>>> SpecifierSet(">=1.0.0,!=1.0.1") == SpecifierSet(">=1.0.0")
False
>>> SpecifierSet(">=1.0.0,!=1.0.1") == SpecifierSet(">=1.0.0,!=1.0.2")
False
"""
if isinstance(other, (str, Specifier)):
other = SpecifierSet(str(other))
elif not isinstance(other, SpecifierSet):
return NotImplemented
return self._canonical_specs() == other._canonical_specs()
def __len__(self) -> int:
"""Returns the number of specifiers in this specifier set."""
return len(self._specs)
def __iter__(self) -> Iterator[Specifier]:
"""
Returns an iterator over all the underlying :class:`Specifier` instances
in this specifier set.
>>> sorted(SpecifierSet(">=1.0.0,!=1.0.1"), key=str)
[<Specifier('!=1.0.1')>, <Specifier('>=1.0.0')>]
"""
return iter(self._specs)
def _get_ranges(self) -> Sequence[_VersionRange]:
"""Intersect all specifiers into a single list of version ranges.
Returns an empty list when unsatisfiable. ``===`` specs are
modeled as full range; string matching is checked separately
by :meth:`_check_arbitrary_unsatisfiable`.
"""
specs = self._specs
result: Sequence[_VersionRange] | None = None
for s in specs:
if result is None:
result = s._to_ranges()
else:
result = _intersect_ranges(result, s._to_ranges())
if not result:
break
if result is None: # pragma: no cover
raise RuntimeError("_get_ranges called with no specs")
return result
def is_unsatisfiable(self) -> bool:
"""Check whether this specifier set can never be satisfied.
Returns True if no version can satisfy all specifiers simultaneously.
>>> SpecifierSet(">=2.0,<1.0").is_unsatisfiable()
True
>>> SpecifierSet(">=1.0,<2.0").is_unsatisfiable()
False
>>> SpecifierSet("").is_unsatisfiable()
False
>>> SpecifierSet("==1.0,!=1.0").is_unsatisfiable()
True
"""
cached = self._is_unsatisfiable
if cached is not None:
return cached
if not self._specs:
self._is_unsatisfiable = False
return False
result = not self._get_ranges()
if not result:
result = self._check_arbitrary_unsatisfiable()
if not result and self.prereleases is False:
result = self._check_prerelease_only_ranges()
self._is_unsatisfiable = result
return result
def _check_prerelease_only_ranges(self) -> bool:
"""With prereleases=False, check if every range contains only
pre-release versions (which would be excluded from matching)."""
for lower, upper in self._get_ranges():
nearest = _nearest_non_prerelease(lower.version)
if nearest is None:
return False
if upper.version is None or nearest < upper.version:
return False
if nearest == upper.version and upper.inclusive:
return False
return True
def _check_arbitrary_unsatisfiable(self) -> bool:
"""Check === (arbitrary equality) specs for unsatisfiability.
=== uses case-insensitive string comparison, so the only candidate
that can match ``===V`` is the literal string V. This method
checks whether that candidate is excluded by other specifiers.
"""
arbitrary = [s for s in self._specs if s.operator == "==="]
if not arbitrary:
return False
# Multiple === must agree on the same string (case-insensitive).
first = arbitrary[0].version.lower()
if any(s.version.lower() != first for s in arbitrary[1:]):
return True
# The sole candidate is the === version string. Check whether
# it can satisfy every standard spec.
candidate = _coerce_version(arbitrary[0].version)
# With prereleases=False, a prerelease candidate is excluded
# by contains() before the === string check even runs.
if (
self.prereleases is False
and candidate is not None
and candidate.is_prerelease
):
return True
standard = [s for s in self._specs if s.operator != "==="]
if not standard:
return False
if candidate is None:
# Unparsable string cannot satisfy any standard spec.
return True
return not all(s.contains(candidate) for s in standard)
def __contains__(self, item: UnparsedVersion) -> bool:
"""Return whether or not the item is contained in this specifier.
:param item: The item to check for.
This is used for the ``in`` operator and behaves the same as
:meth:`contains` with no ``prereleases`` argument passed.
>>> "1.2.3" in SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> Version("1.2.3") in SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> "1.0.1" in SpecifierSet(">=1.0.0,!=1.0.1")
False
>>> "1.3.0a1" in SpecifierSet(">=1.0.0,!=1.0.1")
True
>>> "1.3.0a1" in SpecifierSet(">=1.0.0,!=1.0.1", prereleases=True)
True
"""
return self.contains(item)
def contains(
self,
item: UnparsedVersion,
prereleases: bool | None = None,
installed: bool | None = None,
) -> bool:
"""Return whether or not the item is contained in this SpecifierSet.
:param item:
The item to check for, which can be a version string or a
:class:`Version` instance.
:param prereleases:
Whether or not to match prereleases with this SpecifierSet. If set to
``None`` (the default), it will follow the recommendation from :pep:`440`
and match prereleases, as there are no other versions.
:param installed:
Whether or not the item is installed. If set to ``True``, it will
accept prerelease versions even if the specifier does not allow them.
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.2.3")
True
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains(Version("1.2.3"))
True
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.0.1")
False
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.3.0a1")
True
>>> SpecifierSet(">=1.0.0,!=1.0.1", prereleases=False).contains("1.3.0a1")
False
>>> SpecifierSet(">=1.0.0,!=1.0.1").contains("1.3.0a1", prereleases=True)
True
"""
version = _coerce_version(item)
if version is not None and installed and version.is_prerelease:
prereleases = True
# When item is a string and === is involved, keep it as-is
# so the comparison isn't done against the normalized form.
if version is None or (self._has_arbitrary and not isinstance(item, Version)):
check_item = item
else:
check_item = version
return bool(list(self.filter([check_item], prereleases=prereleases)))
@typing.overload
def filter(
self,
iterable: Iterable[UnparsedVersionVar],
prereleases: bool | None = None,
key: None = ...,
) -> Iterator[UnparsedVersionVar]: ...
@typing.overload
def filter(
self,
iterable: Iterable[T],
prereleases: bool | None = None,
key: Callable[[T], UnparsedVersion] = ...,
) -> Iterator[T]: ...
def filter(
self,
iterable: Iterable[Any],
prereleases: bool | None = None,
key: Callable[[Any], UnparsedVersion] | None = None,
) -> Iterator[Any]:
"""Filter items in the given iterable, that match the specifiers in this set.
:param iterable:
An iterable that can contain version strings and :class:`Version` instances.
The items in the iterable will be filtered according to the specifier.
:param prereleases:
Whether or not to allow prereleases in the returned iterator. If set to
``None`` (the default), it will follow the recommendation from :pep:`440`
and match prereleases if there are no other versions.
:param key:
A callable that takes a single argument (an item from the iterable) and
returns a version string or :class:`Version` instance to be used for
filtering.
>>> list(SpecifierSet(">=1.2.3").filter(["1.2", "1.3", "1.5a1"]))
['1.3']
>>> list(SpecifierSet(">=1.2.3").filter(["1.2", "1.3", Version("1.4")]))
['1.3', <Version('1.4')>]
>>> list(SpecifierSet(">=1.2.3").filter(["1.2", "1.5a1"]))
['1.5a1']
>>> list(SpecifierSet(">=1.2.3").filter(["1.3", "1.5a1"], prereleases=True))
['1.3', '1.5a1']
>>> list(SpecifierSet(">=1.2.3", prereleases=True).filter(["1.3", "1.5a1"]))
['1.3', '1.5a1']
>>> list(SpecifierSet(">=1.2.3").filter(
... [{"ver": "1.2"}, {"ver": "1.3"}],
... key=lambda x: x["ver"]))
[{'ver': '1.3'}]
An "empty" SpecifierSet will filter items based on the presence of prerelease
versions in the set.
>>> list(SpecifierSet("").filter(["1.3", "1.5a1"]))
['1.3']
>>> list(SpecifierSet("").filter(["1.5a1"]))
['1.5a1']
>>> list(SpecifierSet("", prereleases=True).filter(["1.3", "1.5a1"]))
['1.3', '1.5a1']
>>> list(SpecifierSet("").filter(["1.3", "1.5a1"], prereleases=True))
['1.3', '1.5a1']
"""
# Determine if we're forcing a prerelease or not, if we're not forcing
# one for this particular filter call, then we'll use whatever the
# SpecifierSet thinks for whether or not we should support prereleases.
if prereleases is None and self.prereleases is not None:
prereleases = self.prereleases
# Filter versions that match all specifiers using Cost Based Ordering.
if self._specs:
# When prereleases is None, we need to let all versions through
# the individual filters, then decide about prereleases at the end
# based on whether any non-prereleases matched ALL specs.
# Fast path: single specifier, delegate directly.
if len(self._specs) == 1:
filtered = self._specs[0].filter(
iterable,
prereleases=True if prereleases is None else prereleases,
key=key,
)
else:
filtered = self._filter_versions(
iterable,
key,
prereleases=True if prereleases is None else prereleases,
)
if prereleases is not None:
return filtered
return _pep440_filter_prereleases(filtered, key)
# Handle Empty SpecifierSet.
if prereleases is True:
return iter(iterable)
if prereleases is False:
return (
item
for item in iterable
if (
(version := _coerce_version(item if key is None else key(item)))
is None
or not version.is_prerelease
)
)
# PEP 440: exclude prereleases unless no final releases matched
return _pep440_filter_prereleases(iterable, key)
def _filter_versions(
self,
iterable: Iterable[Any],
key: Callable[[Any], UnparsedVersion] | None,
prereleases: bool | None = None,
) -> Iterator[Any]:
"""Filter versions against all specifiers in a single pass.
Uses Cost Based Ordering: specifiers are sorted by _operator_cost so
that cheap range operators reject versions early, avoiding expensive
wildcard or compatible operators on versions that would have been
rejected anyway.
"""
# Pre-resolve operators and sort (cached after first call).
if self._resolved_ops is None:
self._resolved_ops = sorted(
(
(spec._get_operator(spec.operator), spec.version, spec.operator)
for spec in self._specs
),
key=_operator_cost,
)
ops = self._resolved_ops
exclude_prereleases = prereleases is False
for item in iterable:
parsed = _coerce_version(item if key is None else key(item))
if parsed is None:
# Only === can match non-parseable versions.
if all(
op == "===" and str(item).lower() == ver.lower()
for _, ver, op in ops
):
yield item
elif exclude_prereleases and parsed.is_prerelease:
pass
elif all(
str(item if key is None else key(item)).lower() == ver.lower()
if op == "==="
else op_fn(parsed, ver)
for op_fn, ver, op in ops
):
# Short-circuits on the first failing operator.
yield item