/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:58:58 UTC
  • Revision ID: mbp@sourcefrog.net-20050411015857-f781b0d325632cf5cacd2481
- more output from test.sh
- write revison-history in a way that is hardlink-safe

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