docs content

docs/conf.py

@@ -0,0 +1,332 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# wsgi_intercept documentation build configuration file, created by
+# sphinx-quickstart on Fri May 16 13:03:52 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
+
+# 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('.'))
+
+# -- 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.doctest',
+]
+
+# 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 = 'wsgi_intercept'
+copyright = '2014, Titus Brown, Kumar McMillan, Chris Dent'
+
+# 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 = '0.6.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.6.2'
+
+# 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'
+
+# 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 = 'default'
+
+# 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 = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_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 = None
+
+# 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 = None
+
+# 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 = {}
+
+# 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 = 'wsgi_interceptdoc'
+
+
+# -- 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', 'wsgi_intercept.tex', 'wsgi\\_intercept Documentation',
+   'Titus Brown, Kumar McMillan, Chris Dent', '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', 'wsgi_intercept', 'wsgi_intercept Documentation',
+     ['Titus Brown, Kumar McMillan, Chris Dent'], 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', 'wsgi_intercept', 'wsgi_intercept Documentation',
+   'Titus Brown, Kumar McMillan, Chris Dent', 'wsgi_intercept', '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
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = 'wsgi_intercept'
+epub_author = 'Titus Brown, Kumar McMillan, Chris Dent'
+epub_publisher = 'Titus Brown, Kumar McMillan, Chris Dent'
+epub_copyright = '2014, Titus Brown, Kumar McMillan, Chris Dent'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = 'wsgi_intercept'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True

docs/http_client.rst

@@ -0,0 +1,45 @@
+http_client_intercept
+=====================
+
+.. automodule:: wsgi_intercept.http_client_intercept
+
+.. warning::
+
+   This intercept will fail to install if you access access HTTPConnection or
+   HTTPSConnection before the intercept is installed. For example, do not use
+   "from http.client import HTTPConnection". Instead, "import http.client" and
+   reference http.client.HTTPConnection after the intercept is installed.
+
+Example:
+
+.. testcode:: 
+
+    try:
+        import http.client as http_lib
+    except ImportError:
+        import httplib as http_lib
+    from wsgi_intercept import (
+        http_client_intercept, add_wsgi_intercept, remove_wsgi_intercept
+    )
+
+
+    def app(environ, start_response):
+        start_response('200 OK', [('Content-Type', 'text/plain')])
+        return [b'Whee']
+
+
+    def make_app():
+        return app
+
+
+    host, port = 'localhost', 80
+    http_client_intercept.install()
+    add_wsgi_intercept(host, port, make_app)
+    HTTPConnection = http_lib.HTTPConnection
+    client = HTTPConnection(host)
+    client.request('GET', '/')
+    response = client.getresponse()
+    content = response.read()
+    assert content == b'Whee'
+    remove_wsgi_intercept(host, port)
+    http_client_intercept.uninstall()

docs/httplib2.rst

@@ -0,0 +1,30 @@
+httplib2_intercept
+==================
+
+.. automodule:: wsgi_intercept.httplib2_intercept
+
+Example:
+
+.. testcode:: 
+
+    import httplib2
+    from wsgi_intercept import httplib2_intercept, add_wsgi_intercept
+
+
+    def app(environ, start_response):
+        start_response('200 OK', [('Content-Type', 'text/plain')])
+        return [b'Whee']
+
+
+    def make_app():
+        return app
+
+
+    host, port = 'localhost', 80
+    url = 'http://{0}:{1}/'.format(host, port)
+    httplib2_intercept.install()
+    add_wsgi_intercept(host, port, make_app)
+    http = httplib2.Http()
+    resp, content = http.request(url)
+    assert content == b'Whee'
+    httplib2_intercept.uninstall()

docs/index.rst

@@ -1,8 +1,27 @@
-===============================================================================
+================================
-wsgi_intercept: installs a WSGI application in place of a real URI for testing.
+Documentation for wsgi_intercept
-===============================================================================
+================================
 
-.. contents::
+.. automodule:: wsgi_intercept
 
-.. include_docstring:: ./wsgi_intercept/__init__.py
+
+Examples
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   http_client
+   httplib2
+   requests
+   urllib
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
 

docs/requests.rst

@@ -0,0 +1,30 @@
+requests_intercept
+==================
+
+.. automodule:: wsgi_intercept.requests_intercept
+
+
+Example:
+
+.. testcode:: 
+
+    import requests
+    from wsgi_intercept import requests_intercept, add_wsgi_intercept
+
+
+    def app(environ, start_response):
+        start_response('200 OK', [('Content-Type', 'text/plain')])
+        return [b'Whee']
+
+
+    def make_app():
+        return app
+
+
+    host, port = 'localhost', 80
+    url = 'http://{0}:{1}/'.format(host, port)
+    requests_intercept.install()
+    add_wsgi_intercept(host, port, make_app)
+    resp = requests.get(url)
+    assert resp.content == b'Whee'
+    requests_intercept.uninstall()

docs/urllib.rst

@@ -0,0 +1,36 @@
+urllib_intercept
+================
+
+.. automodule:: wsgi_intercept.urllib_intercept
+
+
+Example:
+
+.. testcode:: 
+
+    try:
+        from urllib.request import urlopen
+    except ImportError:
+        from urllib2 import urlopen
+    from wsgi_intercept import (
+        urllib_intercept, add_wsgi_intercept, remove_wsgi_intercept
+    )
+
+
+    def app(environ, start_response):
+        start_response('200 OK', [('Content-Type', 'text/plain')])
+        return [b'Whee']
+
+
+    def make_app():
+        return app
+
+
+    host, port = 'localhost', 80
+    url = 'http://{0}:{1}/'.format(host, port)
+    urllib_intercept.install_opener()
+    add_wsgi_intercept(host, port, make_app)
+    stream = urlopen(url)
+    content = stream.read()
+    assert content == b'Whee'
+    remove_wsgi_intercept()