1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
18
# TODO: Split the command framework away from the actual commands.
 
 
20
# TODO: probably should say which arguments are candidates for glob
 
 
21
# expansion on windows and do that at the command level.
 
 
27
from bzrlib.trace import mutter, note, log_error, warning
 
 
28
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
 
 
29
from bzrlib.branch import find_branch
 
 
30
from bzrlib import BZRDIR
 
 
36
def register_command(cmd):
 
 
37
    "Utility function to help register a command"
 
 
40
    if k.startswith("cmd_"):
 
 
41
        k_unsquished = _unsquish_command_name(k)
 
 
44
    if not plugin_cmds.has_key(k_unsquished):
 
 
45
        plugin_cmds[k_unsquished] = cmd
 
 
47
        log_error('Two plugins defined the same command: %r' % k)
 
 
48
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
 
51
def _squish_command_name(cmd):
 
 
52
    return 'cmd_' + cmd.replace('-', '_')
 
 
55
def _unsquish_command_name(cmd):
 
 
56
    assert cmd.startswith("cmd_")
 
 
57
    return cmd[4:].replace('_','-')
 
 
60
def _parse_revision_str(revstr):
 
 
61
    """This handles a revision string -> revno.
 
 
63
    This always returns a list.  The list will have one element for 
 
 
65
    It supports integers directly, but everything else it
 
 
66
    defers for passing to Branch.get_revision_info()
 
 
68
    >>> _parse_revision_str('234')
 
 
70
    >>> _parse_revision_str('234..567')
 
 
72
    >>> _parse_revision_str('..')
 
 
74
    >>> _parse_revision_str('..234')
 
 
76
    >>> _parse_revision_str('234..')
 
 
78
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
 
 
80
    >>> _parse_revision_str('234....789') # Error?
 
 
82
    >>> _parse_revision_str('revid:test@other.com-234234')
 
 
83
    ['revid:test@other.com-234234']
 
 
84
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
 
 
85
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
 
 
86
    >>> _parse_revision_str('revid:test@other.com-234234..23')
 
 
87
    ['revid:test@other.com-234234', 23]
 
 
88
    >>> _parse_revision_str('date:2005-04-12')
 
 
90
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
 
 
91
    ['date:2005-04-12 12:24:33']
 
 
92
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
 
 
93
    ['date:2005-04-12T12:24:33']
 
 
94
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
 
 
95
    ['date:2005-04-12,12:24:33']
 
 
96
    >>> _parse_revision_str('-5..23')
 
 
98
    >>> _parse_revision_str('-5')
 
 
100
    >>> _parse_revision_str('123a')
 
 
102
    >>> _parse_revision_str('abc')
 
 
106
    old_format_re = re.compile('\d*:\d*')
 
 
107
    m = old_format_re.match(revstr)
 
 
109
        warning('Colon separator for revision numbers is deprecated.'
 
 
112
        for rev in revstr.split(':'):
 
 
114
                revs.append(int(rev))
 
 
119
    for x in revstr.split('..'):
 
 
130
def get_merge_type(typestring):
 
 
131
    """Attempt to find the merge class/factory associated with a string."""
 
 
132
    from merge import merge_types
 
 
134
        return merge_types[typestring][0]
 
 
136
        templ = '%s%%7s: %%s' % (' '*12)
 
 
137
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
 
138
        type_list = '\n'.join(lines)
 
 
139
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
 
140
            (typestring, type_list)
 
 
141
        raise BzrCommandError(msg)
 
 
144
def get_merge_type(typestring):
 
 
145
    """Attempt to find the merge class/factory associated with a string."""
 
 
146
    from merge import merge_types
 
 
148
        return merge_types[typestring][0]
 
 
150
        templ = '%s%%7s: %%s' % (' '*12)
 
 
151
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
 
152
        type_list = '\n'.join(lines)
 
 
153
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
 
154
            (typestring, type_list)
 
 
155
        raise BzrCommandError(msg)
 
 
159
def _get_cmd_dict(plugins_override=True):
 
 
161
    for k, v in globals().iteritems():
 
 
162
        if k.startswith("cmd_"):
 
 
163
            d[_unsquish_command_name(k)] = v
 
 
164
    # If we didn't load plugins, the plugin_cmds dict will be empty
 
 
166
        d.update(plugin_cmds)
 
 
168
        d2 = plugin_cmds.copy()
 
 
174
def get_all_cmds(plugins_override=True):
 
 
175
    """Return canonical name and class for all registered commands."""
 
 
176
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
 
180
def get_cmd_class(cmd, plugins_override=True):
 
 
181
    """Return the canonical name and command class for a command.
 
 
183
    cmd = str(cmd)                      # not unicode
 
 
185
    # first look up this command under the specified name
 
 
186
    cmds = _get_cmd_dict(plugins_override=plugins_override)
 
 
188
        return cmd, cmds[cmd]
 
 
192
    # look for any command which claims this as an alias
 
 
193
    for cmdname, cmdclass in cmds.iteritems():
 
 
194
        if cmd in cmdclass.aliases:
 
 
195
            return cmdname, cmdclass
 
 
197
    cmdclass = ExternalCommand.find_command(cmd)
 
 
201
    raise BzrCommandError("unknown command %r" % cmd)
 
 
204
class Command(object):
 
 
205
    """Base class for commands.
 
 
207
    The docstring for an actual command should give a single-line
 
 
208
    summary, then a complete description of the command.  A grammar
 
 
209
    description will be inserted.
 
 
212
        List of argument forms, marked with whether they are optional,
 
 
216
        List of options that may be given for this command.
 
 
219
        If true, this command isn't advertised.
 
 
228
    def __init__(self, options, arguments):
 
 
229
        """Construct and run the command.
 
 
231
        Sets self.status to the return value of run()."""
 
 
232
        assert isinstance(options, dict)
 
 
233
        assert isinstance(arguments, dict)
 
 
234
        cmdargs = options.copy()
 
 
235
        cmdargs.update(arguments)
 
 
236
        if self.__doc__ == Command.__doc__:
 
 
237
            from warnings import warn
 
 
238
            warn("No help message set for %r" % self)
 
 
239
        self.status = self.run(**cmdargs)
 
 
240
        if self.status is None:
 
 
245
        """Override this in sub-classes.
 
 
247
        This is invoked with the options and arguments bound to
 
 
250
        Return 0 or None if the command was successful, or a shell
 
 
256
class ExternalCommand(Command):
 
 
257
    """Class to wrap external commands.
 
 
259
    We cheat a little here, when get_cmd_class() calls us we actually
 
 
260
    give it back an object we construct that has the appropriate path,
 
 
261
    help, options etc for the specified command.
 
 
263
    When run_bzr() tries to instantiate that 'class' it gets caught by
 
 
264
    the __call__ method, which we override to call the Command.__init__
 
 
265
    method. That then calls our run method which is pretty straight
 
 
268
    The only wrinkle is that we have to map bzr's dictionary of options
 
 
269
    and arguments back into command line options and arguments for the
 
 
273
    def find_command(cls, cmd):
 
 
275
        bzrpath = os.environ.get('BZRPATH', '')
 
 
277
        for dir in bzrpath.split(os.pathsep):
 
 
278
            path = os.path.join(dir, cmd)
 
 
279
            if os.path.isfile(path):
 
 
280
                return ExternalCommand(path)
 
 
284
    find_command = classmethod(find_command)
 
 
286
    def __init__(self, path):
 
 
289
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
 
290
        self.takes_options = pipe.readline().split()
 
 
292
        for opt in self.takes_options:
 
 
293
            if not opt in OPTIONS:
 
 
294
                raise BzrError("Unknown option '%s' returned by external command %s"
 
 
297
        # TODO: Is there any way to check takes_args is valid here?
 
 
298
        self.takes_args = pipe.readline().split()
 
 
300
        if pipe.close() is not None:
 
 
301
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
 
 
303
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
 
304
        self.__doc__ = pipe.read()
 
 
305
        if pipe.close() is not None:
 
 
306
            raise BzrError("Failed funning '%s --bzr-help'" % path)
 
 
308
    def __call__(self, options, arguments):
 
 
309
        Command.__init__(self, options, arguments)
 
 
312
    def run(self, **kargs):
 
 
319
            optname = name.replace('_','-')
 
 
321
            if OPTIONS.has_key(optname):
 
 
323
                opts.append('--%s' % optname)
 
 
324
                if value is not None and value is not True:
 
 
325
                    opts.append(str(value))
 
 
327
                # it's an arg, or arg list
 
 
328
                if type(value) is not list:
 
 
334
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
 
338
class cmd_status(Command):
 
 
339
    """Display status summary.
 
 
341
    This reports on versioned and unknown files, reporting them
 
 
342
    grouped by state.  Possible states are:
 
 
345
        Versioned in the working copy but not in the previous revision.
 
 
348
        Versioned in the previous revision but removed or deleted
 
 
352
        Path of this file changed from the previous revision;
 
 
353
        the text may also have changed.  This includes files whose
 
 
354
        parent directory was renamed.
 
 
357
        Text has changed since the previous revision.
 
 
360
        Nothing about this file has changed since the previous revision.
 
 
361
        Only shown with --all.
 
 
364
        Not versioned and not matching an ignore pattern.
 
 
366
    To see ignored files use 'bzr ignored'.  For details in the
 
 
367
    changes to file texts, use 'bzr diff'.
 
 
369
    If no arguments are specified, the status of the entire working
 
 
370
    directory is shown.  Otherwise, only the status of the specified
 
 
371
    files or directories is reported.  If a directory is given, status
 
 
372
    is reported for everything inside that directory.
 
 
374
    If a revision is specified, the changes since that revision are shown.
 
 
376
    takes_args = ['file*']
 
 
377
    takes_options = ['all', 'show-ids', 'revision']
 
 
378
    aliases = ['st', 'stat']
 
 
380
    def run(self, all=False, show_ids=False, file_list=None):
 
 
382
            b = find_branch(file_list[0])
 
 
383
            file_list = [b.relpath(x) for x in file_list]
 
 
384
            # special case: only one path was given and it's the root
 
 
386
            if file_list == ['']:
 
 
391
        from bzrlib.status import show_status
 
 
392
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
393
                    specific_files=file_list)
 
 
396
class cmd_cat_revision(Command):
 
 
397
    """Write out metadata for a revision."""
 
 
400
    takes_args = ['revision_id']
 
 
402
    def run(self, revision_id):
 
 
403
        from bzrlib.xml import pack_xml
 
 
404
        pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
 
 
407
class cmd_revno(Command):
 
 
408
    """Show current revision number.
 
 
410
    This is equal to the number of revisions on this branch."""
 
 
412
        print find_branch('.').revno()
 
 
414
class cmd_revision_info(Command):
 
 
415
    """Show revision number and revision id for a given revision identifier.
 
 
418
    takes_args = ['revision_info*']
 
 
419
    takes_options = ['revision']
 
 
420
    def run(self, revision=None, revision_info_list=None):
 
 
421
        from bzrlib.branch import find_branch
 
 
424
        if revision is not None:
 
 
425
            revs.extend(revision)
 
 
426
        if revision_info_list is not None:
 
 
427
            revs.extend(revision_info_list)
 
 
429
            raise BzrCommandError('You must supply a revision identifier')
 
 
434
            print '%4d %s' % b.get_revision_info(rev)
 
 
437
class cmd_add(Command):
 
 
438
    """Add specified files or directories.
 
 
440
    In non-recursive mode, all the named items are added, regardless
 
 
441
    of whether they were previously ignored.  A warning is given if
 
 
442
    any of the named files are already versioned.
 
 
444
    In recursive mode (the default), files are treated the same way
 
 
445
    but the behaviour for directories is different.  Directories that
 
 
446
    are already versioned do not give a warning.  All directories,
 
 
447
    whether already versioned or not, are searched for files or
 
 
448
    subdirectories that are neither versioned or ignored, and these
 
 
449
    are added.  This search proceeds recursively into versioned
 
 
450
    directories.  If no names are given '.' is assumed.
 
 
452
    Therefore simply saying 'bzr add' will version all files that
 
 
453
    are currently unknown.
 
 
455
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
456
    recursively add that parent, rather than giving an error?
 
 
458
    takes_args = ['file*']
 
 
459
    takes_options = ['verbose', 'no-recurse']
 
 
461
    def run(self, file_list, verbose=False, no_recurse=False):
 
 
462
        from bzrlib.add import smart_add
 
 
463
        smart_add(file_list, verbose, not no_recurse)
 
 
467
class cmd_mkdir(Command):
 
 
468
    """Create a new versioned directory.
 
 
470
    This is equivalent to creating the directory and then adding it.
 
 
472
    takes_args = ['dir+']
 
 
474
    def run(self, dir_list):
 
 
481
            b.add([d], verbose=True)
 
 
484
class cmd_relpath(Command):
 
 
485
    """Show path of a file relative to root"""
 
 
486
    takes_args = ['filename']
 
 
489
    def run(self, filename):
 
 
490
        print find_branch(filename).relpath(filename)
 
 
494
class cmd_inventory(Command):
 
 
495
    """Show inventory of the current working copy or a revision."""
 
 
496
    takes_options = ['revision', 'show-ids']
 
 
498
    def run(self, revision=None, show_ids=False):
 
 
501
            inv = b.read_working_inventory()
 
 
503
            if len(revision) > 1:
 
 
504
                raise BzrCommandError('bzr inventory --revision takes'
 
 
505
                    ' exactly one revision identifier')
 
 
506
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
 
 
508
        for path, entry in inv.entries():
 
 
510
                print '%-50s %s' % (path, entry.file_id)
 
 
515
class cmd_move(Command):
 
 
516
    """Move files to a different directory.
 
 
521
    The destination must be a versioned directory in the same branch.
 
 
523
    takes_args = ['source$', 'dest']
 
 
524
    def run(self, source_list, dest):
 
 
527
        # TODO: glob expansion on windows?
 
 
528
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
531
class cmd_rename(Command):
 
 
532
    """Change the name of an entry.
 
 
535
      bzr rename frob.c frobber.c
 
 
536
      bzr rename src/frob.c lib/frob.c
 
 
538
    It is an error if the destination name exists.
 
 
540
    See also the 'move' command, which moves files into a different
 
 
541
    directory without changing their name.
 
 
543
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
545
    takes_args = ['from_name', 'to_name']
 
 
547
    def run(self, from_name, to_name):
 
 
549
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
553
class cmd_mv(Command):
 
 
554
    """Move or rename a file.
 
 
557
        bzr mv OLDNAME NEWNAME
 
 
558
        bzr mv SOURCE... DESTINATION
 
 
560
    If the last argument is a versioned directory, all the other names
 
 
561
    are moved into it.  Otherwise, there must be exactly two arguments
 
 
562
    and the file is changed to a new name, which must not already exist.
 
 
564
    Files cannot be moved between branches.
 
 
566
    takes_args = ['names*']
 
 
567
    def run(self, names_list):
 
 
568
        if len(names_list) < 2:
 
 
569
            raise BzrCommandError("missing file argument")
 
 
570
        b = find_branch(names_list[0])
 
 
572
        rel_names = [b.relpath(x) for x in names_list]
 
 
574
        if os.path.isdir(names_list[-1]):
 
 
575
            # move into existing directory
 
 
576
            b.move(rel_names[:-1], rel_names[-1])
 
 
578
            if len(names_list) != 2:
 
 
579
                raise BzrCommandError('to mv multiple files the destination '
 
 
580
                                      'must be a versioned directory')
 
 
581
            b.move(rel_names[0], rel_names[1])
 
 
586
class cmd_pull(Command):
 
 
587
    """Pull any changes from another branch into the current one.
 
 
589
    If the location is omitted, the last-used location will be used.
 
 
590
    Both the revision history and the working directory will be
 
 
593
    This command only works on branches that have not diverged.  Branches are
 
 
594
    considered diverged if both branches have had commits without first
 
 
595
    pulling from the other.
 
 
597
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
 
598
    from one into the other.
 
 
600
    takes_args = ['location?']
 
 
602
    def run(self, location=None):
 
 
603
        from bzrlib.merge import merge
 
 
605
        from shutil import rmtree
 
 
608
        br_to = find_branch('.')
 
 
611
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
 
613
            if e.errno != errno.ENOENT:
 
 
616
            if stored_loc is None:
 
 
617
                raise BzrCommandError("No pull location known or specified.")
 
 
619
                print "Using last location: %s" % stored_loc
 
 
620
                location = stored_loc
 
 
621
        cache_root = tempfile.mkdtemp()
 
 
622
        from bzrlib.branch import DivergedBranches
 
 
623
        br_from = find_branch(location)
 
 
624
        location = pull_loc(br_from)
 
 
625
        old_revno = br_to.revno()
 
 
627
            from branch import find_cached_branch, DivergedBranches
 
 
628
            br_from = find_cached_branch(location, cache_root)
 
 
629
            location = pull_loc(br_from)
 
 
630
            old_revno = br_to.revno()
 
 
632
                br_to.update_revisions(br_from)
 
 
633
            except DivergedBranches:
 
 
634
                raise BzrCommandError("These branches have diverged."
 
 
637
            merge(('.', -1), ('.', old_revno), check_clean=False)
 
 
638
            if location != stored_loc:
 
 
639
                br_to.controlfile("x-pull", "wb").write(location + "\n")
 
 
645
class cmd_branch(Command):
 
 
646
    """Create a new copy of a branch.
 
 
648
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
 
649
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
 
651
    To retrieve the branch as of a particular revision, supply the --revision
 
 
652
    parameter, as in "branch foo/bar -r 5".
 
 
654
    takes_args = ['from_location', 'to_location?']
 
 
655
    takes_options = ['revision']
 
 
656
    aliases = ['get', 'clone']
 
 
658
    def run(self, from_location, to_location=None, revision=None):
 
 
660
        from bzrlib.merge import merge
 
 
661
        from bzrlib.branch import DivergedBranches, \
 
 
662
             find_cached_branch, Branch
 
 
663
        from shutil import rmtree
 
 
664
        from meta_store import CachedStore
 
 
666
        cache_root = tempfile.mkdtemp()
 
 
670
        elif len(revision) > 1:
 
 
671
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
 
 
675
                br_from = find_cached_branch(from_location, cache_root)
 
 
677
                if e.errno == errno.ENOENT:
 
 
678
                    raise BzrCommandError('Source location "%s" does not'
 
 
679
                                          ' exist.' % to_location)
 
 
683
            if to_location is None:
 
 
684
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
 
687
                os.mkdir(to_location)
 
 
689
                if e.errno == errno.EEXIST:
 
 
690
                    raise BzrCommandError('Target directory "%s" already'
 
 
691
                                          ' exists.' % to_location)
 
 
692
                if e.errno == errno.ENOENT:
 
 
693
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
697
            br_to = Branch(to_location, init=True)
 
 
699
            br_to.set_root_id(br_from.get_root_id())
 
 
702
                if revision[0] is None:
 
 
703
                    revno = br_from.revno()
 
 
705
                    revno, rev_id = br_from.get_revision_info(revision[0])
 
 
707
                    br_to.update_revisions(br_from, stop_revision=revno)
 
 
708
                except bzrlib.errors.NoSuchRevision:
 
 
710
                    msg = "The branch %s has no revision %d." % (from_location,
 
 
712
                    raise BzrCommandError(msg)
 
 
714
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
 
715
                  check_clean=False, ignore_zero=True)
 
 
716
            from_location = pull_loc(br_from)
 
 
717
            br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
 
722
def pull_loc(branch):
 
 
723
    # TODO: Should perhaps just make attribute be 'base' in
 
 
724
    # RemoteBranch and Branch?
 
 
725
    if hasattr(branch, "baseurl"):
 
 
726
        return branch.baseurl
 
 
732
class cmd_renames(Command):
 
 
733
    """Show list of renamed files.
 
 
735
    TODO: Option to show renames between two historical versions.
 
 
737
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
739
    takes_args = ['dir?']
 
 
741
    def run(self, dir='.'):
 
 
743
        old_inv = b.basis_tree().inventory
 
 
744
        new_inv = b.read_working_inventory()
 
 
746
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
748
        for old_name, new_name in renames:
 
 
749
            print "%s => %s" % (old_name, new_name)        
 
 
752
class cmd_info(Command):
 
 
753
    """Show statistical information about a branch."""
 
 
754
    takes_args = ['branch?']
 
 
756
    def run(self, branch=None):
 
 
759
        b = find_branch(branch)
 
 
763
class cmd_remove(Command):
 
 
764
    """Make a file unversioned.
 
 
766
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
767
    not delete the working copy.
 
 
769
    takes_args = ['file+']
 
 
770
    takes_options = ['verbose']
 
 
772
    def run(self, file_list, verbose=False):
 
 
773
        b = find_branch(file_list[0])
 
 
774
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
777
class cmd_file_id(Command):
 
 
778
    """Print file_id of a particular file or directory.
 
 
780
    The file_id is assigned when the file is first added and remains the
 
 
781
    same through all revisions where the file exists, even when it is
 
 
785
    takes_args = ['filename']
 
 
786
    def run(self, filename):
 
 
787
        b = find_branch(filename)
 
 
788
        i = b.inventory.path2id(b.relpath(filename))
 
 
790
            raise BzrError("%r is not a versioned file" % filename)
 
 
795
class cmd_file_path(Command):
 
 
796
    """Print path of file_ids to a file or directory.
 
 
798
    This prints one line for each directory down to the target,
 
 
799
    starting at the branch root."""
 
 
801
    takes_args = ['filename']
 
 
802
    def run(self, filename):
 
 
803
        b = find_branch(filename)
 
 
805
        fid = inv.path2id(b.relpath(filename))
 
 
807
            raise BzrError("%r is not a versioned file" % filename)
 
 
808
        for fip in inv.get_idpath(fid):
 
 
812
class cmd_revision_history(Command):
 
 
813
    """Display list of revision ids on this branch."""
 
 
816
        for patchid in find_branch('.').revision_history():
 
 
820
class cmd_directories(Command):
 
 
821
    """Display list of versioned directories in this branch."""
 
 
823
        for name, ie in find_branch('.').read_working_inventory().directories():
 
 
830
class cmd_init(Command):
 
 
831
    """Make a directory into a versioned branch.
 
 
833
    Use this to create an empty branch, or before importing an
 
 
836
    Recipe for importing a tree of files:
 
 
841
        bzr commit -m 'imported project'
 
 
844
        from bzrlib.branch import Branch
 
 
845
        Branch('.', init=True)
 
 
848
class cmd_diff(Command):
 
 
849
    """Show differences in working tree.
 
 
851
    If files are listed, only the changes in those files are listed.
 
 
852
    Otherwise, all changes for the tree are listed.
 
 
854
    TODO: Allow diff across branches.
 
 
856
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
859
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
860
          either fix it up or prefer to use an external diff.
 
 
862
    TODO: If a directory is given, diff everything under that.
 
 
864
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
867
    TODO: This probably handles non-Unix newlines poorly.
 
 
875
    takes_args = ['file*']
 
 
876
    takes_options = ['revision', 'diff-options']
 
 
877
    aliases = ['di', 'dif']
 
 
879
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
880
        from bzrlib.diff import show_diff
 
 
883
            b = find_branch(file_list[0])
 
 
884
            file_list = [b.relpath(f) for f in file_list]
 
 
885
            if file_list == ['']:
 
 
886
                # just pointing to top-of-tree
 
 
891
        if revision is not None:
 
 
892
            if len(revision) == 1:
 
 
893
                show_diff(b, revision[0], specific_files=file_list,
 
 
894
                          external_diff_options=diff_options)
 
 
895
            elif len(revision) == 2:
 
 
896
                show_diff(b, revision[0], specific_files=file_list,
 
 
897
                          external_diff_options=diff_options,
 
 
898
                          revision2=revision[1])
 
 
900
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
 
902
            show_diff(b, None, specific_files=file_list,
 
 
903
                      external_diff_options=diff_options)
 
 
908
class cmd_deleted(Command):
 
 
909
    """List files deleted in the working tree.
 
 
911
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
913
    def run(self, show_ids=False):
 
 
916
        new = b.working_tree()
 
 
918
        ## TODO: Much more efficient way to do this: read in new
 
 
919
        ## directories with readdir, rather than stating each one.  Same
 
 
920
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
921
        ## if the directories are very large...)
 
 
923
        for path, ie in old.inventory.iter_entries():
 
 
924
            if not new.has_id(ie.file_id):
 
 
926
                    print '%-50s %s' % (path, ie.file_id)
 
 
931
class cmd_modified(Command):
 
 
932
    """List files modified in working tree."""
 
 
935
        from bzrlib.delta import compare_trees
 
 
938
        td = compare_trees(b.basis_tree(), b.working_tree())
 
 
940
        for path, id, kind in td.modified:
 
 
945
class cmd_added(Command):
 
 
946
    """List files added in working tree."""
 
 
950
        wt = b.working_tree()
 
 
951
        basis_inv = b.basis_tree().inventory
 
 
954
            if file_id in basis_inv:
 
 
956
            path = inv.id2path(file_id)
 
 
957
            if not os.access(b.abspath(path), os.F_OK):
 
 
963
class cmd_root(Command):
 
 
964
    """Show the tree root directory.
 
 
966
    The root is the nearest enclosing directory with a .bzr control
 
 
968
    takes_args = ['filename?']
 
 
969
    def run(self, filename=None):
 
 
970
        """Print the branch root."""
 
 
971
        b = find_branch(filename)
 
 
972
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
 
975
class cmd_log(Command):
 
 
976
    """Show log of this branch.
 
 
978
    To request a range of logs, you can use the command -r begin:end
 
 
979
    -r revision requests a specific revision, -r :end or -r begin: are
 
 
982
    --message allows you to give a regular expression, which will be evaluated
 
 
983
    so that only matching entries will be displayed.
 
 
985
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
989
    takes_args = ['filename?']
 
 
990
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
 
 
991
                     'long', 'message', 'short',]
 
 
993
    def run(self, filename=None, timezone='original',
 
 
1001
        from bzrlib.branch import find_branch
 
 
1002
        from bzrlib.log import log_formatter, show_log
 
 
1005
        direction = (forward and 'forward') or 'reverse'
 
 
1008
            b = find_branch(filename)
 
 
1009
            fp = b.relpath(filename)
 
 
1011
                file_id = b.read_working_inventory().path2id(fp)
 
 
1013
                file_id = None  # points to branch root
 
 
1015
            b = find_branch('.')
 
 
1018
        if revision is None:
 
 
1021
        elif len(revision) == 1:
 
 
1022
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
 
 
1023
        elif len(revision) == 2:
 
 
1024
            rev1 = b.get_revision_info(revision[0])[0]
 
 
1025
            rev2 = b.get_revision_info(revision[1])[0]
 
 
1027
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
 
1034
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
 
1036
        # use 'replace' so that we don't abort if trying to write out
 
 
1037
        # in e.g. the default C locale.
 
 
1038
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
 
1043
            log_format = 'short'
 
 
1044
        lf = log_formatter(log_format,
 
 
1047
                           show_timezone=timezone)
 
 
1053
                 direction=direction,
 
 
1054
                 start_revision=rev1,
 
 
1060
class cmd_touching_revisions(Command):
 
 
1061
    """Return revision-ids which affected a particular file.
 
 
1063
    A more user-friendly interface is "bzr log FILE"."""
 
 
1065
    takes_args = ["filename"]
 
 
1066
    def run(self, filename):
 
 
1067
        b = find_branch(filename)
 
 
1068
        inv = b.read_working_inventory()
 
 
1069
        file_id = inv.path2id(b.relpath(filename))
 
 
1070
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
1071
            print "%6d %s" % (revno, what)
 
 
1074
class cmd_ls(Command):
 
 
1075
    """List files in a tree.
 
 
1077
    TODO: Take a revision or remote path and list that tree instead.
 
 
1080
    def run(self, revision=None, verbose=False):
 
 
1081
        b = find_branch('.')
 
 
1082
        if revision == None:
 
 
1083
            tree = b.working_tree()
 
 
1085
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
1087
        for fp, fc, kind, fid in tree.list_files():
 
 
1089
                if kind == 'directory':
 
 
1091
                elif kind == 'file':
 
 
1096
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
1102
class cmd_unknowns(Command):
 
 
1103
    """List unknown files."""
 
 
1105
        from bzrlib.osutils import quotefn
 
 
1106
        for f in find_branch('.').unknowns():
 
 
1111
class cmd_ignore(Command):
 
 
1112
    """Ignore a command or pattern.
 
 
1114
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
1116
    If the pattern contains a slash, it is compared to the whole path
 
 
1117
    from the branch root.  Otherwise, it is comapred to only the last
 
 
1118
    component of the path.
 
 
1120
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
1122
    Note: wildcards must be quoted from the shell on Unix.
 
 
1125
        bzr ignore ./Makefile
 
 
1126
        bzr ignore '*.class'
 
 
1128
    takes_args = ['name_pattern']
 
 
1130
    def run(self, name_pattern):
 
 
1131
        from bzrlib.atomicfile import AtomicFile
 
 
1134
        b = find_branch('.')
 
 
1135
        ifn = b.abspath('.bzrignore')
 
 
1137
        if os.path.exists(ifn):
 
 
1140
                igns = f.read().decode('utf-8')
 
 
1146
        # TODO: If the file already uses crlf-style termination, maybe
 
 
1147
        # we should use that for the newly added lines?
 
 
1149
        if igns and igns[-1] != '\n':
 
 
1151
        igns += name_pattern + '\n'
 
 
1154
            f = AtomicFile(ifn, 'wt')
 
 
1155
            f.write(igns.encode('utf-8'))
 
 
1160
        inv = b.working_tree().inventory
 
 
1161
        if inv.path2id('.bzrignore'):
 
 
1162
            mutter('.bzrignore is already versioned')
 
 
1164
            mutter('need to make new .bzrignore file versioned')
 
 
1165
            b.add(['.bzrignore'])
 
 
1169
class cmd_ignored(Command):
 
 
1170
    """List ignored files and the patterns that matched them.
 
 
1172
    See also: bzr ignore"""
 
 
1174
        tree = find_branch('.').working_tree()
 
 
1175
        for path, file_class, kind, file_id in tree.list_files():
 
 
1176
            if file_class != 'I':
 
 
1178
            ## XXX: Slightly inefficient since this was already calculated
 
 
1179
            pat = tree.is_ignored(path)
 
 
1180
            print '%-50s %s' % (path, pat)
 
 
1183
class cmd_lookup_revision(Command):
 
 
1184
    """Lookup the revision-id from a revision-number
 
 
1187
        bzr lookup-revision 33
 
 
1190
    takes_args = ['revno']
 
 
1192
    def run(self, revno):
 
 
1196
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
1198
        print find_branch('.').lookup_revision(revno)
 
 
1201
class cmd_export(Command):
 
 
1202
    """Export past revision to destination directory.
 
 
1204
    If no revision is specified this exports the last committed revision.
 
 
1206
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
 
1207
    given, try to find the format with the extension. If no extension
 
 
1208
    is found exports to a directory (equivalent to --format=dir).
 
 
1210
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
 
1211
    is given, the top directory will be the root name of the file."""
 
 
1212
    # TODO: list known exporters
 
 
1213
    takes_args = ['dest']
 
 
1214
    takes_options = ['revision', 'format', 'root']
 
 
1215
    def run(self, dest, revision=None, format=None, root=None):
 
 
1217
        b = find_branch('.')
 
 
1218
        if revision is None:
 
 
1219
            rev_id = b.last_patch()
 
 
1221
            if len(revision) != 1:
 
 
1222
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
 
1223
            revno, rev_id = b.get_revision_info(revision[0])
 
 
1224
        t = b.revision_tree(rev_id)
 
 
1225
        root, ext = os.path.splitext(dest)
 
 
1227
            if ext in (".tar",):
 
 
1229
            elif ext in (".gz", ".tgz"):
 
 
1231
            elif ext in (".bz2", ".tbz2"):
 
 
1235
        t.export(dest, format, root)
 
 
1238
class cmd_cat(Command):
 
 
1239
    """Write a file's text from a previous revision."""
 
 
1241
    takes_options = ['revision']
 
 
1242
    takes_args = ['filename']
 
 
1244
    def run(self, filename, revision=None):
 
 
1245
        if revision == None:
 
 
1246
            raise BzrCommandError("bzr cat requires a revision number")
 
 
1247
        elif len(revision) != 1:
 
 
1248
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
 
1249
        b = find_branch('.')
 
 
1250
        b.print_file(b.relpath(filename), revision[0])
 
 
1253
class cmd_local_time_offset(Command):
 
 
1254
    """Show the offset in seconds from GMT to local time."""
 
 
1257
        print bzrlib.osutils.local_time_offset()
 
 
1261
class cmd_commit(Command):
 
 
1262
    """Commit changes into a new revision.
 
 
1264
    If no arguments are given, the entire tree is committed.
 
 
1266
    If selected files are specified, only changes to those files are
 
 
1267
    committed.  If a directory is specified then the directory and everything 
 
 
1268
    within it is committed.
 
 
1270
    A selected-file commit may fail in some cases where the committed
 
 
1271
    tree would be invalid, such as trying to commit a file in a
 
 
1272
    newly-added directory that is not itself committed.
 
 
1274
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
1276
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
1278
    takes_args = ['selected*']
 
 
1279
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
 
1280
    aliases = ['ci', 'checkin']
 
 
1282
    # TODO: Give better message for -s, --summary, used by tla people
 
 
1284
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
 
1286
        from bzrlib.errors import PointlessCommit
 
 
1287
        from bzrlib.osutils import get_text_message
 
 
1289
        ## Warning: shadows builtin file()
 
 
1290
        if not message and not file:
 
 
1291
            # FIXME: Ugly; change status code to send to a provided function?
 
 
1295
            catcher = cStringIO.StringIO()
 
 
1296
            sys.stdout = catcher
 
 
1297
            cmd_status({"file_list":selected_list}, {})
 
 
1298
            info = catcher.getvalue()
 
 
1300
            message = get_text_message(info)
 
 
1303
                raise BzrCommandError("please specify a commit message",
 
 
1304
                                      ["use either --message or --file"])
 
 
1305
        elif message and file:
 
 
1306
            raise BzrCommandError("please specify either --message or --file")
 
 
1310
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
1312
        b = find_branch('.')
 
 
1314
            selected_list = [b.relpath(s) for s in selected_list]
 
 
1317
            b.commit(message, verbose=verbose,
 
 
1318
                     specific_files=selected_list,
 
 
1319
                     allow_pointless=unchanged)
 
 
1320
        except PointlessCommit:
 
 
1321
            # FIXME: This should really happen before the file is read in;
 
 
1322
            # perhaps prepare the commit; get the message; then actually commit
 
 
1323
            raise BzrCommandError("no changes to commit",
 
 
1324
                                  ["use --unchanged to commit anyhow"])
 
 
1327
class cmd_check(Command):
 
 
1328
    """Validate consistency of branch history.
 
 
1330
    This command checks various invariants about the branch storage to
 
 
1331
    detect data corruption or bzr bugs.
 
 
1333
    If given the --update flag, it will update some optional fields
 
 
1334
    to help ensure data consistency.
 
 
1336
    takes_args = ['dir?']
 
 
1338
    def run(self, dir='.'):
 
 
1339
        from bzrlib.check import check
 
 
1340
        check(find_branch(dir))
 
 
1344
class cmd_scan_cache(Command):
 
 
1347
        from bzrlib.hashcache import HashCache
 
 
1354
        print '%6d stats' % c.stat_count
 
 
1355
        print '%6d in hashcache' % len(c._cache)
 
 
1356
        print '%6d files removed from cache' % c.removed_count
 
 
1357
        print '%6d hashes updated' % c.update_count
 
 
1358
        print '%6d files changed too recently to cache' % c.danger_count
 
 
1365
class cmd_upgrade(Command):
 
 
1366
    """Upgrade branch storage to current format.
 
 
1368
    This should normally be used only after the check command tells
 
 
1371
    takes_args = ['dir?']
 
 
1373
    def run(self, dir='.'):
 
 
1374
        from bzrlib.upgrade import upgrade
 
 
1375
        upgrade(find_branch(dir))
 
 
1379
class cmd_whoami(Command):
 
 
1380
    """Show bzr user id."""
 
 
1381
    takes_options = ['email']
 
 
1383
    def run(self, email=False):
 
 
1385
            b = bzrlib.branch.find_branch('.')
 
 
1390
            print bzrlib.osutils.user_email(b)
 
 
1392
            print bzrlib.osutils.username(b)
 
 
1395
class cmd_selftest(Command):
 
 
1396
    """Run internal test suite"""
 
 
1398
    takes_options = ['verbose']
 
 
1399
    def run(self, verbose=False):
 
 
1400
        from bzrlib.selftest import selftest
 
 
1401
        return int(not selftest(verbose=verbose))
 
 
1404
class cmd_version(Command):
 
 
1405
    """Show version of bzr."""
 
 
1410
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1411
    # is bzrlib itself in a branch?
 
 
1412
    bzrrev = bzrlib.get_bzr_revision()
 
 
1414
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
 
1415
    print bzrlib.__copyright__
 
 
1416
    print "http://bazaar-ng.org/"
 
 
1418
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1419
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1420
    print "General Public License version 2 or later."
 
 
1423
class cmd_rocks(Command):
 
 
1424
    """Statement of optimism."""
 
 
1427
        print "it sure does!"
 
 
1429
def parse_spec(spec):
 
 
1431
    >>> parse_spec(None)
 
 
1433
    >>> parse_spec("./")
 
 
1435
    >>> parse_spec("../@")
 
 
1437
    >>> parse_spec("../f/@35")
 
 
1439
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
 
 
1440
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
 
 
1445
        parsed = spec.split('/@')
 
 
1446
        assert len(parsed) == 2
 
 
1451
                parsed[1] = int(parsed[1])
 
 
1453
                pass # We can allow stuff like ./@revid:blahblahblah
 
 
1455
                assert parsed[1] >=0
 
 
1457
        parsed = [spec, None]
 
 
1462
class cmd_merge(Command):
 
 
1463
    """Perform a three-way merge.
 
 
1465
    The branch is the branch you will merge from.  By default, it will merge
 
 
1466
    the latest revision.  If you specify a revision, that revision will be
 
 
1467
    merged.  If you specify two revisions, the first will be used as a BASE, 
 
 
1468
    and the second one as OTHER.  Revision numbers are always relative to the
 
 
1473
    To merge the latest revision from bzr.dev
 
 
1474
    bzr merge ../bzr.dev
 
 
1476
    To merge changes up to and including revision 82 from bzr.dev
 
 
1477
    bzr merge -r 82 ../bzr.dev
 
 
1479
    To merge the changes introduced by 82, without previous changes:
 
 
1480
    bzr merge -r 81..82 ../bzr.dev
 
 
1482
    merge refuses to run if there are any uncommitted changes, unless
 
 
1485
    takes_args = ['branch?']
 
 
1486
    takes_options = ['revision', 'force', 'merge-type']
 
 
1488
    def run(self, branch='.', revision=None, force=False, 
 
 
1490
        from bzrlib.merge import merge
 
 
1491
        from bzrlib.merge_core import ApplyMerge3
 
 
1492
        if merge_type is None:
 
 
1493
            merge_type = ApplyMerge3
 
 
1495
        if revision is None or len(revision) < 1:
 
 
1497
            other = (branch, -1)
 
 
1499
            if len(revision) == 1:
 
 
1500
                other = (branch, revision[0])
 
 
1503
                assert len(revision) == 2
 
 
1504
                if None in revision:
 
 
1505
                    raise BzrCommandError(
 
 
1506
                        "Merge doesn't permit that revision specifier.")
 
 
1507
                base = (branch, revision[0])
 
 
1508
                other = (branch, revision[1])
 
 
1510
        merge(other, base, check_clean=(not force), merge_type=merge_type)
 
 
1513
class cmd_revert(Command):
 
 
1514
    """Reverse all changes since the last commit.
 
 
1516
    Only versioned files are affected.  Specify filenames to revert only 
 
 
1517
    those files.  By default, any files that are changed will be backed up
 
 
1518
    first.  Backup files have a '~' appended to their name.
 
 
1520
    takes_options = ['revision', 'no-backup']
 
 
1521
    takes_args = ['file*']
 
 
1522
    aliases = ['merge-revert']
 
 
1524
    def run(self, revision=None, no_backup=False, file_list=None):
 
 
1525
        from bzrlib.merge import merge
 
 
1526
        if file_list is not None:
 
 
1527
            if len(file_list) == 0:
 
 
1528
                raise BzrCommandError("No files specified")
 
 
1529
        if revision is None:
 
 
1531
        elif len(revision) != 1:
 
 
1532
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
1533
        merge(('.', revision[0]), parse_spec('.'),
 
 
1536
              backup_files=not no_backup,
 
 
1537
              file_list=file_list)
 
 
1540
class cmd_assert_fail(Command):
 
 
1541
    """Test reporting of assertion failures"""
 
 
1544
        assert False, "always fails"
 
 
1547
class cmd_help(Command):
 
 
1548
    """Show help on a command or other topic.
 
 
1550
    For a list of all available commands, say 'bzr help commands'."""
 
 
1551
    takes_args = ['topic?']
 
 
1554
    def run(self, topic=None):
 
 
1561
class cmd_missing(Command):
 
 
1562
    """What is missing in this branch relative to other branch.
 
 
1564
    takes_args = ['remote?']
 
 
1565
    aliases = ['mis', 'miss']
 
 
1566
    # We don't have to add quiet to the list, because 
 
 
1567
    # unknown options are parsed as booleans
 
 
1568
    takes_options = ['verbose', 'quiet']
 
 
1570
    def run(self, remote=None, verbose=False, quiet=False):
 
 
1571
        from bzrlib.branch import find_branch, DivergedBranches
 
 
1572
        from bzrlib.errors import BzrCommandError
 
 
1573
        from bzrlib.missing import get_parent, show_missing
 
 
1575
        if verbose and quiet:
 
 
1576
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
 
1578
        b = find_branch('.')
 
 
1579
        parent = get_parent(b)
 
 
1582
                raise BzrCommandError("No missing location known or specified.")
 
 
1585
                    print "Using last location: %s" % parent
 
 
1587
        elif parent is None:
 
 
1588
            # We only update x-pull if it did not exist, missing should not change the parent
 
 
1589
            b.controlfile('x-pull', 'wb').write(remote + '\n')
 
 
1590
        br_remote = find_branch(remote)
 
 
1592
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
 
1595
class cmd_plugins(Command):
 
 
1599
        import bzrlib.plugin
 
 
1600
        from inspect import getdoc
 
 
1601
        from pprint import pprint
 
 
1602
        for plugin in bzrlib.plugin.all_plugins:
 
 
1603
            print plugin.__path__[0]
 
 
1606
                print '\t', d.split('\n')[0]
 
 
1608
        #pprint(bzrlib.plugin.all_plugins)
 
 
1612
# list of all available options; the rhs can be either None for an
 
 
1613
# option that takes no argument, or a constructor function that checks
 
 
1617
    'diff-options':           str,
 
 
1626
    'revision':               _parse_revision_str,
 
 
1638
    'merge-type':             get_merge_type,
 
 
1651
def parse_args(argv):
 
 
1652
    """Parse command line.
 
 
1654
    Arguments and options are parsed at this level before being passed
 
 
1655
    down to specific command handlers.  This routine knows, from a
 
 
1656
    lookup table, something about the available options, what optargs
 
 
1657
    they take, and which commands will accept them.
 
 
1659
    >>> parse_args('--help'.split())
 
 
1660
    ([], {'help': True})
 
 
1661
    >>> parse_args('--version'.split())
 
 
1662
    ([], {'version': True})
 
 
1663
    >>> parse_args('status --all'.split())
 
 
1664
    (['status'], {'all': True})
 
 
1665
    >>> parse_args('commit --message=biter'.split())
 
 
1666
    (['commit'], {'message': u'biter'})
 
 
1667
    >>> parse_args('log -r 500'.split())
 
 
1668
    (['log'], {'revision': [500]})
 
 
1669
    >>> parse_args('log -r500..600'.split())
 
 
1670
    (['log'], {'revision': [500, 600]})
 
 
1671
    >>> parse_args('log -vr500..600'.split())
 
 
1672
    (['log'], {'verbose': True, 'revision': [500, 600]})
 
 
1673
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
 
 
1674
    (['log'], {'revision': ['v500', 600]})
 
 
1679
    # TODO: Maybe handle '--' to end options?
 
 
1684
            # option names must not be unicode
 
 
1688
                mutter("  got option %r" % a)
 
 
1690
                    optname, optarg = a[2:].split('=', 1)
 
 
1693
                if optname not in OPTIONS:
 
 
1694
                    raise BzrError('unknown long option %r' % a)
 
 
1697
                if shortopt in SHORT_OPTIONS:
 
 
1698
                    # Multi-character options must have a space to delimit
 
 
1700
                    optname = SHORT_OPTIONS[shortopt]
 
 
1702
                    # Single character short options, can be chained,
 
 
1703
                    # and have their value appended to their name
 
 
1705
                    if shortopt not in SHORT_OPTIONS:
 
 
1706
                        # We didn't find the multi-character name, and we
 
 
1707
                        # didn't find the single char name
 
 
1708
                        raise BzrError('unknown short option %r' % a)
 
 
1709
                    optname = SHORT_OPTIONS[shortopt]
 
 
1712
                        # There are extra things on this option
 
 
1713
                        # see if it is the value, or if it is another
 
 
1715
                        optargfn = OPTIONS[optname]
 
 
1716
                        if optargfn is None:
 
 
1717
                            # This option does not take an argument, so the
 
 
1718
                            # next entry is another short option, pack it back
 
 
1720
                            argv.insert(0, '-' + a[2:])
 
 
1722
                            # This option takes an argument, so pack it
 
 
1727
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
1728
                raise BzrError('repeated option %r' % a)
 
 
1730
            optargfn = OPTIONS[optname]
 
 
1734
                        raise BzrError('option %r needs an argument' % a)
 
 
1736
                        optarg = argv.pop(0)
 
 
1737
                opts[optname] = optargfn(optarg)
 
 
1740
                    raise BzrError('option %r takes no argument' % optname)
 
 
1741
                opts[optname] = True
 
 
1750
def _match_argform(cmd, takes_args, args):
 
 
1753
    # step through args and takes_args, allowing appropriate 0-many matches
 
 
1754
    for ap in takes_args:
 
 
1758
                argdict[argname] = args.pop(0)
 
 
1759
        elif ap[-1] == '*': # all remaining arguments
 
 
1761
                argdict[argname + '_list'] = args[:]
 
 
1764
                argdict[argname + '_list'] = None
 
 
1767
                raise BzrCommandError("command %r needs one or more %s"
 
 
1768
                        % (cmd, argname.upper()))
 
 
1770
                argdict[argname + '_list'] = args[:]
 
 
1772
        elif ap[-1] == '$': # all but one
 
 
1774
                raise BzrCommandError("command %r needs one or more %s"
 
 
1775
                        % (cmd, argname.upper()))
 
 
1776
            argdict[argname + '_list'] = args[:-1]
 
 
1782
                raise BzrCommandError("command %r requires argument %s"
 
 
1783
                        % (cmd, argname.upper()))
 
 
1785
                argdict[argname] = args.pop(0)
 
 
1788
        raise BzrCommandError("extra argument to command %s: %s"
 
 
1796
    """Execute a command.
 
 
1798
    This is similar to main(), but without all the trappings for
 
 
1799
    logging and error handling.  
 
 
1802
       The command-line arguments, without the program name from argv[0]
 
 
1804
    Returns a command status or raises an exception.
 
 
1806
    Special master options: these must come before the command because
 
 
1807
    they control how the command is interpreted.
 
 
1810
        Do not load plugin modules at all
 
 
1813
        Only use builtin commands.  (Plugins are still allowed to change
 
 
1817
        Run under the Python profiler.
 
 
1820
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
1822
    opt_profile = opt_no_plugins = opt_builtin = False
 
 
1824
    # --no-plugins is handled specially at a very early stage. We need
 
 
1825
    # to load plugins before doing other command parsing so that they
 
 
1826
    # can override commands, but this needs to happen first.
 
 
1829
        if a == '--profile':
 
 
1831
        elif a == '--no-plugins':
 
 
1832
            opt_no_plugins = True
 
 
1833
        elif a == '--builtin':
 
 
1839
    if not opt_no_plugins:
 
 
1840
        from bzrlib.plugin import load_plugins
 
 
1843
    args, opts = parse_args(argv)
 
 
1846
        from bzrlib.help import help
 
 
1853
    if 'version' in opts:
 
 
1858
        print >>sys.stderr, "please try 'bzr help' for help"
 
 
1861
    cmd = str(args.pop(0))
 
 
1863
    canonical_cmd, cmd_class = \
 
 
1864
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
 
 
1866
    # check options are reasonable
 
 
1867
    allowed = cmd_class.takes_options
 
 
1869
        if oname not in allowed:
 
 
1870
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
 
1873
    # mix arguments and options into one dictionary
 
 
1874
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
 
1876
    for k, v in opts.items():
 
 
1877
        cmdopts[k.replace('-', '_')] = v
 
 
1880
        import hotshot, tempfile
 
 
1881
        pffileno, pfname = tempfile.mkstemp()
 
 
1883
            prof = hotshot.Profile(pfname)
 
 
1884
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
 
1887
            import hotshot.stats
 
 
1888
            stats = hotshot.stats.load(pfname)
 
 
1890
            stats.sort_stats('time')
 
 
1891
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
1892
            ## print_stats seems hardcoded to stdout
 
 
1893
            stats.print_stats(20)
 
 
1901
        return cmd_class(cmdopts, cmdargs).status 
 
 
1904
def _report_exception(summary, quiet=False):
 
 
1907
    log_error('bzr: ' + summary)
 
 
1908
    bzrlib.trace.log_exception()
 
 
1910
    if os.environ.get('BZR_DEBUG'):
 
 
1911
        traceback.print_exc()
 
 
1914
        sys.stderr.write('\n')
 
 
1915
        tb = sys.exc_info()[2]
 
 
1916
        exinfo = traceback.extract_tb(tb)
 
 
1918
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
 
1919
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
 
1925
    bzrlib.trace.open_tracefile(argv)
 
 
1930
                return run_bzr(argv[1:])
 
 
1932
                # do this here inside the exception wrappers to catch EPIPE
 
 
1935
            quiet = isinstance(e, (BzrCommandError))
 
 
1936
            _report_exception('error: ' + str(e), quiet=quiet)
 
 
1939
                    # some explanation or hints
 
 
1942
        except AssertionError, e:
 
 
1943
            msg = 'assertion failed'
 
 
1945
                msg += ': ' + str(e)
 
 
1946
            _report_exception(msg)
 
 
1948
        except KeyboardInterrupt, e:
 
 
1949
            _report_exception('interrupted', quiet=True)
 
 
1951
        except Exception, e:
 
 
1954
            if (isinstance(e, IOError) 
 
 
1955
                and hasattr(e, 'errno')
 
 
1956
                and e.errno == errno.EPIPE):
 
 
1960
                msg = str(e).rstrip('\n')
 
 
1961
            _report_exception(msg, quiet)
 
 
1964
        bzrlib.trace.close_trace()
 
 
1967
if __name__ == '__main__':
 
 
1968
    sys.exit(main(sys.argv))