tupledict's Introduction

Tupledict

Classes

DictList
TupleDict

You can use add this using poetry by running (it's not pushed to PyPI):

$ poetry add git+https://github.com/cammacrae/tupledict.git

Some examples:

>>> from tupledict import TupleDict

Constructor

The constructor accepts no arguments:

>>> td = TupleDict()

Or a dict:

>>> td = TupleDict({"one": 1, "two": 2})

Or an iterable containing key, value pairs:

>>> td = TupleDict([("one", 1), ("two", 2)])

It also accepts keyword arguments:

>>> td = TupleDict(one=1, two=2)

Or a mixed bag:

>>> td = TupleDict({"one": 1, "two": 2}, three=3, four=4)

Retrieving values

We can then retrieve our values as we would with a dict:

>>> td["one"]
1

TupleDict also implements a select method for this purpose:

>>> td.select("one")
1

select() also works with a list of keys:

>>> td.select(["one", "two"])
[1, 2]

which returns a list of values matching the keys. The keys needn't exist:

>>> td.select(["one", "three"])
[1]

and wildcards denoted by "*" are accepted:

>>> td.select("*")
[1, 2]

Setting values and more advanced retrieval

Values are set in the usual way:

>>> td["three"] = 3
>>> td["three"]
3
>>> td.select(["one", "three"])
[1, 3]
>>> td.select("*")
[1, 2, 3]

Using a tuple to set a composite key makes select() a lot more powerful:

>>> td2 = TupleDict([(("one", "first"), 1), (("one", "second"), 1.5), (("two", "first"), 2)])
>>> td2["one"]
KeyError: 'Key length is 1 but this dict has key length 2.'
>>> td2[("one", "first")]
1
>>> td2.select("one", "*")
[1, 1.5]
>>> td2.select("*", "first")
[1, 2]
>>> td2.select(["one", "two"], "*")
[1, 1.5, 2]
>>> td2.select(["one", "two"], "third")
[]
>>> td2.select("*", ["first", "third"])
[1, 2]

Recommend Projects