Provides SortedDict, which is a Python sorted dictionary: a Python dictionary in which the keys are always in
ascending order.
pysorteddict is available on PyPI. It requires Python 3.10 or newer. Built distributions (binary wheels) are provided for Linux, macOS and Windows, so installing is straightforward.
pip install pysorteddictIf you are on any other platform, install the Python development headers and libraries before running the above command.
All keys in a sorted dictionary must be of the same type, which is determined when the first key-value pair is inserted into it. The values, though, can be of any type.
import json
from pysorteddict import SortedDict
sorted_dict = SortedDict()
sorted_dict["honestly"] = "weight"
sorted_dict["gain is"] = 31.692
sorted_dict["times"] = "easier than"
sorted_dict["losing"] = ["weight"]
assert sorted_dict.key_type is str
print(json.dumps(sorted_dict, indent=2, sort_keys=False))The above Python script will output the keys in ascending order.
{
"gain is": 31.692,
"honestly": "weight",
"losing": [
"weight"
],
"times": "easier than"
}The following key types are supported.
bytesfloatintstr
pysorteddict is implemented entirely in C++. SortedDict provides a Python interface to
std::map<PyObject*, PyObject*, _>.
Create an empty sorted dictionary. args and kwargs are ignored.
Return the key type of the sorted dictionary d, or None if no key-value pairs have been inserted in it.
Return a human-readable representation of the sorted dictionary d.
Return whether key is present in the sorted dictionary d.
Return the number of key-value pairs in the sorted dictionary d.
Return the value mapped to key in the sorted dictionary d.
If no key-value pairs have been inserted into d yet, raise ValueError.
from pysorteddict import *
d = SortedDict()
d["foo"]Traceback (most recent call last):
File "…", line 3, in <module>
d["foo"]
~^^^^^^^
ValueError: key type not set: insert at least one item first
Otherwise, if type(key) does not match the type of the first key inserted into d, raise TypeError.
from pysorteddict import *
d = SortedDict()
d["foo"] = ("bar", "baz")
d[0xC0FFEE]Traceback (most recent call last):
File "…", line 4, in <module>
d[0xC0FFEE]
~^^^^^^^^^^
TypeError: wrong key type: want <class 'str'>, got <class 'int'>
Otherwise, if key is not comparable with instances of its type, raise ValueError.
from pysorteddict import *
d = SortedDict()
d[1.1] = ("racecar",)
d[float("nan")]Traceback (most recent call last):
File "…", line 4, in <module>
d[float("nan")]
~^^^^^^^^^^^^^^
ValueError: bad key: nan
Otherwise, if key is not present in d, raise KeyError.
from pysorteddict import *
d = SortedDict()
d["foo"] = ("bar", "baz")
d["spam"]Traceback (most recent call last):
File "…", line 4, in <module>
d["spam"]
~^^^^^^^^
KeyError: 'spam'
Map value to key in the sorted dictionary d, replacing the previously-mapped value (if any).
If no key-value pairs have been inserted into d yet and type(key) isn't one of the supported types (bytes,
float, int and str), raise TypeError.
from pysorteddict import *
d = SortedDict()
d[["eggs"]] = NoneTraceback (most recent call last):
File "…", line 3, in <module>
d[["eggs"]] = None
~^^^^^^^^^^
TypeError: unsupported key type: <class 'list'>
Otherwise, if type(key) does not match the type of the first key inserted into d, raise TypeError.
from pysorteddict import *
d = SortedDict()
d["foo"] = ("bar", "baz")
d[0xC0FFEE] = "spam"Traceback (most recent call last):
File "…", line 4, in <module>
d[0xC0FFEE] = "spam"
~^^^^^^^^^^
TypeError: wrong key type: want <class 'str'>, got <class 'int'>
Otherwise, if key is not comparable with instances of its type, raise ValueError.
from pysorteddict import *
d = SortedDict()
d[1.1] = ("racecar",)
d[float("nan")] = {}Traceback (most recent call last):
File "…", line 4, in <module>
d[float("nan")] = {}
~^^^^^^^^^^^^^^
ValueError: bad key: nan
Remove key and the value mapped to it from the sorted dictionary d.
If no key-value pairs have been inserted into d yet, raise ValueError.
from pysorteddict import *
d = SortedDict()
del d["foo"]Traceback (most recent call last):
File "…", line 3, in <module>
del d["foo"]
~^^^^^^^
ValueError: key type not set: insert at least one item first
Otherwise, if type(key) does not match the type of the first key inserted into d, raise TypeError.
from pysorteddict import *
d = SortedDict()
d["foo"] = ("bar", "baz")
del d[0xC0FFEE]Traceback (most recent call last):
File "…", line 4, in <module>
del d[0xC0FFEE]
~^^^^^^^^^^
TypeError: wrong key type: want <class 'str'>, got <class 'int'>
Otherwise, if key is not comparable with instances of its type, raise ValueError.
from pysorteddict import *
d = SortedDict()
d[1.1] = ("racecar",)
del d[float("nan")]Traceback (most recent call last):
File "…", line 4, in <module>
del d[float("nan")]
~^^^^^^^^^^^^^^
ValueError: bad key: nan
Otherwise, if key is not present in d, raise KeyError.
from pysorteddict import *
d = SortedDict()
d["foo"] = ("bar", "baz")
del d["spam"]Traceback (most recent call last):
File "…", line 4, in <module>
del d["spam"]
~^^^^^^^^
KeyError: 'spam'
Remove all key-value pairs in the sorted dictionary d.
Return a shallow copy of the sorted dictionary d.
Return the key-value pairs in the sorted dictionary d. The list will be sorted. It will exist independently of d;
it won't be a view on its items.
Return the keys in the sorted dictionary d. The list will be sorted. It will exist independently of d; it won't
be a view on its keys.
Return the values in the sorted dictionary d. The list will be sorted by the keys the values are mapped to. It will
exist independently of d; it won't be a view on its values.