[Python-modules-commits] [python-multidict] 01/03: import python-multidict_1.2.1.orig.tar.gz
Piotr Ożarowski
piotr at moszumanska.debian.org
Sat Jul 23 20:06:31 UTC 2016
This is an automated email from the git hooks/post-receive script.
piotr pushed a commit to branch master
in repository python-multidict.
commit f35ea17dee35c5572a917a29ac858948f2c6b062
Author: Piotr Ożarowski <ozarow at gmail.com>
Date: Sat Jul 23 22:00:52 2016 +0200
import python-multidict_1.2.1.orig.tar.gz
---
CHANGES.rst | 36 +
MANIFEST.in | 13 +
Makefile | 77 +
PKG-INFO | 101 +
README.rst | 49 +
docs/Makefile | 182 +
docs/conf.py | 315 +
docs/index.rst | 102 +
docs/make.bat | 242 +
docs/multidict.rst | 342 +
docs/spelling_wordlist.txt | 66 +
multidict.egg-info/PKG-INFO | 101 +
multidict.egg-info/SOURCES.txt | 21 +
multidict.egg-info/dependency_links.txt | 1 +
multidict.egg-info/top_level.txt | 1 +
multidict/__init__.py | 34 +
multidict/_multidict.c | 17249 ++++++++++++++++++++++++++++++
multidict/_multidict.pyx | 658 ++
multidict/_multidict_py.py | 368 +
setup.cfg | 5 +
setup.py | 105 +
tests/test_multidict.py | 878 ++
22 files changed, 20946 insertions(+)
diff --git a/CHANGES.rst b/CHANGES.rst
new file mode 100644
index 0000000..f1d24cb
--- /dev/null
+++ b/CHANGES.rst
@@ -0,0 +1,36 @@
+1.2.1 (2016-07-21)
+------------------
+
+* Don't expose `multidict.__version__`
+
+
+1.2.0 (2016-07-16)
+------------------
+
+* Make `upstr(upstr('abc'))` much faster
+
+
+1.1.0 (2016-07-06)
+------------------
+
+* Don't double-iterate during MultiDict initialization #3
+
+* Fix CIMultiDict.pop: it is case insensitive now #1
+
+* Provide manylinux wheels as well as Windows ones
+
+1.0.3 (2016-03-24)
+------------------
+
+* Add missing MANIFEST.in
+
+1.0.2 (2016-03-24)
+------------------
+
+* Fix setup build
+
+
+1.0.0 (2016-02-19)
+------------------
+
+* Initial implementation
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..3bf5b71
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,13 @@
+include LICENSE.txt
+include CHANGES.rst
+include README.rst
+include Makefile
+graft multidict
+graft docs
+graft tests
+global-exclude *.pyc
+exclude multidict/_multidict.html
+exclude multidict/_multidict.*.so
+exclude multidict/_multidict.pyd
+exclude multidict/_multidict.*.pyd
+prune docs/_build
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..8f525f3
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,77 @@
+# Some simple testing tasks (sorry, UNIX only).
+
+.install-deps: requirements-dev.txt
+ pip install -U -r requirements-dev.txt
+ touch .install-deps
+
+flake: .install-deps
+# python setup.py check -rms
+ flake8 multidict
+ if python -c "import sys; sys.exit(sys.version_info < (3,5))"; then \
+ flake8 tests; \
+ fi
+
+
+.develop: .install-deps $(shell find multidict -type f)
+ pip install -e .
+ touch .develop
+
+rmcache:
+ rm -rf tests/__pycache__
+
+
+test: flake .develop rmcache
+ py.test -q ./tests/
+
+vtest: flake .develop rmcache
+ py.test -s -v ./tests/
+
+cov cover coverage:
+ tox
+
+cov-dev: .develop rmcache
+ py.test --cov=multidict --cov-report=term --cov-report=html tests
+ @echo "open file://`pwd`/coverage/index.html"
+
+cov-dev-full: .develop rmcache
+ AIOHTTPMULTIDICT_NO_EXTENSIONS=1 py.test --cov=multidict --cov-append tests
+ py.test --cov=multidict --cov-report=term --cov-report=html tests
+ @echo "open file://`pwd`/coverage/index.html"
+
+clean:
+ rm -rf `find . -name __pycache__`
+ rm -f `find . -type f -name '*.py[co]' `
+ rm -f `find . -type f -name '*~' `
+ rm -f `find . -type f -name '.*~' `
+ rm -f `find . -type f -name '@*' `
+ rm -f `find . -type f -name '#*#' `
+ rm -f `find . -type f -name '*.orig' `
+ rm -f `find . -type f -name '*.rej' `
+ rm -f .coverage
+ rm -rf coverage
+ rm -rf build
+ rm -rf cover
+ make -C docs clean
+ python setup.py clean
+ rm -f multidict/_multidict.html
+ rm -f multidict/_multidict.c
+ rm -f multidict/_multidict.*.so
+ rm -f multidict/_multidict.*.pyd
+ rm -rf .tox
+
+doc:
+ make -C docs html
+ @echo "open file://`pwd`/docs/_build/html/index.html"
+
+doc-spelling:
+ make -C docs spelling
+
+install:
+ pip install -U pip
+ pip install -Ur requirements-dev.txt
+
+wheel_x64:
+ docker pull quay.io/pypa/manylinux1_x86_64
+ docker run --rm -v `pwd`:/io quay.io/pypa/manylinux1_x86_64 /io/build-wheels.sh
+
+.PHONY: all build venv flake test vtest testloop cov clean doc
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..bf69433
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,101 @@
+Metadata-Version: 1.1
+Name: multidict
+Version: 1.2.1
+Summary: multidict implementation
+Home-page: https://github.com/aio-libs/multidict/
+Author: Andrew Svetlov
+Author-email: andrew.svetlov at gmail.com
+License: Apache 2
+Description: =========
+ 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 ``dict`` but it can have
+ several *values* for the same *key*.
+
+ ``multidict`` has four multidict classes:
+ ``MultiDict``, ``MultiDictProxy``, ``CIMultiDict``
+ and ``CIMultiDictProxy``.
+
+ Immutable proxies (``MultiDictProxy`` and
+ ``CIMultiDictProxy``) provide a dynamic view on the
+ proxied multidict, the view reflects underlying collection changes. They
+ implement the ``collections.abc.Mapping`` interface.
+
+ Regular mutable (``MultiDict`` and ``CIMultiDict``) classes
+ implement ``collections.abc.MutableMapping`` and allows to change
+ their own content.
+
+
+ *Case insensitive* (``CIMultiDict`` and
+ ``CIMultiDictProxy``) ones assumes the *keys* are case
+ insensitive, e.g.::
+
+ >>> dct = CIMultiDict(a='val')
+ >>> 'A' in dct
+ True
+ >>> dct['A']
+ 'val'
+
+ *Keys* should be ``str`` instances.
+
+ The library has optional Cython optimization for sake of speed.
+
+
+ License
+ -------
+
+ Apache 2
+
+ 1.2.1 (2016-07-21)
+ ------------------
+
+ * Don't expose `multidict.__version__`
+
+
+ 1.2.0 (2016-07-16)
+ ------------------
+
+ * Make `upstr(upstr('abc'))` much faster
+
+
+ 1.1.0 (2016-07-06)
+ ------------------
+
+ * Don't double-iterate during MultiDict initialization #3
+
+ * Fix CIMultiDict.pop: it is case insensitive now #1
+
+ * Provide manylinux wheels as well as Windows ones
+
+ 1.0.3 (2016-03-24)
+ ------------------
+
+ * Add missing MANIFEST.in
+
+ 1.0.2 (2016-03-24)
+ ------------------
+
+ * Fix setup build
+
+
+ 1.0.0 (2016-02-19)
+ ------------------
+
+ * Initial implementation
+Platform: UNKNOWN
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ed98553
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,49 @@
+=========
+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 ``dict`` but it can have
+several *values* for the same *key*.
+
+``multidict`` has four multidict classes:
+``MultiDict``, ``MultiDictProxy``, ``CIMultiDict``
+and ``CIMultiDictProxy``.
+
+Immutable proxies (``MultiDictProxy`` and
+``CIMultiDictProxy``) provide a dynamic view on the
+proxied multidict, the view reflects underlying collection changes. They
+implement the ``collections.abc.Mapping`` interface.
+
+Regular mutable (``MultiDict`` and ``CIMultiDict``) classes
+implement ``collections.abc.MutableMapping`` and allows to change
+their own content.
+
+
+*Case insensitive* (``CIMultiDict`` and
+``CIMultiDictProxy``) ones assumes the *keys* are case
+insensitive, e.g.::
+
+ >>> dct = CIMultiDict(a='val')
+ >>> 'A' in dct
+ True
+ >>> dct['A']
+ 'val'
+
+*Keys* should be ``str`` instances.
+
+The library has optional Cython optimization for sake of speed.
+
+
+License
+-------
+
+Apache 2
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..3837ff3
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,182 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/aiohttp.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/aiohttp.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/aiohttp"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/aiohttp"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+spelling:
+ $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+ @echo
+ @echo "Build finished."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..6cea8ba
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,315 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# multidict documentation build configuration file, created by
+# sphinx-quickstart on Wed Mar 5 12:35:35 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import codecs
+import re
+
+_docs_path = os.path.dirname(__file__)
+_version_path = os.path.abspath(os.path.join(_docs_path,
+ '..', 'multidict', '__init__.py'))
+with codecs.open(_version_path, 'r', 'latin1') as fp:
+ try:
+ _version_info = re.search(r"^__version__ = '"
+ r"(?P<major>\d+)"
+ r"\.(?P<minor>\d+)"
+ r"\.(?P<patch>\d+)"
+ r"(?P<tag>.*)?'$",
+ fp.read(), re.M).groupdict()
+ except IndexError:
+ raise RuntimeError('Unable to determine version.')
+
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('.'))
+
+import alabaster
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.intersphinx',
+ 'alabaster',
+]
+
+
+try:
+ import sphinxcontrib.spelling
+ extensions.append('sphinxcontrib.spelling')
+except ImportError:
+ pass
+
+intersphinx_mapping = {
+ 'python': ('http://docs.python.org/3', None)}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'multidict'
+copyright = '2016, Andrew Svetlov'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '{major}.{minor}'.format(**_version_info)
+# The full version, including alpha/beta/rc tags.
+release = '{major}.{minor}.{patch}-{tag}'.format(**_version_info)
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# The default language to highlight source code in.
+highlight_language = 'python'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+ # 'logo': 'aiohttp-icon-128x128.png',
+ 'description': 'multidict',
+ 'github_user': 'aio-libs',
+ 'github_repo': 'multidict',
+ 'github_button': True,
+ 'github_banner': True,
+ 'travis_button': True,
+ 'pre_bg': '#FFF6E5',
+ 'note_bg': '#E5ECD1',
+ 'note_border': '#BFCF8C',
+ 'body_text': '#482C0A',
+ 'sidebar_text': '#49443E',
+ 'sidebar_header': '#4B4032',
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [alabaster.get_path()]
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = 'aiohttp-icon.svg'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = 'aiohttp-icon.ico'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+ '**': [
+ 'about.html', 'navigation.html', 'searchbox.html',
+ ]
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'multidictdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ # 'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ ('index', 'multidict.tex', 'multidict Documentation',
+ 'Andrew Svetlov', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'multidict', 'multidict Documentation',
+ ['Andrew Svetlov'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'multidict', 'multidict Documentation',
+ 'Andrew Svetlov', 'multidict', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..2ea0e10
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,102 @@
+.. aiohttp documentation master file, created by
+ sphinx-quickstart on Wed Mar 5 12:35:35 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+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 :class:`dict` but it can have
+several *values* for the same *key*.
+
+:mod:`multidict` has four multidict classes:
+:class:`MultiDict`, :class:`MultiDictProxy`, :class:`CIMultiDict`
+and :class:`CIMultiDictProxy`.
+
+Immutable proxies (:class:`MultiDictProxy` and
+:class:`CIMultiDictProxy`) provide a dynamic view on the
+proxied multidict, the view reflects underlying collection changes. They
+implement the :class:`~collections.abc.Mapping` interface.
+
+Regular mutable (:class:`MultiDict` and :class:`CIMultiDict`) classes
+implement :class:`~collections.abc.MutableMapping` and allows to change
+their own content.
+
+
+*Case insensitive* (:class:`CIMultiDict` and
+:class:`CIMultiDictProxy`) ones assumes the *keys* are case
+insensitive, e.g.::
+
+ >>> dct = CIMultiDict(a='val')
+ >>> 'A' in dct
+ True
+ >>> dct['A']
+ 'val'
+
+*Keys* should be a :class:`str`.
+
+The library has optional Cython optimization for sake of speed.
+
+Library Installation
+--------------------
+
+::
+
+ $ pip install multidict
+
+The library is Python 3 only!
+
+
+Source code
+-----------
+
+The project is hosted on GitHub_
+
+Please feel free to file an issue on the `bug tracker
+<https://github.com/aio-libs/multidict/issues>`_ if you have found a bug
+or have some suggestion in order to improve the library.
+
+The library uses `Travis <https://travis-ci.org/aio-libs/multidict>`_ for
+Continuous Integration.
+
+Discussion list
+---------------
+
+*aio-libs* google group: https://groups.google.com/forum/#!forum/aio-libs
+
+Feel free to post your questions and ideas here.
+
+
+Authors and License
+-------------------
+
+The ``multidict`` package is written by Andrew Svetlov.
+
+It's *Apache 2* licensed and freely available.
+
+Feel free to improve this package and send a pull request to GitHub_.
+
+Contents
+--------
+
+.. toctree::
+
+ multidict
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. _GitHub: https://github.com/aio-libs/multidict
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..9a36c43
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,242 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. xml to make Docutils-native XML files
+ echo. pseudoxml to make pseudoxml-XML files for display purposes
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
... 20109 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-multidict.git
More information about the Python-modules-commits
mailing list