« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1185.65.19
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.65.19
- Committer: Robert Collins
- Date: 2006-01-05 00:16:01 UTC
- mfrom: (1185.69.2 bzr-storage)
- mto: (1185.65.25 storage) (1534.1.15 integration)
- mto: This revision was merged to the branch mainline in revision 1550.
- Revision ID: robertc@robertcollins.net-20060105001601-41706f37af6ae182
Merge from jam-storage.
- files added:
- BRANCH.TODO
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files removed:
- bzrlib/mdiff.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/newinventory.py => contrib/newinventory.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
1
# Copyright (C) 2004, 2005 by Canonical Ltd
4
2
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
16
19
"""Bazaar-NG -- a free distributed version-control tool
20
http://bazaar-ng.org/
21
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
24
* Metadata format is not stable yet -- you may need to
25
discard history in the future.
26
27
* Many commands unimplemented or partially implemented.
28
29
* Space-inefficient storage.
30
31
* No merge operators yet.
32
33
Interesting commands:
34
35
bzr help [COMMAND]
36
Show help screen
37
bzr version
38
Show software version/licence/non-warranty.
39
bzr init
40
Start versioning the current directory
41
bzr add FILE...
42
Make files versioned.
43
bzr log
44
Show revision history.
45
bzr rename FROM TO
46
Rename one file.
47
bzr move FROM... DESTDIR
48
Move one or more files to a different directory.
49
bzr diff [FILE...]
50
Show changes from last revision to working copy.
51
bzr commit -m 'MESSAGE'
52
Store current state as new revision.
53
bzr export REVNO DESTINATION
54
Export the branch state at a previous version.
55
bzr status
56
Show summary of pending changes.
57
bzr remove FILE...
58
Make a file not versioned.
59
bzr info
60
Show statistics about this branch.
61
bzr check
62
Verify history is stored safely.
63
(for more type 'bzr help commands')
64
"""
65
66
67
68
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
70
from sets import Set
71
from pprint import pprint
72
from stat import *
73
from glob import glob
17
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
20
21
# TODO: Help messages for options.
22
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
26
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
29
30
import sys
31
import os
32
from warnings import warn
74
33
from inspect import getdoc
34
import errno
75
35
76
36
import bzrlib
77
from bzrlib.store import ImmutableStore
78
from bzrlib.trace import mutter, note, log_error
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
from bzrlib.revision import Revision
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
84
format_date
85
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
88
89
## standard representation
90
NONE_STRING = '(none)'
91
EMPTY = 'empty'
92
93
94
## TODO: Perhaps a different version of inventory commands that
95
## returns iterators...
96
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
98
99
## TODO: Some kind of locking on branches. Perhaps there should be a
100
## parameter to the branch object saying whether we want a read or
101
## write lock; release it from destructor. Perhaps don't even need a
102
## read lock to look at immutable objects?
103
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
## to compare output?
106
107
## TODO: Some kind of global code to generate the right Branch object
108
## to work on. Almost, but not quite all, commands need one, and it
109
## can be taken either from their parameters or their working
110
## directory.
111
112
113
114
cmd_aliases = {
115
'?': 'help',
116
'ci': 'commit',
117
'checkin': 'commit',
118
'di': 'diff',
119
'st': 'status',
120
'stat': 'status',
121
}
122
123
124
def get_cmd_handler(cmd):
125
cmd = str(cmd)
126
127
cmd = cmd_aliases.get(cmd, cmd)
128
129
try:
130
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
131
except KeyError:
132
raise BzrError("unknown command %r" % cmd)
133
134
return cmd, cmd_handler
135
136
137
138
def cmd_status(all=False):
139
"""Display status summary.
140
141
For each file there is a single line giving its file state and name.
142
The name is that in the current revision unless it is deleted or
143
missing, in which case the old name is shown.
144
"""
145
#import bzrlib.status
146
#bzrlib.status.tree_status(Branch('.'))
147
Branch('.').show_status(show_all=all)
148
149
150
151
######################################################################
152
# examining history
153
def cmd_get_revision(revision_id):
154
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
155
156
157
def cmd_get_file_text(text_id):
158
"""Get contents of a file by hash."""
159
sf = Branch('.').text_store[text_id]
160
pumpfile(sf, sys.stdout)
161
162
163
164
######################################################################
165
# commands
166
167
168
def cmd_revno():
169
"""Show number of revisions on this branch"""
170
print Branch('.').revno()
171
172
173
174
def cmd_add(file_list, verbose=False):
175
"""Add specified files or directories.
176
177
In non-recursive mode, all the named items are added, regardless
178
of whether they were previously ignored. A warning is given if
179
any of the named files are already versioned.
180
181
In recursive mode (the default), files are treated the same way
182
but the behaviour for directories is different. Directories that
183
are already versioned do not give a warning. All directories,
184
whether already versioned or not, are searched for files or
185
subdirectories that are neither versioned or ignored, and these
186
are added. This search proceeds recursively into versioned
187
directories.
188
189
Therefore simply saying 'bzr add .' will version all files that
190
are currently unknown.
191
192
TODO: Perhaps adding a file whose directly is not versioned should
193
recursively add that parent, rather than giving an error?
194
"""
195
bzrlib.add.smart_add(file_list, verbose)
196
197
198
def cmd_relpath(filename):
199
"""Show path of file relative to root"""
200
print Branch(filename).relpath(filename)
201
202
203
204
def cmd_inventory(revision=None):
205
"""Show inventory of the current working copy."""
206
## TODO: Also optionally show a previous inventory
207
## TODO: Format options
208
b = Branch('.')
209
if revision == None:
210
inv = b.read_working_inventory()
211
else:
212
inv = b.get_revision_inventory(b.lookup_revision(revision))
213
214
for path, entry in inv.iter_entries():
215
print '%-50s %s' % (entry.file_id, path)
216
217
218
219
# TODO: Maybe a 'mv' command that has the combined move/rename
220
# special behaviour of Unix?
221
222
def cmd_move(source_list, dest):
223
b = Branch('.')
224
225
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
226
227
228
229
def cmd_rename(from_name, to_name):
230
"""Change the name of an entry.
231
232
usage: bzr rename FROM_NAME TO_NAME
233
234
examples:
235
bzr rename frob.c frobber.c
236
bzr rename src/frob.c lib/frob.c
237
238
It is an error if the destination name exists.
239
240
See also the 'move' command, which moves files into a different
241
directory without changing their name.
242
243
TODO: Some way to rename multiple files without invoking bzr for each
244
one?"""
245
b = Branch('.')
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
247
248
249
250
251
def cmd_renames(dir='.'):
252
"""Show list of renamed files.
253
254
usage: bzr renames [BRANCH]
255
256
TODO: Option to show renames between two historical versions.
257
258
TODO: Only show renames under dir, rather than in the whole branch.
259
"""
260
b = Branch(dir)
261
old_inv = b.basis_tree().inventory
262
new_inv = b.read_working_inventory()
263
264
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
265
renames.sort()
266
for old_name, new_name in renames:
267
print "%s => %s" % (old_name, new_name)
268
269
270
271
def cmd_info():
272
"""info: Show statistical information for this branch
273
274
usage: bzr info"""
275
import info
276
info.show_info(Branch('.'))
277
278
279
280
def cmd_remove(file_list, verbose=False):
281
b = Branch(file_list[0])
282
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
283
284
285
286
def cmd_file_id(filename):
287
"""Print file_id of a particular file or directory.
288
289
usage: bzr file-id FILE
290
291
The file_id is assigned when the file is first added and remains the
292
same through all revisions where the file exists, even when it is
293
moved or renamed.
294
"""
295
b = Branch(filename)
296
i = b.inventory.path2id(b.relpath(filename))
297
if i == None:
298
bailout("%r is not a versioned file" % filename)
299
else:
300
print i
301
302
303
def cmd_file_id_path(filename):
304
"""Print path of file_ids to a file or directory.
305
306
usage: bzr file-id-path FILE
307
308
This prints one line for each directory down to the target,
309
starting at the branch root."""
310
b = Branch(filename)
311
inv = b.inventory
312
fid = inv.path2id(b.relpath(filename))
313
if fid == None:
314
bailout("%r is not a versioned file" % filename)
315
for fip in inv.get_idpath(fid):
316
print fip
317
318
319
def cmd_revision_history():
320
for patchid in Branch('.').revision_history():
321
print patchid
322
323
324
def cmd_directories():
325
for name, ie in Branch('.').read_working_inventory().directories():
326
if name == '':
327
print '.'
328
else:
329
print name
330
331
332
def cmd_missing():
333
for name, ie in Branch('.').working_tree().missing():
334
print name
335
336
337
def cmd_init():
338
# TODO: Check we're not already in a working directory? At the
339
# moment you'll get an ugly error.
340
341
# TODO: What if we're in a subdirectory of a branch? Would like
342
# to allow that, but then the parent may need to understand that
343
# the children have disappeared, or should they be versioned in
344
# both?
345
346
# TODO: Take an argument/option for branch name.
347
Branch('.', init=True)
348
349
350
def cmd_diff(revision=None, file_list=None):
351
"""bzr diff: Show differences in working tree.
352
353
usage: bzr diff [-r REV] [FILE...]
354
355
--revision REV
356
Show changes since REV, rather than predecessor.
357
358
If files are listed, only the changes in those files are listed.
359
Otherwise, all changes for the tree are listed.
360
361
TODO: Given two revision arguments, show the difference between them.
362
363
TODO: Allow diff across branches.
364
365
TODO: Option to use external diff command; could be GNU diff, wdiff,
366
or a graphical diff.
367
368
TODO: Python difflib is not exactly the same as unidiff; should
369
either fix it up or prefer to use an external diff.
370
371
TODO: If a directory is given, diff everything under that.
372
373
TODO: Selected-file diff is inefficient and doesn't show you
374
deleted files.
375
376
TODO: This probably handles non-Unix newlines poorly.
377
"""
378
379
## TODO: Shouldn't be in the cmd function.
380
381
b = Branch('.')
382
383
if revision == None:
384
old_tree = b.basis_tree()
385
else:
386
old_tree = b.revision_tree(b.lookup_revision(revision))
387
388
new_tree = b.working_tree()
389
390
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
391
old_label = ''
392
new_label = ''
393
394
DEVNULL = '/dev/null'
395
# Windows users, don't panic about this filename -- it is a
396
# special signal to GNU patch that the file should be created or
397
# deleted respectively.
398
399
# TODO: Generation of pseudo-diffs for added/deleted files could
400
# be usefully made into a much faster special case.
401
402
# TODO: Better to return them in sorted order I think.
403
404
if file_list:
405
file_list = [b.relpath(f) for f in file_list]
406
407
# FIXME: If given a file list, compare only those files rather
408
# than comparing everything and then throwing stuff away.
409
410
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
411
412
if file_list and (new_name not in file_list):
413
continue
414
415
# Don't show this by default; maybe do it if an option is passed
416
# idlabel = ' {%s}' % fid
417
idlabel = ''
418
419
# FIXME: Something about the diff format makes patch unhappy
420
# with newly-added files.
421
422
def diffit(oldlines, newlines, **kw):
423
424
# FIXME: difflib is wrong if there is no trailing newline.
425
# The syntax used by patch seems to be "\ No newline at
426
# end of file" following the last diff line from that
427
# file. This is not trivial to insert into the
428
# unified_diff output and it might be better to just fix
429
# or replace that function.
430
431
# In the meantime we at least make sure the patch isn't
432
# mangled.
433
434
435
# Special workaround for Python2.3, where difflib fails if
436
# both sequences are empty.
437
if not oldlines and not newlines:
438
return
439
440
nonl = False
441
442
if oldlines and (oldlines[-1][-1] != '\n'):
443
oldlines[-1] += '\n'
444
nonl = True
445
if newlines and (newlines[-1][-1] != '\n'):
446
newlines[-1] += '\n'
447
nonl = True
448
449
ud = difflib.unified_diff(oldlines, newlines, **kw)
450
sys.stdout.writelines(ud)
451
if nonl:
452
print "\\ No newline at end of file"
453
sys.stdout.write('\n')
454
455
if file_state in ['.', '?', 'I']:
456
continue
457
elif file_state == 'A':
458
print '*** added %s %r' % (kind, new_name)
459
if kind == 'file':
460
diffit([],
461
new_tree.get_file(fid).readlines(),
462
fromfile=DEVNULL,
463
tofile=new_label + new_name + idlabel)
464
elif file_state == 'D':
465
assert isinstance(old_name, types.StringTypes)
466
print '*** deleted %s %r' % (kind, old_name)
467
if kind == 'file':
468
diffit(old_tree.get_file(fid).readlines(), [],
469
fromfile=old_label + old_name + idlabel,
470
tofile=DEVNULL)
471
elif file_state in ['M', 'R']:
472
if file_state == 'M':
473
assert kind == 'file'
474
assert old_name == new_name
475
print '*** modified %s %r' % (kind, new_name)
476
elif file_state == 'R':
477
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
478
479
if kind == 'file':
480
diffit(old_tree.get_file(fid).readlines(),
481
new_tree.get_file(fid).readlines(),
482
fromfile=old_label + old_name + idlabel,
483
tofile=new_label + new_name)
484
else:
485
bailout("can't represent state %s {%s}" % (file_state, fid))
486
487
488
489
def cmd_deleted(show_ids=False):
490
"""List files deleted in the working tree.
491
492
TODO: Show files deleted since a previous revision, or between two revisions.
493
"""
494
b = Branch('.')
495
old = b.basis_tree()
496
new = b.working_tree()
497
498
## TODO: Much more efficient way to do this: read in new
499
## directories with readdir, rather than stating each one. Same
500
## level of effort but possibly much less IO. (Or possibly not,
501
## if the directories are very large...)
502
503
for path, ie in old.inventory.iter_entries():
504
if not new.has_id(ie.file_id):
505
if show_ids:
506
print '%-50s %s' % (path, ie.file_id)
507
else:
508
print path
509
510
511
512
def cmd_parse_inventory():
513
import cElementTree
514
515
cElementTree.ElementTree().parse(file('.bzr/inventory'))
516
517
518
519
def cmd_load_inventory():
520
"""Load inventory for timing purposes"""
521
Branch('.').basis_tree().inventory
522
523
524
def cmd_dump_inventory():
525
Branch('.').read_working_inventory().write_xml(sys.stdout)
526
527
528
def cmd_dump_new_inventory():
529
import bzrlib.newinventory
530
inv = Branch('.').basis_tree().inventory
531
bzrlib.newinventory.write_inventory(inv, sys.stdout)
532
533
534
def cmd_load_new_inventory():
535
import bzrlib.newinventory
536
bzrlib.newinventory.read_new_inventory(sys.stdin)
537
538
539
def cmd_dump_slacker_inventory():
540
import bzrlib.newinventory
541
inv = Branch('.').basis_tree().inventory
542
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
543
544
545
546
def cmd_dump_text_inventory():
547
import bzrlib.textinv
548
inv = Branch('.').basis_tree().inventory
549
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
550
551
552
def cmd_load_text_inventory():
553
import bzrlib.textinv
554
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
555
print 'loaded %d entries' % len(inv)
556
557
558
559
def cmd_root(filename=None):
560
"""Print the branch root."""
561
print bzrlib.branch.find_branch_root(filename)
562
563
564
def cmd_log(timezone='original', verbose=False):
565
"""Show log of this branch.
566
567
TODO: Options for utc; to show ids; to limit range; etc.
568
"""
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
570
571
572
def cmd_ls(revision=None, verbose=False):
573
"""List files in a tree.
574
575
TODO: Take a revision or remote path and list that tree instead.
576
"""
577
b = Branch('.')
578
if revision == None:
579
tree = b.working_tree()
580
else:
581
tree = b.revision_tree(b.lookup_revision(revision))
582
583
for fp, fc, kind, fid in tree.list_files():
584
if verbose:
585
if kind == 'directory':
586
kindch = '/'
587
elif kind == 'file':
588
kindch = ''
589
else:
590
kindch = '???'
591
592
print '%-8s %s%s' % (fc, fp, kindch)
593
else:
594
print fp
595
596
597
598
def cmd_unknowns():
599
"""List unknown files"""
600
for f in Branch('.').unknowns():
601
print quotefn(f)
602
603
604
605
def cmd_ignored():
606
"""List ignored files and the patterns that matched them.
607
"""
608
tree = Branch('.').working_tree()
609
for path, file_class, kind, file_id in tree.list_files():
610
if file_class != 'I':
611
continue
612
## XXX: Slightly inefficient since this was already calculated
613
pat = tree.is_ignored(path)
614
print '%-50s %s' % (path, pat)
615
616
617
def cmd_lookup_revision(revno):
618
try:
619
revno = int(revno)
620
except ValueError:
621
bailout("usage: lookup-revision REVNO",
622
["REVNO is a non-negative revision number for this branch"])
623
624
print Branch('.').lookup_revision(revno) or NONE_STRING
625
626
627
628
def cmd_export(revno, dest):
629
"""Export past revision to destination directory."""
630
b = Branch('.')
631
rh = b.lookup_revision(int(revno))
632
t = b.revision_tree(rh)
633
t.export(dest)
634
635
def cmd_cat(revision, filename):
636
"""Print file to stdout."""
637
b = Branch('.')
638
b.print_file(b.relpath(filename), int(revision))
639
640
641
######################################################################
642
# internal/test commands
643
644
645
def cmd_uuid():
646
"""Print a newly-generated UUID."""
647
print bzrlib.osutils.uuid()
648
649
650
651
def cmd_local_time_offset():
652
print bzrlib.osutils.local_time_offset()
653
654
655
656
def cmd_commit(message=None, verbose=False):
657
"""Commit changes to a new revision.
658
659
--message MESSAGE
660
Description of changes in this revision; free form text.
661
It is recommended that the first line be a single-sentence
662
summary.
663
--verbose
664
Show status of changed files,
665
666
TODO: Commit only selected files.
667
668
TODO: Run hooks on tree to-be-committed, and after commit.
669
670
TODO: Strict commit that fails if there are unknown or deleted files.
671
"""
672
673
if not message:
674
bailout("please specify a commit message")
675
Branch('.').commit(message, verbose=verbose)
676
677
678
def cmd_check(dir='.'):
679
"""check: Consistency check of branch history.
680
681
usage: bzr check [-v] [BRANCH]
682
683
options:
684
--verbose, -v Show progress of checking.
685
686
This command checks various invariants about the branch storage to
687
detect data corruption or bzr bugs.
688
"""
689
import bzrlib.check
690
bzrlib.check.check(Branch(dir, find_root=False))
691
692
693
def cmd_is(pred, *rest):
694
"""Test whether PREDICATE is true."""
695
try:
696
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
697
except KeyError:
698
bailout("unknown predicate: %s" % quotefn(pred))
699
700
try:
701
cmd_handler(*rest)
702
except BzrCheckError:
703
# by default we don't print the message so that this can
704
# be used from shell scripts without producing noise
705
sys.exit(1)
706
707
708
def cmd_whoami(email=False):
709
"""Show bzr user id.
710
711
usage: bzr whoami
712
713
options:
714
--email Show only the email address.
715
716
"""
717
if email:
718
print bzrlib.osutils.user_email()
719
else:
720
print bzrlib.osutils.username()
721
722
723
def cmd_gen_revision_id():
724
print bzrlib.branch._gen_revision_id(time.time())
725
726
727
def cmd_selftest():
728
"""Run internal test suite"""
729
## -v, if present, is seen by doctest; the argument is just here
730
## so our parser doesn't complain
731
732
## TODO: --verbose option
733
734
failures, tests = 0, 0
735
736
import doctest, bzrlib.store, bzrlib.tests
737
bzrlib.trace.verbose = False
738
739
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
740
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
741
mf, mt = doctest.testmod(m)
742
failures += mf
743
tests += mt
744
print '%-40s %3d tests' % (m.__name__, mt),
745
if mf:
746
print '%3d FAILED!' % mf
747
else:
748
print
749
750
print '%-40s %3d tests' % ('total', tests),
751
if failures:
752
print '%3d FAILED!' % failures
753
else:
754
print
755
756
757
758
# deprecated
759
cmd_doctest = cmd_selftest
760
761
762
######################################################################
763
# help
764
765
766
def cmd_help(topic=None):
767
if topic == None:
768
print __doc__
769
elif topic == 'commands':
770
help_commands()
771
else:
772
# otherwise, maybe the name of a command?
773
topic, cmdfn = get_cmd_handler(topic)
774
775
doc = getdoc(cmdfn)
776
if doc == None:
777
bailout("sorry, no detailed help yet for %r" % topic)
778
779
print doc
780
781
782
def help_commands():
783
"""List all commands"""
784
accu = []
785
for k in globals().keys():
786
if k.startswith('cmd_'):
787
accu.append(k[4:].replace('_','-'))
788
accu.sort()
789
print "bzr commands: "
790
for x in accu:
791
print " " + x
792
print "note: some of these commands are internal-use or obsolete"
793
# TODO: Some kind of marker for internal-use commands?
794
# TODO: Show aliases?
795
796
797
798
799
def cmd_version():
800
print "bzr (bazaar-ng) %s" % bzrlib.__version__
801
print bzrlib.__copyright__
802
print "http://bazaar-ng.org/"
803
print
804
print \
805
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
806
you may use, modify and redistribute it under the terms of the GNU
807
General Public License version 2 or later."""
808
809
810
def cmd_rocks():
811
"""Statement of optimism."""
812
print "it sure does!"
813
814
815
816
######################################################################
817
# main routine
818
819
820
# list of all available options; the rhs can be either None for an
821
# option that takes no argument, or a constructor function that checks
822
# the type.
823
OPTIONS = {
824
'all': None,
825
'help': None,
826
'message': unicode,
827
'profile': None,
828
'revision': int,
829
'show-ids': None,
830
'timezone': str,
831
'verbose': None,
832
'version': None,
833
'email': None,
834
}
835
836
SHORT_OPTIONS = {
837
'm': 'message',
838
'r': 'revision',
839
'v': 'verbose',
840
}
841
842
# List of options that apply to particular commands; commands not
843
# listed take none.
844
cmd_options = {
845
'add': ['verbose'],
846
'cat': ['revision'],
847
'commit': ['message', 'verbose'],
848
'deleted': ['show-ids'],
849
'diff': ['revision'],
850
'inventory': ['revision'],
851
'log': ['timezone', 'verbose'],
852
'ls': ['revision', 'verbose'],
853
'remove': ['verbose'],
854
'status': ['all'],
855
'whoami': ['email'],
856
}
857
858
859
cmd_args = {
860
'add': ['file+'],
861
'cat': ['filename'],
862
'commit': [],
863
'diff': ['file*'],
864
'export': ['revno', 'dest'],
865
'file-id': ['filename'],
866
'file-id-path': ['filename'],
867
'get-file-text': ['text_id'],
868
'get-inventory': ['inventory_id'],
869
'get-revision': ['revision_id'],
870
'get-revision-inventory': ['revision_id'],
871
'help': ['topic?'],
872
'init': [],
873
'log': [],
874
'lookup-revision': ['revno'],
875
'move': ['source$', 'dest'],
876
'relpath': ['filename'],
877
'remove': ['file+'],
878
'rename': ['from_name', 'to_name'],
879
'renames': ['dir?'],
880
'root': ['filename?'],
881
'status': [],
882
}
883
884
885
def parse_args(argv):
37
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
40
BzrCheckError,
41
BzrCommandError,
42
BzrOptionError,
43
NotBranchError)
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
46
from bzrlib.option import Option
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd, decorate=False):
52
"Utility function to help register a command"
53
global plugin_cmds
54
k = cmd.__name__
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
57
else:
58
k_unsquished = k
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
64
elif decorate:
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
67
return result
68
else:
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
71
72
73
def _squish_command_name(cmd):
74
return 'cmd_' + cmd.replace('-', '_')
75
76
77
def _unsquish_command_name(cmd):
78
assert cmd.startswith("cmd_")
79
return cmd[4:].replace('_','-')
80
81
82
def _builtin_commands():
83
import bzrlib.builtins
84
r = {}
85
builtins = bzrlib.builtins.__dict__
86
for name in builtins:
87
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
90
return r
91
92
93
94
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
97
98
99
def plugin_command_names():
100
return plugin_cmds.keys()
101
102
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
106
if plugins_override:
107
d.update(plugin_cmds)
108
return d
109
110
111
def get_all_cmds(plugins_override=True):
112
"""Return canonical name and class for all registered commands."""
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
114
yield k,v
115
116
117
def get_cmd_object(cmd_name, plugins_override=True):
118
"""Return the canonical name and command class for a command.
119
120
plugins_override
121
If true, plugin commands can override builtins.
122
"""
123
from bzrlib.externalcommand import ExternalCommand
124
125
cmd_name = str(cmd_name) # not unicode
126
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
129
try:
130
return cmds[cmd_name]()
131
except KeyError:
132
pass
133
134
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
137
return cmd_class()
138
139
cmd_obj = ExternalCommand.find_command(cmd_name)
140
if cmd_obj:
141
return cmd_obj
142
143
raise BzrCommandError("unknown command %r" % cmd_name)
144
145
146
class Command(object):
147
"""Base class for commands.
148
149
Commands are the heart of the command-line bzr interface.
150
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
153
into textual output.
154
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
159
160
The docstring for an actual command should give a single-line
161
summary, then a complete description of the command. A grammar
162
description will be inserted.
163
164
aliases
165
Other accepted names for this command.
166
167
takes_args
168
List of argument forms, marked with whether they are optional,
169
repeated, etc.
170
171
Examples:
172
173
['to_location', 'from_branch?', 'file*']
174
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
178
179
takes_options
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
183
184
hidden
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
187
"""
188
aliases = []
189
takes_args = []
190
takes_options = []
191
192
hidden = False
193
194
def __init__(self):
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
198
199
def options(self):
200
"""Return dict of valid options for this command.
201
202
Maps from long option name to option object."""
203
r = dict()
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
208
r[o.name] = o
209
return r
210
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
217
return 0
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
220
for oname in opts:
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
226
cmdopts = {}
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
229
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
232
233
return self.run(**all_cmd_args)
234
235
def run(self):
236
"""Actually run the command.
237
238
This is invoked with the options and arguments bound to
239
keyword parameters.
240
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
244
"""
245
raise NotImplementedError()
246
247
248
def help(self):
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
251
return None
252
return getdoc(self)
253
254
def name(self):
255
return _unsquish_command_name(self.__class__.__name__)
256
257
258
def parse_spec(spec):
259
"""
260
>>> parse_spec(None)
261
[None, None]
262
>>> parse_spec("./")
263
['./', None]
264
>>> parse_spec("../@")
265
['..', -1]
266
>>> parse_spec("../f/@35")
267
['../f', 35]
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
270
"""
271
if spec is None:
272
return [None, None]
273
if '/@' in spec:
274
parsed = spec.split('/@')
275
assert len(parsed) == 2
276
if parsed[1] == "":
277
parsed[1] = -1
278
else:
279
try:
280
parsed[1] = int(parsed[1])
281
except ValueError:
282
pass # We can allow stuff like ./@revid:blahblahblah
283
else:
284
assert parsed[1] >=0
285
else:
286
parsed = [spec, None]
287
return parsed
288
289
def parse_args(command, argv):
886
290
"""Parse command line.
887
291
888
292
Arguments and options are parsed at this level before being passed
889
293
down to specific command handlers. This routine knows, from a
890
294
lookup table, something about the available options, what optargs
891
295
they take, and which commands will accept them.
892
893
>>> parse_args('--help'.split())
894
([], {'help': True})
895
>>> parse_args('--version'.split())
896
([], {'version': True})
897
>>> parse_args('status --all'.split())
898
(['status'], {'all': True})
899
>>> parse_args('commit --message=biter'.split())
900
(['commit'], {'message': u'biter'})
901
296
"""
297
# TODO: chop up this beast; make it a method of the Command
902
298
args = []
903
299
opts = {}
904
300
905
# TODO: Maybe handle '--' to end options?
906
301
cmd_options = command.options()
302
argsover = False
907
303
while argv:
908
304
a = argv.pop(0)
305
if argsover:
306
args.append(a)
307
continue
308
elif a == '--':
309
# We've received a standalone -- No more flags
310
argsover = True
311
continue
909
312
if a[0] == '-':
910
313
# option names must not be unicode
911
314
a = str(a)
912
315
optarg = None
913
316
if a[1] == '-':
914
mutter(" got option %r" % a)
317
mutter(" got option %r", a)
915
318
if '=' in a:
916
319
optname, optarg = a[2:].split('=', 1)
917
320
else:
918
321
optname = a[2:]
919
if optname not in OPTIONS:
920
bailout('unknown long option %r' % a)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
921
325
else:
922
326
shortopt = a[1:]
923
if shortopt not in SHORT_OPTIONS:
924
bailout('unknown short option %r' % a)
925
optname = SHORT_OPTIONS[shortopt]
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
329
# their value
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
332
else:
333
# Single character short options, can be chained,
334
# and have their value appended to their name
335
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
341
342
if a[2:]:
343
# There are extra things on this option
344
# see if it is the value, or if it is another
345
# short option
346
optargfn = Option.OPTIONS[optname].type
347
if optargfn is None:
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
350
# into the list
351
argv.insert(0, '-' + a[2:])
352
else:
353
# This option takes an argument, so pack it
354
# into the array
355
optarg = a[2:]
926
356
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
927
360
if optname in opts:
928
361
# XXX: Do we ever want to support this, e.g. for -r?
929
bailout('repeated option %r' % a)
362
raise BzrError('repeated option %r' % a)
930
363
931
optargfn = OPTIONS[optname]
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
932
366
if optargfn:
933
367
if optarg == None:
934
368
if not argv:
935
bailout('option %r needs an argument' % a)
369
raise BzrError('option %r needs an argument' % a)
936
370
else:
937
371
optarg = argv.pop(0)
938
372
opts[optname] = optargfn(optarg)
939
373
else:
940
374
if optarg != None:
941
bailout('option %r takes no argument' % optname)
375
raise BzrError('option %r takes no argument' % optname)
942
376
opts[optname] = True
943
377
else:
944
378
args.append(a)
945
946
379
return args, opts
947
380
948
381
949
950
def _match_args(cmd, args):
951
"""Check non-option arguments match required pattern.
952
953
>>> _match_args('status', ['asdasdsadasd'])
954
Traceback (most recent call last):
955
...
956
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
957
>>> _match_args('add', ['asdasdsadasd'])
958
{'file_list': ['asdasdsadasd']}
959
>>> _match_args('add', 'abc def gj'.split())
960
{'file_list': ['abc', 'def', 'gj']}
961
"""
962
# match argument pattern
963
argform = cmd_args.get(cmd, [])
382
def _match_argform(cmd, takes_args, args):
964
383
argdict = {}
965
# TODO: Need a way to express 'cp SRC... DEST', where it matches
966
# all but one.
967
384
968
# step through args and argform, allowing appropriate 0-many matches
969
for ap in argform:
385
# step through args and takes_args, allowing appropriate 0-many matches
386
for ap in takes_args:
970
387
argname = ap[:-1]
971
388
if ap[-1] == '?':
972
389
if args:
979
396
argdict[argname + '_list'] = None
980
397
elif ap[-1] == '+':
981
398
if not args:
982
bailout("command %r needs one or more %s"
399
raise BzrCommandError("command %r needs one or more %s"
983
400
% (cmd, argname.upper()))
984
401
else:
985
402
argdict[argname + '_list'] = args[:]
986
403
args = []
987
404
elif ap[-1] == '$': # all but one
988
405
if len(args) < 2:
989
bailout("command %r needs one or more %s"
406
raise BzrCommandError("command %r needs one or more %s"
990
407
% (cmd, argname.upper()))
991
408
argdict[argname + '_list'] = args[:-1]
992
409
args[:-1] = []
994
411
# just a plain arg
995
412
argname = ap
996
413
if not args:
997
bailout("command %r requires argument %s"
414
raise BzrCommandError("command %r requires argument %s"
998
415
% (cmd, argname.upper()))
999
416
else:
1000
417
argdict[argname] = args.pop(0)
1001
418
1002
419
if args:
1003
bailout("extra arguments to command %s: %r"
1004
% (cmd, args))
420
raise BzrCommandError("extra argument to command %s: %s"
421
% (cmd, args[0]))
1005
422
1006
423
return argdict
1007
424
1008
425
1009
426
427
def apply_profiled(the_callable, *args, **kwargs):
428
import hotshot
429
import tempfile
430
import hotshot.stats
431
pffileno, pfname = tempfile.mkstemp()
432
try:
433
prof = hotshot.Profile(pfname)
434
try:
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
436
finally:
437
prof.close()
438
stats = hotshot.stats.load(pfname)
439
stats.strip_dirs()
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
444
return ret
445
finally:
446
os.close(pffileno)
447
os.remove(pfname)
448
449
450
def apply_lsprofiled(the_callable, *args, **kwargs):
451
from bzrlib.lsprof import profile
452
ret,stats = profile(the_callable,*args,**kwargs)
453
stats.sort()
454
stats.pprint()
455
return ret
456
1010
457
def run_bzr(argv):
1011
458
"""Execute a command.
1012
459
1013
460
This is similar to main(), but without all the trappings for
1014
461
logging and error handling.
462
463
argv
464
The command-line arguments, without the program name from argv[0]
465
466
Returns a command status or raises an exception.
467
468
Special master options: these must come before the command because
469
they control how the command is interpreted.
470
471
--no-plugins
472
Do not load plugin modules at all
473
474
--builtin
475
Only use builtin commands. (Plugins are still allowed to change
476
other behaviour.)
477
478
--profile
479
Run under the Python hotshot profiler.
480
481
--lsprof
482
Run under the Python lsprof profiler.
1015
483
"""
1016
1017
484
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1018
485
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
487
488
# --no-plugins is handled specially at a very early stage. We need
489
# to load plugins before doing other command parsing so that they
490
# can override commands, but this needs to happen first.
491
492
for a in argv:
493
if a == '--profile':
494
opt_profile = True
495
elif a == '--lsprof':
496
opt_lsprof = True
497
elif a == '--no-plugins':
498
opt_no_plugins = True
499
elif a == '--builtin':
500
opt_builtin = True
501
elif a in ('--quiet', '-q'):
502
be_quiet()
503
else:
504
continue
505
argv.remove(a)
506
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
509
if len(argv) > 1:
510
help(argv[1])
511
else:
512
help()
513
return 0
514
515
if argv[0] == '--version':
516
from bzrlib.builtins import show_version
517
show_version()
518
return 0
519
520
if not opt_no_plugins:
521
from bzrlib.plugin import load_plugins
522
load_plugins()
523
524
cmd = str(argv.pop(0))
525
526
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
527
1019
528
try:
1020
args, opts = parse_args(argv[1:])
1021
if 'help' in opts:
1022
# TODO: pass down other arguments in case they asked for
1023
# help on a command name?
1024
if args:
1025
cmd_help(args[0])
1026
else:
1027
cmd_help()
1028
return 0
1029
elif 'version' in opts:
1030
cmd_version()
1031
return 0
1032
cmd = str(args.pop(0))
1033
except IndexError:
1034
log_error('usage: bzr COMMAND')
1035
log_error(' try "bzr help"')
1036
return 1
1037
1038
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1039
1040
# global option
1041
if 'profile' in opts:
1042
profile = True
1043
del opts['profile']
1044
else:
1045
profile = False
1046
1047
# check options are reasonable
1048
allowed = cmd_options.get(canonical_cmd, [])
1049
for oname in opts:
1050
if oname not in allowed:
1051
bailout("option %r is not allowed for command %r"
1052
% (oname, cmd))
1053
1054
# TODO: give an error if there are any mandatory options which are
1055
# not specified? Or maybe there shouldn't be any "mandatory
1056
# options" (it is an oxymoron)
1057
1058
# mix arguments and options into one dictionary
1059
cmdargs = _match_args(canonical_cmd, args)
1060
for k, v in opts.items():
1061
cmdargs[k.replace('-', '_')] = v
1062
1063
if profile:
1064
import hotshot
1065
pffileno, pfname = tempfile.mkstemp()
529
if opt_lsprof:
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
531
elif opt_profile:
532
ret = apply_profiled(cmd_obj.run_argv, argv)
533
else:
534
ret = cmd_obj.run_argv(argv)
535
return ret or 0
536
finally:
537
# reset, in case we may do other commands later within the same process
538
be_quiet(False)
539
540
def display_command(func):
541
"""Decorator that suppresses pipe/interrupt errors."""
542
def ignore_pipe(*args, **kwargs):
1066
543
try:
1067
prof = hotshot.Profile(pfname)
1068
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1069
prof.close()
1070
1071
import hotshot.stats
1072
stats = hotshot.stats.load(pfname)
1073
#stats.strip_dirs()
1074
stats.sort_stats('time')
1075
## XXX: Might like to write to stderr or the trace file instead but
1076
## print_stats seems hardcoded to stdout
1077
stats.print_stats(20)
1078
1079
return ret
1080
1081
finally:
1082
os.close(pffileno)
1083
os.remove(pfname)
1084
else:
1085
return cmd_handler(**cmdargs) or 0
1086
1087
1088
1089
def _report_exception(e, summary):
1090
import traceback
1091
log_error('bzr: ' + summary)
1092
bzrlib.trace.log_exception(e)
1093
tb = sys.exc_info()[2]
1094
exinfo = traceback.extract_tb(tb)
1095
if exinfo:
1096
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1097
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1098
1099
1100
def cmd_assert_fail():
1101
assert False, "always fails"
544
result = func(*args, **kwargs)
545
sys.stdout.flush()
546
return result
547
except IOError, e:
548
if not hasattr(e, 'errno'):
549
raise
550
if e.errno != errno.EPIPE:
551
raise
552
pass
553
except KeyboardInterrupt:
554
pass
555
return ignore_pipe
1102
556
1103
557
1104
558
def main(argv):
1105
bzrlib.trace.create_tracefile(argv)
1106
559
import bzrlib.ui
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
563
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
566
return ret
567
568
569
def run_bzr_catch_errors(argv):
1107
570
try:
1108
571
try:
1109
ret = run_bzr(argv)
1110
return ret
1111
except BzrError, e:
1112
_report_exception(e, 'error: ' + e.args[0])
1113
if len(e.args) > 1:
1114
for h in e.args[1]:
1115
# some explanation or hints
1116
log_error(' ' + h)
1117
return 1
1118
except AssertionError, e:
1119
msg = 'assertion failed'
1120
if str(e):
1121
msg += ': ' + str(e)
1122
_report_exception(e, msg)
1123
except Exception, e:
1124
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1125
return 1
1126
finally:
1127
bzrlib.trace.close_trace()
1128
1129
## TODO: Trap AssertionError
1130
1131
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1132
1133
572
return run_bzr(argv)
573
finally:
574
# do this here inside the exception wrappers to catch EPIPE
575
sys.stdout.flush()
576
except Exception, e:
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
579
import errno
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
584
return 3
585
else:
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
589
import pdb
590
pdb.post_mortem(sys.exc_traceback)
591
return 3
1134
592
1135
593
if __name__ == '__main__':
1136
594
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1