~bzr-pqm/bzr/bzr.dev

329 by Martin Pool
- refactor command functions into command classes
1
# Copyright (C) 2004, 2005 by Canonical Ltd
1 by mbp at sourcefrog
import from baz patch-364
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
20
1095 by Martin Pool
todo
21
# TODO: Help messages for options.
22
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
26
1393.1.27 by Martin Pool
- clean up profile code and change default sort order
27
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
29
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
30
import sys
31
import os
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
32
from warnings import warn
33
from inspect import getdoc
1 by mbp at sourcefrog
import from baz patch-364
34
35
import bzrlib
1112 by Martin Pool
- disable standard logging to .bzr.log and stderr while running
36
import bzrlib.trace
897 by Martin Pool
- merge john's revision-naming code
37
from bzrlib.trace import mutter, note, log_error, warning
974.1.82 by Aaron Bentley
Handled NotBranchError like a CommandError in main()
38
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
39
from bzrlib.revisionspec import RevisionSpec
800 by Martin Pool
Merge John's import-speedup branch:
40
from bzrlib import BZRDIR
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
41
from bzrlib.option import Option
1 by mbp at sourcefrog
import from baz patch-364
42
731 by Martin Pool
- merge plugin patch from john
43
plugin_cmds = {}
44
45
759 by Martin Pool
- fix up register_command() names
46
def register_command(cmd):
731 by Martin Pool
- merge plugin patch from john
47
    "Utility function to help register a command"
48
    global plugin_cmds
49
    k = cmd.__name__
50
    if k.startswith("cmd_"):
51
        k_unsquished = _unsquish_command_name(k)
52
    else:
53
        k_unsquished = k
54
    if not plugin_cmds.has_key(k_unsquished):
55
        plugin_cmds[k_unsquished] = cmd
1137 by Martin Pool
- additional trace messages for plugins
56
        mutter('registered plugin command %s', k_unsquished)      
731 by Martin Pool
- merge plugin patch from john
57
    else:
58
        log_error('Two plugins defined the same command: %r' % k)
59
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
60
61
350 by Martin Pool
- refactor command aliases into command classes
62
def _squish_command_name(cmd):
63
    return 'cmd_' + cmd.replace('-', '_')
64
65
66
def _unsquish_command_name(cmd):
67
    assert cmd.startswith("cmd_")
68
    return cmd[4:].replace('_','-')
69
914 by Martin Pool
- fix up breakage of 'bzr log -v' by root_id patch
70
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
71
def _builtin_commands():
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
72
    import bzrlib.builtins
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
73
    r = {}
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
74
    builtins = bzrlib.builtins.__dict__
75
    for name in builtins:
76
        if name.startswith("cmd_"):
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
77
            real_name = _unsquish_command_name(name)        
78
            r[real_name] = builtins[name]
79
    return r
80
81
            
82
83
def builtin_command_names():
84
    """Return list of builtin command names."""
85
    return _builtin_commands().keys()
86
    
87
88
def plugin_command_names():
89
    return plugin_cmds.keys()
90
91
92
def _get_cmd_dict(plugins_override=True):
93
    """Return name->class mapping for all commands."""
94
    d = _builtin_commands()
731 by Martin Pool
- merge plugin patch from john
95
    if plugins_override:
96
        d.update(plugin_cmds)
641 by Martin Pool
- improved external-command patch from john
97
    return d
731 by Martin Pool
- merge plugin patch from john
98
641 by Martin Pool
- improved external-command patch from john
99
    
731 by Martin Pool
- merge plugin patch from john
100
def get_all_cmds(plugins_override=True):
641 by Martin Pool
- improved external-command patch from john
101
    """Return canonical name and class for all registered commands."""
731 by Martin Pool
- merge plugin patch from john
102
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
641 by Martin Pool
- improved external-command patch from john
103
        yield k,v
104
105
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
106
def get_cmd_object(cmd_name, plugins_override=True):
350 by Martin Pool
- refactor command aliases into command classes
107
    """Return the canonical name and command class for a command.
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
108
109
    plugins_override
110
        If true, plugin commands can override builtins.
350 by Martin Pool
- refactor command aliases into command classes
111
    """
1163 by Martin Pool
- split ExternalCommand class into its own file
112
    from bzrlib.externalcommand import ExternalCommand
113
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
114
    cmd_name = str(cmd_name)            # not unicode
350 by Martin Pool
- refactor command aliases into command classes
115
116
    # first look up this command under the specified name
731 by Martin Pool
- merge plugin patch from john
117
    cmds = _get_cmd_dict(plugins_override=plugins_override)
272 by Martin Pool
- Add command aliases
118
    try:
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
119
        return cmds[cmd_name]()
272 by Martin Pool
- Add command aliases
120
    except KeyError:
350 by Martin Pool
- refactor command aliases into command classes
121
        pass
122
123
    # look for any command which claims this as an alias
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
124
    for real_cmd_name, cmd_class in cmds.iteritems():
125
        if cmd_name in cmd_class.aliases:
126
            return cmd_class()
127
128
    cmd_obj = ExternalCommand.find_command(cmd_name)
129
    if cmd_obj:
130
        return cmd_obj
131
132
    raise BzrCommandError("unknown command %r" % cmd_name)
272 by Martin Pool
- Add command aliases
133
329 by Martin Pool
- refactor command functions into command classes
134
558 by Martin Pool
- All top-level classes inherit from object
135
class Command(object):
329 by Martin Pool
- refactor command functions into command classes
136
    """Base class for commands.
137
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
138
    Commands are the heart of the command-line bzr interface.
139
140
    The command object mostly handles the mapping of command-line
141
    parameters into one or more bzrlib operations, and of the results
142
    into textual output.
143
144
    Commands normally don't have any state.  All their arguments are
145
    passed in to the run method.  (Subclasses may take a different
146
    policy if the behaviour of the instance needs to depend on e.g. a
147
    shell plugin and not just its Python class.)
148
329 by Martin Pool
- refactor command functions into command classes
149
    The docstring for an actual command should give a single-line
150
    summary, then a complete description of the command.  A grammar
151
    description will be inserted.
152
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
153
    aliases
154
        Other accepted names for this command.
155
329 by Martin Pool
- refactor command functions into command classes
156
    takes_args
157
        List of argument forms, marked with whether they are optional,
158
        repeated, etc.
159
160
    takes_options
1185.16.43 by Martin Pool
- clean up handling of option objects
161
        List of options that may be given for this command.  These can
162
        be either strings, referring to globally-defined options,
163
        or option objects.  Retrieve through options().
329 by Martin Pool
- refactor command functions into command classes
164
165
    hidden
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
166
        If true, this command isn't advertised.  This is typically
167
        for commands intended for expert users.
329 by Martin Pool
- refactor command functions into command classes
168
    """
169
    aliases = []
170
    takes_args = []
171
    takes_options = []
172
173
    hidden = False
174
    
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
175
    def __init__(self):
176
        """Construct an instance of this command."""
973 by Martin Pool
- various refactorings of command interpreter
177
        if self.__doc__ == Command.__doc__:
178
            warn("No help message set for %r" % self)
329 by Martin Pool
- refactor command functions into command classes
179
1185.16.43 by Martin Pool
- clean up handling of option objects
180
    def options(self):
181
        """Return dict of valid options for this command.
182
183
        Maps from long option name to option object."""
184
        r = dict()
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
185
        r['help'] = Option.OPTIONS['help']
1185.16.43 by Martin Pool
- clean up handling of option objects
186
        for o in self.takes_options:
187
            if not isinstance(o, Option):
188
                o = Option.OPTIONS[o]
189
            r[o.name] = o
190
        return r
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
191
192
    def run_argv(self, argv):
193
        """Parse command line and run."""
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
194
        args, opts = parse_args(self, argv)
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
195
        if 'help' in opts:  # e.g. bzr add --help
196
            from bzrlib.help import help_on_command
197
            help_on_command(self.name())
198
            return 0
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
199
        # XXX: This should be handled by the parser
1185.16.43 by Martin Pool
- clean up handling of option objects
200
        allowed_names = self.options().keys()
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
201
        for oname in opts:
1185.16.43 by Martin Pool
- clean up handling of option objects
202
            if oname not in allowed_names:
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
203
                raise BzrCommandError("option '--%s' is not allowed for command %r"
204
                                      % (oname, self.name()))
205
        # mix arguments and options into one dictionary
206
        cmdargs = _match_argform(self.name(), self.takes_args, args)
207
        cmdopts = {}
208
        for k, v in opts.items():
209
            cmdopts[k.replace('-', '_')] = v
210
211
        all_cmd_args = cmdargs.copy()
212
        all_cmd_args.update(cmdopts)
213
214
        return self.run(**all_cmd_args)
215
329 by Martin Pool
- refactor command functions into command classes
216
    
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
217
    def run(self):
218
        """Actually run the command.
329 by Martin Pool
- refactor command functions into command classes
219
220
        This is invoked with the options and arguments bound to
221
        keyword parameters.
222
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
223
        Return 0 or None if the command was successful, or a non-zero
224
        shell error code if not.  It's OK for this method to allow
225
        an exception to raise up.
329 by Martin Pool
- refactor command functions into command classes
226
        """
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
227
        raise NotImplementedError()
329 by Martin Pool
- refactor command functions into command classes
228
229
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
230
    def help(self):
231
        """Return help message for this class."""
232
        if self.__doc__ is Command.__doc__:
233
            return None
234
        return getdoc(self)
235
236
    def name(self):
237
        return _unsquish_command_name(self.__class__.__name__)
238
239
493 by Martin Pool
- Merge aaron's merge command
240
def parse_spec(spec):
622 by Martin Pool
Updated merge patch from Aaron
241
    """
242
    >>> parse_spec(None)
243
    [None, None]
244
    >>> parse_spec("./")
245
    ['./', None]
246
    >>> parse_spec("../@")
247
    ['..', -1]
248
    >>> parse_spec("../f/@35")
249
    ['../f', 35]
897 by Martin Pool
- merge john's revision-naming code
250
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
251
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
622 by Martin Pool
Updated merge patch from Aaron
252
    """
253
    if spec is None:
254
        return [None, None]
493 by Martin Pool
- Merge aaron's merge command
255
    if '/@' in spec:
256
        parsed = spec.split('/@')
257
        assert len(parsed) == 2
258
        if parsed[1] == "":
259
            parsed[1] = -1
260
        else:
897 by Martin Pool
- merge john's revision-naming code
261
            try:
262
                parsed[1] = int(parsed[1])
263
            except ValueError:
264
                pass # We can allow stuff like ./@revid:blahblahblah
265
            else:
266
                assert parsed[1] >=0
493 by Martin Pool
- Merge aaron's merge command
267
    else:
268
        parsed = [spec, None]
269
    return parsed
270
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
271
def parse_args(command, argv):
1 by mbp at sourcefrog
import from baz patch-364
272
    """Parse command line.
273
    
274
    Arguments and options are parsed at this level before being passed
275
    down to specific command handlers.  This routine knows, from a
276
    lookup table, something about the available options, what optargs
277
    they take, and which commands will accept them.
278
    """
1185.16.49 by mbp at sourcefrog
- more refactoring and tests of commandline
279
    # TODO: chop up this beast; make it a method of the Command
1 by mbp at sourcefrog
import from baz patch-364
280
    args = []
281
    opts = {}
282
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
283
    cmd_options = command.options()
1144 by Martin Pool
- accept -- to terminate options
284
    argsover = False
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
285
    while argv:
286
        a = argv.pop(0)
1185.16.49 by mbp at sourcefrog
- more refactoring and tests of commandline
287
        if argsover:
288
            args.append(a)
289
            continue
290
        elif a == '--':
291
            # We've received a standalone -- No more flags
292
            argsover = True
293
            continue
294
        if a[0] == '-':
264 by Martin Pool
parse_args: option names must be ascii
295
            # option names must not be unicode
296
            a = str(a)
17 by mbp at sourcefrog
allow --option=ARG syntax
297
            optarg = None
1 by mbp at sourcefrog
import from baz patch-364
298
            if a[1] == '-':
299
                mutter("  got option %r" % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
300
                if '=' in a:
301
                    optname, optarg = a[2:].split('=', 1)
302
                else:
303
                    optname = a[2:]
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
304
                if optname not in cmd_options:
305
                    raise BzrCommandError('unknown long option %r for command %s' 
306
                            % (a, command.name))
1 by mbp at sourcefrog
import from baz patch-364
307
            else:
308
                shortopt = a[1:]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
309
                if shortopt in Option.SHORT_OPTIONS:
683 by Martin Pool
- short option stacking patch from John A Meinel
310
                    # Multi-character options must have a space to delimit
311
                    # their value
1185.16.44 by Martin Pool
doc
312
                    # ^^^ what does this mean? mbp 20051014
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
313
                    optname = Option.SHORT_OPTIONS[shortopt].name
683 by Martin Pool
- short option stacking patch from John A Meinel
314
                else:
315
                    # Single character short options, can be chained,
316
                    # and have their value appended to their name
317
                    shortopt = a[1:2]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
318
                    if shortopt not in Option.SHORT_OPTIONS:
683 by Martin Pool
- short option stacking patch from John A Meinel
319
                        # We didn't find the multi-character name, and we
320
                        # didn't find the single char name
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
321
                        raise BzrError('unknown short option %r' % a)
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
322
                    optname = Option.SHORT_OPTIONS[shortopt].name
683 by Martin Pool
- short option stacking patch from John A Meinel
323
324
                    if a[2:]:
325
                        # There are extra things on this option
326
                        # see if it is the value, or if it is another
327
                        # short option
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
328
                        optargfn = Option.OPTIONS[optname].type
683 by Martin Pool
- short option stacking patch from John A Meinel
329
                        if optargfn is None:
330
                            # This option does not take an argument, so the
331
                            # next entry is another short option, pack it back
332
                            # into the list
333
                            argv.insert(0, '-' + a[2:])
334
                        else:
335
                            # This option takes an argument, so pack it
336
                            # into the array
337
                            optarg = a[2:]
1 by mbp at sourcefrog
import from baz patch-364
338
            
339
            if optname in opts:
340
                # XXX: Do we ever want to support this, e.g. for -r?
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
341
                raise BzrError('repeated option %r' % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
342
                
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
343
            option_obj = cmd_options[optname]
344
            optargfn = option_obj.type
1 by mbp at sourcefrog
import from baz patch-364
345
            if optargfn:
17 by mbp at sourcefrog
allow --option=ARG syntax
346
                if optarg == None:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
347
                    if not argv:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
348
                        raise BzrError('option %r needs an argument' % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
349
                    else:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
350
                        optarg = argv.pop(0)
17 by mbp at sourcefrog
allow --option=ARG syntax
351
                opts[optname] = optargfn(optarg)
1 by mbp at sourcefrog
import from baz patch-364
352
            else:
17 by mbp at sourcefrog
allow --option=ARG syntax
353
                if optarg != None:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
354
                    raise BzrError('option %r takes no argument' % optname)
1 by mbp at sourcefrog
import from baz patch-364
355
                opts[optname] = True
356
        else:
357
            args.append(a)
358
    return args, opts
359
360
329 by Martin Pool
- refactor command functions into command classes
361
def _match_argform(cmd, takes_args, args):
1 by mbp at sourcefrog
import from baz patch-364
362
    argdict = {}
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
363
329 by Martin Pool
- refactor command functions into command classes
364
    # step through args and takes_args, allowing appropriate 0-many matches
365
    for ap in takes_args:
1 by mbp at sourcefrog
import from baz patch-364
366
        argname = ap[:-1]
367
        if ap[-1] == '?':
62 by mbp at sourcefrog
- new find_branch_root function; based on suggestion from aaron
368
            if args:
369
                argdict[argname] = args.pop(0)
196 by mbp at sourcefrog
selected-file diff
370
        elif ap[-1] == '*': # all remaining arguments
371
            if args:
372
                argdict[argname + '_list'] = args[:]
373
                args = []
374
            else:
375
                argdict[argname + '_list'] = None
1 by mbp at sourcefrog
import from baz patch-364
376
        elif ap[-1] == '+':
377
            if not args:
329 by Martin Pool
- refactor command functions into command classes
378
                raise BzrCommandError("command %r needs one or more %s"
1 by mbp at sourcefrog
import from baz patch-364
379
                        % (cmd, argname.upper()))
380
            else:
381
                argdict[argname + '_list'] = args[:]
382
                args = []
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
383
        elif ap[-1] == '$': # all but one
384
            if len(args) < 2:
329 by Martin Pool
- refactor command functions into command classes
385
                raise BzrCommandError("command %r needs one or more %s"
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
386
                        % (cmd, argname.upper()))
387
            argdict[argname + '_list'] = args[:-1]
388
            args[:-1] = []                
1 by mbp at sourcefrog
import from baz patch-364
389
        else:
390
            # just a plain arg
391
            argname = ap
392
            if not args:
329 by Martin Pool
- refactor command functions into command classes
393
                raise BzrCommandError("command %r requires argument %s"
1 by mbp at sourcefrog
import from baz patch-364
394
                        % (cmd, argname.upper()))
395
            else:
396
                argdict[argname] = args.pop(0)
397
            
398
    if args:
329 by Martin Pool
- refactor command functions into command classes
399
        raise BzrCommandError("extra argument to command %s: %s"
400
                              % (cmd, args[0]))
1 by mbp at sourcefrog
import from baz patch-364
401
402
    return argdict
403
404
405
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
406
def apply_profiled(the_callable, *args, **kwargs):
407
    import hotshot
408
    import tempfile
1393.1.27 by Martin Pool
- clean up profile code and change default sort order
409
    import hotshot.stats
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
410
    pffileno, pfname = tempfile.mkstemp()
411
    try:
412
        prof = hotshot.Profile(pfname)
413
        try:
414
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
415
        finally:
416
            prof.close()
417
        stats = hotshot.stats.load(pfname)
1393.1.27 by Martin Pool
- clean up profile code and change default sort order
418
        stats.strip_dirs()
419
        stats.sort_stats('cum')   # 'time'
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
420
        ## XXX: Might like to write to stderr or the trace file instead but
421
        ## print_stats seems hardcoded to stdout
422
        stats.print_stats(20)
423
        return ret
424
    finally:
425
        os.close(pffileno)
426
        os.remove(pfname)
427
428
1 by mbp at sourcefrog
import from baz patch-364
429
def run_bzr(argv):
430
    """Execute a command.
431
432
    This is similar to main(), but without all the trappings for
245 by mbp at sourcefrog
- control files always in utf-8-unix format
433
    logging and error handling.  
973 by Martin Pool
- various refactorings of command interpreter
434
    
435
    argv
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
436
       The command-line arguments, without the program name from argv[0]
973 by Martin Pool
- various refactorings of command interpreter
437
    
438
    Returns a command status or raises an exception.
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
439
440
    Special master options: these must come before the command because
441
    they control how the command is interpreted.
442
443
    --no-plugins
444
        Do not load plugin modules at all
445
446
    --builtin
447
        Only use builtin commands.  (Plugins are still allowed to change
448
        other behaviour.)
449
450
    --profile
451
        Run under the Python profiler.
1 by mbp at sourcefrog
import from baz patch-364
452
    """
1185.11.1 by John Arbash Meinel
(broken) Transport work is merged in. Tests do not pass yet.
453
    # Load all of the transport methods
454
    import bzrlib.transport.local, bzrlib.transport.http
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
455
    
251 by mbp at sourcefrog
- factor out locale.getpreferredencoding()
456
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
907.1.21 by John Arbash Meinel
Adding http transport as a valid transport protocol.
457
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
458
    opt_profile = opt_no_plugins = opt_builtin = False
459
460
    # --no-plugins is handled specially at a very early stage. We need
461
    # to load plugins before doing other command parsing so that they
462
    # can override commands, but this needs to happen first.
463
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
464
    for a in argv:
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
465
        if a == '--profile':
466
            opt_profile = True
467
        elif a == '--no-plugins':
468
            opt_no_plugins = True
469
        elif a == '--builtin':
470
            opt_builtin = True
471
        else:
472
            break
473
        argv.remove(a)
474
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
475
    if (not argv) or (argv[0] == '--help'):
476
        from bzrlib.help import help
477
        if len(argv) > 1:
478
            help(argv[1])
479
        else:
480
            help()
481
        return 0
482
483
    if argv[0] == '--version':
484
        from bzrlib.builtins import show_version
485
        show_version()
486
        return 0
487
        
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
488
    if not opt_no_plugins:
973 by Martin Pool
- various refactorings of command interpreter
489
        from bzrlib.plugin import load_plugins
490
        load_plugins()
491
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
492
    cmd = str(argv.pop(0))
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
493
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
494
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1 by mbp at sourcefrog
import from baz patch-364
495
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
496
    if opt_profile:
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
497
        ret = apply_profiled(cmd_obj.run_argv, argv)
137 by mbp at sourcefrog
new --profile option
498
    else:
1165 by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv
499
        ret = cmd_obj.run_argv(argv)
500
    return ret or 0
267 by Martin Pool
- better reporting of errors
501
502
1 by mbp at sourcefrog
import from baz patch-364
503
def main(argv):
1104 by Martin Pool
- Add a simple UIFactory
504
    import bzrlib.ui
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
505
    bzrlib.trace.log_startup(argv)
1104 by Martin Pool
- Add a simple UIFactory
506
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
507
1185.3.20 by Martin Pool
- run_bzr_captured also includes logged errors in
508
    return run_bzr_catch_errors(argv[1:])
1185.3.19 by Martin Pool
- split out commandline error reporting for ease of testing
509
510
511
def run_bzr_catch_errors(argv):
1 by mbp at sourcefrog
import from baz patch-364
512
    try:
260 by Martin Pool
- remove atexit() dependency for writing out execution times
513
        try:
1393.1.64 by Martin Pool
- improved display of some errors, including NotBranchError
514
            return run_bzr(argv)
515
        finally:
516
            # do this here inside the exception wrappers to catch EPIPE
517
            sys.stdout.flush()
1097 by Martin Pool
- send trace messages out through python logging module
518
    except BzrCommandError, e:
519
        # command line syntax error, etc
520
        log_error(str(e))
521
        return 1
522
    except BzrError, e:
523
        bzrlib.trace.log_exception()
524
        return 1
525
    except AssertionError, e:
526
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
527
        return 3
528
    except KeyboardInterrupt, e:
1360 by Martin Pool
- give possible traceback when interrupted
529
        bzrlib.trace.log_exception('interrupted')
1097 by Martin Pool
- send trace messages out through python logging module
530
        return 2
531
    except Exception, e:
532
        import errno
533
        if (isinstance(e, IOError) 
534
            and hasattr(e, 'errno')
535
            and e.errno == errno.EPIPE):
536
            bzrlib.trace.note('broken pipe')
537
            return 2
538
        else:
1393.1.65 by Martin Pool
- remove accidental pdb invocation
539
            ## import pdb
540
            ## pdb.pm()
1108 by Martin Pool
- more cleanups of error reporting
541
            bzrlib.trace.log_exception()
1097 by Martin Pool
- send trace messages out through python logging module
542
            return 2
1 by mbp at sourcefrog
import from baz patch-364
543
544
if __name__ == '__main__':
545
    sys.exit(main(sys.argv))