~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

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