pysorteddict 0.0.6

Python sorted dictionary: a Python dictionary in which the keys are always in ascending order

pysorteddict

Provides SortedDict. It's like Python's dict, but the keys are always in ascending order.

Installation

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 pysorteddict

If you are on any other platform, install the Python development headers and libraries before running the above command.

Usage

All keys in a sorted dictionary must be of the same type, which must be passed to the constructor. The values, though, can be of any type.

from pysorteddict import SortedDict

sorted_dict = SortedDict(int)
sorted_dict[5659] = "gaining weight is"
sorted_dict[1992] = 31.692
sorted_dict[24274] = "times easier than"
sorted_dict[9765] = ["losing", "weight"]
print(sorted_dict)

This program should output {1992: 31.692, 5659: 'gaining weight is', 9765: ['losing', 'weight'], 24274: 'times easier than'}. Note that the keys are in ascending order.

Implementation Details

pysorteddict is implemented entirely in C++. SortedDict provides a Python interface to std::map<PyObject*, PyObject*, _>.

Documentation

class pysorteddict.SortedDict(key_type)

Constructor. Create a new sorted dictionary in which the keys are of type key_type. As of the current version, key_type must be int. Support for some more types will be added in due course.

len(d)

Return the number of key-value pairs in a sorted dictionary d.

d[key]

Return the value mapped to key in a sorted dictionary d.

• If key is not an instance of key_type passed to the constructor, raise TypeError.
• If key is not present in d, raise KeyError.

d[key] = value

Map value to key in a sorted dictionary d, overwriting the previously-mapped value (if any).

• If key is not an instance of key_type passed to the constructor, raise TypeError.

del d[key]

Remove key and the value mapped to it from a sorted dictionary d.

• If key is not present in d, raise KeyError.

str(d)

Return a human-readable representation of a sorted dictionary d.

d.items()

Return the list of key-value pairs in a sorted dictionary d. This list will be sorted.

d.keys()

Return the list of keys in a sorted dictionary d. This list will be sorted.

d.values()

Return the list of values in a sorted dictionary d. The order of the values will be such that the keys they are mapped to will be in ascending order.