Supporting types

List of supporting types that are used by the package, but that do not make up its primary API.

---

SupportsGreaterThan

Bases: Protocol

SupportsLessThan

Bases: Protocol

SupportsComparison module-attribute

SupportsComparison: TypeAlias = SupportsGreaterThan | SupportsLessThan

Grouping

Grouping(key: TKey, source: Iterable[T])

Bases: Iterable[T]

A wrapper around an iterable, that also holds its grouping key.

Parameters:

• key

  (TKey) –

  they key for this group

Attributes:

• key (TKey) –

  Returns the key for this group.

key property

key: TKey

Returns the key for this group.

Returns:

• TKey –

  [TKey]: The key on which this group was based