Commits

Lynn Rees  committed bc05f4e

- sphinx

  • Participants
  • Parent commits 5a9d0f9
  • Branches pu

Comments (0)

Files changed (10)

File docs/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# 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 "  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 "  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/wire.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/wire.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/wire"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/wire"
+	@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."
+
+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."

File docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# wire documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 20 02:05:50 2012.
+#
+# 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, 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.coverage', 'sphinx.ext.viewcode']
+
+# 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 = u'wire'
+copyright = u'2012, L. C. Rees'
+
+# 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.1'
+# The full version, including alpha/beta/rc tags.
+release = '1'
+
+# 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 = []
+
+
+# -- 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']
+
+# 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 = 'wiredoc'
+
+
+# -- 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]).
+latex_documents = [
+  ('index', 'wire.tex', u'wire Documentation',
+   u'L. C. Rees', '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', 'wire', u'wire Documentation',
+     [u'L. C. Rees'], 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', 'wire', u'wire Documentation',
+   u'L. C. Rees', 'wire', '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'

File docs/index.rst

+.. wire documentation master file, created by
+   sphinx-quickstart on Tue Mar 20 02:05:50 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to wire's documentation!
+================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

File wire/http/agents/agent.py

 from stuf.six.moves import StringIO  # @UnresolvedImport
 from callchain import ResetTypeMixin
 
-from wire.http.util import statuscode
-from wire.support import base64_decode
+from wire.support import brh, base64_decode
 
 
 class Agent(ResetTypeMixin):
         super(Agent, self).__init__()
         self._request = request
 
+    @staticmethod
+    def _message(code):
+        '''
+        Returns a response message.
+
+        @param code: HTTP response (integer)
+        '''
+        return brh[code][1]
+
+    @staticmethod
+    def _statuscode(code):
+        '''
+        return response status code
+
+        @param code: HTTP response code (integer)
+        '''
+        return '{0} {1}'.format(code, brh[code][0])
+
     def code(self):
         '''
         HTTP response code
 
     def status(self):
         '''status of HTTP response'''
-        return statuscode(self.code)
+        return self.statuscode(self.code)
 
     def data(self):
         '''data, serialized if supported, original if not'''

File wire/http/client.py

 # -*- coding: utf-8 -*-
-'''wire HTTP request client'''
+'''wire HTTP client'''
 
 from functools import partial
 
         self.args(self.incoming).invoke('data').invoke('content_md5')
         return self.swap().commit().switch(self.G.responses, self.G.userspace)
 
-    _hpack = _pack
+    _h_pack = _pack
 
     def __call__(self, *urls, **config):
         '''
         redirects = self._redirects
         # verify certs
         verify = self._verify
-        # call chain
         _chain = self._cchain
-        # user agent (whatever)
         useragent = self._h_useragent
         # process url arguments
         self._chain.extend(_chain(Request(

File wire/http/header.py

 '''wire HTTP header management'''
 
 import re
+import time
 from random import choice
 from itertools import chain
 from datetime import datetime
 from email.header import Header
 
 from callchain import ResetLocalMixin
+from wire.support import parsedate_tz, _formatdate
 from twoq.support import isstring, isunicode, items
 from stuf.utils import OrderedDict, lazy_class, exhaustmap
 
 from wire.support import n2b
 
-from wire.http.util import datehttp, httpdate
-
 n = n2b
 
 
     ## header manipulation ####################################################
     ###########################################################################
 
+    @staticmethod
+    def date2http(date=None):
+        '''
+        get HTTP preferred date either by passing datetime object or getting
+        current time
+
+        @param date: datetime object (default: None)
+        '''
+        if isinstance(date, datetime):
+            # Put datetime object in UNIX time
+            date = time.mktime(date.timetuple()) + 1e-6 * date.microsecond
+        return _formatdate(date)
+
     def _value(self, key, value):
         '''
         properly format for HTTP header `value`
         key = self._key(key)
         # join with any existing value if header allows multiple values
         if key in self._DATES and isinstance(value, datetime):
-            value = httpdate(value)
+            value = self.date2http(value)
         return key, n(value)
 
     _hvalue = _value
                     value = newval
             # Reformat HTTP dates as datetime objects
             elif key in cls.DATES:
-                value = datehttp(value)
+                value = cls.http2date(value)
         return value
 
     @lazy_class
         '''Python name -> header name mapping'''
         return dict((self._checkname(h), h) for h in self.RES_HEADERS)
 
+    @staticmethod
+    def http2date(value):
+        '''
+        Parses a HTTP date into a datetime object.
+
+        @param value: HTTP date
+        '''
+        return datetime(*parsedate_tz(value)[:6])
+
     def header(self, key):
         '''
         Return an item associated with a key or a default value

File wire/http/httplet.py

+# -*- coding: utf-8 -*-
+'''wire httplet'''
+
+from callchain.chain import ChainletQ
+from twoq.lazy.mixins import AutoQMixin
+
+
+class httplet(ChainletQ, AutoQMixin):
+
+    def __init__(self, root):
+        '''
+        init
+
+        @param root: root object
+        '''
+        super(httplet, self).__init__(root)
+        self._cookies = root._cookies
+        self._headers = root._headers
+        self._params = root._params

File wire/http/mixins.py

-# -*- coding: utf-8 -*-
-'''wire httplet'''
-
-from callchain import chainlink
-
-from wire.datalet import datalet
-
-
-class httplet(datalet):
-
-    def __init__(self, root):
-        '''
-        init
-
-        @param root: root object
-        '''
-        super(httplet, self).__init__(root)
-        self._cookies = root._cookies
-        self._headers = root._headers
-        self._files = root._files
-
-
-class httplink(chainlink):
-
-    def __init__(self, root):
-        '''
-        init
-
-        @param root: root object
-        '''
-        super(httplink, self).__init__(root)
-        self._cookies = root._cookies
-        self._data.extend(root._data)
-        self._headers = root._headers
-        self._params = root._params
-        self._files = root._files

File wire/http/request.py

 
 from wire.support import n2b, n2u
 
-from wire.http.mixins import httplet
+from wire.http.httplet import httplet
 from wire.http.keys.request import KRequestData, KRequestHeaders
 
 

File wire/http/util.py

-'''wire HTTP utils'''
-
-import time
-from datetime import datetime
-
-from wire.support import parsedate_tz, _formatdate, brh
-
-
-def datehttp(value):
-    '''
-    Parses a HTTP date into a datetime object.
-
-    @param value: HTTP date
-    '''
-    return datetime(*parsedate_tz(value)[:6])
-
-
-def httpdate(date=None):
-    '''
-    Get HTTP preferred date either by passing datetime object or getting
-    current time
-
-    @param date: datetime object (default: None)
-    '''
-    if isinstance(date, datetime):
-        # Put datetime object in UNIX time
-        date = time.mktime(date.timetuple()) + 1e-6 * date.microsecond
-    return _formatdate(date)
-
-
-def message(code):
-    '''
-    Returns a response message.
-
-    @param code: HTTP response (integer)
-    '''
-    return brh[code][1]
-
-
-def statuscode(code):
-    '''
-    return response status code
-
-    @param code: HTTP response code (integer)
-    '''
-    return '{0} {1}'.format(code, brh[code][0])