PyPI · #3619 most downloaded on PyPI

sortedcontainers-stubs

2.4.31.3M downloads/moh4l/sortedcontainers-stubs ↗New releases in your daily digest, changelog included.

Type stubs for sortedcontainers

Last release 1 years ago
23 Apr 2025
Release timing varies
gaps range from 3 weeks to 1.5 years
Nearly every release is documented
notes for 4 of 4 stable releases
Nothing withdrawn
no release was ever pulled
3 years old
8 releases · first in 2023

Release timeline

8 releases since 2023

2023202420252026

20232026

One column per quarter.

Releases

2.4.323 Apr 2025
Now allows SortedDict(key_fn) where key_fn accepts a non-string key. Previously this call was not matched by any overload, and an explicit iterable ar
Fixed

SortedDict() constructor:

Now allows SortedDict(key_fn) where key_fn accepts a non-string key. Previously this call was not matched by any overload, and an explicit iterable argument had to be provided. Thanks to @tomtung for reporting and helping to fix this. (issue #6, fixed in #11)

Now allows annotating the constructor explicitly with SortedDict[xxx, yyy](). Previously mypy failed to handle this. (#11)

SortedList() constructor:

No longer accepts SortedList(key_fn), which resulted in a type error at runtime. Calls without an iterable must be SortedList(key=key_fn). (issue #10, fixed in#11)

Now allows annotating the constructor explicitly with SortedList[xxx](). Previously mypy failed to handle this. (#11)

SortedKeyList() constructor:

No longer accepts SortedKeyList(key_fn), which resulted in a type error at runtime. Calls without an iterable must be SortedKeyList(key=key_fn). (issue #10, fixed in#11)

No longer accepts SortedKeyList(key=None), which resulted in a type error at runtime. key is now required to not be None. (issue #12, fixed in#11)

SortedSet() constructor:

No longer accepts SortedSet(key_fn), which resulted in a type error at runtime. Calls without an iterable must be SortedSet(key=key_fn). (issue #10, fixed in#11)

Now allows annotating the constructor explicitly with SortedSet[xxx](). Previously mypy failed to handle this. (#11)

2.4.228 Oct 2023

Using the SortedList (and the other) types as a function that creates an instance of the type works in pyright now. ([#3], [#4])

Fixed

Using the SortedList (and the other) types as a function that creates an instance of the type works in pyright now. (#3, #4)

Changed

Because of the fix to allow pyright to allow using the types as functions, the constructors with no arguments had to be widened to permit assignment to non-comparable/hashable types. The result is that it's unfortunately not a type error to do something like sl: SortedList[type] = SortedList() even though subsequently adding multiple values to this list will fail at runtime.

It doesn't seem to be possible to type the signature of __new__ to constrain SortedList() to only allow comparable element types in a standard way (mypy supported the previous method which worked, but other checkers don't).
The signature definition of SortedDict.setdefault was restructured to satisfy pyright, but the effect of the signature itself remains the same.
pyright runs in CI now

Open source →

2.4.09 Oct 2023

Stubs now published as a standalone package from this separate repo.

Added

Stubs now published as a standalone package from this separate repo.
Tests for stubs using pytest-mypy-plugins
Stub-only types for SortedKeySet and SortedKeyDict which describe the differences that apply when key functions are used (mirrors SortedKeyList).

Changed

Constructors return types that reflect the API differences that apply when key functions are used
The restrictions on key/value types are enforced by the types. Keys/values need to be hashable and or comparable, or unrestricted, according to the collection type and whether a key function is used.
Unsafe operations that would cause type errors at runtime are disallowed. For example, taking a union of two sets with different element types, that could cause a type error due to types not being orderable with respect to each other.

Fixed

A few minor typos, missing methods etc.

Removed

Most private methods, except _reset() (which is documented and used to change the SortedList load factor for performance reasons).

Open source →