1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
==========
Cawdrey
==========
.. start short_desc
**Several useful custom dictionaries for Python 📖 🐍**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/cawdrey/latest?logo=read-the-docs
:target: https://cawdrey.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/cawdrey/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/cawdrey/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/cawdrey/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/cawdrey/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/cawdrey/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/cawdrey/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/cawdrey/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/cawdrey/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/cawdrey/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/cawdrey/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/cawdrey/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/cawdrey/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://requires.io/github/domdfcoding/cawdrey/requirements.svg?branch=master
:target: https://requires.io/github/domdfcoding/cawdrey/requirements/?branch=master
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/cawdrey/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/cawdrey?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/cawdrey?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/cawdrey
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/cawdrey
:target: https://pypi.org/project/cawdrey/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/cawdrey?logo=python&logoColor=white
:target: https://pypi.org/project/cawdrey/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/cawdrey
:target: https://pypi.org/project/cawdrey/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/cawdrey
:target: https://pypi.org/project/cawdrey/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/cawdrey?logo=anaconda
:target: https://anaconda.org/domdfcoding/cawdrey
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/cawdrey?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/cawdrey
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/domdfcoding/cawdrey
:target: https://github.com/domdfcoding/cawdrey/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/cawdrey
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/cawdrey/v0.4.2
:target: https://github.com/domdfcoding/cawdrey/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/cawdrey
:target: https://github.com/domdfcoding/cawdrey/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2021
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/cawdrey
:target: https://pypi.org/project/cawdrey/
:alt: PyPI - Downloads
.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/domdfcoding/cawdrey/master.svg
:target: https://results.pre-commit.ci/latest/github/domdfcoding/cawdrey/master
:alt: pre-commit.ci status
.. end shields
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:
.. code-block:: python
{'foo.bar': 'val'}
to this:
.. code-block:: python
{'foo': {'bar': 'val'}}
check out `unflatten`_, `flattery`_ or `morph`_ to accomplish that.
.. _unflatten: https://github.com/dairiki/unflatten
.. _morph: https://github.com/metagriffin/morph
.. _flattery: https://github.com/acg/python-flattery
`indexed`_ provides an OrederedDict where the values can be accessed by their index as well as by their keys.
.. _indexed: https://github.com/niklasf/indexed.py
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**.
.. _python-benedict: https://github.com/fabiocaccamo/python-benedict
Installation
===========================
.. start installation
``Cawdrey`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install cawdrey
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels http://conda.anaconda.org/conda-forge
$ conda config --add channels http://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install cawdrey
.. end installation
And Finally:
==============
`Why "Cawdrey"? <https://en.wikipedia.org/wiki/Robert_Cawdrey>`_
|
