« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1185.56.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.56.1
- Committer: Michael Ellerman
- Date: 2005-12-10 22:11:13 UTC
- mto: This revision was merged to the branch mainline in revision 1528.
- Revision ID: michael@ellerman.id.au-20051210221113-99ca561aaab4661e
Simplify handling of DivergedBranches in cmd_pull()
- files added:
- .bzrignore
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- 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, be_quiet
39
from bzrlib.errors import (BzrError,
40
BzrCheckError,
41
BzrCommandError,
42
BzrOptionError,
43
NotBranchError)
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
46
from bzrlib.option import Option
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd, decorate=False):
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
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
64
elif decorate:
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
67
return result
68
else:
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
71
72
73
def _squish_command_name(cmd):
74
return 'cmd_' + cmd.replace('-', '_')
75
76
77
def _unsquish_command_name(cmd):
78
assert cmd.startswith("cmd_")
79
return cmd[4:].replace('_','-')
80
81
82
def _builtin_commands():
83
import bzrlib.builtins
84
r = {}
85
builtins = bzrlib.builtins.__dict__
86
for name in builtins:
87
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
90
return r
91
92
93
94
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
97
98
99
def plugin_command_names():
100
return plugin_cmds.keys()
101
102
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
106
if plugins_override:
107
d.update(plugin_cmds)
108
return d
109
110
111
def get_all_cmds(plugins_override=True):
112
"""Return canonical name and class for all registered commands."""
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
114
yield k,v
115
116
117
def get_cmd_object(cmd_name, plugins_override=True):
118
"""Return the canonical name and command class for a command.
119
120
plugins_override
121
If true, plugin commands can override builtins.
122
"""
123
from bzrlib.externalcommand import ExternalCommand
124
125
cmd_name = str(cmd_name) # not unicode
126
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
129
try:
130
return cmds[cmd_name]()
131
except KeyError:
132
pass
133
134
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
137
return cmd_class()
138
139
cmd_obj = ExternalCommand.find_command(cmd_name)
140
if cmd_obj:
141
return cmd_obj
142
143
raise BzrCommandError("unknown command %r" % cmd_name)
144
145
146
class Command(object):
147
"""Base class for commands.
148
149
Commands are the heart of the command-line bzr interface.
150
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
153
into textual output.
154
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
159
160
The docstring for an actual command should give a single-line
161
summary, then a complete description of the command. A grammar
162
description will be inserted.
163
164
aliases
165
Other accepted names for this command.
166
167
takes_args
168
List of argument forms, marked with whether they are optional,
169
repeated, etc.
170
171
Examples:
172
173
['to_location', 'from_branch?', 'file*']
174
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
178
179
takes_options
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
183
184
hidden
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
187
"""
188
aliases = []
189
takes_args = []
190
takes_options = []
191
192
hidden = False
193
194
def __init__(self):
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
198
199
def options(self):
200
"""Return dict of valid options for this command.
201
202
Maps from long option name to option object."""
203
r = dict()
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
208
r[o.name] = o
209
return r
210
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
217
return 0
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
220
for oname in opts:
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
226
cmdopts = {}
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
229
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
232
233
return self.run(**all_cmd_args)
234
235
def run(self):
236
"""Actually run the command.
237
238
This is invoked with the options and arguments bound to
239
keyword parameters.
240
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
244
"""
245
raise NotImplementedError()
246
247
248
def help(self):
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
251
return None
252
return getdoc(self)
253
254
def name(self):
255
return _unsquish_command_name(self.__class__.__name__)
256
257
258
def parse_spec(spec):
259
"""
260
>>> parse_spec(None)
261
[None, None]
262
>>> parse_spec("./")
263
['./', None]
264
>>> parse_spec("../@")
265
['..', -1]
266
>>> parse_spec("../f/@35")
267
['../f', 35]
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
270
"""
271
if spec is None:
272
return [None, None]
273
if '/@' in spec:
274
parsed = spec.split('/@')
275
assert len(parsed) == 2
276
if parsed[1] == "":
277
parsed[1] = -1
328
278
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 = ''
279
try:
280
parsed[1] = int(parsed[1])
281
except ValueError:
282
pass # We can allow stuff like ./@revid:blahblahblah
358
283
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):
284
assert parsed[1] >=0
285
else:
286
parsed = [spec, None]
287
return parsed
288
289
def parse_args(command, argv):
543
290
"""Parse command line.
544
291
545
292
Arguments and options are parsed at this level before being passed
546
293
down to specific command handlers. This routine knows, from a
547
294
lookup table, something about the available options, what optargs
548
295
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
296
"""
297
# TODO: chop up this beast; make it a method of the Command
557
298
args = []
558
299
opts = {}
559
300
560
# TODO: Maybe handle '--' to end options?
561
562
it = iter(argv[1:])
563
while it:
564
a = it.next()
301
cmd_options = command.options()
302
argsover = False
303
while argv:
304
a = argv.pop(0)
305
if argsover:
306
args.append(a)
307
continue
308
elif a == '--':
309
# We've received a standalone -- No more flags
310
argsover = True
311
continue
565
312
if a[0] == '-':
313
# option names must not be unicode
314
a = str(a)
315
optarg = None
566
316
if a[1] == '-':
567
mutter(" got option %r" % a)
568
optname = a[2:]
569
if optname not in OPTIONS:
570
bailout('unknown long option %r' % a)
317
mutter(" got option %r", a)
318
if '=' in a:
319
optname, optarg = a[2:].split('=', 1)
320
else:
321
optname = a[2:]
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
571
325
else:
572
326
shortopt = a[1:]
573
if shortopt not in SHORT_OPTIONS:
574
bailout('unknown short option %r' % a)
575
optname = SHORT_OPTIONS[shortopt]
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
329
# their value
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
332
else:
333
# Single character short options, can be chained,
334
# and have their value appended to their name
335
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
341
342
if a[2:]:
343
# There are extra things on this option
344
# see if it is the value, or if it is another
345
# short option
346
optargfn = Option.OPTIONS[optname].type
347
if optargfn is None:
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
350
# into the list
351
argv.insert(0, '-' + a[2:])
352
else:
353
# This option takes an argument, so pack it
354
# into the array
355
optarg = a[2:]
576
356
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
577
360
if optname in opts:
578
361
# XXX: Do we ever want to support this, e.g. for -r?
579
bailout('repeated option %r' % a)
580
optargfn = OPTIONS[optname]
362
raise BzrError('repeated option %r' % a)
363
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
581
366
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])
367
if optarg == None:
368
if not argv:
369
raise BzrError('option %r needs an argument' % a)
370
else:
371
optarg = argv.pop(0)
372
opts[optname] = optargfn(optarg)
586
373
else:
587
# takes no option argument
374
if optarg != None:
375
raise BzrError('option %r takes no argument' % optname)
588
376
opts[optname] = True
589
elif a[:1] == '-':
590
bailout('unknown short option %r' % a)
591
377
else:
592
378
args.append(a)
593
594
379
return args, opts
595
380
596
381
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, [])
382
def _match_argform(cmd, takes_args, args):
612
383
argdict = {}
613
# TODO: Need a way to express 'cp SRC... DEST', where it matches
614
# all but one.
615
for ap in argform:
384
385
# step through args and takes_args, allowing appropriate 0-many matches
386
for ap in takes_args:
616
387
argname = ap[:-1]
617
388
if ap[-1] == '?':
618
assert 0
619
elif ap[-1] == '*':
620
assert 0
389
if args:
390
argdict[argname] = args.pop(0)
391
elif ap[-1] == '*': # all remaining arguments
392
if args:
393
argdict[argname + '_list'] = args[:]
394
args = []
395
else:
396
argdict[argname + '_list'] = None
621
397
elif ap[-1] == '+':
622
398
if not args:
623
bailout("command %r needs one or more %s"
399
raise BzrCommandError("command %r needs one or more %s"
624
400
% (cmd, argname.upper()))
625
401
else:
626
402
argdict[argname + '_list'] = args[:]
627
403
args = []
404
elif ap[-1] == '$': # all but one
405
if len(args) < 2:
406
raise BzrCommandError("command %r needs one or more %s"
407
% (cmd, argname.upper()))
408
argdict[argname + '_list'] = args[:-1]
409
args[:-1] = []
628
410
else:
629
411
# just a plain arg
630
412
argname = ap
631
413
if not args:
632
bailout("command %r requires argument %s"
414
raise BzrCommandError("command %r requires argument %s"
633
415
% (cmd, argname.upper()))
634
416
else:
635
417
argdict[argname] = args.pop(0)
636
418
637
419
if args:
638
bailout("extra arguments to command %s: %r"
639
% (cmd, args))
420
raise BzrCommandError("extra argument to command %s: %s"
421
% (cmd, args[0]))
640
422
641
423
return argdict
642
424
643
425
644
426
427
def apply_profiled(the_callable, *args, **kwargs):
428
import hotshot
429
import tempfile
430
import hotshot.stats
431
pffileno, pfname = tempfile.mkstemp()
432
try:
433
prof = hotshot.Profile(pfname)
434
try:
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
436
finally:
437
prof.close()
438
stats = hotshot.stats.load(pfname)
439
stats.strip_dirs()
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
444
return ret
445
finally:
446
os.close(pffileno)
447
os.remove(pfname)
448
449
645
450
def run_bzr(argv):
646
451
"""Execute a command.
647
452
648
453
This is similar to main(), but without all the trappings for
649
logging and error handling.
454
logging and error handling.
455
456
argv
457
The command-line arguments, without the program name from argv[0]
458
459
Returns a command status or raises an exception.
460
461
Special master options: these must come before the command because
462
they control how the command is interpreted.
463
464
--no-plugins
465
Do not load plugin modules at all
466
467
--builtin
468
Only use builtin commands. (Plugins are still allowed to change
469
other behaviour.)
470
471
--profile
472
Run under the Python profiler.
650
473
"""
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
474
argv = [a.decode(bzrlib.user_encoding) for a in argv]
475
476
opt_profile = opt_no_plugins = opt_builtin = False
477
478
# --no-plugins is handled specially at a very early stage. We need
479
# to load plugins before doing other command parsing so that they
480
# can override commands, but this needs to happen first.
481
482
for a in argv:
483
if a == '--profile':
484
opt_profile = True
485
elif a == '--no-plugins':
486
opt_no_plugins = True
487
elif a == '--builtin':
488
opt_builtin = True
489
elif a in ('--quiet', '-q'):
490
be_quiet()
491
else:
492
continue
493
argv.remove(a)
494
495
if (not argv) or (argv[0] == '--help'):
496
from bzrlib.help import help
497
if len(argv) > 1:
498
help(argv[1])
499
else:
500
help()
501
return 0
502
503
if argv[0] == '--version':
504
from bzrlib.builtins import show_version
505
show_version()
506
return 0
507
508
if not opt_no_plugins:
509
from bzrlib.plugin import load_plugins
510
load_plugins()
511
512
cmd = str(argv.pop(0))
513
514
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
515
516
try:
517
if opt_profile:
518
ret = apply_profiled(cmd_obj.run_argv, argv)
519
else:
520
ret = cmd_obj.run_argv(argv)
521
return ret or 0
522
finally:
523
# reset, in case we may do other commands later within the same process
524
be_quiet(False)
525
526
def display_command(func):
527
"""Decorator that suppresses pipe/interrupt errors."""
528
def ignore_pipe(*args, **kwargs):
529
try:
530
result = func(*args, **kwargs)
531
sys.stdout.flush()
532
return result
533
except IOError, e:
534
if not hasattr(e, 'errno'):
535
raise
536
if e.errno != errno.EPIPE:
537
raise
538
pass
539
except KeyboardInterrupt:
540
pass
541
return ignore_pipe
686
542
687
543
688
544
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
545
import bzrlib.ui
546
from bzrlib.ui.text import TextUIFactory
547
## bzrlib.trace.enable_default_logging()
548
bzrlib.trace.log_startup(argv)
549
bzrlib.ui.ui_factory = TextUIFactory()
550
ret = run_bzr_catch_errors(argv[1:])
551
mutter("return code %d", ret)
552
return ret
553
554
555
def run_bzr_catch_errors(argv):
695
556
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
716
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')
721
return 1
557
try:
558
return run_bzr(argv)
559
finally:
560
# do this here inside the exception wrappers to catch EPIPE
561
sys.stdout.flush()
722
562
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
563
# used to handle AssertionError and KeyboardInterrupt
564
# specially here, but hopefully they're handled ok by the logger now
565
import errno
566
if (isinstance(e, IOError)
567
and hasattr(e, 'errno')
568
and e.errno == errno.EPIPE):
569
bzrlib.trace.note('broken pipe')
570
return 3
571
else:
572
bzrlib.trace.log_exception()
573
if os.environ.get('BZR_PDB'):
574
print '**** entering debugger'
575
import pdb
576
pdb.post_mortem(sys.exc_traceback)
577
return 3
732
578
733
579
if __name__ == '__main__':
734
580
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