~bzr-pqm/bzr/bzr.dev

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