← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shellcomplete.py

  • Committer: John Arbash Meinel
  • Date: 2010-01-13 16:23:07 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: john@arbash-meinel.com-20100113162307-0bs82td16gzih827
Update the MANIFEST.in file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shellcomplete.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
import sys
 
18
 
 
19
 
 
20
def shellcomplete(context=None, outfile = None):
 
21
    if outfile is None:
 
22
        outfile = sys.stdout
 
23
    if context is None:
 
24
        shellcomplete_commands(outfile = outfile)
 
25
    else:
 
26
        shellcomplete_on_command(context, outfile = outfile)
 
27
 
 
28
 
 
29
def shellcomplete_on_command(cmdname, outfile=None):
 
30
    cmdname = str(cmdname)
 
31
 
 
32
    if outfile is None:
 
33
        outfile = sys.stdout
 
34
 
 
35
    from inspect import getdoc
 
36
    import commands
 
37
    cmdobj = commands.get_cmd_object(cmdname)
 
38
 
 
39
    doc = getdoc(cmdobj)
 
40
    if doc is None:
 
41
        raise NotImplementedError("sorry, no detailed shellcomplete yet for %r" % cmdname)
 
42
 
 
43
    shellcomplete_on_options(cmdobj.options().values(), outfile=outfile)
 
44
    for aname in cmdobj.takes_args:
 
45
        outfile.write(aname + '\n')
 
46
 
 
47
 
 
48
def shellcomplete_on_options(options, outfile=None):
 
49
    for opt in options:
 
50
        short_name = opt.short_name()
 
51
        if short_name:
 
52
            outfile.write('"(--%s -%s)"{--%s,-%s}\n'
 
53
                    % (opt.name, short_name, opt.name, short_name))
 
54
        else:
 
55
            outfile.write('--%s\n' % opt.name)
 
56
 
 
57
 
 
58
def shellcomplete_commands(outfile = None):
 
59
    """List all commands"""
 
60
    import inspect
 
61
    import commands
 
62
    from inspect import getdoc
 
63
 
 
64
    commands.install_bzr_command_hooks()
 
65
 
 
66
    if outfile is None:
 
67
        outfile = sys.stdout
 
68
 
 
69
    cmds = []
 
70
    for cmdname in commands.all_command_names():
 
71
        cmd = commands.get_cmd_object(cmdname)
 
72
        cmds.append((cmdname, cmd))
 
73
        for alias in cmd.aliases:
 
74
            cmds.append((alias, cmd))
 
75
    cmds.sort()
 
76
    for cmdname, cmd in cmds:
 
77
        if cmd.hidden:
 
78
            continue
 
79
        doc = getdoc(cmd)
 
80
        if doc is None:
 
81
            outfile.write(cmdname + '\n')
 
82
        else:
 
83
            doclines = doc.splitlines()
 
84
            firstline = doclines[0].lower()
 
85
            outfile.write(cmdname + ':' + firstline[0:-1] + '\n')