← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Martin Pool
  • Date: 2005-05-10 07:06:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050510070605-0a2453ae5db6fc3c
- new command 'bzr added'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
56
56
"""
57
57
 
58
58
 
59
 
import sys
60
 
 
61
 
 
62
 
def help(topic=None, outfile = None):
63
 
    if outfile == None:
64
 
        outfile = sys.stdout
 
59
 
 
60
def help(topic=None):
65
61
    if topic == None:
66
 
        outfile.write(global_help)
 
62
        print global_help
67
63
    elif topic == 'commands':
68
 
        help_commands(outfile = outfile)
69
 
    else:
70
 
        help_on_command(topic, outfile = outfile)
71
 
 
72
 
 
73
 
def command_usage(cmdname, cmdclass):
74
 
    """Return single-line grammar for command.
75
 
 
76
 
    Only describes arguments, not options.
77
 
    """
78
 
    s = cmdname + ' '
 
64
        help_commands()
 
65
    else:
 
66
        help_on_command(topic)
 
67
 
 
68
 
 
69
def help_on_command(cmdname):
 
70
    cmdname = str(cmdname)
 
71
 
 
72
    from inspect import getdoc
 
73
    import commands
 
74
    topic, cmdclass = commands.get_cmd_class(cmdname)
 
75
 
 
76
    doc = getdoc(cmdclass)
 
77
    if doc == None:
 
78
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
79
 
 
80
    if '\n' in doc:
 
81
        short, rest = doc.split('\n', 1)
 
82
    else:
 
83
        short = doc
 
84
        rest = ''
 
85
 
 
86
    print 'usage: bzr ' + topic,
79
87
    for aname in cmdclass.takes_args:
80
88
        aname = aname.upper()
81
89
        if aname[-1] in ['$', '+']:
84
92
            aname = '[' + aname[:-1] + ']'
85
93
        elif aname[-1] == '*':
86
94
            aname = '[' + aname[:-1] + '...]'
87
 
        s += aname + ' '
88
 
            
89
 
    assert s[-1] == ' '
90
 
    s = s[:-1]
91
 
    
92
 
    return s
93
 
 
94
 
 
95
 
def help_on_command(cmdname, outfile = None):
96
 
    cmdname = str(cmdname)
97
 
 
98
 
    if outfile == None:
99
 
        outfile = sys.stdout
100
 
 
101
 
    from inspect import getdoc
102
 
    import commands
103
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
104
 
 
105
 
    doc = getdoc(cmdclass)
106
 
    if doc == None:
107
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
108
 
 
109
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
 
95
        print aname,
 
96
    print 
 
97
    print short
110
98
 
111
99
    if cmdclass.aliases:
112
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
113
 
    
114
 
    outfile.write(doc)
115
 
    if doc[-1] != '\n':
116
 
        outfile.write('\n')
117
 
    
118
 
    help_on_option(cmdclass.takes_options, outfile = None)
119
 
 
120
 
 
121
 
def help_on_option(options, outfile = None):
 
100
        print 'aliases: ' + ', '.join(cmdclass.aliases)
 
101
    
 
102
    if rest:
 
103
        print rest
 
104
 
 
105
    help_on_option(cmdclass.takes_options)
 
106
 
 
107
 
 
108
def help_on_option(options):
122
109
    import commands
123
110
    
124
111
    if not options:
125
112
        return
126
113
    
127
 
    if outfile == None:
128
 
        outfile = sys.stdout
129
 
 
130
 
    outfile.write('\noptions:\n')
 
114
    print
 
115
    print 'options:'
131
116
    for on in options:
132
117
        l = '    --' + on
133
118
        for shortname, longname in commands.SHORT_OPTIONS.items():
134
119
            if longname == on:
135
120
                l += ', -' + shortname
136
121
                break
137
 
        outfile.write(l + '\n')
138
 
 
139
 
 
140
 
def help_commands(outfile = None):
 
122
        print l
 
123
 
 
124
 
 
125
def help_commands():
141
126
    """List all commands"""
142
127
    import inspect
143
128
    import commands
144
 
 
145
 
    if outfile == None:
146
 
        outfile = sys.stdout
147
129
    
148
130
    accu = []
149
131
    for cmdname, cmdclass in commands.get_all_cmds():
152
134
    for cmdname, cmdclass in accu:
153
135
        if cmdclass.hidden:
154
136
            continue
155
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
 
137
        print cmdname
156
138
        help = inspect.getdoc(cmdclass)
157
139
        if help:
158
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
159
 
 
 
140
            print "    " + help.split('\n', 1)[0]
160
141
            
161
142