~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Robert Collins
  • Date: 2005-08-25 02:43:15 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825024315-01e64162aa925ac3
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
# TODO: Split the command framework away from the actual commands.
 
19
 
18
20
# TODO: probably should say which arguments are candidates for glob
19
21
# expansion on windows and do that at the command level.
20
22
 
24
26
# Those objects can specify the expected type of the argument, which
25
27
# would help with validation and shell completion.
26
28
 
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
29
 
30
30
import sys
31
31
import os
32
 
from warnings import warn
33
 
from inspect import getdoc
34
32
 
35
33
import bzrlib
36
 
import bzrlib.trace
37
34
from bzrlib.trace import mutter, note, log_error, warning
38
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
39
 
from bzrlib.revisionspec import RevisionSpec
 
35
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
 
36
from bzrlib.branch import find_branch
40
37
from bzrlib import BZRDIR
41
 
from bzrlib.option import Option
 
38
 
42
39
 
43
40
plugin_cmds = {}
44
41
 
53
50
        k_unsquished = k
54
51
    if not plugin_cmds.has_key(k_unsquished):
55
52
        plugin_cmds[k_unsquished] = cmd
56
 
        mutter('registered plugin command %s', k_unsquished)      
57
53
    else:
58
54
        log_error('Two plugins defined the same command: %r' % k)
59
55
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
68
64
    return cmd[4:].replace('_','-')
69
65
 
70
66
 
71
 
def _builtin_commands():
72
 
    import bzrlib.builtins
73
 
    r = {}
74
 
    builtins = bzrlib.builtins.__dict__
75
 
    for name in builtins:
76
 
        if name.startswith("cmd_"):
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()
 
67
def _parse_revision_str(revstr):
 
68
    """This handles a revision string -> revno.
 
69
 
 
70
    This always returns a list.  The list will have one element for 
 
71
 
 
72
    It supports integers directly, but everything else it
 
73
    defers for passing to Branch.get_revision_info()
 
74
 
 
75
    >>> _parse_revision_str('234')
 
76
    [234]
 
77
    >>> _parse_revision_str('234..567')
 
78
    [234, 567]
 
79
    >>> _parse_revision_str('..')
 
80
    [None, None]
 
81
    >>> _parse_revision_str('..234')
 
82
    [None, 234]
 
83
    >>> _parse_revision_str('234..')
 
84
    [234, None]
 
85
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
 
86
    [234, 456, 789]
 
87
    >>> _parse_revision_str('234....789') # Error?
 
88
    [234, None, 789]
 
89
    >>> _parse_revision_str('revid:test@other.com-234234')
 
90
    ['revid:test@other.com-234234']
 
91
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
 
92
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
 
93
    >>> _parse_revision_str('revid:test@other.com-234234..23')
 
94
    ['revid:test@other.com-234234', 23]
 
95
    >>> _parse_revision_str('date:2005-04-12')
 
96
    ['date:2005-04-12']
 
97
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
 
98
    ['date:2005-04-12 12:24:33']
 
99
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
 
100
    ['date:2005-04-12T12:24:33']
 
101
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
 
102
    ['date:2005-04-12,12:24:33']
 
103
    >>> _parse_revision_str('-5..23')
 
104
    [-5, 23]
 
105
    >>> _parse_revision_str('-5')
 
106
    [-5]
 
107
    >>> _parse_revision_str('123a')
 
108
    ['123a']
 
109
    >>> _parse_revision_str('abc')
 
110
    ['abc']
 
111
    """
 
112
    import re
 
113
    old_format_re = re.compile('\d*:\d*')
 
114
    m = old_format_re.match(revstr)
 
115
    if m:
 
116
        warning('Colon separator for revision numbers is deprecated.'
 
117
                ' Use .. instead')
 
118
        revs = []
 
119
        for rev in revstr.split(':'):
 
120
            if rev:
 
121
                revs.append(int(rev))
 
122
            else:
 
123
                revs.append(None)
 
124
        return revs
 
125
    revs = []
 
126
    for x in revstr.split('..'):
 
127
        if not x:
 
128
            revs.append(None)
 
129
        else:
 
130
            try:
 
131
                revs.append(int(x))
 
132
            except ValueError:
 
133
                revs.append(x)
 
134
    return revs
 
135
 
 
136
 
 
137
def get_merge_type(typestring):
 
138
    """Attempt to find the merge class/factory associated with a string."""
 
139
    from merge import merge_types
 
140
    try:
 
141
        return merge_types[typestring][0]
 
142
    except KeyError:
 
143
        templ = '%s%%7s: %%s' % (' '*12)
 
144
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
145
        type_list = '\n'.join(lines)
 
146
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
147
            (typestring, type_list)
 
148
        raise BzrCommandError(msg)
 
149
    
 
150
 
 
151
def get_merge_type(typestring):
 
152
    """Attempt to find the merge class/factory associated with a string."""
 
153
    from merge import merge_types
 
154
    try:
 
155
        return merge_types[typestring][0]
 
156
    except KeyError:
 
157
        templ = '%s%%7s: %%s' % (' '*12)
 
158
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
159
        type_list = '\n'.join(lines)
 
160
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
161
            (typestring, type_list)
 
162
        raise BzrCommandError(msg)
 
163
    
90
164
 
91
165
 
92
166
def _get_cmd_dict(plugins_override=True):
93
 
    """Return name->class mapping for all commands."""
94
 
    d = _builtin_commands()
 
167
    d = {}
 
168
    for k, v in globals().iteritems():
 
169
        if k.startswith("cmd_"):
 
170
            d[_unsquish_command_name(k)] = v
 
171
    # If we didn't load plugins, the plugin_cmds dict will be empty
95
172
    if plugins_override:
96
173
        d.update(plugin_cmds)
 
174
    else:
 
175
        d2 = plugin_cmds.copy()
 
176
        d2.update(d)
 
177
        d = d2
97
178
    return d
98
179
 
99
180
    
103
184
        yield k,v
104
185
 
105
186
 
106
 
def get_cmd_object(cmd_name, plugins_override=True):
 
187
def get_cmd_class(cmd, plugins_override=True):
107
188
    """Return the canonical name and command class for a command.
108
 
 
109
 
    plugins_override
110
 
        If true, plugin commands can override builtins.
111
189
    """
112
 
    from bzrlib.externalcommand import ExternalCommand
113
 
 
114
 
    cmd_name = str(cmd_name)            # not unicode
 
190
    cmd = str(cmd)                      # not unicode
115
191
 
116
192
    # first look up this command under the specified name
117
193
    cmds = _get_cmd_dict(plugins_override=plugins_override)
118
194
    try:
119
 
        return cmds[cmd_name]()
 
195
        return cmd, cmds[cmd]
120
196
    except KeyError:
121
197
        pass
122
198
 
123
199
    # look for any command which claims this as an alias
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)
 
200
    for cmdname, cmdclass in cmds.iteritems():
 
201
        if cmd in cmdclass.aliases:
 
202
            return cmdname, cmdclass
 
203
 
 
204
    cmdclass = ExternalCommand.find_command(cmd)
 
205
    if cmdclass:
 
206
        return cmd, cmdclass
 
207
 
 
208
    raise BzrCommandError("unknown command %r" % cmd)
133
209
 
134
210
 
135
211
class Command(object):
136
212
    """Base class for commands.
137
213
 
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
 
 
149
214
    The docstring for an actual command should give a single-line
150
215
    summary, then a complete description of the command.  A grammar
151
216
    description will be inserted.
152
217
 
153
 
    aliases
154
 
        Other accepted names for this command.
155
 
 
156
218
    takes_args
157
219
        List of argument forms, marked with whether they are optional,
158
220
        repeated, etc.
159
221
 
160
222
    takes_options
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().
 
223
        List of options that may be given for this command.
164
224
 
165
225
    hidden
166
 
        If true, this command isn't advertised.  This is typically
167
 
        for commands intended for expert users.
 
226
        If true, this command isn't advertised.
168
227
    """
169
228
    aliases = []
 
229
    
170
230
    takes_args = []
171
231
    takes_options = []
172
232
 
173
233
    hidden = False
174
234
    
175
 
    def __init__(self):
176
 
        """Construct an instance of this command."""
 
235
    def __init__(self, options, arguments):
 
236
        """Construct and run the command.
 
237
 
 
238
        Sets self.status to the return value of run()."""
 
239
        assert isinstance(options, dict)
 
240
        assert isinstance(arguments, dict)
 
241
        cmdargs = options.copy()
 
242
        cmdargs.update(arguments)
177
243
        if self.__doc__ == Command.__doc__:
 
244
            from warnings import warn
178
245
            warn("No help message set for %r" % self)
179
 
 
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()
185
 
        r['help'] = Option.OPTIONS['help']
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
191
 
 
192
 
    def run_argv(self, argv):
193
 
        """Parse command line and run."""
194
 
        args, opts = parse_args(self, 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
199
 
        # XXX: This should be handled by the parser
200
 
        allowed_names = self.options().keys()
201
 
        for oname in opts:
202
 
            if oname not in allowed_names:
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)
 
246
        self.status = self.run(**cmdargs)
 
247
        if self.status is None:
 
248
            self.status = 0
215
249
 
216
250
    
217
251
    def run(self):
218
 
        """Actually run the command.
 
252
        """Override this in sub-classes.
219
253
 
220
254
        This is invoked with the options and arguments bound to
221
255
        keyword parameters.
222
256
 
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.
 
257
        Return 0 or None if the command was successful, or a shell
 
258
        error code if not.
226
259
        """
227
 
        raise NotImplementedError()
228
 
 
229
 
 
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
 
 
 
260
        return 0
 
261
 
 
262
 
 
263
class ExternalCommand(Command):
 
264
    """Class to wrap external commands.
 
265
 
 
266
    We cheat a little here, when get_cmd_class() calls us we actually
 
267
    give it back an object we construct that has the appropriate path,
 
268
    help, options etc for the specified command.
 
269
 
 
270
    When run_bzr() tries to instantiate that 'class' it gets caught by
 
271
    the __call__ method, which we override to call the Command.__init__
 
272
    method. That then calls our run method which is pretty straight
 
273
    forward.
 
274
 
 
275
    The only wrinkle is that we have to map bzr's dictionary of options
 
276
    and arguments back into command line options and arguments for the
 
277
    script.
 
278
    """
 
279
 
 
280
    def find_command(cls, cmd):
 
281
        import os.path
 
282
        bzrpath = os.environ.get('BZRPATH', '')
 
283
 
 
284
        for dir in bzrpath.split(os.pathsep):
 
285
            path = os.path.join(dir, cmd)
 
286
            if os.path.isfile(path):
 
287
                return ExternalCommand(path)
 
288
 
 
289
        return None
 
290
 
 
291
    find_command = classmethod(find_command)
 
292
 
 
293
    def __init__(self, path):
 
294
        self.path = path
 
295
 
 
296
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
297
        self.takes_options = pipe.readline().split()
 
298
 
 
299
        for opt in self.takes_options:
 
300
            if not opt in OPTIONS:
 
301
                raise BzrError("Unknown option '%s' returned by external command %s"
 
302
                               % (opt, path))
 
303
 
 
304
        # TODO: Is there any way to check takes_args is valid here?
 
305
        self.takes_args = pipe.readline().split()
 
306
 
 
307
        if pipe.close() is not None:
 
308
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
 
309
 
 
310
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
311
        self.__doc__ = pipe.read()
 
312
        if pipe.close() is not None:
 
313
            raise BzrError("Failed funning '%s --bzr-help'" % path)
 
314
 
 
315
    def __call__(self, options, arguments):
 
316
        Command.__init__(self, options, arguments)
 
317
        return self
 
318
 
 
319
    def run(self, **kargs):
 
320
        opts = []
 
321
        args = []
 
322
 
 
323
        keys = kargs.keys()
 
324
        keys.sort()
 
325
        for name in keys:
 
326
            optname = name.replace('_','-')
 
327
            value = kargs[name]
 
328
            if OPTIONS.has_key(optname):
 
329
                # it's an option
 
330
                opts.append('--%s' % optname)
 
331
                if value is not None and value is not True:
 
332
                    opts.append(str(value))
 
333
            else:
 
334
                # it's an arg, or arg list
 
335
                if type(value) is not list:
 
336
                    value = [value]
 
337
                for v in value:
 
338
                    if v is not None:
 
339
                        args.append(str(v))
 
340
 
 
341
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
342
        return self.status
 
343
 
 
344
 
 
345
class cmd_status(Command):
 
346
    """Display status summary.
 
347
 
 
348
    This reports on versioned and unknown files, reporting them
 
349
    grouped by state.  Possible states are:
 
350
 
 
351
    added
 
352
        Versioned in the working copy but not in the previous revision.
 
353
 
 
354
    removed
 
355
        Versioned in the previous revision but removed or deleted
 
356
        in the working copy.
 
357
 
 
358
    renamed
 
359
        Path of this file changed from the previous revision;
 
360
        the text may also have changed.  This includes files whose
 
361
        parent directory was renamed.
 
362
 
 
363
    modified
 
364
        Text has changed since the previous revision.
 
365
 
 
366
    unchanged
 
367
        Nothing about this file has changed since the previous revision.
 
368
        Only shown with --all.
 
369
 
 
370
    unknown
 
371
        Not versioned and not matching an ignore pattern.
 
372
 
 
373
    To see ignored files use 'bzr ignored'.  For details in the
 
374
    changes to file texts, use 'bzr diff'.
 
375
 
 
376
    If no arguments are specified, the status of the entire working
 
377
    directory is shown.  Otherwise, only the status of the specified
 
378
    files or directories is reported.  If a directory is given, status
 
379
    is reported for everything inside that directory.
 
380
 
 
381
    If a revision is specified, the changes since that revision are shown.
 
382
    """
 
383
    takes_args = ['file*']
 
384
    takes_options = ['all', 'show-ids', 'revision']
 
385
    aliases = ['st', 'stat']
 
386
    
 
387
    def run(self, all=False, show_ids=False, file_list=None):
 
388
        if file_list:
 
389
            b = find_branch(file_list[0])
 
390
            file_list = [b.relpath(x) for x in file_list]
 
391
            # special case: only one path was given and it's the root
 
392
            # of the branch
 
393
            if file_list == ['']:
 
394
                file_list = None
 
395
        else:
 
396
            b = find_branch('.')
 
397
            
 
398
        from bzrlib.status import show_status
 
399
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
400
                    specific_files=file_list)
 
401
 
 
402
 
 
403
class cmd_cat_revision(Command):
 
404
    """Write out metadata for a revision."""
 
405
 
 
406
    hidden = True
 
407
    takes_args = ['revision_id']
 
408
    
 
409
    def run(self, revision_id):
 
410
        from bzrlib.xml import pack_xml
 
411
        pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
 
412
 
 
413
 
 
414
class cmd_revno(Command):
 
415
    """Show current revision number.
 
416
 
 
417
    This is equal to the number of revisions on this branch."""
 
418
    def run(self):
 
419
        print find_branch('.').revno()
 
420
 
 
421
class cmd_revision_info(Command):
 
422
    """Show revision number and revision id for a given revision identifier.
 
423
    """
 
424
    hidden = True
 
425
    takes_args = ['revision_info*']
 
426
    takes_options = ['revision']
 
427
    def run(self, revision=None, revision_info_list=None):
 
428
        from bzrlib.branch import find_branch
 
429
 
 
430
        revs = []
 
431
        if revision is not None:
 
432
            revs.extend(revision)
 
433
        if revision_info_list is not None:
 
434
            revs.extend(revision_info_list)
 
435
        if len(revs) == 0:
 
436
            raise BzrCommandError('You must supply a revision identifier')
 
437
 
 
438
        b = find_branch('.')
 
439
 
 
440
        for rev in revs:
 
441
            print '%4d %s' % b.get_revision_info(rev)
 
442
 
 
443
    
 
444
class cmd_add(Command):
 
445
    """Add specified files or directories.
 
446
 
 
447
    In non-recursive mode, all the named items are added, regardless
 
448
    of whether they were previously ignored.  A warning is given if
 
449
    any of the named files are already versioned.
 
450
 
 
451
    In recursive mode (the default), files are treated the same way
 
452
    but the behaviour for directories is different.  Directories that
 
453
    are already versioned do not give a warning.  All directories,
 
454
    whether already versioned or not, are searched for files or
 
455
    subdirectories that are neither versioned or ignored, and these
 
456
    are added.  This search proceeds recursively into versioned
 
457
    directories.  If no names are given '.' is assumed.
 
458
 
 
459
    Therefore simply saying 'bzr add' will version all files that
 
460
    are currently unknown.
 
461
 
 
462
    TODO: Perhaps adding a file whose directly is not versioned should
 
463
    recursively add that parent, rather than giving an error?
 
464
    """
 
465
    takes_args = ['file*']
 
466
    takes_options = ['verbose', 'no-recurse']
 
467
    
 
468
    def run(self, file_list, verbose=False, no_recurse=False):
 
469
        from bzrlib.add import smart_add, _PrintAddCallback
 
470
        smart_add(file_list, verbose, not no_recurse,
 
471
                  callback=_PrintAddCallback)
 
472
 
 
473
 
 
474
 
 
475
class cmd_mkdir(Command):
 
476
    """Create a new versioned directory.
 
477
 
 
478
    This is equivalent to creating the directory and then adding it.
 
479
    """
 
480
    takes_args = ['dir+']
 
481
 
 
482
    def run(self, dir_list):
 
483
        b = None
 
484
        
 
485
        for d in dir_list:
 
486
            os.mkdir(d)
 
487
            if not b:
 
488
                b = find_branch(d)
 
489
            b.add([d], verbose=True)
 
490
 
 
491
 
 
492
class cmd_relpath(Command):
 
493
    """Show path of a file relative to root"""
 
494
    takes_args = ['filename']
 
495
    hidden = True
 
496
    
 
497
    def run(self, filename):
 
498
        print find_branch(filename).relpath(filename)
 
499
 
 
500
 
 
501
 
 
502
class cmd_inventory(Command):
 
503
    """Show inventory of the current working copy or a revision."""
 
504
    takes_options = ['revision', 'show-ids']
 
505
    
 
506
    def run(self, revision=None, show_ids=False):
 
507
        b = find_branch('.')
 
508
        if revision == None:
 
509
            inv = b.read_working_inventory()
 
510
        else:
 
511
            if len(revision) > 1:
 
512
                raise BzrCommandError('bzr inventory --revision takes'
 
513
                    ' exactly one revision identifier')
 
514
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
 
515
 
 
516
        for path, entry in inv.entries():
 
517
            if show_ids:
 
518
                print '%-50s %s' % (path, entry.file_id)
 
519
            else:
 
520
                print path
 
521
 
 
522
 
 
523
class cmd_move(Command):
 
524
    """Move files to a different directory.
 
525
 
 
526
    examples:
 
527
        bzr move *.txt doc
 
528
 
 
529
    The destination must be a versioned directory in the same branch.
 
530
    """
 
531
    takes_args = ['source$', 'dest']
 
532
    def run(self, source_list, dest):
 
533
        b = find_branch('.')
 
534
 
 
535
        # TODO: glob expansion on windows?
 
536
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
537
 
 
538
 
 
539
class cmd_rename(Command):
 
540
    """Change the name of an entry.
 
541
 
 
542
    examples:
 
543
      bzr rename frob.c frobber.c
 
544
      bzr rename src/frob.c lib/frob.c
 
545
 
 
546
    It is an error if the destination name exists.
 
547
 
 
548
    See also the 'move' command, which moves files into a different
 
549
    directory without changing their name.
 
550
 
 
551
    TODO: Some way to rename multiple files without invoking bzr for each
 
552
    one?"""
 
553
    takes_args = ['from_name', 'to_name']
 
554
    
 
555
    def run(self, from_name, to_name):
 
556
        b = find_branch('.')
 
557
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
558
 
 
559
 
 
560
 
 
561
class cmd_mv(Command):
 
562
    """Move or rename a file.
 
563
 
 
564
    usage:
 
565
        bzr mv OLDNAME NEWNAME
 
566
        bzr mv SOURCE... DESTINATION
 
567
 
 
568
    If the last argument is a versioned directory, all the other names
 
569
    are moved into it.  Otherwise, there must be exactly two arguments
 
570
    and the file is changed to a new name, which must not already exist.
 
571
 
 
572
    Files cannot be moved between branches.
 
573
    """
 
574
    takes_args = ['names*']
 
575
    def run(self, names_list):
 
576
        if len(names_list) < 2:
 
577
            raise BzrCommandError("missing file argument")
 
578
        b = find_branch(names_list[0])
 
579
 
 
580
        rel_names = [b.relpath(x) for x in names_list]
 
581
        
 
582
        if os.path.isdir(names_list[-1]):
 
583
            # move into existing directory
 
584
            b.move(rel_names[:-1], rel_names[-1])
 
585
        else:
 
586
            if len(names_list) != 2:
 
587
                raise BzrCommandError('to mv multiple files the destination '
 
588
                                      'must be a versioned directory')
 
589
            b.move(rel_names[0], rel_names[1])
 
590
            
 
591
    
 
592
 
 
593
 
 
594
class cmd_pull(Command):
 
595
    """Pull any changes from another branch into the current one.
 
596
 
 
597
    If the location is omitted, the last-used location will be used.
 
598
    Both the revision history and the working directory will be
 
599
    updated.
 
600
 
 
601
    This command only works on branches that have not diverged.  Branches are
 
602
    considered diverged if both branches have had commits without first
 
603
    pulling from the other.
 
604
 
 
605
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
606
    from one into the other.
 
607
    """
 
608
    takes_args = ['location?']
 
609
 
 
610
    def run(self, location=None):
 
611
        from bzrlib.merge import merge
 
612
        import tempfile
 
613
        from shutil import rmtree
 
614
        import errno
 
615
        
 
616
        br_to = find_branch('.')
 
617
        stored_loc = None
 
618
        try:
 
619
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
620
        except IOError, e:
 
621
            if e.errno != errno.ENOENT:
 
622
                raise
 
623
        if location is None:
 
624
            if stored_loc is None:
 
625
                raise BzrCommandError("No pull location known or specified.")
 
626
            else:
 
627
                print "Using last location: %s" % stored_loc
 
628
                location = stored_loc
 
629
        cache_root = tempfile.mkdtemp()
 
630
        from bzrlib.branch import DivergedBranches
 
631
        br_from = find_branch(location)
 
632
        location = pull_loc(br_from)
 
633
        old_revno = br_to.revno()
 
634
        try:
 
635
            from branch import find_cached_branch, DivergedBranches
 
636
            br_from = find_cached_branch(location, cache_root)
 
637
            location = pull_loc(br_from)
 
638
            old_revno = br_to.revno()
 
639
            try:
 
640
                br_to.update_revisions(br_from)
 
641
            except DivergedBranches:
 
642
                raise BzrCommandError("These branches have diverged."
 
643
                    "  Try merge.")
 
644
                
 
645
            merge(('.', -1), ('.', old_revno), check_clean=False)
 
646
            if location != stored_loc:
 
647
                br_to.controlfile("x-pull", "wb").write(location + "\n")
 
648
        finally:
 
649
            rmtree(cache_root)
 
650
 
 
651
 
 
652
 
 
653
class cmd_branch(Command):
 
654
    """Create a new copy of a branch.
 
655
 
 
656
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
657
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
658
 
 
659
    To retrieve the branch as of a particular revision, supply the --revision
 
660
    parameter, as in "branch foo/bar -r 5".
 
661
    """
 
662
    takes_args = ['from_location', 'to_location?']
 
663
    takes_options = ['revision']
 
664
    aliases = ['get', 'clone']
 
665
 
 
666
    def run(self, from_location, to_location=None, revision=None):
 
667
        import errno
 
668
        from bzrlib.merge import merge
 
669
        from bzrlib.branch import DivergedBranches, \
 
670
             find_cached_branch, Branch
 
671
        from shutil import rmtree
 
672
        from meta_store import CachedStore
 
673
        import tempfile
 
674
        cache_root = tempfile.mkdtemp()
 
675
 
 
676
        if revision is None:
 
677
            revision = [None]
 
678
        elif len(revision) > 1:
 
679
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
 
680
 
 
681
        try:
 
682
            try:
 
683
                br_from = find_cached_branch(from_location, cache_root)
 
684
            except OSError, e:
 
685
                if e.errno == errno.ENOENT:
 
686
                    raise BzrCommandError('Source location "%s" does not'
 
687
                                          ' exist.' % to_location)
 
688
                else:
 
689
                    raise
 
690
 
 
691
            if to_location is None:
 
692
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
693
 
 
694
            try:
 
695
                os.mkdir(to_location)
 
696
            except OSError, e:
 
697
                if e.errno == errno.EEXIST:
 
698
                    raise BzrCommandError('Target directory "%s" already'
 
699
                                          ' exists.' % to_location)
 
700
                if e.errno == errno.ENOENT:
 
701
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
702
                                          to_location)
 
703
                else:
 
704
                    raise
 
705
            br_to = Branch(to_location, init=True)
 
706
 
 
707
            br_to.set_root_id(br_from.get_root_id())
 
708
 
 
709
            if revision:
 
710
                if revision[0] is None:
 
711
                    revno = br_from.revno()
 
712
                else:
 
713
                    revno, rev_id = br_from.get_revision_info(revision[0])
 
714
                try:
 
715
                    br_to.update_revisions(br_from, stop_revision=revno)
 
716
                except bzrlib.errors.NoSuchRevision:
 
717
                    rmtree(to_location)
 
718
                    msg = "The branch %s has no revision %d." % (from_location,
 
719
                                                                 revno)
 
720
                    raise BzrCommandError(msg)
 
721
 
 
722
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
723
                  check_clean=False, ignore_zero=True)
 
724
            from_location = pull_loc(br_from)
 
725
            br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
726
        finally:
 
727
            rmtree(cache_root)
 
728
 
 
729
 
 
730
def pull_loc(branch):
 
731
    # TODO: Should perhaps just make attribute be 'base' in
 
732
    # RemoteBranch and Branch?
 
733
    if hasattr(branch, "baseurl"):
 
734
        return branch.baseurl
 
735
    else:
 
736
        return branch.base
 
737
 
 
738
 
 
739
 
 
740
class cmd_renames(Command):
 
741
    """Show list of renamed files.
 
742
 
 
743
    TODO: Option to show renames between two historical versions.
 
744
 
 
745
    TODO: Only show renames under dir, rather than in the whole branch.
 
746
    """
 
747
    takes_args = ['dir?']
 
748
 
 
749
    def run(self, dir='.'):
 
750
        b = find_branch(dir)
 
751
        old_inv = b.basis_tree().inventory
 
752
        new_inv = b.read_working_inventory()
 
753
 
 
754
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
755
        renames.sort()
 
756
        for old_name, new_name in renames:
 
757
            print "%s => %s" % (old_name, new_name)        
 
758
 
 
759
 
 
760
class cmd_info(Command):
 
761
    """Show statistical information about a branch."""
 
762
    takes_args = ['branch?']
 
763
    
 
764
    def run(self, branch=None):
 
765
        import info
 
766
 
 
767
        b = find_branch(branch)
 
768
        info.show_info(b)
 
769
 
 
770
 
 
771
class cmd_remove(Command):
 
772
    """Make a file unversioned.
 
773
 
 
774
    This makes bzr stop tracking changes to a versioned file.  It does
 
775
    not delete the working copy.
 
776
    """
 
777
    takes_args = ['file+']
 
778
    takes_options = ['verbose']
 
779
    
 
780
    def run(self, file_list, verbose=False):
 
781
        b = find_branch(file_list[0])
 
782
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
783
 
 
784
 
 
785
class cmd_file_id(Command):
 
786
    """Print file_id of a particular file or directory.
 
787
 
 
788
    The file_id is assigned when the file is first added and remains the
 
789
    same through all revisions where the file exists, even when it is
 
790
    moved or renamed.
 
791
    """
 
792
    hidden = True
 
793
    takes_args = ['filename']
 
794
    def run(self, filename):
 
795
        b = find_branch(filename)
 
796
        i = b.inventory.path2id(b.relpath(filename))
 
797
        if i == None:
 
798
            raise BzrError("%r is not a versioned file" % filename)
 
799
        else:
 
800
            print i
 
801
 
 
802
 
 
803
class cmd_file_path(Command):
 
804
    """Print path of file_ids to a file or directory.
 
805
 
 
806
    This prints one line for each directory down to the target,
 
807
    starting at the branch root."""
 
808
    hidden = True
 
809
    takes_args = ['filename']
 
810
    def run(self, filename):
 
811
        b = find_branch(filename)
 
812
        inv = b.inventory
 
813
        fid = inv.path2id(b.relpath(filename))
 
814
        if fid == None:
 
815
            raise BzrError("%r is not a versioned file" % filename)
 
816
        for fip in inv.get_idpath(fid):
 
817
            print fip
 
818
 
 
819
 
 
820
class cmd_revision_history(Command):
 
821
    """Display list of revision ids on this branch."""
 
822
    hidden = True
 
823
    def run(self):
 
824
        for patchid in find_branch('.').revision_history():
 
825
            print patchid
 
826
 
 
827
 
 
828
class cmd_directories(Command):
 
829
    """Display list of versioned directories in this branch."""
 
830
    def run(self):
 
831
        for name, ie in find_branch('.').read_working_inventory().directories():
 
832
            if name == '':
 
833
                print '.'
 
834
            else:
 
835
                print name
 
836
 
 
837
 
 
838
class cmd_init(Command):
 
839
    """Make a directory into a versioned branch.
 
840
 
 
841
    Use this to create an empty branch, or before importing an
 
842
    existing project.
 
843
 
 
844
    Recipe for importing a tree of files:
 
845
        cd ~/project
 
846
        bzr init
 
847
        bzr add -v .
 
848
        bzr status
 
849
        bzr commit -m 'imported project'
 
850
    """
 
851
    def run(self):
 
852
        from bzrlib.branch import Branch
 
853
        Branch('.', init=True)
 
854
 
 
855
 
 
856
class cmd_diff(Command):
 
857
    """Show differences in working tree.
 
858
    
 
859
    If files are listed, only the changes in those files are listed.
 
860
    Otherwise, all changes for the tree are listed.
 
861
 
 
862
    TODO: Allow diff across branches.
 
863
 
 
864
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
865
          or a graphical diff.
 
866
 
 
867
    TODO: Python difflib is not exactly the same as unidiff; should
 
868
          either fix it up or prefer to use an external diff.
 
869
 
 
870
    TODO: If a directory is given, diff everything under that.
 
871
 
 
872
    TODO: Selected-file diff is inefficient and doesn't show you
 
873
          deleted files.
 
874
 
 
875
    TODO: This probably handles non-Unix newlines poorly.
 
876
 
 
877
    examples:
 
878
        bzr diff
 
879
        bzr diff -r1
 
880
        bzr diff -r1:2
 
881
    """
 
882
    
 
883
    takes_args = ['file*']
 
884
    takes_options = ['revision', 'diff-options']
 
885
    aliases = ['di', 'dif']
 
886
 
 
887
    def run(self, revision=None, file_list=None, diff_options=None):
 
888
        from bzrlib.diff import show_diff
 
889
 
 
890
        if file_list:
 
891
            b = find_branch(file_list[0])
 
892
            file_list = [b.relpath(f) for f in file_list]
 
893
            if file_list == ['']:
 
894
                # just pointing to top-of-tree
 
895
                file_list = None
 
896
        else:
 
897
            b = find_branch('.')
 
898
 
 
899
        if revision is not None:
 
900
            if len(revision) == 1:
 
901
                show_diff(b, revision[0], specific_files=file_list,
 
902
                          external_diff_options=diff_options)
 
903
            elif len(revision) == 2:
 
904
                show_diff(b, revision[0], specific_files=file_list,
 
905
                          external_diff_options=diff_options,
 
906
                          revision2=revision[1])
 
907
            else:
 
908
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
909
        else:
 
910
            show_diff(b, None, specific_files=file_list,
 
911
                      external_diff_options=diff_options)
 
912
 
 
913
        
 
914
 
 
915
 
 
916
class cmd_deleted(Command):
 
917
    """List files deleted in the working tree.
 
918
 
 
919
    TODO: Show files deleted since a previous revision, or between two revisions.
 
920
    """
 
921
    def run(self, show_ids=False):
 
922
        b = find_branch('.')
 
923
        old = b.basis_tree()
 
924
        new = b.working_tree()
 
925
 
 
926
        ## TODO: Much more efficient way to do this: read in new
 
927
        ## directories with readdir, rather than stating each one.  Same
 
928
        ## level of effort but possibly much less IO.  (Or possibly not,
 
929
        ## if the directories are very large...)
 
930
 
 
931
        for path, ie in old.inventory.iter_entries():
 
932
            if not new.has_id(ie.file_id):
 
933
                if show_ids:
 
934
                    print '%-50s %s' % (path, ie.file_id)
 
935
                else:
 
936
                    print path
 
937
 
 
938
 
 
939
class cmd_modified(Command):
 
940
    """List files modified in working tree."""
 
941
    hidden = True
 
942
    def run(self):
 
943
        from bzrlib.delta import compare_trees
 
944
 
 
945
        b = find_branch('.')
 
946
        td = compare_trees(b.basis_tree(), b.working_tree())
 
947
 
 
948
        for path, id, kind in td.modified:
 
949
            print path
 
950
 
 
951
 
 
952
 
 
953
class cmd_added(Command):
 
954
    """List files added in working tree."""
 
955
    hidden = True
 
956
    def run(self):
 
957
        b = find_branch('.')
 
958
        wt = b.working_tree()
 
959
        basis_inv = b.basis_tree().inventory
 
960
        inv = wt.inventory
 
961
        for file_id in inv:
 
962
            if file_id in basis_inv:
 
963
                continue
 
964
            path = inv.id2path(file_id)
 
965
            if not os.access(b.abspath(path), os.F_OK):
 
966
                continue
 
967
            print path
 
968
                
 
969
        
 
970
 
 
971
class cmd_root(Command):
 
972
    """Show the tree root directory.
 
973
 
 
974
    The root is the nearest enclosing directory with a .bzr control
 
975
    directory."""
 
976
    takes_args = ['filename?']
 
977
    def run(self, filename=None):
 
978
        """Print the branch root."""
 
979
        b = find_branch(filename)
 
980
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
981
 
 
982
 
 
983
class cmd_log(Command):
 
984
    """Show log of this branch.
 
985
 
 
986
    To request a range of logs, you can use the command -r begin:end
 
987
    -r revision requests a specific revision, -r :end or -r begin: are
 
988
    also valid.
 
989
 
 
990
    --message allows you to give a regular expression, which will be evaluated
 
991
    so that only matching entries will be displayed.
 
992
 
 
993
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
994
  
 
995
    """
 
996
 
 
997
    takes_args = ['filename?']
 
998
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
 
999
                     'long', 'message', 'short',]
 
1000
    
 
1001
    def run(self, filename=None, timezone='original',
 
1002
            verbose=False,
 
1003
            show_ids=False,
 
1004
            forward=False,
 
1005
            revision=None,
 
1006
            message=None,
 
1007
            long=False,
 
1008
            short=False):
 
1009
        from bzrlib.branch import find_branch
 
1010
        from bzrlib.log import log_formatter, show_log
 
1011
        import codecs
 
1012
 
 
1013
        direction = (forward and 'forward') or 'reverse'
 
1014
        
 
1015
        if filename:
 
1016
            b = find_branch(filename)
 
1017
            fp = b.relpath(filename)
 
1018
            if fp:
 
1019
                file_id = b.read_working_inventory().path2id(fp)
 
1020
            else:
 
1021
                file_id = None  # points to branch root
 
1022
        else:
 
1023
            b = find_branch('.')
 
1024
            file_id = None
 
1025
 
 
1026
        if revision is None:
 
1027
            rev1 = None
 
1028
            rev2 = None
 
1029
        elif len(revision) == 1:
 
1030
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
 
1031
        elif len(revision) == 2:
 
1032
            rev1 = b.get_revision_info(revision[0])[0]
 
1033
            rev2 = b.get_revision_info(revision[1])[0]
 
1034
        else:
 
1035
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
1036
 
 
1037
        if rev1 == 0:
 
1038
            rev1 = None
 
1039
        if rev2 == 0:
 
1040
            rev2 = None
 
1041
 
 
1042
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
1043
 
 
1044
        # use 'replace' so that we don't abort if trying to write out
 
1045
        # in e.g. the default C locale.
 
1046
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1047
 
 
1048
        if not short:
 
1049
            log_format = 'long'
 
1050
        else:
 
1051
            log_format = 'short'
 
1052
        lf = log_formatter(log_format,
 
1053
                           show_ids=show_ids,
 
1054
                           to_file=outf,
 
1055
                           show_timezone=timezone)
 
1056
 
 
1057
        show_log(b,
 
1058
                 lf,
 
1059
                 file_id,
 
1060
                 verbose=verbose,
 
1061
                 direction=direction,
 
1062
                 start_revision=rev1,
 
1063
                 end_revision=rev2,
 
1064
                 search=message)
 
1065
 
 
1066
 
 
1067
 
 
1068
class cmd_touching_revisions(Command):
 
1069
    """Return revision-ids which affected a particular file.
 
1070
 
 
1071
    A more user-friendly interface is "bzr log FILE"."""
 
1072
    hidden = True
 
1073
    takes_args = ["filename"]
 
1074
    def run(self, filename):
 
1075
        b = find_branch(filename)
 
1076
        inv = b.read_working_inventory()
 
1077
        file_id = inv.path2id(b.relpath(filename))
 
1078
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
1079
            print "%6d %s" % (revno, what)
 
1080
 
 
1081
 
 
1082
class cmd_ls(Command):
 
1083
    """List files in a tree.
 
1084
 
 
1085
    TODO: Take a revision or remote path and list that tree instead.
 
1086
    """
 
1087
    hidden = True
 
1088
    def run(self, revision=None, verbose=False):
 
1089
        b = find_branch('.')
 
1090
        if revision == None:
 
1091
            tree = b.working_tree()
 
1092
        else:
 
1093
            tree = b.revision_tree(b.lookup_revision(revision))
 
1094
 
 
1095
        for fp, fc, kind, fid in tree.list_files():
 
1096
            if verbose:
 
1097
                if kind == 'directory':
 
1098
                    kindch = '/'
 
1099
                elif kind == 'file':
 
1100
                    kindch = ''
 
1101
                else:
 
1102
                    kindch = '???'
 
1103
 
 
1104
                print '%-8s %s%s' % (fc, fp, kindch)
 
1105
            else:
 
1106
                print fp
 
1107
 
 
1108
 
 
1109
 
 
1110
class cmd_unknowns(Command):
 
1111
    """List unknown files."""
 
1112
    def run(self):
 
1113
        from bzrlib.osutils import quotefn
 
1114
        for f in find_branch('.').unknowns():
 
1115
            print quotefn(f)
 
1116
 
 
1117
 
 
1118
 
 
1119
class cmd_ignore(Command):
 
1120
    """Ignore a command or pattern.
 
1121
 
 
1122
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1123
 
 
1124
    If the pattern contains a slash, it is compared to the whole path
 
1125
    from the branch root.  Otherwise, it is comapred to only the last
 
1126
    component of the path.
 
1127
 
 
1128
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1129
 
 
1130
    Note: wildcards must be quoted from the shell on Unix.
 
1131
 
 
1132
    examples:
 
1133
        bzr ignore ./Makefile
 
1134
        bzr ignore '*.class'
 
1135
    """
 
1136
    takes_args = ['name_pattern']
 
1137
    
 
1138
    def run(self, name_pattern):
 
1139
        from bzrlib.atomicfile import AtomicFile
 
1140
        import os.path
 
1141
 
 
1142
        b = find_branch('.')
 
1143
        ifn = b.abspath('.bzrignore')
 
1144
 
 
1145
        if os.path.exists(ifn):
 
1146
            f = open(ifn, 'rt')
 
1147
            try:
 
1148
                igns = f.read().decode('utf-8')
 
1149
            finally:
 
1150
                f.close()
 
1151
        else:
 
1152
            igns = ''
 
1153
 
 
1154
        # TODO: If the file already uses crlf-style termination, maybe
 
1155
        # we should use that for the newly added lines?
 
1156
 
 
1157
        if igns and igns[-1] != '\n':
 
1158
            igns += '\n'
 
1159
        igns += name_pattern + '\n'
 
1160
 
 
1161
        try:
 
1162
            f = AtomicFile(ifn, 'wt')
 
1163
            f.write(igns.encode('utf-8'))
 
1164
            f.commit()
 
1165
        finally:
 
1166
            f.close()
 
1167
 
 
1168
        inv = b.working_tree().inventory
 
1169
        if inv.path2id('.bzrignore'):
 
1170
            mutter('.bzrignore is already versioned')
 
1171
        else:
 
1172
            mutter('need to make new .bzrignore file versioned')
 
1173
            b.add(['.bzrignore'])
 
1174
 
 
1175
 
 
1176
 
 
1177
class cmd_ignored(Command):
 
1178
    """List ignored files and the patterns that matched them.
 
1179
 
 
1180
    See also: bzr ignore"""
 
1181
    def run(self):
 
1182
        tree = find_branch('.').working_tree()
 
1183
        for path, file_class, kind, file_id in tree.list_files():
 
1184
            if file_class != 'I':
 
1185
                continue
 
1186
            ## XXX: Slightly inefficient since this was already calculated
 
1187
            pat = tree.is_ignored(path)
 
1188
            print '%-50s %s' % (path, pat)
 
1189
 
 
1190
 
 
1191
class cmd_lookup_revision(Command):
 
1192
    """Lookup the revision-id from a revision-number
 
1193
 
 
1194
    example:
 
1195
        bzr lookup-revision 33
 
1196
    """
 
1197
    hidden = True
 
1198
    takes_args = ['revno']
 
1199
    
 
1200
    def run(self, revno):
 
1201
        try:
 
1202
            revno = int(revno)
 
1203
        except ValueError:
 
1204
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1205
 
 
1206
        print find_branch('.').lookup_revision(revno)
 
1207
 
 
1208
 
 
1209
class cmd_export(Command):
 
1210
    """Export past revision to destination directory.
 
1211
 
 
1212
    If no revision is specified this exports the last committed revision.
 
1213
 
 
1214
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1215
    given, try to find the format with the extension. If no extension
 
1216
    is found exports to a directory (equivalent to --format=dir).
 
1217
 
 
1218
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1219
    is given, the top directory will be the root name of the file."""
 
1220
    # TODO: list known exporters
 
1221
    takes_args = ['dest']
 
1222
    takes_options = ['revision', 'format', 'root']
 
1223
    def run(self, dest, revision=None, format=None, root=None):
 
1224
        import os.path
 
1225
        b = find_branch('.')
 
1226
        if revision is None:
 
1227
            rev_id = b.last_patch()
 
1228
        else:
 
1229
            if len(revision) != 1:
 
1230
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1231
            revno, rev_id = b.get_revision_info(revision[0])
 
1232
        t = b.revision_tree(rev_id)
 
1233
        root, ext = os.path.splitext(dest)
 
1234
        if not format:
 
1235
            if ext in (".tar",):
 
1236
                format = "tar"
 
1237
            elif ext in (".gz", ".tgz"):
 
1238
                format = "tgz"
 
1239
            elif ext in (".bz2", ".tbz2"):
 
1240
                format = "tbz2"
 
1241
            else:
 
1242
                format = "dir"
 
1243
        t.export(dest, format, root)
 
1244
 
 
1245
 
 
1246
class cmd_cat(Command):
 
1247
    """Write a file's text from a previous revision."""
 
1248
 
 
1249
    takes_options = ['revision']
 
1250
    takes_args = ['filename']
 
1251
 
 
1252
    def run(self, filename, revision=None):
 
1253
        if revision == None:
 
1254
            raise BzrCommandError("bzr cat requires a revision number")
 
1255
        elif len(revision) != 1:
 
1256
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1257
        b = find_branch('.')
 
1258
        b.print_file(b.relpath(filename), revision[0])
 
1259
 
 
1260
 
 
1261
class cmd_local_time_offset(Command):
 
1262
    """Show the offset in seconds from GMT to local time."""
 
1263
    hidden = True    
 
1264
    def run(self):
 
1265
        print bzrlib.osutils.local_time_offset()
 
1266
 
 
1267
 
 
1268
 
 
1269
class cmd_commit(Command):
 
1270
    """Commit changes into a new revision.
 
1271
    
 
1272
    If no arguments are given, the entire tree is committed.
 
1273
 
 
1274
    If selected files are specified, only changes to those files are
 
1275
    committed.  If a directory is specified then the directory and everything 
 
1276
    within it is committed.
 
1277
 
 
1278
    A selected-file commit may fail in some cases where the committed
 
1279
    tree would be invalid, such as trying to commit a file in a
 
1280
    newly-added directory that is not itself committed.
 
1281
 
 
1282
    TODO: Run hooks on tree to-be-committed, and after commit.
 
1283
 
 
1284
    TODO: Strict commit that fails if there are unknown or deleted files.
 
1285
    """
 
1286
    takes_args = ['selected*']
 
1287
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
1288
    aliases = ['ci', 'checkin']
 
1289
 
 
1290
    # TODO: Give better message for -s, --summary, used by tla people
 
1291
    
 
1292
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1293
            unchanged=False):
 
1294
        from bzrlib.errors import PointlessCommit
 
1295
        from bzrlib.osutils import get_text_message
 
1296
 
 
1297
        ## Warning: shadows builtin file()
 
1298
        if not message and not file:
 
1299
            # FIXME: Ugly; change status code to send to a provided function?
 
1300
            
 
1301
            import cStringIO
 
1302
            stdout = sys.stdout
 
1303
            catcher = cStringIO.StringIO()
 
1304
            sys.stdout = catcher
 
1305
            cmd_status({"file_list":selected_list}, {})
 
1306
            info = catcher.getvalue()
 
1307
            sys.stdout = stdout
 
1308
            message = get_text_message(info)
 
1309
            
 
1310
            if message is None:
 
1311
                raise BzrCommandError("please specify a commit message",
 
1312
                                      ["use either --message or --file"])
 
1313
        elif message and file:
 
1314
            raise BzrCommandError("please specify either --message or --file")
 
1315
        
 
1316
        if file:
 
1317
            import codecs
 
1318
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1319
 
 
1320
        b = find_branch('.')
 
1321
        if selected_list:
 
1322
            selected_list = [b.relpath(s) for s in selected_list]
 
1323
            
 
1324
        try:
 
1325
            b.commit(message, verbose=verbose,
 
1326
                     specific_files=selected_list,
 
1327
                     allow_pointless=unchanged)
 
1328
        except PointlessCommit:
 
1329
            # FIXME: This should really happen before the file is read in;
 
1330
            # perhaps prepare the commit; get the message; then actually commit
 
1331
            raise BzrCommandError("no changes to commit",
 
1332
                                  ["use --unchanged to commit anyhow"])
 
1333
 
 
1334
 
 
1335
class cmd_check(Command):
 
1336
    """Validate consistency of branch history.
 
1337
 
 
1338
    This command checks various invariants about the branch storage to
 
1339
    detect data corruption or bzr bugs.
 
1340
 
 
1341
    If given the --update flag, it will update some optional fields
 
1342
    to help ensure data consistency.
 
1343
    """
 
1344
    takes_args = ['dir?']
 
1345
 
 
1346
    def run(self, dir='.'):
 
1347
        from bzrlib.check import check
 
1348
 
 
1349
        check(find_branch(dir))
 
1350
 
 
1351
 
 
1352
class cmd_scan_cache(Command):
 
1353
    hidden = True
 
1354
    def run(self):
 
1355
        from bzrlib.hashcache import HashCache
 
1356
        import os
 
1357
 
 
1358
        c = HashCache('.')
 
1359
        c.read()
 
1360
        c.scan()
 
1361
            
 
1362
        print '%6d stats' % c.stat_count
 
1363
        print '%6d in hashcache' % len(c._cache)
 
1364
        print '%6d files removed from cache' % c.removed_count
 
1365
        print '%6d hashes updated' % c.update_count
 
1366
        print '%6d files changed too recently to cache' % c.danger_count
 
1367
 
 
1368
        if c.needs_write:
 
1369
            c.write()
 
1370
            
 
1371
 
 
1372
 
 
1373
class cmd_upgrade(Command):
 
1374
    """Upgrade branch storage to current format.
 
1375
 
 
1376
    This should normally be used only after the check command tells
 
1377
    you to run it.
 
1378
    """
 
1379
    takes_args = ['dir?']
 
1380
 
 
1381
    def run(self, dir='.'):
 
1382
        from bzrlib.upgrade import upgrade
 
1383
        upgrade(find_branch(dir))
 
1384
 
 
1385
 
 
1386
 
 
1387
class cmd_whoami(Command):
 
1388
    """Show bzr user id."""
 
1389
    takes_options = ['email']
 
1390
    
 
1391
    def run(self, email=False):
 
1392
        try:
 
1393
            b = bzrlib.branch.find_branch('.')
 
1394
        except:
 
1395
            b = None
 
1396
        
 
1397
        if email:
 
1398
            print bzrlib.osutils.user_email(b)
 
1399
        else:
 
1400
            print bzrlib.osutils.username(b)
 
1401
 
 
1402
 
 
1403
class cmd_selftest(Command):
 
1404
    """Run internal test suite"""
 
1405
    hidden = True
 
1406
    takes_options = ['verbose', 'pattern']
 
1407
    def run(self, verbose=False, pattern=".*"):
 
1408
        import bzrlib.ui
 
1409
        from bzrlib.selftest import selftest
 
1410
        # we don't want progress meters from the tests to go to the
 
1411
        # real output.
 
1412
        save_ui = bzrlib.ui.ui_factory
 
1413
        try:
 
1414
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1415
            return int(not selftest(verbose=verbose, pattern=pattern))
 
1416
        finally:
 
1417
            bzrlib.ui.ui_factory = save_ui
 
1418
 
 
1419
 
 
1420
class cmd_version(Command):
 
1421
    """Show version of bzr."""
 
1422
    def run(self):
 
1423
        show_version()
 
1424
 
 
1425
def show_version():
 
1426
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1427
    # is bzrlib itself in a branch?
 
1428
    bzrrev = bzrlib.get_bzr_revision()
 
1429
    if bzrrev:
 
1430
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1431
    print bzrlib.__copyright__
 
1432
    print "http://bazaar-ng.org/"
 
1433
    print
 
1434
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1435
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1436
    print "General Public License version 2 or later."
 
1437
 
 
1438
 
 
1439
class cmd_rocks(Command):
 
1440
    """Statement of optimism."""
 
1441
    hidden = True
 
1442
    def run(self):
 
1443
        print "it sure does!"
239
1444
 
240
1445
def parse_spec(spec):
241
1446
    """
268
1473
        parsed = [spec, None]
269
1474
    return parsed
270
1475
 
271
 
def parse_args(command, argv):
 
1476
 
 
1477
 
 
1478
class cmd_merge(Command):
 
1479
    """Perform a three-way merge.
 
1480
    
 
1481
    The branch is the branch you will merge from.  By default, it will merge
 
1482
    the latest revision.  If you specify a revision, that revision will be
 
1483
    merged.  If you specify two revisions, the first will be used as a BASE, 
 
1484
    and the second one as OTHER.  Revision numbers are always relative to the
 
1485
    specified branch.
 
1486
    
 
1487
    Examples:
 
1488
 
 
1489
    To merge the latest revision from bzr.dev
 
1490
    bzr merge ../bzr.dev
 
1491
 
 
1492
    To merge changes up to and including revision 82 from bzr.dev
 
1493
    bzr merge -r 82 ../bzr.dev
 
1494
 
 
1495
    To merge the changes introduced by 82, without previous changes:
 
1496
    bzr merge -r 81..82 ../bzr.dev
 
1497
    
 
1498
    merge refuses to run if there are any uncommitted changes, unless
 
1499
    --force is given.
 
1500
    """
 
1501
    takes_args = ['branch?']
 
1502
    takes_options = ['revision', 'force', 'merge-type']
 
1503
 
 
1504
    def run(self, branch='.', revision=None, force=False, 
 
1505
            merge_type=None):
 
1506
        from bzrlib.merge import merge
 
1507
        from bzrlib.merge_core import ApplyMerge3
 
1508
        if merge_type is None:
 
1509
            merge_type = ApplyMerge3
 
1510
 
 
1511
        if revision is None or len(revision) < 1:
 
1512
            base = (None, None)
 
1513
            other = (branch, -1)
 
1514
        else:
 
1515
            if len(revision) == 1:
 
1516
                other = (branch, revision[0])
 
1517
                base = (None, None)
 
1518
            else:
 
1519
                assert len(revision) == 2
 
1520
                if None in revision:
 
1521
                    raise BzrCommandError(
 
1522
                        "Merge doesn't permit that revision specifier.")
 
1523
                base = (branch, revision[0])
 
1524
                other = (branch, revision[1])
 
1525
            
 
1526
        merge(other, base, check_clean=(not force), merge_type=merge_type)
 
1527
 
 
1528
 
 
1529
class cmd_revert(Command):
 
1530
    """Reverse all changes since the last commit.
 
1531
 
 
1532
    Only versioned files are affected.  Specify filenames to revert only 
 
1533
    those files.  By default, any files that are changed will be backed up
 
1534
    first.  Backup files have a '~' appended to their name.
 
1535
    """
 
1536
    takes_options = ['revision', 'no-backup']
 
1537
    takes_args = ['file*']
 
1538
    aliases = ['merge-revert']
 
1539
 
 
1540
    def run(self, revision=None, no_backup=False, file_list=None):
 
1541
        from bzrlib.merge import merge
 
1542
        if file_list is not None:
 
1543
            if len(file_list) == 0:
 
1544
                raise BzrCommandError("No files specified")
 
1545
        if revision is None:
 
1546
            revision = [-1]
 
1547
        elif len(revision) != 1:
 
1548
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1549
        merge(('.', revision[0]), parse_spec('.'),
 
1550
              check_clean=False,
 
1551
              ignore_zero=True,
 
1552
              backup_files=not no_backup,
 
1553
              file_list=file_list)
 
1554
 
 
1555
 
 
1556
class cmd_assert_fail(Command):
 
1557
    """Test reporting of assertion failures"""
 
1558
    hidden = True
 
1559
    def run(self):
 
1560
        assert False, "always fails"
 
1561
 
 
1562
 
 
1563
class cmd_help(Command):
 
1564
    """Show help on a command or other topic.
 
1565
 
 
1566
    For a list of all available commands, say 'bzr help commands'."""
 
1567
    takes_args = ['topic?']
 
1568
    aliases = ['?']
 
1569
    
 
1570
    def run(self, topic=None):
 
1571
        import help
 
1572
        help.help(topic)
 
1573
 
 
1574
 
 
1575
class cmd_shell_complete(Command):
 
1576
    """Show appropriate completions for context.
 
1577
 
 
1578
    For a list of all available commands, say 'bzr shell-complete'."""
 
1579
    takes_args = ['context?']
 
1580
    aliases = ['s-c']
 
1581
    hidden = True
 
1582
    
 
1583
    def run(self, context=None):
 
1584
        import shellcomplete
 
1585
        shellcomplete.shellcomplete(context)
 
1586
 
 
1587
 
 
1588
class cmd_missing(Command):
 
1589
    """What is missing in this branch relative to other branch.
 
1590
    """
 
1591
    takes_args = ['remote?']
 
1592
    aliases = ['mis', 'miss']
 
1593
    # We don't have to add quiet to the list, because 
 
1594
    # unknown options are parsed as booleans
 
1595
    takes_options = ['verbose', 'quiet']
 
1596
 
 
1597
    def run(self, remote=None, verbose=False, quiet=False):
 
1598
        from bzrlib.branch import find_branch, DivergedBranches
 
1599
        from bzrlib.errors import BzrCommandError
 
1600
        from bzrlib.missing import get_parent, show_missing
 
1601
 
 
1602
        if verbose and quiet:
 
1603
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
1604
 
 
1605
        b = find_branch('.')
 
1606
        parent = get_parent(b)
 
1607
        if remote is None:
 
1608
            if parent is None:
 
1609
                raise BzrCommandError("No missing location known or specified.")
 
1610
            else:
 
1611
                if not quiet:
 
1612
                    print "Using last location: %s" % parent
 
1613
                remote = parent
 
1614
        elif parent is None:
 
1615
            # We only update x-pull if it did not exist, missing should not change the parent
 
1616
            b.controlfile('x-pull', 'wb').write(remote + '\n')
 
1617
        br_remote = find_branch(remote)
 
1618
 
 
1619
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
1620
 
 
1621
 
 
1622
 
 
1623
class cmd_plugins(Command):
 
1624
    """List plugins"""
 
1625
    hidden = True
 
1626
    def run(self):
 
1627
        import bzrlib.plugin
 
1628
        from inspect import getdoc
 
1629
        from pprint import pprint
 
1630
        for plugin in bzrlib.plugin.all_plugins:
 
1631
            print plugin.__path__[0]
 
1632
            d = getdoc(plugin)
 
1633
            if d:
 
1634
                print '\t', d.split('\n')[0]
 
1635
 
 
1636
        #pprint(bzrlib.plugin.all_plugins)
 
1637
 
 
1638
 
 
1639
 
 
1640
# list of all available options; the rhs can be either None for an
 
1641
# option that takes no argument, or a constructor function that checks
 
1642
# the type.
 
1643
OPTIONS = {
 
1644
    'all':                    None,
 
1645
    'diff-options':           str,
 
1646
    'help':                   None,
 
1647
    'file':                   unicode,
 
1648
    'force':                  None,
 
1649
    'format':                 unicode,
 
1650
    'forward':                None,
 
1651
    'message':                unicode,
 
1652
    'no-recurse':             None,
 
1653
    'profile':                None,
 
1654
    'revision':               _parse_revision_str,
 
1655
    'short':                  None,
 
1656
    'show-ids':               None,
 
1657
    'timezone':               str,
 
1658
    'verbose':                None,
 
1659
    'version':                None,
 
1660
    'email':                  None,
 
1661
    'unchanged':              None,
 
1662
    'update':                 None,
 
1663
    'long':                   None,
 
1664
    'root':                   str,
 
1665
    'no-backup':              None,
 
1666
    'merge-type':             get_merge_type,
 
1667
    'pattern':                str,
 
1668
    }
 
1669
 
 
1670
SHORT_OPTIONS = {
 
1671
    'F':                      'file', 
 
1672
    'h':                      'help',
 
1673
    'm':                      'message',
 
1674
    'r':                      'revision',
 
1675
    'v':                      'verbose',
 
1676
    'l':                      'long',
 
1677
}
 
1678
 
 
1679
 
 
1680
def parse_args(argv):
272
1681
    """Parse command line.
273
1682
    
274
1683
    Arguments and options are parsed at this level before being passed
275
1684
    down to specific command handlers.  This routine knows, from a
276
1685
    lookup table, something about the available options, what optargs
277
1686
    they take, and which commands will accept them.
 
1687
 
 
1688
    >>> parse_args('--help'.split())
 
1689
    ([], {'help': True})
 
1690
    >>> parse_args('--version'.split())
 
1691
    ([], {'version': True})
 
1692
    >>> parse_args('status --all'.split())
 
1693
    (['status'], {'all': True})
 
1694
    >>> parse_args('commit --message=biter'.split())
 
1695
    (['commit'], {'message': u'biter'})
 
1696
    >>> parse_args('log -r 500'.split())
 
1697
    (['log'], {'revision': [500]})
 
1698
    >>> parse_args('log -r500..600'.split())
 
1699
    (['log'], {'revision': [500, 600]})
 
1700
    >>> parse_args('log -vr500..600'.split())
 
1701
    (['log'], {'verbose': True, 'revision': [500, 600]})
 
1702
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
 
1703
    (['log'], {'revision': ['v500', 600]})
278
1704
    """
279
 
    # TODO: chop up this beast; make it a method of the Command
280
1705
    args = []
281
1706
    opts = {}
282
1707
 
283
 
    cmd_options = command.options()
284
 
    argsover = False
 
1708
    # TODO: Maybe handle '--' to end options?
 
1709
 
285
1710
    while argv:
286
1711
        a = argv.pop(0)
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
1712
        if a[0] == '-':
295
1713
            # option names must not be unicode
296
1714
            a = str(a)
301
1719
                    optname, optarg = a[2:].split('=', 1)
302
1720
                else:
303
1721
                    optname = a[2:]
304
 
                if optname not in cmd_options:
305
 
                    raise BzrCommandError('unknown long option %r for command %s' 
306
 
                            % (a, command.name))
 
1722
                if optname not in OPTIONS:
 
1723
                    raise BzrError('unknown long option %r' % a)
307
1724
            else:
308
1725
                shortopt = a[1:]
309
 
                if shortopt in Option.SHORT_OPTIONS:
 
1726
                if shortopt in SHORT_OPTIONS:
310
1727
                    # Multi-character options must have a space to delimit
311
1728
                    # their value
312
 
                    # ^^^ what does this mean? mbp 20051014
313
 
                    optname = Option.SHORT_OPTIONS[shortopt].name
 
1729
                    optname = SHORT_OPTIONS[shortopt]
314
1730
                else:
315
1731
                    # Single character short options, can be chained,
316
1732
                    # and have their value appended to their name
317
1733
                    shortopt = a[1:2]
318
 
                    if shortopt not in Option.SHORT_OPTIONS:
 
1734
                    if shortopt not in SHORT_OPTIONS:
319
1735
                        # We didn't find the multi-character name, and we
320
1736
                        # didn't find the single char name
321
1737
                        raise BzrError('unknown short option %r' % a)
322
 
                    optname = Option.SHORT_OPTIONS[shortopt].name
 
1738
                    optname = SHORT_OPTIONS[shortopt]
323
1739
 
324
1740
                    if a[2:]:
325
1741
                        # There are extra things on this option
326
1742
                        # see if it is the value, or if it is another
327
1743
                        # short option
328
 
                        optargfn = Option.OPTIONS[optname].type
 
1744
                        optargfn = OPTIONS[optname]
329
1745
                        if optargfn is None:
330
1746
                            # This option does not take an argument, so the
331
1747
                            # next entry is another short option, pack it back
340
1756
                # XXX: Do we ever want to support this, e.g. for -r?
341
1757
                raise BzrError('repeated option %r' % a)
342
1758
                
343
 
            option_obj = cmd_options[optname]
344
 
            optargfn = option_obj.type
 
1759
            optargfn = OPTIONS[optname]
345
1760
            if optargfn:
346
1761
                if optarg == None:
347
1762
                    if not argv:
355
1770
                opts[optname] = True
356
1771
        else:
357
1772
            args.append(a)
 
1773
 
358
1774
    return args, opts
359
1775
 
360
1776
 
 
1777
 
 
1778
 
361
1779
def _match_argform(cmd, takes_args, args):
362
1780
    argdict = {}
363
1781
 
403
1821
 
404
1822
 
405
1823
 
406
 
def apply_profiled(the_callable, *args, **kwargs):
407
 
    import hotshot
408
 
    import tempfile
409
 
    import hotshot.stats
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)
418
 
        stats.strip_dirs()
419
 
        stats.sort_stats('cum')   # 'time'
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
 
 
429
1824
def run_bzr(argv):
430
1825
    """Execute a command.
431
1826
 
450
1845
    --profile
451
1846
        Run under the Python profiler.
452
1847
    """
453
 
    import bzrlib.transport
454
 
    bzrlib.transport.register_builtin_transports()
455
1848
    
456
1849
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
457
1850
 
461
1854
    # to load plugins before doing other command parsing so that they
462
1855
    # can override commands, but this needs to happen first.
463
1856
 
464
 
    for a in argv:
 
1857
    for a in argv[:]:
465
1858
        if a == '--profile':
466
1859
            opt_profile = True
467
1860
        elif a == '--no-plugins':
472
1865
            break
473
1866
        argv.remove(a)
474
1867
 
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
 
        
488
1868
    if not opt_no_plugins:
489
1869
        from bzrlib.plugin import load_plugins
490
1870
        load_plugins()
491
1871
 
492
 
    cmd = str(argv.pop(0))
493
 
 
494
 
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
1872
    args, opts = parse_args(argv)
 
1873
 
 
1874
    if 'help' in opts:
 
1875
        from bzrlib.help import help
 
1876
        if args:
 
1877
            help(args[0])
 
1878
        else:
 
1879
            help()
 
1880
        return 0            
 
1881
        
 
1882
    if 'version' in opts:
 
1883
        show_version()
 
1884
        return 0
 
1885
    
 
1886
    if not args:
 
1887
        from bzrlib.help import help
 
1888
        help(None)
 
1889
        return 0
 
1890
    
 
1891
    cmd = str(args.pop(0))
 
1892
 
 
1893
    canonical_cmd, cmd_class = \
 
1894
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
 
1895
 
 
1896
    # check options are reasonable
 
1897
    allowed = cmd_class.takes_options
 
1898
    for oname in opts:
 
1899
        if oname not in allowed:
 
1900
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1901
                                  % (oname, cmd))
 
1902
 
 
1903
    # mix arguments and options into one dictionary
 
1904
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1905
    cmdopts = {}
 
1906
    for k, v in opts.items():
 
1907
        cmdopts[k.replace('-', '_')] = v
495
1908
 
496
1909
    if opt_profile:
497
 
        ret = apply_profiled(cmd_obj.run_argv, argv)
 
1910
        import hotshot, tempfile
 
1911
        pffileno, pfname = tempfile.mkstemp()
 
1912
        try:
 
1913
            prof = hotshot.Profile(pfname)
 
1914
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1915
            prof.close()
 
1916
 
 
1917
            import hotshot.stats
 
1918
            stats = hotshot.stats.load(pfname)
 
1919
            #stats.strip_dirs()
 
1920
            stats.sort_stats('time')
 
1921
            ## XXX: Might like to write to stderr or the trace file instead but
 
1922
            ## print_stats seems hardcoded to stdout
 
1923
            stats.print_stats(20)
 
1924
            
 
1925
            return ret.status
 
1926
 
 
1927
        finally:
 
1928
            os.close(pffileno)
 
1929
            os.remove(pfname)
498
1930
    else:
499
 
        ret = cmd_obj.run_argv(argv)
500
 
    return ret or 0
 
1931
        return cmd_class(cmdopts, cmdargs).status 
 
1932
 
 
1933
 
 
1934
def _report_exception(summary, quiet=False):
 
1935
    import traceback
 
1936
    
 
1937
    log_error('bzr: ' + summary)
 
1938
 
 
1939
    if not quiet:
 
1940
        sys.stderr.write('\n')
 
1941
        tb = sys.exc_info()[2]
 
1942
        exinfo = traceback.extract_tb(tb)
 
1943
        if exinfo:
 
1944
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1945
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1946
 
501
1947
 
502
1948
 
503
1949
def main(argv):
504
1950
    import bzrlib.ui
505
 
    bzrlib.trace.log_startup(argv)
 
1951
    
 
1952
    bzrlib.trace.open_tracefile(argv)
 
1953
 
506
1954
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
507
1955
 
508
 
    return run_bzr_catch_errors(argv[1:])
509
 
 
510
 
 
511
 
def run_bzr_catch_errors(argv):
512
1956
    try:
513
1957
        try:
514
 
            return run_bzr(argv)
 
1958
            return run_bzr(argv[1:])
515
1959
        finally:
516
1960
            # do this here inside the exception wrappers to catch EPIPE
517
1961
            sys.stdout.flush()
526
1970
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
527
1971
        return 3
528
1972
    except KeyboardInterrupt, e:
529
 
        bzrlib.trace.log_exception('interrupted')
 
1973
        bzrlib.trace.note('interrupted')
530
1974
        return 2
531
1975
    except Exception, e:
532
1976
        import errno
536
1980
            bzrlib.trace.note('broken pipe')
537
1981
            return 2
538
1982
        else:
539
 
            ## import pdb
540
 
            ## pdb.pm()
541
 
            bzrlib.trace.log_exception()
 
1983
            bzrlib.trace.log_exception('terminated by exception')
542
1984
            return 2
543
1985
 
 
1986
 
544
1987
if __name__ == '__main__':
545
1988
    sys.exit(main(sys.argv))