1
# Copyright (C) 2006 Canonical Ltd
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
3
8
# This program is free software; you can redistribute it and/or modify
4
9
# it under the terms of the GNU General Public License as published by
5
10
# the Free Software Foundation; either version 2 of the License, or
6
11
# (at your option) any later version.
8
13
# This program is distributed in the hope that it will be useful,
9
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
16
# GNU General Public License for more details.
13
18
# You should have received a copy of the GNU General Public License
14
19
# along with this program; if not, write to the Free Software
15
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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 bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
from warnings import warn
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
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.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Show some information about this branch.
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
81
from pprint import pprint
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
91
def _squish_command_name(cmd):
92
return 'cmd_' + cmd.replace('-', '_')
95
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
return cmd[4:].replace('_','-')
100
def _builtin_commands():
101
import bzrlib.builtins
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
105
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
111
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
116
def plugin_command_names():
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
138
If true, plugin commands can override builtins.
141
return _get_cmd_object(cmd_name, plugins_override)
143
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
146
def _get_cmd_object(cmd_name, plugins_override=True):
147
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
148
from bzrlib.externalcommand import ExternalCommand
150
# We want only 'ascii' command names, but the user may have typed
151
# in a Unicode name. In that case, they should just get a
152
# 'command not found' error later.
153
# In the future, we may actually support Unicode command names.
155
# first look up this command under the specified name
156
cmds = _get_cmd_dict(plugins_override=plugins_override)
158
return cmds[cmd_name]()
162
# look for any command which claims this as an alias
163
for real_cmd_name, cmd_class in cmds.iteritems():
164
if cmd_name in cmd_class.aliases:
167
cmd_obj = ExternalCommand.find_command(cmd_name)
173
class Command(object):
174
"""Base class for commands.
176
Commands are the heart of the command-line bzr interface.
178
The command object mostly handles the mapping of command-line
179
parameters into one or more bzrlib operations, and of the results
182
Commands normally don't have any state. All their arguments are
183
passed in to the run method. (Subclasses may take a different
184
policy if the behaviour of the instance needs to depend on e.g. a
185
shell plugin and not just its Python class.)
187
The docstring for an actual command should give a single-line
188
summary, then a complete description of the command. A grammar
189
description will be inserted.
192
Other accepted names for this command.
195
List of argument forms, marked with whether they are optional,
200
['to_location', 'from_branch?', 'file*']
202
'to_location' is required
203
'from_branch' is optional
204
'file' can be specified 0 or more times
207
List of options that may be given for this command. These can
208
be either strings, referring to globally-defined options,
209
or option objects. Retrieve through options().
212
If true, this command isn't advertised. This is typically
213
for commands intended for expert users.
216
Command objects will get a 'outf' attribute, which has been
217
setup to properly handle encoding of unicode strings.
218
encoding_type determines what will happen when characters cannot
220
strict - abort if we cannot decode
221
replace - put in a bogus character (typically '?')
222
exact - do not encode sys.stdout
224
NOTE: by default on Windows, sys.stdout is opened as a text
225
stream, therefore LF line-endings are converted to CRLF.
226
When a command uses encoding_type = 'exact', then
227
sys.stdout is forced to be a binary stream, and line-endings
234
encoding_type = 'strict'
239
"""Construct an instance of this command."""
240
if self.__doc__ == Command.__doc__:
241
warn("No help message set for %r" % self)
244
"""Return single-line grammar for this command.
246
Only describes arguments, not options.
248
s = 'bzr ' + self.name() + ' '
249
for aname in self.takes_args:
250
aname = aname.upper()
251
if aname[-1] in ['$', '+']:
252
aname = aname[:-1] + '...'
253
elif aname[-1] == '?':
254
aname = '[' + aname[:-1] + ']'
255
elif aname[-1] == '*':
256
aname = '[' + aname[:-1] + '...]'
86
from bzrlib.store import ImmutableStore
87
from bzrlib.trace import mutter, note, log_error
88
from bzrlib.errors import bailout, BzrError
89
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
from bzrlib.revision import Revision
92
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
98
## standard representation
99
NONE_STRING = '(none)'
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
108
## TODO: Some kind of locking on branches. Perhaps there should be a
109
## parameter to the branch object saying whether we want a read or
110
## write lock; release it from destructor. Perhaps don't even need a
111
## read lock to look at immutable objects?
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
116
## TODO: Some kind of global code to generate the right Branch object
117
## to work on. Almost, but not quite all, commands need one, and it
118
## can be taken either from their parameters or their working
121
## TODO: rename command, needed soon: check destination doesn't exist
122
## either in working copy or tree; move working copy; update
123
## inventory; write out
125
## TODO: move command; check destination is a directory and will not
128
## TODO: command to show renames, one per line, as to->from
133
def cmd_status(all=False):
134
"""Display status summary.
136
For each file there is a single line giving its file state and name.
137
The name is that in the current revision unless it is deleted or
138
missing, in which case the old name is shown.
140
:todo: Don't show unchanged files unless ``--all`` is given?
142
Branch('.').show_status(show_all=all)
146
######################################################################
148
def cmd_get_revision(revision_id):
149
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
152
def cmd_get_file_text(text_id):
153
"""Get contents of a file by hash."""
154
sf = Branch('.').text_store[text_id]
155
pumpfile(sf, sys.stdout)
159
######################################################################
164
"""Show number of revisions on this branch"""
165
print Branch('.').revno()
168
def cmd_add(file_list, verbose=False):
169
"""Add specified files.
171
Fails if the files are already added.
173
Branch('.').add(file_list, verbose=verbose)
176
def cmd_inventory(revision=None):
177
"""Show inventory of the current working copy."""
178
## TODO: Also optionally show a previous inventory
179
## TODO: Format options
182
inv = b.read_working_inventory()
184
inv = b.get_revision_inventory(b.lookup_revision(revision))
186
for path, entry in inv.iter_entries():
187
print '%-50s %s' % (entry.file_id, path)
193
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
195
def plural(n, base='', pl=None):
203
count_version_dirs = 0
205
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
206
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
208
count_status[fs] += 1
209
if fs not in ['I', '?'] and st_tup[4] == 'directory':
210
count_version_dirs += 1
213
print 'in the working tree:'
214
for name, fs in (('unchanged', '.'),
215
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
216
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
218
print ' %5d %s' % (count_status[fs], name)
219
print ' %5d versioned subdirector%s' % (count_version_dirs,
220
plural(count_version_dirs, 'y', 'ies'))
223
print 'branch history:'
224
history = b.revision_history()
226
print ' %5d revision%s' % (revno, plural(revno))
229
committers.add(b.get_revision(rev).committer)
230
print ' %5d committer%s' % (len(committers), plural(len(committers)))
232
firstrev = b.get_revision(history[0])
233
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
234
print ' %5d day%s old' % (age, plural(age))
235
print ' first revision: %s' % format_date(firstrev.timestamp,
238
lastrev = b.get_revision(history[-1])
239
print ' latest revision: %s' % format_date(lastrev.timestamp,
245
def cmd_remove(file_list, verbose=False):
246
Branch('.').remove(file_list, verbose=verbose)
250
def cmd_file_id(filename):
251
i = Branch('.').read_working_inventory().path2id(filename)
253
bailout("%s is not a versioned file" % filename)
258
def cmd_find_filename(fileid):
259
n = find_filename(fileid)
261
bailout("%s is not a live file id" % fileid)
266
def cmd_revision_history():
267
for patchid in Branch('.').revision_history():
273
# TODO: Check we're not already in a working directory? At the
274
# moment you'll get an ugly error.
276
# TODO: What if we're in a subdirectory of a branch? Would like
277
# to allow that, but then the parent may need to understand that
278
# the children have disappeared, or should they be versioned in
281
# TODO: Take an argument/option for branch name.
282
Branch('.', init=True)
285
def cmd_diff(revision=None):
286
"""Show diff from basis to working copy.
288
:todo: Take one or two revision arguments, look up those trees,
291
:todo: Allow diff across branches.
293
:todo: Mangle filenames in diff to be more relevant.
295
:todo: Shouldn't be in the cmd function.
301
old_tree = b.basis_tree()
303
old_tree = b.revision_tree(b.lookup_revision(revision))
305
new_tree = b.working_tree()
306
old_inv = old_tree.inventory
307
new_inv = new_tree.inventory
309
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
313
DEVNULL = '/dev/null'
314
# Windows users, don't panic about this filename -- it is a
315
# special signal to GNU patch that the file should be created or
316
# deleted respectively.
318
# TODO: Generation of pseudo-diffs for added/deleted files could
319
# be usefully made into a much faster special case.
321
# TODO: Better to return them in sorted order I think.
323
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
326
# Don't show this by default; maybe do it if an option is passed
327
# idlabel = ' {%s}' % fid
330
# FIXME: Something about the diff format makes patch unhappy
331
# with newly-added files.
333
def diffit(*a, **kw):
334
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
337
if file_state in ['.', '?', 'I']:
339
elif file_state == 'A':
340
print '*** added %s %r' % (kind, new_name)
343
new_tree.get_file(fid).readlines(),
345
tofile=new_label + new_name + idlabel)
346
elif file_state == 'D':
347
assert isinstance(old_name, types.StringTypes)
348
print '*** deleted %s %r' % (kind, old_name)
350
diffit(old_tree.get_file(fid).readlines(), [],
351
fromfile=old_label + old_name + idlabel,
353
elif file_state in ['M', 'R']:
354
if file_state == 'M':
355
assert kind == 'file'
356
assert old_name == new_name
357
print '*** modified %s %r' % (kind, new_name)
358
elif file_state == 'R':
359
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
362
diffit(old_tree.get_file(fid).readlines(),
363
new_tree.get_file(fid).readlines(),
364
fromfile=old_label + old_name + idlabel,
365
tofile=new_label + new_name)
367
bailout("can't represent state %s {%s}" % (file_state, fid))
371
def cmd_log(timezone='original'):
372
"""Show log of this branch.
374
:todo: Options for utc; to show ids; to limit range; etc.
376
Branch('.').write_log(show_timezone=timezone)
379
def cmd_ls(revision=None, verbose=False):
380
"""List files in a tree.
382
:todo: Take a revision or remote path and list that tree instead.
386
tree = b.working_tree()
388
tree = b.revision_tree(b.lookup_revision(revision))
390
for fp, fc, kind, fid in tree.list_files():
392
if kind == 'directory':
263
def get_help_text(self, additional_see_also=None):
264
"""Return a text string with help for this command.
266
:param additional_see_also: Additional help topics to be
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
274
result += 'usage: %s\n' % self._usage()
277
result += 'aliases: '
278
result += ', '.join(self.aliases) + '\n'
282
plugin_name = self.plugin_name()
283
if plugin_name is not None:
284
result += '(From plugin "%s")' % plugin_name
288
if result[-1] != '\n':
291
result += option.get_optparser(self.options()).format_option_help()
292
see_also = self.get_see_also(additional_see_also)
294
result += '\nSee also: '
295
result += ', '.join(see_also)
299
def get_help_topic(self):
300
"""Return the commands help topic - its name."""
303
def get_see_also(self, additional_terms=None):
304
"""Return a list of help topics that are related to this ommand.
306
The list is derived from the content of the _see_also attribute. Any
307
duplicates are removed and the result is in lexical order.
308
:param additional_terms: Additional help topics to cross-reference.
309
:return: A list of help topics.
311
see_also = set(getattr(self, '_see_also', []))
313
see_also.update(additional_terms)
314
return sorted(see_also)
317
"""Return dict of valid options for this command.
319
Maps from long option name to option object."""
321
r['help'] = option.Option.OPTIONS['help']
322
for o in self.takes_options:
323
if isinstance(o, basestring):
324
o = option.Option.OPTIONS[o]
328
def _setup_outf(self):
329
"""Return a file linked to stdout, which has proper encoding."""
330
assert self.encoding_type in ['strict', 'exact', 'replace']
332
# Originally I was using self.stdout, but that looks
333
# *way* too much like sys.stdout
334
if self.encoding_type == 'exact':
335
# force sys.stdout to be binary stream on win32
336
if sys.platform == 'win32':
337
fileno = getattr(sys.stdout, 'fileno', None)
340
msvcrt.setmode(fileno(), os.O_BINARY)
341
self.outf = sys.stdout
344
output_encoding = osutils.get_terminal_encoding()
346
# use 'replace' so that we don't abort if trying to write out
347
# in e.g. the default C locale.
348
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
349
# For whatever reason codecs.getwriter() does not advertise its encoding
350
# it just returns the encoding of the wrapped file, which is completely
351
# bogus. So set the attribute, so we can find the correct encoding later.
352
self.outf.encoding = output_encoding
354
def run_argv_aliases(self, argv, alias_argv=None):
355
"""Parse the command line and run with extra aliases in alias_argv."""
357
warn("Passing None for [] is deprecated from bzrlib 0.10",
358
DeprecationWarning, stacklevel=2)
360
args, opts = parse_args(self, argv, alias_argv)
361
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
364
# mix arguments and options into one dictionary
365
cmdargs = _match_argform(self.name(), self.takes_args, args)
367
for k, v in opts.items():
368
cmdopts[k.replace('-', '_')] = v
370
all_cmd_args = cmdargs.copy()
371
all_cmd_args.update(cmdopts)
375
return self.run(**all_cmd_args)
378
"""Actually run the command.
380
This is invoked with the options and arguments bound to
383
Return 0 or None if the command was successful, or a non-zero
384
shell error code if not. It's OK for this method to allow
385
an exception to raise up.
387
raise NotImplementedError('no implementation of command %r'
391
"""Return help message for this class."""
392
from inspect import getdoc
393
if self.__doc__ is Command.__doc__:
398
return _unsquish_command_name(self.__class__.__name__)
400
def plugin_name(self):
401
"""Get the name of the plugin that provides this command.
403
:return: The name of the plugin or None if the command is builtin.
405
mod_parts = self.__module__.split('.')
406
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
412
# Technically, this function hasn't been use in a *really* long time
413
# but we are only deprecating it now.
414
@deprecated_function(zero_eleven)
415
def parse_spec(spec):
421
>>> parse_spec("../@")
423
>>> parse_spec("../f/@35")
425
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
426
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
431
parsed = spec.split('/@')
432
assert len(parsed) == 2
437
parsed[1] = int(parsed[1])
439
pass # We can allow stuff like ./@revid:blahblahblah
443
parsed = [spec, None]
446
def parse_args(command, argv, alias_argv=None):
399
print '%-8s %s%s' % (fc, fp, kindch)
406
"""List unknown files"""
407
for f in Branch('.').unknowns():
411
def cmd_lookup_revision(revno):
415
bailout("usage: lookup-revision REVNO",
416
["REVNO is a non-negative revision number for this branch"])
418
print Branch('.').lookup_revision(revno) or NONE_STRING
422
def cmd_export(revno, dest):
423
"""Export past revision to destination directory."""
425
rh = b.lookup_revision(int(revno))
426
t = b.revision_tree(rh)
431
######################################################################
432
# internal/test commands
436
"""Print a newly-generated UUID."""
441
def cmd_local_time_offset():
442
print bzrlib.osutils.local_time_offset()
446
def cmd_commit(message, verbose=False):
447
Branch('.').commit(message, verbose=verbose)
451
"""Check consistency of the branch."""
455
def cmd_is(pred, *rest):
456
"""Test whether PREDICATE is true."""
458
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
460
bailout("unknown predicate: %s" % quotefn(pred))
464
except BzrCheckError:
465
# by default we don't print the message so that this can
466
# be used from shell scripts without producing noise
471
print bzrlib.osutils.username()
474
def cmd_user_email():
475
print bzrlib.osutils.user_email()
478
def cmd_gen_revision_id():
480
print bzrlib.branch._gen_revision_id(time.time())
484
"""Run internal doctest suite"""
485
## -v, if present, is seen by doctest; the argument is just here
486
## so our parser doesn't complain
488
## TODO: --verbose option
490
import bzr, doctest, bzrlib.store
491
bzrlib.trace.verbose = False
493
doctest.testmod(bzrlib.store)
494
doctest.testmod(bzrlib.inventory)
495
doctest.testmod(bzrlib.branch)
496
doctest.testmod(bzrlib.osutils)
497
doctest.testmod(bzrlib.tree)
499
# more strenuous tests;
501
doctest.testmod(bzrlib.tests)
504
######################################################################
509
# TODO: Specific help for particular commands
514
print "bzr (bazaar-ng) %s" % __version__
516
print "http://bazaar-ng.org/"
519
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
520
you may use, modify and redistribute it under the terms of the GNU
521
General Public License version 2 or later."""
525
"""Statement of optimism."""
526
print "it sure does!"
530
######################################################################
534
# list of all available options; the rhs can be either None for an
535
# option that takes no argument, or a constructor function that checks
554
# List of options that apply to particular commands; commands not
558
'commit': ['message', 'verbose'],
559
'diff': ['revision'],
560
'inventory': ['revision'],
561
'log': ['show-ids', 'timezone'],
562
'ls': ['revision', 'verbose'],
563
'remove': ['verbose'],
573
'file-id': ['filename'],
574
'get-file-text': ['text_id'],
575
'get-inventory': ['inventory_id'],
576
'get-revision': ['revision_id'],
577
'get-revision-inventory': ['revision_id'],
579
'lookup-revision': ['revno'],
580
'export': ['revno', 'dest'],
586
def parse_args(argv):
447
587
"""Parse command line.
449
589
Arguments and options are parsed at this level before being passed
450
590
down to specific command handlers. This routine knows, from a
451
591
lookup table, something about the available options, what optargs
452
592
they take, and which commands will accept them.
594
>>> parse_args('--help'.split())
596
>>> parse_args('--version'.split())
597
([], {'version': True})
598
>>> parse_args('status --all'.split())
599
(['status'], {'all': True})
600
>>> parse_args('commit --message=biter'.split())
601
(['commit'], {'message': u'biter'})
454
# TODO: make it a method of the Command?
455
parser = option.get_optparser(command.options())
456
if alias_argv is not None:
457
args = alias_argv + argv
461
options, args = parser.parse_args(args)
462
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
463
v is not option.OptionParser.DEFAULT_VALUE])
606
# TODO: Maybe handle '--' to end options?
613
mutter(" got option %r" % a)
615
optname, optarg = a[2:].split('=', 1)
618
if optname not in OPTIONS:
619
bailout('unknown long option %r' % a)
622
if shortopt not in SHORT_OPTIONS:
623
bailout('unknown short option %r' % a)
624
optname = SHORT_OPTIONS[shortopt]
627
# XXX: Do we ever want to support this, e.g. for -r?
628
bailout('repeated option %r' % a)
630
optargfn = OPTIONS[optname]
634
bailout('option %r needs an argument' % a)
637
opts[optname] = optargfn(optarg)
638
mutter(" option argument %r" % opts[optname])
641
bailout('option %r takes no argument' % optname)
464
646
return args, opts
467
def _match_argform(cmd, takes_args, args):
650
def _match_args(cmd, args):
651
"""Check non-option arguments match required pattern.
653
>>> _match_args('status', ['asdasdsadasd'])
654
Traceback (most recent call last):
656
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
657
>>> _match_args('add', ['asdasdsadasd'])
658
{'file_list': ['asdasdsadasd']}
659
>>> _match_args('add', 'abc def gj'.split())
660
{'file_list': ['abc', 'def', 'gj']}
662
# match argument pattern
663
argform = cmd_args.get(cmd, [])
665
# TODO: Need a way to express 'cp SRC... DEST', where it matches
470
# step through args and takes_args, allowing appropriate 0-many matches
471
for ap in takes_args:
472
669
argname = ap[:-1]
473
670
if ap[-1] == '?':
475
argdict[argname] = args.pop(0)
476
elif ap[-1] == '*': # all remaining arguments
478
argdict[argname + '_list'] = args[:]
481
argdict[argname + '_list'] = None
482
674
elif ap[-1] == '+':
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
676
bailout("command %r needs one or more %s"
677
% (cmd, argname.upper()))
487
679
argdict[argname + '_list'] = args[:]
489
elif ap[-1] == '$': # all but one
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
493
argdict[argname + '_list'] = args[:-1]
496
682
# just a plain arg
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
685
bailout("command %r requires argument %s"
686
% (cmd, argname.upper()))
502
688
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
691
bailout("extra arguments to command %s: %r"
512
def apply_profiled(the_callable, *args, **kwargs):
516
pffileno, pfname = tempfile.mkstemp()
518
prof = hotshot.Profile(pfname)
520
ret = prof.runcall(the_callable, *args, **kwargs) or 0
523
stats = hotshot.stats.load(pfname)
525
stats.sort_stats('cum') # 'time'
526
## XXX: Might like to write to stderr or the trace file instead but
527
## print_stats seems hardcoded to stdout
528
stats.print_stats(20)
535
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
536
from bzrlib.lsprof import profile
538
ret, stats = profile(the_callable, *args, **kwargs)
544
print 'Profile data written to %r.' % filename
548
def get_alias(cmd, config=None):
549
"""Return an expanded alias, or None if no alias exists.
552
Command to be checked for an alias.
554
Used to specify an alternative config to use,
555
which is especially useful for testing.
556
If it is unspecified, the global config will be used.
560
config = bzrlib.config.GlobalConfig()
561
alias = config.get_alias(cmd)
564
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
568
698
def run_bzr(argv):
569
699
"""Execute a command.
571
701
This is similar to main(), but without all the trappings for
572
logging and error handling.
575
The command-line arguments, without the program name from argv[0]
576
These should already be decoded. All library/test code calling
577
run_bzr should be passing valid strings (don't need decoding).
579
Returns a command status or raises an exception.
581
Special master options: these must come before the command because
582
they control how the command is interpreted.
585
Do not load plugin modules at all
591
Only use builtin commands. (Plugins are still allowed to change
595
Run under the Python hotshot profiler.
598
Run under the Python lsprof profiler.
702
logging and error handling.
601
trace.mutter("bzr arguments: %r", argv)
603
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
604
opt_no_aliases = False
605
opt_lsprof_file = None
607
# --no-plugins is handled specially at a very early stage. We need
608
# to load plugins before doing other command parsing so that they
609
# can override commands, but this needs to happen first.
617
elif a == '--lsprof':
619
elif a == '--lsprof-file':
621
opt_lsprof_file = argv[i + 1]
623
elif a == '--no-plugins':
624
opt_no_plugins = True
625
elif a == '--no-aliases':
626
opt_no_aliases = True
627
elif a == '--builtin':
629
elif a in ('--quiet', '-q'):
631
elif a.startswith('-D'):
632
debug.debug_flags.add(a[2:])
639
from bzrlib.builtins import cmd_help
640
cmd_help().run_argv_aliases([])
643
if argv[0] == '--version':
644
from bzrlib.version import show_version
648
if not opt_no_plugins:
649
from bzrlib.plugin import load_plugins
652
from bzrlib.plugin import disable_plugins
657
if not opt_no_aliases:
658
alias_argv = get_alias(argv[0])
660
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
661
argv[0] = alias_argv.pop(0)
664
# We want only 'ascii' command names, but the user may have typed
665
# in a Unicode name. In that case, they should just get a
666
# 'command not found' error later.
668
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
669
run = cmd_obj.run_argv_aliases
670
run_argv = [argv, alias_argv]
674
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
676
ret = apply_profiled(run, *run_argv)
681
# reset, in case we may do other commands later within the same process
682
trace.be_quiet(False)
684
def display_command(func):
685
"""Decorator that suppresses pipe/interrupt errors."""
686
def ignore_pipe(*args, **kwargs):
688
result = func(*args, **kwargs)
692
if getattr(e, 'errno', None) is None:
694
if e.errno != errno.EPIPE:
695
# Win32 raises IOError with errno=0 on a broken pipe
696
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
699
except KeyboardInterrupt:
705
args, opts = parse_args(argv[1:])
707
# TODO: pass down other arguments in case they asked for
708
# help on a command name?
711
elif 'version' in opts:
716
log_error('usage: bzr COMMAND\n')
717
log_error(' try "bzr help"\n')
721
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
723
bailout("unknown command " + `cmd`)
725
# TODO: special --profile option to turn on the Python profiler
727
# check options are reasonable
728
allowed = cmd_options.get(cmd, [])
730
if oname not in allowed:
731
bailout("option %r is not allowed for command %r"
734
cmdargs = _match_args(cmd, args)
737
ret = cmd_handler(**cmdargs) or 0
706
from bzrlib.ui.text import TextUIFactory
707
bzrlib.ui.ui_factory = TextUIFactory()
708
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
709
ret = run_bzr_catch_errors(argv)
710
trace.mutter("return code %d", ret)
714
def run_bzr_catch_errors(argv):
742
## TODO: Handle command-line options; probably know what options are valid for
745
## TODO: If the arguments are wrong, give a usage message rather
746
## than just a backtrace.
719
# do this here inside the exception wrappers to catch EPIPE
721
except (KeyboardInterrupt, Exception), e:
722
# used to handle AssertionError and KeyboardInterrupt
723
# specially here, but hopefully they're handled ok by the logger now
724
trace.report_exception(sys.exc_info(), sys.stderr)
725
if os.environ.get('BZR_PDB'):
726
print '**** entering debugger'
728
pdb.post_mortem(sys.exc_traceback)
732
class HelpCommandIndex(object):
733
"""A index for bzr help that returns commands."""
736
self.prefix = 'commands/'
738
def get_topics(self, topic):
739
"""Search for topic amongst commands.
741
:param topic: A topic to search for.
742
:return: A list which is either empty or contains a single
745
if topic and topic.startswith(self.prefix):
746
topic = topic[len(self.prefix):]
748
cmd = _get_cmd_object(topic)
749
# TODO: Lift into separate function in trace.py
750
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
751
# Perhaps that should eventually go into the platform library?
752
# TODO: If the file doesn't exist, add a note describing it.
753
t = bzrlib.trace._tracefile
754
t.write('-' * 60 + '\n')
755
t.write('bzr invoked at %s\n' % format_date(time.time()))
756
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
757
t.write(' arguments: %r\n' % argv)
759
starttime = os.times()[4]
762
t.write(' platform: %s\n' % platform.platform())
763
t.write(' python: %s\n' % platform.python_version())
768
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
770
mutter(" %.3f elapsed" % (times[4] - starttime))
774
log_error('bzr: error: ' + e.args[0] + '\n')
777
log_error(' ' + h + '\n')
780
log_error('bzr: exception: %s\n' % e)
781
log_error(' see .bzr.log for details\n')
782
traceback.print_exc(None, bzrlib.trace._tracefile)
783
traceback.print_exc(None, sys.stderr)
786
# TODO: Maybe nicer handling of IOError?
755
790
if __name__ == '__main__':
756
791
sys.exit(main(sys.argv))
793
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
