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?
34
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
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
43
from bzrlib import option
44
from bzrlib.option import Option
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
53
def register_command(cmd, decorate=False):
54
"""Utility function to help register a command
56
:param cmd: Command subclass to register
57
:param decorate: If true, allow overriding an existing command
58
of the same name; the old command is returned by this function.
59
Otherwise it is an error to try to override an existing command.
63
if k.startswith("cmd_"):
64
k_unsquished = _unsquish_command_name(k)
67
if k_unsquished not in plugin_cmds:
68
plugin_cmds[k_unsquished] = cmd
69
mutter('registered plugin command %s', k_unsquished)
70
if decorate and k_unsquished in builtin_command_names():
71
return _builtin_commands()[k_unsquished]
73
result = plugin_cmds[k_unsquished]
74
plugin_cmds[k_unsquished] = cmd
77
log_error('Two plugins defined the same command: %r' % k)
78
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
81
def _squish_command_name(cmd):
82
return 'cmd_' + cmd.replace('-', '_')
85
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
87
return cmd[4:].replace('_','-')
90
def _builtin_commands():
91
import bzrlib.builtins
93
builtins = bzrlib.builtins.__dict__
95
if name.startswith("cmd_"):
96
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
101
def builtin_command_names():
102
"""Return list of builtin command names."""
103
return _builtin_commands().keys()
106
def plugin_command_names():
107
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
112
d = _builtin_commands()
114
d.update(plugin_cmds)
118
def get_all_cmds(plugins_override=True):
119
"""Return canonical name and class for all registered commands."""
120
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
124
def get_cmd_object(cmd_name, plugins_override=True):
125
"""Return the canonical name and command class for a command.
128
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
132
# We want only 'ascii' command names, but the user may have typed
133
# in a Unicode name. In that case, they should just get a
134
# 'command not found' error later.
135
# In the future, we may actually support Unicode command names.
137
# first look up this command under the specified name
138
cmds = _get_cmd_dict(plugins_override=plugins_override)
140
return cmds[cmd_name]()
144
# look for any command which claims this as an alias
145
for real_cmd_name, cmd_class in cmds.iteritems():
146
if cmd_name in cmd_class.aliases:
149
cmd_obj = ExternalCommand.find_command(cmd_name)
153
raise BzrCommandError('unknown command "%s"' % cmd_name)
156
class Command(object):
157
"""Base class for commands.
159
Commands are the heart of the command-line bzr interface.
161
The command object mostly handles the mapping of command-line
162
parameters into one or more bzrlib operations, and of the results
165
Commands normally don't have any state. All their arguments are
166
passed in to the run method. (Subclasses may take a different
167
policy if the behaviour of the instance needs to depend on e.g. a
168
shell plugin and not just its Python class.)
170
The docstring for an actual command should give a single-line
171
summary, then a complete description of the command. A grammar
172
description will be inserted.
175
Other accepted names for this command.
178
List of argument forms, marked with whether they are optional,
183
['to_location', 'from_branch?', 'file*']
185
'to_location' is required
186
'from_branch' is optional
187
'file' can be specified 0 or more times
190
List of options that may be given for this command. These can
191
be either strings, referring to globally-defined options,
192
or option objects. Retrieve through options().
195
If true, this command isn't advertised. This is typically
196
for commands intended for expert users.
199
Command objects will get a 'outf' attribute, which has been
200
setup to properly handle encoding of unicode strings.
201
encoding_type determines what will happen when characters cannot
203
strict - abort if we cannot decode
204
replace - put in a bogus character (typically '?')
205
exact - do not encode sys.stdout
211
encoding_type = 'strict'
216
"""Construct an instance of this command."""
217
if self.__doc__ == Command.__doc__:
218
warn("No help message set for %r" % self)
221
"""Return dict of valid options for this command.
223
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
226
for o in self.takes_options:
227
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
232
def _setup_outf(self):
233
"""Return a file linked to stdout, which has proper encoding."""
234
assert self.encoding_type in ['strict', 'exact', 'replace']
236
# Originally I was using self.stdout, but that looks
237
# *way* too much like sys.stdout
238
if self.encoding_type == 'exact':
239
self.outf = sys.stdout
242
output_encoding = bzrlib.osutils.get_terminal_encoding()
244
# use 'replace' so that we don't abort if trying to write out
245
# in e.g. the default C locale.
246
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
247
# For whatever reason codecs.getwriter() does not advertise its encoding
248
# it just returns the encoding of the wrapped file, which is completely
249
# bogus. So set the attribute, so we can find the correct encoding later.
250
self.outf.encoding = output_encoding
252
@deprecated_method(zero_eight)
253
def run_argv(self, argv):
254
"""Parse command line and run.
256
See run_argv_aliases for the 0.8 and beyond api.
258
return self.run_argv_aliases(argv)
260
def run_argv_aliases(self, argv, alias_argv=None):
261
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
DeprecationWarning, stacklevel=2)
266
args, opts = parse_args(self, argv, alias_argv)
267
if 'help' in opts: # e.g. bzr add --help
268
from bzrlib.help import help_on_command
269
help_on_command(self.name())
271
# mix arguments and options into one dictionary
272
cmdargs = _match_argform(self.name(), self.takes_args, args)
274
for k, v in opts.items():
275
cmdopts[k.replace('-', '_')] = v
277
all_cmd_args = cmdargs.copy()
278
all_cmd_args.update(cmdopts)
282
return self.run(**all_cmd_args)
285
"""Actually run the command.
287
This is invoked with the options and arguments bound to
290
Return 0 or None if the command was successful, or a non-zero
291
shell error code if not. It's OK for this method to allow
292
an exception to raise up.
294
raise NotImplementedError('no implementation of command %r'
298
"""Return help message for this class."""
299
from inspect import getdoc
300
if self.__doc__ is Command.__doc__:
305
return _unsquish_command_name(self.__class__.__name__)
307
def plugin_name(self):
308
"""Get the name of the plugin that provides this command.
310
:return: The name of the plugin or None if the command is builtin.
312
mod_parts = self.__module__.split('.')
313
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
319
def parse_spec(spec):
325
>>> parse_spec("../@")
327
>>> parse_spec("../f/@35")
329
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
330
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
335
parsed = spec.split('/@')
336
assert len(parsed) == 2
341
parsed[1] = int(parsed[1])
343
pass # We can allow stuff like ./@revid:blahblahblah
347
parsed = [spec, None]
350
def parse_args(command, argv, alias_argv=None):
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)
199
"""info: Show statistical information for this branch
203
info.show_info(Branch('.'))
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
213
def cmd_file_id(filename):
215
i = b.inventory.path2id(b.relpath(filename))
217
bailout("%s is not a versioned file" % filename)
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
225
bailout("%s is not a live file id" % fileid)
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
252
usage: bzr diff [-r REV]
255
Show changes since REV, rather than predecessor.
257
TODO: Given two revision arguments, show the difference between them.
259
TODO: Allow diff across branches.
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
264
TODO: Diff selected files.
267
## TODO: Shouldn't be in the cmd function.
272
old_tree = b.basis_tree()
274
old_tree = b.revision_tree(b.lookup_revision(revision))
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
292
# TODO: Better to return them in sorted order I think.
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
308
if file_state in ['.', '?', 'I']:
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
314
new_tree.get_file(fid).readlines(),
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
338
bailout("can't represent state %s {%s}" % (file_state, fid))
342
def cmd_deleted(show_ids=False):
343
"""List files deleted in the working tree.
345
TODO: Show files deleted since a previous revision, or between two revisions.
349
new = b.working_tree()
351
for path, ie in old.inventory.iter_entries():
352
if not new.has_id(ie.file_id):
354
print '%-50s %s' % (path, ie.file_id)
361
def cmd_root(filename=None):
362
"""Print the branch root."""
363
print bzrlib.branch.find_branch_root(filename)
366
def cmd_log(timezone='original'):
367
"""Show log of this branch.
369
:todo: Options for utc; to show ids; to limit range; etc.
371
Branch('.').write_log(show_timezone=timezone)
374
def cmd_ls(revision=None, verbose=False):
375
"""List files in a tree.
377
:todo: Take a revision or remote path and list that tree instead.
381
tree = b.working_tree()
383
tree = b.revision_tree(b.lookup_revision(revision))
385
for fp, fc, kind, fid in tree.list_files():
387
if kind == 'directory':
394
print '%-8s %s%s' % (fc, fp, kindch)
401
"""List unknown files"""
402
for f in Branch('.').unknowns():
407
def cmd_ignored(verbose=True):
408
"""List ignored files and the patterns that matched them.
410
tree = Branch('.').working_tree()
411
for path, file_class, kind, id in tree.list_files():
412
if file_class != 'I':
414
## XXX: Slightly inefficient since this was already calculated
415
pat = tree.is_ignored(path)
416
print '%-50s %s' % (path, pat)
420
def cmd_lookup_revision(revno):
424
bailout("usage: lookup-revision REVNO",
425
["REVNO is a non-negative revision number for this branch"])
427
print Branch('.').lookup_revision(revno) or NONE_STRING
431
def cmd_export(revno, dest):
432
"""Export past revision to destination directory."""
434
rh = b.lookup_revision(int(revno))
435
t = b.revision_tree(rh)
440
######################################################################
441
# internal/test commands
445
"""Print a newly-generated UUID."""
446
print bzrlib.osutils.uuid()
450
def cmd_local_time_offset():
451
print bzrlib.osutils.local_time_offset()
455
def cmd_commit(message=None, verbose=False):
456
"""Commit changes to a new revision.
459
Description of changes in this revision; free form text.
460
It is recommended that the first line be a single-sentence
463
Show status of changed files,
465
TODO: Commit only selected files.
467
TODO: Run hooks on tree to-be-committed, and after commit.
469
TODO: Strict commit that fails if there are unknown or deleted files.
473
bailout("please specify a commit message")
474
Branch('.').commit(message, verbose=verbose)
477
def cmd_check(dir='.'):
478
"""check: Consistency check of branch history.
480
usage: bzr check [-v] [BRANCH]
483
--verbose, -v Show progress of checking.
485
This command checks various invariants about the branch storage to
486
detect data corruption or bzr bugs.
489
bzrlib.check.check(Branch(dir, find_root=False))
492
def cmd_is(pred, *rest):
493
"""Test whether PREDICATE is true."""
495
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
497
bailout("unknown predicate: %s" % quotefn(pred))
501
except BzrCheckError:
502
# by default we don't print the message so that this can
503
# be used from shell scripts without producing noise
508
print bzrlib.osutils.username()
511
def cmd_user_email():
512
print bzrlib.osutils.user_email()
515
def cmd_gen_revision_id():
517
print bzrlib.branch._gen_revision_id(time.time())
520
def cmd_selftest(verbose=False):
521
"""Run internal test suite"""
522
## -v, if present, is seen by doctest; the argument is just here
523
## so our parser doesn't complain
525
## TODO: --verbose option
527
failures, tests = 0, 0
529
import doctest, bzrlib.store, bzrlib.tests
530
bzrlib.trace.verbose = False
532
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
533
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
534
mf, mt = doctest.testmod(m)
537
print '%-40s %3d tests' % (m.__name__, mt),
539
print '%3d FAILED!' % mf
543
print '%-40s %3d tests' % ('total', tests),
545
print '%3d FAILED!' % failures
552
cmd_doctest = cmd_selftest
555
######################################################################
559
def cmd_help(topic=None):
564
# otherwise, maybe the name of a command?
566
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
568
bailout("no help for %r" % topic)
572
bailout("sorry, no detailed help yet for %r" % topic)
580
print "bzr (bazaar-ng) %s" % bzrlib.__version__
581
print bzrlib.__copyright__
582
print "http://bazaar-ng.org/"
585
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
586
you may use, modify and redistribute it under the terms of the GNU
587
General Public License version 2 or later."""
591
"""Statement of optimism."""
592
print "it sure does!"
596
######################################################################
600
# list of all available options; the rhs can be either None for an
601
# option that takes no argument, or a constructor function that checks
621
# List of options that apply to particular commands; commands not
625
'commit': ['message', 'verbose'],
626
'deleted': ['show-ids'],
627
'diff': ['revision'],
628
'inventory': ['revision'],
630
'ls': ['revision', 'verbose'],
631
'remove': ['verbose'],
640
'export': ['revno', 'dest'],
641
'file-id': ['filename'],
642
'get-file-text': ['text_id'],
643
'get-inventory': ['inventory_id'],
644
'get-revision': ['revision_id'],
645
'get-revision-inventory': ['revision_id'],
649
'lookup-revision': ['revno'],
650
'relpath': ['filename'],
652
'root': ['filename?'],
657
def parse_args(argv):
351
658
"""Parse command line.
353
660
Arguments and options are parsed at this level before being passed
354
661
down to specific command handlers. This routine knows, from a
355
662
lookup table, something about the available options, what optargs
356
663
they take, and which commands will accept them.
665
>>> parse_args('--help'.split())
667
>>> parse_args('--version'.split())
668
([], {'version': True})
669
>>> parse_args('status --all'.split())
670
(['status'], {'all': True})
671
>>> parse_args('commit --message=biter'.split())
672
(['commit'], {'message': u'biter'})
358
# TODO: make it a method of the Command?
359
parser = option.get_optparser(command.options())
360
if alias_argv is not None:
361
args = alias_argv + argv
365
options, args = parser.parse_args(args)
366
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
367
v is not option.OptionParser.DEFAULT_VALUE])
677
# TODO: Maybe handle '--' to end options?
684
mutter(" got option %r" % a)
686
optname, optarg = a[2:].split('=', 1)
689
if optname not in OPTIONS:
690
bailout('unknown long option %r' % a)
693
if shortopt not in SHORT_OPTIONS:
694
bailout('unknown short option %r' % a)
695
optname = SHORT_OPTIONS[shortopt]
698
# XXX: Do we ever want to support this, e.g. for -r?
699
bailout('repeated option %r' % a)
701
optargfn = OPTIONS[optname]
705
bailout('option %r needs an argument' % a)
708
opts[optname] = optargfn(optarg)
711
bailout('option %r takes no argument' % optname)
368
716
return args, opts
371
def _match_argform(cmd, takes_args, args):
720
def _match_args(cmd, args):
721
"""Check non-option arguments match required pattern.
723
>>> _match_args('status', ['asdasdsadasd'])
724
Traceback (most recent call last):
726
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
727
>>> _match_args('add', ['asdasdsadasd'])
728
{'file_list': ['asdasdsadasd']}
729
>>> _match_args('add', 'abc def gj'.split())
730
{'file_list': ['abc', 'def', 'gj']}
732
# match argument pattern
733
argform = cmd_args.get(cmd, [])
735
# TODO: Need a way to express 'cp SRC... DEST', where it matches
374
# step through args and takes_args, allowing appropriate 0-many matches
375
for ap in takes_args:
738
# step through args and argform, allowing appropriate 0-many matches
376
740
argname = ap[:-1]
377
741
if ap[-1] == '?':
379
743
argdict[argname] = args.pop(0)
380
elif ap[-1] == '*': # all remaining arguments
382
argdict[argname + '_list'] = args[:]
385
argdict[argname + '_list'] = None
386
746
elif ap[-1] == '+':
388
raise BzrCommandError("command %r needs one or more %s"
748
bailout("command %r needs one or more %s"
389
749
% (cmd, argname.upper()))
391
751
argdict[argname + '_list'] = args[:]
393
elif ap[-1] == '$': # all but one
395
raise BzrCommandError("command %r needs one or more %s"
396
% (cmd, argname.upper()))
397
argdict[argname + '_list'] = args[:-1]
400
754
# just a plain arg
403
raise BzrCommandError("command %r requires argument %s"
757
bailout("command %r requires argument %s"
404
758
% (cmd, argname.upper()))
406
760
argdict[argname] = args.pop(0)
409
raise BzrCommandError("extra argument to command %s: %s"
763
bailout("extra arguments to command %s: %r"
416
def apply_profiled(the_callable, *args, **kwargs):
420
pffileno, pfname = tempfile.mkstemp()
422
prof = hotshot.Profile(pfname)
424
ret = prof.runcall(the_callable, *args, **kwargs) or 0
427
stats = hotshot.stats.load(pfname)
429
stats.sort_stats('cum') # 'time'
430
## XXX: Might like to write to stderr or the trace file instead but
431
## print_stats seems hardcoded to stdout
432
stats.print_stats(20)
439
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
440
from bzrlib.lsprof import profile
442
ret, stats = profile(the_callable, *args, **kwargs)
448
cPickle.dump(stats, open(filename, 'w'), 2)
449
print 'Profile data written to %r.' % filename
454
"""Return an expanded alias, or None if no alias exists"""
456
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
458
return alias.split(' ')
462
770
def run_bzr(argv):
463
771
"""Execute a command.
465
773
This is similar to main(), but without all the trappings for
466
logging and error handling.
469
The command-line arguments, without the program name from argv[0]
470
These should already be decoded. All library/test code calling
471
run_bzr should be passing valid strings (don't need decoding).
473
Returns a command status or raises an exception.
475
Special master options: these must come before the command because
476
they control how the command is interpreted.
479
Do not load plugin modules at all
485
Only use builtin commands. (Plugins are still allowed to change
489
Run under the Python hotshot profiler.
492
Run under the Python lsprof profiler.
774
logging and error handling.
496
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
497
opt_no_aliases = False
498
opt_lsprof_file = None
500
# --no-plugins is handled specially at a very early stage. We need
501
# to load plugins before doing other command parsing so that they
502
# can override commands, but this needs to happen first.
510
elif a == '--lsprof':
512
elif a == '--lsprof-file':
514
opt_lsprof_file = argv[i + 1]
516
elif a == '--no-plugins':
517
opt_no_plugins = True
518
elif a == '--no-aliases':
519
opt_no_aliases = True
520
elif a == '--builtin':
522
elif a in ('--quiet', '-q'):
530
from bzrlib.builtins import cmd_help
531
cmd_help().run_argv_aliases([])
534
if argv[0] == '--version':
535
from bzrlib.version import show_version
539
if not opt_no_plugins:
540
from bzrlib.plugin import load_plugins
543
from bzrlib.plugin import disable_plugins
548
if not opt_no_aliases:
549
alias_argv = get_alias(argv[0])
551
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
552
argv[0] = alias_argv.pop(0)
555
# We want only 'ascii' command names, but the user may have typed
556
# in a Unicode name. In that case, they should just get a
557
# 'command not found' error later.
559
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
560
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
561
run = cmd_obj.run_argv
564
run = cmd_obj.run_argv_aliases
565
run_argv = [argv, alias_argv]
569
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
571
ret = apply_profiled(run, *run_argv)
576
# reset, in case we may do other commands later within the same process
579
def display_command(func):
580
"""Decorator that suppresses pipe/interrupt errors."""
581
def ignore_pipe(*args, **kwargs):
583
result = func(*args, **kwargs)
587
if getattr(e, 'errno', None) is None:
589
if e.errno != errno.EPIPE:
590
# Win32 raises IOError with errno=0 on a broken pipe
591
if sys.platform != 'win32' or e.errno != 0:
594
except KeyboardInterrupt:
777
args, opts = parse_args(argv[1:])
779
# TODO: pass down other arguments in case they asked for
780
# help on a command name?
783
elif 'version' in opts:
788
log_error('usage: bzr COMMAND\n')
789
log_error(' try "bzr help"\n')
793
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
795
bailout("unknown command " + `cmd`)
798
if 'profile' in opts:
804
# check options are reasonable
805
allowed = cmd_options.get(cmd, [])
807
if oname not in allowed:
808
bailout("option %r is not allowed for command %r"
811
# mix arguments and options into one dictionary
812
cmdargs = _match_args(cmd, args)
813
for k, v in opts.items():
814
cmdargs[k.replace('-', '_')] = v
818
prof = hotshot.Profile('.bzr.profile')
819
ret = prof.runcall(cmd_handler, **cmdargs) or 0
823
stats = hotshot.stats.load('.bzr.profile')
825
stats.sort_stats('cumulative', 'calls')
826
stats.print_stats(20)
828
return cmd_handler(**cmdargs) or 0
601
from bzrlib.ui.text import TextUIFactory
602
bzrlib.ui.ui_factory = TextUIFactory()
603
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
604
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
609
def run_bzr_catch_errors(argv):
833
## TODO: Handle command-line options; probably know what options are valid for
836
## TODO: If the arguments are wrong, give a usage message rather
837
## than just a backtrace.
839
bzrlib.trace.create_tracefile(argv)
612
# do this here inside the exception wrappers to catch EPIPE
614
except (KeyboardInterrupt, Exception), e:
615
# used to handle AssertionError and KeyboardInterrupt
616
# specially here, but hopefully they're handled ok by the logger now
617
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
618
if os.environ.get('BZR_PDB'):
619
print '**** entering debugger'
621
pdb.post_mortem(sys.exc_traceback)
845
log_error('bzr: error: ' + e.args[0] + '\n')
848
log_error(' ' + h + '\n')
851
log_error('bzr: exception: %s\n' % e)
852
log_error(' see .bzr.log for details\n')
853
traceback.print_exc(None, bzrlib.trace._tracefile)
854
traceback.print_exc(None, sys.stderr)
857
# TODO: Maybe nicer handling of IOError?
624
861
if __name__ == '__main__':
625
862
sys.exit(main(sys.argv))
864
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
