Commits

Jonathan Eunice committed c9e69aa

Updating for Sphinx docs.

Comments (0)

Files changed (8)

+.hg*
+build/
+dist/
+docs/_build/
+*.egg-info
 syntax: glob
-.git*
+.git/
 *.swp.{py,txt,html,css,js}
 *.pyc
 .DS_Store
+docs/_build
 build/*
 dist/*
 *.egg-info
 .. image:: https://travis-ci.org/jonathaneunice/simplere.png?branch=master
-        :target: https://travis-ci.org/jonathaneunice/simplere
+    :target: https://travis-ci.org/jonathaneunice/simplere
 
-        .. image:: https://pypip.in/d/simplere/badge.png
-        :target: https://crate.io/packages/simplere/
+.. image:: https://pypip.in/d/simplere/badge.png
+    :target: https://crate.io/packages/simplere/
 
 A simplified interface to Python's regular expression (``re``)
 string search that tries to eliminate steps and provide
     if match / re.search(pattern, some_string):
         print match[1]
 
-Or with an object-orented style:
+Or with an object-orented style::
 
     if some_string in Re(pattern):
         print Re._[1]
+# 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/simplere.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/simplere.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/simplere"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/simplere"
+	@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."
+.. image:: https://travis-ci.org/jonathaneunice/simplere.png?branch=master
+    :target: https://travis-ci.org/jonathaneunice/simplere
+
+.. image:: https://pypip.in/d/simplere/badge.png
+    :target: https://crate.io/packages/simplere/
+
+A simplified interface to Python's regular expression (``re``)
+string search that tries to eliminate steps and provide
+simpler access to results. As a bonus, also provides compatible way to
+access Unix glob searches.
+
+Usage
+=====
+
+Python regular expressions are powerful, but the language's lack
+of an *en passant* (in passing) assignment requires a preparatory
+motion and then a test::
+
+    import re
+    
+    match = re.search(pattern, some_string)
+    if match:
+        print match.group(1)
+
+With ``simplere``, you can do it in fewer steps::
+
+    from simplere import *
+
+    if match / re.search(pattern, some_string):
+        print match[1]
+
+Or with an object-orented style::
+
+    if some_string in Re(pattern):
+        print Re._[1]
+
+
+Re Objects
+==========
+
+``Re`` objects are `memoized
+<http://en.wikipedia.org/wiki/Memoization>`_ for efficiency, so they compile their
+pattern just once, regardless of how many times they're mentioned in a
+program.
+
+Note that the ``in`` test turns the sense of the matching around (compared to
+the standard ``re`` module). It asks "is the given string *in*
+the set of items this pattern describes?" To be fancy, the
+``Re`` pattern is an intensionally
+defined set (namely "all strings matching the pattern"). This order often makes
+excellent sense whey you have a clear intent for the test. For example, "is the
+given string within the set of *all legitimate commands*?"
+
+Second, the ``in`` test had the side effect of setting the underscore
+name ``_`` to the result. Python doesn't support *en passant* assignment--apparently,
+no matter how hard you try, or how much introspection you use. This makes it
+harder to both test and collect results in the same motion, even though that's
+often exactly appropriate. Collecting them in a class variable is a fallback
+strategy (see the *En Passant* section below for a slicker one).
+
+If you prefer the more traditional ``re`` calls::
+
+    if Re(pattern).search(some_string):
+        print Re._[1]
+
+``Re`` works even better with named pattern components, which are exposed
+as attributes of the returned object::
+
+    person = 'John Smith 48'
+    if person in Re(r'(?P<name>[\w\s]*)\s+(?P<age>\d+)'):
+        print Re._.name, "is", Re._.age, "years old"
+    else:
+        print "don't understand '{}'".format(person)
+        
+One trick being used here is that the returned object is not a pure
+``_sre.SRE_Match`` that Python's ``re`` module returns. Nor is it a subclass.
+(That class `appears to be unsubclassable
+<http://stackoverflow.com/questions/4835352/subclassing-matchobject-in-python>`_.)
+Thus, regular expression matches return a proxy object that
+exposes the match object's numeric (positional) and
+named groups through indices and attributes. If a named group has the same
+name as a match object method or property, it takes precedence. Either
+change the name of the match group or access the underlying property thus:
+``x._match.property``
+        
+It's possible also to loop over the results::
+
+    for found in Re('pattern (\w+)').finditer('pattern is as pattern does'):
+        print found[1]
+        
+Or collect them all in one fell swoop::
+
+    found = Re('pattern (\w+)').findall('pattern is as pattern does')
+    
+Pretty much all of the methods and properties one can access from the standard
+``re`` module are available.
+
+Bonus: Globs
+============
+
+Regular expressions are wonderfuly powerful, but sometimes the simpler `Unix glob
+<http://en.wikipedia.org/wiki/Glob_(programming)>`_ is works just fine. As a bonus,
+``simplere`` also provides simple glob access.::
+
+    if 'globtastic' in Glob('glob*'):
+        print "Yes! It is!"
+    else:
+        raise ValueError('YES IT IS')
+
+En Passant
+==========
+
+If you have existing code that already uses ``re`` regular expressions
+and you want to ease into using ``simplere``, ``ReMatch`` objects can
+simply wrap Python's native``_sre.SRE_Match`` objects (the things that ``re``
+method calls return).::
+
+    match = re.match(r'(?P<word>th.s)', 'this is a string')
+    match = ReMatch(match)
+    if match:
+        print match.group(1)    # still works
+        print match[1]          # same thing
+        print match.word        # same thing, with logical name
+        
+But that's a huge amount of boiler plate for a simple test, right? So ``simplere``
+also uses an *en passant* trick of redefining the division operation::
+    
+    if match / re.search(r'(?P<word>th.s)', 'this is a string'):
+        assert match[1] == 'this'
+        assert match.word == 'this'
+        assert match.group(1) == 'this'
+
+This uses the pre-delcared ``match`` object and the division operator (``/``)
+to quickly funnel
+the result of the search. 
+If the ``re`` operation fails, the resulting object is guaranteed to have
+a ``False``-like boolean value, so that it will fall through conditional tests. 
+
+If you prefer the look of the less-than (``<``) or less-than-or-equal (``<=``),
+as indicators that ``match`` takes the value of the following function call, they
+are supported as aliases of the division operation (``/``). You may define your
+own match objects, and can use them on memoized ``Re`` objects too. Putting
+a few of these optional things together::
+
+    answer = Match()   # need to do this just once
+    
+    if answer < Re(r'(?P<word>th..)').search('and that goes there'):
+        assert answer.word == 'that'
+
+Notes
+=====
+   
+ *  Automated multi-version testing is managed with the wonderful
+    `pytest <http://pypi.python.org/pypi/pytest>`_
+    and `tox <http://pypi.python.org/pypi/tox>`_. ``simplere`` is
+    successfully packaged for, and tested against, all late-model verions of
+    Python: 2.6, 2.7, 3.2, and 3.3, as well as PyPy 1.9 (based on 2.7.2).
+ 
+ *  ``simplere`` is one part of a larger effort to add intensional sets
+    to Python. The `intensional <http://pypi.python.org/pypi/intensional>`_
+    package contains a parallel implementation of ``Re``, among many other
+    things.
+ 
+ *  The author, `Jonathan Eunice <mailto:jonathan.eunice@gmail.com>`_ or
+    `@jeunice on Twitter <http://twitter.com/jeunice>`_
+    welcomes your comments and suggestions.
+
+Installation
+============
+
+To install the latest version::
+
+    pip install -U simplere
+
+To ``easy_install`` under a specific Python version (3.3 in this example)::
+
+    python3.3 -m easy_install --upgrade simplere
+    
+(You may need to prefix these with "sudo " to authorize installation.)
+# -*- coding: utf-8 -*-
+#
+# simplere documentation build configuration file, created by
+# sphinx-quickstart on Fri Sep 13 13:54:51 2013.
+#
+# 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']
+
+# 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'simplere'
+copyright = u'2013, Jonathan Eunice'
+
+# 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0.4'
+
+# 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 = 'simpleredoc'
+
+
+# -- 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', 'simplere.tex', u'simplere Documentation',
+   u'Jonathan Eunice', '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', 'simplere', u'simplere Documentation',
+     [u'Jonathan Eunice'], 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', 'simplere', u'simplere Documentation',
+   u'Jonathan Eunice', 'simplere', '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'
+.. simplere documentation master file, created by
+   sphinx-quickstart on Fri Sep 13 13:54:51 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to simplere's documentation!
+====================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+
+   README
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
 
 setup(
     name='simplere',
-    version='1.0.2',
+    version='1.0.4',
     author='Jonathan Eunice',
     author_email='jonathan.eunice@gmail.com',
     description='Simpler, cleaner access to regular expressions. Globs too.',
     install_requires=['mementos'],
     tests_require = ['tox', 'pytest'],
     zip_safe = False,  # actually it is, but this apparently avoids setuptools hacks
-    keywords='re regex regular expression glob',
+    keywords='re regex regexp regular expression glob simple',
     classifiers=linelist("""
         Development Status :: 4 - Beta
         Operating System :: OS Independent