~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 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

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
 
86
from ElementTree import Element, ElementTree, SubElement
75
87
 
76
88
import bzrlib
77
89
from bzrlib.store import ImmutableStore
78
90
from bzrlib.trace import mutter, note, log_error
79
 
from bzrlib.errors import bailout, BzrError, BzrCheckError
 
91
from bzrlib.errors import bailout, BzrError
80
92
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
93
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
94
from bzrlib.revision import Revision
104
116
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
117
## to compare output?
106
118
 
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
 
 
 
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
136
129
 
137
130
 
138
131
def cmd_status(all=False):
141
134
    For each file there is a single line giving its file state and name.
142
135
    The name is that in the current revision unless it is deleted or
143
136
    missing, in which case the old name is shown.
 
137
 
 
138
    :todo: Don't show unchanged files unless ``--all`` is given?
144
139
    """
145
 
    #import bzrlib.status
146
 
    #bzrlib.status.tree_status(Branch('.'))
147
140
    Branch('.').show_status(show_all=all)
148
141
 
149
142
 
154
147
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
155
148
 
156
149
 
 
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
 
157
161
def cmd_get_file_text(text_id):
158
162
    """Get contents of a file by hash."""
159
163
    sf = Branch('.').text_store[text_id]
170
174
    print Branch('.').revno()
171
175
    
172
176
 
173
 
    
174
177
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?
 
178
    """Add specified files.
 
179
    
 
180
    Fails if the files are already added.
194
181
    """
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
 
 
 
182
    Branch('.').add(file_list, verbose=verbose)
202
183
 
203
184
 
204
185
def cmd_inventory(revision=None):
216
197
 
217
198
 
218
199
 
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
200
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
 
    
 
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())
278
205
 
279
206
 
280
207
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)
 
208
    Branch('.').remove(file_list, verbose=verbose)
283
209
 
284
210
 
285
211
 
286
212
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)
 
213
    i = Branch('.').read_working_inventory().path2id(filename)
 
214
    if i is None:
 
215
        bailout("%s is not a versioned file" % filename)
299
216
    else:
300
217
        print i
301
218
 
302
219
 
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
 
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
317
226
 
318
227
 
319
228
def cmd_revision_history():
321
230
        print patchid
322
231
 
323
232
 
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
233
 
337
234
def cmd_init():
338
235
    # TODO: Check we're not already in a working directory?  At the
347
244
    Branch('.', init=True)
348
245
 
349
246
 
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.
 
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
    """
380
259
 
381
260
    b = Branch('.')
382
261
 
386
265
        old_tree = b.revision_tree(b.lookup_revision(revision))
387
266
        
388
267
    new_tree = b.working_tree()
 
268
    old_inv = old_tree.inventory
 
269
    new_inv = new_tree.inventory
389
270
 
390
271
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
391
272
    old_label = ''
400
281
    # be usefully made into a much faster special case.
401
282
 
402
283
    # 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
284
    
410
285
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
286
        d = None
411
287
 
412
 
        if file_list and (new_name not in file_list):
413
 
            continue
414
 
        
415
288
        # Don't show this by default; maybe do it if an option is passed
416
289
        # idlabel = '      {%s}' % fid
417
290
        idlabel = ''
419
292
        # FIXME: Something about the diff format makes patch unhappy
420
293
        # with newly-added files.
421
294
 
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')
 
295
        def diffit(*a, **kw):
 
296
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
297
            print
454
298
        
455
299
        if file_state in ['.', '?', 'I']:
456
300
            continue
486
330
 
487
331
 
488
332
 
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):
 
333
def cmd_log():
565
334
    """Show log of this branch.
566
335
 
567
 
    TODO: Options for utc; to show ids; to limit range; etc.
 
336
    :todo: Options for utc; to show ids; to limit range; etc.
568
337
    """
569
 
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
 
338
    Branch('.').write_log()
570
339
 
571
340
 
572
341
def cmd_ls(revision=None, verbose=False):
573
342
    """List files in a tree.
574
343
 
575
 
    TODO: Take a revision or remote path and list that tree instead.
 
344
    :todo: Take a revision or remote path and list that tree instead.
576
345
    """
577
346
    b = Branch('.')
578
347
    if revision == None:
601
370
        print quotefn(f)
602
371
 
603
372
 
604
 
 
605
 
def cmd_ignore(name_pattern):
606
 
    """Ignore a command or pattern"""
607
 
 
608
 
    b = Branch('.')
609
 
 
610
 
    # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
611
 
    f = open(b.abspath('.bzrignore'), 'at')
612
 
    f.write(name_pattern + '\n')
613
 
    f.close()
614
 
    
615
 
    inv = b.working_tree().inventory
616
 
    if inv.path2id('.bzrignore'):
617
 
        mutter('.bzrignore is already versioned')
618
 
    else:
619
 
        mutter('need to make new .bzrignore file versioned')
620
 
        b.add(['.bzrignore'])
621
 
 
622
 
 
623
 
 
624
 
def cmd_ignored():
625
 
    """List ignored files and the patterns that matched them.
626
 
      """
627
 
    tree = Branch('.').working_tree()
628
 
    for path, file_class, kind, file_id in tree.list_files():
629
 
        if file_class != 'I':
630
 
            continue
631
 
        ## XXX: Slightly inefficient since this was already calculated
632
 
        pat = tree.is_ignored(path)
633
 
        print '%-50s %s' % (path, pat)
634
 
 
635
 
 
636
373
def cmd_lookup_revision(revno):
637
374
    try:
638
375
        revno = int(revno)
651
388
    t = b.revision_tree(rh)
652
389
    t.export(dest)
653
390
 
654
 
def cmd_cat(revision, filename):
655
 
    """Print file to stdout."""
656
 
    b = Branch('.')
657
 
    b.print_file(b.relpath(filename), int(revision))
658
391
 
659
392
 
660
393
######################################################################
663
396
 
664
397
def cmd_uuid():
665
398
    """Print a newly-generated UUID."""
666
 
    print bzrlib.osutils.uuid()
667
 
 
668
 
 
669
 
 
670
 
def cmd_local_time_offset():
671
 
    print bzrlib.osutils.local_time_offset()
672
 
 
673
 
 
674
 
 
675
 
def cmd_commit(message=None, verbose=False):
676
 
    """Commit changes to a new revision.
677
 
 
678
 
    --message MESSAGE
679
 
        Description of changes in this revision; free form text.
680
 
        It is recommended that the first line be a single-sentence
681
 
        summary.
682
 
    --verbose
683
 
        Show status of changed files,
684
 
 
685
 
    TODO: Commit only selected files.
686
 
 
687
 
    TODO: Run hooks on tree to-be-committed, and after commit.
688
 
 
689
 
    TODO: Strict commit that fails if there are unknown or deleted files.
690
 
    """
691
 
 
692
 
    if not message:
693
 
        bailout("please specify a commit message")
 
399
    print uuid()
 
400
 
 
401
 
 
402
 
 
403
def cmd_commit(message, verbose=False):
694
404
    Branch('.').commit(message, verbose=verbose)
695
405
 
696
406
 
697
 
def cmd_check(dir='.'):
698
 
    """check: Consistency check of branch history.
699
 
 
700
 
    usage: bzr check [-v] [BRANCH]
701
 
 
702
 
    options:
703
 
      --verbose, -v         Show progress of checking.
704
 
 
705
 
    This command checks various invariants about the branch storage to
706
 
    detect data corruption or bzr bugs.
707
 
    """
708
 
    import bzrlib.check
709
 
    bzrlib.check.check(Branch(dir, find_root=False))
 
407
def cmd_check():
 
408
    """Check consistency of the branch."""
 
409
    check()
710
410
 
711
411
 
712
412
def cmd_is(pred, *rest):
724
424
        sys.exit(1)
725
425
 
726
426
 
727
 
def cmd_whoami(email=False):
728
 
    """Show bzr user id.
729
 
 
730
 
    usage: bzr whoami
731
 
 
732
 
    options:
733
 
        --email             Show only the email address.
734
 
    
735
 
    """
736
 
    if email:
737
 
        print bzrlib.osutils.user_email()
738
 
    else:
739
 
        print bzrlib.osutils.username()
740
 
        
741
 
        
 
427
def cmd_username():
 
428
    print bzrlib.osutils.username()
 
429
 
 
430
 
 
431
def cmd_user_email():
 
432
    print bzrlib.osutils.user_email()
 
433
 
 
434
 
742
435
def cmd_gen_revision_id():
 
436
    import time
743
437
    print bzrlib.branch._gen_revision_id(time.time())
744
438
 
745
439
 
746
 
def cmd_selftest():
747
 
    """Run internal test suite"""
 
440
def cmd_doctest():
 
441
    """Run internal doctest suite"""
748
442
    ## -v, if present, is seen by doctest; the argument is just here
749
443
    ## so our parser doesn't complain
750
444
 
751
445
    ## TODO: --verbose option
752
 
 
753
 
    failures, tests = 0, 0
754
446
    
755
 
    import doctest, bzrlib.store, bzrlib.tests
 
447
    import bzr, doctest, bzrlib.store
756
448
    bzrlib.trace.verbose = False
757
 
 
758
 
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
759
 
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
760
 
        mf, mt = doctest.testmod(m)
761
 
        failures += mf
762
 
        tests += mt
763
 
        print '%-40s %3d tests' % (m.__name__, mt),
764
 
        if mf:
765
 
            print '%3d FAILED!' % mf
766
 
        else:
767
 
            print
768
 
 
769
 
    print '%-40s %3d tests' % ('total', tests),
770
 
    if failures:
771
 
        print '%3d FAILED!' % failures
772
 
    else:
773
 
        print
774
 
 
775
 
 
776
 
 
777
 
# deprecated
778
 
cmd_doctest = cmd_selftest
 
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)
779
459
 
780
460
 
781
461
######################################################################
782
462
# help
783
463
 
784
464
 
785
 
def cmd_help(topic=None):
786
 
    if topic == None:
787
 
        print __doc__
788
 
    elif topic == 'commands':
789
 
        help_commands()
790
 
    else:
791
 
        # otherwise, maybe the name of a command?
792
 
        topic, cmdfn = get_cmd_handler(topic)
793
 
 
794
 
        doc = getdoc(cmdfn)
795
 
        if doc == None:
796
 
            bailout("sorry, no detailed help yet for %r" % topic)
797
 
 
798
 
        print doc
799
 
 
800
 
 
801
 
def help_commands():
802
 
    """List all commands"""
803
 
    accu = []
804
 
    for k in globals().keys():
805
 
        if k.startswith('cmd_'):
806
 
            accu.append(k[4:].replace('_','-'))
807
 
    accu.sort()
808
 
    print "bzr commands: "
809
 
    for x in accu:
810
 
        print "   " + x
811
 
    print "note: some of these commands are internal-use or obsolete"
812
 
    # TODO: Some kind of marker for internal-use commands?
813
 
    # TODO: Show aliases?
814
 
        
815
 
 
 
465
def cmd_help():
 
466
    # TODO: Specific help for particular commands
 
467
    print __doc__
816
468
 
817
469
 
818
470
def cmd_version():
819
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
820
 
    print bzrlib.__copyright__
 
471
    print "bzr (bazaar-ng) %s" % __version__
 
472
    print __copyright__
821
473
    print "http://bazaar-ng.org/"
822
474
    print
823
475
    print \
843
495
    'all':                    None,
844
496
    'help':                   None,
845
497
    'message':                unicode,
846
 
    'profile':                None,
847
498
    'revision':               int,
848
499
    'show-ids':               None,
849
 
    'timezone':               str,
850
500
    'verbose':                None,
851
501
    'version':                None,
852
 
    'email':                  None,
853
502
    }
854
503
 
855
504
SHORT_OPTIONS = {
862
511
# listed take none.
863
512
cmd_options = {
864
513
    'add':                    ['verbose'],
865
 
    'cat':                    ['revision'],
866
514
    'commit':                 ['message', 'verbose'],
867
 
    'deleted':                ['show-ids'],
868
515
    'diff':                   ['revision'],
869
516
    'inventory':              ['revision'],
870
 
    'log':                    ['timezone', 'verbose'],
871
517
    'ls':                     ['revision', 'verbose'],
 
518
    'status':                 ['all'],
 
519
    'log':                    ['show-ids'],
872
520
    'remove':                 ['verbose'],
873
 
    'status':                 ['all'],
874
 
    'whoami':                 ['email'],
875
521
    }
876
522
 
877
523
 
878
524
cmd_args = {
 
525
    'init':                   [],
879
526
    'add':                    ['file+'],
880
 
    'cat':                    ['filename'],
881
527
    'commit':                 [],
882
 
    'diff':                   ['file*'],
883
 
    'export':                 ['revno', 'dest'],
 
528
    'diff':                   [],
884
529
    'file-id':                ['filename'],
885
 
    'file-id-path':           ['filename'],
886
530
    'get-file-text':          ['text_id'],
887
531
    'get-inventory':          ['inventory_id'],
888
532
    'get-revision':           ['revision_id'],
889
533
    'get-revision-inventory': ['revision_id'],
890
 
    'help':                   ['topic?'],
891
 
    'ignore':                 ['name_pattern'],
892
 
    'init':                   [],
893
534
    'log':                    [],
894
535
    'lookup-revision':        ['revno'],
895
 
    'move':                   ['source$', 'dest'],
896
 
    'relpath':                ['filename'],
 
536
    'export':                 ['revno', 'dest'],
897
537
    'remove':                 ['file+'],
898
 
    'rename':                 ['from_name', 'to_name'],
899
 
    'renames':                ['dir?'],
900
 
    'root':                   ['filename?'],
901
538
    'status':                 [],
902
539
    }
903
540
 
910
547
    lookup table, something about the available options, what optargs
911
548
    they take, and which commands will accept them.
912
549
 
913
 
    >>> parse_args('--help'.split())
 
550
    >>> parse_args('bzr --help'.split())
914
551
    ([], {'help': True})
915
 
    >>> parse_args('--version'.split())
 
552
    >>> parse_args('bzr --version'.split())
916
553
    ([], {'version': True})
917
 
    >>> parse_args('status --all'.split())
 
554
    >>> parse_args('bzr status --all'.split())
918
555
    (['status'], {'all': True})
919
 
    >>> parse_args('commit --message=biter'.split())
920
 
    (['commit'], {'message': u'biter'})
921
556
    """
922
557
    args = []
923
558
    opts = {}
924
559
 
925
560
    # TODO: Maybe handle '--' to end options?
926
561
 
927
 
    while argv:
928
 
        a = argv.pop(0)
 
562
    it = iter(argv[1:])
 
563
    while it:
 
564
        a = it.next()
929
565
        if a[0] == '-':
930
 
            # option names must not be unicode
931
 
            a = str(a)
932
 
            optarg = None
933
566
            if a[1] == '-':
934
567
                mutter("  got option %r" % a)
935
 
                if '=' in a:
936
 
                    optname, optarg = a[2:].split('=', 1)
937
 
                else:
938
 
                    optname = a[2:]
 
568
                optname = a[2:]
939
569
                if optname not in OPTIONS:
940
570
                    bailout('unknown long option %r' % a)
941
571
            else:
947
577
            if optname in opts:
948
578
                # XXX: Do we ever want to support this, e.g. for -r?
949
579
                bailout('repeated option %r' % a)
950
 
                
951
580
            optargfn = OPTIONS[optname]
952
581
            if optargfn:
953
 
                if optarg == None:
954
 
                    if not argv:
955
 
                        bailout('option %r needs an argument' % a)
956
 
                    else:
957
 
                        optarg = argv.pop(0)
958
 
                opts[optname] = optargfn(optarg)
 
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])
959
586
            else:
960
 
                if optarg != None:
961
 
                    bailout('option %r takes no argument' % optname)
 
587
                # takes no option argument
962
588
                opts[optname] = True
 
589
        elif a[:1] == '-':
 
590
            bailout('unknown short option %r' % a)
963
591
        else:
964
592
            args.append(a)
965
593
 
984
612
    argdict = {}
985
613
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
986
614
    # all but one.
987
 
 
988
 
    # step through args and argform, allowing appropriate 0-many matches
989
615
    for ap in argform:
990
616
        argname = ap[:-1]
991
617
        if ap[-1] == '?':
992
 
            if args:
993
 
                argdict[argname] = args.pop(0)
994
 
        elif ap[-1] == '*': # all remaining arguments
995
 
            if args:
996
 
                argdict[argname + '_list'] = args[:]
997
 
                args = []
998
 
            else:
999
 
                argdict[argname + '_list'] = None
 
618
            assert 0
 
619
        elif ap[-1] == '*':
 
620
            assert 0
1000
621
        elif ap[-1] == '+':
1001
622
            if not args:
1002
623
                bailout("command %r needs one or more %s"
1004
625
            else:
1005
626
                argdict[argname + '_list'] = args[:]
1006
627
                args = []
1007
 
        elif ap[-1] == '$': # all but one
1008
 
            if len(args) < 2:
1009
 
                bailout("command %r needs one or more %s"
1010
 
                        % (cmd, argname.upper()))
1011
 
            argdict[argname + '_list'] = args[:-1]
1012
 
            args[:-1] = []                
1013
628
        else:
1014
629
            # just a plain arg
1015
630
            argname = ap
1031
646
    """Execute a command.
1032
647
 
1033
648
    This is similar to main(), but without all the trappings for
1034
 
    logging and error handling.  
 
649
    logging and error handling.
1035
650
    """
1036
 
 
1037
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1038
 
    
1039
651
    try:
1040
 
        args, opts = parse_args(argv[1:])
 
652
        args, opts = parse_args(argv)
1041
653
        if 'help' in opts:
1042
654
            # TODO: pass down other arguments in case they asked for
1043
655
            # help on a command name?
1044
 
            if args:
1045
 
                cmd_help(args[0])
1046
 
            else:
1047
 
                cmd_help()
 
656
            cmd_help()
1048
657
            return 0
1049
658
        elif 'version' in opts:
1050
659
            cmd_version()
1051
660
            return 0
1052
 
        cmd = str(args.pop(0))
 
661
        cmd = args.pop(0)
1053
662
    except IndexError:
1054
 
        log_error('usage: bzr COMMAND')
1055
 
        log_error('  try "bzr help"')
 
663
        log_error('usage: bzr COMMAND\n')
 
664
        log_error('  try "bzr help"\n')
1056
665
        return 1
1057
 
 
1058
 
    canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1059
 
 
1060
 
    # global option
1061
 
    if 'profile' in opts:
1062
 
        profile = True
1063
 
        del opts['profile']
1064
 
    else:
1065
 
        profile = False
 
666
            
 
667
    try:
 
668
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
669
    except KeyError:
 
670
        bailout("unknown command " + `cmd`)
 
671
 
 
672
    # TODO: special --profile option to turn on the Python profiler
1066
673
 
1067
674
    # check options are reasonable
1068
 
    allowed = cmd_options.get(canonical_cmd, [])
 
675
    allowed = cmd_options.get(cmd, [])
1069
676
    for oname in opts:
1070
677
        if oname not in allowed:
1071
678
            bailout("option %r is not allowed for command %r"
1072
679
                    % (oname, cmd))
1073
680
 
1074
 
    # TODO: give an error if there are any mandatory options which are
1075
 
    # not specified?  Or maybe there shouldn't be any "mandatory
1076
 
    # options" (it is an oxymoron)
1077
 
 
1078
 
    # mix arguments and options into one dictionary
1079
 
    cmdargs = _match_args(canonical_cmd, args)
1080
 
    for k, v in opts.items():
1081
 
        cmdargs[k.replace('-', '_')] = v
1082
 
 
1083
 
    if profile:
1084
 
        import hotshot
1085
 
        pffileno, pfname = tempfile.mkstemp()
1086
 
        try:
1087
 
            prof = hotshot.Profile(pfname)
1088
 
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
1089
 
            prof.close()
1090
 
 
1091
 
            import hotshot.stats
1092
 
            stats = hotshot.stats.load(pfname)
1093
 
            #stats.strip_dirs()
1094
 
            stats.sort_stats('time')
1095
 
            ## XXX: Might like to write to stderr or the trace file instead but
1096
 
            ## print_stats seems hardcoded to stdout
1097
 
            stats.print_stats(20)
1098
 
            
1099
 
            return ret
1100
 
 
1101
 
        finally:
1102
 
            os.close(pffileno)
1103
 
            os.remove(pfname)
1104
 
    else:
1105
 
        return cmd_handler(**cmdargs) or 0
1106
 
 
1107
 
 
1108
 
 
1109
 
def _report_exception(e, summary):
1110
 
    import traceback
1111
 
    log_error('bzr: ' + summary)
1112
 
    bzrlib.trace.log_exception(e)
1113
 
    tb = sys.exc_info()[2]
1114
 
    exinfo = traceback.extract_tb(tb)
1115
 
    if exinfo:
1116
 
        sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1117
 
    sys.stderr.write('  see ~/.bzr.log for debug information\n')
1118
 
 
1119
 
 
1120
 
def cmd_assert_fail():
1121
 
    assert False, "always fails"
 
681
    cmdargs = _match_args(cmd, args)
 
682
    cmdargs.update(opts)
 
683
 
 
684
    ret = cmd_handler(**cmdargs) or 0
 
685
 
1122
686
 
1123
687
 
1124
688
def main(argv):
1125
 
    bzrlib.trace.create_tracefile(argv)
 
689
    ## TODO: Handle command-line options; probably know what options are valid for
 
690
    ## each command
 
691
 
 
692
    ## TODO: If the arguments are wrong, give a usage message rather
 
693
    ## than just a backtrace.
1126
694
 
1127
695
    try:
1128
 
        try:
1129
 
            ret = run_bzr(argv)
1130
 
            return ret
1131
 
        except BzrError, e:
1132
 
            _report_exception(e, 'error: ' + e.args[0])
1133
 
            if len(e.args) > 1:
1134
 
                for h in e.args[1]:
1135
 
                    # some explanation or hints
1136
 
                    log_error('  ' + h)
1137
 
            return 1
1138
 
        except AssertionError, e:
1139
 
            msg = 'assertion failed'
1140
 
            if str(e):
1141
 
                msg += ': ' + str(e)
1142
 
            _report_exception(e, msg)
1143
 
        except Exception, e:
1144
 
            _report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1145
 
            return 1
1146
 
    finally:
1147
 
        bzrlib.trace.close_trace()
1148
 
 
1149
 
    ## TODO: Trap AssertionError
1150
 
 
1151
 
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
 
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
        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
        return ret
 
716
    except BzrError, e:
 
717
        log_error('bzr: error: ' + e.args[0] + '\n')
 
718
        if len(e.args) > 1:
 
719
            for h in e.args[1]:
 
720
                log_error('  ' + h + '\n')
 
721
        return 1
 
722
    except Exception, e:
 
723
        log_error('bzr: exception: %s\n' % e)
 
724
        log_error('    see .bzr.log for details\n')
 
725
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
726
        traceback.print_exc(None, sys.stderr)
 
727
        return 1
 
728
 
 
729
    # TODO: Maybe nicer handling of IOError?
1152
730
 
1153
731
 
1154
732
 
1155
733
if __name__ == '__main__':
1156
734
    sys.exit(main(sys.argv))
 
735
    ##import profile
 
736
    ##profile.run('main(sys.argv)')
 
737