← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: abentley
  • Date: 2006-04-20 23:47:53 UTC
  • mfrom: (1681 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1683.
  • Revision ID: abentley@lappy-20060420234753-6a6874b76f09f86d
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006 by Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
20
20
 
21
 
# TODO: Help messages for options.
22
 
 
23
21
# TODO: Define arguments by objects, rather than just using names.
24
22
# Those objects can specify the expected type of the argument, which
25
 
# would help with validation and shell completion.
 
23
# would help with validation and shell completion.  They could also provide
 
24
# help/explanation for that argument in a structured way.
 
25
 
 
26
# TODO: Specific "examples" property on commands for consistent formatting.
26
27
 
27
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
28
29
# the profile output behind so it can be interactively examined?
30
31
import sys
31
32
import os
32
33
from warnings import warn
33
 
from inspect import getdoc
34
34
import errno
35
35
 
36
36
import bzrlib
37
 
from bzrlib.errors import (BzrError, 
 
37
from bzrlib.errors import (BzrError,
38
38
                           BzrCheckError,
39
39
                           BzrCommandError,
40
40
                           BzrOptionError,
49
49
 
50
50
 
51
51
def register_command(cmd, decorate=False):
52
 
    "Utility function to help register a command"
 
52
    """Utility function to help register a command
 
53
 
 
54
    :param cmd: Command subclass to register
 
55
    :param decorate: If true, allow overriding an existing command
 
56
        of the same name; the old command is returned by this function.
 
57
        Otherwise it is an error to try to override an existing command.
 
58
    """
53
59
    global plugin_cmds
54
60
    k = cmd.__name__
55
61
    if k.startswith("cmd_"):
58
64
        k_unsquished = k
59
65
    if not plugin_cmds.has_key(k_unsquished):
60
66
        plugin_cmds[k_unsquished] = cmd
61
 
        mutter('registered plugin command %s', k_unsquished)      
 
67
        mutter('registered plugin command %s', k_unsquished)
62
68
        if decorate and k_unsquished in builtin_command_names():
63
69
            return _builtin_commands()[k_unsquished]
64
70
    elif decorate:
85
91
    builtins = bzrlib.builtins.__dict__
86
92
    for name in builtins:
87
93
        if name.startswith("cmd_"):
88
 
            real_name = _unsquish_command_name(name)        
 
94
            real_name = _unsquish_command_name(name)
89
95
            r[real_name] = builtins[name]
90
96
    return r
91
 
 
92
97
            
93
98
 
94
99
def builtin_command_names():
250
255
        shell error code if not.  It's OK for this method to allow
251
256
        an exception to raise up.
252
257
        """
253
 
        raise NotImplementedError()
254
 
 
 
258
        raise NotImplementedError('no implementation of command %r' 
 
259
                                  % self.name())
255
260
 
256
261
    def help(self):
257
262
        """Return help message for this class."""
 
263
        from inspect import getdoc
258
264
        if self.__doc__ is Command.__doc__:
259
265
            return None
260
266
        return getdoc(self)
562
568
        i += 1
563
569
 
564
570
    argv = argv_copy
565
 
    if (not argv) or (argv[0] == '--help'):
566
 
        from bzrlib.help import help
567
 
        if len(argv) > 1:
568
 
            help(argv[1])
569
 
        else:
570
 
            help()
 
571
    if (not argv):
 
572
        from bzrlib.builtins import cmd_help
 
573
        cmd_help().run_argv_aliases([])
571
574
        return 0
572
575
 
573
576
    if argv[0] == '--version':