1
# Copyright (C) 2006 by Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
13
# GNU General Public License for more details.
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
33
from warnings import warn
19
"""Bazaar-NG -- a free distributed version-control tool
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
69
from pprint import pprint
37
from bzrlib.errors import (BzrError,
42
from bzrlib.option import Option
43
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.symbol_versioning import *
46
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
51
def register_command(cmd, decorate=False):
52
"""Utility function to help register a command
54
:param cmd: Command subclass to register
55
:param decorate: If true, allow overriding an existing command
56
of the same name; the old command is returned by this function.
57
Otherwise it is an error to try to override an existing command.
61
if k.startswith("cmd_"):
62
k_unsquished = _unsquish_command_name(k)
65
if not plugin_cmds.has_key(k_unsquished):
66
plugin_cmds[k_unsquished] = cmd
67
mutter('registered plugin command %s', k_unsquished)
68
if decorate and k_unsquished in builtin_command_names():
69
return _builtin_commands()[k_unsquished]
71
result = plugin_cmds[k_unsquished]
72
plugin_cmds[k_unsquished] = cmd
75
log_error('Two plugins defined the same command: %r' % k)
76
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
79
def _squish_command_name(cmd):
80
return 'cmd_' + cmd.replace('-', '_')
83
def _unsquish_command_name(cmd):
84
assert cmd.startswith("cmd_")
85
return cmd[4:].replace('_','-')
88
def _builtin_commands():
89
import bzrlib.builtins
91
builtins = bzrlib.builtins.__dict__
93
if name.startswith("cmd_"):
94
real_name = _unsquish_command_name(name)
95
r[real_name] = builtins[name]
99
def builtin_command_names():
100
"""Return list of builtin command names."""
101
return _builtin_commands().keys()
104
def plugin_command_names():
105
return plugin_cmds.keys()
108
def _get_cmd_dict(plugins_override=True):
109
"""Return name->class mapping for all commands."""
110
d = _builtin_commands()
112
d.update(plugin_cmds)
116
def get_all_cmds(plugins_override=True):
117
"""Return canonical name and class for all registered commands."""
118
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
122
def get_cmd_object(cmd_name, plugins_override=True):
123
"""Return the canonical name and command class for a command.
126
If true, plugin commands can override builtins.
128
from bzrlib.externalcommand import ExternalCommand
130
cmd_name = str(cmd_name) # not unicode
132
# first look up this command under the specified name
133
cmds = _get_cmd_dict(plugins_override=plugins_override)
135
return cmds[cmd_name]()
139
# look for any command which claims this as an alias
140
for real_cmd_name, cmd_class in cmds.iteritems():
141
if cmd_name in cmd_class.aliases:
144
cmd_obj = ExternalCommand.find_command(cmd_name)
148
raise BzrCommandError("unknown command %r" % cmd_name)
151
class Command(object):
152
"""Base class for commands.
154
Commands are the heart of the command-line bzr interface.
156
The command object mostly handles the mapping of command-line
157
parameters into one or more bzrlib operations, and of the results
160
Commands normally don't have any state. All their arguments are
161
passed in to the run method. (Subclasses may take a different
162
policy if the behaviour of the instance needs to depend on e.g. a
163
shell plugin and not just its Python class.)
165
The docstring for an actual command should give a single-line
166
summary, then a complete description of the command. A grammar
167
description will be inserted.
170
Other accepted names for this command.
173
List of argument forms, marked with whether they are optional,
178
['to_location', 'from_branch?', 'file*']
180
'to_location' is required
181
'from_branch' is optional
182
'file' can be specified 0 or more times
185
List of options that may be given for this command. These can
186
be either strings, referring to globally-defined options,
187
or option objects. Retrieve through options().
190
If true, this command isn't advertised. This is typically
191
for commands intended for expert users.
200
"""Construct an instance of this command."""
201
if self.__doc__ == Command.__doc__:
202
warn("No help message set for %r" % self)
205
"""Return dict of valid options for this command.
207
Maps from long option name to option object."""
209
r['help'] = Option.OPTIONS['help']
210
for o in self.takes_options:
211
if not isinstance(o, Option):
212
o = Option.OPTIONS[o]
216
@deprecated_method(zero_eight)
217
def run_argv(self, argv):
218
"""Parse command line and run.
220
See run_argv_aliases for the 0.8 and beyond api.
222
return self.run_argv_aliases(argv)
224
def run_argv_aliases(self, argv, alias_argv=None):
225
"""Parse the command line and run with extra aliases in alias_argv."""
226
args, opts = parse_args(self, argv, alias_argv)
227
if 'help' in opts: # e.g. bzr add --help
228
from bzrlib.help import help_on_command
229
help_on_command(self.name())
231
# XXX: This should be handled by the parser
232
allowed_names = self.options().keys()
234
if oname not in allowed_names:
235
raise BzrCommandError("option '--%s' is not allowed for"
236
" command %r" % (oname, self.name()))
237
# mix arguments and options into one dictionary
238
cmdargs = _match_argform(self.name(), self.takes_args, args)
240
for k, v in opts.items():
241
cmdopts[k.replace('-', '_')] = v
243
all_cmd_args = cmdargs.copy()
244
all_cmd_args.update(cmdopts)
246
return self.run(**all_cmd_args)
249
"""Actually run the command.
251
This is invoked with the options and arguments bound to
254
Return 0 or None if the command was successful, or a non-zero
255
shell error code if not. It's OK for this method to allow
256
an exception to raise up.
258
raise NotImplementedError('no implementation of command %r'
262
"""Return help message for this class."""
263
from inspect import getdoc
264
if self.__doc__ is Command.__doc__:
269
return _unsquish_command_name(self.__class__.__name__)
272
def parse_spec(spec):
278
>>> parse_spec("../@")
280
>>> parse_spec("../f/@35")
282
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
283
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
288
parsed = spec.split('/@')
289
assert len(parsed) == 2
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
113
## TODO: move command; check destination is a directory and will not
116
## TODO: command to show renames, one per line, as to->from
121
def cmd_status(all=False):
122
"""Display status summary.
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
128
:todo: Don't show unchanged files unless ``--all`` is given?
130
Branch('.').show_status(show_all=all)
134
######################################################################
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
147
######################################################################
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
175
bzrlib.add.smart_add(file_list, verbose)
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
200
info.show_info(Branch('.'))
204
def cmd_remove(file_list, verbose=False):
205
b = Branch(file_list[0])
206
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
def cmd_file_id(filename):
212
i = b.inventory.path2id(b.relpath(filename))
214
bailout("%s is not a versioned file" % filename)
219
def cmd_find_filename(fileid):
220
n = find_filename(fileid)
222
bailout("%s is not a live file id" % fileid)
227
def cmd_revision_history():
228
for patchid in Branch('.').revision_history():
234
# TODO: Check we're not already in a working directory? At the
235
# moment you'll get an ugly error.
237
# TODO: What if we're in a subdirectory of a branch? Would like
238
# to allow that, but then the parent may need to understand that
239
# the children have disappeared, or should they be versioned in
242
# TODO: Take an argument/option for branch name.
243
Branch('.', init=True)
246
def cmd_diff(revision=None):
247
"""bzr diff: Show differences in working tree.
249
usage: bzr diff [-r REV]
252
Show changes since REV, rather than predecessor.
254
TODO: Given two revision arguments, show the difference between them.
256
TODO: Allow diff across branches.
258
TODO: Option to use external diff command; could be GNU diff, wdiff,
261
TODO: Diff selected files.
264
## TODO: Shouldn't be in the cmd function.
269
old_tree = b.basis_tree()
271
old_tree = b.revision_tree(b.lookup_revision(revision))
273
new_tree = b.working_tree()
274
old_inv = old_tree.inventory
275
new_inv = new_tree.inventory
277
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
281
DEVNULL = '/dev/null'
282
# Windows users, don't panic about this filename -- it is a
283
# special signal to GNU patch that the file should be created or
284
# deleted respectively.
286
# TODO: Generation of pseudo-diffs for added/deleted files could
287
# be usefully made into a much faster special case.
289
# TODO: Better to return them in sorted order I think.
291
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
294
# Don't show this by default; maybe do it if an option is passed
295
# idlabel = ' {%s}' % fid
298
# FIXME: Something about the diff format makes patch unhappy
299
# with newly-added files.
301
def diffit(*a, **kw):
302
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
305
if file_state in ['.', '?', 'I']:
307
elif file_state == 'A':
308
print '*** added %s %r' % (kind, new_name)
311
new_tree.get_file(fid).readlines(),
313
tofile=new_label + new_name + idlabel)
314
elif file_state == 'D':
315
assert isinstance(old_name, types.StringTypes)
316
print '*** deleted %s %r' % (kind, old_name)
318
diffit(old_tree.get_file(fid).readlines(), [],
319
fromfile=old_label + old_name + idlabel,
321
elif file_state in ['M', 'R']:
322
if file_state == 'M':
323
assert kind == 'file'
324
assert old_name == new_name
325
print '*** modified %s %r' % (kind, new_name)
326
elif file_state == 'R':
327
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
330
diffit(old_tree.get_file(fid).readlines(),
331
new_tree.get_file(fid).readlines(),
332
fromfile=old_label + old_name + idlabel,
333
tofile=new_label + new_name)
294
parsed[1] = int(parsed[1])
296
pass # We can allow stuff like ./@revid:blahblahblah
335
bailout("can't represent state %s {%s}" % (file_state, fid))
339
def cmd_root(filename=None):
340
"""Print the branch root."""
341
print bzrlib.branch.find_branch_root(filename)
344
def cmd_log(timezone='original'):
345
"""Show log of this branch.
347
:todo: Options for utc; to show ids; to limit range; etc.
349
Branch('.').write_log(show_timezone=timezone)
352
def cmd_ls(revision=None, verbose=False):
353
"""List files in a tree.
355
:todo: Take a revision or remote path and list that tree instead.
359
tree = b.working_tree()
361
tree = b.revision_tree(b.lookup_revision(revision))
363
for fp, fc, kind, fid in tree.list_files():
365
if kind == 'directory':
372
print '%-8s %s%s' % (fc, fp, kindch)
379
"""List unknown files"""
380
for f in Branch('.').unknowns():
384
def cmd_lookup_revision(revno):
388
bailout("usage: lookup-revision REVNO",
389
["REVNO is a non-negative revision number for this branch"])
391
print Branch('.').lookup_revision(revno) or NONE_STRING
395
def cmd_export(revno, dest):
396
"""Export past revision to destination directory."""
398
rh = b.lookup_revision(int(revno))
399
t = b.revision_tree(rh)
404
######################################################################
405
# internal/test commands
409
"""Print a newly-generated UUID."""
410
print bzrlib.osutils.uuid()
414
def cmd_local_time_offset():
415
print bzrlib.osutils.local_time_offset()
419
def cmd_commit(message=None, verbose=False):
420
"""Commit changes to a new revision.
423
Description of changes in this revision; free form text.
424
It is recommended that the first line be a single-sentence
427
Show status of changed files,
429
TODO: Commit only selected files.
431
TODO: Run hooks on tree to-be-committed, and after commit.
433
TODO: Strict commit that fails if there are unknown or deleted files.
437
bailout("please specify a commit message")
438
Branch('.').commit(message, verbose=verbose)
442
"""Check consistency of the branch."""
446
def cmd_is(pred, *rest):
447
"""Test whether PREDICATE is true."""
449
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
451
bailout("unknown predicate: %s" % quotefn(pred))
455
except BzrCheckError:
456
# by default we don't print the message so that this can
457
# be used from shell scripts without producing noise
462
print bzrlib.osutils.username()
465
def cmd_user_email():
466
print bzrlib.osutils.user_email()
469
def cmd_gen_revision_id():
471
print bzrlib.branch._gen_revision_id(time.time())
474
def cmd_selftest(verbose=False):
475
"""Run internal test suite"""
476
## -v, if present, is seen by doctest; the argument is just here
477
## so our parser doesn't complain
479
## TODO: --verbose option
481
failures, tests = 0, 0
483
import doctest, bzrlib.store, bzrlib.tests
484
bzrlib.trace.verbose = False
486
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
487
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
488
mf, mt = doctest.testmod(m)
491
print '%-40s %3d tests' % (m.__name__, mt),
493
print '%3d FAILED!' % mf
497
print '%-40s %3d tests' % ('total', tests),
499
print '%3d FAILED!' % failures
300
parsed = [spec, None]
303
def parse_args(command, argv, alias_argv=None):
506
cmd_doctest = cmd_selftest
509
######################################################################
513
def cmd_help(topic=None):
518
# otherwise, maybe the name of a command?
520
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
522
bailout("no help for %r" % topic)
526
bailout("sorry, no detailed help yet for %r" % topic)
534
print "bzr (bazaar-ng) %s" % bzrlib.__version__
535
print bzrlib.__copyright__
536
print "http://bazaar-ng.org/"
539
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
540
you may use, modify and redistribute it under the terms of the GNU
541
General Public License version 2 or later."""
545
"""Statement of optimism."""
546
print "it sure does!"
550
######################################################################
554
# list of all available options; the rhs can be either None for an
555
# option that takes no argument, or a constructor function that checks
574
# List of options that apply to particular commands; commands not
578
'commit': ['message', 'verbose'],
579
'diff': ['revision'],
580
'inventory': ['revision'],
581
'log': ['show-ids', 'timezone'],
582
'ls': ['revision', 'verbose'],
583
'remove': ['verbose'],
592
'export': ['revno', 'dest'],
593
'file-id': ['filename'],
594
'get-file-text': ['text_id'],
595
'get-inventory': ['inventory_id'],
596
'get-revision': ['revision_id'],
597
'get-revision-inventory': ['revision_id'],
601
'lookup-revision': ['revno'],
602
'relpath': ['filename'],
604
'root': ['filename?'],
609
def parse_args(argv):
304
610
"""Parse command line.
306
612
Arguments and options are parsed at this level before being passed
307
613
down to specific command handlers. This routine knows, from a
308
614
lookup table, something about the available options, what optargs
309
615
they take, and which commands will accept them.
617
>>> parse_args('--help'.split())
619
>>> parse_args('--version'.split())
620
([], {'version': True})
621
>>> parse_args('status --all'.split())
622
(['status'], {'all': True})
623
>>> parse_args('commit --message=biter'.split())
624
(['commit'], {'message': u'biter'})
311
# TODO: chop up this beast; make it a method of the Command
316
cmd_options = command.options()
318
proc_aliasarg = True # Are we processing alias_argv now?
319
for proc_argv in alias_argv, argv:
326
# We've received a standalone -- No more flags
330
# option names must not be unicode
334
mutter(" got option %r", a)
336
optname, optarg = a[2:].split('=', 1)
339
if optname not in cmd_options:
340
raise BzrOptionError('unknown long option %r for'
629
# TODO: Maybe handle '--' to end options?
636
mutter(" got option %r" % a)
638
optname, optarg = a[2:].split('=', 1)
345
if shortopt in Option.SHORT_OPTIONS:
346
# Multi-character options must have a space to delimit
348
# ^^^ what does this mean? mbp 20051014
349
optname = Option.SHORT_OPTIONS[shortopt].name
351
# Single character short options, can be chained,
352
# and have their value appended to their name
354
if shortopt not in Option.SHORT_OPTIONS:
355
# We didn't find the multi-character name, and we
356
# didn't find the single char name
357
raise BzrError('unknown short option %r' % a)
358
optname = Option.SHORT_OPTIONS[shortopt].name
361
# There are extra things on this option
362
# see if it is the value, or if it is another
364
optargfn = Option.OPTIONS[optname].type
366
# This option does not take an argument, so the
367
# next entry is another short option, pack it
369
proc_argv.insert(0, '-' + a[2:])
371
# This option takes an argument, so pack it
641
if optname not in OPTIONS:
642
bailout('unknown long option %r' % a)
645
if shortopt not in SHORT_OPTIONS:
646
bailout('unknown short option %r' % a)
647
optname = SHORT_OPTIONS[shortopt]
650
# XXX: Do we ever want to support this, e.g. for -r?
651
bailout('repeated option %r' % a)
375
if optname not in cmd_options:
376
raise BzrOptionError('unknown short option %r for'
378
(shortopt, command.name()))
380
# XXX: Do we ever want to support this, e.g. for -r?
382
raise BzrError('repeated option %r' % a)
383
elif optname in alias_opts:
384
# Replace what's in the alias with what's in the real
386
del alias_opts[optname]
388
proc_argv.insert(0, a)
653
optargfn = OPTIONS[optname]
657
bailout('option %r needs an argument' % a)
391
raise BzrError('repeated option %r' % a)
393
option_obj = cmd_options[optname]
394
optargfn = option_obj.type
398
raise BzrError('option %r needs an argument' % a)
400
optarg = proc_argv.pop(0)
401
opts[optname] = optargfn(optarg)
403
alias_opts[optname] = optargfn(optarg)
406
raise BzrError('option %r takes no argument' % optname)
409
alias_opts[optname] = True
660
opts[optname] = optargfn(optarg)
661
mutter(" option argument %r" % opts[optname])
412
proc_aliasarg = False # Done with alias argv
664
bailout('option %r takes no argument' % optname)
413
669
return args, opts
416
def _match_argform(cmd, takes_args, args):
673
def _match_args(cmd, args):
674
"""Check non-option arguments match required pattern.
676
>>> _match_args('status', ['asdasdsadasd'])
677
Traceback (most recent call last):
679
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
680
>>> _match_args('add', ['asdasdsadasd'])
681
{'file_list': ['asdasdsadasd']}
682
>>> _match_args('add', 'abc def gj'.split())
683
{'file_list': ['abc', 'def', 'gj']}
685
# match argument pattern
686
argform = cmd_args.get(cmd, [])
688
# TODO: Need a way to express 'cp SRC... DEST', where it matches
419
# step through args and takes_args, allowing appropriate 0-many matches
420
for ap in takes_args:
691
# step through args and argform, allowing appropriate 0-many matches
421
693
argname = ap[:-1]
422
694
if ap[-1] == '?':
424
696
argdict[argname] = args.pop(0)
425
elif ap[-1] == '*': # all remaining arguments
427
argdict[argname + '_list'] = args[:]
430
argdict[argname + '_list'] = None
431
699
elif ap[-1] == '+':
433
raise BzrCommandError("command %r needs one or more %s"
701
bailout("command %r needs one or more %s"
434
702
% (cmd, argname.upper()))
436
704
argdict[argname + '_list'] = args[:]
438
elif ap[-1] == '$': # all but one
440
raise BzrCommandError("command %r needs one or more %s"
441
% (cmd, argname.upper()))
442
argdict[argname + '_list'] = args[:-1]
445
707
# just a plain arg
448
raise BzrCommandError("command %r requires argument %s"
710
bailout("command %r requires argument %s"
449
711
% (cmd, argname.upper()))
451
713
argdict[argname] = args.pop(0)
454
raise BzrCommandError("extra argument to command %s: %s"
716
bailout("extra arguments to command %s: %r"
461
def apply_profiled(the_callable, *args, **kwargs):
465
pffileno, pfname = tempfile.mkstemp()
467
prof = hotshot.Profile(pfname)
469
ret = prof.runcall(the_callable, *args, **kwargs) or 0
472
stats = hotshot.stats.load(pfname)
474
stats.sort_stats('cum') # 'time'
475
## XXX: Might like to write to stderr or the trace file instead but
476
## print_stats seems hardcoded to stdout
477
stats.print_stats(20)
484
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
485
from bzrlib.lsprof import profile
487
ret, stats = profile(the_callable, *args, **kwargs)
493
cPickle.dump(stats, open(filename, 'w'), 2)
494
print 'Profile data written to %r.' % filename
499
"""Return an expanded alias, or None if no alias exists"""
501
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
503
return alias.split(' ')
507
723
def run_bzr(argv):
508
724
"""Execute a command.
510
726
This is similar to main(), but without all the trappings for
511
logging and error handling.
514
The command-line arguments, without the program name from argv[0]
516
Returns a command status or raises an exception.
518
Special master options: these must come before the command because
519
they control how the command is interpreted.
522
Do not load plugin modules at all
528
Only use builtin commands. (Plugins are still allowed to change
532
Run under the Python hotshot profiler.
535
Run under the Python lsprof profiler.
727
logging and error handling.
537
argv = [a.decode(bzrlib.user_encoding) for a in argv]
539
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
540
opt_no_aliases = False
541
opt_lsprof_file = None
543
# --no-plugins is handled specially at a very early stage. We need
544
# to load plugins before doing other command parsing so that they
545
# can override commands, but this needs to happen first.
553
elif a == '--lsprof':
555
elif a == '--lsprof-file':
556
opt_lsprof_file = argv[i + 1]
558
elif a == '--no-plugins':
559
opt_no_plugins = True
560
elif a == '--no-aliases':
561
opt_no_aliases = True
562
elif a == '--builtin':
564
elif a in ('--quiet', '-q'):
572
from bzrlib.builtins import cmd_help
573
cmd_help().run_argv_aliases([])
576
if argv[0] == '--version':
577
from bzrlib.builtins import show_version
581
if not opt_no_plugins:
582
from bzrlib.plugin import load_plugins
585
from bzrlib.plugin import disable_plugins
590
if not opt_no_aliases:
591
alias_argv = get_alias(argv[0])
593
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
594
argv[0] = alias_argv.pop(0)
596
cmd = str(argv.pop(0))
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
610
ret = apply_profiled(run, *run_argv)
615
# reset, in case we may do other commands later within the same process
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
622
result = func(*args, **kwargs)
626
if not hasattr(e, 'errno'):
628
if e.errno != errno.EPIPE:
631
except KeyboardInterrupt:
730
args, opts = parse_args(argv[1:])
732
# TODO: pass down other arguments in case they asked for
733
# help on a command name?
736
elif 'version' in opts:
741
log_error('usage: bzr COMMAND\n')
742
log_error(' try "bzr help"\n')
746
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
748
bailout("unknown command " + `cmd`)
750
# TODO: special --profile option to turn on the Python profiler
752
# check options are reasonable
753
allowed = cmd_options.get(cmd, [])
755
if oname not in allowed:
756
bailout("option %r is not allowed for command %r"
759
cmdargs = _match_args(cmd, args)
762
ret = cmd_handler(**cmdargs) or 0
638
from bzrlib.ui.text import TextUIFactory
639
## bzrlib.trace.enable_default_logging()
640
bzrlib.trace.log_startup(argv)
641
bzrlib.ui.ui_factory = TextUIFactory()
642
ret = run_bzr_catch_errors(argv[1:])
643
mutter("return code %d", ret)
647
def run_bzr_catch_errors(argv):
767
## TODO: Handle command-line options; probably know what options are valid for
770
## TODO: If the arguments are wrong, give a usage message rather
771
## than just a backtrace.
773
bzrlib.trace.create_tracefile(argv)
652
# do this here inside the exception wrappers to catch EPIPE
779
log_error('bzr: error: ' + e.args[0] + '\n')
782
log_error(' ' + h + '\n')
654
784
except Exception, e:
655
# used to handle AssertionError and KeyboardInterrupt
656
# specially here, but hopefully they're handled ok by the logger now
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
664
bzrlib.trace.log_exception()
665
if os.environ.get('BZR_PDB'):
666
print '**** entering debugger'
668
pdb.post_mortem(sys.exc_traceback)
785
log_error('bzr: exception: %s\n' % e)
786
log_error(' see .bzr.log for details\n')
787
traceback.print_exc(None, bzrlib.trace._tracefile)
788
traceback.print_exc(None, sys.stderr)
791
# TODO: Maybe nicer handling of IOError?
671
795
if __name__ == '__main__':
672
796
sys.exit(main(sys.argv))
798
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
