« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1491
- compare with another revision
- download diff
- download tarball
- view history from revision 1491
- Committer: Robert Collins
- Date: 2005-10-30 00:00:09 UTC
- mfrom: (1185.16.134)
- Revision ID: robertc@robertcollins.net-20051030000009-9db99a338a0dfdac
Merge from Martin.
- files added:
- .bzrignore
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- notes
- patches
- tools
- files removed:
- bzrlib/tests.py
- files renamed:
- bzr.py => bzrlib/commands.py
- bzrlib/store.py => bzrlib/store/__init__.py
- files modified:
- README
added
removed
bzrlib/commands.py
1
#! /usr/bin/python
2
3
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
6
1
# Copyright (C) 2004, 2005 by Canonical Ltd
7
2
8
3
# This program is free software; you can redistribute it and/or modify
9
4
# it under the terms of the GNU General Public License as published by
19
14
# along with this program; if not, write to the Free Software
20
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
16
22
"""Bazaar-NG -- a free distributed version-control tool
23
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
25
26
Current limitation include:
27
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
30
31
* No handling of subdirectories, symlinks or any non-text files.
32
33
* Insufficient error handling.
34
35
* Many commands unimplemented or partially implemented.
36
37
* Space-inefficient storage.
38
39
* No merge operators yet.
40
41
Interesting commands::
42
43
bzr help
44
Show summary help screen
45
bzr version
46
Show software version/licence/non-warranty.
47
bzr init
48
Start versioning the current directory
49
bzr add FILE...
50
Make files versioned.
51
bzr log
52
Show revision history.
53
bzr diff
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
59
bzr status
60
Show summary of pending changes.
61
bzr remove FILE...
62
Make a file not versioned.
63
"""
64
65
# not currently working:
66
# bzr check
67
# Run internal consistency checks.
68
# bzr info
69
# Show some information about this branch.
70
71
72
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
76
__version__ = '0.0.0'
77
78
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
81
from os import path
82
from sets import Set
83
from pprint import pprint
84
from stat import *
85
from glob import glob
86
from ElementTree import Element, ElementTree, SubElement
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
34
import errno
87
35
88
36
import bzrlib
89
from bzrlib.store import ImmutableStore
90
from bzrlib.trace import mutter, note, log_error
91
from bzrlib.errors import bailout, BzrError
92
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
93
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
94
from bzrlib.revision import Revision
95
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
96
format_date
97
98
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
99
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
100
101
## standard representation
102
NONE_STRING = '(none)'
103
EMPTY = 'empty'
104
105
106
## TODO: Perhaps a different version of inventory commands that
107
## returns iterators...
108
109
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
110
111
## TODO: Some kind of locking on branches. Perhaps there should be a
112
## parameter to the branch object saying whether we want a read or
113
## write lock; release it from destructor. Perhaps don't even need a
114
## read lock to look at immutable objects?
115
116
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
117
## to compare output?
118
119
## TODO: Is ElementTree really all that much better for our purposes?
120
## Perhaps using the standard MiniDOM would be enough?
121
122
123
124
125
126
127
######################################################################
128
# check status
129
130
131
def cmd_status(all=False):
132
"""Display status summary.
133
134
For each file there is a single line giving its file state and name.
135
The name is that in the current revision unless it is deleted or
136
missing, in which case the old name is shown.
137
138
:todo: Don't show unchanged files unless ``--all`` is given?
139
"""
140
Branch('.').show_status(show_all=all)
141
142
143
144
######################################################################
145
# examining history
146
def cmd_get_revision(revision_id):
147
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
148
149
150
def cmd_get_inventory(inventory_id):
151
"""Return inventory in XML by hash"""
152
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
153
154
155
def cmd_get_revision_inventory(revision_id):
156
"""Output inventory for a revision."""
157
b = Branch('.')
158
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
159
160
161
def cmd_get_file_text(text_id):
162
"""Get contents of a file by hash."""
163
sf = Branch('.').text_store[text_id]
164
pumpfile(sf, sys.stdout)
165
166
167
168
######################################################################
169
# commands
170
171
172
def cmd_revno():
173
"""Show number of revisions on this branch"""
174
print Branch('.').revno()
175
176
177
def cmd_add(file_list, verbose=False):
178
"""Add specified files.
179
180
Fails if the files are already added.
181
"""
182
Branch('.').add(file_list, verbose=verbose)
183
184
185
def cmd_inventory(revision=None):
186
"""Show inventory of the current working copy."""
187
## TODO: Also optionally show a previous inventory
188
## TODO: Format options
189
b = Branch('.')
190
if revision == None:
191
inv = b.read_working_inventory()
192
else:
193
inv = b.get_revision_inventory(b.lookup_revision(revision))
194
195
for path, entry in inv.iter_entries():
196
print '%-50s %s' % (entry.file_id, path)
197
198
199
200
def cmd_info():
201
b = Branch('.')
202
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
203
print 'revision number:', b.revno()
204
print 'number of versioned files:', len(b.read_working_inventory())
205
206
207
def cmd_remove(file_list, verbose=False):
208
Branch('.').remove(file_list, verbose=verbose)
209
210
211
212
def cmd_file_id(filename):
213
i = Branch('.').read_working_inventory().path2id(filename)
214
if i is None:
215
bailout("%s is not a versioned file" % filename)
216
else:
217
print i
218
219
220
def cmd_find_filename(fileid):
221
n = find_filename(fileid)
222
if n is None:
223
bailout("%s is not a live file id" % fileid)
224
else:
225
print n
226
227
228
def cmd_revision_history():
229
for patchid in Branch('.').revision_history():
230
print patchid
231
232
233
234
def cmd_init():
235
# TODO: Check we're not already in a working directory? At the
236
# moment you'll get an ugly error.
237
238
# TODO: What if we're in a subdirectory of a branch? Would like
239
# to allow that, but then the parent may need to understand that
240
# the children have disappeared, or should they be versioned in
241
# both?
242
243
# TODO: Take an argument/option for branch name.
244
Branch('.', init=True)
245
246
247
def cmd_diff(revision=None):
248
"""Show diff from basis to working copy.
249
250
:todo: Take one or two revision arguments, look up those trees,
251
and diff them.
252
253
:todo: Allow diff across branches.
254
255
:todo: Mangle filenames in diff to be more relevant.
256
257
:todo: Shouldn't be in the cmd function.
258
"""
259
260
b = Branch('.')
261
262
if revision == None:
263
old_tree = b.basis_tree()
264
else:
265
old_tree = b.revision_tree(b.lookup_revision(revision))
266
267
new_tree = b.working_tree()
268
old_inv = old_tree.inventory
269
new_inv = new_tree.inventory
270
271
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
272
old_label = ''
273
new_label = ''
274
275
DEVNULL = '/dev/null'
276
# Windows users, don't panic about this filename -- it is a
277
# special signal to GNU patch that the file should be created or
278
# deleted respectively.
279
280
# TODO: Generation of pseudo-diffs for added/deleted files could
281
# be usefully made into a much faster special case.
282
283
# TODO: Better to return them in sorted order I think.
284
285
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
286
d = None
287
288
# Don't show this by default; maybe do it if an option is passed
289
# idlabel = ' {%s}' % fid
290
idlabel = ''
291
292
# FIXME: Something about the diff format makes patch unhappy
293
# with newly-added files.
294
295
def diffit(*a, **kw):
296
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
297
print
298
299
if file_state in ['.', '?', 'I']:
300
continue
301
elif file_state == 'A':
302
print '*** added %s %r' % (kind, new_name)
303
if kind == 'file':
304
diffit([],
305
new_tree.get_file(fid).readlines(),
306
fromfile=DEVNULL,
307
tofile=new_label + new_name + idlabel)
308
elif file_state == 'D':
309
assert isinstance(old_name, types.StringTypes)
310
print '*** deleted %s %r' % (kind, old_name)
311
if kind == 'file':
312
diffit(old_tree.get_file(fid).readlines(), [],
313
fromfile=old_label + old_name + idlabel,
314
tofile=DEVNULL)
315
elif file_state in ['M', 'R']:
316
if file_state == 'M':
317
assert kind == 'file'
318
assert old_name == new_name
319
print '*** modified %s %r' % (kind, new_name)
320
elif file_state == 'R':
321
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
322
323
if kind == 'file':
324
diffit(old_tree.get_file(fid).readlines(),
325
new_tree.get_file(fid).readlines(),
326
fromfile=old_label + old_name + idlabel,
327
tofile=new_label + new_name)
37
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning
39
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
40
from bzrlib.revisionspec import RevisionSpec
41
from bzrlib import BZRDIR
42
from bzrlib.option import Option
43
44
plugin_cmds = {}
45
46
47
def register_command(cmd):
48
"Utility function to help register a command"
49
global plugin_cmds
50
k = cmd.__name__
51
if k.startswith("cmd_"):
52
k_unsquished = _unsquish_command_name(k)
53
else:
54
k_unsquished = k
55
if not plugin_cmds.has_key(k_unsquished):
56
plugin_cmds[k_unsquished] = cmd
57
mutter('registered plugin command %s', k_unsquished)
58
else:
59
log_error('Two plugins defined the same command: %r' % k)
60
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
61
62
63
def _squish_command_name(cmd):
64
return 'cmd_' + cmd.replace('-', '_')
65
66
67
def _unsquish_command_name(cmd):
68
assert cmd.startswith("cmd_")
69
return cmd[4:].replace('_','-')
70
71
72
def _builtin_commands():
73
import bzrlib.builtins
74
r = {}
75
builtins = bzrlib.builtins.__dict__
76
for name in builtins:
77
if name.startswith("cmd_"):
78
real_name = _unsquish_command_name(name)
79
r[real_name] = builtins[name]
80
return r
81
82
83
84
def builtin_command_names():
85
"""Return list of builtin command names."""
86
return _builtin_commands().keys()
87
88
89
def plugin_command_names():
90
return plugin_cmds.keys()
91
92
93
def _get_cmd_dict(plugins_override=True):
94
"""Return name->class mapping for all commands."""
95
d = _builtin_commands()
96
if plugins_override:
97
d.update(plugin_cmds)
98
return d
99
100
101
def get_all_cmds(plugins_override=True):
102
"""Return canonical name and class for all registered commands."""
103
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
104
yield k,v
105
106
107
def get_cmd_object(cmd_name, plugins_override=True):
108
"""Return the canonical name and command class for a command.
109
110
plugins_override
111
If true, plugin commands can override builtins.
112
"""
113
from bzrlib.externalcommand import ExternalCommand
114
115
cmd_name = str(cmd_name) # not unicode
116
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
try:
120
return cmds[cmd_name]()
121
except KeyError:
122
pass
123
124
# look for any command which claims this as an alias
125
for real_cmd_name, cmd_class in cmds.iteritems():
126
if cmd_name in cmd_class.aliases:
127
return cmd_class()
128
129
cmd_obj = ExternalCommand.find_command(cmd_name)
130
if cmd_obj:
131
return cmd_obj
132
133
raise BzrCommandError("unknown command %r" % cmd_name)
134
135
136
class Command(object):
137
"""Base class for commands.
138
139
Commands are the heart of the command-line bzr interface.
140
141
The command object mostly handles the mapping of command-line
142
parameters into one or more bzrlib operations, and of the results
143
into textual output.
144
145
Commands normally don't have any state. All their arguments are
146
passed in to the run method. (Subclasses may take a different
147
policy if the behaviour of the instance needs to depend on e.g. a
148
shell plugin and not just its Python class.)
149
150
The docstring for an actual command should give a single-line
151
summary, then a complete description of the command. A grammar
152
description will be inserted.
153
154
aliases
155
Other accepted names for this command.
156
157
takes_args
158
List of argument forms, marked with whether they are optional,
159
repeated, etc.
160
161
takes_options
162
List of options that may be given for this command. These can
163
be either strings, referring to globally-defined options,
164
or option objects. Retrieve through options().
165
166
hidden
167
If true, this command isn't advertised. This is typically
168
for commands intended for expert users.
169
"""
170
aliases = []
171
takes_args = []
172
takes_options = []
173
174
hidden = False
175
176
def __init__(self):
177
"""Construct an instance of this command."""
178
if self.__doc__ == Command.__doc__:
179
warn("No help message set for %r" % self)
180
181
def options(self):
182
"""Return dict of valid options for this command.
183
184
Maps from long option name to option object."""
185
r = dict()
186
r['help'] = Option.OPTIONS['help']
187
for o in self.takes_options:
188
if not isinstance(o, Option):
189
o = Option.OPTIONS[o]
190
r[o.name] = o
191
return r
192
193
def run_argv(self, argv):
194
"""Parse command line and run."""
195
args, opts = parse_args(self, argv)
196
if 'help' in opts: # e.g. bzr add --help
197
from bzrlib.help import help_on_command
198
help_on_command(self.name())
199
return 0
200
# XXX: This should be handled by the parser
201
allowed_names = self.options().keys()
202
for oname in opts:
203
if oname not in allowed_names:
204
raise BzrCommandError("option '--%s' is not allowed for command %r"
205
% (oname, self.name()))
206
# mix arguments and options into one dictionary
207
cmdargs = _match_argform(self.name(), self.takes_args, args)
208
cmdopts = {}
209
for k, v in opts.items():
210
cmdopts[k.replace('-', '_')] = v
211
212
all_cmd_args = cmdargs.copy()
213
all_cmd_args.update(cmdopts)
214
215
return self.run(**all_cmd_args)
216
217
def run(self):
218
"""Actually run the command.
219
220
This is invoked with the options and arguments bound to
221
keyword parameters.
222
223
Return 0 or None if the command was successful, or a non-zero
224
shell error code if not. It's OK for this method to allow
225
an exception to raise up.
226
"""
227
raise NotImplementedError()
228
229
230
def help(self):
231
"""Return help message for this class."""
232
if self.__doc__ is Command.__doc__:
233
return None
234
return getdoc(self)
235
236
def name(self):
237
return _unsquish_command_name(self.__class__.__name__)
238
239
240
def parse_spec(spec):
241
"""
242
>>> parse_spec(None)
243
[None, None]
244
>>> parse_spec("./")
245
['./', None]
246
>>> parse_spec("../@")
247
['..', -1]
248
>>> parse_spec("../f/@35")
249
['../f', 35]
250
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
251
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
252
"""
253
if spec is None:
254
return [None, None]
255
if '/@' in spec:
256
parsed = spec.split('/@')
257
assert len(parsed) == 2
258
if parsed[1] == "":
259
parsed[1] = -1
328
260
else:
329
bailout("can't represent state %s {%s}" % (file_state, fid))
330
331
332
333
def cmd_log():
334
"""Show log of this branch.
335
336
:todo: Options for utc; to show ids; to limit range; etc.
337
"""
338
Branch('.').write_log()
339
340
341
def cmd_ls(revision=None, verbose=False):
342
"""List files in a tree.
343
344
:todo: Take a revision or remote path and list that tree instead.
345
"""
346
b = Branch('.')
347
if revision == None:
348
tree = b.working_tree()
349
else:
350
tree = b.revision_tree(b.lookup_revision(revision))
351
352
for fp, fc, kind, fid in tree.list_files():
353
if verbose:
354
if kind == 'directory':
355
kindch = '/'
356
elif kind == 'file':
357
kindch = ''
261
try:
262
parsed[1] = int(parsed[1])
263
except ValueError:
264
pass # We can allow stuff like ./@revid:blahblahblah
358
265
else:
359
kindch = '???'
360
361
print '%-8s %s%s' % (fc, fp, kindch)
362
else:
363
print fp
364
365
366
367
def cmd_unknowns():
368
"""List unknown files"""
369
for f in Branch('.').unknowns():
370
print quotefn(f)
371
372
373
def cmd_lookup_revision(revno):
374
try:
375
revno = int(revno)
376
except ValueError:
377
bailout("usage: lookup-revision REVNO",
378
["REVNO is a non-negative revision number for this branch"])
379
380
print Branch('.').lookup_revision(revno) or NONE_STRING
381
382
383
384
def cmd_export(revno, dest):
385
"""Export past revision to destination directory."""
386
b = Branch('.')
387
rh = b.lookup_revision(int(revno))
388
t = b.revision_tree(rh)
389
t.export(dest)
390
391
392
393
######################################################################
394
# internal/test commands
395
396
397
def cmd_uuid():
398
"""Print a newly-generated UUID."""
399
print uuid()
400
401
402
403
def cmd_commit(message, verbose=False):
404
Branch('.').commit(message, verbose=verbose)
405
406
407
def cmd_check():
408
"""Check consistency of the branch."""
409
check()
410
411
412
def cmd_is(pred, *rest):
413
"""Test whether PREDICATE is true."""
414
try:
415
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
416
except KeyError:
417
bailout("unknown predicate: %s" % quotefn(pred))
418
419
try:
420
cmd_handler(*rest)
421
except BzrCheckError:
422
# by default we don't print the message so that this can
423
# be used from shell scripts without producing noise
424
sys.exit(1)
425
426
427
def cmd_username():
428
print bzrlib.osutils.username()
429
430
431
def cmd_user_email():
432
print bzrlib.osutils.user_email()
433
434
435
def cmd_gen_revision_id():
436
import time
437
print bzrlib.branch._gen_revision_id(time.time())
438
439
440
def cmd_doctest():
441
"""Run internal doctest suite"""
442
## -v, if present, is seen by doctest; the argument is just here
443
## so our parser doesn't complain
444
445
## TODO: --verbose option
446
447
import bzr, doctest, bzrlib.store
448
bzrlib.trace.verbose = False
449
doctest.testmod(bzr)
450
doctest.testmod(bzrlib.store)
451
doctest.testmod(bzrlib.inventory)
452
doctest.testmod(bzrlib.branch)
453
doctest.testmod(bzrlib.osutils)
454
doctest.testmod(bzrlib.tree)
455
456
# more strenuous tests;
457
import bzrlib.tests
458
doctest.testmod(bzrlib.tests)
459
460
461
######################################################################
462
# help
463
464
465
def cmd_help():
466
# TODO: Specific help for particular commands
467
print __doc__
468
469
470
def cmd_version():
471
print "bzr (bazaar-ng) %s" % __version__
472
print __copyright__
473
print "http://bazaar-ng.org/"
474
print
475
print \
476
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
477
you may use, modify and redistribute it under the terms of the GNU
478
General Public License version 2 or later."""
479
480
481
def cmd_rocks():
482
"""Statement of optimism."""
483
print "it sure does!"
484
485
486
487
######################################################################
488
# main routine
489
490
491
# list of all available options; the rhs can be either None for an
492
# option that takes no argument, or a constructor function that checks
493
# the type.
494
OPTIONS = {
495
'all': None,
496
'help': None,
497
'message': unicode,
498
'revision': int,
499
'show-ids': None,
500
'verbose': None,
501
'version': None,
502
}
503
504
SHORT_OPTIONS = {
505
'm': 'message',
506
'r': 'revision',
507
'v': 'verbose',
508
}
509
510
# List of options that apply to particular commands; commands not
511
# listed take none.
512
cmd_options = {
513
'add': ['verbose'],
514
'commit': ['message', 'verbose'],
515
'diff': ['revision'],
516
'inventory': ['revision'],
517
'ls': ['revision', 'verbose'],
518
'status': ['all'],
519
'log': ['show-ids'],
520
'remove': ['verbose'],
521
}
522
523
524
cmd_args = {
525
'init': [],
526
'add': ['file+'],
527
'commit': [],
528
'diff': [],
529
'file-id': ['filename'],
530
'get-file-text': ['text_id'],
531
'get-inventory': ['inventory_id'],
532
'get-revision': ['revision_id'],
533
'get-revision-inventory': ['revision_id'],
534
'log': [],
535
'lookup-revision': ['revno'],
536
'export': ['revno', 'dest'],
537
'remove': ['file+'],
538
'status': [],
539
}
540
541
542
def parse_args(argv):
266
assert parsed[1] >=0
267
else:
268
parsed = [spec, None]
269
return parsed
270
271
def parse_args(command, argv):
543
272
"""Parse command line.
544
273
545
274
Arguments and options are parsed at this level before being passed
546
275
down to specific command handlers. This routine knows, from a
547
276
lookup table, something about the available options, what optargs
548
277
they take, and which commands will accept them.
549
550
>>> parse_args('bzr --help'.split())
551
([], {'help': True})
552
>>> parse_args('bzr --version'.split())
553
([], {'version': True})
554
>>> parse_args('bzr status --all'.split())
555
(['status'], {'all': True})
556
278
"""
279
# TODO: chop up this beast; make it a method of the Command
557
280
args = []
558
281
opts = {}
559
282
560
# TODO: Maybe handle '--' to end options?
561
562
it = iter(argv[1:])
563
while it:
564
a = it.next()
283
cmd_options = command.options()
284
argsover = False
285
while argv:
286
a = argv.pop(0)
287
if argsover:
288
args.append(a)
289
continue
290
elif a == '--':
291
# We've received a standalone -- No more flags
292
argsover = True
293
continue
565
294
if a[0] == '-':
295
# option names must not be unicode
296
a = str(a)
297
optarg = None
566
298
if a[1] == '-':
567
299
mutter(" got option %r" % a)
568
optname = a[2:]
569
if optname not in OPTIONS:
570
bailout('unknown long option %r' % a)
300
if '=' in a:
301
optname, optarg = a[2:].split('=', 1)
302
else:
303
optname = a[2:]
304
if optname not in cmd_options:
305
raise BzrCommandError('unknown long option %r for command %s'
306
% (a, command.name()))
571
307
else:
572
308
shortopt = a[1:]
573
if shortopt not in SHORT_OPTIONS:
574
bailout('unknown short option %r' % a)
575
optname = SHORT_OPTIONS[shortopt]
309
if shortopt in Option.SHORT_OPTIONS:
310
# Multi-character options must have a space to delimit
311
# their value
312
# ^^^ what does this mean? mbp 20051014
313
optname = Option.SHORT_OPTIONS[shortopt].name
314
else:
315
# Single character short options, can be chained,
316
# and have their value appended to their name
317
shortopt = a[1:2]
318
if shortopt not in Option.SHORT_OPTIONS:
319
# We didn't find the multi-character name, and we
320
# didn't find the single char name
321
raise BzrError('unknown short option %r' % a)
322
optname = Option.SHORT_OPTIONS[shortopt].name
323
324
if a[2:]:
325
# There are extra things on this option
326
# see if it is the value, or if it is another
327
# short option
328
optargfn = Option.OPTIONS[optname].type
329
if optargfn is None:
330
# This option does not take an argument, so the
331
# next entry is another short option, pack it back
332
# into the list
333
argv.insert(0, '-' + a[2:])
334
else:
335
# This option takes an argument, so pack it
336
# into the array
337
optarg = a[2:]
576
338
577
339
if optname in opts:
578
340
# XXX: Do we ever want to support this, e.g. for -r?
579
bailout('repeated option %r' % a)
580
optargfn = OPTIONS[optname]
341
raise BzrError('repeated option %r' % a)
342
343
option_obj = cmd_options[optname]
344
optargfn = option_obj.type
581
345
if optargfn:
582
if not it:
583
bailout('option %r needs an argument' % a)
584
opts[optname] = optargfn(it.next())
585
mutter(" option argument %r" % opts[optname])
346
if optarg == None:
347
if not argv:
348
raise BzrError('option %r needs an argument' % a)
349
else:
350
optarg = argv.pop(0)
351
opts[optname] = optargfn(optarg)
586
352
else:
587
# takes no option argument
353
if optarg != None:
354
raise BzrError('option %r takes no argument' % optname)
588
355
opts[optname] = True
589
elif a[:1] == '-':
590
bailout('unknown short option %r' % a)
591
356
else:
592
357
args.append(a)
593
594
358
return args, opts
595
359
596
360
597
598
def _match_args(cmd, args):
599
"""Check non-option arguments match required pattern.
600
601
>>> _match_args('status', ['asdasdsadasd'])
602
Traceback (most recent call last):
603
...
604
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
605
>>> _match_args('add', ['asdasdsadasd'])
606
{'file_list': ['asdasdsadasd']}
607
>>> _match_args('add', 'abc def gj'.split())
608
{'file_list': ['abc', 'def', 'gj']}
609
"""
610
# match argument pattern
611
argform = cmd_args.get(cmd, [])
361
def _match_argform(cmd, takes_args, args):
612
362
argdict = {}
613
# TODO: Need a way to express 'cp SRC... DEST', where it matches
614
# all but one.
615
for ap in argform:
363
364
# step through args and takes_args, allowing appropriate 0-many matches
365
for ap in takes_args:
616
366
argname = ap[:-1]
617
367
if ap[-1] == '?':
618
assert 0
619
elif ap[-1] == '*':
620
assert 0
368
if args:
369
argdict[argname] = args.pop(0)
370
elif ap[-1] == '*': # all remaining arguments
371
if args:
372
argdict[argname + '_list'] = args[:]
373
args = []
374
else:
375
argdict[argname + '_list'] = None
621
376
elif ap[-1] == '+':
622
377
if not args:
623
bailout("command %r needs one or more %s"
378
raise BzrCommandError("command %r needs one or more %s"
624
379
% (cmd, argname.upper()))
625
380
else:
626
381
argdict[argname + '_list'] = args[:]
627
382
args = []
383
elif ap[-1] == '$': # all but one
384
if len(args) < 2:
385
raise BzrCommandError("command %r needs one or more %s"
386
% (cmd, argname.upper()))
387
argdict[argname + '_list'] = args[:-1]
388
args[:-1] = []
628
389
else:
629
390
# just a plain arg
630
391
argname = ap
631
392
if not args:
632
bailout("command %r requires argument %s"
393
raise BzrCommandError("command %r requires argument %s"
633
394
% (cmd, argname.upper()))
634
395
else:
635
396
argdict[argname] = args.pop(0)
636
397
637
398
if args:
638
bailout("extra arguments to command %s: %r"
639
% (cmd, args))
399
raise BzrCommandError("extra argument to command %s: %s"
400
% (cmd, args[0]))
640
401
641
402
return argdict
642
403
643
404
644
405
406
def apply_profiled(the_callable, *args, **kwargs):
407
import hotshot
408
import tempfile
409
import hotshot.stats
410
pffileno, pfname = tempfile.mkstemp()
411
try:
412
prof = hotshot.Profile(pfname)
413
try:
414
ret = prof.runcall(the_callable, *args, **kwargs) or 0
415
finally:
416
prof.close()
417
stats = hotshot.stats.load(pfname)
418
stats.strip_dirs()
419
stats.sort_stats('cum') # 'time'
420
## XXX: Might like to write to stderr or the trace file instead but
421
## print_stats seems hardcoded to stdout
422
stats.print_stats(20)
423
return ret
424
finally:
425
os.close(pffileno)
426
os.remove(pfname)
427
428
645
429
def run_bzr(argv):
646
430
"""Execute a command.
647
431
648
432
This is similar to main(), but without all the trappings for
649
logging and error handling.
433
logging and error handling.
434
435
argv
436
The command-line arguments, without the program name from argv[0]
437
438
Returns a command status or raises an exception.
439
440
Special master options: these must come before the command because
441
they control how the command is interpreted.
442
443
--no-plugins
444
Do not load plugin modules at all
445
446
--builtin
447
Only use builtin commands. (Plugins are still allowed to change
448
other behaviour.)
449
450
--profile
451
Run under the Python profiler.
650
452
"""
651
try:
652
args, opts = parse_args(argv)
653
if 'help' in opts:
654
# TODO: pass down other arguments in case they asked for
655
# help on a command name?
656
cmd_help()
657
return 0
658
elif 'version' in opts:
659
cmd_version()
660
return 0
661
cmd = args.pop(0)
662
except IndexError:
663
log_error('usage: bzr COMMAND\n')
664
log_error(' try "bzr help"\n')
665
return 1
666
667
try:
668
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
669
except KeyError:
670
bailout("unknown command " + `cmd`)
671
672
# TODO: special --profile option to turn on the Python profiler
673
674
# check options are reasonable
675
allowed = cmd_options.get(cmd, [])
676
for oname in opts:
677
if oname not in allowed:
678
bailout("option %r is not allowed for command %r"
679
% (oname, cmd))
680
681
cmdargs = _match_args(cmd, args)
682
cmdargs.update(opts)
683
684
ret = cmd_handler(**cmdargs) or 0
685
686
453
argv = [a.decode(bzrlib.user_encoding) for a in argv]
454
455
opt_profile = opt_no_plugins = opt_builtin = False
456
457
# --no-plugins is handled specially at a very early stage. We need
458
# to load plugins before doing other command parsing so that they
459
# can override commands, but this needs to happen first.
460
461
for a in argv:
462
if a == '--profile':
463
opt_profile = True
464
elif a == '--no-plugins':
465
opt_no_plugins = True
466
elif a == '--builtin':
467
opt_builtin = True
468
else:
469
break
470
argv.remove(a)
471
472
if (not argv) or (argv[0] == '--help'):
473
from bzrlib.help import help
474
if len(argv) > 1:
475
help(argv[1])
476
else:
477
help()
478
return 0
479
480
if argv[0] == '--version':
481
from bzrlib.builtins import show_version
482
show_version()
483
return 0
484
485
if not opt_no_plugins:
486
from bzrlib.plugin import load_plugins
487
load_plugins()
488
489
cmd = str(argv.pop(0))
490
491
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
492
493
if opt_profile:
494
ret = apply_profiled(cmd_obj.run_argv, argv)
495
else:
496
ret = cmd_obj.run_argv(argv)
497
return ret or 0
498
499
def display_command(func):
500
def ignore_pipe(*args, **kwargs):
501
try:
502
return func(*args, **kwargs)
503
except IOError, e:
504
if e.errno != errno.EPIPE:
505
raise
506
except KeyboardInterrupt:
507
pass
508
return ignore_pipe
687
509
688
510
def main(argv):
689
## TODO: Handle command-line options; probably know what options are valid for
690
## each command
691
692
## TODO: If the arguments are wrong, give a usage message rather
693
## than just a backtrace.
694
511
import bzrlib.ui
512
bzrlib.trace.log_startup(argv)
513
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
514
515
return run_bzr_catch_errors(argv[1:])
516
517
518
def run_bzr_catch_errors(argv):
695
519
try:
696
t = bzrlib.trace._tracefile
697
t.write('-' * 60 + '\n')
698
t.write('bzr invoked at %s\n' % format_date(time.time()))
699
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
700
t.write(' arguments: %r\n' % argv)
701
702
starttime = os.times()[4]
703
704
import platform
705
t.write(' platform: %s\n' % platform.platform())
706
t.write(' python: %s\n' % platform.python_version())
707
708
ret = run_bzr(argv)
709
710
times = os.times()
711
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
712
% times[:4])
713
mutter(" %.3f elapsed" % (times[4] - starttime))
714
715
return ret
520
try:
521
return run_bzr(argv)
522
finally:
523
# do this here inside the exception wrappers to catch EPIPE
524
sys.stdout.flush()
525
except BzrCommandError, e:
526
# command line syntax error, etc
527
log_error(str(e))
528
return 1
716
529
except BzrError, e:
717
log_error('bzr: error: ' + e.args[0] + '\n')
718
if len(e.args) > 1:
719
for h in e.args[1]:
720
log_error(' ' + h + '\n')
530
bzrlib.trace.log_exception()
721
531
return 1
532
except AssertionError, e:
533
bzrlib.trace.log_exception('assertion failed: ' + str(e))
534
return 3
535
except KeyboardInterrupt, e:
536
bzrlib.trace.log_exception('interrupted')
537
return 2
722
538
except Exception, e:
723
log_error('bzr: exception: %s\n' % e)
724
log_error(' see .bzr.log for details\n')
725
traceback.print_exc(None, bzrlib.trace._tracefile)
726
traceback.print_exc(None, sys.stderr)
727
return 1
728
729
# TODO: Maybe nicer handling of IOError?
730
731
539
import errno
540
if (isinstance(e, IOError)
541
and hasattr(e, 'errno')
542
and e.errno == errno.EPIPE):
543
bzrlib.trace.note('broken pipe')
544
return 2
545
else:
546
## import pdb
547
## pdb.pm()
548
bzrlib.trace.log_exception()
549
return 2
732
550
733
551
if __name__ == '__main__':
734
552
sys.exit(main(sys.argv))
735
##import profile
736
##profile.run('main(sys.argv)')
737
Loggerhead is a web-based interface for Breezy
Version: 2.0.1