1
# Copyright (C) 2004, 2005 by Martin Pool
 
 
2
# Copyright (C) 2005 by Canonical Ltd
 
 
5
# This program is free software; you can redistribute it and/or modify
 
 
6
# it under the terms of the GNU General Public License as published by
 
 
7
# the Free Software Foundation; either version 2 of the License, or
 
 
8
# (at your option) any later version.
 
 
10
# This program is distributed in the hope that it will be useful,
 
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
13
# GNU General Public License for more details.
 
 
15
# You should have received a copy of the GNU General Public License
 
 
16
# along with this program; if not, write to the Free Software
 
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
19
"""Bazaar-NG -- a free distributed version-control tool
 
 
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
 
24
* Metadata format is not stable yet -- you may need to
 
 
25
  discard history in the future.
 
 
27
* Many commands unimplemented or partially implemented.
 
 
29
* Space-inefficient storage.
 
 
31
* No merge operators yet.
 
 
38
      Show software version/licence/non-warranty.
 
 
40
      Start versioning the current directory
 
 
44
      Show revision history.
 
 
47
  bzr move FROM... DESTDIR
 
 
48
      Move one or more files to a different directory.
 
 
50
      Show changes from last revision to working copy.
 
 
51
  bzr commit -m 'MESSAGE'
 
 
52
      Store current state as new revision.
 
 
53
  bzr export REVNO DESTINATION
 
 
54
      Export the branch state at a previous version.
 
 
56
      Show summary of pending changes.
 
 
58
      Make a file not versioned.
 
 
60
      Show statistics about this branch.
 
 
62
      Verify history is stored safely. 
 
 
63
  (for more type 'bzr help commands')
 
 
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
 
 
71
from pprint import pprint
 
 
74
from inspect import getdoc
 
 
77
from bzrlib.store import ImmutableStore
 
 
78
from bzrlib.trace import mutter, note, log_error
 
 
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
 
 
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
 
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
 
82
from bzrlib.revision import Revision
 
 
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
 
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
 
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
 
89
## standard representation
 
 
90
NONE_STRING = '(none)'
 
 
94
## TODO: Perhaps a different version of inventory commands that
 
 
95
## returns iterators...
 
 
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
 
99
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
 
100
## parameter to the branch object saying whether we want a read or
 
 
101
## write lock; release it from destructor.  Perhaps don't even need a
 
 
102
## read lock to look at immutable objects?
 
 
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
 
105
## to compare output?
 
 
107
## TODO: Some kind of global code to generate the right Branch object
 
 
108
## to work on.  Almost, but not quite all, commands need one, and it
 
 
109
## can be taken either from their parameters or their working
 
 
124
def get_cmd_handler(cmd):
 
 
127
    cmd = cmd_aliases.get(cmd, cmd)
 
 
130
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
 
132
        raise BzrError("unknown command %r" % cmd)
 
 
134
    return cmd, cmd_handler
 
 
138
def cmd_status(all=False):
 
 
139
    """Display status summary.
 
 
141
    For each file there is a single line giving its file state and name.
 
 
142
    The name is that in the current revision unless it is deleted or
 
 
143
    missing, in which case the old name is shown.
 
 
145
    #import bzrlib.status
 
 
146
    #bzrlib.status.tree_status(Branch('.'))
 
 
147
    Branch('.').show_status(show_all=all)
 
 
151
######################################################################
 
 
153
def cmd_get_revision(revision_id):
 
 
154
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
 
157
def cmd_get_file_text(text_id):
 
 
158
    """Get contents of a file by hash."""
 
 
159
    sf = Branch('.').text_store[text_id]
 
 
160
    pumpfile(sf, sys.stdout)
 
 
164
######################################################################
 
 
169
    """Show number of revisions on this branch"""
 
 
170
    print Branch('.').revno()
 
 
174
def cmd_add(file_list, verbose=False):
 
 
175
    """Add specified files or directories.
 
 
177
    In non-recursive mode, all the named items are added, regardless
 
 
178
    of whether they were previously ignored.  A warning is given if
 
 
179
    any of the named files are already versioned.
 
 
181
    In recursive mode (the default), files are treated the same way
 
 
182
    but the behaviour for directories is different.  Directories that
 
 
183
    are already versioned do not give a warning.  All directories,
 
 
184
    whether already versioned or not, are searched for files or
 
 
185
    subdirectories that are neither versioned or ignored, and these
 
 
186
    are added.  This search proceeds recursively into versioned
 
 
189
    Therefore simply saying 'bzr add .' will version all files that
 
 
190
    are currently unknown.
 
 
192
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
193
    recursively add that parent, rather than giving an error?
 
 
195
    bzrlib.add.smart_add(file_list, verbose)
 
 
198
def cmd_relpath(filename):
 
 
199
    """Show path of file relative to root"""
 
 
200
    print Branch(filename).relpath(filename)
 
 
204
def cmd_inventory(revision=None):
 
 
205
    """Show inventory of the current working copy."""
 
 
206
    ## TODO: Also optionally show a previous inventory
 
 
207
    ## TODO: Format options
 
 
210
        inv = b.read_working_inventory()
 
 
212
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
 
214
    for path, entry in inv.iter_entries():
 
 
215
        print '%-50s %s' % (entry.file_id, path)
 
 
219
# TODO: Maybe a 'mv' command that has the combined move/rename
 
 
220
# special behaviour of Unix?
 
 
222
def cmd_move(source_list, dest):
 
 
225
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
229
def cmd_rename(from_name, to_name):
 
 
230
    """Change the name of an entry.
 
 
232
    usage: bzr rename FROM_NAME TO_NAME
 
 
235
      bzr rename frob.c frobber.c
 
 
236
      bzr rename src/frob.c lib/frob.c
 
 
238
    It is an error if the destination name exists.
 
 
240
    See also the 'move' command, which moves files into a different
 
 
241
    directory without changing their name.
 
 
243
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
246
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
251
def cmd_renames(dir='.'):
 
 
252
    """Show list of renamed files.
 
 
254
    usage: bzr renames [BRANCH]
 
 
256
    TODO: Option to show renames between two historical versions.
 
 
258
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
261
    old_inv = b.basis_tree().inventory
 
 
262
    new_inv = b.read_working_inventory()
 
 
264
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
266
    for old_name, new_name in renames:
 
 
267
        print "%s => %s" % (old_name, new_name)        
 
 
272
    """info: Show statistical information for this branch
 
 
276
    info.show_info(Branch('.'))        
 
 
280
def cmd_remove(file_list, verbose=False):
 
 
281
    b = Branch(file_list[0])
 
 
282
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
286
def cmd_file_id(filename):
 
 
287
    """Print file_id of a particular file or directory.
 
 
289
    usage: bzr file-id FILE
 
 
291
    The file_id is assigned when the file is first added and remains the
 
 
292
    same through all revisions where the file exists, even when it is
 
 
296
    i = b.inventory.path2id(b.relpath(filename))
 
 
298
        bailout("%r is not a versioned file" % filename)
 
 
303
def cmd_file_id_path(filename):
 
 
304
    """Print path of file_ids to a file or directory.
 
 
306
    usage: bzr file-id-path FILE
 
 
308
    This prints one line for each directory down to the target,
 
 
309
    starting at the branch root."""
 
 
312
    fid = inv.path2id(b.relpath(filename))
 
 
314
        bailout("%r is not a versioned file" % filename)
 
 
315
    for fip in inv.get_idpath(fid):
 
 
319
def cmd_revision_history():
 
 
320
    for patchid in Branch('.').revision_history():
 
 
324
def cmd_directories():
 
 
325
    for name, ie in Branch('.').read_working_inventory().directories():
 
 
333
    for name, ie in Branch('.').working_tree().missing():
 
 
338
    # TODO: Check we're not already in a working directory?  At the
 
 
339
    # moment you'll get an ugly error.
 
 
341
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
 
342
    # to allow that, but then the parent may need to understand that
 
 
343
    # the children have disappeared, or should they be versioned in
 
 
346
    # TODO: Take an argument/option for branch name.
 
 
347
    Branch('.', init=True)
 
 
350
def cmd_diff(revision=None, file_list=None):
 
 
351
    """bzr diff: Show differences in working tree.
 
 
353
    usage: bzr diff [-r REV] [FILE...]
 
 
356
         Show changes since REV, rather than predecessor.
 
 
358
    If files are listed, only the changes in those files are listed.
 
 
359
    Otherwise, all changes for the tree are listed.
 
 
361
    TODO: Given two revision arguments, show the difference between them.
 
 
363
    TODO: Allow diff across branches.
 
 
365
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
368
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
369
          either fix it up or prefer to use an external diff.
 
 
371
    TODO: If a directory is given, diff everything under that.
 
 
373
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
376
    TODO: This probably handles non-Unix newlines poorly.
 
 
379
    ## TODO: Shouldn't be in the cmd function.
 
 
384
        old_tree = b.basis_tree()
 
 
386
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
 
388
    new_tree = b.working_tree()
 
 
390
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
394
    DEVNULL = '/dev/null'
 
 
395
    # Windows users, don't panic about this filename -- it is a
 
 
396
    # special signal to GNU patch that the file should be created or
 
 
397
    # deleted respectively.
 
 
399
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
400
    # be usefully made into a much faster special case.
 
 
402
    # TODO: Better to return them in sorted order I think.
 
 
405
        file_list = [b.relpath(f) for f in file_list]
 
 
407
    # FIXME: If given a file list, compare only those files rather
 
 
408
    # than comparing everything and then throwing stuff away.
 
 
410
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
 
412
        if file_list and (new_name not in file_list):
 
 
415
        # Don't show this by default; maybe do it if an option is passed
 
 
416
        # idlabel = '      {%s}' % fid
 
 
419
        # FIXME: Something about the diff format makes patch unhappy
 
 
420
        # with newly-added files.
 
 
422
        def diffit(oldlines, newlines, **kw):
 
 
424
            # FIXME: difflib is wrong if there is no trailing newline.
 
 
425
            # The syntax used by patch seems to be "\ No newline at
 
 
426
            # end of file" following the last diff line from that
 
 
427
            # file.  This is not trivial to insert into the
 
 
428
            # unified_diff output and it might be better to just fix
 
 
429
            # or replace that function.
 
 
431
            # In the meantime we at least make sure the patch isn't
 
 
435
            # Special workaround for Python2.3, where difflib fails if
 
 
436
            # both sequences are empty.
 
 
437
            if not oldlines and not newlines:
 
 
442
            if oldlines and (oldlines[-1][-1] != '\n'):
 
 
445
            if newlines and (newlines[-1][-1] != '\n'):
 
 
449
            ud = difflib.unified_diff(oldlines, newlines, **kw)
 
 
450
            sys.stdout.writelines(ud)
 
 
452
                print "\\ No newline at end of file"
 
 
453
            sys.stdout.write('\n')
 
 
455
        if file_state in ['.', '?', 'I']:
 
 
457
        elif file_state == 'A':
 
 
458
            print '*** added %s %r' % (kind, new_name)
 
 
461
                       new_tree.get_file(fid).readlines(),
 
 
463
                       tofile=new_label + new_name + idlabel)
 
 
464
        elif file_state == 'D':
 
 
465
            assert isinstance(old_name, types.StringTypes)
 
 
466
            print '*** deleted %s %r' % (kind, old_name)
 
 
468
                diffit(old_tree.get_file(fid).readlines(), [],
 
 
469
                       fromfile=old_label + old_name + idlabel,
 
 
471
        elif file_state in ['M', 'R']:
 
 
472
            if file_state == 'M':
 
 
473
                assert kind == 'file'
 
 
474
                assert old_name == new_name
 
 
475
                print '*** modified %s %r' % (kind, new_name)
 
 
476
            elif file_state == 'R':
 
 
477
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
 
480
                diffit(old_tree.get_file(fid).readlines(),
 
 
481
                       new_tree.get_file(fid).readlines(),
 
 
482
                       fromfile=old_label + old_name + idlabel,
 
 
483
                       tofile=new_label + new_name)
 
 
485
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
 
489
def cmd_deleted(show_ids=False):
 
 
490
    """List files deleted in the working tree.
 
 
492
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
496
    new = b.working_tree()
 
 
498
    ## TODO: Much more efficient way to do this: read in new
 
 
499
    ## directories with readdir, rather than stating each one.  Same
 
 
500
    ## level of effort but possibly much less IO.  (Or possibly not,
 
 
501
    ## if the directories are very large...)
 
 
503
    for path, ie in old.inventory.iter_entries():
 
 
504
        if not new.has_id(ie.file_id):
 
 
506
                print '%-50s %s' % (path, ie.file_id)
 
 
512
def cmd_parse_inventory():
 
 
515
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
 
519
def cmd_load_inventory():
 
 
520
    """Load inventory for timing purposes"""
 
 
521
    Branch('.').basis_tree().inventory
 
 
524
def cmd_dump_inventory():
 
 
525
    Branch('.').read_working_inventory().write_xml(sys.stdout)
 
 
528
def cmd_dump_new_inventory():
 
 
529
    import bzrlib.newinventory
 
 
530
    inv = Branch('.').basis_tree().inventory
 
 
531
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
 
534
def cmd_load_new_inventory():
 
 
535
    import bzrlib.newinventory
 
 
536
    bzrlib.newinventory.read_new_inventory(sys.stdin)
 
 
539
def cmd_dump_slacker_inventory():
 
 
540
    import bzrlib.newinventory
 
 
541
    inv = Branch('.').basis_tree().inventory
 
 
542
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
 
546
def cmd_dump_text_inventory():
 
 
547
    import bzrlib.textinv
 
 
548
    inv = Branch('.').basis_tree().inventory
 
 
549
    bzrlib.textinv.write_text_inventory(inv, sys.stdout)
 
 
552
def cmd_load_text_inventory():
 
 
553
    import bzrlib.textinv
 
 
554
    inv = bzrlib.textinv.read_text_inventory(sys.stdin)
 
 
555
    print 'loaded %d entries' % len(inv)
 
 
559
def cmd_root(filename=None):
 
 
560
    """Print the branch root."""
 
 
561
    print bzrlib.branch.find_branch_root(filename)
 
 
564
def cmd_log(timezone='original', verbose=False):
 
 
565
    """Show log of this branch.
 
 
567
    TODO: Options for utc; to show ids; to limit range; etc.
 
 
569
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
 
 
572
def cmd_ls(revision=None, verbose=False):
 
 
573
    """List files in a tree.
 
 
575
    TODO: Take a revision or remote path and list that tree instead.
 
 
579
        tree = b.working_tree()
 
 
581
        tree = b.revision_tree(b.lookup_revision(revision))
 
 
583
    for fp, fc, kind, fid in tree.list_files():
 
 
585
            if kind == 'directory':
 
 
592
            print '%-8s %s%s' % (fc, fp, kindch)
 
 
599
    """List unknown files"""
 
 
600
    for f in Branch('.').unknowns():
 
 
605
def cmd_ignore(name_pattern):
 
 
606
    """Ignore a command or pattern"""
 
 
610
    # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
 
 
611
    f = open(b.abspath('.bzrignore'), 'at')
 
 
612
    f.write(name_pattern + '\n')
 
 
615
    inv = b.working_tree().inventory
 
 
616
    if inv.path2id('.bzrignore'):
 
 
617
        mutter('.bzrignore is already versioned')
 
 
619
        mutter('need to make new .bzrignore file versioned')
 
 
620
        b.add(['.bzrignore'])
 
 
625
    """List ignored files and the patterns that matched them.
 
 
627
    tree = Branch('.').working_tree()
 
 
628
    for path, file_class, kind, file_id in tree.list_files():
 
 
629
        if file_class != 'I':
 
 
631
        ## XXX: Slightly inefficient since this was already calculated
 
 
632
        pat = tree.is_ignored(path)
 
 
633
        print '%-50s %s' % (path, pat)
 
 
636
def cmd_lookup_revision(revno):
 
 
640
        bailout("usage: lookup-revision REVNO",
 
 
641
                ["REVNO is a non-negative revision number for this branch"])
 
 
643
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
 
647
def cmd_export(revno, dest):
 
 
648
    """Export past revision to destination directory."""
 
 
650
    rh = b.lookup_revision(int(revno))
 
 
651
    t = b.revision_tree(rh)
 
 
654
def cmd_cat(revision, filename):
 
 
655
    """Print file to stdout."""
 
 
657
    b.print_file(b.relpath(filename), int(revision))
 
 
660
######################################################################
 
 
661
# internal/test commands
 
 
665
    """Print a newly-generated UUID."""
 
 
666
    print bzrlib.osutils.uuid()
 
 
670
def cmd_local_time_offset():
 
 
671
    print bzrlib.osutils.local_time_offset()
 
 
675
def cmd_commit(message=None, verbose=False):
 
 
676
    """Commit changes to a new revision.
 
 
679
        Description of changes in this revision; free form text.
 
 
680
        It is recommended that the first line be a single-sentence
 
 
683
        Show status of changed files,
 
 
685
    TODO: Commit only selected files.
 
 
687
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
689
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
693
        bailout("please specify a commit message")
 
 
694
    Branch('.').commit(message, verbose=verbose)
 
 
697
def cmd_check(dir='.'):
 
 
698
    """check: Consistency check of branch history.
 
 
700
    usage: bzr check [-v] [BRANCH]
 
 
703
      --verbose, -v         Show progress of checking.
 
 
705
    This command checks various invariants about the branch storage to
 
 
706
    detect data corruption or bzr bugs.
 
 
709
    bzrlib.check.check(Branch(dir, find_root=False))
 
 
712
def cmd_is(pred, *rest):
 
 
713
    """Test whether PREDICATE is true."""
 
 
715
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
 
717
        bailout("unknown predicate: %s" % quotefn(pred))
 
 
721
    except BzrCheckError:
 
 
722
        # by default we don't print the message so that this can
 
 
723
        # be used from shell scripts without producing noise
 
 
727
def cmd_whoami(email=False):
 
 
733
        --email             Show only the email address.
 
 
737
        print bzrlib.osutils.user_email()
 
 
739
        print bzrlib.osutils.username()
 
 
742
def cmd_gen_revision_id():
 
 
743
    print bzrlib.branch._gen_revision_id(time.time())
 
 
747
    """Run internal test suite"""
 
 
748
    ## -v, if present, is seen by doctest; the argument is just here
 
 
749
    ## so our parser doesn't complain
 
 
751
    ## TODO: --verbose option
 
 
753
    failures, tests = 0, 0
 
 
755
    import doctest, bzrlib.store, bzrlib.tests
 
 
756
    bzrlib.trace.verbose = False
 
 
758
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
 
759
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
 
760
        mf, mt = doctest.testmod(m)
 
 
763
        print '%-40s %3d tests' % (m.__name__, mt),
 
 
765
            print '%3d FAILED!' % mf
 
 
769
    print '%-40s %3d tests' % ('total', tests),
 
 
771
        print '%3d FAILED!' % failures
 
 
778
cmd_doctest = cmd_selftest
 
 
781
######################################################################
 
 
785
def cmd_help(topic=None):
 
 
788
    elif topic == 'commands':
 
 
791
        # otherwise, maybe the name of a command?
 
 
792
        topic, cmdfn = get_cmd_handler(topic)
 
 
796
            bailout("sorry, no detailed help yet for %r" % topic)
 
 
802
    """List all commands"""
 
 
804
    for k in globals().keys():
 
 
805
        if k.startswith('cmd_'):
 
 
806
            accu.append(k[4:].replace('_','-'))
 
 
808
    print "bzr commands: "
 
 
811
    print "note: some of these commands are internal-use or obsolete"
 
 
812
    # TODO: Some kind of marker for internal-use commands?
 
 
813
    # TODO: Show aliases?
 
 
819
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
820
    print bzrlib.__copyright__
 
 
821
    print "http://bazaar-ng.org/"
 
 
824
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
 
825
you may use, modify and redistribute it under the terms of the GNU 
 
 
826
General Public License version 2 or later."""
 
 
830
    """Statement of optimism."""
 
 
831
    print "it sure does!"
 
 
835
######################################################################
 
 
839
# list of all available options; the rhs can be either None for an
 
 
840
# option that takes no argument, or a constructor function that checks
 
 
861
# List of options that apply to particular commands; commands not
 
 
866
    'commit':                 ['message', 'verbose'],
 
 
867
    'deleted':                ['show-ids'],
 
 
868
    'diff':                   ['revision'],
 
 
869
    'inventory':              ['revision'],
 
 
870
    'log':                    ['timezone', 'verbose'],
 
 
871
    'ls':                     ['revision', 'verbose'],
 
 
872
    'remove':                 ['verbose'],
 
 
883
    'export':                 ['revno', 'dest'],
 
 
884
    'file-id':                ['filename'],
 
 
885
    'file-id-path':           ['filename'],
 
 
886
    'get-file-text':          ['text_id'],
 
 
887
    'get-inventory':          ['inventory_id'],
 
 
888
    'get-revision':           ['revision_id'],
 
 
889
    'get-revision-inventory': ['revision_id'],
 
 
891
    'ignore':                 ['name_pattern'],
 
 
894
    'lookup-revision':        ['revno'],
 
 
895
    'move':                   ['source$', 'dest'],
 
 
896
    'relpath':                ['filename'],
 
 
898
    'rename':                 ['from_name', 'to_name'],
 
 
900
    'root':                   ['filename?'],
 
 
905
def parse_args(argv):
 
 
906
    """Parse command line.
 
 
908
    Arguments and options are parsed at this level before being passed
 
 
909
    down to specific command handlers.  This routine knows, from a
 
 
910
    lookup table, something about the available options, what optargs
 
 
911
    they take, and which commands will accept them.
 
 
913
    >>> parse_args('--help'.split())
 
 
915
    >>> parse_args('--version'.split())
 
 
916
    ([], {'version': True})
 
 
917
    >>> parse_args('status --all'.split())
 
 
918
    (['status'], {'all': True})
 
 
919
    >>> parse_args('commit --message=biter'.split())
 
 
920
    (['commit'], {'message': u'biter'})
 
 
925
    # TODO: Maybe handle '--' to end options?
 
 
930
            # option names must not be unicode
 
 
934
                mutter("  got option %r" % a)
 
 
936
                    optname, optarg = a[2:].split('=', 1)
 
 
939
                if optname not in OPTIONS:
 
 
940
                    bailout('unknown long option %r' % a)
 
 
943
                if shortopt not in SHORT_OPTIONS:
 
 
944
                    bailout('unknown short option %r' % a)
 
 
945
                optname = SHORT_OPTIONS[shortopt]
 
 
948
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
949
                bailout('repeated option %r' % a)
 
 
951
            optargfn = OPTIONS[optname]
 
 
955
                        bailout('option %r needs an argument' % a)
 
 
958
                opts[optname] = optargfn(optarg)
 
 
961
                    bailout('option %r takes no argument' % optname)
 
 
970
def _match_args(cmd, args):
 
 
971
    """Check non-option arguments match required pattern.
 
 
973
    >>> _match_args('status', ['asdasdsadasd'])
 
 
974
    Traceback (most recent call last):
 
 
976
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
 
977
    >>> _match_args('add', ['asdasdsadasd'])
 
 
978
    {'file_list': ['asdasdsadasd']}
 
 
979
    >>> _match_args('add', 'abc def gj'.split())
 
 
980
    {'file_list': ['abc', 'def', 'gj']}
 
 
982
    # match argument pattern
 
 
983
    argform = cmd_args.get(cmd, [])
 
 
985
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
 
988
    # step through args and argform, allowing appropriate 0-many matches
 
 
993
                argdict[argname] = args.pop(0)
 
 
994
        elif ap[-1] == '*': # all remaining arguments
 
 
996
                argdict[argname + '_list'] = args[:]
 
 
999
                argdict[argname + '_list'] = None
 
 
1002
                bailout("command %r needs one or more %s"
 
 
1003
                        % (cmd, argname.upper()))
 
 
1005
                argdict[argname + '_list'] = args[:]
 
 
1007
        elif ap[-1] == '$': # all but one
 
 
1009
                bailout("command %r needs one or more %s"
 
 
1010
                        % (cmd, argname.upper()))
 
 
1011
            argdict[argname + '_list'] = args[:-1]
 
 
1017
                bailout("command %r requires argument %s"
 
 
1018
                        % (cmd, argname.upper()))
 
 
1020
                argdict[argname] = args.pop(0)
 
 
1023
        bailout("extra arguments to command %s: %r"
 
 
1031
    """Execute a command.
 
 
1033
    This is similar to main(), but without all the trappings for
 
 
1034
    logging and error handling.  
 
 
1037
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
1040
        args, opts = parse_args(argv[1:])
 
 
1042
            # TODO: pass down other arguments in case they asked for
 
 
1043
            # help on a command name?
 
 
1049
        elif 'version' in opts:
 
 
1052
        cmd = str(args.pop(0))
 
 
1054
        log_error('usage: bzr COMMAND')
 
 
1055
        log_error('  try "bzr help"')
 
 
1058
    canonical_cmd, cmd_handler = get_cmd_handler(cmd)
 
 
1061
    if 'profile' in opts:
 
 
1067
    # check options are reasonable
 
 
1068
    allowed = cmd_options.get(canonical_cmd, [])
 
 
1070
        if oname not in allowed:
 
 
1071
            bailout("option %r is not allowed for command %r"
 
 
1074
    # TODO: give an error if there are any mandatory options which are
 
 
1075
    # not specified?  Or maybe there shouldn't be any "mandatory
 
 
1076
    # options" (it is an oxymoron)
 
 
1078
    # mix arguments and options into one dictionary
 
 
1079
    cmdargs = _match_args(canonical_cmd, args)
 
 
1080
    for k, v in opts.items():
 
 
1081
        cmdargs[k.replace('-', '_')] = v
 
 
1085
        pffileno, pfname = tempfile.mkstemp()
 
 
1087
            prof = hotshot.Profile(pfname)
 
 
1088
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
 
1091
            import hotshot.stats
 
 
1092
            stats = hotshot.stats.load(pfname)
 
 
1094
            stats.sort_stats('time')
 
 
1095
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
1096
            ## print_stats seems hardcoded to stdout
 
 
1097
            stats.print_stats(20)
 
 
1105
        return cmd_handler(**cmdargs) or 0
 
 
1109
def _report_exception(e, summary, quiet=False):
 
 
1111
    log_error('bzr: ' + summary)
 
 
1112
    bzrlib.trace.log_exception(e)
 
 
1115
        tb = sys.exc_info()[2]
 
 
1116
        exinfo = traceback.extract_tb(tb)
 
 
1118
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
 
1119
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
 
1122
def cmd_assert_fail():
 
 
1123
    assert False, "always fails"
 
 
1129
    bzrlib.trace.create_tracefile(argv)
 
 
1134
            # do this here to catch EPIPE
 
 
1138
            _report_exception(e, 'error: ' + e.args[0])
 
 
1141
                    # some explanation or hints
 
 
1144
        except AssertionError, e:
 
 
1145
            msg = 'assertion failed'
 
 
1147
                msg += ': ' + str(e)
 
 
1148
            _report_exception(e, msg)
 
 
1150
        except KeyboardInterrupt, e:
 
 
1151
            _report_exception(e, 'interrupted', quiet=True)
 
 
1153
        except Exception, e:
 
 
1155
            if isinstance(e, IOError) and e.errno == errno.EPIPE:
 
 
1159
                msg = str(e).rstrip('\n')
 
 
1160
            _report_exception(e, msg, quiet)
 
 
1163
        bzrlib.trace.close_trace()
 
 
1166
if __name__ == '__main__':
 
 
1167
    sys.exit(main(sys.argv))