Andy Mikhailenko avatar Andy Mikhailenko committed 9c7ff40

Added initial documentation draft. The real code in not here yet.

Comments (0)

Files changed (8)

+^build/
+^dist/
+^docs/_build
+^nbproject/
+\.egg-info
+\.directory
+\.pyc$
+\.pyo$
+~$
+\.swo$
+\.swp$
+^\.coverage
+^cover/
+,cover$
+Agrh, argparse!
+===============
+
+Did you ever say "argh" trying to remember the details of optparse or argparse
+API? If yes, this package may be useful for you. It provides a very simple
+wrapper for argparse with support for hierarchical commands that can be bound
+to modules or classes. Argparse can do it; argh makes it easy.
+
+Installation
+------------
+
+    $  pip install argh
+
+Documentation
+-------------
+
+See the `complete documentation`_ for details. If it's not complete enough,
+feel free to ask your questions or submit bugs.
+
+.. _complete documentation: http://packages.python.org/argh
+
+Author
+------
+
+Originally written by Andrey Mikhaylenko in 2010.
+
+See the file AUTHORS for a complete authors list of this application.
+
+Please feel free to submit patches, report bugs or request features:
+
+    http://bitbucket.org/neithere/argh/issues/
+
+Licensing
+---------
+
+Argh is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Argh is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Argh.  If not, see <http://gnu.org/licenses/>.
+# -*- coding: utf-8 -*-
+"""
+Agrh, argparse!
+===============
+
+Did you ever say "argh" trying to remember the details of optparse or argparse
+API? If yes, this package may be useful for you. It provides a very simple
+wrapper for argparse with support for hierarchical commands that can be bound
+to modules or classes. Argparse can do it; argh makes it easy.
+
+Usage
+-----
+
+Here's an example::
+
+    from argh import arg, dispatch
+
+    # define a couple of non-web commands
+
+    def shell(args):
+        "Runs the interactive shell."    # <- the command documentation
+        run_the_interactive_shell(...)
+
+    @arg('file', description='fixture to load')  # <- a command argument
+    def load(args):
+        "Loads a JSON fixture from given file."
+        print json.load(args.file)
+
+    # define a pair of web server commands with a handful of arguments
+
+    @arg('host', default='127.0.0.1', description='The host')
+    @arg('port', default=6060, description='The port')
+    @arg('noreload', default=False, description='Do not use autoreloader')
+    def serve(args):
+        "Runs a simple webserver."
+        do_something(host=args.host, ...)
+
+    def serve_rest(args):
+        "Run some REST service... whatever."
+        do_something()
+
+    # instantiate an ArgumentParser for the web-related commands
+    # so they are grouped; this parser is standalone and can be used right away
+
+    web_commands = make_parser(serve)
+
+    # now assemble all the commands — web-related and miscellaneous — within a
+    # single argument parser
+
+    parser = make_parser(shell, load, web=web_commands)
+
+    if __name__=='__main__':
+        dispatch(parser)
+
+The example above defines four commands: `shell`, `load`, `serve` and `rest`.
+Note how they are assembled together in the last :func:`make_parser` call: two
+commands as arguments and two as a keyword argument `web`. This is the
+resulting command-line interface:
+
+    * ``shell``
+    * ``load prancing_ponies.json``
+    * ``web serve_rest``
+    * ``web serve -p 6060 --noreload``
+
+See what's happening here?
+
+The statement ``make_parser(bar, quux)`` builds an ArgumentParser with two
+commands: `bar` and `quux`.
+
+The statement ``make_parser(foo=make_parser(bar, quux))`` produces a command
+hierarchy for the command-line expressions ``foo bar`` and ``foo quux``. It is
+roughly equivalent to this generic argparse code::
+
+    import sys
+    from argparse import ArgumentParser
+
+    def bar(args):
+        return 'I am foobar!'
+
+    p = argparse.ArgumentParser()
+    subparsers = p.add_subparsers()
+    foo_parser = subparsers.add_parser('foo')
+    foo_subparsers = foo_parser.add_subparsers()
+    foo_bar_parser = foo_subparsers.add_parser('bar')
+    foo_bar_parser.set_defaults(function=bar)
+    args = p.parse_args(sys.argv[1:])
+    print args.function(args)
+
+The `help` command is always added automatically and displays the docstring:
+
+    * ``help shell``
+    * ``help web serve``
+
+API
+---
+"""
+__all__ = ['arg', 'make_parser']
+__version__ = '0.1.0'
+
+from functools import wraps
+import argparse
+
+
+def arg(func):
+    """Declares an argument for given function. Does not register the function
+    anywhere, not does it modify the function in any way.
+    """
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        func.argh_args = getattr(func, 'argh_args', [])
+        func.argh_args.append((args, kwargs))
+        return func
+    return wrapper
+
+def make_parser(*commands, **subcommands):
+    """Returns an ArgumentParser instance that can handle given commands and
+    subcommands.
+
+    :param commands:
+        A list of functions. Each function *must* accept only one argument: the
+        Namespace instance as returned by ArgumentParser. Any extra arguments
+        must be defined by wrapping the function into :func:`arg`. The function
+        names will be translated to command names.
+    :param subcommands:
+        A dictionary where names are
+
+    Usage::
+
+        def foo(args):
+            print 'I am foo'
+        def bar(args): pass
+            print 'I am bar'
+        top_level_cmds = foo, bar
+        def quux(args): pass
+            print 'I am baz/quux'
+        # register commands: "foo", "bar", "baz quux"
+        p = make_parser(*top_level_cmds, baz=quux)
+        p.parse_args(sys.argv[1:])
+
+    """
+    raise NotImplementedError
+
+def dispatch(args):
+    raise NotImplementedError
+
+if __name__=='__main__':
+    import sys
+    p = argparse.ArgumentParser()
+    subparsers = p.add_subparsers()
+    foo_parser = subparsers.add_parser('foo')
+    foo_subparsers = foo_parser.add_subparsers()
+    foo_bar_parser = foo_subparsers.add_parser('bar')
+    def bar(args):
+        return 'I am foobar!'
+    foo_bar_parser.set_defaults(function=bar)
+    args = p.parse_args(sys.argv[1:])
+    print args.function(args)
+# 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) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp epub latex changes linkcheck doctest
+
+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 "  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/argh.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/argh.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/argh"
+	@echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/argh"
+	@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 all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+latexpdf: latex
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C _build/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in _build/latex."
+
+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."
+# -*- coding: utf-8 -*-
+#
+# argh documentation build configuration file, created by
+# sphinx-quickstart on Tue Nov  9 23:06:31 2010.
+#
+# 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.append(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']
+
+# 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'argh'
+copyright = u'2010, Andrey Mikhaylenko'
+
+# 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 = '0.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.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+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_use_modindex = 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'arghdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'argh.tex', u'argh Documentation',
+   u'Andrey Mikhaylenko', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+#epub_title = ''
+#epub_author = ''
+#epub_publisher = ''
+#epub_copyright = ''
+
+# 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 = ''
+
+# 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 = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+.. argh documentation master file, created by
+   sphinx-quickstart on Tue Nov  9 23:06:31 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to argh's documentation!
+================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: argh
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+[upload_sphinx]
+upload-dir = build/sphinx/html
+[nosetests]
+with-coverage=1
+cover-html=1
+cover-package=args
+cover-erase=1
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+#    Argh is a simple argparse wrapper.
+#    Copyright © 2010  Andrey Mikhaylenko
+#
+#    This file is part of Argh.
+#
+#    Argh is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Lesser General Public License as published
+#    by the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    Argh is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Lesser General Public License for more details.
+#
+#    You should have received a copy of the GNU Lesser General Public License
+#    along with Argh.  If not, see <http://gnu.org/licenses/>.
+
+
+import os
+from setuptools import setup
+import argh
+
+
+version = argh.__version__
+readme = open(os.path.join(os.path.dirname(__file__), 'README')).read()
+
+setup(
+    # overview
+    name             = 'argh',
+    description      = 'A simple argparse wrapper.',
+    long_description = readme,
+
+    # technical info
+    version  = version,
+    packages = [],
+    requires = ['python (>= 2.6)', 'argparse (>=1.1)'],
+    provides = ['argh'],
+
+    # copyright
+    author   = 'Andrey Mikhaylenko',
+    author_email = 'andy@neithere.net',
+    license  = 'GNU Lesser General Public License (LGPL), Version 3',
+
+    # more info
+    url          = 'http://bitbucket.org/neithere/argh/',
+    download_url = 'http://bitbucket.org/neithere/argh/src/',
+
+    # categorization
+    keywords     = ('cli command line argparse optparse argument option'),
+    classifiers  = [
+        'Development Status :: 1 - Planning',
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)',
+        'Programming Language :: Python',
+        'Topic :: Software Development :: User Interfaces',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+
+    # release sanity check
+    test_suite = 'nose.collector',
+)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.