Cawdrey¶

Several useful custom dictionaries for Python 📖 🐍

Docs
Tests
PyPI
Anaconda
Activity
Other

Contents¶

frozendict: An immutable dictionary that cannot be changed after creation.
FrozenOrderedDict: An immutable OrderedDict where the order of keys is preserved, but that cannot be changed after creation.
AlphaDict: A FrozenOrderedDict where the keys are stored in alphabetical order.
bdict: A dictionary where key, value pairs are stored both ways round.

This package also provides two base classes for creating your own custom dictionaries:

FrozenBase: An Abstract Base Class for Frozen dictionaries.
MutableBase: An Abstract Base Class for mutable dictionaries.

Other Dictionary Packages¶

If you’re looking to unflatten a dictionary, such as to go from this:

{'foo.bar': 'val'}

to this:

{'foo': {'bar': 'val'}}

check out unflatten, flattery or morph to accomplish that.

indexed provides an OrederedDict where the values can be accessed by their index as well as by their keys.

There’s also python-benedict, which provides a custom dictionary with keylist/keypath support, I/O shortcuts (Base64, CSV, JSON, TOML, XML, YAML, pickle, query-string) and many utilities.

Installation¶

python3 -m pip install cawdrey --user

First add the required channels

conda config --add channels https://conda.anaconda.org/domdfcoding
conda config --add channels https://conda.anaconda.org/conda-forge

Then install

conda install cawdrey

python3 -m pip install git+https://github.com/domdfcoding/cawdrey@master --user

AlphaDict¶

class AlphaDict(seq=None, **kwargs)[source]¶

Bases: cawdrey.frozenordereddict.FrozenOrderedDict

Initialize an immutable, alphabetised dictionary.

The signature is the same as regular dictionaries.

AlphaDict() -> new empty AlphaDict
AlphaDict(mapping) -> new AlphaDict initialized from a mapping object’s (key, value) pairs
AlphaDict(iterable) -> new AlphaDict initialized as if via:

d = {}
for k, v in iterable:
    d[k] = v

AlphaDict(**kwargs) -> new AlphaDict initialized with the name=value pairs in the keyword argument list.

For example:

AlphaDict(one=1, two=2)

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`copy`(args, *kwargs)	Return a copy of the `FrozenOrderedDict`.
`fromkeys`(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
`get`(k[, default])	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `FrozenOrderedDict`’s items.
`keys`()	Returns a set-like object providing a view on the `FrozenOrderedDict`’s keys.
`values`()	Returns an object providing a view on the `FrozenOrderedDict`’s values.

__contains__(key)¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

copy(*args, **kwargs)¶

Return a copy of the FrozenOrderedDict.

Parameters

args
kwargs

classmethod fromkeys(iterable, value=None)¶: Create a new dictionary with keys from iterable and values set to value.

get(k, default=None)¶

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()¶

Returns a set-like object providing a view on the FrozenOrderedDict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()¶

Returns a set-like object providing a view on the FrozenOrderedDict’s keys.

Return type: AbstractSet[~KT]

values()¶

Returns an object providing a view on the FrozenOrderedDict’s values.

Return type: ValuesView[~VT]

bdict¶

class bdict(seq=None, **kwargs)[source]¶

Bases: collections.UserDict

Returns a new dictionary initialized from an optional positional argument, and a possibly empty set of keyword arguments.

Each key: value pair is entered into the dictionary in both directions, so you can perform lookups with either the key or the value.

If no positional argument is given, an empty dictionary is created.

If a positional argument is given and it is a mapping object, a dictionary is created with the same key-value pairs as the mapping object. Otherwise, the positional argument must be an iterable object. Each item in the iterable must itself be an iterable with exactly two objects. The first object of each item becomes a key in the new dictionary, and the second object the corresponding value.

If keyword arguments are given, the keyword arguments and their values are added to the dictionary created from the positional argument.

If an attempt is made to add a key or value that already exists in the dictionary a ValueError will be raised.

Keys or values of None, True and False will be stored internally as "_None", "_True" and "_False" respectively

Based on https://stackoverflow.com/a/1063393 by https://stackoverflow.com/users/9493/brian

Improved May 2020 with suggestions from https://treyhunner.com/2019/04/why-you-shouldnt-inherit-from-list-and-dict-in-python/

Methods:

`__contains__`(key)	Return `key in self`.
`__delitem__`(key)	Delete `self[key]`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__repr__`()	Return repr(self).
`__setitem__`(key, val)	Set `self[key]` to `value`.
`clear`()	Removes all items from the `bdict`.
`get`()	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`setdefault`(k[,d])
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()	Returns an object providing a view on the `bdict`’s values.

__contains__(key)[source]¶

Return key in self.

Parameters: key (object)
Return type: bool

__delitem__(key)[source]¶

Delete self[key].

Parameters: key (~KT)

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)[source]¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__repr__()¶: Return repr(self).

__setitem__(key, val)[source]¶

Set self[key] to value.

Parameters

key
val

clear()[source]¶

Removes all items from the bdict.

Return type: None

get(k: KT) → Optional[VT][source]¶

get(k: KT, default: Union[VT, T]) → Union[VT, T]

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()[source]¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()[source]¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

update([E, ]**F) → None. Update D from mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values()[source]¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

frozendict¶

About¶

frozendict is an immutable wrapper around dictionaries that implements the complete mapping interface. It can be used as a drop-in replacement for dictionaries where immutability is desired.

Of course, this is python, and you can still poke around the object’s internals if you want.

The frozendict constructor mimics dict, and all of the expected interfaces (iter, len, repr, hash, getitem) are provided. Note that a frozendict does not guarantee the immutability of its values, so the utility of the hash method is restricted by usage.

The only difference is that the copy() method of frozendict takes variable keyword arguments, which will be present as key/value pairs in the new, immutable copy.

Usage¶

>>> from cawdrey import frozendict
>>>
>>> fd = frozendict({ 'hello': 'World' })
>>>
>>> print fd
<frozendict {'hello': 'World'}>
>>>
>>> print fd['hello']
'World'
>>>
>>> print fd.copy(another='key/value')
<frozendict {'hello': 'World', 'another': 'key/value'}>
>>>

In addition, frozendict supports the + and - operands. If you add a dict-like object, a new frozendict will be returned, equal to the old frozendict updated with the other object. Example:

>>> frozendict({"Sulla": "Marco", 2: 3}) + {"Sulla": "Marò", 4: 7}
<frozendict {'Sulla': 'Marò', 2: 3, 4: 7}>
>>>

You can also subtract an iterable from a frozendict. A new frozendict will be returned, without the keys that are in the iterable. Examples:

>>> frozendict({"Sulla": "Marco", 2: 3}) - {"Sulla": "Marò", 4: 7}
<frozendict {'Sulla': 'Marco', 2: 3}>
>>> frozendict({"Sulla": "Marco", 2: 3}) - [2, 4]
<frozendict {'Sulla': 'Marco'}>
>>>

Some other examples:

>>> from cawdrey import frozendict
>>> fd = frozendict({"Sulla": "Marco", "Hicks": "Bill"})
>>> print(fd)
<frozendict {'Sulla': 'Marco', 'Hicks': 'Bill'}>
>>> print(fd["Sulla"])
Marco
>>> fd["Bim"]
KeyError: 'Bim'
>>> len(fd)
2
>>> "Sulla" in fd
True
>>> "Sulla" not in fd
False
>>> "Bim" in fd
False
>>> hash(fd)
835910019049608535
>>> fd_unhashable = frozendict({1: []})
>>> hash(fd_unhashable)
TypeError: unhashable type: 'list'
>>> fd2 = frozendict({"Hicks": "Bill", "Sulla": "Marco"})
>>> print(fd2)
<frozendict {'Hicks': 'Bill', 'Sulla': 'Marco'}>
>>> fd2 is fd
False
>>> fd2 == fd
True
>>> frozendict()
<frozendict {}>
>>> frozendict(Sulla="Marco", Hicks="Bill")
<frozendict {'Sulla': 'Marco', 'Hicks': 'Bill'}>
>>> frozendict((("Sulla", "Marco"), ("Hicks", "Bill")))
<frozendict {'Sulla': 'Marco', 'Hicks': 'Bill'}>
>>> fd.get("Sulla")
'Marco'
>>> print(fd.get("God"))
None
>>> tuple(fd.keys())
('Sulla', 'Hicks')
>>> tuple(fd.values())
('Marco', 'Bill')
>>> tuple(fd.items())
(('Sulla', 'Marco'), ('Hicks', 'Bill'))
>>> iter(fd)
<dict_keyiterator object at 0x7feb75c49188>
>>> frozendict.fromkeys(["Marco", "Giulia"], "Sulla")
<frozendict {'Marco': 'Sulla', 'Giulia': 'Sulla'}>
>>> fd["Sulla"] = "Silla"
TypeError: 'frozendict' object does not support item assignment
>>> del fd["Sulla"]
TypeError: 'frozendict' object does not support item deletion
>>> fd.clear()
AttributeError: 'frozendict' object has no attribute 'clear'
>>> fd.pop("Sulla")
AttributeError: 'frozendict' object has no attribute 'pop'
>>> fd.popitem()
AttributeError: 'frozendict' object has no attribute 'popitem'
>>> fd.setdefault("Sulla")
AttributeError: 'frozendict' object has no attribute 'setdefault'
>>> fd.update({"Bim": "James May"})
AttributeError: 'frozendict' object has no attribute 'update'

API Reference¶

class frozendict(*args, **kwds)[source]¶

Bases: cawdrey.base.FrozenBase

An immutable wrapper around dictionaries that implements the complete collections.Mapping interface. It can be used as a drop-in replacement for dictionaries where immutability is desired.

Methods:

`__add__`(other, args, *kwargs)	If you add a dict-like object, a new frozendict will be returned, equal to the old frozendict updated with the other object.
`__and__`(other, args, *kwargs)	Returns a new `frozendict`, that is the intersection between `self` and `other`.
`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`__sub__`(other, args, *kwargs)	The method will create a new `frozendict`, result of the subtraction by other.
`fromkeys`(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
`get`(k[, default])	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`sorted`(*args[, by])	Return a new `frozendict`, with the element insertion sorted.
`values`()	Returns an object providing a view on the `bdict`’s values.

__add__(other, *args, **kwargs)[source]¶: If you add a dict-like object, a new frozendict will be returned, equal to the old frozendict updated with the other object.

__and__(other, *args, **kwargs)[source]¶

Returns a new frozendict, that is the intersection between self and other.

If other is a dict-like object, the intersection will contain only the items in common.

If other is another iterable, the intersection will contain the items of self which keys are in other.

Iterables of pairs are not managed differently. This is for consistency.

Beware! The final order is dictated by the order of other. This allows the coder to change the order of the original frozendict.

The last two behaviours breaks voluntarily the dict.items() API, for consistency and practical reasons.

__contains__(key)¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

__sub__(other, *args, **kwargs)[source]¶

The method will create a new frozendict, result of the subtraction by other.

If other is a dict-like, the result will have the items of the frozendict that are not in common with other.

If other is another type of iterable, the result will have the items of frozendict without the keys that are in other.

classmethod fromkeys(iterable, value=None)¶: Create a new dictionary with keys from iterable and values set to value.

get(k, default=None)¶

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

sorted(*args, by='keys', **kwargs)[source]¶

Return a new frozendict, with the element insertion sorted. The signature is the same as the builtin sorted function, except for the additional parameter by, that is "keys" by default and can also be "values" and "items". So the resulting frozendict can be sorted by keys, values or items.

If you want more complicated sorts read the documentation of sorted.

The the parameters passed to the key function are the keys of the frozendict if by = "keys", and are the items otherwise.

Note

Sorting by keys and items achieves the same effect. The only difference is when you want to customize the sorting passing a custom key function. You could achieve the same result using by = "values", since also sorting by values passes the items to the key function. But this is an implementation detail and you should not rely on it.

values()¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

Copyright¶

Based on https://github.com/slezica/python-frozendict and https://github.com/mredolatti/python-frozendict .
Copyright (c) 2012 Santiago Lezica
Licensed under the MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Also based on https://github.com/Marco-Sulla/python-frozendict
Copyright (c) Marco Sulla
Licensed under the GNU Lesser General Public License Version 3

FrozenOrderedDict¶

About¶

FrozenOrderedDict is a immutable wrapper around an OrderedDict.

FrozenOrderedDict is similar to frozendict, and with regards to immutability it solves the same problems:

Because dictionaries are mutable, they are not hashable and cannot be used in sets or as dictionary keys.

Nasty bugs can and do occur when mutable data structures are passed around.

It can be initialized just like a dict or OrderedDict. Once instantiated, an instance of FrozenOrderedDict cannot be altered, since it does not implement the MutableMapping interface.

It does implement the Mapping interface, so can be used just like a normal dictionary in most cases.

In order to modify the contents of a FrozenOrderedDict, a new instance must be created. The easiest way to do that is by calling the .copy() method. It will return a new instance of FrozenOrderedDict initialized using the following steps:

A copy of the wrapped OrderedDict instance will be created.

If any arguments or keyword arguments are passed to the .copy() method, they will be used to create another OrderedDict instance, which will then be used to update the copy made in step #1.

Finally, self.__class__() will be called, passing the copy as the only argument.

API Reference¶

class FrozenOrderedDict(*args, **kwds)[source]¶

Bases: cawdrey.base.FrozenBase

An immutable OrderedDict. It can be used as a drop-in replacement for dictionaries where immutability is desired.

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`copy`(args, *kwargs)	Return a copy of the `FrozenOrderedDict`.
`fromkeys`(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
`get`()	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `FrozenOrderedDict`’s items.
`keys`()	Returns a set-like object providing a view on the `FrozenOrderedDict`’s keys.
`values`()	Returns an object providing a view on the `FrozenOrderedDict`’s values.

__contains__(key)[source]¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)[source]¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

copy(*args, **kwargs)[source]¶

Return a copy of the FrozenOrderedDict.

Parameters

args
kwargs

classmethod fromkeys(iterable, value=None)¶: Create a new dictionary with keys from iterable and values set to value.

get(k: KT) → Optional[VT][source]¶

get(k: KT, default: Union[VT, T]) → Union[VT, T]

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()[source]¶

Returns a set-like object providing a view on the FrozenOrderedDict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()[source]¶

Returns a set-like object providing a view on the FrozenOrderedDict’s keys.

Return type: AbstractSet[~KT]

values()[source]¶

Returns an object providing a view on the FrozenOrderedDict’s values.

Return type: ValuesView[~VT]

Copyright¶

Based on https://github.com/slezica/python-frozendict and https://github.com/mredolatti/python-frozendict .
Copyright (c) 2012 Santiago Lezica
Licensed under the MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Also based on https://github.com/Marco-Sulla/python-frozendict
Copyright (c) Marco Sulla
Licensed under the GNU Lesser General Public License Version 3

Also based on https://github.com/wsmith323/frozenordereddict
Copyright (c) 2015 Warren Smith
Licensed under the MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NonelessDict¶

About¶

NonelessDict is a wrapper around dict that will check if a value is None/empty/False, and not add the key in that case.

The class has a method set_with_strict_none_check() that can be used to set a value and check only for None values.

NonelessOrderedDict is based on NonelessDict and OrderedDict, so the order of key insertion is preserved.

API Reference¶

Provides NonelessDict.

Classes:

`NonelessDict`(args, *kwds)	A wrapper around dict that will check if a value is `None`/empty/`False`, and not add the key in that case.
`NonelessOrderedDict`(args, *kwds)	A wrapper around OrderedDict that will check if a value is None/empty/False, and not add the key in that case.

class NonelessDict(*args, **kwds)[source]¶

Bases: cawdrey.base.MutableBase

A wrapper around dict that will check if a value is None/empty/False, and not add the key in that case.

Use the set_with_strict_none_check() method to check only for None.

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`clear`()
`fromkeys`(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
`get`(k[, default])	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`set_with_strict_none_check`(key, value)	param key
`setdefault`(k[,d])
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()	Returns an object providing a view on the `bdict`’s values.

__contains__(key)¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

clear() → None. Remove all items from D.¶

classmethod fromkeys(iterable, value=None)¶: Create a new dictionary with keys from iterable and values set to value.

get(k, default=None)¶

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

set_with_strict_none_check(key, value)[source]¶

Parameters

key
value

Return type

None

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

update([E, ]**F) → None. Update D from mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values()¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

class NonelessOrderedDict(*args, **kwds)[source]¶

Bases: cawdrey.base.MutableBase

A wrapper around OrderedDict that will check if a value is None/empty/False, and not add the key in that case. Use the set_with_strict_none_check function to check only for None

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`clear`()
`fromkeys`(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
`get`(k[, default])	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`setdefault`(k[,d])
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()	Returns an object providing a view on the `bdict`’s values.

__contains__(key)¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

clear() → None. Remove all items from D.¶

classmethod fromkeys(iterable, value=None)¶: Create a new dictionary with keys from iterable and values set to value.

get(k, default=None)¶

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

update([E, ]**F) → None. Update D from mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values()¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

Copyright¶

Based on https://github.com/slezica/python-frozendict and https://github.com/jerr0328/python-helpfuldicts .
Copyright (c) 2012 Santiago Lezica
Licensed under the MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Base Classes¶

About¶

FrozenBase is the base class for frozendict and FrozenOrderedDict. If you wish to construct your own frozen dictionary classes, you may inherit from this class.

API Reference¶

Base Classes

Classes:

`DictWrapper`(args, *kwds)	Abstract Mixin class for classes that wrap a dict object or similar
`FrozenBase`(args, *kwds)	Abstract Base Class for Frozen dictionaries
`MutableBase`(args, *kwds)	Abstract Base Class for mutable dictionaries

class DictWrapper(*args, **kwds)[source]¶

Bases: collections.abc.Mapping, typing.Generic

Abstract Mixin class for classes that wrap a dict object or similar

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`get`()	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`values`()	Returns an object providing a view on the `bdict`’s values.

__contains__(key)[source]¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)[source]¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()[source]¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()[source]¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()[source]¶

Return a string representation of the DictWrapper.

Return type: str

get(k: KT) → Optional[VT][source]¶

get(k: KT, default: Union[VT, T]) → Union[VT, T]

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()[source]¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()[source]¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

values()[source]¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

class FrozenBase(*args, **kwds)[source]¶

Bases: cawdrey.base.DictWrapper

Abstract Base Class for Frozen dictionaries

Used by frozendict and FrozenOrderedDict.

Custom subclasses must implement at a minimum __init__, copy, fromkeys.

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`fromkeys`()	Create a new dictionary with keys from iterable and values set to value.
`get`(k[, default])	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`values`()	Returns an object providing a view on the `bdict`’s values.

__contains__(key)¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

classmethod fromkeys(iterable: Iterable[_T]) → FrozenBase[_T, Any][source]¶
classmethod fromkeys(iterable: Iterable[_T], value: _S) → FrozenBase[_T, _S]: Create a new dictionary with keys from iterable and values set to value.

get(k, default=None)¶

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

values()¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

class MutableBase(*args, **kwds)[source]¶

Bases: cawdrey.base.DictWrapper, collections.abc.MutableMapping, typing.Generic

Abstract Base Class for mutable dictionaries

Used by NonelessDict and NonelessOrderedDict.

Custom subclasses must implement at a minimum __init__, copy, fromkeys.

Methods:

`__contains__`(key)	Return `key in self`.
`__eq__`(other)	Return `self == other`.
`__getitem__`(key)	Return `self[key]`.
`__iter__`()	Iterates over the dictionary’s keys
`__len__`()	Returns the number of keys in the dictionary.
`__repr__`()	Return a string representation of the `DictWrapper`.
`clear`()
`fromkeys`()	Create a new dictionary with keys from iterable and values set to value.
`get`(k[, default])	Return the value for `k` if `k` is in the dictionary, else `default`.
`items`()	Returns a set-like object providing a view on the `bdict`’s items.
`keys`()	Returns a set-like object providing a view on the `bdict`’s keys.
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`setdefault`(k[,d])
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()	Returns an object providing a view on the `bdict`’s values.

__contains__(key)¶

Return key in self.

Parameters: key (object)
Return type: bool

__eq__(other)¶

Return self == other.

Return type: bool

__getitem__(key)¶

Return self[key].

Parameters: key (~KT)
Return type: ~VT

__iter__()¶

Iterates over the dictionary’s keys

Return type: Iterator[~KT]

__len__()¶

Returns the number of keys in the dictionary.

Return type: int

__repr__()¶

Return a string representation of the DictWrapper.

Return type: str

clear() → None. Remove all items from D.¶

classmethod fromkeys(iterable: Iterable[_T]) → MutableBase[_T, Any][source]¶
classmethod fromkeys(iterable: Iterable[_T], value: _S) → MutableBase[_T, _S]: Create a new dictionary with keys from iterable and values set to value.

get(k, default=None)¶

Return the value for k if k is in the dictionary, else default.

Parameters

k – The key to return the value for.
default – The value to return if key is not in the dictionary. Default None.

items()¶

Returns a set-like object providing a view on the bdict’s items.

Return type: AbstractSet[Tuple[~KT, ~VT]]

keys()¶

Returns a set-like object providing a view on the bdict’s keys.

Return type: AbstractSet[~KT]

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

update([E, ]**F) → None. Update D from mapping/iterable E and F.¶: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values()¶

Returns an object providing a view on the bdict’s values.

Return type: ValuesView[~VT]

Functions¶

alphabetical_dict(**kwargs)[source]¶

Returns an OrderedDict with the keys sorted alphabetically.

Parameters: kwargs
Returns
Return type

Overview¶

Cawdrey uses tox to automate testing and packaging, and pre-commit to maintain code quality.

Install pre-commit with pip and install the git hook:

python -m pip install pre-commit
pre-commit install

Coding style¶

Yapf is used for code formatting, and isort is used to sort imports.

yapf and isort can be run manually via pre-commit:

pre-commit run yapf -a
pre-commit run isort -a

The complete autoformatting suite can be run with pre-commit:

pre-commit run -a

Automated tests¶

Tests are run with tox and pytest. To run tests for a specific Python version, such as Python 3.6, run:

tox -e py36

To run tests for all Python versions, simply run:

tox

Type Annotations¶

Type annotations are checked using mypy. Run mypy using tox:

tox -e mypy

Build documentation locally¶

The documentation is powered by Sphinx. A local copy of the documentation can be built with tox:

tox -e docs

Downloading source code¶

The Cawdrey source code is available on GitHub, and can be accessed from the following URL: https://github.com/domdfcoding/cawdrey”

If you have git installed, you can clone the repository with the following command:

$ git clone https://github.com/domdfcoding/cawdrey"
> Cloning into 'cawdrey'...
> remote: Enumerating objects: 47, done.
> remote: Counting objects: 100% (47/47), done.
> remote: Compressing objects: 100% (41/41), done.
> remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
> Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
> Resolving deltas: 100% (66/66), done.

Alternatively, the code can be downloaded in a ‘zip’ file by clicking:

Clone or download –> Download Zip

Downloading a ‘zip’ file of the source code¶

Building from source¶

The recommended way to build Cawdrey is to use tox:

tox -e build

The source and wheel distributions will be in the directory dist.

If you wish, you may also use pep517.build or another PEP 517-compatible build tool.

View the Function Index or browse the Source Code.

Browse the GitHub Repository

And Finally:¶

Why “Cawdrey”?