/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

ImproveĀ docstrings.

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