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