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