Skip to main content

Case insensitive derivable dictionary

Project description

Test Status Coverage Latest Version License

Installation

You can install the newest version of pydicti from PyPI:

pip install pydicti

Alternatively, you can just take the file pydicti.py and redistribute it with your application.

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:

>>> d = dicti(Hello='foo', world='bar')
>>> d['heLLO']
'foo'
>>> 'WOrld' in d
True

Internally however, the keys retain their original case:

>>> sorted(d.keys())
['Hello', 'world']

odicti

The type odicti instanciates order-preserving case insensitive dictionaries:

>>> 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:

>>> 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:

>>> issubclass(odicti, OrderedDict)
True

Dicti

The function Dicti is convenient for creating case insensitive copies of dictionary instances:

>>> 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:

>>> import json
>>> d == json.loads(json.dumps(d), object_hook=dicti)
True

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:

>>> 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.

License

Copyright © 2013 Thomas Gläßle <t_glaessle@gmx.de>

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.

CHANGELOG

1.1.2

Date: 28.06.2019

  • leave item order invariant under assignment in odicti (#2)

  • leave key case invariant under assignment

1.1.1

Date: 25.03.2019

  • fix deprecated MutableMapping import (error on py38)

1.1.0

Date: 19.03.2019

  • drop py2.6 support

  • fix version number in long_description

1.0.0

Date: 19.03.2019

  • make str representation more dict-like

  • misc cleanup

0.0.6

Date: 08.09.2016

  • fix UnicodeDecodeError in setup when UTF-8 is not the default encoding

0.0.5

Date: 18.05.2016

  • fix pickling on py 3.5

  • the ‘name’ parameter to build_dicti can now be a qualname

0.0.4

Date: 01.02.2014

  • add coverage reports

  • use more extensive unit tests

  • add support for pickle

0.0.3

Date: 26.01.2014

  • add support for python26

  • make dependency on OrderedDict optional

  • migrate to setuptools in order to use testing commands

  • support ordereddict.OrderedDict as fallback

0.0.2

Date: 29.12.2013

  • fix dicti.pop

  • support deepcopy(dicti)

  • make nosetest automatically execute the doctests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydicti-1.1.2.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

pydicti-1.1.2-py2.py3-none-any.whl (7.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pydicti-1.1.2.tar.gz.

File metadata

  • Download URL: pydicti-1.1.2.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for pydicti-1.1.2.tar.gz
Algorithm Hash digest
SHA256 ca62561a643050e9bf6bba7c053de3c01fa050d6518ead3758487486e3ab269a
MD5 54e9184fa3f3db2cfd5a9f6250e5b576
BLAKE2b-256 ea46dee372a3c77ed94e9f0736e46e7c0c4c0bec1acfe1d74df42022c149d55f

See more details on using hashes here.

File details

Details for the file pydicti-1.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pydicti-1.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for pydicti-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4a8e06cb1895d4295caa09ca52b3371fb7bbec6d085dcb9cc367e9d146e3344d
MD5 55e219ccb9cdb2504a5e4a0156afa70e
BLAKE2b-256 f469d8f787d695e7e9e5a0d4f786820b88c07385379724498c6042e043dcae0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page