Demonstrate behaviour of SpecifierSet.__iter__ (#575)

pypa · Jul 17, 2022 · 2bd5da3 · 2bd5da3
1 parent e404434
commit 2bd5da3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/specifiers.rst b/docs/specifiers.rst
@@ -30,6 +30,10 @@ Usage
     >>> combined_spec &= "!=1.1"
     >>> combined_spec
     <SpecifierSet('!=1.1,>=1.0,~=1.0')>
+    >>> # We can iterate over the SpecifierSet to recover the
+    >>> # individual specifiers
+    >>> sorted(combined_spec, key=str)
+    [<Specifier('!=1.1')>, <Specifier('>=1.0')>, <Specifier('~=1.0')>]
     >>> # Create a few versions to check for contains.
     >>> v1 = Version("1.0a5")
     >>> v2 = Version("1.0")

diff --git a/packaging/specifiers.py b/packaging/specifiers.py
@@ -823,6 +823,9 @@ 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)