Initial, functioning code

Author: dbarnett

Diff for: .gitignore

@@ -0,0 +1,4 @@
+/MANIFEST
+/build
+/dist
+*.pyc

Diff for: README

@@ -0,0 +1,69 @@
+selfcompletion
+==============
+
+selfcompletion is a layer on top of argparse to take the fine-grained model
+argparse builds of the arguments your program accepts and automatically
+generate an extra '--_completion' argument that generates all possible
+completions given a partial command line as a string.
+
+The '--_completion' argument in turn is used by a generic bash programmable
+completion script that tries '--_completion' on any program that doesn't have
+its own completion already available, renders the output of the program's
+built-in completion if available, and otherwise silently falls back to the
+shell default.
+
+About
+-----
+
+* Author:       David Barnett <[email protected]>
+* Home:         http://github.com/dbarnett/cyberpyg
+* License:      BSD
+
+How to Use
+----------
+prog.py:
+    #!/usr/bin/env python
+    try:
+        from selfcompletion import SelfCompletingArgumentParser as ArgumentParser
+    except ImportError, e:
+        from argparse import ArgumentParser
+
+    parser = ArgumentParser(description='Process some integers.')
+    parser.add_argument('integers', metavar='N', type=int, nargs='+',
+                       help='an integer for the accumulator')
+    parser.add_argument('--sum', dest='accumulate', action='store_const',
+                       const=sum, default=max,
+                       help='sum the integers (default: find the max)')
+
+    args = parser.parse_args()
+    print(args.accumulate(args.integers))
+
+$ chmod +x prog.py
+$ ./prog.py <TAB><TAB>
+0        2        4        6        8        -h       --sum
+1        3        5        7        9        --help
+$ ./prog.py -<TAB><TAB>
+-h       --help   --sum
+$ ./prog.py 1<TAB><TAB>
+0  1  2  3  4  5  6  7  8  9
+
+Why?
+----
+Command-line completion is very, very cool, and along with good built-in help,
+can make even the most complex program usable. Unfortunately, it's a pain to
+implement. It requires an entirely separate shell script *per shell syntax*
+to support (e.g., bash, zsh, fish), it's a challenge for maintainers to
+distribute, and it must be kept in sync with changes in the program itself or
+else it becomes less useful or even gets in the way.
+
+selfcompletion is an attempt to create a standard, and reduce a matrix of
+supported shell/application combinations to a list of supported shells and a
+list of compliant programs. Now all python software using argparse can add
+fine-grained command-line completion essentially for free!
+
+Installing
+----------
+selfcompletion uses distutils2. To install, run
+    pysetup install
+or
+    python -m distutils2.run install

Diff for: bash_completion.d/_selfcompletion

@@ -0,0 +1,19 @@
+# -*- mode: shell-script; sh-basic-offset: 8; indent-tabs-mode: t -*-
+# ex: ts=8 sw=8 noet filetype=sh
+#
+
+_foo()
+{
+    prog="$1"
+    which "$prog" >/dev/null
+    if test $? -eq 0; then
+        COMP_STR="${COMP_WORDS[*]}"
+        _ORIG_IFS="$IFS"
+        IFS="
+"
+        COMPREPLY=( $( $prog --_completion $COMP_STR 2>/dev/null) )
+        IFS="$_ORIG_IFS"
+    fi
+}
+
+complete -o default -o nospace -D -F _foo

Diff for: selfcompletion/__init__.py

@@ -0,0 +1,26 @@
+import argparse
+import re
+
+class SelfCompletingArgumentParser(argparse.ArgumentParser):
+    def __init__(self, *args, **kw):
+        argparse.ArgumentParser.__init__(self, *args, **kw)
+        self._completion_parser = argparse.ArgumentParser()
+        self._completion_parser.add_argument('--_completion', type=str)
+
+    def parse_args(self, *args, **kw):
+        comp_args = self._completion_parser.parse_args(*args, **kw)
+        if comp_args._completion is not None:
+            comp_words = re.split(r'\s+', comp_args._completion)
+            comp_word = comp_words[-1]
+            all_options = sum((a.option_strings for a in self._actions), [])
+            types = [a.type for a in self._actions if a.nargs != 0 and a.type is not None]
+            for opt in all_options:
+                if opt.startswith(comp_word):
+                    print opt+' '
+            if int in types and re.match(r'^\d*$', comp_word):
+                for i in xrange(10):
+                    print i
+
+            self.exit(0)
+        else:
+            return argparse.ArgumentParser.parse_args(self, *args, **kw)

Diff for: setup.cfg

@@ -0,0 +1,21 @@
+[metadata]
+name = selfcompletion
+version = 0.0.1
+author = David Barnett
+author_email = [email protected]
+summary = Automatically-generated command completion built on argparse
+description-file = README
+home_page = http://github.com/dbarnett/python-selfcompletion
+
+classifier = License :: OSI Approved :: BSD License
+    Development Status :: 2 - Pre-Alpha
+
+requires-dist = argparse; python_version < '2.7'
+
+[files]
+
+packages = selfcompletion
+extra_files =
+
+resources =
+