1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
11
# GNU General Public License for more details.
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Bazaar-NG -- a free distributed version-control tool
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
24
* Metadata format is not stable yet -- you may need to
25
discard history in the future.
27
* Many commands unimplemented or partially implemented.
29
* Space-inefficient storage.
31
* No merge operators yet.
38
Show software version/licence/non-warranty.
40
Start versioning the current directory
44
Show revision history.
47
bzr move FROM... DESTDIR
48
Move one or more files to a different directory.
50
Show changes from last revision to working copy.
51
bzr commit -m 'MESSAGE'
52
Store current state as new revision.
53
bzr export REVNO DESTINATION
54
Export the branch state at a previous version.
56
Show summary of pending changes.
58
Make a file not versioned.
60
Show statistics about this branch.
62
Verify history is stored safely.
63
(for more type 'bzr help commands')
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
71
from pprint import pprint
74
from inspect import getdoc
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Define arguments by objects, rather than just using names.
19
# Those objects can specify the expected type of the argument, which
20
# would help with validation and shell completion. They could also provide
21
# help/explanation for that argument in a structured way.
23
# TODO: Specific "examples" property on commands for consistent formatting.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
77
from bzrlib.store import ImmutableStore
78
from bzrlib.trace import mutter, note, log_error
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
from bzrlib.revision import Revision
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
89
## standard representation
90
NONE_STRING = '(none)'
94
## TODO: Perhaps a different version of inventory commands that
95
## returns iterators...
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
99
## TODO: Some kind of locking on branches. Perhaps there should be a
100
## parameter to the branch object saying whether we want a read or
101
## write lock; release it from destructor. Perhaps don't even need a
102
## read lock to look at immutable objects?
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
## to compare output?
107
## TODO: Some kind of global code to generate the right Branch object
108
## to work on. Almost, but not quite all, commands need one, and it
109
## can be taken either from their parameters or their working
124
def get_cmd_handler(cmd):
127
cmd = cmd_aliases.get(cmd, cmd)
130
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
132
raise BzrError("unknown command %r" % cmd)
134
return cmd, cmd_handler
138
def cmd_status(all=False):
139
"""Display status summary.
141
For each file there is a single line giving its file state and name.
142
The name is that in the current revision unless it is deleted or
143
missing, in which case the old name is shown.
145
#import bzrlib.status
146
#bzrlib.status.tree_status(Branch('.'))
147
Branch('.').show_status(show_all=all)
151
######################################################################
153
def cmd_get_revision(revision_id):
154
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
157
def cmd_get_file_text(text_id):
158
"""Get contents of a file by hash."""
159
sf = Branch('.').text_store[text_id]
160
pumpfile(sf, sys.stdout)
164
######################################################################
169
"""Show number of revisions on this branch"""
170
print Branch('.').revno()
174
def cmd_add(file_list, verbose=False):
175
"""Add specified files or directories.
177
In non-recursive mode, all the named items are added, regardless
178
of whether they were previously ignored. A warning is given if
179
any of the named files are already versioned.
181
In recursive mode (the default), files are treated the same way
182
but the behaviour for directories is different. Directories that
183
are already versioned do not give a warning. All directories,
184
whether already versioned or not, are searched for files or
185
subdirectories that are neither versioned or ignored, and these
186
are added. This search proceeds recursively into versioned
189
Therefore simply saying 'bzr add .' will version all files that
190
are currently unknown.
192
TODO: Perhaps adding a file whose directly is not versioned should
193
recursively add that parent, rather than giving an error?
195
bzrlib.add.smart_add(file_list, verbose)
198
def cmd_relpath(filename):
199
"""Show path of file relative to root"""
200
print Branch(filename).relpath(filename)
204
def cmd_inventory(revision=None):
205
"""Show inventory of the current working copy."""
206
## TODO: Also optionally show a previous inventory
207
## TODO: Format options
210
inv = b.read_working_inventory()
212
inv = b.get_revision_inventory(b.lookup_revision(revision))
214
for path, entry in inv.iter_entries():
215
print '%-50s %s' % (entry.file_id, path)
219
# TODO: Maybe a 'mv' command that has the combined move/rename
220
# special behaviour of Unix?
222
def cmd_move(source_list, dest):
225
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
229
def cmd_rename(from_name, to_name):
230
"""Change the name of an entry.
232
usage: bzr rename FROM_NAME TO_NAME
235
bzr rename frob.c frobber.c
236
bzr rename src/frob.c lib/frob.c
238
It is an error if the destination name exists.
240
See also the 'move' command, which moves files into a different
241
directory without changing their name.
243
TODO: Some way to rename multiple files without invoking bzr for each
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
251
def cmd_renames(dir='.'):
252
"""Show list of renamed files.
254
usage: bzr renames [BRANCH]
256
TODO: Option to show renames between two historical versions.
258
TODO: Only show renames under dir, rather than in the whole branch.
261
old_inv = b.basis_tree().inventory
262
new_inv = b.read_working_inventory()
264
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
266
for old_name, new_name in renames:
267
print "%s => %s" % (old_name, new_name)
272
"""info: Show statistical information for this branch
276
info.show_info(Branch('.'))
280
def cmd_remove(file_list, verbose=False):
281
b = Branch(file_list[0])
282
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
286
def cmd_file_id(filename):
287
"""Print file_id of a particular file or directory.
289
usage: bzr file-id FILE
291
The file_id is assigned when the file is first added and remains the
292
same through all revisions where the file exists, even when it is
296
i = b.inventory.path2id(b.relpath(filename))
298
bailout("%r is not a versioned file" % filename)
303
def cmd_file_id_path(filename):
304
"""Print path of file_ids to a file or directory.
306
usage: bzr file-id-path FILE
308
This prints one line for each directory down to the target,
309
starting at the branch root."""
312
fid = inv.path2id(b.relpath(filename))
314
bailout("%r is not a versioned file" % filename)
315
for fip in inv.get_idpath(fid):
319
def cmd_revision_history():
320
for patchid in Branch('.').revision_history():
324
def cmd_directories():
325
for name, ie in Branch('.').read_working_inventory().directories():
333
for name, ie in Branch('.').working_tree().missing():
338
# TODO: Check we're not already in a working directory? At the
339
# moment you'll get an ugly error.
341
# TODO: What if we're in a subdirectory of a branch? Would like
342
# to allow that, but then the parent may need to understand that
343
# the children have disappeared, or should they be versioned in
346
# TODO: Take an argument/option for branch name.
347
Branch('.', init=True)
350
def cmd_diff(revision=None, file_list=None):
351
"""bzr diff: Show differences in working tree.
353
usage: bzr diff [-r REV] [FILE...]
356
Show changes since REV, rather than predecessor.
358
If files are listed, only the changes in those files are listed.
359
Otherwise, all changes for the tree are listed.
361
TODO: Given two revision arguments, show the difference between them.
363
TODO: Allow diff across branches.
365
TODO: Option to use external diff command; could be GNU diff, wdiff,
368
TODO: Python difflib is not exactly the same as unidiff; should
369
either fix it up or prefer to use an external diff.
371
TODO: If a directory is given, diff everything under that.
373
TODO: Selected-file diff is inefficient and doesn't show you
376
TODO: This probably handles non-Unix newlines poorly.
379
## TODO: Shouldn't be in the cmd function.
384
old_tree = b.basis_tree()
386
old_tree = b.revision_tree(b.lookup_revision(revision))
388
new_tree = b.working_tree()
390
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
394
DEVNULL = '/dev/null'
395
# Windows users, don't panic about this filename -- it is a
396
# special signal to GNU patch that the file should be created or
397
# deleted respectively.
399
# TODO: Generation of pseudo-diffs for added/deleted files could
400
# be usefully made into a much faster special case.
402
# TODO: Better to return them in sorted order I think.
405
file_list = [b.relpath(f) for f in file_list]
407
# FIXME: If given a file list, compare only those files rather
408
# than comparing everything and then throwing stuff away.
410
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
412
if file_list and (new_name not in file_list):
415
# Don't show this by default; maybe do it if an option is passed
416
# idlabel = ' {%s}' % fid
419
# FIXME: Something about the diff format makes patch unhappy
420
# with newly-added files.
422
def diffit(oldlines, newlines, **kw):
424
# FIXME: difflib is wrong if there is no trailing newline.
425
# The syntax used by patch seems to be "\ No newline at
426
# end of file" following the last diff line from that
427
# file. This is not trivial to insert into the
428
# unified_diff output and it might be better to just fix
429
# or replace that function.
431
# In the meantime we at least make sure the patch isn't
435
# Special workaround for Python2.3, where difflib fails if
436
# both sequences are empty.
437
if not oldlines and not newlines:
442
if oldlines and (oldlines[-1][-1] != '\n'):
445
if newlines and (newlines[-1][-1] != '\n'):
449
ud = difflib.unified_diff(oldlines, newlines, **kw)
450
sys.stdout.writelines(ud)
452
print "\\ No newline at end of file"
453
sys.stdout.write('\n')
455
if file_state in ['.', '?', 'I']:
457
elif file_state == 'A':
458
print '*** added %s %r' % (kind, new_name)
461
new_tree.get_file(fid).readlines(),
463
tofile=new_label + new_name + idlabel)
464
elif file_state == 'D':
465
assert isinstance(old_name, types.StringTypes)
466
print '*** deleted %s %r' % (kind, old_name)
468
diffit(old_tree.get_file(fid).readlines(), [],
469
fromfile=old_label + old_name + idlabel,
471
elif file_state in ['M', 'R']:
472
if file_state == 'M':
473
assert kind == 'file'
474
assert old_name == new_name
475
print '*** modified %s %r' % (kind, new_name)
476
elif file_state == 'R':
477
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
480
diffit(old_tree.get_file(fid).readlines(),
481
new_tree.get_file(fid).readlines(),
482
fromfile=old_label + old_name + idlabel,
483
tofile=new_label + new_name)
485
bailout("can't represent state %s {%s}" % (file_state, fid))
489
def cmd_deleted(show_ids=False):
490
"""List files deleted in the working tree.
492
TODO: Show files deleted since a previous revision, or between two revisions.
496
new = b.working_tree()
498
## TODO: Much more efficient way to do this: read in new
499
## directories with readdir, rather than stating each one. Same
500
## level of effort but possibly much less IO. (Or possibly not,
501
## if the directories are very large...)
503
for path, ie in old.inventory.iter_entries():
504
if not new.has_id(ie.file_id):
506
print '%-50s %s' % (path, ie.file_id)
512
def cmd_parse_inventory():
515
cElementTree.ElementTree().parse(file('.bzr/inventory'))
519
def cmd_load_inventory():
520
"""Load inventory for timing purposes"""
521
Branch('.').basis_tree().inventory
524
def cmd_dump_inventory():
525
Branch('.').read_working_inventory().write_xml(sys.stdout)
528
def cmd_dump_new_inventory():
529
import bzrlib.newinventory
530
inv = Branch('.').basis_tree().inventory
531
bzrlib.newinventory.write_inventory(inv, sys.stdout)
534
def cmd_load_new_inventory():
535
import bzrlib.newinventory
536
bzrlib.newinventory.read_new_inventory(sys.stdin)
539
def cmd_dump_slacker_inventory():
540
import bzrlib.newinventory
541
inv = Branch('.').basis_tree().inventory
542
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
546
def cmd_dump_text_inventory():
547
import bzrlib.textinv
548
inv = Branch('.').basis_tree().inventory
549
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
552
def cmd_load_text_inventory():
553
import bzrlib.textinv
554
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
555
print 'loaded %d entries' % len(inv)
559
def cmd_root(filename=None):
560
"""Print the branch root."""
561
print bzrlib.branch.find_branch_root(filename)
564
def cmd_log(timezone='original', verbose=False):
565
"""Show log of this branch.
567
TODO: Options for utc; to show ids; to limit range; etc.
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
572
def cmd_ls(revision=None, verbose=False):
573
"""List files in a tree.
575
TODO: Take a revision or remote path and list that tree instead.
579
tree = b.working_tree()
581
tree = b.revision_tree(b.lookup_revision(revision))
583
for fp, fc, kind, fid in tree.list_files():
46
from bzrlib.hooks import Hooks
47
# Compatibility - Option used to be in commands.
48
from bzrlib.option import Option
49
from bzrlib.plugin import disable_plugins, load_plugins
50
from bzrlib import registry
51
from bzrlib.symbol_versioning import (
58
class CommandInfo(object):
59
"""Information about a command."""
61
def __init__(self, aliases):
62
"""The list of aliases for the command."""
63
self.aliases = aliases
66
def from_command(klass, command):
67
"""Factory to construct a CommandInfo from a command."""
68
return klass(command.aliases)
71
class CommandRegistry(registry.Registry):
72
"""Special registry mapping command names to command classes.
74
:ivar overridden_registry: Look in this registry for commands being
75
overridden by this registry. This can be used to tell plugin commands
76
about the builtin they're decorating.
80
registry.Registry.__init__(self)
81
self.overridden_registry = None
82
# map from aliases to the real command that implements the name
85
def get(self, command_name):
86
real_name = self._alias_dict.get(command_name, command_name)
87
return registry.Registry.get(self, real_name)
90
def _get_name(command_name):
91
if command_name.startswith("cmd_"):
92
return _unsquish_command_name(command_name)
96
def register(self, cmd, decorate=False):
97
"""Utility function to help register a command
99
:param cmd: Command subclass to register
100
:param decorate: If true, allow overriding an existing command
101
of the same name; the old command is returned by this function.
102
Otherwise it is an error to try to override an existing command.
105
k_unsquished = self._get_name(k)
107
previous = self.get(k_unsquished)
110
if self.overridden_registry:
112
previous = self.overridden_registry.get(k_unsquished)
115
info = CommandInfo.from_command(cmd)
117
registry.Registry.register(self, k_unsquished, cmd,
118
override_existing=decorate, info=info)
120
trace.warning('Two plugins defined the same command: %r' % k)
121
trace.warning('Not loading the one in %r' %
122
sys.modules[cmd.__module__])
123
trace.warning('Previously this command was registered from %r' %
124
sys.modules[previous.__module__])
125
for a in cmd.aliases:
126
self._alias_dict[a] = k_unsquished
129
def register_lazy(self, command_name, aliases, module_name):
130
"""Register a command without loading its module.
132
:param command_name: The primary name of the command.
133
:param aliases: A list of aliases for the command.
134
:module_name: The module that the command lives in.
136
key = self._get_name(command_name)
137
registry.Registry.register_lazy(self, key, module_name, command_name,
138
info=CommandInfo(aliases))
140
self._alias_dict[a] = key
143
plugin_cmds = CommandRegistry()
144
builtin_command_registry = CommandRegistry()
145
plugin_cmds.overridden_registry = builtin_command_registry
148
def register_command(cmd, decorate=False):
149
"""Register a plugin command.
151
Should generally be avoided in favor of lazy registration.
154
return plugin_cmds.register(cmd, decorate)
157
def _squish_command_name(cmd):
158
return 'cmd_' + cmd.replace('-', '_')
161
def _unsquish_command_name(cmd):
162
return cmd[4:].replace('_','-')
165
@deprecated_function(deprecated_in((2, 2, 0)))
166
def _builtin_commands():
167
"""Return a dict of {name: cmd_class} for builtin commands.
169
:deprecated: Use the builtin_command_registry registry instead
171
# return dict(name: cmd_class)
172
return dict(builtin_command_registry.items())
175
def _register_builtin_commands():
176
if builtin_command_registry.keys():
179
import bzrlib.builtins
180
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
181
builtin_command_registry.register(cmd_class)
182
bzrlib.builtins._register_lazy_builtins()
185
def _scan_module_for_commands(module):
187
for name, obj in module.__dict__.iteritems():
188
if name.startswith("cmd_"):
189
real_name = _unsquish_command_name(name)
194
def _list_bzr_commands(names):
195
"""Find commands from bzr's core and plugins.
197
This is not the public interface, just the default hook called by all_command_names.
199
# to eliminate duplicates
200
names.update(builtin_command_names())
201
names.update(plugin_command_names())
205
def all_command_names():
206
"""Return a set of all command names."""
208
for hook in Command.hooks['list_commands']:
211
raise AssertionError(
212
'hook %s returned None' % Command.hooks.get_hook_name(hook))
216
def builtin_command_names():
217
"""Return list of builtin command names.
219
Use of all_command_names() is encouraged rather than builtin_command_names
220
and/or plugin_command_names.
222
_register_builtin_commands()
223
return builtin_command_registry.keys()
226
def plugin_command_names():
227
"""Returns command names from commands registered by plugins."""
228
return plugin_cmds.keys()
231
def get_cmd_object(cmd_name, plugins_override=True):
232
"""Return the command object for a command.
235
If true, plugin commands can override builtins.
238
return _get_cmd_object(cmd_name, plugins_override)
240
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
244
"""Get a command object.
246
:param cmd_name: The name of the command.
247
:param plugins_override: Allow plugins to override builtins.
248
:param check_missing: Look up commands not found in the regular index via
249
the get_missing_command hook.
250
:return: A Command object instance
251
:raises KeyError: If no command is found.
253
# We want only 'ascii' command names, but the user may have typed
254
# in a Unicode name. In that case, they should just get a
255
# 'command not found' error later.
256
# In the future, we may actually support Unicode command names.
259
for hook in Command.hooks['get_command']:
260
cmd = hook(cmd, cmd_name)
261
if cmd is not None and not plugins_override and not cmd.plugin_name():
262
# We've found a non-plugin command, don't permit it to be
265
if cmd is None and check_missing:
266
for hook in Command.hooks['get_missing_command']:
273
# Allow plugins to extend commands
274
for hook in Command.hooks['extend_command']:
276
if getattr(cmd, 'invoked_as', None) is None:
277
cmd.invoked_as = cmd_name
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
324
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
342
class Command(object):
343
"""Base class for commands.
345
Commands are the heart of the command-line bzr interface.
347
The command object mostly handles the mapping of command-line
348
parameters into one or more bzrlib operations, and of the results
351
Commands normally don't have any state. All their arguments are
352
passed in to the run method. (Subclasses may take a different
353
policy if the behaviour of the instance needs to depend on e.g. a
354
shell plugin and not just its Python class.)
356
The docstring for an actual command should give a single-line
357
summary, then a complete description of the command. A grammar
358
description will be inserted.
360
:cvar aliases: Other accepted names for this command.
362
:cvar takes_args: List of argument forms, marked with whether they are
363
optional, repeated, etc. Examples::
365
['to_location', 'from_branch?', 'file*']
367
* 'to_location' is required
368
* 'from_branch' is optional
369
* 'file' can be specified 0 or more times
371
:cvar takes_options: List of options that may be given for this command.
372
These can be either strings, referring to globally-defined options, or
373
option objects. Retrieve through options().
375
:cvar hidden: If true, this command isn't advertised. This is typically
376
for commands intended for expert users.
378
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
379
been setup to properly handle encoding of unicode strings.
380
encoding_type determines what will happen when characters cannot be
383
* strict - abort if we cannot decode
384
* replace - put in a bogus character (typically '?')
385
* exact - do not encode sys.stdout
387
NOTE: by default on Windows, sys.stdout is opened as a text stream,
388
therefore LF line-endings are converted to CRLF. When a command uses
389
encoding_type = 'exact', then sys.stdout is forced to be a binary
390
stream, and line-endings will not mangled.
393
A string indicating the real name under which this command was
394
invoked, before expansion of aliases.
395
(This may be None if the command was constructed and run in-process.)
397
:cvar hooks: An instance of CommandHooks.
399
:cvar __doc__: The help shown by 'bzr help command' for this command.
400
This is set by assigning explicitly to __doc__ so that -OO can
404
__doc__ = "My help goes here"
409
encoding_type = 'strict'
415
"""Construct an instance of this command."""
416
# List of standard options directly supported
417
self.supported_std_options = []
420
def add_cleanup(self, cleanup_func, *args, **kwargs):
421
"""Register a function to call after self.run returns or raises.
423
Functions will be called in LIFO order.
425
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
def cleanup_now(self):
428
"""Execute and empty pending cleanup functions immediately.
430
After cleanup_now all registered cleanups are forgotten. add_cleanup
431
may be called again after cleanup_now; these cleanups will be called
432
after self.run returns or raises (or when cleanup_now is next called).
434
This is useful for releasing expensive or contentious resources (such
435
as write locks) before doing further work that does not require those
436
resources (such as writing results to self.outf). Note though, that
437
as it releases all resources, this may release locks that the command
438
wants to hold, so use should be done with care.
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
443
def _maybe_expand_globs(self, file_list):
444
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
449
:return: A possibly empty list of unicode paths.
451
Introduced in bzrlib 0.18.
456
"""Return single-line grammar for this command.
458
Only describes arguments, not options.
460
s = 'bzr ' + self.name() + ' '
461
for aname in self.takes_args:
462
aname = aname.upper()
463
if aname[-1] in ['$', '+']:
464
aname = aname[:-1] + '...'
465
elif aname[-1] == '?':
466
aname = '[' + aname[:-1] + ']'
467
elif aname[-1] == '*':
468
aname = '[' + aname[:-1] + '...]'
470
s = s[:-1] # remove last space
473
def get_help_text(self, additional_see_also=None, plain=True,
474
see_also_as_links=False, verbose=True):
475
"""Return a text string with help for this command.
477
:param additional_see_also: Additional help topics to be
479
:param plain: if False, raw help (reStructuredText) is
480
returned instead of plain text.
481
:param see_also_as_links: if True, convert items in 'See also'
482
list to internal links (used by bzr_man rstx generator)
483
:param verbose: if True, display the full help, otherwise
484
leave out the descriptive sections and just display
485
usage help (e.g. Purpose, Usage, Options) with a
486
message explaining how to obtain full help.
490
doc = "No help for this command."
492
# Extract the summary (purpose) and sections out from the text
493
purpose,sections,order = self._get_help_parts(doc)
495
# If a custom usage section was provided, use it
496
if sections.has_key('Usage'):
497
usage = sections.pop('Usage')
499
usage = self._usage()
501
# The header is the purpose and usage
503
result += ':Purpose: %s\n' % purpose
504
if usage.find('\n') >= 0:
505
result += ':Usage:\n%s\n' % usage
507
result += ':Usage: %s\n' % usage
512
# XXX: optparse implicitly rewraps the help, and not always perfectly,
513
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
515
options = option.get_optparser(self.options()).format_option_help()
516
# FIXME: According to the spec, ReST option lists actually don't
517
# support options like --1.14 so that causes syntax errors (in Sphinx
518
# at least). As that pattern always appears in the commands that
519
# break, we trap on that and then format that block of 'format' options
520
# as a literal block. We use the most recent format still listed so we
521
# don't have to do that too often -- vila 20110514
522
if not plain and options.find(' --1.14 ') != -1:
523
options = options.replace(' format:\n', ' format::\n\n', 1)
524
if options.startswith('Options:'):
525
result += ':' + options
526
elif options.startswith('options:'):
527
# Python 2.4 version of optparse
528
result += ':Options:' + options[len('options:'):]
585
if kind == 'directory':
534
# Add the description, indenting it 2 spaces
535
# to match the indentation of the options
536
if sections.has_key(None):
537
text = sections.pop(None)
538
text = '\n '.join(text.splitlines())
539
result += ':%s:\n %s\n\n' % ('Description',text)
541
# Add the custom sections (e.g. Examples). Note that there's no need
542
# to indent these as they must be indented already in the source.
545
if sections.has_key(label):
546
result += ':%s:\n%s\n' % (label,sections[label])
549
result += ("See bzr help %s for more details and examples.\n\n"
552
# Add the aliases, source (plug-in) and see also links, if any
554
result += ':Aliases: '
555
result += ', '.join(self.aliases) + '\n'
556
plugin_name = self.plugin_name()
557
if plugin_name is not None:
558
result += ':From: plugin "%s"\n' % plugin_name
559
see_also = self.get_see_also(additional_see_also)
561
if not plain and see_also_as_links:
563
for item in see_also:
565
# topics doesn't have an independent section
566
# so don't create a real link
567
see_also_links.append(item)
569
# Use a Sphinx link for this entry
570
link_text = ":doc:`%s <%s-help>`" % (item, item)
571
see_also_links.append(link_text)
572
see_also = see_also_links
573
result += ':See also: '
574
result += ', '.join(see_also) + '\n'
576
# If this will be rendered as plain text, convert it
578
import bzrlib.help_topics
579
result = bzrlib.help_topics.help_as_plain_text(result)
583
def _get_help_parts(text):
584
"""Split help text into a summary and named sections.
586
:return: (summary,sections,order) where summary is the top line and
587
sections is a dictionary of the rest indexed by section name.
588
order is the order the section appear in the text.
589
A section starts with a heading line of the form ":xxx:".
590
Indented text on following lines is the section value.
591
All text found outside a named section is assigned to the
592
default section which is given the key of None.
594
def save_section(sections, order, label, section):
596
if sections.has_key(label):
597
sections[label] += '\n' + section
600
sections[label] = section
602
lines = text.rstrip().splitlines()
603
summary = lines.pop(0)
606
label,section = None,''
608
if line.startswith(':') and line.endswith(':') and len(line) > 2:
609
save_section(sections, order, label, section)
610
label,section = line[1:-1],''
611
elif (label is not None) and len(line) > 1 and not line[0].isspace():
612
save_section(sections, order, label, section)
613
label,section = None,line
592
print '%-8s %s%s' % (fc, fp, kindch)
599
"""List unknown files"""
600
for f in Branch('.').unknowns():
606
"""List ignored files and the patterns that matched them.
608
tree = Branch('.').working_tree()
609
for path, file_class, kind, file_id in tree.list_files():
610
if file_class != 'I':
612
## XXX: Slightly inefficient since this was already calculated
613
pat = tree.is_ignored(path)
614
print '%-50s %s' % (path, pat)
617
def cmd_lookup_revision(revno):
621
bailout("usage: lookup-revision REVNO",
622
["REVNO is a non-negative revision number for this branch"])
624
print Branch('.').lookup_revision(revno) or NONE_STRING
628
def cmd_export(revno, dest):
629
"""Export past revision to destination directory."""
631
rh = b.lookup_revision(int(revno))
632
t = b.revision_tree(rh)
635
def cmd_cat(revision, filename):
636
"""Print file to stdout."""
638
b.print_file(b.relpath(filename), int(revision))
641
######################################################################
642
# internal/test commands
646
"""Print a newly-generated UUID."""
647
print bzrlib.osutils.uuid()
651
def cmd_local_time_offset():
652
print bzrlib.osutils.local_time_offset()
656
def cmd_commit(message=None, verbose=False):
657
"""Commit changes to a new revision.
660
Description of changes in this revision; free form text.
661
It is recommended that the first line be a single-sentence
664
Show status of changed files,
666
TODO: Commit only selected files.
668
TODO: Run hooks on tree to-be-committed, and after commit.
670
TODO: Strict commit that fails if there are unknown or deleted files.
674
bailout("please specify a commit message")
675
Branch('.').commit(message, verbose=verbose)
678
def cmd_check(dir='.'):
679
"""check: Consistency check of branch history.
681
usage: bzr check [-v] [BRANCH]
684
--verbose, -v Show progress of checking.
686
This command checks various invariants about the branch storage to
687
detect data corruption or bzr bugs.
690
bzrlib.check.check(Branch(dir, find_root=False))
693
def cmd_is(pred, *rest):
694
"""Test whether PREDICATE is true."""
696
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
698
bailout("unknown predicate: %s" % quotefn(pred))
702
except BzrCheckError:
703
# by default we don't print the message so that this can
704
# be used from shell scripts without producing noise
708
def cmd_whoami(email=False):
714
--email Show only the email address.
718
print bzrlib.osutils.user_email()
720
print bzrlib.osutils.username()
723
def cmd_gen_revision_id():
724
print bzrlib.branch._gen_revision_id(time.time())
728
"""Run internal test suite"""
729
## -v, if present, is seen by doctest; the argument is just here
730
## so our parser doesn't complain
732
## TODO: --verbose option
734
failures, tests = 0, 0
736
import doctest, bzrlib.store, bzrlib.tests
737
bzrlib.trace.verbose = False
739
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
740
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
741
mf, mt = doctest.testmod(m)
744
print '%-40s %3d tests' % (m.__name__, mt),
746
print '%3d FAILED!' % mf
750
print '%-40s %3d tests' % ('total', tests),
752
print '%3d FAILED!' % failures
759
cmd_doctest = cmd_selftest
762
######################################################################
766
def cmd_help(topic=None):
769
elif topic == 'commands':
772
# otherwise, maybe the name of a command?
773
topic, cmdfn = get_cmd_handler(topic)
777
bailout("sorry, no detailed help yet for %r" % topic)
783
"""List all commands"""
785
for k in globals().keys():
786
if k.startswith('cmd_'):
787
accu.append(k[4:].replace('_','-'))
789
print "bzr commands: "
792
print "note: some of these commands are internal-use or obsolete"
793
# TODO: Some kind of marker for internal-use commands?
794
# TODO: Show aliases?
800
print "bzr (bazaar-ng) %s" % bzrlib.__version__
801
print bzrlib.__copyright__
802
print "http://bazaar-ng.org/"
805
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
806
you may use, modify and redistribute it under the terms of the GNU
807
General Public License version 2 or later."""
811
"""Statement of optimism."""
812
print "it sure does!"
816
######################################################################
820
# list of all available options; the rhs can be either None for an
821
# option that takes no argument, or a constructor function that checks
842
# List of options that apply to particular commands; commands not
847
'commit': ['message', 'verbose'],
848
'deleted': ['show-ids'],
849
'diff': ['revision'],
850
'inventory': ['revision'],
851
'log': ['timezone', 'verbose'],
852
'ls': ['revision', 'verbose'],
853
'remove': ['verbose'],
864
'export': ['revno', 'dest'],
865
'file-id': ['filename'],
866
'file-id-path': ['filename'],
867
'get-file-text': ['text_id'],
868
'get-inventory': ['inventory_id'],
869
'get-revision': ['revision_id'],
870
'get-revision-inventory': ['revision_id'],
874
'lookup-revision': ['revno'],
875
'move': ['source$', 'dest'],
876
'relpath': ['filename'],
878
'rename': ['from_name', 'to_name'],
880
'root': ['filename?'],
885
def parse_args(argv):
616
section += '\n' + line
619
save_section(sections, order, label, section)
620
return summary, sections, order
622
def get_help_topic(self):
623
"""Return the commands help topic - its name."""
626
def get_see_also(self, additional_terms=None):
627
"""Return a list of help topics that are related to this command.
629
The list is derived from the content of the _see_also attribute. Any
630
duplicates are removed and the result is in lexical order.
631
:param additional_terms: Additional help topics to cross-reference.
632
:return: A list of help topics.
634
see_also = set(getattr(self, '_see_also', []))
636
see_also.update(additional_terms)
637
return sorted(see_also)
640
"""Return dict of valid options for this command.
642
Maps from long option name to option object."""
643
r = Option.STD_OPTIONS.copy()
645
for o in self.takes_options:
646
if isinstance(o, basestring):
647
o = option.Option.OPTIONS[o]
649
if o.name in std_names:
650
self.supported_std_options.append(o.name)
653
def _setup_outf(self):
654
"""Return a file linked to stdout, which has proper encoding."""
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
658
def run_argv_aliases(self, argv, alias_argv=None):
659
"""Parse the command line and run with extra aliases in alias_argv."""
660
args, opts = parse_args(self, argv, alias_argv)
662
# Process the standard options
663
if 'help' in opts: # e.g. bzr add --help
664
sys.stdout.write(self.get_help_text())
666
if 'usage' in opts: # e.g. bzr add --usage
667
sys.stdout.write(self.get_help_text(verbose=False))
669
trace.set_verbosity_level(option._verbosity_level)
670
if 'verbose' in self.supported_std_options:
671
opts['verbose'] = trace.is_verbose()
672
elif opts.has_key('verbose'):
674
if 'quiet' in self.supported_std_options:
675
opts['quiet'] = trace.is_quiet()
676
elif opts.has_key('quiet'):
679
# mix arguments and options into one dictionary
680
cmdargs = _match_argform(self.name(), self.takes_args, args)
682
for k, v in opts.items():
683
cmdopts[k.replace('-', '_')] = v
685
all_cmd_args = cmdargs.copy()
686
all_cmd_args.update(cmdopts)
691
return self.run(**all_cmd_args)
693
# reset it, so that other commands run in the same process won't
694
# inherit state. Before we reset it, log any activity, so that it
695
# gets properly tracked.
696
ui.ui_factory.log_transport_activity(
697
display=('bytes' in debug.debug_flags))
698
trace.set_verbosity_level(0)
700
def _setup_run(self):
701
"""Wrap the defined run method on self with a cleanup.
703
This is called by __init__ to make the Command be able to be run
704
by just calling run(), as it could be before cleanups were added.
706
If a different form of cleanups are in use by your Command subclass,
707
you can override this method.
710
def run(*args, **kwargs):
711
self._operation = cleanup.OperationWithCleanups(class_run)
713
return self._operation.run_simple(*args, **kwargs)
718
@deprecated_method(deprecated_in((2, 2, 0)))
719
def run_direct(self, *args, **kwargs):
720
"""Deprecated thunk from bzrlib 2.1."""
721
return self.run(*args, **kwargs)
724
"""Actually run the command.
726
This is invoked with the options and arguments bound to
729
Return 0 or None if the command was successful, or a non-zero
730
shell error code if not. It's OK for this method to allow
731
an exception to raise up.
733
This method is automatically wrapped by Command.__init__ with a
734
cleanup operation, stored as self._operation. This can be used
735
via self.add_cleanup to perform automatic cleanups at the end of
738
The argument for run are assembled by introspection. So for instance,
739
if your command takes an argument files, you would declare::
741
def run(self, files=None):
744
raise NotImplementedError('no implementation of command %r'
748
"""Return help message for this class."""
749
from inspect import getdoc
750
if self.__doc__ is Command.__doc__:
755
"""Return the canonical name for this command.
757
The name under which it was actually invoked is available in invoked_as.
759
return _unsquish_command_name(self.__class__.__name__)
761
def plugin_name(self):
762
"""Get the name of the plugin that provides this command.
764
:return: The name of the plugin or None if the command is builtin.
766
mod_parts = self.__module__.split('.')
767
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
773
class CommandHooks(Hooks):
774
"""Hooks related to Command object creation/enumeration."""
777
"""Create the default hooks.
779
These are all empty initially, because by default nothing should get
782
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
783
self.add_hook('extend_command',
784
"Called after creating a command object to allow modifications "
785
"such as adding or removing options, docs etc. Called with the "
786
"new bzrlib.commands.Command object.", (1, 13))
787
self.add_hook('get_command',
788
"Called when creating a single command. Called with "
789
"(cmd_or_None, command_name). get_command should either return "
790
"the cmd_or_None parameter, or a replacement Command object that "
791
"should be used for the command. Note that the Command.hooks "
792
"hooks are core infrastructure. Many users will prefer to use "
793
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
795
self.add_hook('get_missing_command',
796
"Called when creating a single command if no command could be "
797
"found. Called with (command_name). get_missing_command should "
798
"either return None, or a Command object to be used for the "
800
self.add_hook('list_commands',
801
"Called when enumerating commands. Called with a set of "
802
"cmd_name strings for all the commands found so far. This set "
803
" is safe to mutate - e.g. to remove a command. "
804
"list_commands should return the updated set of command names.",
807
Command.hooks = CommandHooks()
810
def parse_args(command, argv, alias_argv=None):
886
811
"""Parse command line.
888
813
Arguments and options are parsed at this level before being passed
889
814
down to specific command handlers. This routine knows, from a
890
815
lookup table, something about the available options, what optargs
891
816
they take, and which commands will accept them.
893
>>> parse_args('--help'.split())
895
>>> parse_args('--version'.split())
896
([], {'version': True})
897
>>> parse_args('status --all'.split())
898
(['status'], {'all': True})
899
>>> parse_args('commit --message=biter'.split())
900
(['commit'], {'message': u'biter'})
905
# TODO: Maybe handle '--' to end options?
910
# option names must not be unicode
914
mutter(" got option %r" % a)
916
optname, optarg = a[2:].split('=', 1)
919
if optname not in OPTIONS:
920
bailout('unknown long option %r' % a)
923
if shortopt not in SHORT_OPTIONS:
924
bailout('unknown short option %r' % a)
925
optname = SHORT_OPTIONS[shortopt]
928
# XXX: Do we ever want to support this, e.g. for -r?
929
bailout('repeated option %r' % a)
931
optargfn = OPTIONS[optname]
935
bailout('option %r needs an argument' % a)
938
opts[optname] = optargfn(optarg)
941
bailout('option %r takes no argument' % optname)
818
# TODO: make it a method of the Command?
819
parser = option.get_optparser(command.options())
820
if alias_argv is not None:
821
args = alias_argv + argv
825
# for python 2.5 and later, optparse raises this exception if a non-ascii
826
# option name is given. See http://bugs.python.org/issue2931
828
options, args = parser.parse_args(args)
829
except UnicodeEncodeError,e:
830
raise errors.BzrCommandError('Only ASCII permitted in option names')
832
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
833
v is not option.OptionParser.DEFAULT_VALUE])
946
834
return args, opts
950
def _match_args(cmd, args):
951
"""Check non-option arguments match required pattern.
953
>>> _match_args('status', ['asdasdsadasd'])
954
Traceback (most recent call last):
956
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
957
>>> _match_args('add', ['asdasdsadasd'])
958
{'file_list': ['asdasdsadasd']}
959
>>> _match_args('add', 'abc def gj'.split())
960
{'file_list': ['abc', 'def', 'gj']}
962
# match argument pattern
963
argform = cmd_args.get(cmd, [])
837
def _match_argform(cmd, takes_args, args):
965
# TODO: Need a way to express 'cp SRC... DEST', where it matches
968
# step through args and argform, allowing appropriate 0-many matches
840
# step through args and takes_args, allowing appropriate 0-many matches
841
for ap in takes_args:
970
842
argname = ap[:-1]
971
843
if ap[-1] == '?':
979
851
argdict[argname + '_list'] = None
980
852
elif ap[-1] == '+':
982
bailout("command %r needs one or more %s"
983
% (cmd, argname.upper()))
854
raise errors.BzrCommandError("command %r needs one or more %s"
855
% (cmd, argname.upper()))
985
857
argdict[argname + '_list'] = args[:]
987
859
elif ap[-1] == '$': # all but one
988
860
if len(args) < 2:
989
bailout("command %r needs one or more %s"
990
% (cmd, argname.upper()))
861
raise errors.BzrCommandError("command %r needs one or more %s"
862
% (cmd, argname.upper()))
991
863
argdict[argname + '_list'] = args[:-1]
994
866
# just a plain arg
997
bailout("command %r requires argument %s"
998
% (cmd, argname.upper()))
869
raise errors.BzrCommandError("command %r requires argument %s"
870
% (cmd, argname.upper()))
1000
872
argdict[argname] = args.pop(0)
1003
bailout("extra arguments to command %s: %r"
875
raise errors.BzrCommandError("extra argument to command %s: %s"
880
def apply_coveraged(dirname, the_callable, *args, **kwargs):
881
# Cannot use "import trace", as that would import bzrlib.trace instead of
882
# the standard library's trace.
883
trace = __import__('trace')
885
tracer = trace.Trace(count=1, trace=0)
886
sys.settrace(tracer.globaltrace)
887
threading.settrace(tracer.globaltrace)
890
return exception_to_return_code(the_callable, *args, **kwargs)
893
results = tracer.results()
894
results.write_results(show_missing=1, summary=False,
898
def apply_profiled(the_callable, *args, **kwargs):
902
pffileno, pfname = tempfile.mkstemp()
904
prof = hotshot.Profile(pfname)
906
ret = prof.runcall(exception_to_return_code, the_callable, *args,
910
stats = hotshot.stats.load(pfname)
912
stats.sort_stats('cum') # 'time'
913
## XXX: Might like to write to stderr or the trace file instead but
914
## print_stats seems hardcoded to stdout
915
stats.print_stats(20)
922
def exception_to_return_code(the_callable, *args, **kwargs):
923
"""UI level helper for profiling and coverage.
925
This transforms exceptions into a return value of 3. As such its only
926
relevant to the UI layer, and should never be called where catching
927
exceptions may be desirable.
930
return the_callable(*args, **kwargs)
931
except (KeyboardInterrupt, Exception), e:
932
# used to handle AssertionError and KeyboardInterrupt
933
# specially here, but hopefully they're handled ok by the logger now
934
exc_info = sys.exc_info()
935
exitcode = trace.report_exception(exc_info, sys.stderr)
936
if os.environ.get('BZR_PDB'):
937
print '**** entering debugger'
940
if sys.version_info[:2] < (2, 6):
942
# pdb.post_mortem(tb)
943
# but because pdb.post_mortem gives bad results for tracebacks
944
# from inside generators, we do it manually.
945
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
947
# Setup pdb on the traceback
950
p.setup(tb.tb_frame, tb)
951
# Point the debugger at the deepest frame of the stack
952
p.curindex = len(p.stack) - 1
953
p.curframe = p.stack[p.curindex][0]
954
# Start the pdb prompt.
955
p.print_stack_entry(p.stack[p.curindex])
963
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
964
from bzrlib.lsprof import profile
965
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
971
trace.note('Profile data written to "%s".', filename)
975
@deprecated_function(deprecated_in((2, 2, 0)))
976
def shlex_split_unicode(unsplit):
977
return cmdline.split(unsplit)
980
def get_alias(cmd, config=None):
981
"""Return an expanded alias, or None if no alias exists.
984
Command to be checked for an alias.
986
Used to specify an alternative config to use,
987
which is especially useful for testing.
988
If it is unspecified, the global config will be used.
992
config = bzrlib.config.GlobalConfig()
993
alias = config.get_alias(cmd)
995
return cmdline.split(alias)
999
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1011
1000
"""Execute a command.
1013
This is similar to main(), but without all the trappings for
1014
logging and error handling.
1002
:param argv: The command-line arguments, without the program name from
1003
argv[0] These should already be decoded. All library/test code calling
1004
run_bzr should be passing valid strings (don't need decoding).
1005
:param load_plugins: What function to call when triggering plugin loading.
1006
This function should take no arguments and cause all plugins to be
1008
:param disable_plugins: What function to call when disabling plugin
1009
loading. This function should take no arguments and cause all plugin
1010
loading to be prohibited (so that code paths in your application that
1011
know about some plugins possibly being present will fail to import
1012
those plugins even if they are installed.)
1013
:return: Returns a command exit code or raises an exception.
1015
Special master options: these must come before the command because
1016
they control how the command is interpreted.
1019
Do not load plugin modules at all
1022
Do not allow aliases
1025
Only use builtin commands. (Plugins are still allowed to change
1029
Run under the Python hotshot profiler.
1032
Run under the Python lsprof profiler.
1035
Generate line coverage report in the specified directory.
1038
Specify the number of processes that can be run concurrently (selftest).
1017
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1020
args, opts = parse_args(argv[1:])
1022
# TODO: pass down other arguments in case they asked for
1023
# help on a command name?
1029
elif 'version' in opts:
1032
cmd = str(args.pop(0))
1034
log_error('usage: bzr COMMAND')
1035
log_error(' try "bzr help"')
1038
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1041
if 'profile' in opts:
1047
# check options are reasonable
1048
allowed = cmd_options.get(canonical_cmd, [])
1050
if oname not in allowed:
1051
bailout("option %r is not allowed for command %r"
1054
# TODO: give an error if there are any mandatory options which are
1055
# not specified? Or maybe there shouldn't be any "mandatory
1056
# options" (it is an oxymoron)
1058
# mix arguments and options into one dictionary
1059
cmdargs = _match_args(canonical_cmd, args)
1060
for k, v in opts.items():
1061
cmdargs[k.replace('-', '_')] = v
1065
pffileno, pfname = tempfile.mkstemp()
1067
prof = hotshot.Profile(pfname)
1068
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1071
import hotshot.stats
1072
stats = hotshot.stats.load(pfname)
1074
stats.sort_stats('time')
1075
## XXX: Might like to write to stderr or the trace file instead but
1076
## print_stats seems hardcoded to stdout
1077
stats.print_stats(20)
1085
return cmd_handler(**cmdargs) or 0
1089
def _report_exception(e, summary):
1091
log_error('bzr: ' + summary)
1092
bzrlib.trace.log_exception(e)
1093
tb = sys.exc_info()[2]
1094
exinfo = traceback.extract_tb(tb)
1096
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1097
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1100
def cmd_assert_fail():
1101
assert False, "always fails"
1105
bzrlib.trace.create_tracefile(argv)
1112
_report_exception(e, 'error: ' + e.args[0])
1115
# some explanation or hints
1118
except AssertionError, e:
1119
msg = 'assertion failed'
1121
msg += ': ' + str(e)
1122
_report_exception(e, msg)
1123
except Exception, e:
1124
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1040
trace.mutter("bazaar version: " + bzrlib.__version__)
1041
argv = _specified_or_unicode_argv(argv)
1042
trace.mutter("bzr arguments: %r", argv)
1044
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1045
opt_no_aliases = False
1046
opt_lsprof_file = opt_coverage_dir = None
1048
# --no-plugins is handled specially at a very early stage. We need
1049
# to load plugins before doing other command parsing so that they
1050
# can override commands, but this needs to happen first.
1054
while i < len(argv):
1056
if a == '--profile':
1058
elif a == '--lsprof':
1060
elif a == '--lsprof-file':
1062
opt_lsprof_file = argv[i + 1]
1064
elif a == '--no-plugins':
1065
opt_no_plugins = True
1066
elif a == '--no-aliases':
1067
opt_no_aliases = True
1068
elif a == '--builtin':
1070
elif a == '--concurrency':
1071
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1073
elif a == '--coverage':
1074
opt_coverage_dir = argv[i + 1]
1076
elif a == '--profile-imports':
1077
pass # already handled in startup script Bug #588277
1078
elif a.startswith('-D'):
1079
debug.debug_flags.add(a[2:])
1084
debug.set_debug_flags_from_config()
1086
if not opt_no_plugins:
1093
get_cmd_object('help').run_argv_aliases([])
1096
if argv[0] == '--version':
1097
get_cmd_object('version').run_argv_aliases([])
1102
if not opt_no_aliases:
1103
alias_argv = get_alias(argv[0])
1105
argv[0] = alias_argv.pop(0)
1108
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1109
run = cmd_obj.run_argv_aliases
1110
run_argv = [argv, alias_argv]
1113
# We can be called recursively (tests for example), but we don't want
1114
# the verbosity level to propagate.
1115
saved_verbosity_level = option._verbosity_level
1116
option._verbosity_level = 0
1118
if opt_coverage_dir:
1120
'--coverage ignored, because --lsprof is in use.')
1121
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1123
if opt_coverage_dir:
1125
'--coverage ignored, because --profile is in use.')
1126
ret = apply_profiled(run, *run_argv)
1127
elif opt_coverage_dir:
1128
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1130
ret = run(*run_argv)
1127
bzrlib.trace.close_trace()
1129
## TODO: Trap AssertionError
1131
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1135
if __name__ == '__main__':
1136
sys.exit(main(sys.argv))
1133
# reset, in case we may do other commands later within the same
1134
# process. Commands that want to execute sub-commands must propagate
1135
# --verbose in their own way.
1136
if 'memory' in debug.debug_flags:
1137
trace.debug_memory('Process status after command:', short=False)
1138
option._verbosity_level = saved_verbosity_level
1141
def display_command(func):
1142
"""Decorator that suppresses pipe/interrupt errors."""
1143
def ignore_pipe(*args, **kwargs):
1145
result = func(*args, **kwargs)
1149
if getattr(e, 'errno', None) is None:
1151
if e.errno != errno.EPIPE:
1152
# Win32 raises IOError with errno=0 on a broken pipe
1153
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1156
except KeyboardInterrupt:
1161
def install_bzr_command_hooks():
1162
"""Install the hooks to supply bzr's own commands."""
1163
if _list_bzr_commands in Command.hooks["list_commands"]:
1165
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1167
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1169
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1170
"bzr plugin commands")
1171
Command.hooks.install_named_hook("get_command", _get_external_command,
1172
"bzr external command lookup")
1173
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1174
"bzr plugin-provider-db check")
1178
def _specified_or_unicode_argv(argv):
1179
# For internal or testing use, argv can be passed. Otherwise, get it from
1180
# the process arguments in a unicode-safe way.
1182
return osutils.get_unicode_argv()
1186
# ensure all arguments are unicode strings
1188
if isinstance(a, unicode):
1191
new_argv.append(a.decode('ascii'))
1192
except UnicodeDecodeError:
1193
raise errors.BzrError("argv should be list of unicode strings.")
1197
def main(argv=None):
1198
"""Main entry point of command-line interface.
1200
Typically `bzrlib.initialize` should be called first.
1202
:param argv: list of unicode command-line arguments similar to sys.argv.
1203
argv[0] is script name usually, it will be ignored.
1204
Don't pass here sys.argv because this list contains plain strings
1205
and not unicode; pass None instead.
1207
:return: exit code of bzr command.
1209
if argv is not None:
1211
_register_builtin_commands()
1212
ret = run_bzr_catch_errors(argv)
1213
trace.mutter("return code %d", ret)
1217
def run_bzr_catch_errors(argv):
1218
"""Run a bzr command with parameters as described by argv.
1220
This function assumed that that UI layer is setup, that symbol deprecations
1221
are already applied, and that unicode decoding has already been performed on argv.
1223
# done here so that they're covered for every test run
1224
install_bzr_command_hooks()
1225
return exception_to_return_code(run_bzr, argv)
1228
def run_bzr_catch_user_errors(argv):
1229
"""Run bzr and report user errors, but let internal errors propagate.
1231
This is used for the test suite, and might be useful for other programs
1232
that want to wrap the commandline interface.
1234
# done here so that they're covered for every test run
1235
install_bzr_command_hooks()
1237
return run_bzr(argv)
1238
except Exception, e:
1239
if (isinstance(e, (OSError, IOError))
1240
or not getattr(e, 'internal_error', True)):
1241
trace.report_exception(sys.exc_info(), sys.stderr)
1247
class HelpCommandIndex(object):
1248
"""A index for bzr help that returns commands."""
1251
self.prefix = 'commands/'
1253
def get_topics(self, topic):
1254
"""Search for topic amongst commands.
1256
:param topic: A topic to search for.
1257
:return: A list which is either empty or contains a single
1260
if topic and topic.startswith(self.prefix):
1261
topic = topic[len(self.prefix):]
1263
cmd = _get_cmd_object(topic, check_missing=False)
1270
class Provider(object):
1271
"""Generic class to be overriden by plugins"""
1273
def plugin_for_command(self, cmd_name):
1274
"""Takes a command and returns the information for that plugin
1276
:return: A dictionary with all the available information
1277
for the requested plugin
1279
raise NotImplementedError
1282
class ProvidersRegistry(registry.Registry):
1283
"""This registry exists to allow other providers to exist"""
1286
for key, provider in self.iteritems():
1289
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
