~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 06:44:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050309064453-60be0ae479d019b8
store committer's timezone in revision and show 
in changelog

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#! /usr/bin/python
 
2
 
 
3
 
1
4
# Copyright (C) 2004, 2005 by Martin Pool
2
5
# Copyright (C) 2005 by Canonical Ltd
3
6
 
17
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
21
 
19
22
"""Bazaar-NG -- a free distributed version-control tool
20
 
http://bazaar-ng.org/
21
23
 
22
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
25
 
 
26
Current limitation include:
 
27
 
24
28
* Metadata format is not stable yet -- you may need to
25
29
  discard history in the future.
26
30
 
 
31
* No handling of subdirectories, symlinks or any non-text files.
 
32
 
 
33
* Insufficient error handling.
 
34
 
27
35
* Many commands unimplemented or partially implemented.
28
36
 
29
37
* Space-inefficient storage.
30
38
 
31
39
* No merge operators yet.
32
40
 
33
 
Interesting commands:
 
41
Interesting commands::
34
42
 
35
 
  bzr help [COMMAND]
36
 
      Show help screen
 
43
  bzr help
 
44
       Show summary help screen
37
45
  bzr version
38
 
      Show software version/licence/non-warranty.
 
46
       Show software version/licence/non-warranty.
39
47
  bzr init
40
 
      Start versioning the current directory
 
48
       Start versioning the current directory
41
49
  bzr add FILE...
42
 
      Make files versioned.
 
50
       Make files versioned.
43
51
  bzr log
44
 
      Show revision history.
45
 
  bzr rename FROM TO
46
 
      Rename one file.
47
 
  bzr move FROM... DESTDIR
48
 
      Move one or more files to a different directory.
49
 
  bzr diff [FILE...]
50
 
      Show changes from last revision to working copy.
 
52
       Show revision history.
 
53
  bzr diff
 
54
       Show changes from last revision to working copy.
51
55
  bzr commit -m 'MESSAGE'
52
 
      Store current state as new revision.
 
56
       Store current state as new revision.
53
57
  bzr export REVNO DESTINATION
54
 
      Export the branch state at a previous version.
 
58
       Export the branch state at a previous version.
55
59
  bzr status
56
 
      Show summary of pending changes.
 
60
       Show summary of pending changes.
57
61
  bzr remove FILE...
58
 
      Make a file not versioned.
59
 
  bzr info
60
 
      Show statistics about this branch.
61
 
  bzr check
62
 
      Verify history is stored safely. 
63
 
  (for more type 'bzr help commands')
 
62
       Make a file not versioned.
64
63
"""
65
64
 
66
 
 
67
 
 
68
 
 
69
 
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
 
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
70
82
from sets import Set
71
83
from pprint import pprint
72
84
from stat import *
73
85
from glob import glob
74
 
from inspect import getdoc
75
86
 
76
87
import bzrlib
77
88
from bzrlib.store import ImmutableStore
78
89
from bzrlib.trace import mutter, note, log_error
79
 
from bzrlib.errors import bailout, BzrError, BzrCheckError
 
90
from bzrlib.errors import bailout, BzrError
80
91
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
92
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
93
from bzrlib.revision import Revision
104
115
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
116
## to compare output?
106
117
 
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
110
 
## directory.
111
 
 
112
 
 
113
 
 
114
 
cmd_aliases = {
115
 
    '?':         'help',
116
 
    'ci':        'commit',
117
 
    'checkin':   'commit',
118
 
    'di':        'diff',
119
 
    'st':        'status',
120
 
    'stat':      'status',
121
 
    }
122
 
 
123
 
 
124
 
def get_cmd_handler(cmd):
125
 
    cmd = str(cmd)
126
 
    
127
 
    cmd = cmd_aliases.get(cmd, cmd)
128
 
    
129
 
    try:
130
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
131
 
    except KeyError:
132
 
        raise BzrError("unknown command %r" % cmd)
133
 
 
134
 
    return cmd, cmd_handler
135
 
 
 
118
 
 
119
 
 
120
 
 
121
######################################################################
 
122
# check status
136
123
 
137
124
 
138
125
def cmd_status(all=False):
141
128
    For each file there is a single line giving its file state and name.
142
129
    The name is that in the current revision unless it is deleted or
143
130
    missing, in which case the old name is shown.
 
131
 
 
132
    :todo: Don't show unchanged files unless ``--all`` is given?
144
133
    """
145
 
    #import bzrlib.status
146
 
    #bzrlib.status.tree_status(Branch('.'))
147
134
    Branch('.').show_status(show_all=all)
148
135
 
149
136
 
154
141
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
155
142
 
156
143
 
 
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
 
157
155
def cmd_get_file_text(text_id):
158
156
    """Get contents of a file by hash."""
159
157
    sf = Branch('.').text_store[text_id]
170
168
    print Branch('.').revno()
171
169
    
172
170
 
173
 
    
174
171
def cmd_add(file_list, verbose=False):
175
 
    """Add specified files or directories.
176
 
 
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.
180
 
 
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
187
 
    directories.
188
 
 
189
 
    Therefore simply saying 'bzr add .' will version all files that
190
 
    are currently unknown.
191
 
 
192
 
    TODO: Perhaps adding a file whose directly is not versioned should
193
 
    recursively add that parent, rather than giving an error?
 
172
    """Add specified files.
 
173
    
 
174
    Fails if the files are already added.
194
175
    """
195
 
    bzrlib.add.smart_add(file_list, verbose)
196
 
    
197
 
 
198
 
def cmd_relpath(filename):
199
 
    """Show path of file relative to root"""
200
 
    print Branch(filename).relpath(filename)
201
 
 
 
176
    Branch('.').add(file_list, verbose=verbose)
202
177
 
203
178
 
204
179
def cmd_inventory(revision=None):
216
191
 
217
192
 
218
193
 
219
 
# TODO: Maybe a 'mv' command that has the combined move/rename
220
 
# special behaviour of Unix?
221
 
 
222
 
def cmd_move(source_list, dest):
223
 
    b = Branch('.')
224
 
 
225
 
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
226
 
 
227
 
 
228
 
 
229
 
def cmd_rename(from_name, to_name):
230
 
    """Change the name of an entry.
231
 
 
232
 
    usage: bzr rename FROM_NAME TO_NAME
233
 
 
234
 
    examples:
235
 
      bzr rename frob.c frobber.c
236
 
      bzr rename src/frob.c lib/frob.c
237
 
 
238
 
    It is an error if the destination name exists.
239
 
 
240
 
    See also the 'move' command, which moves files into a different
241
 
    directory without changing their name.
242
 
 
243
 
    TODO: Some way to rename multiple files without invoking bzr for each
244
 
    one?"""
245
 
    b = Branch('.')
246
 
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
247
 
    
248
 
 
249
 
 
250
 
 
251
 
def cmd_renames(dir='.'):
252
 
    """Show list of renamed files.
253
 
 
254
 
    usage: bzr renames [BRANCH]
255
 
 
256
 
    TODO: Option to show renames between two historical versions.
257
 
 
258
 
    TODO: Only show renames under dir, rather than in the whole branch.
259
 
    """
260
 
    b = Branch(dir)
261
 
    old_inv = b.basis_tree().inventory
262
 
    new_inv = b.read_working_inventory()
263
 
    
264
 
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
265
 
    renames.sort()
266
 
    for old_name, new_name in renames:
267
 
        print "%s => %s" % (old_name, new_name)        
268
 
 
269
 
 
270
 
 
271
194
def cmd_info():
272
 
    """info: Show statistical information for this branch
273
 
 
274
 
    usage: bzr info"""
275
 
    import info
276
 
    info.show_info(Branch('.'))        
277
 
    
 
195
    b = Branch('.')
 
196
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
 
197
    print 'revision number:', b.revno()
 
198
    print 'number of versioned files:', len(b.read_working_inventory())
278
199
 
279
200
 
280
201
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)
 
202
    Branch('.').remove(file_list, verbose=verbose)
283
203
 
284
204
 
285
205
 
286
206
def cmd_file_id(filename):
287
 
    """Print file_id of a particular file or directory.
288
 
 
289
 
    usage: bzr file-id FILE
290
 
 
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
293
 
    moved or renamed.
294
 
    """
295
 
    b = Branch(filename)
296
 
    i = b.inventory.path2id(b.relpath(filename))
297
 
    if i == None:
298
 
        bailout("%r is not a versioned file" % filename)
 
207
    i = Branch('.').read_working_inventory().path2id(filename)
 
208
    if i is None:
 
209
        bailout("%s is not a versioned file" % filename)
299
210
    else:
300
211
        print i
301
212
 
302
213
 
303
 
def cmd_file_id_path(filename):
304
 
    """Print path of file_ids to a file or directory.
305
 
 
306
 
    usage: bzr file-id-path FILE
307
 
 
308
 
    This prints one line for each directory down to the target,
309
 
    starting at the branch root."""
310
 
    b = Branch(filename)
311
 
    inv = b.inventory
312
 
    fid = inv.path2id(b.relpath(filename))
313
 
    if fid == None:
314
 
        bailout("%r is not a versioned file" % filename)
315
 
    for fip in inv.get_idpath(fid):
316
 
        print fip
 
214
def cmd_find_filename(fileid):
 
215
    n = find_filename(fileid)
 
216
    if n is None:
 
217
        bailout("%s is not a live file id" % fileid)
 
218
    else:
 
219
        print n
317
220
 
318
221
 
319
222
def cmd_revision_history():
321
224
        print patchid
322
225
 
323
226
 
324
 
def cmd_directories():
325
 
    for name, ie in Branch('.').read_working_inventory().directories():
326
 
        if name == '':
327
 
            print '.'
328
 
        else:
329
 
            print name
330
 
 
331
 
 
332
 
def cmd_missing():
333
 
    for name, ie in Branch('.').working_tree().missing():
334
 
        print name
335
 
 
336
227
 
337
228
def cmd_init():
338
229
    # TODO: Check we're not already in a working directory?  At the
347
238
    Branch('.', init=True)
348
239
 
349
240
 
350
 
def cmd_diff(revision=None, file_list=None):
351
 
    """bzr diff: Show differences in working tree.
352
 
    
353
 
    usage: bzr diff [-r REV] [FILE...]
354
 
 
355
 
    --revision REV
356
 
         Show changes since REV, rather than predecessor.
357
 
 
358
 
    If files are listed, only the changes in those files are listed.
359
 
    Otherwise, all changes for the tree are listed.
360
 
 
361
 
    TODO: Given two revision arguments, show the difference between them.
362
 
 
363
 
    TODO: Allow diff across branches.
364
 
 
365
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
366
 
          or a graphical diff.
367
 
 
368
 
    TODO: Python difflib is not exactly the same as unidiff; should
369
 
          either fix it up or prefer to use an external diff.
370
 
 
371
 
    TODO: If a directory is given, diff everything under that.
372
 
 
373
 
    TODO: Selected-file diff is inefficient and doesn't show you
374
 
          deleted files.
375
 
 
376
 
    TODO: This probably handles non-Unix newlines poorly.
377
 
"""
378
 
 
379
 
    ## TODO: Shouldn't be in the cmd function.
 
241
def cmd_diff(revision=None):
 
242
    """Show diff from basis to working copy.
 
243
 
 
244
    :todo: Take one or two revision arguments, look up those trees,
 
245
           and diff them.
 
246
 
 
247
    :todo: Allow diff across branches.
 
248
 
 
249
    :todo: Mangle filenames in diff to be more relevant.
 
250
 
 
251
    :todo: Shouldn't be in the cmd function.
 
252
    """
380
253
 
381
254
    b = Branch('.')
382
255
 
386
259
        old_tree = b.revision_tree(b.lookup_revision(revision))
387
260
        
388
261
    new_tree = b.working_tree()
 
262
    old_inv = old_tree.inventory
 
263
    new_inv = new_tree.inventory
389
264
 
390
265
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
391
266
    old_label = ''
400
275
    # be usefully made into a much faster special case.
401
276
 
402
277
    # TODO: Better to return them in sorted order I think.
403
 
 
404
 
    if file_list:
405
 
        file_list = [b.relpath(f) for f in file_list]
406
 
 
407
 
    # FIXME: If given a file list, compare only those files rather
408
 
    # than comparing everything and then throwing stuff away.
409
278
    
410
279
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
280
        d = None
411
281
 
412
 
        if file_list and (new_name not in file_list):
413
 
            continue
414
 
        
415
282
        # Don't show this by default; maybe do it if an option is passed
416
283
        # idlabel = '      {%s}' % fid
417
284
        idlabel = ''
419
286
        # FIXME: Something about the diff format makes patch unhappy
420
287
        # with newly-added files.
421
288
 
422
 
        def diffit(oldlines, newlines, **kw):
423
 
            
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.
430
 
 
431
 
            # In the meantime we at least make sure the patch isn't
432
 
            # mangled.
433
 
            
434
 
 
435
 
            # Special workaround for Python2.3, where difflib fails if
436
 
            # both sequences are empty.
437
 
            if not oldlines and not newlines:
438
 
                return
439
 
 
440
 
            nonl = False
441
 
 
442
 
            if oldlines and (oldlines[-1][-1] != '\n'):
443
 
                oldlines[-1] += '\n'
444
 
                nonl = True
445
 
            if newlines and (newlines[-1][-1] != '\n'):
446
 
                newlines[-1] += '\n'
447
 
                nonl = True
448
 
 
449
 
            ud = difflib.unified_diff(oldlines, newlines, **kw)
450
 
            sys.stdout.writelines(ud)
451
 
            if nonl:
452
 
                print "\\ No newline at end of file"
453
 
            sys.stdout.write('\n')
 
289
        def diffit(*a, **kw):
 
290
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
291
            print
454
292
        
455
293
        if file_state in ['.', '?', 'I']:
456
294
            continue
486
324
 
487
325
 
488
326
 
489
 
def cmd_deleted(show_ids=False):
490
 
    """List files deleted in the working tree.
491
 
 
492
 
    TODO: Show files deleted since a previous revision, or between two revisions.
493
 
    """
494
 
    b = Branch('.')
495
 
    old = b.basis_tree()
496
 
    new = b.working_tree()
497
 
 
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...)
502
 
 
503
 
    for path, ie in old.inventory.iter_entries():
504
 
        if not new.has_id(ie.file_id):
505
 
            if show_ids:
506
 
                print '%-50s %s' % (path, ie.file_id)
507
 
            else:
508
 
                print path
509
 
 
510
 
 
511
 
 
512
 
def cmd_parse_inventory():
513
 
    import cElementTree
514
 
    
515
 
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
516
 
 
517
 
 
518
 
 
519
 
def cmd_load_inventory():
520
 
    """Load inventory for timing purposes"""
521
 
    Branch('.').basis_tree().inventory
522
 
 
523
 
 
524
 
def cmd_dump_inventory():
525
 
    Branch('.').read_working_inventory().write_xml(sys.stdout)
526
 
 
527
 
 
528
 
def cmd_dump_new_inventory():
529
 
    import bzrlib.newinventory
530
 
    inv = Branch('.').basis_tree().inventory
531
 
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
532
 
 
533
 
 
534
 
def cmd_load_new_inventory():
535
 
    import bzrlib.newinventory
536
 
    bzrlib.newinventory.read_new_inventory(sys.stdin)
537
 
                
538
 
    
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)
543
 
 
544
 
 
545
 
 
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)
550
 
 
551
 
 
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)
556
 
    
557
 
    
558
 
 
559
 
def cmd_root(filename=None):
560
 
    """Print the branch root."""
561
 
    print bzrlib.branch.find_branch_root(filename)
562
 
    
563
 
 
564
 
def cmd_log(timezone='original', verbose=False):
 
327
def cmd_log():
565
328
    """Show log of this branch.
566
329
 
567
 
    TODO: Options for utc; to show ids; to limit range; etc.
 
330
    :todo: Options for utc; to show ids; to limit range; etc.
568
331
    """
569
 
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
 
332
    Branch('.').write_log()
570
333
 
571
334
 
572
335
def cmd_ls(revision=None, verbose=False):
573
336
    """List files in a tree.
574
337
 
575
 
    TODO: Take a revision or remote path and list that tree instead.
 
338
    :todo: Take a revision or remote path and list that tree instead.
576
339
    """
577
340
    b = Branch('.')
578
341
    if revision == None:
601
364
        print quotefn(f)
602
365
 
603
366
 
604
 
 
605
 
def cmd_ignored():
606
 
    """List ignored files and the patterns that matched them.
607
 
      """
608
 
    tree = Branch('.').working_tree()
609
 
    for path, file_class, kind, file_id in tree.list_files():
610
 
        if file_class != 'I':
611
 
            continue
612
 
        ## XXX: Slightly inefficient since this was already calculated
613
 
        pat = tree.is_ignored(path)
614
 
        print '%-50s %s' % (path, pat)
615
 
 
616
 
 
617
367
def cmd_lookup_revision(revno):
618
368
    try:
619
369
        revno = int(revno)
632
382
    t = b.revision_tree(rh)
633
383
    t.export(dest)
634
384
 
635
 
def cmd_cat(revision, filename):
636
 
    """Print file to stdout."""
637
 
    b = Branch('.')
638
 
    b.print_file(b.relpath(filename), int(revision))
639
385
 
640
386
 
641
387
######################################################################
644
390
 
645
391
def cmd_uuid():
646
392
    """Print a newly-generated UUID."""
647
 
    print bzrlib.osutils.uuid()
 
393
    print uuid()
648
394
 
649
395
 
650
396
 
653
399
 
654
400
 
655
401
 
656
 
def cmd_commit(message=None, verbose=False):
657
 
    """Commit changes to a new revision.
658
 
 
659
 
    --message MESSAGE
660
 
        Description of changes in this revision; free form text.
661
 
        It is recommended that the first line be a single-sentence
662
 
        summary.
663
 
    --verbose
664
 
        Show status of changed files,
665
 
 
666
 
    TODO: Commit only selected files.
667
 
 
668
 
    TODO: Run hooks on tree to-be-committed, and after commit.
669
 
 
670
 
    TODO: Strict commit that fails if there are unknown or deleted files.
671
 
    """
672
 
 
673
 
    if not message:
674
 
        bailout("please specify a commit message")
 
402
def cmd_commit(message, verbose=False):
675
403
    Branch('.').commit(message, verbose=verbose)
676
404
 
677
405
 
678
 
def cmd_check(dir='.'):
679
 
    """check: Consistency check of branch history.
680
 
 
681
 
    usage: bzr check [-v] [BRANCH]
682
 
 
683
 
    options:
684
 
      --verbose, -v         Show progress of checking.
685
 
 
686
 
    This command checks various invariants about the branch storage to
687
 
    detect data corruption or bzr bugs.
688
 
    """
689
 
    import bzrlib.check
690
 
    bzrlib.check.check(Branch(dir, find_root=False))
 
406
def cmd_check():
 
407
    """Check consistency of the branch."""
 
408
    check()
691
409
 
692
410
 
693
411
def cmd_is(pred, *rest):
705
423
        sys.exit(1)
706
424
 
707
425
 
708
 
def cmd_whoami(email=False):
709
 
    """Show bzr user id.
710
 
 
711
 
    usage: bzr whoami
712
 
 
713
 
    options:
714
 
        --email             Show only the email address.
715
 
    
716
 
    """
717
 
    if email:
718
 
        print bzrlib.osutils.user_email()
719
 
    else:
720
 
        print bzrlib.osutils.username()
721
 
        
722
 
        
 
426
def cmd_username():
 
427
    print bzrlib.osutils.username()
 
428
 
 
429
 
 
430
def cmd_user_email():
 
431
    print bzrlib.osutils.user_email()
 
432
 
 
433
 
723
434
def cmd_gen_revision_id():
 
435
    import time
724
436
    print bzrlib.branch._gen_revision_id(time.time())
725
437
 
726
438
 
727
 
def cmd_selftest():
728
 
    """Run internal test suite"""
 
439
def cmd_doctest():
 
440
    """Run internal doctest suite"""
729
441
    ## -v, if present, is seen by doctest; the argument is just here
730
442
    ## so our parser doesn't complain
731
443
 
732
444
    ## TODO: --verbose option
733
 
 
734
 
    failures, tests = 0, 0
735
445
    
736
 
    import doctest, bzrlib.store, bzrlib.tests
 
446
    import bzr, doctest, bzrlib.store
737
447
    bzrlib.trace.verbose = False
738
 
 
739
 
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
740
 
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
741
 
        mf, mt = doctest.testmod(m)
742
 
        failures += mf
743
 
        tests += mt
744
 
        print '%-40s %3d tests' % (m.__name__, mt),
745
 
        if mf:
746
 
            print '%3d FAILED!' % mf
747
 
        else:
748
 
            print
749
 
 
750
 
    print '%-40s %3d tests' % ('total', tests),
751
 
    if failures:
752
 
        print '%3d FAILED!' % failures
753
 
    else:
754
 
        print
755
 
 
756
 
 
757
 
 
758
 
# deprecated
759
 
cmd_doctest = cmd_selftest
 
448
    doctest.testmod(bzr)
 
449
    doctest.testmod(bzrlib.store)
 
450
    doctest.testmod(bzrlib.inventory)
 
451
    doctest.testmod(bzrlib.branch)
 
452
    doctest.testmod(bzrlib.osutils)
 
453
    doctest.testmod(bzrlib.tree)
 
454
 
 
455
    # more strenuous tests;
 
456
    import bzrlib.tests
 
457
    doctest.testmod(bzrlib.tests)
760
458
 
761
459
 
762
460
######################################################################
763
461
# help
764
462
 
765
463
 
766
 
def cmd_help(topic=None):
767
 
    if topic == None:
768
 
        print __doc__
769
 
    elif topic == 'commands':
770
 
        help_commands()
771
 
    else:
772
 
        # otherwise, maybe the name of a command?
773
 
        topic, cmdfn = get_cmd_handler(topic)
774
 
 
775
 
        doc = getdoc(cmdfn)
776
 
        if doc == None:
777
 
            bailout("sorry, no detailed help yet for %r" % topic)
778
 
 
779
 
        print doc
780
 
 
781
 
 
782
 
def help_commands():
783
 
    """List all commands"""
784
 
    accu = []
785
 
    for k in globals().keys():
786
 
        if k.startswith('cmd_'):
787
 
            accu.append(k[4:].replace('_','-'))
788
 
    accu.sort()
789
 
    print "bzr commands: "
790
 
    for x in accu:
791
 
        print "   " + x
792
 
    print "note: some of these commands are internal-use or obsolete"
793
 
    # TODO: Some kind of marker for internal-use commands?
794
 
    # TODO: Show aliases?
795
 
        
796
 
 
 
464
def cmd_help():
 
465
    # TODO: Specific help for particular commands
 
466
    print __doc__
797
467
 
798
468
 
799
469
def cmd_version():
800
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
801
 
    print bzrlib.__copyright__
 
470
    print "bzr (bazaar-ng) %s" % __version__
 
471
    print __copyright__
802
472
    print "http://bazaar-ng.org/"
803
473
    print
804
474
    print \
824
494
    'all':                    None,
825
495
    'help':                   None,
826
496
    'message':                unicode,
827
 
    'profile':                None,
828
497
    'revision':               int,
829
498
    'show-ids':               None,
830
 
    'timezone':               str,
831
499
    'verbose':                None,
832
500
    'version':                None,
833
 
    'email':                  None,
834
501
    }
835
502
 
836
503
SHORT_OPTIONS = {
843
510
# listed take none.
844
511
cmd_options = {
845
512
    'add':                    ['verbose'],
846
 
    'cat':                    ['revision'],
847
513
    'commit':                 ['message', 'verbose'],
848
 
    'deleted':                ['show-ids'],
849
514
    'diff':                   ['revision'],
850
515
    'inventory':              ['revision'],
851
 
    'log':                    ['timezone', 'verbose'],
852
516
    'ls':                     ['revision', 'verbose'],
 
517
    'status':                 ['all'],
 
518
    'log':                    ['show-ids'],
853
519
    'remove':                 ['verbose'],
854
 
    'status':                 ['all'],
855
 
    'whoami':                 ['email'],
856
520
    }
857
521
 
858
522
 
859
523
cmd_args = {
 
524
    'init':                   [],
860
525
    'add':                    ['file+'],
861
 
    'cat':                    ['filename'],
862
526
    'commit':                 [],
863
 
    'diff':                   ['file*'],
864
 
    'export':                 ['revno', 'dest'],
 
527
    'diff':                   [],
865
528
    'file-id':                ['filename'],
866
 
    'file-id-path':           ['filename'],
867
529
    'get-file-text':          ['text_id'],
868
530
    'get-inventory':          ['inventory_id'],
869
531
    'get-revision':           ['revision_id'],
870
532
    'get-revision-inventory': ['revision_id'],
871
 
    'help':                   ['topic?'],
872
 
    'init':                   [],
873
533
    'log':                    [],
874
534
    'lookup-revision':        ['revno'],
875
 
    'move':                   ['source$', 'dest'],
876
 
    'relpath':                ['filename'],
 
535
    'export':                 ['revno', 'dest'],
877
536
    'remove':                 ['file+'],
878
 
    'rename':                 ['from_name', 'to_name'],
879
 
    'renames':                ['dir?'],
880
 
    'root':                   ['filename?'],
881
537
    'status':                 [],
882
538
    }
883
539
 
890
546
    lookup table, something about the available options, what optargs
891
547
    they take, and which commands will accept them.
892
548
 
893
 
    >>> parse_args('--help'.split())
 
549
    >>> parse_args('bzr --help'.split())
894
550
    ([], {'help': True})
895
 
    >>> parse_args('--version'.split())
 
551
    >>> parse_args('bzr --version'.split())
896
552
    ([], {'version': True})
897
 
    >>> parse_args('status --all'.split())
 
553
    >>> parse_args('bzr status --all'.split())
898
554
    (['status'], {'all': True})
899
 
    >>> parse_args('commit --message=biter'.split())
900
 
    (['commit'], {'message': u'biter'})
901
555
    """
902
556
    args = []
903
557
    opts = {}
904
558
 
905
559
    # TODO: Maybe handle '--' to end options?
906
560
 
907
 
    while argv:
908
 
        a = argv.pop(0)
 
561
    it = iter(argv[1:])
 
562
    while it:
 
563
        a = it.next()
909
564
        if a[0] == '-':
910
 
            # option names must not be unicode
911
 
            a = str(a)
912
 
            optarg = None
913
565
            if a[1] == '-':
914
566
                mutter("  got option %r" % a)
915
 
                if '=' in a:
916
 
                    optname, optarg = a[2:].split('=', 1)
917
 
                else:
918
 
                    optname = a[2:]
 
567
                optname = a[2:]
919
568
                if optname not in OPTIONS:
920
569
                    bailout('unknown long option %r' % a)
921
570
            else:
927
576
            if optname in opts:
928
577
                # XXX: Do we ever want to support this, e.g. for -r?
929
578
                bailout('repeated option %r' % a)
930
 
                
931
579
            optargfn = OPTIONS[optname]
932
580
            if optargfn:
933
 
                if optarg == None:
934
 
                    if not argv:
935
 
                        bailout('option %r needs an argument' % a)
936
 
                    else:
937
 
                        optarg = argv.pop(0)
938
 
                opts[optname] = optargfn(optarg)
 
581
                if not it:
 
582
                    bailout('option %r needs an argument' % a)
 
583
                opts[optname] = optargfn(it.next())
 
584
                mutter("    option argument %r" % opts[optname])
939
585
            else:
940
 
                if optarg != None:
941
 
                    bailout('option %r takes no argument' % optname)
 
586
                # takes no option argument
942
587
                opts[optname] = True
 
588
        elif a[:1] == '-':
 
589
            bailout('unknown short option %r' % a)
943
590
        else:
944
591
            args.append(a)
945
592
 
964
611
    argdict = {}
965
612
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
966
613
    # all but one.
967
 
 
968
 
    # step through args and argform, allowing appropriate 0-many matches
969
614
    for ap in argform:
970
615
        argname = ap[:-1]
971
616
        if ap[-1] == '?':
972
 
            if args:
973
 
                argdict[argname] = args.pop(0)
974
 
        elif ap[-1] == '*': # all remaining arguments
975
 
            if args:
976
 
                argdict[argname + '_list'] = args[:]
977
 
                args = []
978
 
            else:
979
 
                argdict[argname + '_list'] = None
 
617
            assert 0
 
618
        elif ap[-1] == '*':
 
619
            assert 0
980
620
        elif ap[-1] == '+':
981
621
            if not args:
982
622
                bailout("command %r needs one or more %s"
984
624
            else:
985
625
                argdict[argname + '_list'] = args[:]
986
626
                args = []
987
 
        elif ap[-1] == '$': # all but one
988
 
            if len(args) < 2:
989
 
                bailout("command %r needs one or more %s"
990
 
                        % (cmd, argname.upper()))
991
 
            argdict[argname + '_list'] = args[:-1]
992
 
            args[:-1] = []                
993
627
        else:
994
628
            # just a plain arg
995
629
            argname = ap
1011
645
    """Execute a command.
1012
646
 
1013
647
    This is similar to main(), but without all the trappings for
1014
 
    logging and error handling.  
 
648
    logging and error handling.
1015
649
    """
1016
 
 
1017
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1018
 
    
1019
650
    try:
1020
 
        args, opts = parse_args(argv[1:])
 
651
        args, opts = parse_args(argv)
1021
652
        if 'help' in opts:
1022
653
            # TODO: pass down other arguments in case they asked for
1023
654
            # help on a command name?
1024
 
            if args:
1025
 
                cmd_help(args[0])
1026
 
            else:
1027
 
                cmd_help()
 
655
            cmd_help()
1028
656
            return 0
1029
657
        elif 'version' in opts:
1030
658
            cmd_version()
1031
659
            return 0
1032
 
        cmd = str(args.pop(0))
 
660
        cmd = args.pop(0)
1033
661
    except IndexError:
1034
 
        log_error('usage: bzr COMMAND')
1035
 
        log_error('  try "bzr help"')
 
662
        log_error('usage: bzr COMMAND\n')
 
663
        log_error('  try "bzr help"\n')
1036
664
        return 1
1037
 
 
1038
 
    canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1039
 
 
1040
 
    # global option
1041
 
    if 'profile' in opts:
1042
 
        profile = True
1043
 
        del opts['profile']
1044
 
    else:
1045
 
        profile = False
 
665
            
 
666
    try:
 
667
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
668
    except KeyError:
 
669
        bailout("unknown command " + `cmd`)
 
670
 
 
671
    # TODO: special --profile option to turn on the Python profiler
1046
672
 
1047
673
    # check options are reasonable
1048
 
    allowed = cmd_options.get(canonical_cmd, [])
 
674
    allowed = cmd_options.get(cmd, [])
1049
675
    for oname in opts:
1050
676
        if oname not in allowed:
1051
677
            bailout("option %r is not allowed for command %r"
1052
678
                    % (oname, cmd))
1053
679
 
1054
 
    # TODO: give an error if there are any mandatory options which are
1055
 
    # not specified?  Or maybe there shouldn't be any "mandatory
1056
 
    # options" (it is an oxymoron)
1057
 
 
1058
 
    # mix arguments and options into one dictionary
1059
 
    cmdargs = _match_args(canonical_cmd, args)
1060
 
    for k, v in opts.items():
1061
 
        cmdargs[k.replace('-', '_')] = v
1062
 
 
1063
 
    if profile:
1064
 
        import hotshot
1065
 
        pffileno, pfname = tempfile.mkstemp()
1066
 
        try:
1067
 
            prof = hotshot.Profile(pfname)
1068
 
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
1069
 
            prof.close()
1070
 
 
1071
 
            import hotshot.stats
1072
 
            stats = hotshot.stats.load(pfname)
1073
 
            #stats.strip_dirs()
1074
 
            stats.sort_stats('time')
1075
 
            ## XXX: Might like to write to stderr or the trace file instead but
1076
 
            ## print_stats seems hardcoded to stdout
1077
 
            stats.print_stats(20)
1078
 
            
1079
 
            return ret
1080
 
 
1081
 
        finally:
1082
 
            os.close(pffileno)
1083
 
            os.remove(pfname)
1084
 
    else:
1085
 
        return cmd_handler(**cmdargs) or 0
1086
 
 
1087
 
 
1088
 
 
1089
 
def _report_exception(e, summary):
1090
 
    import traceback
1091
 
    log_error('bzr: ' + summary)
1092
 
    bzrlib.trace.log_exception(e)
1093
 
    tb = sys.exc_info()[2]
1094
 
    exinfo = traceback.extract_tb(tb)
1095
 
    if exinfo:
1096
 
        sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1097
 
    sys.stderr.write('  see ~/.bzr.log for debug information\n')
1098
 
 
1099
 
 
1100
 
def cmd_assert_fail():
1101
 
    assert False, "always fails"
 
680
    cmdargs = _match_args(cmd, args)
 
681
    cmdargs.update(opts)
 
682
 
 
683
    ret = cmd_handler(**cmdargs) or 0
 
684
 
1102
685
 
1103
686
 
1104
687
def main(argv):
1105
 
    bzrlib.trace.create_tracefile(argv)
 
688
    ## TODO: Handle command-line options; probably know what options are valid for
 
689
    ## each command
 
690
 
 
691
    ## TODO: If the arguments are wrong, give a usage message rather
 
692
    ## than just a backtrace.
1106
693
 
1107
694
    try:
1108
 
        try:
1109
 
            ret = run_bzr(argv)
1110
 
            return ret
1111
 
        except BzrError, e:
1112
 
            _report_exception(e, 'error: ' + e.args[0])
1113
 
            if len(e.args) > 1:
1114
 
                for h in e.args[1]:
1115
 
                    # some explanation or hints
1116
 
                    log_error('  ' + h)
1117
 
            return 1
1118
 
        except AssertionError, e:
1119
 
            msg = 'assertion failed'
1120
 
            if str(e):
1121
 
                msg += ': ' + str(e)
1122
 
            _report_exception(e, msg)
1123
 
        except Exception, e:
1124
 
            _report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1125
 
            return 1
1126
 
    finally:
1127
 
        bzrlib.trace.close_trace()
1128
 
 
1129
 
    ## TODO: Trap AssertionError
1130
 
 
1131
 
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
 
695
        t = bzrlib.trace._tracefile
 
696
        t.write('-' * 60 + '\n')
 
697
        t.write('bzr invoked at %s\n' % format_date(time.time()))
 
698
        t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
 
699
        t.write('  arguments: %r\n' % argv)
 
700
 
 
701
        starttime = os.times()[4]
 
702
 
 
703
        import platform
 
704
        t.write('  platform: %s\n' % platform.platform())
 
705
        t.write('  python: %s\n' % platform.python_version())
 
706
 
 
707
        ret = run_bzr(argv)
 
708
        
 
709
        times = os.times()
 
710
        mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
 
711
               % times[:4])
 
712
        mutter("    %.3f elapsed" % (times[4] - starttime))
 
713
 
 
714
        return ret
 
715
    except BzrError, e:
 
716
        log_error('bzr: error: ' + e.args[0] + '\n')
 
717
        if len(e.args) > 1:
 
718
            for h in e.args[1]:
 
719
                log_error('  ' + h + '\n')
 
720
        return 1
 
721
    except Exception, e:
 
722
        log_error('bzr: exception: %s\n' % e)
 
723
        log_error('    see .bzr.log for details\n')
 
724
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
725
        traceback.print_exc(None, sys.stderr)
 
726
        return 1
 
727
 
 
728
    # TODO: Maybe nicer handling of IOError?
1132
729
 
1133
730
 
1134
731
 
1135
732
if __name__ == '__main__':
1136
733
    sys.exit(main(sys.argv))
 
734
    ##import profile
 
735
    ##profile.run('main(sys.argv)')
 
736