https://github.com/coldfix/pydicti
Case insensitive dictionary with user-defined underlying dictionary.
https://github.com/coldfix/pydicti
Last synced: 3 months ago
JSON representation
Case insensitive dictionary with user-defined underlying dictionary.
- Host: GitHub
- URL: https://github.com/coldfix/pydicti
- Owner: coldfix
- License: other
- Created: 2013-06-24T22:07:15.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T19:06:48.000Z (over 1 year ago)
- Last Synced: 2025-02-02T00:31:50.812Z (4 months ago)
- Language: Python
- Size: 117 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: COPYING
Awesome Lists containing this project
README
pydicti
-------
|Tests| |Coverage| |Version| |License|
Installation
~~~~~~~~~~~~
You can install the newest version of *pydicti* from PyPI_:
.. code:: bash
pip install pydicti
Alternatively, you can just take the file ``pydicti.py`` and redistribute
it with your application.
.. _PyPI: https://pypi.python.org/pypi/pydicti/
Overview
~~~~~~~~
- ``class dicti``: default case insensitive dictionary type
- ``class odicti``: ordered case insensitive dictionary type
- ``def build_dicti``: create a case insensitive dictionary class
- ``def Dicti``: create a case insensitive copy of a dictionary
dicti
=====
Objects of type ``dicti`` are dictionaries that feature case insensitive
item access:
.. code:: python
>>> d = dicti(Hello='foo', world='bar')
>>> d['heLLO']
'foo'
>>> 'WOrld' in d
True
Internally however, the keys retain their original case:
.. code:: python
>>> sorted(d.keys())
['Hello', 'world']
odicti
======
The type ``odicti`` instanciates order-preserving case insensitive
dictionaries:
.. code:: python
>>> odicti(zip('abc', range(3)))
Dicti(OrderedDict([('a', 0), ('b', 1), ('c', 2)]))
build_dicti
===========
With ``build_dicti`` you can create custom case insensitive dictionaries.
This function is what is used to create the ``pydicti.dicti`` and
``pydicti.odicti`` types. Note that calling ``build_dicti`` several times
with the same argument will result in identical types:
.. code:: python
>>> build_dicti(dict) is dicti
True
>>> build_dicti(OrderedDict) is odicti
True
``build_dicti`` uses subclassing to inherit the semantics of the given base
dictionary type:
.. code:: python
>>> issubclass(odicti, OrderedDict)
True
Dicti
=====
The function ``Dicti`` is convenient for creating case insensitive
copies of dictionary instances:
.. code:: python
>>> o = OrderedDict(zip('abcdefg', range(7)))
>>> oi = Dicti(o)
>>> type(oi) is odicti
True
JSON
~~~~
The subclassing approach allows to plug your dictionary instance into
places where typechecking with ``isinstance`` is used, like in the json_
module:
.. code:: python
>>> import json
>>> d == json.loads(json.dumps(d), object_hook=dicti)
True
.. _json: http://docs.python.org/3.3/library/json.html
You can use ``json.loads(s, object_pairs_hook=odicti)`` to
deserialize ordered dictionaries.
Pitfalls
~~~~~~~~
The equality comparison tries preserves the semantics of the base type as
well as reflexitivity. This has impact on the transitivity of the
comparison operator:
.. code:: python
>>> i = dicti(oi)
>>> roi = odicti(reversed(list(oi.items())))
>>> roi == i and i == oi
True
>>> oi != roi and roi != oi # NOT transitive!
True
>>> oi == i and i == oi # reflexive
True
The `coercion rules`_ in python allow this to work pretty well when
performing comparisons between types that are subclasses of each other. Be
careful otherwise, however.
.. _`coercion rules`: http://docs.python.org/2/reference/datamodel.html#coercion-rules
License
~~~~~~~
Copyright © 2013 Thomas Gläßle
This work is free. You can redistribute it and/or modify it under the
terms of the Do What The Fuck You Want To Public License, Version 2, as
published by Sam Hocevar. See the COPYING file for more details.
This program is free software. It comes without any warranty, to the
extent permitted by applicable law.
.. Badges:
.. |Version| image:: https://img.shields.io/pypi/v/pydicti.svg
:target: https://pypi.python.org/pypi/pydicti
:alt: Latest Version
.. |Tests| image:: https://github.com/coldfix/pydicti/workflows/Tests/badge.svg
:target: https://github.com/coldfix/pydicti/actions?query=Tests
:alt: Test Status
.. |Coverage| image:: https://codecov.io/gh/coldfix/pydicti/branch/master/graph/badge.svg?token=7FEGhE9UVI
:target: https://codecov.io/gh/coldfix/pydicti
:alt: Coverage
.. |License| image:: https://img.shields.io/pypi/l/pydicti.svg
:target: https://github.com/coldfix/pydicti/blob/master/COPYING
:alt: License