~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-14 23:43:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050414234300-57f6e8b8514287e4
- factor out locale.getpreferredencoding()
- fix problems with EMAIL not being defined

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
 
70
from inspect import getdoc
86
71
 
87
72
import bzrlib
88
73
from bzrlib.store import ImmutableStore
89
74
from bzrlib.trace import mutter, note, log_error
90
 
from bzrlib.errors import bailout, BzrError
 
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
91
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
92
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
93
78
from bzrlib.revision import Revision
115
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
116
101
## to compare output?
117
102
 
118
 
 
119
 
 
120
 
 
121
 
######################################################################
122
 
# 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
 
123
118
 
124
119
 
125
120
def cmd_status(all=False):
128
123
    For each file there is a single line giving its file state and name.
129
124
    The name is that in the current revision unless it is deleted or
130
125
    missing, in which case the old name is shown.
131
 
 
132
 
    :todo: Don't show unchanged files unless ``--all`` is given?
133
126
    """
 
127
    #import bzrlib.status
 
128
    #bzrlib.status.tree_status(Branch('.'))
134
129
    Branch('.').show_status(show_all=all)
135
130
 
136
131
 
141
136
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
142
137
 
143
138
 
144
 
def cmd_get_inventory(inventory_id):
145
 
    """Return inventory in XML by hash"""
146
 
    Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
147
 
 
148
 
 
149
 
def cmd_get_revision_inventory(revision_id):
150
 
    """Output inventory for a revision."""
151
 
    b = Branch('.')
152
 
    b.get_revision_inventory(revision_id).write_xml(sys.stdout)
153
 
 
154
 
 
155
139
def cmd_get_file_text(text_id):
156
140
    """Get contents of a file by hash."""
157
141
    sf = Branch('.').text_store[text_id]
168
152
    print Branch('.').revno()
169
153
    
170
154
 
 
155
    
171
156
def cmd_add(file_list, verbose=False):
172
 
    """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)
173
175
    
174
 
    Fails if the files are already added.
175
 
    """
176
 
    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
 
177
181
 
178
182
 
179
183
def cmd_inventory(revision=None):
191
195
 
192
196
 
193
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
 
194
250
def cmd_info():
195
 
    b = Branch('.')
196
 
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
197
 
 
198
 
    def plural(n, base='', pl=None):
199
 
        if n == 1:
200
 
            return base
201
 
        elif pl is not None:
202
 
            return pl
203
 
        else:
204
 
            return 's'
205
 
 
206
 
    count_version_dirs = 0
207
 
 
208
 
    count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
209
 
    for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
210
 
        fs = st_tup[0]
211
 
        count_status[fs] += 1
212
 
        if fs not in ['I', '?'] and st_tup[4] == 'directory':
213
 
            count_version_dirs += 1
214
 
 
215
 
    print
216
 
    print 'in the working tree:'
217
 
    for name, fs in (('unchanged', '.'),
218
 
                     ('modified', 'M'), ('added', 'A'), ('removed', 'D'),
219
 
                     ('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
220
 
                     ):
221
 
        print '  %5d %s' % (count_status[fs], name)
222
 
    print '  %5d versioned subdirector%s' % (count_version_dirs,
223
 
                                             plural(count_version_dirs, 'y', 'ies'))
224
 
 
225
 
    print
226
 
    print 'branch history:'
227
 
    history = b.revision_history()
228
 
    revno = len(history)
229
 
    print '  %5d revision%s' % (revno, plural(revno))
230
 
    committers = Set()
231
 
    for rev in history:
232
 
        committers.add(b.get_revision(rev).committer)
233
 
    print '  %5d committer%s' % (len(committers), plural(len(committers)))
234
 
    if revno > 0:
235
 
        firstrev = b.get_revision(history[0])
236
 
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
237
 
        print '  %5d day%s old' % (age, plural(age))
238
 
        print '  first revision: %s' % format_date(firstrev.timestamp,
239
 
                                                 firstrev.timezone)
240
 
 
241
 
        lastrev = b.get_revision(history[-1])
242
 
        print '  latest revision: %s' % format_date(lastrev.timestamp,
243
 
                                                    lastrev.timezone)
244
 
        
 
251
    """info: Show statistical information for this branch
 
252
 
 
253
    usage: bzr info"""
 
254
    import info
 
255
    info.show_info(Branch('.'))        
245
256
    
246
257
 
247
258
 
248
259
def cmd_remove(file_list, verbose=False):
249
 
    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)
250
262
 
251
263
 
252
264
 
253
265
def cmd_file_id(filename):
254
 
    i = Branch('.').read_working_inventory().path2id(filename)
255
 
    if i is None:
256
 
        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)
257
278
    else:
258
279
        print i
259
280
 
260
281
 
261
 
def cmd_find_filename(fileid):
262
 
    n = find_filename(fileid)
263
 
    if n is None:
264
 
        bailout("%s is not a live file id" % fileid)
265
 
    else:
266
 
        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
267
296
 
268
297
 
269
298
def cmd_revision_history():
271
300
        print patchid
272
301
 
273
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
 
274
315
 
275
316
def cmd_init():
276
317
    # TODO: Check we're not already in a working directory?  At the
285
326
    Branch('.', init=True)
286
327
 
287
328
 
288
 
def cmd_diff(revision=None):
289
 
    """Show diff from basis to working copy.
290
 
 
291
 
    :todo: Take one or two revision arguments, look up those trees,
292
 
           and diff them.
293
 
 
294
 
    :todo: Allow diff across branches.
295
 
 
296
 
    :todo: Mangle filenames in diff to be more relevant.
297
 
 
298
 
    :todo: Shouldn't be in the cmd function.
299
 
    """
 
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.
300
353
 
301
354
    b = Branch('.')
302
355
 
306
359
        old_tree = b.revision_tree(b.lookup_revision(revision))
307
360
        
308
361
    new_tree = b.working_tree()
309
 
    old_inv = old_tree.inventory
310
 
    new_inv = new_tree.inventory
311
362
 
312
363
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
313
364
    old_label = ''
322
373
    # be usefully made into a much faster special case.
323
374
 
324
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.
325
379
    
326
380
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
327
 
        d = None
328
381
 
 
382
        if file_list and new_name not in file_list:
 
383
            continue
 
384
        
329
385
        # Don't show this by default; maybe do it if an option is passed
330
386
        # idlabel = '      {%s}' % fid
331
387
        idlabel = ''
333
389
        # FIXME: Something about the diff format makes patch unhappy
334
390
        # with newly-added files.
335
391
 
336
 
        def diffit(*a, **kw):
337
 
            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))
338
399
            print
339
400
        
340
401
        if file_state in ['.', '?', 'I']:
371
432
 
372
433
 
373
434
 
374
 
def cmd_log(timezone='original'):
 
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):
375
511
    """Show log of this branch.
376
512
 
377
513
    :todo: Options for utc; to show ids; to limit range; etc.
378
514
    """
379
 
    Branch('.').write_log(show_timezone=timezone)
 
515
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
380
516
 
381
517
 
382
518
def cmd_ls(revision=None, verbose=False):
411
547
        print quotefn(f)
412
548
 
413
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
 
414
563
def cmd_lookup_revision(revno):
415
564
    try:
416
565
        revno = int(revno)
429
578
    t = b.revision_tree(rh)
430
579
    t.export(dest)
431
580
 
 
581
def cmd_cat(revision, filename):
 
582
    """Print file to stdout."""
 
583
    b = Branch('.')
 
584
    b.print_file(b.relpath(filename), int(revision))
432
585
 
433
586
 
434
587
######################################################################
437
590
 
438
591
def cmd_uuid():
439
592
    """Print a newly-generated UUID."""
440
 
    print uuid()
 
593
    print bzrlib.osutils.uuid()
441
594
 
442
595
 
443
596
 
446
599
 
447
600
 
448
601
 
449
 
def cmd_commit(message, verbose=False):
 
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")
450
621
    Branch('.').commit(message, verbose=verbose)
451
622
 
452
623
 
453
 
def cmd_check():
454
 
    """Check consistency of the branch."""
455
 
    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))
456
637
 
457
638
 
458
639
def cmd_is(pred, *rest):
479
660
 
480
661
 
481
662
def cmd_gen_revision_id():
482
 
    import time
483
663
    print bzrlib.branch._gen_revision_id(time.time())
484
664
 
485
665
 
486
 
def cmd_doctest():
487
 
    """Run internal doctest suite"""
 
666
def cmd_selftest():
 
667
    """Run internal test suite"""
488
668
    ## -v, if present, is seen by doctest; the argument is just here
489
669
    ## so our parser doesn't complain
490
670
 
491
671
    ## TODO: --verbose option
 
672
 
 
673
    failures, tests = 0, 0
492
674
    
493
 
    import bzr, doctest, bzrlib.store
 
675
    import doctest, bzrlib.store, bzrlib.tests
494
676
    bzrlib.trace.verbose = False
495
 
    doctest.testmod(bzr)
496
 
    doctest.testmod(bzrlib.store)
497
 
    doctest.testmod(bzrlib.inventory)
498
 
    doctest.testmod(bzrlib.branch)
499
 
    doctest.testmod(bzrlib.osutils)
500
 
    doctest.testmod(bzrlib.tree)
501
 
 
502
 
    # more strenuous tests;
503
 
    import bzrlib.tests
504
 
    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
505
699
 
506
700
 
507
701
######################################################################
508
702
# help
509
703
 
510
704
 
511
 
def cmd_help():
512
 
    # TODO: Specific help for particular commands
513
 
    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
 
514
723
 
515
724
 
516
725
def cmd_version():
517
 
    print "bzr (bazaar-ng) %s" % __version__
518
 
    print __copyright__
 
726
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
727
    print bzrlib.__copyright__
519
728
    print "http://bazaar-ng.org/"
520
729
    print
521
730
    print \
541
750
    'all':                    None,
542
751
    'help':                   None,
543
752
    'message':                unicode,
 
753
    'profile':                None,
544
754
    'revision':               int,
545
755
    'show-ids':               None,
546
756
    'timezone':               str,
558
768
# listed take none.
559
769
cmd_options = {
560
770
    'add':                    ['verbose'],
 
771
    'cat':                    ['revision'],
561
772
    'commit':                 ['message', 'verbose'],
 
773
    'deleted':                ['show-ids'],
562
774
    'diff':                   ['revision'],
563
775
    'inventory':              ['revision'],
564
 
    'log':                    ['show-ids', 'timezone'],
 
776
    'log':                    ['timezone', 'verbose'],
565
777
    'ls':                     ['revision', 'verbose'],
566
778
    'remove':                 ['verbose'],
567
779
    'status':                 ['all'],
569
781
 
570
782
 
571
783
cmd_args = {
572
 
    'init':                   [],
573
784
    'add':                    ['file+'],
 
785
    'cat':                    ['filename'],
574
786
    'commit':                 [],
575
 
    'diff':                   [],
 
787
    'diff':                   ['file*'],
 
788
    'export':                 ['revno', 'dest'],
576
789
    'file-id':                ['filename'],
 
790
    'file-id-path':           ['filename'],
577
791
    'get-file-text':          ['text_id'],
578
792
    'get-inventory':          ['inventory_id'],
579
793
    'get-revision':           ['revision_id'],
580
794
    'get-revision-inventory': ['revision_id'],
 
795
    'help':                   ['topic?'],
 
796
    'init':                   [],
581
797
    'log':                    [],
582
798
    'lookup-revision':        ['revno'],
583
 
    'export':                 ['revno', 'dest'],
 
799
    'move':                   ['source$', 'dest'],
 
800
    'relpath':                ['filename'],
584
801
    'remove':                 ['file+'],
 
802
    'rename':                 ['from_name', 'to_name'],
 
803
    'renames':                ['dir?'],
 
804
    'root':                   ['filename?'],
585
805
    'status':                 [],
586
806
    }
587
807
 
594
814
    lookup table, something about the available options, what optargs
595
815
    they take, and which commands will accept them.
596
816
 
597
 
    >>> parse_args('bzr --help'.split())
 
817
    >>> parse_args('--help'.split())
598
818
    ([], {'help': True})
599
 
    >>> parse_args('bzr --version'.split())
 
819
    >>> parse_args('--version'.split())
600
820
    ([], {'version': True})
601
 
    >>> parse_args('bzr status --all'.split())
 
821
    >>> parse_args('status --all'.split())
602
822
    (['status'], {'all': True})
603
 
    >>> parse_args('bzr commit --message=biter'.split())
 
823
    >>> parse_args('commit --message=biter'.split())
604
824
    (['commit'], {'message': u'biter'})
605
825
    """
606
826
    args = []
608
828
 
609
829
    # TODO: Maybe handle '--' to end options?
610
830
 
611
 
    it = iter(argv[1:])
612
 
    while it:
613
 
        a = it.next()
 
831
    while argv:
 
832
        a = argv.pop(0)
614
833
        if a[0] == '-':
615
834
            optarg = None
616
835
            if a[1] == '-':
634
853
            optargfn = OPTIONS[optname]
635
854
            if optargfn:
636
855
                if optarg == None:
637
 
                    if not it:
 
856
                    if not argv:
638
857
                        bailout('option %r needs an argument' % a)
639
858
                    else:
640
 
                        optarg = it.next()
 
859
                        optarg = argv.pop(0)
641
860
                opts[optname] = optargfn(optarg)
642
 
                mutter("    option argument %r" % opts[optname])
643
861
            else:
644
862
                if optarg != None:
645
863
                    bailout('option %r takes no argument' % optname)
668
886
    argdict = {}
669
887
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
670
888
    # all but one.
 
889
 
 
890
    # step through args and argform, allowing appropriate 0-many matches
671
891
    for ap in argform:
672
892
        argname = ap[:-1]
673
893
        if ap[-1] == '?':
674
 
            assert 0
675
 
        elif ap[-1] == '*':
676
 
            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
677
902
        elif ap[-1] == '+':
678
903
            if not args:
679
904
                bailout("command %r needs one or more %s"
681
906
            else:
682
907
                argdict[argname + '_list'] = args[:]
683
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] = []                
684
915
        else:
685
916
            # just a plain arg
686
917
            argname = ap
702
933
    """Execute a command.
703
934
 
704
935
    This is similar to main(), but without all the trappings for
705
 
    logging and error handling.
 
936
    logging and error handling.  
706
937
    """
 
938
 
 
939
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
940
    
707
941
    try:
708
 
        args, opts = parse_args(argv)
 
942
        args, opts = parse_args(argv[1:])
709
943
        if 'help' in opts:
710
944
            # TODO: pass down other arguments in case they asked for
711
945
            # help on a command name?
712
 
            cmd_help()
 
946
            if args:
 
947
                cmd_help(args[0])
 
948
            else:
 
949
                cmd_help()
713
950
            return 0
714
951
        elif 'version' in opts:
715
952
            cmd_version()
719
956
        log_error('usage: bzr COMMAND\n')
720
957
        log_error('  try "bzr help"\n')
721
958
        return 1
722
 
            
 
959
 
723
960
    try:
724
961
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
725
962
    except KeyError:
726
963
        bailout("unknown command " + `cmd`)
727
964
 
728
 
    # 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
729
971
 
730
972
    # check options are reasonable
731
973
    allowed = cmd_options.get(cmd, [])
734
976
            bailout("option %r is not allowed for command %r"
735
977
                    % (oname, cmd))
736
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
737
984
    cmdargs = _match_args(cmd, args)
738
 
    cmdargs.update(opts)
739
 
 
740
 
    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
741
1011
 
742
1012
 
743
1013
 
748
1018
    ## TODO: If the arguments are wrong, give a usage message rather
749
1019
    ## than just a backtrace.
750
1020
 
 
1021
    bzrlib.trace.create_tracefile(argv)
 
1022
    
751
1023
    try:
752
 
        t = bzrlib.trace._tracefile
753
 
        t.write('-' * 60 + '\n')
754
 
        t.write('bzr invoked at %s\n' % format_date(time.time()))
755
 
        t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
756
 
        t.write('  arguments: %r\n' % argv)
757
 
 
758
 
        starttime = os.times()[4]
759
 
 
760
 
        import platform
761
 
        t.write('  platform: %s\n' % platform.platform())
762
 
        t.write('  python: %s\n' % platform.python_version())
763
 
 
764
1024
        ret = run_bzr(argv)
765
 
        
766
 
        times = os.times()
767
 
        mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
768
 
               % times[:4])
769
 
        mutter("    %.3f elapsed" % (times[4] - starttime))
770
 
 
771
1025
        return ret
772
1026
    except BzrError, e:
773
1027
        log_error('bzr: error: ' + e.args[0] + '\n')
774
1028
        if len(e.args) > 1:
775
1029
            for h in e.args[1]:
776
1030
                log_error('  ' + h + '\n')
 
1031
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
1032
        log_error('(see $HOME/.bzr.log for debug information)\n')
777
1033
        return 1
778
1034
    except Exception, e:
779
1035
        log_error('bzr: exception: %s\n' % e)
780
 
        log_error('    see .bzr.log for details\n')
 
1036
        log_error('(see $HOME/.bzr.log for debug information)\n')
781
1037
        traceback.print_exc(None, bzrlib.trace._tracefile)
782
 
        traceback.print_exc(None, sys.stderr)
 
1038
        ## traceback.print_exc(None, sys.stderr)
783
1039
        return 1
784
1040
 
785
 
    # TODO: Maybe nicer handling of IOError?
 
1041
    ## TODO: Trap AssertionError
 
1042
 
 
1043
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
786
1044
 
787
1045
 
788
1046
 
790
1048
    sys.exit(main(sys.argv))
791
1049
    ##import profile
792
1050
    ##profile.run('main(sys.argv)')
793