« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1442.1.50
- compare with another revision
- download diff
- download tarball
- view history from revision 1442.1.50
- Committer: Robert Collins
- Date: 2005-10-17 00:11:49 UTC
- mto: This revision was merged to the branch mainline in revision 1459.
- Revision ID: robertc@lifelesslap.robertcollins.net-20051017001149-fe23a449de1385f7
test get with suffixes
- files added:
- .rsyncexclude
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- 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:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- 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
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
# 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
33
from inspect import getdoc
72
34
73
35
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
def cmd_lookup_revision(revno):
420
try:
421
revno = int(revno)
422
except ValueError:
423
bailout("usage: lookup-revision REVNO",
424
["REVNO is a non-negative revision number for this branch"])
425
426
print Branch('.').lookup_revision(revno) or NONE_STRING
427
428
429
430
def cmd_export(revno, dest):
431
"""Export past revision to destination directory."""
432
b = Branch('.')
433
rh = b.lookup_revision(int(revno))
434
t = b.revision_tree(rh)
435
t.export(dest)
436
437
438
439
######################################################################
440
# internal/test commands
441
442
443
def cmd_uuid():
444
"""Print a newly-generated UUID."""
445
print bzrlib.osutils.uuid()
446
447
448
449
def cmd_local_time_offset():
450
print bzrlib.osutils.local_time_offset()
451
452
453
454
def cmd_commit(message=None, verbose=False):
455
"""Commit changes to a new revision.
456
457
--message MESSAGE
458
Description of changes in this revision; free form text.
459
It is recommended that the first line be a single-sentence
460
summary.
461
--verbose
462
Show status of changed files,
463
464
TODO: Commit only selected files.
465
466
TODO: Run hooks on tree to-be-committed, and after commit.
467
468
TODO: Strict commit that fails if there are unknown or deleted files.
469
"""
470
471
if not message:
472
bailout("please specify a commit message")
473
Branch('.').commit(message, verbose=verbose)
474
475
476
def cmd_check(dir='.'):
477
"""check: Consistency check of branch history.
478
479
usage: bzr check [-v] [BRANCH]
480
481
options:
482
--verbose, -v Show progress of checking.
483
484
This command checks various invariants about the branch storage to
485
detect data corruption or bzr bugs.
486
"""
487
import bzrlib.check
488
bzrlib.check.check(Branch(dir, find_root=False))
489
490
491
def cmd_is(pred, *rest):
492
"""Test whether PREDICATE is true."""
493
try:
494
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
495
except KeyError:
496
bailout("unknown predicate: %s" % quotefn(pred))
497
498
try:
499
cmd_handler(*rest)
500
except BzrCheckError:
501
# by default we don't print the message so that this can
502
# be used from shell scripts without producing noise
503
sys.exit(1)
504
505
506
def cmd_username():
507
print bzrlib.osutils.username()
508
509
510
def cmd_user_email():
511
print bzrlib.osutils.user_email()
512
513
514
def cmd_gen_revision_id():
515
import time
516
print bzrlib.branch._gen_revision_id(time.time())
517
518
519
def cmd_selftest(verbose=False):
520
"""Run internal test suite"""
521
## -v, if present, is seen by doctest; the argument is just here
522
## so our parser doesn't complain
523
524
## TODO: --verbose option
525
526
failures, tests = 0, 0
527
528
import doctest, bzrlib.store, bzrlib.tests
529
bzrlib.trace.verbose = False
530
531
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
532
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
533
mf, mt = doctest.testmod(m)
534
failures += mf
535
tests += mt
536
print '%-40s %3d tests' % (m.__name__, mt),
537
if mf:
538
print '%3d FAILED!' % mf
539
else:
540
print
541
542
print '%-40s %3d tests' % ('total', tests),
543
if failures:
544
print '%3d FAILED!' % failures
545
else:
546
print
547
548
549
550
# deprecated
551
cmd_doctest = cmd_selftest
552
553
554
######################################################################
555
# help
556
557
558
def cmd_help(topic=None):
559
if topic == None:
560
print __doc__
561
return
562
563
# otherwise, maybe the name of a command?
564
try:
565
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
566
except KeyError:
567
bailout("no help for %r" % topic)
568
569
doc = cmdfn.__doc__
570
if doc == None:
571
bailout("sorry, no detailed help yet for %r" % topic)
572
573
print doc
574
575
576
577
578
def cmd_version():
579
print "bzr (bazaar-ng) %s" % bzrlib.__version__
580
print bzrlib.__copyright__
581
print "http://bazaar-ng.org/"
582
print
583
print \
584
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
585
you may use, modify and redistribute it under the terms of the GNU
586
General Public License version 2 or later."""
587
588
589
def cmd_rocks():
590
"""Statement of optimism."""
591
print "it sure does!"
592
593
594
595
######################################################################
596
# 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
597
339
598
340
599
341
# list of all available options; the rhs can be either None for an
601
343
# the type.
602
344
OPTIONS = {
603
345
'all': None,
346
'basis': str,
347
'diff-options': str,
604
348
'help': None,
349
'file': unicode,
350
'force': None,
351
'format': unicode,
352
'forward': None,
353
'quiet': None,
605
354
'message': unicode,
355
'no-recurse': None,
606
356
'profile': None,
607
'revision': int,
357
'revision': _parse_revision_str,
358
'short': None,
608
359
'show-ids': None,
609
360
'timezone': str,
610
361
'verbose': None,
611
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,
612
371
}
613
372
614
373
SHORT_OPTIONS = {
374
'F': 'file',
375
'h': 'help',
615
376
'm': 'message',
616
377
'r': 'revision',
617
378
'v': 'verbose',
379
'l': 'long',
380
'q': 'quiet',
618
381
}
619
382
620
# List of options that apply to particular commands; commands not
621
# listed take none.
622
cmd_options = {
623
'add': ['verbose'],
624
'commit': ['message', 'verbose'],
625
'deleted': ['show-ids'],
626
'diff': ['revision'],
627
'inventory': ['revision'],
628
'log': ['timezone'],
629
'ls': ['revision', 'verbose'],
630
'remove': ['verbose'],
631
'status': ['all'],
632
}
633
634
635
cmd_args = {
636
'add': ['file+'],
637
'commit': [],
638
'diff': [],
639
'export': ['revno', 'dest'],
640
'file-id': ['filename'],
641
'get-file-text': ['text_id'],
642
'get-inventory': ['inventory_id'],
643
'get-revision': ['revision_id'],
644
'get-revision-inventory': ['revision_id'],
645
'help': ['topic?'],
646
'init': [],
647
'log': [],
648
'lookup-revision': ['revno'],
649
'relpath': ['filename'],
650
'remove': ['file+'],
651
'root': ['filename?'],
652
'status': [],
653
}
654
655
383
656
384
def parse_args(argv):
657
385
"""Parse command line.
663
391
664
392
>>> parse_args('--help'.split())
665
393
([], {'help': True})
394
>>> parse_args('help -- --invalidcmd'.split())
395
(['help', '--invalidcmd'], {})
666
396
>>> parse_args('--version'.split())
667
397
([], {'version': True})
668
398
>>> parse_args('status --all'.split())
669
399
(['status'], {'all': True})
670
400
>>> parse_args('commit --message=biter'.split())
671
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>]})
672
410
"""
673
411
args = []
674
412
opts = {}
675
413
676
# TODO: Maybe handle '--' to end options?
677
414
argsover = False
678
415
while argv:
679
416
a = argv.pop(0)
680
if a[0] == '-':
417
if not argsover and a[0] == '-':
418
# option names must not be unicode
419
a = str(a)
681
420
optarg = None
682
421
if a[1] == '-':
422
if a == '--':
423
# We've received a standalone -- No more flags
424
argsover = True
425
continue
683
426
mutter(" got option %r" % a)
684
427
if '=' in a:
685
428
optname, optarg = a[2:].split('=', 1)
686
429
else:
687
430
optname = a[2:]
688
431
if optname not in OPTIONS:
689
bailout('unknown long option %r' % a)
432
raise BzrError('unknown long option %r' % a)
690
433
else:
691
434
shortopt = a[1:]
692
if shortopt not in SHORT_OPTIONS:
693
bailout('unknown short option %r' % a)
694
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:]
695
463
696
464
if optname in opts:
697
465
# XXX: Do we ever want to support this, e.g. for -r?
698
bailout('repeated option %r' % a)
466
raise BzrError('repeated option %r' % a)
699
467
700
468
optargfn = OPTIONS[optname]
701
469
if optargfn:
702
470
if optarg == None:
703
471
if not argv:
704
bailout('option %r needs an argument' % a)
472
raise BzrError('option %r needs an argument' % a)
705
473
else:
706
474
optarg = argv.pop(0)
707
475
opts[optname] = optargfn(optarg)
708
476
else:
709
477
if optarg != None:
710
bailout('option %r takes no argument' % optname)
478
raise BzrError('option %r takes no argument' % optname)
711
479
opts[optname] = True
712
480
else:
713
481
args.append(a)
716
484
717
485
718
486
719
def _match_args(cmd, args):
720
"""Check non-option arguments match required pattern.
721
487
722
>>> _match_args('status', ['asdasdsadasd'])
723
Traceback (most recent call last):
724
...
725
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
726
>>> _match_args('add', ['asdasdsadasd'])
727
{'file_list': ['asdasdsadasd']}
728
>>> _match_args('add', 'abc def gj'.split())
729
{'file_list': ['abc', 'def', 'gj']}
730
"""
731
# match argument pattern
732
argform = cmd_args.get(cmd, [])
488
def _match_argform(cmd, takes_args, args):
733
489
argdict = {}
734
# TODO: Need a way to express 'cp SRC... DEST', where it matches
735
# all but one.
736
490
737
# step through args and argform, allowing appropriate 0-many matches
738
for ap in argform:
491
# step through args and takes_args, allowing appropriate 0-many matches
492
for ap in takes_args:
739
493
argname = ap[:-1]
740
494
if ap[-1] == '?':
741
495
if args:
742
496
argdict[argname] = args.pop(0)
743
elif ap[-1] == '*':
744
assert 0
497
elif ap[-1] == '*': # all remaining arguments
498
if args:
499
argdict[argname + '_list'] = args[:]
500
args = []
501
else:
502
argdict[argname + '_list'] = None
745
503
elif ap[-1] == '+':
746
504
if not args:
747
bailout("command %r needs one or more %s"
505
raise BzrCommandError("command %r needs one or more %s"
748
506
% (cmd, argname.upper()))
749
507
else:
750
508
argdict[argname + '_list'] = args[:]
751
509
args = []
510
elif ap[-1] == '$': # all but one
511
if len(args) < 2:
512
raise BzrCommandError("command %r needs one or more %s"
513
% (cmd, argname.upper()))
514
argdict[argname + '_list'] = args[:-1]
515
args[:-1] = []
752
516
else:
753
517
# just a plain arg
754
518
argname = ap
755
519
if not args:
756
bailout("command %r requires argument %s"
520
raise BzrCommandError("command %r requires argument %s"
757
521
% (cmd, argname.upper()))
758
522
else:
759
523
argdict[argname] = args.pop(0)
760
524
761
525
if args:
762
bailout("extra arguments to command %s: %r"
763
% (cmd, args))
526
raise BzrCommandError("extra argument to command %s: %s"
527
% (cmd, args[0]))
764
528
765
529
return argdict
766
530
767
531
768
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
769
556
def run_bzr(argv):
770
557
"""Execute a command.
771
558
772
559
This is similar to main(), but without all the trappings for
773
logging and error handling.
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.
774
579
"""
775
try:
776
args, opts = parse_args(argv[1:])
777
if 'help' in opts:
778
# TODO: pass down other arguments in case they asked for
779
# help on a command name?
780
cmd_help()
781
return 0
782
elif 'version' in opts:
783
cmd_version()
784
return 0
785
cmd = args.pop(0)
786
except IndexError:
787
log_error('usage: bzr COMMAND\n')
788
log_error(' try "bzr help"\n')
789
return 1
790
791
try:
792
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
793
except KeyError:
794
bailout("unknown command " + `cmd`)
795
796
# global option
797
if 'profile' in opts:
798
profile = True
799
del opts['profile']
800
else:
801
profile = False
802
803
# check options are reasonable
804
allowed = cmd_options.get(cmd, [])
805
for oname in opts:
806
if oname not in allowed:
807
bailout("option %r is not allowed for command %r"
808
% (oname, cmd))
809
810
# mix arguments and options into one dictionary
811
cmdargs = _match_args(cmd, args)
812
for k, v in opts.items():
813
cmdargs[k.replace('-', '_')] = v
814
815
if profile:
816
import hotshot
817
prof = hotshot.Profile('.bzr.profile')
818
ret = prof.runcall(cmd_handler, **cmdargs) or 0
819
prof.close()
820
821
import hotshot.stats
822
stats = hotshot.stats.load('.bzr.profile')
823
#stats.strip_dirs()
824
stats.sort_stats('cumulative', 'calls')
825
stats.print_stats(20)
826
else:
827
return cmd_handler(**cmdargs) or 0
828
580
# Load all of the transport methods
581
import bzrlib.transport.local, bzrlib.transport.http
582
583
argv = [a.decode(bzrlib.user_encoding) for a in argv]
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
829
628
830
629
831
630
def main(argv):
832
## TODO: Handle command-line options; probably know what options are valid for
833
## each command
834
835
## TODO: If the arguments are wrong, give a usage message rather
836
## than just a backtrace.
837
838
bzrlib.trace.create_tracefile(argv)
839
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):
840
639
try:
841
ret = run_bzr(argv)
842
return ret
640
try:
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
843
649
except BzrError, e:
844
log_error('bzr: error: ' + e.args[0] + '\n')
845
if len(e.args) > 1:
846
for h in e.args[1]:
847
log_error(' ' + h + '\n')
650
bzrlib.trace.log_exception()
848
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
849
658
except Exception, e:
850
log_error('bzr: exception: %s\n' % e)
851
log_error(' see .bzr.log for details\n')
852
traceback.print_exc(None, bzrlib.trace._tracefile)
853
traceback.print_exc(None, sys.stderr)
854
return 1
855
856
# TODO: Maybe nicer handling of IOError?
857
858
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
859
670
860
671
if __name__ == '__main__':
861
672
sys.exit(main(sys.argv))
862
##import profile
863
##profile.run('main(sys.argv)')
864
Loggerhead is a web-based interface for Breezy
Version: 2.0.1