~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-04-15 01:31:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/python
2
 
 
3
 
 
4
1
# Copyright (C) 2004, 2005 by Martin Pool
5
2
# Copyright (C) 2005 by Canonical Ltd
6
3
 
28
25
* Metadata format is not stable yet -- you may need to
29
26
  discard history in the future.
30
27
 
31
 
* No handling of subdirectories, symlinks or any non-text files.
32
 
 
33
28
* Insufficient error handling.
34
29
 
35
30
* Many commands unimplemented or partially implemented.
40
35
 
41
36
Interesting commands::
42
37
 
43
 
  bzr help
44
 
       Show summary help screen
 
38
  bzr help [COMMAND]
 
39
       Show help screen
45
40
  bzr version
46
41
       Show software version/licence/non-warranty.
47
42
  bzr init
50
45
       Make files versioned.
51
46
  bzr log
52
47
       Show revision history.
53
 
  bzr diff
 
48
  bzr diff [FILE...]
54
49
       Show changes from last revision to working copy.
55
50
  bzr commit -m 'MESSAGE'
56
51
       Store current state as new revision.
60
55
       Show summary of pending changes.
61
56
  bzr remove FILE...
62
57
       Make a file not versioned.
 
58
  bzr info
 
59
       Show statistics about this branch.
63
60
"""
64
61
 
65
 
# not currently working:
66
 
#  bzr check
67
 
#       Run internal consistency checks.
68
 
#  bzr info
69
 
#       Show some information about this branch.
70
 
 
71
 
 
72
 
 
73
 
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
 
__author__ = "Martin Pool <mbp@canonical.com>"
75
 
__docformat__ = "restructuredtext en"
76
 
__version__ = '0.0.0'
77
 
 
78
 
 
79
 
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
 
import traceback, socket, fnmatch, difflib
81
 
from os import path
 
62
 
 
63
 
 
64
 
 
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
82
66
from sets import Set
83
67
from pprint import pprint
84
68
from stat import *
85
69
from glob import glob
86
 
from ElementTree import Element, ElementTree, SubElement
 
70
from inspect import getdoc
87
71
 
88
72
import bzrlib
89
73
from bzrlib.store import ImmutableStore
90
74
from bzrlib.trace import mutter, note, log_error
91
 
from bzrlib.errors import bailout, BzrError
 
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
92
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
93
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
94
78
from bzrlib.revision import Revision
116
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
117
101
## to compare output?
118
102
 
119
 
## TODO: Is ElementTree really all that much better for our purposes?
120
 
## Perhaps using the standard MiniDOM would be enough?
121
 
 
122
 
 
123
 
 
124
 
 
125
 
 
126
 
 
127
 
######################################################################
128
 
# check status
 
103
## TODO: Some kind of global code to generate the right Branch object
 
104
## to work on.  Almost, but not quite all, commands need one, and it
 
105
## can be taken either from their parameters or their working
 
106
## directory.
 
107
 
 
108
## TODO: rename command, needed soon: check destination doesn't exist
 
109
## either in working copy or tree; move working copy; update
 
110
## inventory; write out
 
111
 
 
112
## TODO: move command; check destination is a directory and will not
 
113
## clash; move it.
 
114
 
 
115
## TODO: command to show renames, one per line, as to->from
 
116
 
 
117
 
129
118
 
130
119
 
131
120
def cmd_status(all=False):
134
123
    For each file there is a single line giving its file state and name.
135
124
    The name is that in the current revision unless it is deleted or
136
125
    missing, in which case the old name is shown.
137
 
 
138
 
    :todo: Don't show unchanged files unless ``--all`` is given?
139
126
    """
 
127
    #import bzrlib.status
 
128
    #bzrlib.status.tree_status(Branch('.'))
140
129
    Branch('.').show_status(show_all=all)
141
130
 
142
131
 
147
136
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
148
137
 
149
138
 
150
 
def cmd_get_inventory(inventory_id):
151
 
    """Return inventory in XML by hash"""
152
 
    Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
153
 
 
154
 
 
155
 
def cmd_get_revision_inventory(revision_id):
156
 
    """Output inventory for a revision."""
157
 
    b = Branch('.')
158
 
    b.get_revision_inventory(revision_id).write_xml(sys.stdout)
159
 
 
160
 
 
161
139
def cmd_get_file_text(text_id):
162
140
    """Get contents of a file by hash."""
163
141
    sf = Branch('.').text_store[text_id]
174
152
    print Branch('.').revno()
175
153
    
176
154
 
 
155
    
177
156
def cmd_add(file_list, verbose=False):
178
 
    """Add specified files.
 
157
    """Add specified files or directories.
 
158
 
 
159
    In non-recursive mode, all the named items are added, regardless
 
160
    of whether they were previously ignored.  A warning is given if
 
161
    any of the named files are already versioned.
 
162
 
 
163
    In recursive mode (the default), files are treated the same way
 
164
    but the behaviour for directories is different.  Directories that
 
165
    are already versioned do not give a warning.  All directories,
 
166
    whether already versioned or not, are searched for files or
 
167
    subdirectories that are neither versioned or ignored, and these
 
168
    are added.  This search proceeds recursively into versioned
 
169
    directories.
 
170
 
 
171
    Therefore simply saying 'bzr add .' will version all files that
 
172
    are currently unknown.
 
173
    """
 
174
    bzrlib.add.smart_add(file_list, verbose)
179
175
    
180
 
    Fails if the files are already added.
181
 
    """
182
 
    Branch('.').add(file_list, verbose=verbose)
 
176
 
 
177
def cmd_relpath(filename):
 
178
    """Show path of file relative to root"""
 
179
    print Branch(filename).relpath(filename)
 
180
 
183
181
 
184
182
 
185
183
def cmd_inventory(revision=None):
197
195
 
198
196
 
199
197
 
 
198
# TODO: Maybe a 'mv' command that has the combined move/rename
 
199
# special behaviour of Unix?
 
200
 
 
201
def cmd_move(source_list, dest):
 
202
    b = Branch('.')
 
203
 
 
204
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
205
 
 
206
 
 
207
 
 
208
def cmd_rename(from_name, to_name):
 
209
    """Change the name of an entry.
 
210
 
 
211
    usage: bzr rename FROM_NAME TO_NAME
 
212
 
 
213
    examples:
 
214
      bzr rename frob.c frobber.c
 
215
      bzr rename src/frob.c lib/frob.c
 
216
 
 
217
    It is an error if the destination name exists.
 
218
 
 
219
    See also the 'move' command, which moves files into a different
 
220
    directory without changing their name.
 
221
 
 
222
    TODO: Some way to rename multiple files without invoking bzr for each
 
223
    one?"""
 
224
    b = Branch('.')
 
225
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
226
    
 
227
 
 
228
 
 
229
 
 
230
def cmd_renames(dir='.'):
 
231
    """Show list of renamed files.
 
232
 
 
233
    usage: bzr renames [BRANCH]
 
234
 
 
235
    TODO: Option to show renames between two historical versions.
 
236
 
 
237
    TODO: Only show renames under dir, rather than in the whole branch.
 
238
    """
 
239
    b = Branch(dir)
 
240
    old_inv = b.basis_tree().inventory
 
241
    new_inv = b.read_working_inventory()
 
242
    
 
243
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
244
    renames.sort()
 
245
    for old_name, new_name in renames:
 
246
        print "%s => %s" % (old_name, new_name)        
 
247
 
 
248
 
 
249
 
200
250
def cmd_info():
201
 
    b = Branch('.')
202
 
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
203
 
    print 'revision number:', b.revno()
204
 
    print 'number of versioned files:', len(b.read_working_inventory())
 
251
    """info: Show statistical information for this branch
 
252
 
 
253
    usage: bzr info"""
 
254
    import info
 
255
    info.show_info(Branch('.'))        
 
256
    
205
257
 
206
258
 
207
259
def cmd_remove(file_list, verbose=False):
208
 
    Branch('.').remove(file_list, verbose=verbose)
 
260
    b = Branch(file_list[0])
 
261
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
209
262
 
210
263
 
211
264
 
212
265
def cmd_file_id(filename):
213
 
    i = Branch('.').read_working_inventory().path2id(filename)
214
 
    if i is None:
215
 
        bailout("%s is not a versioned file" % filename)
 
266
    """Print file_id of a particular file or directory.
 
267
 
 
268
    usage: bzr file-id FILE
 
269
 
 
270
    The file_id is assigned when the file is first added and remains the
 
271
    same through all revisions where the file exists, even when it is
 
272
    moved or renamed.
 
273
    """
 
274
    b = Branch(filename)
 
275
    i = b.inventory.path2id(b.relpath(filename))
 
276
    if i == None:
 
277
        bailout("%r is not a versioned file" % filename)
216
278
    else:
217
279
        print i
218
280
 
219
281
 
220
 
def cmd_find_filename(fileid):
221
 
    n = find_filename(fileid)
222
 
    if n is None:
223
 
        bailout("%s is not a live file id" % fileid)
224
 
    else:
225
 
        print n
 
282
def cmd_file_id_path(filename):
 
283
    """Print path of file_ids to a file or directory.
 
284
 
 
285
    usage: bzr file-id-path FILE
 
286
 
 
287
    This prints one line for each directory down to the target,
 
288
    starting at the branch root."""
 
289
    b = Branch(filename)
 
290
    inv = b.inventory
 
291
    fid = inv.path2id(b.relpath(filename))
 
292
    if fid == None:
 
293
        bailout("%r is not a versioned file" % filename)
 
294
    for fip in inv.get_idpath(fid):
 
295
        print fip
226
296
 
227
297
 
228
298
def cmd_revision_history():
230
300
        print patchid
231
301
 
232
302
 
 
303
def cmd_directories():
 
304
    for name, ie in Branch('.').read_working_inventory().directories():
 
305
        if name == '':
 
306
            print '.'
 
307
        else:
 
308
            print name
 
309
 
 
310
 
 
311
def cmd_missing():
 
312
    for name, ie in Branch('.').working_tree().missing():
 
313
        print name
 
314
 
233
315
 
234
316
def cmd_init():
235
317
    # TODO: Check we're not already in a working directory?  At the
244
326
    Branch('.', init=True)
245
327
 
246
328
 
247
 
def cmd_diff(revision=None):
248
 
    """Show diff from basis to working copy.
249
 
 
250
 
    :todo: Take one or two revision arguments, look up those trees,
251
 
           and diff them.
252
 
 
253
 
    :todo: Allow diff across branches.
254
 
 
255
 
    :todo: Mangle filenames in diff to be more relevant.
256
 
 
257
 
    :todo: Shouldn't be in the cmd function.
258
 
    """
 
329
def cmd_diff(revision=None, file_list=None):
 
330
    """bzr diff: Show differences in working tree.
 
331
    
 
332
    usage: bzr diff [-r REV] [FILE...]
 
333
 
 
334
    --revision REV
 
335
         Show changes since REV, rather than predecessor.
 
336
 
 
337
    If files are listed, only the changes in those files are listed.
 
338
    Otherwise, all changes for the tree are listed.
 
339
 
 
340
    TODO: Given two revision arguments, show the difference between them.
 
341
 
 
342
    TODO: Allow diff across branches.
 
343
 
 
344
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
345
          or a graphical diff.
 
346
 
 
347
    TODO: If a directory is given, diff everything under that.
 
348
 
 
349
    TODO: Selected-file diff is inefficient and doesn't show you deleted files.
 
350
"""
 
351
 
 
352
    ## TODO: Shouldn't be in the cmd function.
259
353
 
260
354
    b = Branch('.')
261
355
 
265
359
        old_tree = b.revision_tree(b.lookup_revision(revision))
266
360
        
267
361
    new_tree = b.working_tree()
268
 
    old_inv = old_tree.inventory
269
 
    new_inv = new_tree.inventory
270
362
 
271
363
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
272
364
    old_label = ''
281
373
    # be usefully made into a much faster special case.
282
374
 
283
375
    # TODO: Better to return them in sorted order I think.
 
376
 
 
377
    # FIXME: If given a file list, compare only those files rather
 
378
    # than comparing everything and then throwing stuff away.
284
379
    
285
380
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
286
 
        d = None
287
381
 
 
382
        if file_list and new_name not in file_list:
 
383
            continue
 
384
        
288
385
        # Don't show this by default; maybe do it if an option is passed
289
386
        # idlabel = '      {%s}' % fid
290
387
        idlabel = ''
292
389
        # FIXME: Something about the diff format makes patch unhappy
293
390
        # with newly-added files.
294
391
 
295
 
        def diffit(*a, **kw):
296
 
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
392
        def diffit(oldlines, newlines, **kw):
 
393
            # FIXME: difflib is wrong if there is no trailing newline.
 
394
 
 
395
            # Special workaround for Python2.3, where difflib fails if
 
396
            # both sequences are empty.
 
397
            if oldlines or newlines:
 
398
                sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
297
399
            print
298
400
        
299
401
        if file_state in ['.', '?', 'I']:
330
432
 
331
433
 
332
434
 
333
 
def cmd_log():
 
435
def cmd_deleted(show_ids=False):
 
436
    """List files deleted in the working tree.
 
437
 
 
438
    TODO: Show files deleted since a previous revision, or between two revisions.
 
439
    """
 
440
    b = Branch('.')
 
441
    old = b.basis_tree()
 
442
    new = b.working_tree()
 
443
 
 
444
    ## TODO: Much more efficient way to do this: read in new
 
445
    ## directories with readdir, rather than stating each one.  Same
 
446
    ## level of effort but possibly much less IO.  (Or possibly not,
 
447
    ## if the directories are very large...)
 
448
 
 
449
    for path, ie in old.inventory.iter_entries():
 
450
        if not new.has_id(ie.file_id):
 
451
            if show_ids:
 
452
                print '%-50s %s' % (path, ie.file_id)
 
453
            else:
 
454
                print path
 
455
 
 
456
 
 
457
 
 
458
def cmd_parse_inventory():
 
459
    import cElementTree
 
460
    
 
461
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
462
 
 
463
 
 
464
 
 
465
def cmd_load_inventory():
 
466
    """Load inventory for timing purposes"""
 
467
    Branch('.').basis_tree().inventory
 
468
 
 
469
 
 
470
def cmd_dump_inventory():
 
471
    Branch('.').read_working_inventory().write_xml(sys.stdout)
 
472
 
 
473
 
 
474
def cmd_dump_new_inventory():
 
475
    import bzrlib.newinventory
 
476
    inv = Branch('.').basis_tree().inventory
 
477
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
478
 
 
479
 
 
480
def cmd_load_new_inventory():
 
481
    import bzrlib.newinventory
 
482
    bzrlib.newinventory.read_new_inventory(sys.stdin)
 
483
                
 
484
    
 
485
def cmd_dump_slacker_inventory():
 
486
    import bzrlib.newinventory
 
487
    inv = Branch('.').basis_tree().inventory
 
488
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
489
 
 
490
 
 
491
 
 
492
def cmd_dump_text_inventory():
 
493
    import bzrlib.textinv
 
494
    inv = Branch('.').basis_tree().inventory
 
495
    bzrlib.textinv.write_text_inventory(inv, sys.stdout)
 
496
 
 
497
 
 
498
def cmd_load_text_inventory():
 
499
    import bzrlib.textinv
 
500
    inv = bzrlib.textinv.read_text_inventory(sys.stdin)
 
501
    print 'loaded %d entries' % len(inv)
 
502
    
 
503
    
 
504
 
 
505
def cmd_root(filename=None):
 
506
    """Print the branch root."""
 
507
    print bzrlib.branch.find_branch_root(filename)
 
508
    
 
509
 
 
510
def cmd_log(timezone='original', verbose=False):
334
511
    """Show log of this branch.
335
512
 
336
 
    :todo: Options for utc; to show ids; to limit range; etc.
 
513
    TODO: Options for utc; to show ids; to limit range; etc.
337
514
    """
338
 
    Branch('.').write_log()
 
515
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
339
516
 
340
517
 
341
518
def cmd_ls(revision=None, verbose=False):
342
519
    """List files in a tree.
343
520
 
344
 
    :todo: Take a revision or remote path and list that tree instead.
 
521
    TODO: Take a revision or remote path and list that tree instead.
345
522
    """
346
523
    b = Branch('.')
347
524
    if revision == None:
370
547
        print quotefn(f)
371
548
 
372
549
 
 
550
 
 
551
def cmd_ignored():
 
552
    """List ignored files and the patterns that matched them.
 
553
      """
 
554
    tree = Branch('.').working_tree()
 
555
    for path, file_class, kind, file_id in tree.list_files():
 
556
        if file_class != 'I':
 
557
            continue
 
558
        ## XXX: Slightly inefficient since this was already calculated
 
559
        pat = tree.is_ignored(path)
 
560
        print '%-50s %s' % (path, pat)
 
561
 
 
562
 
373
563
def cmd_lookup_revision(revno):
374
564
    try:
375
565
        revno = int(revno)
388
578
    t = b.revision_tree(rh)
389
579
    t.export(dest)
390
580
 
 
581
def cmd_cat(revision, filename):
 
582
    """Print file to stdout."""
 
583
    b = Branch('.')
 
584
    b.print_file(b.relpath(filename), int(revision))
391
585
 
392
586
 
393
587
######################################################################
396
590
 
397
591
def cmd_uuid():
398
592
    """Print a newly-generated UUID."""
399
 
    print uuid()
400
 
 
401
 
 
402
 
 
403
 
def cmd_commit(message, verbose=False):
 
593
    print bzrlib.osutils.uuid()
 
594
 
 
595
 
 
596
 
 
597
def cmd_local_time_offset():
 
598
    print bzrlib.osutils.local_time_offset()
 
599
 
 
600
 
 
601
 
 
602
def cmd_commit(message=None, verbose=False):
 
603
    """Commit changes to a new revision.
 
604
 
 
605
    --message MESSAGE
 
606
        Description of changes in this revision; free form text.
 
607
        It is recommended that the first line be a single-sentence
 
608
        summary.
 
609
    --verbose
 
610
        Show status of changed files,
 
611
 
 
612
    TODO: Commit only selected files.
 
613
 
 
614
    TODO: Run hooks on tree to-be-committed, and after commit.
 
615
 
 
616
    TODO: Strict commit that fails if there are unknown or deleted files.
 
617
    """
 
618
 
 
619
    if not message:
 
620
        bailout("please specify a commit message")
404
621
    Branch('.').commit(message, verbose=verbose)
405
622
 
406
623
 
407
 
def cmd_check():
408
 
    """Check consistency of the branch."""
409
 
    check()
 
624
def cmd_check(dir='.'):
 
625
    """check: Consistency check of branch history.
 
626
 
 
627
    usage: bzr check [-v] [BRANCH]
 
628
 
 
629
    options:
 
630
      --verbose, -v         Show progress of checking.
 
631
 
 
632
    This command checks various invariants about the branch storage to
 
633
    detect data corruption or bzr bugs.
 
634
    """
 
635
    import bzrlib.check
 
636
    bzrlib.check.check(Branch(dir, find_root=False))
410
637
 
411
638
 
412
639
def cmd_is(pred, *rest):
433
660
 
434
661
 
435
662
def cmd_gen_revision_id():
436
 
    import time
437
663
    print bzrlib.branch._gen_revision_id(time.time())
438
664
 
439
665
 
440
 
def cmd_doctest():
441
 
    """Run internal doctest suite"""
 
666
def cmd_selftest():
 
667
    """Run internal test suite"""
442
668
    ## -v, if present, is seen by doctest; the argument is just here
443
669
    ## so our parser doesn't complain
444
670
 
445
671
    ## TODO: --verbose option
 
672
 
 
673
    failures, tests = 0, 0
446
674
    
447
 
    import bzr, doctest, bzrlib.store
 
675
    import doctest, bzrlib.store, bzrlib.tests
448
676
    bzrlib.trace.verbose = False
449
 
    doctest.testmod(bzr)
450
 
    doctest.testmod(bzrlib.store)
451
 
    doctest.testmod(bzrlib.inventory)
452
 
    doctest.testmod(bzrlib.branch)
453
 
    doctest.testmod(bzrlib.osutils)
454
 
    doctest.testmod(bzrlib.tree)
455
 
 
456
 
    # more strenuous tests;
457
 
    import bzrlib.tests
458
 
    doctest.testmod(bzrlib.tests)
 
677
 
 
678
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
679
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
680
        mf, mt = doctest.testmod(m)
 
681
        failures += mf
 
682
        tests += mt
 
683
        print '%-40s %3d tests' % (m.__name__, mt),
 
684
        if mf:
 
685
            print '%3d FAILED!' % mf
 
686
        else:
 
687
            print
 
688
 
 
689
    print '%-40s %3d tests' % ('total', tests),
 
690
    if failures:
 
691
        print '%3d FAILED!' % failures
 
692
    else:
 
693
        print
 
694
 
 
695
 
 
696
 
 
697
# deprecated
 
698
cmd_doctest = cmd_selftest
459
699
 
460
700
 
461
701
######################################################################
462
702
# help
463
703
 
464
704
 
465
 
def cmd_help():
466
 
    # TODO: Specific help for particular commands
467
 
    print __doc__
 
705
def cmd_help(topic=None):
 
706
    if topic == None:
 
707
        print __doc__
 
708
        return
 
709
 
 
710
    # otherwise, maybe the name of a command?
 
711
    try:
 
712
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
 
713
    except KeyError:
 
714
        bailout("no help for %r" % topic)
 
715
 
 
716
    doc = getdoc(cmdfn)
 
717
    if doc == None:
 
718
        bailout("sorry, no detailed help yet for %r" % topic)
 
719
 
 
720
    print doc
 
721
        
 
722
 
468
723
 
469
724
 
470
725
def cmd_version():
471
 
    print "bzr (bazaar-ng) %s" % __version__
472
 
    print __copyright__
 
726
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
727
    print bzrlib.__copyright__
473
728
    print "http://bazaar-ng.org/"
474
729
    print
475
730
    print \
495
750
    'all':                    None,
496
751
    'help':                   None,
497
752
    'message':                unicode,
 
753
    'profile':                None,
498
754
    'revision':               int,
499
755
    'show-ids':               None,
 
756
    'timezone':               str,
500
757
    'verbose':                None,
501
758
    'version':                None,
502
759
    }
511
768
# listed take none.
512
769
cmd_options = {
513
770
    'add':                    ['verbose'],
 
771
    'cat':                    ['revision'],
514
772
    'commit':                 ['message', 'verbose'],
 
773
    'deleted':                ['show-ids'],
515
774
    'diff':                   ['revision'],
516
775
    'inventory':              ['revision'],
 
776
    'log':                    ['timezone', 'verbose'],
517
777
    'ls':                     ['revision', 'verbose'],
 
778
    'remove':                 ['verbose'],
518
779
    'status':                 ['all'],
519
 
    'log':                    ['show-ids'],
520
 
    'remove':                 ['verbose'],
521
780
    }
522
781
 
523
782
 
524
783
cmd_args = {
525
 
    'init':                   [],
526
784
    'add':                    ['file+'],
 
785
    'cat':                    ['filename'],
527
786
    'commit':                 [],
528
 
    'diff':                   [],
 
787
    'diff':                   ['file*'],
 
788
    'export':                 ['revno', 'dest'],
529
789
    'file-id':                ['filename'],
 
790
    'file-id-path':           ['filename'],
530
791
    'get-file-text':          ['text_id'],
531
792
    'get-inventory':          ['inventory_id'],
532
793
    'get-revision':           ['revision_id'],
533
794
    'get-revision-inventory': ['revision_id'],
 
795
    'help':                   ['topic?'],
 
796
    'init':                   [],
534
797
    'log':                    [],
535
798
    'lookup-revision':        ['revno'],
536
 
    'export':                 ['revno', 'dest'],
 
799
    'move':                   ['source$', 'dest'],
 
800
    'relpath':                ['filename'],
537
801
    'remove':                 ['file+'],
 
802
    'rename':                 ['from_name', 'to_name'],
 
803
    'renames':                ['dir?'],
 
804
    'root':                   ['filename?'],
538
805
    'status':                 [],
539
806
    }
540
807
 
547
814
    lookup table, something about the available options, what optargs
548
815
    they take, and which commands will accept them.
549
816
 
550
 
    >>> parse_args('bzr --help'.split())
 
817
    >>> parse_args('--help'.split())
551
818
    ([], {'help': True})
552
 
    >>> parse_args('bzr --version'.split())
 
819
    >>> parse_args('--version'.split())
553
820
    ([], {'version': True})
554
 
    >>> parse_args('bzr status --all'.split())
 
821
    >>> parse_args('status --all'.split())
555
822
    (['status'], {'all': True})
 
823
    >>> parse_args('commit --message=biter'.split())
 
824
    (['commit'], {'message': u'biter'})
556
825
    """
557
826
    args = []
558
827
    opts = {}
559
828
 
560
829
    # TODO: Maybe handle '--' to end options?
561
830
 
562
 
    it = iter(argv[1:])
563
 
    while it:
564
 
        a = it.next()
 
831
    while argv:
 
832
        a = argv.pop(0)
565
833
        if a[0] == '-':
 
834
            optarg = None
566
835
            if a[1] == '-':
567
836
                mutter("  got option %r" % a)
568
 
                optname = a[2:]
 
837
                if '=' in a:
 
838
                    optname, optarg = a[2:].split('=', 1)
 
839
                else:
 
840
                    optname = a[2:]
569
841
                if optname not in OPTIONS:
570
842
                    bailout('unknown long option %r' % a)
571
843
            else:
577
849
            if optname in opts:
578
850
                # XXX: Do we ever want to support this, e.g. for -r?
579
851
                bailout('repeated option %r' % a)
 
852
                
580
853
            optargfn = OPTIONS[optname]
581
854
            if optargfn:
582
 
                if not it:
583
 
                    bailout('option %r needs an argument' % a)
584
 
                opts[optname] = optargfn(it.next())
585
 
                mutter("    option argument %r" % opts[optname])
 
855
                if optarg == None:
 
856
                    if not argv:
 
857
                        bailout('option %r needs an argument' % a)
 
858
                    else:
 
859
                        optarg = argv.pop(0)
 
860
                opts[optname] = optargfn(optarg)
586
861
            else:
587
 
                # takes no option argument
 
862
                if optarg != None:
 
863
                    bailout('option %r takes no argument' % optname)
588
864
                opts[optname] = True
589
 
        elif a[:1] == '-':
590
 
            bailout('unknown short option %r' % a)
591
865
        else:
592
866
            args.append(a)
593
867
 
612
886
    argdict = {}
613
887
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
614
888
    # all but one.
 
889
 
 
890
    # step through args and argform, allowing appropriate 0-many matches
615
891
    for ap in argform:
616
892
        argname = ap[:-1]
617
893
        if ap[-1] == '?':
618
 
            assert 0
619
 
        elif ap[-1] == '*':
620
 
            assert 0
 
894
            if args:
 
895
                argdict[argname] = args.pop(0)
 
896
        elif ap[-1] == '*': # all remaining arguments
 
897
            if args:
 
898
                argdict[argname + '_list'] = args[:]
 
899
                args = []
 
900
            else:
 
901
                argdict[argname + '_list'] = None
621
902
        elif ap[-1] == '+':
622
903
            if not args:
623
904
                bailout("command %r needs one or more %s"
625
906
            else:
626
907
                argdict[argname + '_list'] = args[:]
627
908
                args = []
 
909
        elif ap[-1] == '$': # all but one
 
910
            if len(args) < 2:
 
911
                bailout("command %r needs one or more %s"
 
912
                        % (cmd, argname.upper()))
 
913
            argdict[argname + '_list'] = args[:-1]
 
914
            args[:-1] = []                
628
915
        else:
629
916
            # just a plain arg
630
917
            argname = ap
646
933
    """Execute a command.
647
934
 
648
935
    This is similar to main(), but without all the trappings for
649
 
    logging and error handling.
 
936
    logging and error handling.  
650
937
    """
 
938
 
 
939
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
940
    
651
941
    try:
652
 
        args, opts = parse_args(argv)
 
942
        args, opts = parse_args(argv[1:])
653
943
        if 'help' in opts:
654
944
            # TODO: pass down other arguments in case they asked for
655
945
            # help on a command name?
656
 
            cmd_help()
 
946
            if args:
 
947
                cmd_help(args[0])
 
948
            else:
 
949
                cmd_help()
657
950
            return 0
658
951
        elif 'version' in opts:
659
952
            cmd_version()
663
956
        log_error('usage: bzr COMMAND\n')
664
957
        log_error('  try "bzr help"\n')
665
958
        return 1
666
 
            
 
959
 
667
960
    try:
668
961
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
669
962
    except KeyError:
670
963
        bailout("unknown command " + `cmd`)
671
964
 
672
 
    # TODO: special --profile option to turn on the Python profiler
 
965
    # global option
 
966
    if 'profile' in opts:
 
967
        profile = True
 
968
        del opts['profile']
 
969
    else:
 
970
        profile = False
673
971
 
674
972
    # check options are reasonable
675
973
    allowed = cmd_options.get(cmd, [])
678
976
            bailout("option %r is not allowed for command %r"
679
977
                    % (oname, cmd))
680
978
 
 
979
    # TODO: give an error if there are any mandatory options which are
 
980
    # not specified?  Or maybe there shouldn't be any "mandatory
 
981
    # options" (it is an oxymoron)
 
982
 
 
983
    # mix arguments and options into one dictionary
681
984
    cmdargs = _match_args(cmd, args)
682
 
    cmdargs.update(opts)
683
 
 
684
 
    ret = cmd_handler(**cmdargs) or 0
 
985
    for k, v in opts.items():
 
986
        cmdargs[str(k.replace('-', '_'))] = v
 
987
 
 
988
    if profile:
 
989
        import hotshot
 
990
        pffileno, pfname = tempfile.mkstemp()
 
991
        try:
 
992
            prof = hotshot.Profile(pfname)
 
993
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
994
            prof.close()
 
995
 
 
996
            import hotshot.stats
 
997
            stats = hotshot.stats.load(pfname)
 
998
            #stats.strip_dirs()
 
999
            stats.sort_stats('time')
 
1000
            ## XXX: Might like to write to stderr or the trace file instead but
 
1001
            ## print_stats seems hardcoded to stdout
 
1002
            stats.print_stats(20)
 
1003
            
 
1004
            return ret
 
1005
 
 
1006
        finally:
 
1007
            os.close(pffileno)
 
1008
            os.remove(pfname)
 
1009
    else:
 
1010
        return cmd_handler(**cmdargs) or 0
685
1011
 
686
1012
 
687
1013
 
692
1018
    ## TODO: If the arguments are wrong, give a usage message rather
693
1019
    ## than just a backtrace.
694
1020
 
 
1021
    bzrlib.trace.create_tracefile(argv)
 
1022
    
695
1023
    try:
696
 
        t = bzrlib.trace._tracefile
697
 
        t.write('-' * 60 + '\n')
698
 
        t.write('bzr invoked at %s\n' % format_date(time.time()))
699
 
        t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
700
 
        t.write('  arguments: %r\n' % argv)
701
 
 
702
 
        starttime = os.times()[4]
703
 
 
704
 
        import platform
705
 
        t.write('  platform: %s\n' % platform.platform())
706
 
        t.write('  python: %s\n' % platform.python_version())
707
 
 
708
1024
        ret = run_bzr(argv)
709
 
        
710
 
        times = os.times()
711
 
        mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
712
 
               % times[:4])
713
 
        mutter("    %.3f elapsed" % (times[4] - starttime))
714
 
 
715
1025
        return ret
716
1026
    except BzrError, e:
717
1027
        log_error('bzr: error: ' + e.args[0] + '\n')
718
1028
        if len(e.args) > 1:
719
1029
            for h in e.args[1]:
720
1030
                log_error('  ' + h + '\n')
 
1031
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
1032
        log_error('(see $HOME/.bzr.log for debug information)\n')
721
1033
        return 1
722
1034
    except Exception, e:
723
1035
        log_error('bzr: exception: %s\n' % e)
724
 
        log_error('    see .bzr.log for details\n')
 
1036
        log_error('(see $HOME/.bzr.log for debug information)\n')
725
1037
        traceback.print_exc(None, bzrlib.trace._tracefile)
726
 
        traceback.print_exc(None, sys.stderr)
 
1038
        ## traceback.print_exc(None, sys.stderr)
727
1039
        return 1
728
1040
 
729
 
    # TODO: Maybe nicer handling of IOError?
 
1041
    ## TODO: Trap AssertionError
 
1042
 
 
1043
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
730
1044
 
731
1045
 
732
1046
 
734
1048
    sys.exit(main(sys.argv))
735
1049
    ##import profile
736
1050
    ##profile.run('main(sys.argv)')
737