/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-11 01:01:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050411010135-f70271e3bbb92d5ee2b4e151
Allow docstrings for help to be in PEP0257 format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
3
 
 
4
 
 
5
# This program is free software; you can redistribute it and/or modify
 
6
# it under the terms of the GNU General Public License as published by
 
7
# the Free Software Foundation; either version 2 of the License, or
 
8
# (at your option) any later version.
 
9
 
 
10
# This program is distributed in the hope that it will be useful,
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
# GNU General Public License for more details.
 
14
 
 
15
# You should have received a copy of the GNU General Public License
 
16
# along with this program; if not, write to the Free Software
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
 
19
"""Bazaar-NG -- a free distributed version-control tool
 
20
 
 
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
22
 
 
23
Current limitation include:
 
24
 
 
25
* Metadata format is not stable yet -- you may need to
 
26
  discard history in the future.
 
27
 
 
28
* Insufficient error handling.
 
29
 
 
30
* Many commands unimplemented or partially implemented.
 
31
 
 
32
* Space-inefficient storage.
 
33
 
 
34
* No merge operators yet.
 
35
 
 
36
Interesting commands::
 
37
 
 
38
  bzr help [COMMAND]
 
39
       Show help screen
 
40
  bzr version
 
41
       Show software version/licence/non-warranty.
 
42
  bzr init
 
43
       Start versioning the current directory
 
44
  bzr add FILE...
 
45
       Make files versioned.
 
46
  bzr log
 
47
       Show revision history.
 
48
  bzr diff [FILE...]
 
49
       Show changes from last revision to working copy.
 
50
  bzr commit -m 'MESSAGE'
 
51
       Store current state as new revision.
 
52
  bzr export REVNO DESTINATION
 
53
       Export the branch state at a previous version.
 
54
  bzr status
 
55
       Show summary of pending changes.
 
56
  bzr remove FILE...
 
57
       Make a file not versioned.
 
58
  bzr info
 
59
       Show statistics about this branch.
 
60
"""
 
61
 
 
62
 
 
63
 
 
64
 
 
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
 
66
from sets import Set
 
67
from pprint import pprint
 
68
from stat import *
 
69
from glob import glob
 
70
from inspect import getdoc
 
71
 
 
72
import bzrlib
 
73
from bzrlib.store import ImmutableStore
 
74
from bzrlib.trace import mutter, note, log_error
 
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
 
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
78
from bzrlib.revision import Revision
 
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
80
     format_date
 
81
 
 
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
84
 
 
85
## standard representation
 
86
NONE_STRING = '(none)'
 
87
EMPTY = 'empty'
 
88
 
 
89
 
 
90
## TODO: Perhaps a different version of inventory commands that
 
91
## returns iterators...
 
92
 
 
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
94
 
 
95
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
96
## parameter to the branch object saying whether we want a read or
 
97
## write lock; release it from destructor.  Perhaps don't even need a
 
98
## read lock to look at immutable objects?
 
99
 
 
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
101
## to compare output?
 
102
 
 
103
## TODO: Some kind of global code to generate the right Branch object
 
104
## to work on.  Almost, but not quite all, commands need one, and it
 
105
## can be taken either from their parameters or their working
 
106
## directory.
 
107
 
 
108
## TODO: rename command, needed soon: check destination doesn't exist
 
109
## either in working copy or tree; move working copy; update
 
110
## inventory; write out
 
111
 
 
112
## TODO: move command; check destination is a directory and will not
 
113
## clash; move it.
 
114
 
 
115
## TODO: command to show renames, one per line, as to->from
 
116
 
 
117
 
 
118
 
 
119
 
 
120
def cmd_status(all=False):
 
121
    """Display status summary.
 
122
 
 
123
    For each file there is a single line giving its file state and name.
 
124
    The name is that in the current revision unless it is deleted or
 
125
    missing, in which case the old name is shown.
 
126
 
 
127
    :todo: Don't show unchanged files unless ``--all`` is given?
 
128
    """
 
129
    Branch('.').show_status(show_all=all)
 
130
 
 
131
 
 
132
 
 
133
######################################################################
 
134
# examining history
 
135
def cmd_get_revision(revision_id):
 
136
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
137
 
 
138
 
 
139
def cmd_get_file_text(text_id):
 
140
    """Get contents of a file by hash."""
 
141
    sf = Branch('.').text_store[text_id]
 
142
    pumpfile(sf, sys.stdout)
 
143
 
 
144
 
 
145
 
 
146
######################################################################
 
147
# commands
 
148
    
 
149
 
 
150
def cmd_revno():
 
151
    """Show number of revisions on this branch"""
 
152
    print Branch('.').revno()
 
153
    
 
154
 
 
155
    
 
156
def cmd_add(file_list, verbose=False):
 
157
    """Add specified files or directories.
 
158
 
 
159
    In non-recursive mode, all the named items are added, regardless
 
160
    of whether they were previously ignored.  A warning is given if
 
161
    any of the named files are already versioned.
 
162
 
 
163
    In recursive mode (the default), files are treated the same way
 
164
    but the behaviour for directories is different.  Directories that
 
165
    are already versioned do not give a warning.  All directories,
 
166
    whether already versioned or not, are searched for files or
 
167
    subdirectories that are neither versioned or ignored, and these
 
168
    are added.  This search proceeds recursively into versioned
 
169
    directories.
 
170
 
 
171
    Therefore simply saying 'bzr add .' will version all files that
 
172
    are currently unknown.
 
173
    """
 
174
    bzrlib.add.smart_add(file_list, verbose)
 
175
    
 
176
 
 
177
def cmd_relpath(filename):
 
178
    """Show path of file relative to root"""
 
179
    print Branch(filename).relpath(filename)
 
180
 
 
181
 
 
182
 
 
183
def cmd_inventory(revision=None):
 
184
    """Show inventory of the current working copy."""
 
185
    ## TODO: Also optionally show a previous inventory
 
186
    ## TODO: Format options
 
187
    b = Branch('.')
 
188
    if revision == None:
 
189
        inv = b.read_working_inventory()
 
190
    else:
 
191
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
192
        
 
193
    for path, entry in inv.iter_entries():
 
194
        print '%-50s %s' % (entry.file_id, path)
 
195
 
 
196
 
 
197
 
 
198
# TODO: Maybe a 'mv' command that has the combined move/rename
 
199
# special behaviour of Unix?
 
200
 
 
201
def cmd_move(source_list, dest):
 
202
    b = Branch('.')
 
203
 
 
204
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
205
 
 
206
 
 
207
 
 
208
def cmd_rename(from_name, to_name):
 
209
    """Change the name of an entry.
 
210
 
 
211
    usage: bzr rename FROM_NAME TO_NAME
 
212
 
 
213
    examples:
 
214
      bzr rename frob.c frobber.c
 
215
      bzr rename src/frob.c lib/frob.c
 
216
 
 
217
    It is an error if the destination name exists.
 
218
 
 
219
    See also the 'move' command, which moves files into a different
 
220
    directory without changing their name.
 
221
 
 
222
    TODO: Some way to rename multiple files without invoking bzr for each
 
223
    one?"""
 
224
    b = Branch('.')
 
225
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
226
    
 
227
 
 
228
 
 
229
 
 
230
def cmd_renames(dir='.'):
 
231
    """Show list of renamed files.
 
232
 
 
233
    usage: bzr renames [BRANCH]
 
234
 
 
235
    TODO: Option to show renames between two historical versions.
 
236
 
 
237
    TODO: Only show renames under dir, rather than in the whole branch.
 
238
    """
 
239
    b = Branch(dir)
 
240
    old_inv = b.basis_tree().inventory
 
241
    new_inv = b.read_working_inventory()
 
242
    
 
243
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
244
    renames.sort()
 
245
    for old_name, new_name in renames:
 
246
        print "%s => %s" % (old_name, new_name)        
 
247
 
 
248
 
 
249
 
 
250
def cmd_info():
 
251
    """info: Show statistical information for this branch
 
252
 
 
253
    usage: bzr info"""
 
254
    import info
 
255
    info.show_info(Branch('.'))        
 
256
    
 
257
 
 
258
 
 
259
def cmd_remove(file_list, verbose=False):
 
260
    b = Branch(file_list[0])
 
261
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
262
 
 
263
 
 
264
 
 
265
def cmd_file_id(filename):
 
266
    """Print file_id of a particular file or directory.
 
267
 
 
268
    usage: bzr file-id FILE
 
269
 
 
270
    The file_id is assigned when the file is first added and remains the
 
271
    same through all revisions where the file exists, even when it is
 
272
    moved or renamed.
 
273
    """
 
274
    b = Branch(filename)
 
275
    i = b.inventory.path2id(b.relpath(filename))
 
276
    if i == None:
 
277
        bailout("%r is not a versioned file" % filename)
 
278
    else:
 
279
        print i
 
280
 
 
281
 
 
282
def cmd_file_id_path(filename):
 
283
    """Print path of file_ids to a file or directory.
 
284
 
 
285
    usage: bzr file-id-path FILE
 
286
 
 
287
    This prints one line for each directory down to the target,
 
288
    starting at the branch root."""
 
289
    b = Branch(filename)
 
290
    inv = b.inventory
 
291
    fid = inv.path2id(b.relpath(filename))
 
292
    if fid == None:
 
293
        bailout("%r is not a versioned file" % filename)
 
294
    for fip in inv.get_idpath(fid):
 
295
        print fip
 
296
 
 
297
 
 
298
def cmd_revision_history():
 
299
    for patchid in Branch('.').revision_history():
 
300
        print patchid
 
301
 
 
302
 
 
303
def cmd_directories():
 
304
    for name, ie in Branch('.').read_working_inventory().directories():
 
305
        if name == '':
 
306
            print '.'
 
307
        else:
 
308
            print name
 
309
 
 
310
 
 
311
def cmd_missing():
 
312
    for name, ie in Branch('.').working_tree().missing():
 
313
        print name
 
314
 
 
315
 
 
316
def cmd_init():
 
317
    # TODO: Check we're not already in a working directory?  At the
 
318
    # moment you'll get an ugly error.
 
319
    
 
320
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
321
    # to allow that, but then the parent may need to understand that
 
322
    # the children have disappeared, or should they be versioned in
 
323
    # both?
 
324
 
 
325
    # TODO: Take an argument/option for branch name.
 
326
    Branch('.', init=True)
 
327
 
 
328
 
 
329
def cmd_diff(revision=None, file_list=None):
 
330
    """bzr diff: Show differences in working tree.
 
331
    
 
332
    usage: bzr diff [-r REV] [FILE...]
 
333
 
 
334
    --revision REV
 
335
         Show changes since REV, rather than predecessor.
 
336
 
 
337
    If files are listed, only the changes in those files are listed.
 
338
    Otherwise, all changes for the tree are listed.
 
339
 
 
340
    TODO: Given two revision arguments, show the difference between them.
 
341
 
 
342
    TODO: Allow diff across branches.
 
343
 
 
344
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
345
          or a graphical diff.
 
346
 
 
347
    TODO: If a directory is given, diff everything under that.
 
348
 
 
349
    TODO: Selected-file diff is inefficient and doesn't show you deleted files.
 
350
"""
 
351
 
 
352
    ## TODO: Shouldn't be in the cmd function.
 
353
 
 
354
    b = Branch('.')
 
355
 
 
356
    if revision == None:
 
357
        old_tree = b.basis_tree()
 
358
    else:
 
359
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
360
        
 
361
    new_tree = b.working_tree()
 
362
 
 
363
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
364
    old_label = ''
 
365
    new_label = ''
 
366
 
 
367
    DEVNULL = '/dev/null'
 
368
    # Windows users, don't panic about this filename -- it is a
 
369
    # special signal to GNU patch that the file should be created or
 
370
    # deleted respectively.
 
371
 
 
372
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
373
    # be usefully made into a much faster special case.
 
374
 
 
375
    # TODO: Better to return them in sorted order I think.
 
376
 
 
377
    # FIXME: If given a file list, compare only those files rather
 
378
    # than comparing everything and then throwing stuff away.
 
379
    
 
380
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
381
 
 
382
        if file_list and new_name not in file_list:
 
383
            continue
 
384
        
 
385
        # Don't show this by default; maybe do it if an option is passed
 
386
        # idlabel = '      {%s}' % fid
 
387
        idlabel = ''
 
388
 
 
389
        # FIXME: Something about the diff format makes patch unhappy
 
390
        # with newly-added files.
 
391
 
 
392
        def diffit(oldlines, newlines, **kw):
 
393
            # FIXME: difflib is wrong if there is no trailing newline.
 
394
 
 
395
            # Special workaround for Python2.3, where difflib fails if
 
396
            # both sequences are empty.
 
397
            if oldlines or newlines:
 
398
                sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
 
399
            print
 
400
        
 
401
        if file_state in ['.', '?', 'I']:
 
402
            continue
 
403
        elif file_state == 'A':
 
404
            print '*** added %s %r' % (kind, new_name)
 
405
            if kind == 'file':
 
406
                diffit([],
 
407
                       new_tree.get_file(fid).readlines(),
 
408
                       fromfile=DEVNULL,
 
409
                       tofile=new_label + new_name + idlabel)
 
410
        elif file_state == 'D':
 
411
            assert isinstance(old_name, types.StringTypes)
 
412
            print '*** deleted %s %r' % (kind, old_name)
 
413
            if kind == 'file':
 
414
                diffit(old_tree.get_file(fid).readlines(), [],
 
415
                       fromfile=old_label + old_name + idlabel,
 
416
                       tofile=DEVNULL)
 
417
        elif file_state in ['M', 'R']:
 
418
            if file_state == 'M':
 
419
                assert kind == 'file'
 
420
                assert old_name == new_name
 
421
                print '*** modified %s %r' % (kind, new_name)
 
422
            elif file_state == 'R':
 
423
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
424
 
 
425
            if kind == 'file':
 
426
                diffit(old_tree.get_file(fid).readlines(),
 
427
                       new_tree.get_file(fid).readlines(),
 
428
                       fromfile=old_label + old_name + idlabel,
 
429
                       tofile=new_label + new_name)
 
430
        else:
 
431
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
432
 
 
433
 
 
434
 
 
435
def cmd_deleted(show_ids=False):
 
436
    """List files deleted in the working tree.
 
437
 
 
438
    TODO: Show files deleted since a previous revision, or between two revisions.
 
439
    """
 
440
    b = Branch('.')
 
441
    old = b.basis_tree()
 
442
    new = b.working_tree()
 
443
 
 
444
    ## TODO: Much more efficient way to do this: read in new
 
445
    ## directories with readdir, rather than stating each one.  Same
 
446
    ## level of effort but possibly much less IO.  (Or possibly not,
 
447
    ## if the directories are very large...)
 
448
 
 
449
    for path, ie in old.inventory.iter_entries():
 
450
        if not new.has_id(ie.file_id):
 
451
            if show_ids:
 
452
                print '%-50s %s' % (path, ie.file_id)
 
453
            else:
 
454
                print path
 
455
 
 
456
 
 
457
 
 
458
def cmd_parse_inventory():
 
459
    import cElementTree
 
460
    
 
461
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
462
 
 
463
 
 
464
 
 
465
def cmd_load_inventory():
 
466
    """Load inventory for timing purposes"""
 
467
    Branch('.').basis_tree().inventory
 
468
 
 
469
 
 
470
def cmd_dump_inventory():
 
471
    Branch('.').read_working_inventory().write_xml(sys.stdout)
 
472
 
 
473
 
 
474
def cmd_dump_new_inventory():
 
475
    import bzrlib.newinventory
 
476
    inv = Branch('.').basis_tree().inventory
 
477
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
478
 
 
479
 
 
480
def cmd_load_new_inventory():
 
481
    import bzrlib.newinventory
 
482
    bzrlib.newinventory.read_new_inventory(sys.stdin)
 
483
                
 
484
    
 
485
def cmd_dump_slacker_inventory():
 
486
    import bzrlib.newinventory
 
487
    inv = Branch('.').basis_tree().inventory
 
488
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
489
                
 
490
    
 
491
 
 
492
def cmd_root(filename=None):
 
493
    """Print the branch root."""
 
494
    print bzrlib.branch.find_branch_root(filename)
 
495
    
 
496
 
 
497
def cmd_log(timezone='original'):
 
498
    """Show log of this branch.
 
499
 
 
500
    :todo: Options for utc; to show ids; to limit range; etc.
 
501
    """
 
502
    Branch('.').write_log(show_timezone=timezone)
 
503
 
 
504
 
 
505
def cmd_ls(revision=None, verbose=False):
 
506
    """List files in a tree.
 
507
 
 
508
    :todo: Take a revision or remote path and list that tree instead.
 
509
    """
 
510
    b = Branch('.')
 
511
    if revision == None:
 
512
        tree = b.working_tree()
 
513
    else:
 
514
        tree = b.revision_tree(b.lookup_revision(revision))
 
515
        
 
516
    for fp, fc, kind, fid in tree.list_files():
 
517
        if verbose:
 
518
            if kind == 'directory':
 
519
                kindch = '/'
 
520
            elif kind == 'file':
 
521
                kindch = ''
 
522
            else:
 
523
                kindch = '???'
 
524
                
 
525
            print '%-8s %s%s' % (fc, fp, kindch)
 
526
        else:
 
527
            print fp
 
528
    
 
529
    
 
530
 
 
531
def cmd_unknowns():
 
532
    """List unknown files"""
 
533
    for f in Branch('.').unknowns():
 
534
        print quotefn(f)
 
535
 
 
536
 
 
537
 
 
538
def cmd_ignored():
 
539
    """List ignored files and the patterns that matched them.
 
540
      """
 
541
    tree = Branch('.').working_tree()
 
542
    for path, file_class, kind, file_id in tree.list_files():
 
543
        if file_class != 'I':
 
544
            continue
 
545
        ## XXX: Slightly inefficient since this was already calculated
 
546
        pat = tree.is_ignored(path)
 
547
        print '%-50s %s' % (path, pat)
 
548
 
 
549
 
 
550
def cmd_lookup_revision(revno):
 
551
    try:
 
552
        revno = int(revno)
 
553
    except ValueError:
 
554
        bailout("usage: lookup-revision REVNO",
 
555
                ["REVNO is a non-negative revision number for this branch"])
 
556
 
 
557
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
558
 
 
559
 
 
560
 
 
561
def cmd_export(revno, dest):
 
562
    """Export past revision to destination directory."""
 
563
    b = Branch('.')
 
564
    rh = b.lookup_revision(int(revno))
 
565
    t = b.revision_tree(rh)
 
566
    t.export(dest)
 
567
 
 
568
def cmd_cat(revision, filename):
 
569
    """Print file to stdout."""
 
570
    b = Branch('.')
 
571
    b.print_file(b.relpath(filename), int(revision))
 
572
 
 
573
 
 
574
######################################################################
 
575
# internal/test commands
 
576
 
 
577
 
 
578
def cmd_uuid():
 
579
    """Print a newly-generated UUID."""
 
580
    print bzrlib.osutils.uuid()
 
581
 
 
582
 
 
583
 
 
584
def cmd_local_time_offset():
 
585
    print bzrlib.osutils.local_time_offset()
 
586
 
 
587
 
 
588
 
 
589
def cmd_commit(message=None, verbose=False):
 
590
    """Commit changes to a new revision.
 
591
 
 
592
    --message MESSAGE
 
593
        Description of changes in this revision; free form text.
 
594
        It is recommended that the first line be a single-sentence
 
595
        summary.
 
596
    --verbose
 
597
        Show status of changed files,
 
598
 
 
599
    TODO: Commit only selected files.
 
600
 
 
601
    TODO: Run hooks on tree to-be-committed, and after commit.
 
602
 
 
603
    TODO: Strict commit that fails if there are unknown or deleted files.
 
604
    """
 
605
 
 
606
    if not message:
 
607
        bailout("please specify a commit message")
 
608
    Branch('.').commit(message, verbose=verbose)
 
609
 
 
610
 
 
611
def cmd_check(dir='.'):
 
612
    """check: Consistency check of branch history.
 
613
 
 
614
    usage: bzr check [-v] [BRANCH]
 
615
 
 
616
    options:
 
617
      --verbose, -v         Show progress of checking.
 
618
 
 
619
    This command checks various invariants about the branch storage to
 
620
    detect data corruption or bzr bugs.
 
621
    """
 
622
    import bzrlib.check
 
623
    bzrlib.check.check(Branch(dir, find_root=False))
 
624
 
 
625
 
 
626
def cmd_is(pred, *rest):
 
627
    """Test whether PREDICATE is true."""
 
628
    try:
 
629
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
630
    except KeyError:
 
631
        bailout("unknown predicate: %s" % quotefn(pred))
 
632
        
 
633
    try:
 
634
        cmd_handler(*rest)
 
635
    except BzrCheckError:
 
636
        # by default we don't print the message so that this can
 
637
        # be used from shell scripts without producing noise
 
638
        sys.exit(1)
 
639
 
 
640
 
 
641
def cmd_username():
 
642
    print bzrlib.osutils.username()
 
643
 
 
644
 
 
645
def cmd_user_email():
 
646
    print bzrlib.osutils.user_email()
 
647
 
 
648
 
 
649
def cmd_gen_revision_id():
 
650
    print bzrlib.branch._gen_revision_id(time.time())
 
651
 
 
652
 
 
653
def cmd_selftest():
 
654
    """Run internal test suite"""
 
655
    ## -v, if present, is seen by doctest; the argument is just here
 
656
    ## so our parser doesn't complain
 
657
 
 
658
    ## TODO: --verbose option
 
659
 
 
660
    failures, tests = 0, 0
 
661
    
 
662
    import doctest, bzrlib.store, bzrlib.tests
 
663
    bzrlib.trace.verbose = False
 
664
 
 
665
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
666
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
667
        mf, mt = doctest.testmod(m)
 
668
        failures += mf
 
669
        tests += mt
 
670
        print '%-40s %3d tests' % (m.__name__, mt),
 
671
        if mf:
 
672
            print '%3d FAILED!' % mf
 
673
        else:
 
674
            print
 
675
 
 
676
    print '%-40s %3d tests' % ('total', tests),
 
677
    if failures:
 
678
        print '%3d FAILED!' % failures
 
679
    else:
 
680
        print
 
681
 
 
682
 
 
683
 
 
684
# deprecated
 
685
cmd_doctest = cmd_selftest
 
686
 
 
687
 
 
688
######################################################################
 
689
# help
 
690
 
 
691
 
 
692
def cmd_help(topic=None):
 
693
    if topic == None:
 
694
        print __doc__
 
695
        return
 
696
 
 
697
    # otherwise, maybe the name of a command?
 
698
    try:
 
699
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
 
700
    except KeyError:
 
701
        bailout("no help for %r" % topic)
 
702
 
 
703
    doc = getdoc(cmdfn)
 
704
    if doc == None:
 
705
        bailout("sorry, no detailed help yet for %r" % topic)
 
706
 
 
707
    print doc
 
708
        
 
709
 
 
710
 
 
711
 
 
712
def cmd_version():
 
713
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
714
    print bzrlib.__copyright__
 
715
    print "http://bazaar-ng.org/"
 
716
    print
 
717
    print \
 
718
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
719
you may use, modify and redistribute it under the terms of the GNU 
 
720
General Public License version 2 or later."""
 
721
 
 
722
 
 
723
def cmd_rocks():
 
724
    """Statement of optimism."""
 
725
    print "it sure does!"
 
726
 
 
727
 
 
728
 
 
729
######################################################################
 
730
# main routine
 
731
 
 
732
 
 
733
# list of all available options; the rhs can be either None for an
 
734
# option that takes no argument, or a constructor function that checks
 
735
# the type.
 
736
OPTIONS = {
 
737
    'all':                    None,
 
738
    'help':                   None,
 
739
    'message':                unicode,
 
740
    'profile':                None,
 
741
    'revision':               int,
 
742
    'show-ids':               None,
 
743
    'timezone':               str,
 
744
    'verbose':                None,
 
745
    'version':                None,
 
746
    }
 
747
 
 
748
SHORT_OPTIONS = {
 
749
    'm':                      'message',
 
750
    'r':                      'revision',
 
751
    'v':                      'verbose',
 
752
}
 
753
 
 
754
# List of options that apply to particular commands; commands not
 
755
# listed take none.
 
756
cmd_options = {
 
757
    'add':                    ['verbose'],
 
758
    'cat':                    ['revision'],
 
759
    'commit':                 ['message', 'verbose'],
 
760
    'deleted':                ['show-ids'],
 
761
    'diff':                   ['revision'],
 
762
    'inventory':              ['revision'],
 
763
    'log':                    ['timezone'],
 
764
    'ls':                     ['revision', 'verbose'],
 
765
    'remove':                 ['verbose'],
 
766
    'status':                 ['all'],
 
767
    }
 
768
 
 
769
 
 
770
cmd_args = {
 
771
    'add':                    ['file+'],
 
772
    'cat':                    ['filename'],
 
773
    'commit':                 [],
 
774
    'diff':                   ['file*'],
 
775
    'export':                 ['revno', 'dest'],
 
776
    'file-id':                ['filename'],
 
777
    'file-id-path':           ['filename'],
 
778
    'get-file-text':          ['text_id'],
 
779
    'get-inventory':          ['inventory_id'],
 
780
    'get-revision':           ['revision_id'],
 
781
    'get-revision-inventory': ['revision_id'],
 
782
    'help':                   ['topic?'],
 
783
    'init':                   [],
 
784
    'log':                    [],
 
785
    'lookup-revision':        ['revno'],
 
786
    'move':                   ['source$', 'dest'],
 
787
    'relpath':                ['filename'],
 
788
    'remove':                 ['file+'],
 
789
    'rename':                 ['from_name', 'to_name'],
 
790
    'renames':                ['dir?'],
 
791
    'root':                   ['filename?'],
 
792
    'status':                 [],
 
793
    }
 
794
 
 
795
 
 
796
def parse_args(argv):
 
797
    """Parse command line.
 
798
    
 
799
    Arguments and options are parsed at this level before being passed
 
800
    down to specific command handlers.  This routine knows, from a
 
801
    lookup table, something about the available options, what optargs
 
802
    they take, and which commands will accept them.
 
803
 
 
804
    >>> parse_args('--help'.split())
 
805
    ([], {'help': True})
 
806
    >>> parse_args('--version'.split())
 
807
    ([], {'version': True})
 
808
    >>> parse_args('status --all'.split())
 
809
    (['status'], {'all': True})
 
810
    >>> parse_args('commit --message=biter'.split())
 
811
    (['commit'], {'message': u'biter'})
 
812
    """
 
813
    args = []
 
814
    opts = {}
 
815
 
 
816
    # TODO: Maybe handle '--' to end options?
 
817
 
 
818
    while argv:
 
819
        a = argv.pop(0)
 
820
        if a[0] == '-':
 
821
            optarg = None
 
822
            if a[1] == '-':
 
823
                mutter("  got option %r" % a)
 
824
                if '=' in a:
 
825
                    optname, optarg = a[2:].split('=', 1)
 
826
                else:
 
827
                    optname = a[2:]
 
828
                if optname not in OPTIONS:
 
829
                    bailout('unknown long option %r' % a)
 
830
            else:
 
831
                shortopt = a[1:]
 
832
                if shortopt not in SHORT_OPTIONS:
 
833
                    bailout('unknown short option %r' % a)
 
834
                optname = SHORT_OPTIONS[shortopt]
 
835
            
 
836
            if optname in opts:
 
837
                # XXX: Do we ever want to support this, e.g. for -r?
 
838
                bailout('repeated option %r' % a)
 
839
                
 
840
            optargfn = OPTIONS[optname]
 
841
            if optargfn:
 
842
                if optarg == None:
 
843
                    if not argv:
 
844
                        bailout('option %r needs an argument' % a)
 
845
                    else:
 
846
                        optarg = argv.pop(0)
 
847
                opts[optname] = optargfn(optarg)
 
848
            else:
 
849
                if optarg != None:
 
850
                    bailout('option %r takes no argument' % optname)
 
851
                opts[optname] = True
 
852
        else:
 
853
            args.append(a)
 
854
 
 
855
    return args, opts
 
856
 
 
857
 
 
858
 
 
859
def _match_args(cmd, args):
 
860
    """Check non-option arguments match required pattern.
 
861
 
 
862
    >>> _match_args('status', ['asdasdsadasd'])
 
863
    Traceback (most recent call last):
 
864
    ...
 
865
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
866
    >>> _match_args('add', ['asdasdsadasd'])
 
867
    {'file_list': ['asdasdsadasd']}
 
868
    >>> _match_args('add', 'abc def gj'.split())
 
869
    {'file_list': ['abc', 'def', 'gj']}
 
870
    """
 
871
    # match argument pattern
 
872
    argform = cmd_args.get(cmd, [])
 
873
    argdict = {}
 
874
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
875
    # all but one.
 
876
 
 
877
    # step through args and argform, allowing appropriate 0-many matches
 
878
    for ap in argform:
 
879
        argname = ap[:-1]
 
880
        if ap[-1] == '?':
 
881
            if args:
 
882
                argdict[argname] = args.pop(0)
 
883
        elif ap[-1] == '*': # all remaining arguments
 
884
            if args:
 
885
                argdict[argname + '_list'] = args[:]
 
886
                args = []
 
887
            else:
 
888
                argdict[argname + '_list'] = None
 
889
        elif ap[-1] == '+':
 
890
            if not args:
 
891
                bailout("command %r needs one or more %s"
 
892
                        % (cmd, argname.upper()))
 
893
            else:
 
894
                argdict[argname + '_list'] = args[:]
 
895
                args = []
 
896
        elif ap[-1] == '$': # all but one
 
897
            if len(args) < 2:
 
898
                bailout("command %r needs one or more %s"
 
899
                        % (cmd, argname.upper()))
 
900
            argdict[argname + '_list'] = args[:-1]
 
901
            args[:-1] = []                
 
902
        else:
 
903
            # just a plain arg
 
904
            argname = ap
 
905
            if not args:
 
906
                bailout("command %r requires argument %s"
 
907
                        % (cmd, argname.upper()))
 
908
            else:
 
909
                argdict[argname] = args.pop(0)
 
910
            
 
911
    if args:
 
912
        bailout("extra arguments to command %s: %r"
 
913
                % (cmd, args))
 
914
 
 
915
    return argdict
 
916
 
 
917
 
 
918
 
 
919
def run_bzr(argv):
 
920
    """Execute a command.
 
921
 
 
922
    This is similar to main(), but without all the trappings for
 
923
    logging and error handling.
 
924
    """
 
925
    try:
 
926
        args, opts = parse_args(argv[1:])
 
927
        if 'help' in opts:
 
928
            # TODO: pass down other arguments in case they asked for
 
929
            # help on a command name?
 
930
            if args:
 
931
                cmd_help(args[0])
 
932
            else:
 
933
                cmd_help()
 
934
            return 0
 
935
        elif 'version' in opts:
 
936
            cmd_version()
 
937
            return 0
 
938
        cmd = args.pop(0)
 
939
    except IndexError:
 
940
        log_error('usage: bzr COMMAND\n')
 
941
        log_error('  try "bzr help"\n')
 
942
        return 1
 
943
 
 
944
    try:
 
945
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
946
    except KeyError:
 
947
        bailout("unknown command " + `cmd`)
 
948
 
 
949
    # global option
 
950
    if 'profile' in opts:
 
951
        profile = True
 
952
        del opts['profile']
 
953
    else:
 
954
        profile = False
 
955
 
 
956
    # check options are reasonable
 
957
    allowed = cmd_options.get(cmd, [])
 
958
    for oname in opts:
 
959
        if oname not in allowed:
 
960
            bailout("option %r is not allowed for command %r"
 
961
                    % (oname, cmd))
 
962
 
 
963
    # TODO: give an error if there are any mandatory options which are
 
964
    # not specified?  Or maybe there shouldn't be any "mandatory
 
965
    # options" (it is an oxymoron)
 
966
 
 
967
    # mix arguments and options into one dictionary
 
968
    cmdargs = _match_args(cmd, args)
 
969
    for k, v in opts.items():
 
970
        cmdargs[k.replace('-', '_')] = v
 
971
 
 
972
    if profile:
 
973
        import hotshot
 
974
        prof = hotshot.Profile('.bzr.profile')
 
975
        ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
976
        prof.close()
 
977
 
 
978
        import hotshot.stats
 
979
        stats = hotshot.stats.load('.bzr.profile')
 
980
        #stats.strip_dirs()
 
981
        stats.sort_stats('time')
 
982
        stats.print_stats(20)
 
983
 
 
984
        return ret
 
985
    else:
 
986
        return cmd_handler(**cmdargs) or 0
 
987
 
 
988
 
 
989
 
 
990
def main(argv):
 
991
    ## TODO: Handle command-line options; probably know what options are valid for
 
992
    ## each command
 
993
 
 
994
    ## TODO: If the arguments are wrong, give a usage message rather
 
995
    ## than just a backtrace.
 
996
 
 
997
    bzrlib.trace.create_tracefile(argv)
 
998
    
 
999
    try:
 
1000
        ret = run_bzr(argv)
 
1001
        return ret
 
1002
    except BzrError, e:
 
1003
        log_error('bzr: error: ' + e.args[0] + '\n')
 
1004
        if len(e.args) > 1:
 
1005
            for h in e.args[1]:
 
1006
                log_error('  ' + h + '\n')
 
1007
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
1008
        log_error('(see $HOME/.bzr.log for debug information)\n')
 
1009
        return 1
 
1010
    except Exception, e:
 
1011
        log_error('bzr: exception: %s\n' % e)
 
1012
        log_error('(see $HOME/.bzr.log for debug information)\n')
 
1013
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
1014
        ## traceback.print_exc(None, sys.stderr)
 
1015
        return 1
 
1016
 
 
1017
    # TODO: Maybe nicer handling of IOError?
 
1018
 
 
1019
 
 
1020
 
 
1021
if __name__ == '__main__':
 
1022
    sys.exit(main(sys.argv))
 
1023
    ##import profile
 
1024
    ##profile.run('main(sys.argv)')
 
1025