/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

https://launchpad.net/bugs/605394
Add some basic documentation in 'bzr help git'.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
 
19
 
import sys, os
20
 
 
21
 
import bzrlib
22
 
from bzrlib.trace import mutter, note, log_error
23
 
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
 
from bzrlib.osutils import quotefn
25
 
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
26
 
     format_date
27
 
 
28
 
 
29
 
def _squish_command_name(cmd):
30
 
    return 'cmd_' + cmd.replace('-', '_')
31
 
 
32
 
 
33
 
def _unsquish_command_name(cmd):
34
 
    assert cmd.startswith("cmd_")
35
 
    return cmd[4:].replace('_','-')
36
 
 
37
 
def _parse_revision_str(revstr):
38
 
    """This handles a revision string -> revno. 
39
 
 
40
 
    There are several possibilities:
41
 
 
42
 
        '234'       -> 234
43
 
        '234:345'   -> [234, 345]
44
 
        ':234'      -> [None, 234]
45
 
        '234:'      -> [234, None]
46
 
 
47
 
    In the future we will also support:
48
 
        'uuid:blah-blah-blah'   -> ?
49
 
        'hash:blahblahblah'     -> ?
50
 
        potentially:
51
 
        'tag:mytag'             -> ?
52
 
    """
53
 
    if revstr.find(':') != -1:
54
 
        revs = revstr.split(':')
55
 
        if len(revs) > 2:
56
 
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
57
 
 
58
 
        if not revs[0]:
59
 
            revs[0] = None
60
 
        else:
61
 
            revs[0] = int(revs[0])
62
 
 
63
 
        if not revs[1]:
64
 
            revs[1] = None
65
 
        else:
66
 
            revs[1] = int(revs[1])
67
 
    else:
68
 
        revs = int(revstr)
69
 
    return revs
70
 
 
71
 
def get_all_cmds():
72
 
    """Return canonical name and class for all registered commands."""
73
 
    for k, v in globals().iteritems():
74
 
        if k.startswith("cmd_"):
75
 
            yield _unsquish_command_name(k), v
76
 
 
77
 
def get_cmd_class(cmd):
78
 
    """Return the canonical name and command class for a command.
79
 
    """
80
 
    cmd = str(cmd)                      # not unicode
81
 
 
82
 
    # first look up this command under the specified name
83
 
    try:
84
 
        return cmd, globals()[_squish_command_name(cmd)]
85
 
    except KeyError:
86
 
        pass
87
 
 
88
 
    # look for any command which claims this as an alias
89
 
    for cmdname, cmdclass in get_all_cmds():
90
 
        if cmd in cmdclass.aliases:
91
 
            return cmdname, cmdclass
92
 
 
93
 
    cmdclass = ExternalCommand.find_command(cmd)
94
 
    if cmdclass:
95
 
        return cmd, cmdclass
96
 
 
97
 
    raise BzrCommandError("unknown command %r" % cmd)
98
 
 
99
 
 
100
 
class Command(object):
101
 
    """Base class for commands.
102
 
 
103
 
    The docstring for an actual command should give a single-line
104
 
    summary, then a complete description of the command.  A grammar
105
 
    description will be inserted.
106
 
 
107
 
    takes_args
108
 
        List of argument forms, marked with whether they are optional,
109
 
        repeated, etc.
110
 
 
111
 
    takes_options
112
 
        List of options that may be given for this command.
113
 
 
114
 
    hidden
115
 
        If true, this command isn't advertised.
116
 
    """
117
 
    aliases = []
118
 
    
119
 
    takes_args = []
120
 
    takes_options = []
121
 
 
122
 
    hidden = False
123
 
    
124
 
    def __init__(self, options, arguments):
125
 
        """Construct and run the command.
126
 
 
127
 
        Sets self.status to the return value of run()."""
128
 
        assert isinstance(options, dict)
129
 
        assert isinstance(arguments, dict)
130
 
        cmdargs = options.copy()
131
 
        cmdargs.update(arguments)
132
 
        assert self.__doc__ != Command.__doc__, \
133
 
               ("No help message set for %r" % self)
134
 
        self.status = self.run(**cmdargs)
135
 
 
136
 
    
137
 
    def run(self):
138
 
        """Override this in sub-classes.
139
 
 
140
 
        This is invoked with the options and arguments bound to
141
 
        keyword parameters.
142
 
 
143
 
        Return 0 or None if the command was successful, or a shell
144
 
        error code if not.
145
 
        """
146
 
        return 0
147
 
 
148
 
 
149
 
class ExternalCommand(Command):
150
 
    """Class to wrap external commands.
151
 
 
152
 
    We cheat a little here, when get_cmd_class() calls us we actually give it back
153
 
    an object we construct that has the appropriate path, help, options etc for the
154
 
    specified command.
155
 
 
156
 
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
157
 
    method, which we override to call the Command.__init__ method. That then calls
158
 
    our run method which is pretty straight forward.
159
 
 
160
 
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
161
 
    back into command line options and arguments for the script.
162
 
    """
163
 
 
164
 
    def find_command(cls, cmd):
165
 
        import os.path
166
 
        bzrpath = os.environ.get('BZRPATH', '')
167
 
 
168
 
        for dir in bzrpath.split(':'):
169
 
            path = os.path.join(dir, cmd)
170
 
            if os.path.isfile(path):
171
 
                return ExternalCommand(path)
172
 
 
173
 
        return None
174
 
 
175
 
    find_command = classmethod(find_command)
176
 
 
177
 
    def __init__(self, path):
178
 
        self.path = path
179
 
 
180
 
        # TODO: If either of these fail, we should detect that and
181
 
        # assume that path is not really a bzr plugin after all.
182
 
 
183
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
184
 
        self.takes_options = pipe.readline().split()
185
 
        self.takes_args = pipe.readline().split()
186
 
        pipe.close()
187
 
 
188
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
189
 
        self.__doc__ = pipe.read()
190
 
        pipe.close()
191
 
 
192
 
    def __call__(self, options, arguments):
193
 
        Command.__init__(self, options, arguments)
194
 
        return self
195
 
 
196
 
    def run(self, **kargs):
197
 
        opts = []
198
 
        args = []
199
 
 
200
 
        keys = kargs.keys()
201
 
        keys.sort()
202
 
        for name in keys:
203
 
            value = kargs[name]
204
 
            if OPTIONS.has_key(name):
205
 
                # it's an option
206
 
                opts.append('--%s' % name)
207
 
                if value is not None and value is not True:
208
 
                    opts.append(str(value))
209
 
            else:
210
 
                # it's an arg, or arg list
211
 
                if type(value) is not list:
212
 
                    value = [value]
213
 
                for v in value:
214
 
                    if v is not None:
215
 
                        args.append(str(v))
216
 
 
217
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
218
 
        return self.status
219
 
 
220
 
 
221
 
class cmd_status(Command):
222
 
    """Display status summary.
223
 
 
224
 
    This reports on versioned and unknown files, reporting them
225
 
    grouped by state.  Possible states are:
226
 
 
227
 
    added
228
 
        Versioned in the working copy but not in the previous revision.
229
 
 
230
 
    removed
231
 
        Versioned in the previous revision but removed or deleted
232
 
        in the working copy.
233
 
 
234
 
    renamed
235
 
        Path of this file changed from the previous revision;
236
 
        the text may also have changed.  This includes files whose
237
 
        parent directory was renamed.
238
 
 
239
 
    modified
240
 
        Text has changed since the previous revision.
241
 
 
242
 
    unchanged
243
 
        Nothing about this file has changed since the previous revision.
244
 
        Only shown with --all.
245
 
 
246
 
    unknown
247
 
        Not versioned and not matching an ignore pattern.
248
 
 
249
 
    To see ignored files use 'bzr ignored'.  For details in the
250
 
    changes to file texts, use 'bzr diff'.
251
 
 
252
 
    If no arguments are specified, the status of the entire working
253
 
    directory is shown.  Otherwise, only the status of the specified
254
 
    files or directories is reported.  If a directory is given, status
255
 
    is reported for everything inside that directory.
256
 
    """
257
 
    takes_args = ['file*']
258
 
    takes_options = ['all', 'show-ids']
259
 
    aliases = ['st', 'stat']
260
 
    
261
 
    def run(self, all=False, show_ids=False, file_list=None):
262
 
        if file_list:
263
 
            b = Branch(file_list[0])
264
 
            file_list = [b.relpath(x) for x in file_list]
265
 
            # special case: only one path was given and it's the root
266
 
            # of the branch
267
 
            if file_list == ['']:
268
 
                file_list = None
269
 
        else:
270
 
            b = Branch('.')
271
 
        import status
272
 
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
273
 
                           specific_files=file_list)
274
 
 
275
 
 
276
 
class cmd_cat_revision(Command):
277
 
    """Write out metadata for a revision."""
278
 
 
279
 
    hidden = True
280
 
    takes_args = ['revision_id']
281
 
    
282
 
    def run(self, revision_id):
283
 
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
284
 
 
285
 
 
286
 
class cmd_revno(Command):
287
 
    """Show current revision number.
288
 
 
289
 
    This is equal to the number of revisions on this branch."""
290
 
    def run(self):
291
 
        print Branch('.').revno()
292
 
 
293
 
    
294
 
class cmd_add(Command):
295
 
    """Add specified files or directories.
296
 
 
297
 
    In non-recursive mode, all the named items are added, regardless
298
 
    of whether they were previously ignored.  A warning is given if
299
 
    any of the named files are already versioned.
300
 
 
301
 
    In recursive mode (the default), files are treated the same way
302
 
    but the behaviour for directories is different.  Directories that
303
 
    are already versioned do not give a warning.  All directories,
304
 
    whether already versioned or not, are searched for files or
305
 
    subdirectories that are neither versioned or ignored, and these
306
 
    are added.  This search proceeds recursively into versioned
307
 
    directories.
308
 
 
309
 
    Therefore simply saying 'bzr add .' will version all files that
310
 
    are currently unknown.
311
 
 
312
 
    TODO: Perhaps adding a file whose directly is not versioned should
313
 
    recursively add that parent, rather than giving an error?
314
 
    """
315
 
    takes_args = ['file+']
316
 
    takes_options = ['verbose', 'no-recurse']
317
 
    
318
 
    def run(self, file_list, verbose=False, no_recurse=False):
319
 
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
320
 
 
321
 
 
322
 
class cmd_relpath(Command):
323
 
    """Show path of a file relative to root"""
324
 
    takes_args = ['filename']
325
 
    hidden = True
326
 
    
327
 
    def run(self, filename):
328
 
        print Branch(filename).relpath(filename)
329
 
 
330
 
 
331
 
 
332
 
class cmd_inventory(Command):
333
 
    """Show inventory of the current working copy or a revision."""
334
 
    takes_options = ['revision', 'show-ids']
335
 
    
336
 
    def run(self, revision=None, show_ids=False):
337
 
        b = Branch('.')
338
 
        if revision == None:
339
 
            inv = b.read_working_inventory()
340
 
        else:
341
 
            inv = b.get_revision_inventory(b.lookup_revision(revision))
342
 
 
343
 
        for path, entry in inv.entries():
344
 
            if show_ids:
345
 
                print '%-50s %s' % (path, entry.file_id)
346
 
            else:
347
 
                print path
348
 
 
349
 
 
350
 
class cmd_move(Command):
351
 
    """Move files to a different directory.
352
 
 
353
 
    examples:
354
 
        bzr move *.txt doc
355
 
 
356
 
    The destination must be a versioned directory in the same branch.
357
 
    """
358
 
    takes_args = ['source$', 'dest']
359
 
    def run(self, source_list, dest):
360
 
        b = Branch('.')
361
 
 
362
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
363
 
 
364
 
 
365
 
class cmd_rename(Command):
366
 
    """Change the name of an entry.
367
 
 
368
 
    examples:
369
 
      bzr rename frob.c frobber.c
370
 
      bzr rename src/frob.c lib/frob.c
371
 
 
372
 
    It is an error if the destination name exists.
373
 
 
374
 
    See also the 'move' command, which moves files into a different
375
 
    directory without changing their name.
376
 
 
377
 
    TODO: Some way to rename multiple files without invoking bzr for each
378
 
    one?"""
379
 
    takes_args = ['from_name', 'to_name']
380
 
    
381
 
    def run(self, from_name, to_name):
382
 
        b = Branch('.')
383
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
384
 
 
385
 
 
386
 
 
387
 
 
388
 
 
389
 
class cmd_pull(Command):
390
 
    """Pull any changes from another branch into the current one.
391
 
 
392
 
    If the location is omitted, the last-used location will be used.
393
 
    Both the revision history and the working directory will be
394
 
    updated.
395
 
 
396
 
    This command only works on branches that have not diverged.  Branches are
397
 
    considered diverged if both branches have had commits without first
398
 
    pulling from the other.
399
 
 
400
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
401
 
    from one into the other.
402
 
    """
403
 
    takes_args = ['location?']
404
 
 
405
 
    def run(self, location=None):
406
 
        from bzrlib.merge import merge
407
 
        import errno
408
 
        
409
 
        br_to = Branch('.')
410
 
        stored_loc = None
411
 
        try:
412
 
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
413
 
        except IOError, e:
414
 
            if errno == errno.ENOENT:
415
 
                raise
416
 
        if location is None:
417
 
            location = stored_loc
418
 
        if location is None:
419
 
            raise BzrCommandError("No pull location known or specified.")
420
 
        from branch import find_branch, DivergedBranches
421
 
        br_from = find_branch(location)
422
 
        location = pull_loc(br_from)
423
 
        old_revno = br_to.revno()
424
 
        try:
425
 
            br_to.update_revisions(br_from)
426
 
        except DivergedBranches:
427
 
            raise BzrCommandError("These branches have diverged.  Try merge.")
428
 
            
429
 
        merge(('.', -1), ('.', old_revno))
430
 
        if location != stored_loc:
431
 
            br_to.controlfile("x-pull", "wb").write(location + "\n")
432
 
 
433
 
 
434
 
 
435
 
class cmd_branch(Command):
436
 
    """Create a new copy of a branch.
437
 
 
438
 
    If the TO_LOCATION is omitted, the last component of the
439
 
    FROM_LOCATION will be used.  In other words,
440
 
    "branch ../foo/bar" will attempt to create ./bar.
441
 
    """
442
 
    takes_args = ['from_location', 'to_location?']
443
 
 
444
 
    def run(self, from_location, to_location=None):
445
 
        import errno
446
 
        from bzrlib.merge import merge
447
 
        
448
 
        if to_location is None:
449
 
            to_location = os.path.basename(from_location)
450
 
            # FIXME: If there's a trailing slash, keep removing them
451
 
            # until we find the right bit
452
 
 
453
 
        try:
454
 
            os.mkdir(to_location)
455
 
        except OSError, e:
456
 
            if e.errno == errno.EEXIST:
457
 
                raise BzrCommandError('Target directory "%s" already exists.' %
458
 
                                      to_location)
459
 
            if e.errno == errno.ENOENT:
460
 
                raise BzrCommandError('Parent of "%s" does not exist.' %
461
 
                                      to_location)
462
 
            else:
463
 
                raise
464
 
        br_to = Branch(to_location, init=True)
465
 
        from branch import find_branch, DivergedBranches
466
 
        try:
467
 
            br_from = find_branch(from_location)
468
 
        except OSError, e:
469
 
            if e.errno == errno.ENOENT:
470
 
                raise BzrCommandError('Source location "%s" does not exist.' %
471
 
                                      to_location)
472
 
            else:
473
 
                raise
474
 
 
475
 
        from_location = pull_loc(br_from)
476
 
        br_to.update_revisions(br_from)
477
 
        merge((to_location, -1), (to_location, 0), this_dir=to_location,
478
 
              check_clean=False)
479
 
        br_to.controlfile("x-pull", "wb").write(from_location + "\n")
480
 
 
481
 
 
482
 
def pull_loc(branch):
483
 
    # TODO: Should perhaps just make attribute be 'base' in
484
 
    # RemoteBranch and Branch?
485
 
    if hasattr(branch, "baseurl"):
486
 
        return branch.baseurl
487
 
    else:
488
 
        return branch.base
489
 
 
490
 
 
491
 
 
492
 
class cmd_renames(Command):
493
 
    """Show list of renamed files.
494
 
 
495
 
    TODO: Option to show renames between two historical versions.
496
 
 
497
 
    TODO: Only show renames under dir, rather than in the whole branch.
498
 
    """
499
 
    takes_args = ['dir?']
500
 
 
501
 
    def run(self, dir='.'):
502
 
        b = Branch(dir)
503
 
        old_inv = b.basis_tree().inventory
504
 
        new_inv = b.read_working_inventory()
505
 
 
506
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
507
 
        renames.sort()
508
 
        for old_name, new_name in renames:
509
 
            print "%s => %s" % (old_name, new_name)        
510
 
 
511
 
 
512
 
class cmd_info(Command):
513
 
    """Show statistical information about a branch."""
514
 
    takes_args = ['branch?']
515
 
    
516
 
    def run(self, branch=None):
517
 
        import info
518
 
 
519
 
        from branch import find_branch
520
 
        b = find_branch(branch)
521
 
        info.show_info(b)
522
 
 
523
 
 
524
 
class cmd_remove(Command):
525
 
    """Make a file unversioned.
526
 
 
527
 
    This makes bzr stop tracking changes to a versioned file.  It does
528
 
    not delete the working copy.
529
 
    """
530
 
    takes_args = ['file+']
531
 
    takes_options = ['verbose']
532
 
    
533
 
    def run(self, file_list, verbose=False):
534
 
        b = Branch(file_list[0])
535
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
536
 
 
537
 
 
538
 
class cmd_file_id(Command):
539
 
    """Print file_id of a particular file or directory.
540
 
 
541
 
    The file_id is assigned when the file is first added and remains the
542
 
    same through all revisions where the file exists, even when it is
543
 
    moved or renamed.
544
 
    """
545
 
    hidden = True
546
 
    takes_args = ['filename']
547
 
    def run(self, filename):
548
 
        b = Branch(filename)
549
 
        i = b.inventory.path2id(b.relpath(filename))
550
 
        if i == None:
551
 
            bailout("%r is not a versioned file" % filename)
552
 
        else:
553
 
            print i
554
 
 
555
 
 
556
 
class cmd_file_path(Command):
557
 
    """Print path of file_ids to a file or directory.
558
 
 
559
 
    This prints one line for each directory down to the target,
560
 
    starting at the branch root."""
561
 
    hidden = True
562
 
    takes_args = ['filename']
563
 
    def run(self, filename):
564
 
        b = Branch(filename)
565
 
        inv = b.inventory
566
 
        fid = inv.path2id(b.relpath(filename))
567
 
        if fid == None:
568
 
            bailout("%r is not a versioned file" % filename)
569
 
        for fip in inv.get_idpath(fid):
570
 
            print fip
571
 
 
572
 
 
573
 
class cmd_revision_history(Command):
574
 
    """Display list of revision ids on this branch."""
575
 
    hidden = True
576
 
    def run(self):
577
 
        for patchid in Branch('.').revision_history():
578
 
            print patchid
579
 
 
580
 
 
581
 
class cmd_directories(Command):
582
 
    """Display list of versioned directories in this branch."""
583
 
    def run(self):
584
 
        for name, ie in Branch('.').read_working_inventory().directories():
585
 
            if name == '':
586
 
                print '.'
587
 
            else:
588
 
                print name
589
 
 
590
 
 
591
 
class cmd_init(Command):
592
 
    """Make a directory into a versioned branch.
593
 
 
594
 
    Use this to create an empty branch, or before importing an
595
 
    existing project.
596
 
 
597
 
    Recipe for importing a tree of files:
598
 
        cd ~/project
599
 
        bzr init
600
 
        bzr add -v .
601
 
        bzr status
602
 
        bzr commit -m 'imported project'
603
 
    """
604
 
    def run(self):
605
 
        Branch('.', init=True)
606
 
 
607
 
 
608
 
class cmd_diff(Command):
609
 
    """Show differences in working tree.
610
 
    
611
 
    If files are listed, only the changes in those files are listed.
612
 
    Otherwise, all changes for the tree are listed.
613
 
 
614
 
    TODO: Given two revision arguments, show the difference between them.
615
 
 
616
 
    TODO: Allow diff across branches.
617
 
 
618
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
619
 
          or a graphical diff.
620
 
 
621
 
    TODO: Python difflib is not exactly the same as unidiff; should
622
 
          either fix it up or prefer to use an external diff.
623
 
 
624
 
    TODO: If a directory is given, diff everything under that.
625
 
 
626
 
    TODO: Selected-file diff is inefficient and doesn't show you
627
 
          deleted files.
628
 
 
629
 
    TODO: This probably handles non-Unix newlines poorly.
630
 
    """
631
 
    
632
 
    takes_args = ['file*']
633
 
    takes_options = ['revision', 'diff-options']
634
 
    aliases = ['di']
635
 
 
636
 
    def run(self, revision=None, file_list=None, diff_options=None):
637
 
        from bzrlib.diff import show_diff
638
 
        from bzrlib import find_branch
639
 
 
640
 
        if file_list:
641
 
            b = find_branch(file_list[0])
642
 
            file_list = [b.relpath(f) for f in file_list]
643
 
            if file_list == ['']:
644
 
                # just pointing to top-of-tree
645
 
                file_list = None
646
 
        else:
647
 
            b = Branch('.')
648
 
    
649
 
        show_diff(b, revision, specific_files=file_list,
650
 
                  external_diff_options=diff_options)
651
 
 
652
 
 
653
 
        
654
 
 
655
 
 
656
 
class cmd_deleted(Command):
657
 
    """List files deleted in the working tree.
658
 
 
659
 
    TODO: Show files deleted since a previous revision, or between two revisions.
660
 
    """
661
 
    def run(self, show_ids=False):
662
 
        b = Branch('.')
663
 
        old = b.basis_tree()
664
 
        new = b.working_tree()
665
 
 
666
 
        ## TODO: Much more efficient way to do this: read in new
667
 
        ## directories with readdir, rather than stating each one.  Same
668
 
        ## level of effort but possibly much less IO.  (Or possibly not,
669
 
        ## if the directories are very large...)
670
 
 
671
 
        for path, ie in old.inventory.iter_entries():
672
 
            if not new.has_id(ie.file_id):
673
 
                if show_ids:
674
 
                    print '%-50s %s' % (path, ie.file_id)
675
 
                else:
676
 
                    print path
677
 
 
678
 
 
679
 
class cmd_modified(Command):
680
 
    """List files modified in working tree."""
681
 
    hidden = True
682
 
    def run(self):
683
 
        import statcache
684
 
        b = Branch('.')
685
 
        inv = b.read_working_inventory()
686
 
        sc = statcache.update_cache(b, inv)
687
 
        basis = b.basis_tree()
688
 
        basis_inv = basis.inventory
689
 
        
690
 
        # We used to do this through iter_entries(), but that's slow
691
 
        # when most of the files are unmodified, as is usually the
692
 
        # case.  So instead we iterate by inventory entry, and only
693
 
        # calculate paths as necessary.
694
 
 
695
 
        for file_id in basis_inv:
696
 
            cacheentry = sc.get(file_id)
697
 
            if not cacheentry:                 # deleted
698
 
                continue
699
 
            ie = basis_inv[file_id]
700
 
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
701
 
                path = inv.id2path(file_id)
702
 
                print path
703
 
 
704
 
 
705
 
 
706
 
class cmd_added(Command):
707
 
    """List files added in working tree."""
708
 
    hidden = True
709
 
    def run(self):
710
 
        b = Branch('.')
711
 
        wt = b.working_tree()
712
 
        basis_inv = b.basis_tree().inventory
713
 
        inv = wt.inventory
714
 
        for file_id in inv:
715
 
            if file_id in basis_inv:
716
 
                continue
717
 
            path = inv.id2path(file_id)
718
 
            if not os.access(b.abspath(path), os.F_OK):
719
 
                continue
720
 
            print path
721
 
                
722
 
        
723
 
 
724
 
class cmd_root(Command):
725
 
    """Show the tree root directory.
726
 
 
727
 
    The root is the nearest enclosing directory with a .bzr control
728
 
    directory."""
729
 
    takes_args = ['filename?']
730
 
    def run(self, filename=None):
731
 
        """Print the branch root."""
732
 
        from branch import find_branch
733
 
        b = find_branch(filename)
734
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
735
 
 
736
 
 
737
 
class cmd_log(Command):
738
 
    """Show log of this branch.
739
 
 
740
 
    To request a range of logs, you can use the command -r begin:end
741
 
    -r revision requests a specific revision, -r :end or -r begin: are
742
 
    also valid.
743
 
 
744
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
745
 
  
746
 
    """
747
 
 
748
 
    takes_args = ['filename?']
749
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
750
 
    
751
 
    def run(self, filename=None, timezone='original',
752
 
            verbose=False,
753
 
            show_ids=False,
754
 
            forward=False,
755
 
            revision=None):
756
 
        from bzrlib import show_log, find_branch
757
 
        import codecs
758
 
 
759
 
        direction = (forward and 'forward') or 'reverse'
760
 
        
761
 
        if filename:
762
 
            b = find_branch(filename)
763
 
            fp = b.relpath(filename)
764
 
            if fp:
765
 
                file_id = b.read_working_inventory().path2id(fp)
766
 
            else:
767
 
                file_id = None  # points to branch root
768
 
        else:
769
 
            b = find_branch('.')
770
 
            file_id = None
771
 
 
772
 
        if revision == None:
773
 
            revision = [None, None]
774
 
        elif isinstance(revision, int):
775
 
            revision = [revision, revision]
776
 
        else:
777
 
            # pair of revisions?
778
 
            pass
779
 
            
780
 
        assert len(revision) == 2
781
 
 
782
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
783
 
 
784
 
        # use 'replace' so that we don't abort if trying to write out
785
 
        # in e.g. the default C locale.
786
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
787
 
 
788
 
        show_log(b, file_id,
789
 
                 show_timezone=timezone,
790
 
                 verbose=verbose,
791
 
                 show_ids=show_ids,
792
 
                 to_file=outf,
793
 
                 direction=direction,
794
 
                 start_revision=revision[0],
795
 
                 end_revision=revision[1])
796
 
 
797
 
 
798
 
 
799
 
class cmd_touching_revisions(Command):
800
 
    """Return revision-ids which affected a particular file.
801
 
 
802
 
    A more user-friendly interface is "bzr log FILE"."""
803
 
    hidden = True
804
 
    takes_args = ["filename"]
805
 
    def run(self, filename):
806
 
        b = Branch(filename)
807
 
        inv = b.read_working_inventory()
808
 
        file_id = inv.path2id(b.relpath(filename))
809
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
810
 
            print "%6d %s" % (revno, what)
811
 
 
812
 
 
813
 
class cmd_ls(Command):
814
 
    """List files in a tree.
815
 
 
816
 
    TODO: Take a revision or remote path and list that tree instead.
817
 
    """
818
 
    hidden = True
819
 
    def run(self, revision=None, verbose=False):
820
 
        b = Branch('.')
821
 
        if revision == None:
822
 
            tree = b.working_tree()
823
 
        else:
824
 
            tree = b.revision_tree(b.lookup_revision(revision))
825
 
 
826
 
        for fp, fc, kind, fid in tree.list_files():
827
 
            if verbose:
828
 
                if kind == 'directory':
829
 
                    kindch = '/'
830
 
                elif kind == 'file':
831
 
                    kindch = ''
832
 
                else:
833
 
                    kindch = '???'
834
 
 
835
 
                print '%-8s %s%s' % (fc, fp, kindch)
836
 
            else:
837
 
                print fp
838
 
 
839
 
 
840
 
 
841
 
class cmd_unknowns(Command):
842
 
    """List unknown files."""
843
 
    def run(self):
844
 
        for f in Branch('.').unknowns():
845
 
            print quotefn(f)
846
 
 
847
 
 
848
 
 
849
 
class cmd_ignore(Command):
850
 
    """Ignore a command or pattern.
851
 
 
852
 
    To remove patterns from the ignore list, edit the .bzrignore file.
853
 
 
854
 
    If the pattern contains a slash, it is compared to the whole path
855
 
    from the branch root.  Otherwise, it is comapred to only the last
856
 
    component of the path.
857
 
 
858
 
    Ignore patterns are case-insensitive on case-insensitive systems.
859
 
 
860
 
    Note: wildcards must be quoted from the shell on Unix.
861
 
 
862
 
    examples:
863
 
        bzr ignore ./Makefile
864
 
        bzr ignore '*.class'
865
 
    """
866
 
    takes_args = ['name_pattern']
867
 
    
868
 
    def run(self, name_pattern):
869
 
        from bzrlib.atomicfile import AtomicFile
870
 
        import os.path
871
 
 
872
 
        b = Branch('.')
873
 
        ifn = b.abspath('.bzrignore')
874
 
 
875
 
        if os.path.exists(ifn):
876
 
            f = open(ifn, 'rt')
877
 
            try:
878
 
                igns = f.read().decode('utf-8')
879
 
            finally:
880
 
                f.close()
881
 
        else:
882
 
            igns = ''
883
 
 
884
 
        # TODO: If the file already uses crlf-style termination, maybe
885
 
        # we should use that for the newly added lines?
886
 
 
887
 
        if igns and igns[-1] != '\n':
888
 
            igns += '\n'
889
 
        igns += name_pattern + '\n'
890
 
 
891
 
        try:
892
 
            f = AtomicFile(ifn, 'wt')
893
 
            f.write(igns.encode('utf-8'))
894
 
            f.commit()
895
 
        finally:
896
 
            f.close()
897
 
 
898
 
        inv = b.working_tree().inventory
899
 
        if inv.path2id('.bzrignore'):
900
 
            mutter('.bzrignore is already versioned')
901
 
        else:
902
 
            mutter('need to make new .bzrignore file versioned')
903
 
            b.add(['.bzrignore'])
904
 
 
905
 
 
906
 
 
907
 
class cmd_ignored(Command):
908
 
    """List ignored files and the patterns that matched them.
909
 
 
910
 
    See also: bzr ignore"""
911
 
    def run(self):
912
 
        tree = Branch('.').working_tree()
913
 
        for path, file_class, kind, file_id in tree.list_files():
914
 
            if file_class != 'I':
915
 
                continue
916
 
            ## XXX: Slightly inefficient since this was already calculated
917
 
            pat = tree.is_ignored(path)
918
 
            print '%-50s %s' % (path, pat)
919
 
 
920
 
 
921
 
class cmd_lookup_revision(Command):
922
 
    """Lookup the revision-id from a revision-number
923
 
 
924
 
    example:
925
 
        bzr lookup-revision 33
926
 
    """
927
 
    hidden = True
928
 
    takes_args = ['revno']
929
 
    
930
 
    def run(self, revno):
931
 
        try:
932
 
            revno = int(revno)
933
 
        except ValueError:
934
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
935
 
 
936
 
        print Branch('.').lookup_revision(revno)
937
 
 
938
 
 
939
 
class cmd_export(Command):
940
 
    """Export past revision to destination directory.
941
 
 
942
 
    If no revision is specified this exports the last committed revision."""
943
 
    takes_args = ['dest']
944
 
    takes_options = ['revision']
945
 
    def run(self, dest, revision=None):
946
 
        b = Branch('.')
947
 
        if revision == None:
948
 
            rh = b.revision_history()[-1]
949
 
        else:
950
 
            rh = b.lookup_revision(int(revision))
951
 
        t = b.revision_tree(rh)
952
 
        t.export(dest)
953
 
 
954
 
 
955
 
class cmd_cat(Command):
956
 
    """Write a file's text from a previous revision."""
957
 
 
958
 
    takes_options = ['revision']
959
 
    takes_args = ['filename']
960
 
 
961
 
    def run(self, filename, revision=None):
962
 
        if revision == None:
963
 
            raise BzrCommandError("bzr cat requires a revision number")
964
 
        b = Branch('.')
965
 
        b.print_file(b.relpath(filename), int(revision))
966
 
 
967
 
 
968
 
class cmd_local_time_offset(Command):
969
 
    """Show the offset in seconds from GMT to local time."""
970
 
    hidden = True    
971
 
    def run(self):
972
 
        print bzrlib.osutils.local_time_offset()
973
 
 
974
 
 
975
 
 
976
 
class cmd_commit(Command):
977
 
    """Commit changes into a new revision.
978
 
 
979
 
    If selected files are specified, only changes to those files are
980
 
    committed.  If a directory is specified then its contents are also
981
 
    committed.
982
 
 
983
 
    A selected-file commit may fail in some cases where the committed
984
 
    tree would be invalid, such as trying to commit a file in a
985
 
    newly-added directory that is not itself committed.
986
 
 
987
 
    TODO: Run hooks on tree to-be-committed, and after commit.
988
 
 
989
 
    TODO: Strict commit that fails if there are unknown or deleted files.
990
 
    """
991
 
    takes_args = ['selected*']
992
 
    takes_options = ['message', 'file', 'verbose']
993
 
    aliases = ['ci', 'checkin']
994
 
 
995
 
    def run(self, message=None, file=None, verbose=True, selected_list=None):
996
 
        from bzrlib.commit import commit
997
 
 
998
 
        ## Warning: shadows builtin file()
999
 
        if not message and not file:
1000
 
            raise BzrCommandError("please specify a commit message",
1001
 
                                  ["use either --message or --file"])
1002
 
        elif message and file:
1003
 
            raise BzrCommandError("please specify either --message or --file")
1004
 
        
1005
 
        if file:
1006
 
            import codecs
1007
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1008
 
 
1009
 
        b = Branch('.')
1010
 
        commit(b, message, verbose=verbose, specific_files=selected_list)
1011
 
 
1012
 
 
1013
 
class cmd_check(Command):
1014
 
    """Validate consistency of branch history.
1015
 
 
1016
 
    This command checks various invariants about the branch storage to
1017
 
    detect data corruption or bzr bugs.
1018
 
    """
1019
 
    takes_args = ['dir?']
1020
 
    def run(self, dir='.'):
1021
 
        import bzrlib.check
1022
 
        bzrlib.check.check(Branch(dir))
1023
 
 
1024
 
 
1025
 
 
1026
 
class cmd_whoami(Command):
1027
 
    """Show bzr user id."""
1028
 
    takes_options = ['email']
1029
 
    
1030
 
    def run(self, email=False):
1031
 
        if email:
1032
 
            print bzrlib.osutils.user_email()
1033
 
        else:
1034
 
            print bzrlib.osutils.username()
1035
 
 
1036
 
 
1037
 
class cmd_selftest(Command):
1038
 
    """Run internal test suite"""
1039
 
    hidden = True
1040
 
    def run(self):
1041
 
        from bzrlib.selftest import selftest
1042
 
        if selftest():
1043
 
            return 0
1044
 
        else:
1045
 
            return 1
1046
 
 
1047
 
 
1048
 
 
1049
 
class cmd_version(Command):
1050
 
    """Show version of bzr."""
1051
 
    def run(self):
1052
 
        show_version()
1053
 
 
1054
 
def show_version():
1055
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1056
 
    # is bzrlib itself in a branch?
1057
 
    bzrrev = bzrlib.get_bzr_revision()
1058
 
    if bzrrev:
1059
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1060
 
    print bzrlib.__copyright__
1061
 
    print "http://bazaar-ng.org/"
1062
 
    print
1063
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1064
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1065
 
    print "General Public License version 2 or later."
1066
 
 
1067
 
 
1068
 
class cmd_rocks(Command):
1069
 
    """Statement of optimism."""
1070
 
    hidden = True
1071
 
    def run(self):
1072
 
        print "it sure does!"
1073
 
 
1074
 
def parse_spec(spec):
1075
 
    """
1076
 
    >>> parse_spec(None)
1077
 
    [None, None]
1078
 
    >>> parse_spec("./")
1079
 
    ['./', None]
1080
 
    >>> parse_spec("../@")
1081
 
    ['..', -1]
1082
 
    >>> parse_spec("../f/@35")
1083
 
    ['../f', 35]
1084
 
    """
1085
 
    if spec is None:
1086
 
        return [None, None]
1087
 
    if '/@' in spec:
1088
 
        parsed = spec.split('/@')
1089
 
        assert len(parsed) == 2
1090
 
        if parsed[1] == "":
1091
 
            parsed[1] = -1
1092
 
        else:
1093
 
            parsed[1] = int(parsed[1])
1094
 
            assert parsed[1] >=0
1095
 
    else:
1096
 
        parsed = [spec, None]
1097
 
    return parsed
1098
 
 
1099
 
 
1100
 
 
1101
 
class cmd_merge(Command):
1102
 
    """Perform a three-way merge of trees.
1103
 
    
1104
 
    The SPEC parameters are working tree or revision specifiers.  Working trees
1105
 
    are specified using standard paths or urls.  No component of a directory
1106
 
    path may begin with '@'.
1107
 
    
1108
 
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1109
 
 
1110
 
    Revisions are specified using a dirname/@revno pair, where dirname is the
1111
 
    branch directory and revno is the revision within that branch.  If no revno
1112
 
    is specified, the latest revision is used.
1113
 
 
1114
 
    Revision examples: './@127', 'foo/@', '../@1'
1115
 
 
1116
 
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
1117
 
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
1118
 
    as the BASE.
1119
 
 
1120
 
    merge refuses to run if there are any uncommitted changes, unless
1121
 
    --force is given.
1122
 
    """
1123
 
    takes_args = ['other_spec', 'base_spec?']
1124
 
    takes_options = ['force']
1125
 
 
1126
 
    def run(self, other_spec, base_spec=None, force=False):
1127
 
        from bzrlib.merge import merge
1128
 
        merge(parse_spec(other_spec), parse_spec(base_spec),
1129
 
              check_clean=(not force))
1130
 
 
1131
 
 
1132
 
class cmd_revert(Command):
1133
 
    """Reverse all changes since the last commit.
1134
 
 
1135
 
    Only versioned files are affected.
1136
 
 
1137
 
    TODO: Store backups of any files that will be reverted, so
1138
 
          that the revert can be undone.          
1139
 
    """
1140
 
    takes_options = ['revision']
1141
 
 
1142
 
    def run(self, revision=-1):
1143
 
        merge(('.', revision), parse_spec('.'),
1144
 
              check_clean=False,
1145
 
              ignore_zero=True)
1146
 
 
1147
 
 
1148
 
class cmd_assert_fail(Command):
1149
 
    """Test reporting of assertion failures"""
1150
 
    hidden = True
1151
 
    def run(self):
1152
 
        assert False, "always fails"
1153
 
 
1154
 
 
1155
 
class cmd_help(Command):
1156
 
    """Show help on a command or other topic.
1157
 
 
1158
 
    For a list of all available commands, say 'bzr help commands'."""
1159
 
    takes_args = ['topic?']
1160
 
    aliases = ['?']
1161
 
    
1162
 
    def run(self, topic=None):
1163
 
        import help
1164
 
        help.help(topic)
1165
 
 
1166
 
 
1167
 
class cmd_update_stat_cache(Command):
1168
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
1169
 
 
1170
 
    For testing only."""
1171
 
    hidden = True
1172
 
    def run(self):
1173
 
        import statcache
1174
 
        b = Branch('.')
1175
 
        statcache.update_cache(b.base, b.read_working_inventory())
1176
 
 
1177
 
 
1178
 
 
1179
 
# list of all available options; the rhs can be either None for an
1180
 
# option that takes no argument, or a constructor function that checks
1181
 
# the type.
1182
 
OPTIONS = {
1183
 
    'all':                    None,
1184
 
    'diff-options':           str,
1185
 
    'help':                   None,
1186
 
    'file':                   unicode,
1187
 
    'force':                  None,
1188
 
    'forward':                None,
1189
 
    'message':                unicode,
1190
 
    'no-recurse':             None,
1191
 
    'profile':                None,
1192
 
    'revision':               _parse_revision_str,
1193
 
    'show-ids':               None,
1194
 
    'timezone':               str,
1195
 
    'verbose':                None,
1196
 
    'version':                None,
1197
 
    'email':                  None,
1198
 
    }
1199
 
 
1200
 
SHORT_OPTIONS = {
1201
 
    'F':                      'file', 
1202
 
    'h':                      'help',
1203
 
    'm':                      'message',
1204
 
    'r':                      'revision',
1205
 
    'v':                      'verbose',
1206
 
}
1207
 
 
1208
 
 
1209
 
def parse_args(argv):
1210
 
    """Parse command line.
1211
 
    
1212
 
    Arguments and options are parsed at this level before being passed
1213
 
    down to specific command handlers.  This routine knows, from a
1214
 
    lookup table, something about the available options, what optargs
1215
 
    they take, and which commands will accept them.
1216
 
 
1217
 
    >>> parse_args('--help'.split())
1218
 
    ([], {'help': True})
1219
 
    >>> parse_args('--version'.split())
1220
 
    ([], {'version': True})
1221
 
    >>> parse_args('status --all'.split())
1222
 
    (['status'], {'all': True})
1223
 
    >>> parse_args('commit --message=biter'.split())
1224
 
    (['commit'], {'message': u'biter'})
1225
 
    """
1226
 
    args = []
1227
 
    opts = {}
1228
 
 
1229
 
    # TODO: Maybe handle '--' to end options?
1230
 
 
1231
 
    while argv:
1232
 
        a = argv.pop(0)
1233
 
        if a[0] == '-':
1234
 
            # option names must not be unicode
1235
 
            a = str(a)
1236
 
            optarg = None
1237
 
            if a[1] == '-':
1238
 
                mutter("  got option %r" % a)
1239
 
                if '=' in a:
1240
 
                    optname, optarg = a[2:].split('=', 1)
1241
 
                else:
1242
 
                    optname = a[2:]
1243
 
                if optname not in OPTIONS:
1244
 
                    bailout('unknown long option %r' % a)
1245
 
            else:
1246
 
                shortopt = a[1:]
1247
 
                if shortopt not in SHORT_OPTIONS:
1248
 
                    bailout('unknown short option %r' % a)
1249
 
                optname = SHORT_OPTIONS[shortopt]
1250
 
            
1251
 
            if optname in opts:
1252
 
                # XXX: Do we ever want to support this, e.g. for -r?
1253
 
                bailout('repeated option %r' % a)
1254
 
                
1255
 
            optargfn = OPTIONS[optname]
1256
 
            if optargfn:
1257
 
                if optarg == None:
1258
 
                    if not argv:
1259
 
                        bailout('option %r needs an argument' % a)
1260
 
                    else:
1261
 
                        optarg = argv.pop(0)
1262
 
                opts[optname] = optargfn(optarg)
1263
 
            else:
1264
 
                if optarg != None:
1265
 
                    bailout('option %r takes no argument' % optname)
1266
 
                opts[optname] = True
1267
 
        else:
1268
 
            args.append(a)
1269
 
 
1270
 
    return args, opts
1271
 
 
1272
 
 
1273
 
 
1274
 
 
1275
 
def _match_argform(cmd, takes_args, args):
1276
 
    argdict = {}
1277
 
 
1278
 
    # step through args and takes_args, allowing appropriate 0-many matches
1279
 
    for ap in takes_args:
1280
 
        argname = ap[:-1]
1281
 
        if ap[-1] == '?':
1282
 
            if args:
1283
 
                argdict[argname] = args.pop(0)
1284
 
        elif ap[-1] == '*': # all remaining arguments
1285
 
            if args:
1286
 
                argdict[argname + '_list'] = args[:]
1287
 
                args = []
1288
 
            else:
1289
 
                argdict[argname + '_list'] = None
1290
 
        elif ap[-1] == '+':
1291
 
            if not args:
1292
 
                raise BzrCommandError("command %r needs one or more %s"
1293
 
                        % (cmd, argname.upper()))
1294
 
            else:
1295
 
                argdict[argname + '_list'] = args[:]
1296
 
                args = []
1297
 
        elif ap[-1] == '$': # all but one
1298
 
            if len(args) < 2:
1299
 
                raise BzrCommandError("command %r needs one or more %s"
1300
 
                        % (cmd, argname.upper()))
1301
 
            argdict[argname + '_list'] = args[:-1]
1302
 
            args[:-1] = []                
1303
 
        else:
1304
 
            # just a plain arg
1305
 
            argname = ap
1306
 
            if not args:
1307
 
                raise BzrCommandError("command %r requires argument %s"
1308
 
                        % (cmd, argname.upper()))
1309
 
            else:
1310
 
                argdict[argname] = args.pop(0)
1311
 
            
1312
 
    if args:
1313
 
        raise BzrCommandError("extra argument to command %s: %s"
1314
 
                              % (cmd, args[0]))
1315
 
 
1316
 
    return argdict
1317
 
 
1318
 
 
1319
 
 
1320
 
def run_bzr(argv):
1321
 
    """Execute a command.
1322
 
 
1323
 
    This is similar to main(), but without all the trappings for
1324
 
    logging and error handling.  
1325
 
    """
1326
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1327
 
    
1328
 
    try:
1329
 
        args, opts = parse_args(argv[1:])
1330
 
        if 'help' in opts:
1331
 
            import help
1332
 
            if args:
1333
 
                help.help(args[0])
1334
 
            else:
1335
 
                help.help()
1336
 
            return 0
1337
 
        elif 'version' in opts:
1338
 
            show_version()
1339
 
            return 0
1340
 
        cmd = str(args.pop(0))
1341
 
    except IndexError:
1342
 
        import help
1343
 
        help.help()
1344
 
        return 1
1345
 
          
1346
 
 
1347
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
1348
 
 
1349
 
    # global option
1350
 
    if 'profile' in opts:
1351
 
        profile = True
1352
 
        del opts['profile']
1353
 
    else:
1354
 
        profile = False
1355
 
 
1356
 
    # check options are reasonable
1357
 
    allowed = cmd_class.takes_options
1358
 
    for oname in opts:
1359
 
        if oname not in allowed:
1360
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1361
 
                                  % (oname, cmd))
1362
 
 
1363
 
    # mix arguments and options into one dictionary
1364
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1365
 
    cmdopts = {}
1366
 
    for k, v in opts.items():
1367
 
        cmdopts[k.replace('-', '_')] = v
1368
 
 
1369
 
    if profile:
1370
 
        import hotshot, tempfile
1371
 
        pffileno, pfname = tempfile.mkstemp()
1372
 
        try:
1373
 
            prof = hotshot.Profile(pfname)
1374
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1375
 
            prof.close()
1376
 
 
1377
 
            import hotshot.stats
1378
 
            stats = hotshot.stats.load(pfname)
1379
 
            #stats.strip_dirs()
1380
 
            stats.sort_stats('time')
1381
 
            ## XXX: Might like to write to stderr or the trace file instead but
1382
 
            ## print_stats seems hardcoded to stdout
1383
 
            stats.print_stats(20)
1384
 
            
1385
 
            return ret.status
1386
 
 
1387
 
        finally:
1388
 
            os.close(pffileno)
1389
 
            os.remove(pfname)
1390
 
    else:
1391
 
        return cmd_class(cmdopts, cmdargs).status 
1392
 
 
1393
 
 
1394
 
def _report_exception(summary, quiet=False):
1395
 
    import traceback
1396
 
    log_error('bzr: ' + summary)
1397
 
    bzrlib.trace.log_exception()
1398
 
 
1399
 
    if not quiet:
1400
 
        tb = sys.exc_info()[2]
1401
 
        exinfo = traceback.extract_tb(tb)
1402
 
        if exinfo:
1403
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1404
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
1405
 
 
1406
 
 
1407
 
 
1408
 
def main(argv):
1409
 
    import errno
1410
 
    
1411
 
    bzrlib.open_tracefile(argv)
1412
 
 
1413
 
    try:
1414
 
        try:
1415
 
            try:
1416
 
                return run_bzr(argv)
1417
 
            finally:
1418
 
                # do this here inside the exception wrappers to catch EPIPE
1419
 
                sys.stdout.flush()
1420
 
        except BzrError, e:
1421
 
            quiet = isinstance(e, (BzrCommandError))
1422
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
1423
 
            if len(e.args) > 1:
1424
 
                for h in e.args[1]:
1425
 
                    # some explanation or hints
1426
 
                    log_error('  ' + h)
1427
 
            return 1
1428
 
        except AssertionError, e:
1429
 
            msg = 'assertion failed'
1430
 
            if str(e):
1431
 
                msg += ': ' + str(e)
1432
 
            _report_exception(msg)
1433
 
            return 2
1434
 
        except KeyboardInterrupt, e:
1435
 
            _report_exception('interrupted', quiet=True)
1436
 
            return 2
1437
 
        except Exception, e:
1438
 
            quiet = False
1439
 
            if (isinstance(e, IOError) 
1440
 
                and hasattr(e, 'errno')
1441
 
                and e.errno == errno.EPIPE):
1442
 
                quiet = True
1443
 
                msg = 'broken pipe'
1444
 
            else:
1445
 
                msg = str(e).rstrip('\n')
1446
 
            _report_exception(msg, quiet)
1447
 
            return 2
1448
 
    finally:
1449
 
        bzrlib.trace.close_trace()
1450
 
 
1451
 
 
1452
 
if __name__ == '__main__':
1453
 
    sys.exit(main(sys.argv))