multidict

Multidicts are useful for working with HTTP headers, URL query args etc.

The code was extracted from aiohttp library.

Introduction

HTTP Headers and URL query string require specific data structure: multidict. It behaves mostly like a regular dict but it may have several values for the same key and preserves insertion ordering.

The key is str (or istr for case-insensitive dictionaries).

multidict has four multidict classes: MultiDict, MultiDictProxy, CIMultiDict and CIMultiDictProxy.

Immutable proxies (MultiDictProxy and CIMultiDictProxy) provide a dynamic view for the proxied multidict, the view reflects underlying collection changes. They implement the Mapping interface.

Regular mutable (MultiDict and CIMultiDict) classes implement MutableMapping and allows to change their own content.

Case insensitive (CIMultiDict and CIMultiDictProxy) ones assume the keys are case insensitive, e.g.:

>>> dct = CIMultiDict(key='val')
>>> 'Key' in dct
True
>>> dct['Key']
'val'

Keys should be either str or istr instance.

The library has optional C Extensions for sake of speed.

Library Installation

$ pip install multidict

The library is Python 3 only!

PyPI contains binary wheels for Linux, Windows and MacOS. If you want to install multidict on another operation system (or Alpine Linux inside a Docker) the Tarball will be used to compile the library from sources. It requires C compiler and Python headers installed.

To skip the compilation please use the MULTIDICT_NO_EXTENSIONS environment variable, e.g.:

$ MULTIDICT_NO_EXTENSIONS=1 pip install multidict

Please note, Pure Python (uncompiled) version is about 20-50 times slower depending on the usage scenario!!!

Source code

The project is hosted on GitHub

Please file an issue on the bug tracker if you have found a bug or have some suggestion in order to improve the library.

Authors and License

The multidict package is written by Andrew Svetlov.

It’s Apache 2 licensed and freely available.

Contents

• Reference
  • MultiDict
    • MultiDict
      • MultiDict.len()
      • MultiDict.d()
      • MultiDict.iter()
      • MultiDict.add()
      • MultiDict.clear()
      • MultiDict.copy()
      • MultiDict.extend()
      • MultiDict.getone()
      • MultiDict.getall()
      • MultiDict.get()
      • MultiDict.keys()
      • MultiDict.items()
      • MultiDict.values()
      • MultiDict.popone()
      • MultiDict.pop()
      • MultiDict.popall()
      • MultiDict.popitem()
      • MultiDict.setdefault()
      • MultiDict.update()
  • CIMultiDict
    • CIMultiDict
  • MultiDictProxy
    • MultiDictProxy
      • MultiDictProxy.len()
      • MultiDictProxy.d()
      • MultiDictProxy.iter()
      • MultiDictProxy.copy()
      • MultiDictProxy.getone()
      • MultiDictProxy.getall()
      • MultiDictProxy.get()
      • MultiDictProxy.keys()
      • MultiDictProxy.items()
      • MultiDictProxy.values()
  • CIMultiDictProxy
    • CIMultiDictProxy
  • Version
    • getversion()
  • istr
    • istr
  • Abstract Base Classes
  • Typing
  • Environment variables
• Benchmarks
  • Introduction
  • How to run
  • How to compare implementations
• Changelog
  • 6.1.0 (2024-09-09)
    • Bug fixes
    • Features
    • Removals and backward incompatible breaking changes
    • Contributor-facing changes
  • 6.0.5 (2024-02-01)
    • Bug fixes
    • Improved documentation
    • Packaging updates and notes for downstreams
    • Contributor-facing changes
  • 6.0.4 (2022-12-24)
    • Bugfixes
  • 6.0.3 (2022-12-03)
    • Features
  • 6.0.2 (2022-01-24)
    • Bugfixes
  • 6.0.1 (2022-01-23)
    • Bugfixes
  • 6.0.0 (2022-01-22)
    • Features
    • Bugfixes
    • Deprecations and Removals
    • Misc
  • 5.2.0 (2021-10-03)
    • Features
    • Bugfixes
  • 5.1.0 (2020-12-03)
    • Features
    • Bugfixes
  • 5.0.1 (2020-11-14)
    • Bugfixes
  • 5.0.0 (2020-10-12)
    • Features
    • Removal
    • Misc
    • 4.7.6 (2020-05-15)
      • Bugfixes
    • 4.7.5 (2020-02-21)
      • Bugfixes
    • 4.7.4 (2020-01-11)
      • Bugfixes
    • Multidict 4.7.3 (2019-12-30)
      • Features
      • Bugfixes
      • Improved Documentation
    • 4.7.2 (2019-12-20)
      • Bugfixes
    • 4.7.1 (2019-12-12)
      • Bugfixes
      • Improved Documentation
    • 4.7.0 (2019-12-10)
      • Features
      • Bugfixes
    • 4.6.1 (2019-11-21)
      • Bugfixes
    • 4.6.0 (2019-11-20)
      • Bugfixes
    • 4.5.2 (2018-11-28)
    • 4.5.1 (2018-11-22)
    • 4.5.0 (2018-11-19)
    • 4.4.2 (2018-09-19)
    • 4.4.1 (2018-09-17)
    • 4.4.0 (2018-07-04)
    • 4.3.1 (2018-05-06)
    • 4.3.0 (2018-05-06)
    • 4.2.0 (2018-04-15)
    • 4.1.0 (2018-01-28)
    • 4.0.0 (2018-01-14)
    • 3.3.2 (2017-11-02)
    • 3.3.1 (2017-11-01)
    • 3.3.0 (2017-10-15)
    • 3.2.0 (2017-09-17)
    • 3.1.3 (2017-07-14)
    • 3.1.2 (2017-07-14)
    • 3.1.1 (2017-07-09)
    • 3.1.0 (2017-06-25)
    • 3.0.0 (2017-06-21)
    • 2.1.7 (2017-05-29)
    • 2.1.6 (2017-05-27)
    • 2.1.5 (2017-05-13)
    • 2.1.4 (2016-12-1)
    • 2.1.3 (2016-11-26)
    • 2.1.2 (2016-09-25)
    • 2.1.1 (2016-09-22)
    • 2.1.0 (2016-09-18)
    • 2.0.1 (2016-08-02)
    • 2.0.0 (2016-07-28)
    • 1.2.2 (2016-08-02)
    • 1.2.1 (2016-07-21)
    • 1.2.0 (2016-07-16)
    • 1.1.0 (2016-07-06)
    • 1.0.3 (2016-03-24)
    • 1.0.2 (2016-03-24)
    • 1.0.0 (2016-02-19)

Indices and tables

• Index

• Module Index

• Search Page