« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1185.1.29
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.1.29
- Committer: Robert Collins
- Date: 2005-09-19 06:05:19 UTC
- mfrom: (974.1.92)
- mto: (1185.41.1 bzr.sftp) (1092.3.4) (1417.1.4) (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) (1393.1.21)
- mto: This revision was merged to the branch mainline in revision 1390.
- Revision ID: robertc@robertcollins.net-20050919060519-f582f62146b0b458
merge merge tweaks from aaron, which includes latest .dev
- files added:
- .rsyncexclude
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files removed:
- bzrlib/tests.py
- files renamed:
- elementtree/ => bzrlib/util/elementtree/
- files modified:
- .bzrignore
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
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, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
67
from os import path
68
from sets import Set
69
from pprint import pprint
70
from stat import *
71
from glob import glob
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
28
# TODO: Help messages for options.
29
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
33
34
35
36
import sys
37
import os
38
from warnings import warn
39
from inspect import getdoc
72
40
73
41
import bzrlib
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
format_date
82
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
86
## standard representation
87
NONE_STRING = '(none)'
88
EMPTY = 'empty'
89
90
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
93
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
100
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
103
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
107
## directory.
108
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
112
113
## TODO: move command; check destination is a directory and will not
114
## clash; move it.
115
116
## TODO: command to show renames, one per line, as to->from
117
118
119
120
121
def cmd_status(all=False):
122
"""Display status summary.
123
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
127
128
:todo: Don't show unchanged files unless ``--all`` is given?
129
"""
130
Branch('.').show_status(show_all=all)
131
132
133
134
######################################################################
135
# examining history
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
139
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
144
145
146
147
######################################################################
148
# commands
149
150
151
def cmd_revno():
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
154
155
156
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
159
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
163
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
170
directories.
171
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
174
"""
175
bzrlib.add.smart_add(file_list, verbose)
176
177
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
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
def cmd_info():
199
"""info: Show statistical information for this branch
200
201
usage: bzr info"""
202
import info
203
info.show_info(Branch('.'))
204
205
206
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
211
212
213
def cmd_file_id(filename):
214
b = Branch(filename)
215
i = b.inventory.path2id(b.relpath(filename))
216
if i is None:
217
bailout("%s is not a versioned file" % filename)
218
else:
219
print i
220
221
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
224
if n is None:
225
bailout("%s is not a live file id" % fileid)
226
else:
227
print n
228
229
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
232
print patchid
233
234
235
236
def cmd_init():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
239
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
243
# both?
244
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
247
248
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
251
252
usage: bzr diff [-r REV]
253
254
--revision REV
255
Show changes since REV, rather than predecessor.
256
257
TODO: Given two revision arguments, show the difference between them.
258
259
TODO: Allow diff across branches.
260
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
262
or a graphical diff.
263
264
TODO: Diff selected files.
265
"""
266
267
## TODO: Shouldn't be in the cmd function.
268
269
b = Branch('.')
270
271
if revision == None:
272
old_tree = b.basis_tree()
273
else:
274
old_tree = b.revision_tree(b.lookup_revision(revision))
275
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
279
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
281
old_label = ''
282
new_label = ''
283
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
288
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
291
292
# TODO: Better to return them in sorted order I think.
293
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
295
d = None
296
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
299
idlabel = ''
300
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
303
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
306
print
307
308
if file_state in ['.', '?', 'I']:
309
continue
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
312
if kind == 'file':
313
diffit([],
314
new_tree.get_file(fid).readlines(),
315
fromfile=DEVNULL,
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
320
if kind == 'file':
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
323
tofile=DEVNULL)
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
331
332
if kind == 'file':
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
337
else:
338
bailout("can't represent state %s {%s}" % (file_state, fid))
339
340
341
342
def cmd_deleted(show_ids=False):
343
"""List files deleted in the working tree.
344
345
TODO: Show files deleted since a previous revision, or between two revisions.
346
"""
347
b = Branch('.')
348
old = b.basis_tree()
349
new = b.working_tree()
350
351
for path, ie in old.inventory.iter_entries():
352
if not new.has_id(ie.file_id):
353
if show_ids:
354
print '%-50s %s' % (path, ie.file_id)
355
else:
356
print path
357
358
359
360
361
def cmd_root(filename=None):
362
"""Print the branch root."""
363
print bzrlib.branch.find_branch_root(filename)
364
365
366
def cmd_log(timezone='original'):
367
"""Show log of this branch.
368
369
:todo: Options for utc; to show ids; to limit range; etc.
370
"""
371
Branch('.').write_log(show_timezone=timezone)
372
373
374
def cmd_ls(revision=None, verbose=False):
375
"""List files in a tree.
376
377
:todo: Take a revision or remote path and list that tree instead.
378
"""
379
b = Branch('.')
380
if revision == None:
381
tree = b.working_tree()
382
else:
383
tree = b.revision_tree(b.lookup_revision(revision))
384
385
for fp, fc, kind, fid in tree.list_files():
386
if verbose:
387
if kind == 'directory':
388
kindch = '/'
389
elif kind == 'file':
390
kindch = ''
391
else:
392
kindch = '???'
393
394
print '%-8s %s%s' % (fc, fp, kindch)
395
else:
396
print fp
397
398
399
400
def cmd_unknowns():
401
"""List unknown files"""
402
for f in Branch('.').unknowns():
403
print quotefn(f)
404
405
406
407
def cmd_ignored(verbose=True):
408
"""List ignored files and the patterns that matched them.
409
"""
410
tree = Branch('.').working_tree()
411
for path, file_class, kind, id in tree.list_files():
412
if file_class != 'I':
413
continue
414
## XXX: Slightly inefficient since this was already calculated
415
pat = tree.is_ignored(path)
416
print '%-50s %s' % (path, pat)
417
418
419
420
def cmd_lookup_revision(revno):
421
try:
422
revno = int(revno)
423
except ValueError:
424
bailout("usage: lookup-revision REVNO",
425
["REVNO is a non-negative revision number for this branch"])
426
427
print Branch('.').lookup_revision(revno) or NONE_STRING
428
429
430
431
def cmd_export(revno, dest):
432
"""Export past revision to destination directory."""
433
b = Branch('.')
434
rh = b.lookup_revision(int(revno))
435
t = b.revision_tree(rh)
436
t.export(dest)
437
438
439
440
######################################################################
441
# internal/test commands
442
443
444
def cmd_uuid():
445
"""Print a newly-generated UUID."""
446
print bzrlib.osutils.uuid()
447
448
449
450
def cmd_local_time_offset():
451
print bzrlib.osutils.local_time_offset()
452
453
454
455
def cmd_commit(message=None, verbose=False):
456
"""Commit changes to a new revision.
457
458
--message MESSAGE
459
Description of changes in this revision; free form text.
460
It is recommended that the first line be a single-sentence
461
summary.
462
--verbose
463
Show status of changed files,
464
465
TODO: Commit only selected files.
466
467
TODO: Run hooks on tree to-be-committed, and after commit.
468
469
TODO: Strict commit that fails if there are unknown or deleted files.
470
"""
471
472
if not message:
473
bailout("please specify a commit message")
474
Branch('.').commit(message, verbose=verbose)
475
476
477
def cmd_check(dir='.'):
478
"""check: Consistency check of branch history.
479
480
usage: bzr check [-v] [BRANCH]
481
482
options:
483
--verbose, -v Show progress of checking.
484
485
This command checks various invariants about the branch storage to
486
detect data corruption or bzr bugs.
487
"""
488
import bzrlib.check
489
bzrlib.check.check(Branch(dir, find_root=False))
490
491
492
def cmd_is(pred, *rest):
493
"""Test whether PREDICATE is true."""
494
try:
495
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
496
except KeyError:
497
bailout("unknown predicate: %s" % quotefn(pred))
498
499
try:
500
cmd_handler(*rest)
501
except BzrCheckError:
502
# by default we don't print the message so that this can
503
# be used from shell scripts without producing noise
504
sys.exit(1)
505
506
507
def cmd_username():
508
print bzrlib.osutils.username()
509
510
511
def cmd_user_email():
512
print bzrlib.osutils.user_email()
513
514
515
def cmd_gen_revision_id():
516
import time
517
print bzrlib.branch._gen_revision_id(time.time())
518
519
520
def cmd_selftest(verbose=False):
521
"""Run internal test suite"""
522
## -v, if present, is seen by doctest; the argument is just here
523
## so our parser doesn't complain
524
525
## TODO: --verbose option
526
527
failures, tests = 0, 0
528
529
import doctest, bzrlib.store, bzrlib.tests
530
bzrlib.trace.verbose = False
531
532
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
533
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
534
mf, mt = doctest.testmod(m)
535
failures += mf
536
tests += mt
537
print '%-40s %3d tests' % (m.__name__, mt),
538
if mf:
539
print '%3d FAILED!' % mf
540
else:
541
print
542
543
print '%-40s %3d tests' % ('total', tests),
544
if failures:
545
print '%3d FAILED!' % failures
546
else:
547
print
548
549
550
551
# deprecated
552
cmd_doctest = cmd_selftest
553
554
555
######################################################################
556
# help
557
558
559
def cmd_help(topic=None):
560
if topic == None:
561
print __doc__
562
return
563
564
# otherwise, maybe the name of a command?
565
try:
566
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
567
except KeyError:
568
bailout("no help for %r" % topic)
569
570
doc = cmdfn.__doc__
571
if doc == None:
572
bailout("sorry, no detailed help yet for %r" % topic)
573
574
print doc
575
576
577
578
579
def cmd_version():
580
print "bzr (bazaar-ng) %s" % bzrlib.__version__
581
print bzrlib.__copyright__
582
print "http://bazaar-ng.org/"
583
print
584
print \
585
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
586
you may use, modify and redistribute it under the terms of the GNU
587
General Public License version 2 or later."""
588
589
590
def cmd_rocks():
591
"""Statement of optimism."""
592
print "it sure does!"
593
594
595
596
######################################################################
597
# main routine
42
import bzrlib.trace
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib import BZRDIR
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd):
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
else:
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
65
66
67
def _squish_command_name(cmd):
68
return 'cmd_' + cmd.replace('-', '_')
69
70
71
def _unsquish_command_name(cmd):
72
assert cmd.startswith("cmd_")
73
return cmd[4:].replace('_','-')
74
75
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
78
79
This always returns a list. The list will have one element for
80
each revision.
81
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
116
...
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
120
...
121
BzrError: No namespace registered for string: 'abc'
122
"""
123
import re
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
126
revs = []
127
if m:
128
warning('Colon separator for revision numbers is deprecated.'
129
' Use .. instead')
130
for rev in revstr.split(':'):
131
if rev:
132
revs.append(RevisionSpec(int(rev)))
133
else:
134
revs.append(RevisionSpec(None))
135
else:
136
for x in revstr.split('..'):
137
if not x:
138
revs.append(RevisionSpec(None))
139
else:
140
revs.append(RevisionSpec(x))
141
return revs
142
143
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
147
try:
148
return merge_types[typestring][0]
149
except KeyError:
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
156
157
158
def _builtin_commands():
159
import bzrlib.builtins
160
r = {}
161
builtins = bzrlib.builtins.__dict__
162
for name in builtins:
163
if name.startswith("cmd_"):
164
real_name = _unsquish_command_name(name)
165
r[real_name] = builtins[name]
166
return r
167
168
169
170
def builtin_command_names():
171
"""Return list of builtin command names."""
172
return _builtin_commands().keys()
173
174
175
def plugin_command_names():
176
return plugin_cmds.keys()
177
178
179
def _get_cmd_dict(plugins_override=True):
180
"""Return name->class mapping for all commands."""
181
d = _builtin_commands()
182
if plugins_override:
183
d.update(plugin_cmds)
184
return d
185
186
187
def get_all_cmds(plugins_override=True):
188
"""Return canonical name and class for all registered commands."""
189
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
190
yield k,v
191
192
193
def get_cmd_object(cmd_name, plugins_override=True):
194
"""Return the canonical name and command class for a command.
195
196
plugins_override
197
If true, plugin commands can override builtins.
198
"""
199
from bzrlib.externalcommand import ExternalCommand
200
201
cmd_name = str(cmd_name) # not unicode
202
203
# first look up this command under the specified name
204
cmds = _get_cmd_dict(plugins_override=plugins_override)
205
try:
206
return cmds[cmd_name]()
207
except KeyError:
208
pass
209
210
# look for any command which claims this as an alias
211
for real_cmd_name, cmd_class in cmds.iteritems():
212
if cmd_name in cmd_class.aliases:
213
return cmd_class()
214
215
cmd_obj = ExternalCommand.find_command(cmd_name)
216
if cmd_obj:
217
return cmd_obj
218
219
raise BzrCommandError("unknown command %r" % cmd_name)
220
221
222
class Command(object):
223
"""Base class for commands.
224
225
Commands are the heart of the command-line bzr interface.
226
227
The command object mostly handles the mapping of command-line
228
parameters into one or more bzrlib operations, and of the results
229
into textual output.
230
231
Commands normally don't have any state. All their arguments are
232
passed in to the run method. (Subclasses may take a different
233
policy if the behaviour of the instance needs to depend on e.g. a
234
shell plugin and not just its Python class.)
235
236
The docstring for an actual command should give a single-line
237
summary, then a complete description of the command. A grammar
238
description will be inserted.
239
240
aliases
241
Other accepted names for this command.
242
243
takes_args
244
List of argument forms, marked with whether they are optional,
245
repeated, etc.
246
247
takes_options
248
List of options that may be given for this command.
249
250
hidden
251
If true, this command isn't advertised. This is typically
252
for commands intended for expert users.
253
"""
254
aliases = []
255
256
takes_args = []
257
takes_options = []
258
259
hidden = False
260
261
def __init__(self):
262
"""Construct an instance of this command."""
263
if self.__doc__ == Command.__doc__:
264
warn("No help message set for %r" % self)
265
266
267
def run_argv(self, argv):
268
"""Parse command line and run."""
269
args, opts = parse_args(argv)
270
271
if 'help' in opts: # e.g. bzr add --help
272
from bzrlib.help import help_on_command
273
help_on_command(self.name())
274
return 0
275
276
# check options are reasonable
277
allowed = self.takes_options
278
for oname in opts:
279
if oname not in allowed:
280
raise BzrCommandError("option '--%s' is not allowed for command %r"
281
% (oname, self.name()))
282
283
# mix arguments and options into one dictionary
284
cmdargs = _match_argform(self.name(), self.takes_args, args)
285
cmdopts = {}
286
for k, v in opts.items():
287
cmdopts[k.replace('-', '_')] = v
288
289
all_cmd_args = cmdargs.copy()
290
all_cmd_args.update(cmdopts)
291
292
return self.run(**all_cmd_args)
293
294
295
def run(self):
296
"""Actually run the command.
297
298
This is invoked with the options and arguments bound to
299
keyword parameters.
300
301
Return 0 or None if the command was successful, or a non-zero
302
shell error code if not. It's OK for this method to allow
303
an exception to raise up.
304
"""
305
raise NotImplementedError()
306
307
308
def help(self):
309
"""Return help message for this class."""
310
if self.__doc__ is Command.__doc__:
311
return None
312
return getdoc(self)
313
314
def name(self):
315
return _unsquish_command_name(self.__class__.__name__)
316
317
318
def parse_spec(spec):
319
"""
320
>>> parse_spec(None)
321
[None, None]
322
>>> parse_spec("./")
323
['./', None]
324
>>> parse_spec("../@")
325
['..', -1]
326
>>> parse_spec("../f/@35")
327
['../f', 35]
328
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
329
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
330
"""
331
if spec is None:
332
return [None, None]
333
if '/@' in spec:
334
parsed = spec.split('/@')
335
assert len(parsed) == 2
336
if parsed[1] == "":
337
parsed[1] = -1
338
else:
339
try:
340
parsed[1] = int(parsed[1])
341
except ValueError:
342
pass # We can allow stuff like ./@revid:blahblahblah
343
else:
344
assert parsed[1] >=0
345
else:
346
parsed = [spec, None]
347
return parsed
598
348
599
349
600
350
# list of all available options; the rhs can be either None for an
602
352
# the type.
603
353
OPTIONS = {
604
354
'all': None,
355
'diff-options': str,
605
356
'help': None,
357
'file': unicode,
358
'force': None,
359
'format': unicode,
360
'forward': None,
606
361
'message': unicode,
362
'no-recurse': None,
607
363
'profile': None,
608
'revision': int,
364
'revision': _parse_revision_str,
365
'short': None,
609
366
'show-ids': None,
610
367
'timezone': str,
611
368
'verbose': None,
612
369
'version': None,
370
'email': None,
371
'unchanged': None,
372
'update': None,
373
'long': None,
374
'root': str,
375
'no-backup': None,
376
'merge-type': get_merge_type,
377
'pattern': str,
613
378
}
614
379
615
380
SHORT_OPTIONS = {
381
'F': 'file',
382
'h': 'help',
616
383
'm': 'message',
617
384
'r': 'revision',
618
385
'v': 'verbose',
386
'l': 'long',
619
387
}
620
388
621
# List of options that apply to particular commands; commands not
622
# listed take none.
623
cmd_options = {
624
'add': ['verbose'],
625
'commit': ['message', 'verbose'],
626
'deleted': ['show-ids'],
627
'diff': ['revision'],
628
'inventory': ['revision'],
629
'log': ['timezone'],
630
'ls': ['revision', 'verbose'],
631
'remove': ['verbose'],
632
'status': ['all'],
633
}
634
635
636
cmd_args = {
637
'add': ['file+'],
638
'commit': [],
639
'diff': [],
640
'export': ['revno', 'dest'],
641
'file-id': ['filename'],
642
'get-file-text': ['text_id'],
643
'get-inventory': ['inventory_id'],
644
'get-revision': ['revision_id'],
645
'get-revision-inventory': ['revision_id'],
646
'help': ['topic?'],
647
'init': [],
648
'log': [],
649
'lookup-revision': ['revno'],
650
'relpath': ['filename'],
651
'remove': ['file+'],
652
'root': ['filename?'],
653
'status': [],
654
}
655
656
389
657
390
def parse_args(argv):
658
391
"""Parse command line.
664
397
665
398
>>> parse_args('--help'.split())
666
399
([], {'help': True})
400
>>> parse_args('help -- --invalidcmd'.split())
401
(['help', '--invalidcmd'], {})
667
402
>>> parse_args('--version'.split())
668
403
([], {'version': True})
669
404
>>> parse_args('status --all'.split())
670
405
(['status'], {'all': True})
671
406
>>> parse_args('commit --message=biter'.split())
672
407
(['commit'], {'message': u'biter'})
408
>>> parse_args('log -r 500'.split())
409
(['log'], {'revision': [<RevisionSpec_int 500>]})
410
>>> parse_args('log -r500..600'.split())
411
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
412
>>> parse_args('log -vr500..600'.split())
413
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
414
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
415
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
673
416
"""
674
417
args = []
675
418
opts = {}
676
419
677
# TODO: Maybe handle '--' to end options?
678
420
argsover = False
679
421
while argv:
680
422
a = argv.pop(0)
681
if a[0] == '-':
423
if not argsover and a[0] == '-':
424
# option names must not be unicode
425
a = str(a)
682
426
optarg = None
683
427
if a[1] == '-':
428
if a == '--':
429
# We've received a standalone -- No more flags
430
argsover = True
431
continue
684
432
mutter(" got option %r" % a)
685
433
if '=' in a:
686
434
optname, optarg = a[2:].split('=', 1)
687
435
else:
688
436
optname = a[2:]
689
437
if optname not in OPTIONS:
690
bailout('unknown long option %r' % a)
438
raise BzrError('unknown long option %r' % a)
691
439
else:
692
440
shortopt = a[1:]
693
if shortopt not in SHORT_OPTIONS:
694
bailout('unknown short option %r' % a)
695
optname = SHORT_OPTIONS[shortopt]
441
if shortopt in SHORT_OPTIONS:
442
# Multi-character options must have a space to delimit
443
# their value
444
optname = SHORT_OPTIONS[shortopt]
445
else:
446
# Single character short options, can be chained,
447
# and have their value appended to their name
448
shortopt = a[1:2]
449
if shortopt not in SHORT_OPTIONS:
450
# We didn't find the multi-character name, and we
451
# didn't find the single char name
452
raise BzrError('unknown short option %r' % a)
453
optname = SHORT_OPTIONS[shortopt]
454
455
if a[2:]:
456
# There are extra things on this option
457
# see if it is the value, or if it is another
458
# short option
459
optargfn = OPTIONS[optname]
460
if optargfn is None:
461
# This option does not take an argument, so the
462
# next entry is another short option, pack it back
463
# into the list
464
argv.insert(0, '-' + a[2:])
465
else:
466
# This option takes an argument, so pack it
467
# into the array
468
optarg = a[2:]
696
469
697
470
if optname in opts:
698
471
# XXX: Do we ever want to support this, e.g. for -r?
699
bailout('repeated option %r' % a)
472
raise BzrError('repeated option %r' % a)
700
473
701
474
optargfn = OPTIONS[optname]
702
475
if optargfn:
703
476
if optarg == None:
704
477
if not argv:
705
bailout('option %r needs an argument' % a)
478
raise BzrError('option %r needs an argument' % a)
706
479
else:
707
480
optarg = argv.pop(0)
708
481
opts[optname] = optargfn(optarg)
709
482
else:
710
483
if optarg != None:
711
bailout('option %r takes no argument' % optname)
484
raise BzrError('option %r takes no argument' % optname)
712
485
opts[optname] = True
713
486
else:
714
487
args.append(a)
717
490
718
491
719
492
720
def _match_args(cmd, args):
721
"""Check non-option arguments match required pattern.
722
493
723
>>> _match_args('status', ['asdasdsadasd'])
724
Traceback (most recent call last):
725
...
726
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
727
>>> _match_args('add', ['asdasdsadasd'])
728
{'file_list': ['asdasdsadasd']}
729
>>> _match_args('add', 'abc def gj'.split())
730
{'file_list': ['abc', 'def', 'gj']}
731
"""
732
# match argument pattern
733
argform = cmd_args.get(cmd, [])
494
def _match_argform(cmd, takes_args, args):
734
495
argdict = {}
735
# TODO: Need a way to express 'cp SRC... DEST', where it matches
736
# all but one.
737
496
738
# step through args and argform, allowing appropriate 0-many matches
739
for ap in argform:
497
# step through args and takes_args, allowing appropriate 0-many matches
498
for ap in takes_args:
740
499
argname = ap[:-1]
741
500
if ap[-1] == '?':
742
501
if args:
743
502
argdict[argname] = args.pop(0)
744
elif ap[-1] == '*':
745
assert 0
503
elif ap[-1] == '*': # all remaining arguments
504
if args:
505
argdict[argname + '_list'] = args[:]
506
args = []
507
else:
508
argdict[argname + '_list'] = None
746
509
elif ap[-1] == '+':
747
510
if not args:
748
bailout("command %r needs one or more %s"
511
raise BzrCommandError("command %r needs one or more %s"
749
512
% (cmd, argname.upper()))
750
513
else:
751
514
argdict[argname + '_list'] = args[:]
752
515
args = []
516
elif ap[-1] == '$': # all but one
517
if len(args) < 2:
518
raise BzrCommandError("command %r needs one or more %s"
519
% (cmd, argname.upper()))
520
argdict[argname + '_list'] = args[:-1]
521
args[:-1] = []
753
522
else:
754
523
# just a plain arg
755
524
argname = ap
756
525
if not args:
757
bailout("command %r requires argument %s"
526
raise BzrCommandError("command %r requires argument %s"
758
527
% (cmd, argname.upper()))
759
528
else:
760
529
argdict[argname] = args.pop(0)
761
530
762
531
if args:
763
bailout("extra arguments to command %s: %r"
764
% (cmd, args))
532
raise BzrCommandError("extra argument to command %s: %s"
533
% (cmd, args[0]))
765
534
766
535
return argdict
767
536
768
537
769
538
539
def apply_profiled(the_callable, *args, **kwargs):
540
import hotshot
541
import tempfile
542
pffileno, pfname = tempfile.mkstemp()
543
try:
544
prof = hotshot.Profile(pfname)
545
try:
546
ret = prof.runcall(the_callable, *args, **kwargs) or 0
547
finally:
548
prof.close()
549
550
import hotshot.stats
551
stats = hotshot.stats.load(pfname)
552
#stats.strip_dirs()
553
stats.sort_stats('time')
554
## XXX: Might like to write to stderr or the trace file instead but
555
## print_stats seems hardcoded to stdout
556
stats.print_stats(20)
557
558
return ret
559
finally:
560
os.close(pffileno)
561
os.remove(pfname)
562
563
770
564
def run_bzr(argv):
771
565
"""Execute a command.
772
566
773
567
This is similar to main(), but without all the trappings for
774
logging and error handling.
568
logging and error handling.
569
570
argv
571
The command-line arguments, without the program name from argv[0]
572
573
Returns a command status or raises an exception.
574
575
Special master options: these must come before the command because
576
they control how the command is interpreted.
577
578
--no-plugins
579
Do not load plugin modules at all
580
581
--builtin
582
Only use builtin commands. (Plugins are still allowed to change
583
other behaviour.)
584
585
--profile
586
Run under the Python profiler.
775
587
"""
776
try:
777
args, opts = parse_args(argv[1:])
778
if 'help' in opts:
779
# TODO: pass down other arguments in case they asked for
780
# help on a command name?
781
cmd_help()
782
return 0
783
elif 'version' in opts:
784
cmd_version()
785
return 0
786
cmd = args.pop(0)
787
except IndexError:
788
log_error('usage: bzr COMMAND\n')
789
log_error(' try "bzr help"\n')
790
return 1
791
792
try:
793
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
794
except KeyError:
795
bailout("unknown command " + `cmd`)
796
797
# global option
798
if 'profile' in opts:
799
profile = True
800
del opts['profile']
801
else:
802
profile = False
803
804
# check options are reasonable
805
allowed = cmd_options.get(cmd, [])
806
for oname in opts:
807
if oname not in allowed:
808
bailout("option %r is not allowed for command %r"
809
% (oname, cmd))
810
811
# mix arguments and options into one dictionary
812
cmdargs = _match_args(cmd, args)
813
for k, v in opts.items():
814
cmdargs[k.replace('-', '_')] = v
815
816
if profile:
817
import hotshot
818
prof = hotshot.Profile('.bzr.profile')
819
ret = prof.runcall(cmd_handler, **cmdargs) or 0
820
prof.close()
821
822
import hotshot.stats
823
stats = hotshot.stats.load('.bzr.profile')
824
#stats.strip_dirs()
825
stats.sort_stats('cumulative', 'calls')
826
stats.print_stats(20)
827
else:
828
return cmd_handler(**cmdargs) or 0
829
588
589
argv = [a.decode(bzrlib.user_encoding) for a in argv]
590
591
opt_profile = opt_no_plugins = opt_builtin = False
592
593
# --no-plugins is handled specially at a very early stage. We need
594
# to load plugins before doing other command parsing so that they
595
# can override commands, but this needs to happen first.
596
597
for a in argv:
598
if a == '--profile':
599
opt_profile = True
600
elif a == '--no-plugins':
601
opt_no_plugins = True
602
elif a == '--builtin':
603
opt_builtin = True
604
else:
605
break
606
argv.remove(a)
607
608
if (not argv) or (argv[0] == '--help'):
609
from bzrlib.help import help
610
if len(argv) > 1:
611
help(argv[1])
612
else:
613
help()
614
return 0
615
616
if argv[0] == '--version':
617
from bzrlib.builtins import show_version
618
show_version()
619
return 0
620
621
if not opt_no_plugins:
622
from bzrlib.plugin import load_plugins
623
load_plugins()
624
625
cmd = str(argv.pop(0))
626
627
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
628
629
if opt_profile:
630
ret = apply_profiled(cmd_obj.run_argv, argv)
631
else:
632
ret = cmd_obj.run_argv(argv)
633
return ret or 0
830
634
831
635
832
636
def main(argv):
833
## TODO: Handle command-line options; probably know what options are valid for
834
## each command
835
836
## TODO: If the arguments are wrong, give a usage message rather
837
## than just a backtrace.
838
839
bzrlib.trace.create_tracefile(argv)
840
637
import bzrlib.ui
638
bzrlib.trace.log_startup(argv)
639
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
640
641
return run_bzr_catch_errors(argv[1:])
642
643
644
def run_bzr_catch_errors(argv):
841
645
try:
842
ret = run_bzr(argv)
843
return ret
646
try:
647
try:
648
return run_bzr(argv)
649
finally:
650
# do this here inside the exception wrappers to catch EPIPE
651
sys.stdout.flush()
652
#wrap common errors as CommandErrors.
653
except (NotBranchError,), e:
654
raise BzrCommandError(str(e))
655
except BzrCommandError, e:
656
# command line syntax error, etc
657
log_error(str(e))
658
return 1
844
659
except BzrError, e:
845
log_error('bzr: error: ' + e.args[0] + '\n')
846
if len(e.args) > 1:
847
for h in e.args[1]:
848
log_error(' ' + h + '\n')
660
bzrlib.trace.log_exception()
849
661
return 1
662
except AssertionError, e:
663
bzrlib.trace.log_exception('assertion failed: ' + str(e))
664
return 3
665
except KeyboardInterrupt, e:
666
bzrlib.trace.note('interrupted')
667
return 2
850
668
except Exception, e:
851
log_error('bzr: exception: %s\n' % e)
852
log_error(' see .bzr.log for details\n')
853
traceback.print_exc(None, bzrlib.trace._tracefile)
854
traceback.print_exc(None, sys.stderr)
855
return 1
856
857
# TODO: Maybe nicer handling of IOError?
858
669
import errno
670
if (isinstance(e, IOError)
671
and hasattr(e, 'errno')
672
and e.errno == errno.EPIPE):
673
bzrlib.trace.note('broken pipe')
674
return 2
675
else:
676
bzrlib.trace.log_exception()
677
return 2
859
678
860
679
861
680
if __name__ == '__main__':
862
681
sys.exit(main(sys.argv))
863
##import profile
864
##profile.run('main(sys.argv)')
865
Loggerhead is a web-based interface for Breezy
Version: 2.0.1