« 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
import info
200
info.show_info(Branch('.'))
201
202
203
204
def cmd_remove(file_list, verbose=False):
205
b = Branch(file_list[0])
206
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
207
208
209
210
def cmd_file_id(filename):
211
b = Branch(filename)
212
i = b.inventory.path2id(b.relpath(filename))
213
if i is None:
214
bailout("%s is not a versioned file" % filename)
215
else:
216
print i
217
218
219
def cmd_find_filename(fileid):
220
n = find_filename(fileid)
221
if n is None:
222
bailout("%s is not a live file id" % fileid)
223
else:
224
print n
225
226
227
def cmd_revision_history():
228
for patchid in Branch('.').revision_history():
229
print patchid
230
231
232
233
def cmd_init():
234
# TODO: Check we're not already in a working directory? At the
235
# moment you'll get an ugly error.
236
237
# TODO: What if we're in a subdirectory of a branch? Would like
238
# to allow that, but then the parent may need to understand that
239
# the children have disappeared, or should they be versioned in
240
# both?
241
242
# TODO: Take an argument/option for branch name.
243
Branch('.', init=True)
244
245
246
def cmd_diff(revision=None):
247
"""Show diff from basis to working copy.
248
249
:todo: Take one or two revision arguments, look up those trees,
250
and diff them.
251
252
:todo: Allow diff across branches.
253
254
:todo: Mangle filenames in diff to be more relevant.
255
256
:todo: Shouldn't be in the cmd function.
257
258
TODO: Option to use external diff command; could be GNU diff,
259
wdiff, or a graphical diff.
260
"""
261
262
b = Branch('.')
263
264
if revision == None:
265
old_tree = b.basis_tree()
266
else:
267
old_tree = b.revision_tree(b.lookup_revision(revision))
268
269
new_tree = b.working_tree()
270
old_inv = old_tree.inventory
271
new_inv = new_tree.inventory
272
273
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
274
old_label = ''
275
new_label = ''
276
277
DEVNULL = '/dev/null'
278
# Windows users, don't panic about this filename -- it is a
279
# special signal to GNU patch that the file should be created or
280
# deleted respectively.
281
282
# TODO: Generation of pseudo-diffs for added/deleted files could
283
# be usefully made into a much faster special case.
284
285
# TODO: Better to return them in sorted order I think.
286
287
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
288
d = None
289
290
# Don't show this by default; maybe do it if an option is passed
291
# idlabel = ' {%s}' % fid
292
idlabel = ''
293
294
# FIXME: Something about the diff format makes patch unhappy
295
# with newly-added files.
296
297
def diffit(*a, **kw):
298
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
299
print
300
301
if file_state in ['.', '?', 'I']:
302
continue
303
elif file_state == 'A':
304
print '*** added %s %r' % (kind, new_name)
305
if kind == 'file':
306
diffit([],
307
new_tree.get_file(fid).readlines(),
308
fromfile=DEVNULL,
309
tofile=new_label + new_name + idlabel)
310
elif file_state == 'D':
311
assert isinstance(old_name, types.StringTypes)
312
print '*** deleted %s %r' % (kind, old_name)
313
if kind == 'file':
314
diffit(old_tree.get_file(fid).readlines(), [],
315
fromfile=old_label + old_name + idlabel,
316
tofile=DEVNULL)
317
elif file_state in ['M', 'R']:
318
if file_state == 'M':
319
assert kind == 'file'
320
assert old_name == new_name
321
print '*** modified %s %r' % (kind, new_name)
322
elif file_state == 'R':
323
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
324
325
if kind == 'file':
326
diffit(old_tree.get_file(fid).readlines(),
327
new_tree.get_file(fid).readlines(),
328
fromfile=old_label + old_name + idlabel,
329
tofile=new_label + new_name)
330
else:
331
bailout("can't represent state %s {%s}" % (file_state, fid))
332
333
334
335
def cmd_root(filename=None):
336
"""Print the branch root."""
337
print bzrlib.branch.find_branch_root(filename)
338
339
340
def cmd_log(timezone='original'):
341
"""Show log of this branch.
342
343
:todo: Options for utc; to show ids; to limit range; etc.
344
"""
345
Branch('.').write_log(show_timezone=timezone)
346
347
348
def cmd_ls(revision=None, verbose=False):
349
"""List files in a tree.
350
351
:todo: Take a revision or remote path and list that tree instead.
352
"""
353
b = Branch('.')
354
if revision == None:
355
tree = b.working_tree()
356
else:
357
tree = b.revision_tree(b.lookup_revision(revision))
358
359
for fp, fc, kind, fid in tree.list_files():
360
if verbose:
361
if kind == 'directory':
362
kindch = '/'
363
elif kind == 'file':
364
kindch = ''
365
else:
366
kindch = '???'
367
368
print '%-8s %s%s' % (fc, fp, kindch)
369
else:
370
print fp
371
372
373
374
def cmd_unknowns():
375
"""List unknown files"""
376
for f in Branch('.').unknowns():
377
print quotefn(f)
378
379
380
def cmd_lookup_revision(revno):
381
try:
382
revno = int(revno)
383
except ValueError:
384
bailout("usage: lookup-revision REVNO",
385
["REVNO is a non-negative revision number for this branch"])
386
387
print Branch('.').lookup_revision(revno) or NONE_STRING
388
389
390
391
def cmd_export(revno, dest):
392
"""Export past revision to destination directory."""
393
b = Branch('.')
394
rh = b.lookup_revision(int(revno))
395
t = b.revision_tree(rh)
396
t.export(dest)
397
398
399
400
######################################################################
401
# internal/test commands
402
403
404
def cmd_uuid():
405
"""Print a newly-generated UUID."""
406
print bzrlib.osutils.uuid()
407
408
409
410
def cmd_local_time_offset():
411
print bzrlib.osutils.local_time_offset()
412
413
414
415
def cmd_commit(message=None, verbose=False):
416
if not message:
417
bailout("please specify a commit message")
418
Branch('.').commit(message, verbose=verbose)
419
420
421
def cmd_check():
422
"""Check consistency of the branch."""
423
check()
424
425
426
def cmd_is(pred, *rest):
427
"""Test whether PREDICATE is true."""
428
try:
429
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
430
except KeyError:
431
bailout("unknown predicate: %s" % quotefn(pred))
432
433
try:
434
cmd_handler(*rest)
435
except BzrCheckError:
436
# by default we don't print the message so that this can
437
# be used from shell scripts without producing noise
438
sys.exit(1)
439
440
441
def cmd_username():
442
print bzrlib.osutils.username()
443
444
445
def cmd_user_email():
446
print bzrlib.osutils.user_email()
447
448
449
def cmd_gen_revision_id():
450
import time
451
print bzrlib.branch._gen_revision_id(time.time())
452
453
454
def cmd_selftest(verbose=False):
455
"""Run internal test suite"""
456
## -v, if present, is seen by doctest; the argument is just here
457
## so our parser doesn't complain
458
459
## TODO: --verbose option
460
461
failures, tests = 0, 0
462
463
import doctest, bzrlib.store, bzrlib.tests
464
bzrlib.trace.verbose = False
465
466
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
467
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
468
mf, mt = doctest.testmod(m)
469
failures += mf
470
tests += mt
471
print '%-40s %3d tests' % (m.__name__, mt),
472
if mf:
473
print '%3d FAILED!' % mf
474
else:
475
print
476
477
print '%-40s %3d tests' % ('total', tests),
478
if failures:
479
print '%3d FAILED!' % failures
480
else:
481
print
482
483
484
485
# deprecated
486
cmd_doctest = cmd_selftest
487
488
489
######################################################################
490
# help
491
492
493
def cmd_help(topic=None):
494
if topic == None:
495
print __doc__
496
return
497
498
# otherwise, maybe the name of a command?
499
try:
500
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
501
except KeyError:
502
bailout("no help for %r" % topic)
503
504
doc = cmdfn.__doc__
505
if doc == None:
506
bailout("sorry, no detailed help yet for %r" % topic)
507
508
print doc
509
510
511
512
513
def cmd_version():
514
print "bzr (bazaar-ng) %s" % bzrlib.__version__
515
print bzrlib.__copyright__
516
print "http://bazaar-ng.org/"
517
print
518
print \
519
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
520
you may use, modify and redistribute it under the terms of the GNU
521
General Public License version 2 or later."""
522
523
524
def cmd_rocks():
525
"""Statement of optimism."""
526
print "it sure does!"
527
528
529
530
######################################################################
531
# 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
532
348
533
349
534
350
# list of all available options; the rhs can be either None for an
536
352
# the type.
537
353
OPTIONS = {
538
354
'all': None,
355
'diff-options': str,
539
356
'help': None,
357
'file': unicode,
358
'force': None,
359
'format': unicode,
360
'forward': None,
540
361
'message': unicode,
541
'revision': int,
362
'no-recurse': None,
363
'profile': None,
364
'revision': _parse_revision_str,
365
'short': None,
542
366
'show-ids': None,
543
367
'timezone': str,
544
368
'verbose': None,
545
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,
546
378
}
547
379
548
380
SHORT_OPTIONS = {
381
'F': 'file',
382
'h': 'help',
549
383
'm': 'message',
550
384
'r': 'revision',
551
385
'v': 'verbose',
386
'l': 'long',
552
387
}
553
388
554
# List of options that apply to particular commands; commands not
555
# listed take none.
556
cmd_options = {
557
'add': ['verbose'],
558
'commit': ['message', 'verbose'],
559
'diff': ['revision'],
560
'inventory': ['revision'],
561
'log': ['show-ids', 'timezone'],
562
'ls': ['revision', 'verbose'],
563
'remove': ['verbose'],
564
'status': ['all'],
565
}
566
567
568
cmd_args = {
569
'add': ['file+'],
570
'commit': [],
571
'diff': [],
572
'export': ['revno', 'dest'],
573
'file-id': ['filename'],
574
'get-file-text': ['text_id'],
575
'get-inventory': ['inventory_id'],
576
'get-revision': ['revision_id'],
577
'get-revision-inventory': ['revision_id'],
578
'help': ['topic?'],
579
'init': [],
580
'log': [],
581
'lookup-revision': ['revno'],
582
'relpath': ['filename'],
583
'remove': ['file+'],
584
'root': ['filename?'],
585
'status': [],
586
}
587
588
389
589
390
def parse_args(argv):
590
391
"""Parse command line.
596
397
597
398
>>> parse_args('--help'.split())
598
399
([], {'help': True})
400
>>> parse_args('help -- --invalidcmd'.split())
401
(['help', '--invalidcmd'], {})
599
402
>>> parse_args('--version'.split())
600
403
([], {'version': True})
601
404
>>> parse_args('status --all'.split())
602
405
(['status'], {'all': True})
603
406
>>> parse_args('commit --message=biter'.split())
604
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>]})
605
416
"""
606
417
args = []
607
418
opts = {}
608
419
609
# TODO: Maybe handle '--' to end options?
610
420
argsover = False
611
421
while argv:
612
422
a = argv.pop(0)
613
if a[0] == '-':
423
if not argsover and a[0] == '-':
424
# option names must not be unicode
425
a = str(a)
614
426
optarg = None
615
427
if a[1] == '-':
428
if a == '--':
429
# We've received a standalone -- No more flags
430
argsover = True
431
continue
616
432
mutter(" got option %r" % a)
617
433
if '=' in a:
618
434
optname, optarg = a[2:].split('=', 1)
619
435
else:
620
436
optname = a[2:]
621
437
if optname not in OPTIONS:
622
bailout('unknown long option %r' % a)
438
raise BzrError('unknown long option %r' % a)
623
439
else:
624
440
shortopt = a[1:]
625
if shortopt not in SHORT_OPTIONS:
626
bailout('unknown short option %r' % a)
627
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:]
628
469
629
470
if optname in opts:
630
471
# XXX: Do we ever want to support this, e.g. for -r?
631
bailout('repeated option %r' % a)
472
raise BzrError('repeated option %r' % a)
632
473
633
474
optargfn = OPTIONS[optname]
634
475
if optargfn:
635
476
if optarg == None:
636
477
if not argv:
637
bailout('option %r needs an argument' % a)
478
raise BzrError('option %r needs an argument' % a)
638
479
else:
639
480
optarg = argv.pop(0)
640
481
opts[optname] = optargfn(optarg)
641
mutter(" option argument %r" % opts[optname])
642
482
else:
643
483
if optarg != None:
644
bailout('option %r takes no argument' % optname)
484
raise BzrError('option %r takes no argument' % optname)
645
485
opts[optname] = True
646
486
else:
647
487
args.append(a)
650
490
651
491
652
492
653
def _match_args(cmd, args):
654
"""Check non-option arguments match required pattern.
655
493
656
>>> _match_args('status', ['asdasdsadasd'])
657
Traceback (most recent call last):
658
...
659
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
660
>>> _match_args('add', ['asdasdsadasd'])
661
{'file_list': ['asdasdsadasd']}
662
>>> _match_args('add', 'abc def gj'.split())
663
{'file_list': ['abc', 'def', 'gj']}
664
"""
665
# match argument pattern
666
argform = cmd_args.get(cmd, [])
494
def _match_argform(cmd, takes_args, args):
667
495
argdict = {}
668
# TODO: Need a way to express 'cp SRC... DEST', where it matches
669
# all but one.
670
496
671
# step through args and argform, allowing appropriate 0-many matches
672
for ap in argform:
497
# step through args and takes_args, allowing appropriate 0-many matches
498
for ap in takes_args:
673
499
argname = ap[:-1]
674
500
if ap[-1] == '?':
675
501
if args:
676
502
argdict[argname] = args.pop(0)
677
elif ap[-1] == '*':
678
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
679
509
elif ap[-1] == '+':
680
510
if not args:
681
bailout("command %r needs one or more %s"
511
raise BzrCommandError("command %r needs one or more %s"
682
512
% (cmd, argname.upper()))
683
513
else:
684
514
argdict[argname + '_list'] = args[:]
685
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] = []
686
522
else:
687
523
# just a plain arg
688
524
argname = ap
689
525
if not args:
690
bailout("command %r requires argument %s"
526
raise BzrCommandError("command %r requires argument %s"
691
527
% (cmd, argname.upper()))
692
528
else:
693
529
argdict[argname] = args.pop(0)
694
530
695
531
if args:
696
bailout("extra arguments to command %s: %r"
697
% (cmd, args))
532
raise BzrCommandError("extra argument to command %s: %s"
533
% (cmd, args[0]))
698
534
699
535
return argdict
700
536
701
537
702
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
703
564
def run_bzr(argv):
704
565
"""Execute a command.
705
566
706
567
This is similar to main(), but without all the trappings for
707
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.
708
587
"""
709
try:
710
args, opts = parse_args(argv[1:])
711
if 'help' in opts:
712
# TODO: pass down other arguments in case they asked for
713
# help on a command name?
714
cmd_help()
715
return 0
716
elif 'version' in opts:
717
cmd_version()
718
return 0
719
cmd = args.pop(0)
720
except IndexError:
721
log_error('usage: bzr COMMAND\n')
722
log_error(' try "bzr help"\n')
723
return 1
724
725
try:
726
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
727
except KeyError:
728
bailout("unknown command " + `cmd`)
729
730
# TODO: special --profile option to turn on the Python profiler
731
732
# check options are reasonable
733
allowed = cmd_options.get(cmd, [])
734
for oname in opts:
735
if oname not in allowed:
736
bailout("option %r is not allowed for command %r"
737
% (oname, cmd))
738
739
cmdargs = _match_args(cmd, args)
740
cmdargs.update(opts)
741
742
ret = cmd_handler(**cmdargs) or 0
743
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
744
634
745
635
746
636
def main(argv):
747
## TODO: Handle command-line options; probably know what options are valid for
748
## each command
749
750
## TODO: If the arguments are wrong, give a usage message rather
751
## than just a backtrace.
752
753
bzrlib.trace.create_tracefile(argv)
754
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):
755
645
try:
756
ret = run_bzr(argv)
757
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
758
659
except BzrError, e:
759
log_error('bzr: error: ' + e.args[0] + '\n')
760
if len(e.args) > 1:
761
for h in e.args[1]:
762
log_error(' ' + h + '\n')
660
bzrlib.trace.log_exception()
763
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
764
668
except Exception, e:
765
log_error('bzr: exception: %s\n' % e)
766
log_error(' see .bzr.log for details\n')
767
traceback.print_exc(None, bzrlib.trace._tracefile)
768
traceback.print_exc(None, sys.stderr)
769
return 1
770
771
# TODO: Maybe nicer handling of IOError?
772
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
773
678
774
679
775
680
if __name__ == '__main__':
776
681
sys.exit(main(sys.argv))
777
##import profile
778
##profile.run('main(sys.argv)')
779
Loggerhead is a web-based interface for Breezy
Version: 2.0.1