1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2010 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
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
69
from pprint import pprint
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(), """
33
from warnings import warn
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
113
## TODO: move command; check destination is a directory and will not
116
## TODO: command to show renames, one per line, as to->from
121
def cmd_status(all=False):
122
"""Display status summary.
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
128
:todo: Don't show unchanged files unless ``--all`` is given?
130
Branch('.').show_status(show_all=all)
134
######################################################################
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
147
######################################################################
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
175
bzrlib.add.smart_add(file_list, verbose)
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
199
"""info: Show statistical information for this branch
203
info.show_info(Branch('.'))
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
213
def cmd_file_id(filename):
215
i = b.inventory.path2id(b.relpath(filename))
217
bailout("%s is not a versioned file" % filename)
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
225
bailout("%s is not a live file id" % fileid)
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
252
usage: bzr diff [-r REV]
255
Show changes since REV, rather than predecessor.
257
TODO: Given two revision arguments, show the difference between them.
259
TODO: Allow diff across branches.
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
264
TODO: Diff selected files.
267
## TODO: Shouldn't be in the cmd function.
272
old_tree = b.basis_tree()
274
old_tree = b.revision_tree(b.lookup_revision(revision))
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
292
# TODO: Better to return them in sorted order I think.
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
308
if file_state in ['.', '?', 'I']:
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
314
new_tree.get_file(fid).readlines(),
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
338
bailout("can't represent state %s {%s}" % (file_state, fid))
342
def cmd_deleted(show_ids=False):
343
"""List files deleted in the working tree.
345
TODO: Show files deleted since a previous revision, or between two revisions.
349
new = b.working_tree()
351
for path, ie in old.inventory.iter_entries():
352
if not new.has_id(ie.file_id):
354
print '%-50s %s' % (path, ie.file_id)
361
def cmd_root(filename=None):
362
"""Print the branch root."""
363
print bzrlib.branch.find_branch_root(filename)
366
def cmd_log(timezone='original'):
367
"""Show log of this branch.
369
:todo: Options for utc; to show ids; to limit range; etc.
371
Branch('.').write_log(show_timezone=timezone)
374
def cmd_ls(revision=None, verbose=False):
375
"""List files in a tree.
377
:todo: Take a revision or remote path and list that tree instead.
381
tree = b.working_tree()
383
tree = b.revision_tree(b.lookup_revision(revision))
385
for fp, fc, kind, fid in tree.list_files():
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
157
return plugin_cmds.register(cmd, decorate)
160
def _squish_command_name(cmd):
161
return 'cmd_' + cmd.replace('-', '_')
164
def _unsquish_command_name(cmd):
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
191
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
def builtin_command_names():
220
"""Return list of builtin command names.
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
return plugin_cmds.keys()
233
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
237
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
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.
361
Other accepted names for this command.
364
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
381
If true, this command isn't advertised. This is typically
382
for commands intended for expert users.
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
399
:cvar hooks: An instance of CommandHooks.
400
:ivar __doc__: The help shown by 'bzr help command' for this command.
401
This is set by assigning explicitly to __doc__ so that -OO can
405
__doc__ = "My help goes here"
410
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
# XXX: According to the spec, ReST option lists actually don't support
517
# options like --1.9 so that causes syntax errors (in Sphinx at least).
518
# As that pattern always appears in the commands that break, we trap
519
# on that and then format that block of 'format' options as a literal
521
if not plain and options.find(' --1.9 ') != -1:
522
options = options.replace(' format:\n', ' format::\n\n', 1)
523
if options.startswith('Options:'):
524
result += ':' + options
525
elif options.startswith('options:'):
526
# Python 2.4 version of optparse
527
result += ':Options:' + options[len('options:'):]
387
if kind == 'directory':
533
# Add the description, indenting it 2 spaces
534
# to match the indentation of the options
535
if sections.has_key(None):
536
text = sections.pop(None)
537
text = '\n '.join(text.splitlines())
538
result += ':%s:\n %s\n\n' % ('Description',text)
540
# Add the custom sections (e.g. Examples). Note that there's no need
541
# to indent these as they must be indented already in the source.
544
if sections.has_key(label):
545
result += ':%s:\n%s\n' % (label,sections[label])
548
result += ("See bzr help %s for more details and examples.\n\n"
551
# Add the aliases, source (plug-in) and see also links, if any
553
result += ':Aliases: '
554
result += ', '.join(self.aliases) + '\n'
555
plugin_name = self.plugin_name()
556
if plugin_name is not None:
557
result += ':From: plugin "%s"\n' % plugin_name
558
see_also = self.get_see_also(additional_see_also)
560
if not plain and see_also_as_links:
562
for item in see_also:
564
# topics doesn't have an independent section
565
# so don't create a real link
566
see_also_links.append(item)
568
# Use a Sphinx link for this entry
569
link_text = ":doc:`%s <%s-help>`" % (item, item)
570
see_also_links.append(link_text)
571
see_also = see_also_links
572
result += ':See also: '
573
result += ', '.join(see_also) + '\n'
575
# If this will be rendered as plain text, convert it
577
import bzrlib.help_topics
578
result = bzrlib.help_topics.help_as_plain_text(result)
582
def _get_help_parts(text):
583
"""Split help text into a summary and named sections.
585
:return: (summary,sections,order) where summary is the top line and
586
sections is a dictionary of the rest indexed by section name.
587
order is the order the section appear in the text.
588
A section starts with a heading line of the form ":xxx:".
589
Indented text on following lines is the section value.
590
All text found outside a named section is assigned to the
591
default section which is given the key of None.
593
def save_section(sections, order, label, section):
595
if sections.has_key(label):
596
sections[label] += '\n' + section
599
sections[label] = section
601
lines = text.rstrip().splitlines()
602
summary = lines.pop(0)
605
label,section = None,''
607
if line.startswith(':') and line.endswith(':') and len(line) > 2:
608
save_section(sections, order, label, section)
609
label,section = line[1:-1],''
610
elif (label is not None) and len(line) > 1 and not line[0].isspace():
611
save_section(sections, order, label, section)
612
label,section = None,line
394
print '%-8s %s%s' % (fc, fp, kindch)
401
"""List unknown files"""
402
for f in Branch('.').unknowns():
407
def cmd_ignored(verbose=True):
408
"""List ignored files and the patterns that matched them.
410
tree = Branch('.').working_tree()
411
for path, file_class, kind, id in tree.list_files():
412
if file_class != 'I':
414
## XXX: Slightly inefficient since this was already calculated
415
pat = tree.is_ignored(path)
416
print '%-50s %s' % (path, pat)
419
def cmd_lookup_revision(revno):
423
bailout("usage: lookup-revision REVNO",
424
["REVNO is a non-negative revision number for this branch"])
426
print Branch('.').lookup_revision(revno) or NONE_STRING
430
def cmd_export(revno, dest):
431
"""Export past revision to destination directory."""
433
rh = b.lookup_revision(int(revno))
434
t = b.revision_tree(rh)
439
######################################################################
440
# internal/test commands
444
"""Print a newly-generated UUID."""
445
print bzrlib.osutils.uuid()
449
def cmd_local_time_offset():
450
print bzrlib.osutils.local_time_offset()
454
def cmd_commit(message=None, verbose=False):
455
"""Commit changes to a new revision.
458
Description of changes in this revision; free form text.
459
It is recommended that the first line be a single-sentence
462
Show status of changed files,
464
TODO: Commit only selected files.
466
TODO: Run hooks on tree to-be-committed, and after commit.
468
TODO: Strict commit that fails if there are unknown or deleted files.
472
bailout("please specify a commit message")
473
Branch('.').commit(message, verbose=verbose)
476
def cmd_check(dir='.'):
477
"""check: Consistency check of branch history.
479
usage: bzr check [-v] [BRANCH]
482
--verbose, -v Show progress of checking.
484
This command checks various invariants about the branch storage to
485
detect data corruption or bzr bugs.
488
bzrlib.check.check(Branch(dir, find_root=False))
491
def cmd_is(pred, *rest):
492
"""Test whether PREDICATE is true."""
494
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
496
bailout("unknown predicate: %s" % quotefn(pred))
500
except BzrCheckError:
501
# by default we don't print the message so that this can
502
# be used from shell scripts without producing noise
507
print bzrlib.osutils.username()
510
def cmd_user_email():
511
print bzrlib.osutils.user_email()
514
def cmd_gen_revision_id():
516
print bzrlib.branch._gen_revision_id(time.time())
519
def cmd_selftest(verbose=False):
520
"""Run internal test suite"""
521
## -v, if present, is seen by doctest; the argument is just here
522
## so our parser doesn't complain
524
## TODO: --verbose option
526
failures, tests = 0, 0
528
import doctest, bzrlib.store, bzrlib.tests
529
bzrlib.trace.verbose = False
531
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
532
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
533
mf, mt = doctest.testmod(m)
536
print '%-40s %3d tests' % (m.__name__, mt),
538
print '%3d FAILED!' % mf
542
print '%-40s %3d tests' % ('total', tests),
544
print '%3d FAILED!' % failures
551
cmd_doctest = cmd_selftest
554
######################################################################
558
def cmd_help(topic=None):
563
# otherwise, maybe the name of a command?
565
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
567
bailout("no help for %r" % topic)
571
bailout("sorry, no detailed help yet for %r" % topic)
579
print "bzr (bazaar-ng) %s" % bzrlib.__version__
580
print bzrlib.__copyright__
581
print "http://bazaar-ng.org/"
584
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
585
you may use, modify and redistribute it under the terms of the GNU
586
General Public License version 2 or later."""
590
"""Statement of optimism."""
591
print "it sure does!"
595
######################################################################
599
# list of all available options; the rhs can be either None for an
600
# option that takes no argument, or a constructor function that checks
620
# List of options that apply to particular commands; commands not
624
'commit': ['message', 'verbose'],
625
'deleted': ['show-ids'],
626
'diff': ['revision'],
627
'inventory': ['revision'],
629
'ls': ['revision', 'verbose'],
630
'remove': ['verbose'],
639
'export': ['revno', 'dest'],
640
'file-id': ['filename'],
641
'get-file-text': ['text_id'],
642
'get-inventory': ['inventory_id'],
643
'get-revision': ['revision_id'],
644
'get-revision-inventory': ['revision_id'],
648
'lookup-revision': ['revno'],
649
'relpath': ['filename'],
651
'root': ['filename?'],
656
def parse_args(argv):
615
section += '\n' + line
618
save_section(sections, order, label, section)
619
return summary, sections, order
621
def get_help_topic(self):
622
"""Return the commands help topic - its name."""
625
def get_see_also(self, additional_terms=None):
626
"""Return a list of help topics that are related to this command.
628
The list is derived from the content of the _see_also attribute. Any
629
duplicates are removed and the result is in lexical order.
630
:param additional_terms: Additional help topics to cross-reference.
631
:return: A list of help topics.
633
see_also = set(getattr(self, '_see_also', []))
635
see_also.update(additional_terms)
636
return sorted(see_also)
639
"""Return dict of valid options for this command.
641
Maps from long option name to option object."""
642
r = Option.STD_OPTIONS.copy()
644
for o in self.takes_options:
645
if isinstance(o, basestring):
646
o = option.Option.OPTIONS[o]
648
if o.name in std_names:
649
self.supported_std_options.append(o.name)
652
def _setup_outf(self):
653
"""Return a file linked to stdout, which has proper encoding."""
654
self.outf = ui.ui_factory.make_output_stream(
655
encoding_type=self.encoding_type)
657
def run_argv_aliases(self, argv, alias_argv=None):
658
"""Parse the command line and run with extra aliases in alias_argv."""
659
args, opts = parse_args(self, argv, alias_argv)
661
# Process the standard options
662
if 'help' in opts: # e.g. bzr add --help
663
sys.stdout.write(self.get_help_text())
665
if 'usage' in opts: # e.g. bzr add --usage
666
sys.stdout.write(self.get_help_text(verbose=False))
668
trace.set_verbosity_level(option._verbosity_level)
669
if 'verbose' in self.supported_std_options:
670
opts['verbose'] = trace.is_verbose()
671
elif opts.has_key('verbose'):
673
if 'quiet' in self.supported_std_options:
674
opts['quiet'] = trace.is_quiet()
675
elif opts.has_key('quiet'):
678
# mix arguments and options into one dictionary
679
cmdargs = _match_argform(self.name(), self.takes_args, args)
681
for k, v in opts.items():
682
cmdopts[k.replace('-', '_')] = v
684
all_cmd_args = cmdargs.copy()
685
all_cmd_args.update(cmdopts)
689
return self.run(**all_cmd_args)
691
def _setup_run(self):
692
"""Wrap the defined run method on self with a cleanup.
694
This is called by __init__ to make the Command be able to be run
695
by just calling run(), as it could be before cleanups were added.
697
If a different form of cleanups are in use by your Command subclass,
698
you can override this method.
701
def run(*args, **kwargs):
702
self._operation = cleanup.OperationWithCleanups(class_run)
704
return self._operation.run_simple(*args, **kwargs)
709
@deprecated_method(deprecated_in((2, 2, 0)))
710
def run_direct(self, *args, **kwargs):
711
"""Deprecated thunk from bzrlib 2.1."""
712
return self.run(*args, **kwargs)
715
"""Actually run the command.
717
This is invoked with the options and arguments bound to
720
Return 0 or None if the command was successful, or a non-zero
721
shell error code if not. It's OK for this method to allow
722
an exception to raise up.
724
This method is automatically wrapped by Command.__init__ with a
725
cleanup operation, stored as self._operation. This can be used
726
via self.add_cleanup to perform automatic cleanups at the end of
729
The argument for run are assembled by introspection. So for instance,
730
if your command takes an argument files, you would declare::
732
def run(self, files=None):
735
raise NotImplementedError('no implementation of command %r'
739
"""Return help message for this class."""
740
from inspect import getdoc
741
if self.__doc__ is Command.__doc__:
746
return _unsquish_command_name(self.__class__.__name__)
748
def plugin_name(self):
749
"""Get the name of the plugin that provides this command.
751
:return: The name of the plugin or None if the command is builtin.
753
mod_parts = self.__module__.split('.')
754
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
760
class CommandHooks(Hooks):
761
"""Hooks related to Command object creation/enumeration."""
764
"""Create the default hooks.
766
These are all empty initially, because by default nothing should get
770
self.create_hook(HookPoint('extend_command',
771
"Called after creating a command object to allow modifications "
772
"such as adding or removing options, docs etc. Called with the "
773
"new bzrlib.commands.Command object.", (1, 13), None))
774
self.create_hook(HookPoint('get_command',
775
"Called when creating a single command. Called with "
776
"(cmd_or_None, command_name). get_command should either return "
777
"the cmd_or_None parameter, or a replacement Command object that "
778
"should be used for the command. Note that the Command.hooks "
779
"hooks are core infrastructure. Many users will prefer to use "
780
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
self.create_hook(HookPoint('get_missing_command',
783
"Called when creating a single command if no command could be "
784
"found. Called with (command_name). get_missing_command should "
785
"either return None, or a Command object to be used for the "
786
"command.", (1, 17), None))
787
self.create_hook(HookPoint('list_commands',
788
"Called when enumerating commands. Called with a set of "
789
"cmd_name strings for all the commands found so far. This set "
790
" is safe to mutate - e.g. to remove a command. "
791
"list_commands should return the updated set of command names.",
794
Command.hooks = CommandHooks()
797
def parse_args(command, argv, alias_argv=None):
657
798
"""Parse command line.
659
800
Arguments and options are parsed at this level before being passed
660
801
down to specific command handlers. This routine knows, from a
661
802
lookup table, something about the available options, what optargs
662
803
they take, and which commands will accept them.
664
>>> parse_args('--help'.split())
666
>>> parse_args('--version'.split())
667
([], {'version': True})
668
>>> parse_args('status --all'.split())
669
(['status'], {'all': True})
670
>>> parse_args('commit --message=biter'.split())
671
(['commit'], {'message': u'biter'})
676
# TODO: Maybe handle '--' to end options?
683
mutter(" got option %r" % a)
685
optname, optarg = a[2:].split('=', 1)
688
if optname not in OPTIONS:
689
bailout('unknown long option %r' % a)
692
if shortopt not in SHORT_OPTIONS:
693
bailout('unknown short option %r' % a)
694
optname = SHORT_OPTIONS[shortopt]
697
# XXX: Do we ever want to support this, e.g. for -r?
698
bailout('repeated option %r' % a)
700
optargfn = OPTIONS[optname]
704
bailout('option %r needs an argument' % a)
707
opts[optname] = optargfn(optarg)
710
bailout('option %r takes no argument' % optname)
805
# TODO: make it a method of the Command?
806
parser = option.get_optparser(command.options())
807
if alias_argv is not None:
808
args = alias_argv + argv
812
options, args = parser.parse_args(args)
813
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
814
v is not option.OptionParser.DEFAULT_VALUE])
715
815
return args, opts
719
def _match_args(cmd, args):
720
"""Check non-option arguments match required pattern.
722
>>> _match_args('status', ['asdasdsadasd'])
723
Traceback (most recent call last):
725
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
726
>>> _match_args('add', ['asdasdsadasd'])
727
{'file_list': ['asdasdsadasd']}
728
>>> _match_args('add', 'abc def gj'.split())
729
{'file_list': ['abc', 'def', 'gj']}
731
# match argument pattern
732
argform = cmd_args.get(cmd, [])
818
def _match_argform(cmd, takes_args, args):
734
# TODO: Need a way to express 'cp SRC... DEST', where it matches
737
# step through args and argform, allowing appropriate 0-many matches
821
# step through args and takes_args, allowing appropriate 0-many matches
822
for ap in takes_args:
739
823
argname = ap[:-1]
740
824
if ap[-1] == '?':
742
826
argdict[argname] = args.pop(0)
827
elif ap[-1] == '*': # all remaining arguments
829
argdict[argname + '_list'] = args[:]
832
argdict[argname + '_list'] = None
745
833
elif ap[-1] == '+':
747
bailout("command %r needs one or more %s"
748
% (cmd, argname.upper()))
835
raise errors.BzrCommandError("command %r needs one or more %s"
836
% (cmd, argname.upper()))
750
838
argdict[argname + '_list'] = args[:]
840
elif ap[-1] == '$': # all but one
842
raise errors.BzrCommandError("command %r needs one or more %s"
843
% (cmd, argname.upper()))
844
argdict[argname + '_list'] = args[:-1]
753
847
# just a plain arg
756
bailout("command %r requires argument %s"
757
% (cmd, argname.upper()))
850
raise errors.BzrCommandError("command %r requires argument %s"
851
% (cmd, argname.upper()))
759
853
argdict[argname] = args.pop(0)
762
bailout("extra arguments to command %s: %r"
856
raise errors.BzrCommandError("extra argument to command %s: %s"
770
"""Execute a command.
772
This is similar to main(), but without all the trappings for
773
logging and error handling.
776
args, opts = parse_args(argv[1:])
778
# TODO: pass down other arguments in case they asked for
779
# help on a command name?
782
elif 'version' in opts:
787
log_error('usage: bzr COMMAND\n')
788
log_error(' try "bzr help"\n')
792
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
794
bailout("unknown command " + `cmd`)
797
if 'profile' in opts:
803
# check options are reasonable
804
allowed = cmd_options.get(cmd, [])
806
if oname not in allowed:
807
bailout("option %r is not allowed for command %r"
810
# mix arguments and options into one dictionary
811
cmdargs = _match_args(cmd, args)
812
for k, v in opts.items():
813
cmdargs[k.replace('-', '_')] = v
817
prof = hotshot.Profile('.bzr.profile')
818
ret = prof.runcall(cmd_handler, **cmdargs) or 0
822
stats = hotshot.stats.load('.bzr.profile')
824
stats.sort_stats('cumulative', 'calls')
861
def apply_coveraged(dirname, the_callable, *args, **kwargs):
862
# Cannot use "import trace", as that would import bzrlib.trace instead of
863
# the standard library's trace.
864
trace = __import__('trace')
866
tracer = trace.Trace(count=1, trace=0)
867
sys.settrace(tracer.globaltrace)
868
threading.settrace(tracer.globaltrace)
871
return exception_to_return_code(the_callable, *args, **kwargs)
874
results = tracer.results()
875
results.write_results(show_missing=1, summary=False,
879
def apply_profiled(the_callable, *args, **kwargs):
883
pffileno, pfname = tempfile.mkstemp()
885
prof = hotshot.Profile(pfname)
887
ret = prof.runcall(exception_to_return_code, the_callable, *args,
891
stats = hotshot.stats.load(pfname)
893
stats.sort_stats('cum') # 'time'
894
## XXX: Might like to write to stderr or the trace file instead but
895
## print_stats seems hardcoded to stdout
825
896
stats.print_stats(20)
827
return cmd_handler(**cmdargs) or 0
832
## TODO: Handle command-line options; probably know what options are valid for
835
## TODO: If the arguments are wrong, give a usage message rather
836
## than just a backtrace.
838
bzrlib.trace.create_tracefile(argv)
844
log_error('bzr: error: ' + e.args[0] + '\n')
847
log_error(' ' + h + '\n')
903
def exception_to_return_code(the_callable, *args, **kwargs):
904
"""UI level helper for profiling and coverage.
906
This transforms exceptions into a return value of 3. As such its only
907
relevant to the UI layer, and should never be called where catching
908
exceptions may be desirable.
911
return the_callable(*args, **kwargs)
912
except (KeyboardInterrupt, Exception), e:
913
# used to handle AssertionError and KeyboardInterrupt
914
# specially here, but hopefully they're handled ok by the logger now
915
exc_info = sys.exc_info()
916
exitcode = trace.report_exception(exc_info, sys.stderr)
917
if os.environ.get('BZR_PDB'):
918
print '**** entering debugger'
921
if sys.version_info[:2] < (2, 6):
923
# pdb.post_mortem(tb)
924
# but because pdb.post_mortem gives bad results for tracebacks
925
# from inside generators, we do it manually.
926
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
928
# Setup pdb on the traceback
931
p.setup(tb.tb_frame, tb)
932
# Point the debugger at the deepest frame of the stack
933
p.curindex = len(p.stack) - 1
934
p.curframe = p.stack[p.curindex][0]
935
# Start the pdb prompt.
936
p.print_stack_entry(p.stack[p.curindex])
944
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
945
from bzrlib.lsprof import profile
946
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
952
trace.note('Profile data written to "%s".', filename)
956
@deprecated_function(deprecated_in((2, 2, 0)))
957
def shlex_split_unicode(unsplit):
958
return cmdline.split(unsplit)
961
def get_alias(cmd, config=None):
962
"""Return an expanded alias, or None if no alias exists.
965
Command to be checked for an alias.
967
Used to specify an alternative config to use,
968
which is especially useful for testing.
969
If it is unspecified, the global config will be used.
973
config = bzrlib.config.GlobalConfig()
974
alias = config.get_alias(cmd)
976
return cmdline.split(alias)
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
981
"""Execute a command.
983
:param argv: The command-line arguments, without the program name from
984
argv[0] These should already be decoded. All library/test code calling
985
run_bzr should be passing valid strings (don't need decoding).
986
:param load_plugins: What function to call when triggering plugin loading.
987
This function should take no arguments and cause all plugins to be
989
:param disable_plugins: What function to call when disabling plugin
990
loading. This function should take no arguments and cause all plugin
991
loading to be prohibited (so that code paths in your application that
992
know about some plugins possibly being present will fail to import
993
those plugins even if they are installed.)
994
:return: Returns a command exit code or raises an exception.
996
Special master options: these must come before the command because
997
they control how the command is interpreted.
1000
Do not load plugin modules at all
1003
Do not allow aliases
1006
Only use builtin commands. (Plugins are still allowed to change
1010
Run under the Python hotshot profiler.
1013
Run under the Python lsprof profiler.
1016
Generate line coverage report in the specified directory.
1019
Specify the number of processes that can be run concurrently (selftest).
1021
trace.mutter("bazaar version: " + bzrlib.__version__)
1023
trace.mutter("bzr arguments: %r", argv)
1025
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1026
opt_no_aliases = False
1027
opt_lsprof_file = opt_coverage_dir = None
1029
# --no-plugins is handled specially at a very early stage. We need
1030
# to load plugins before doing other command parsing so that they
1031
# can override commands, but this needs to happen first.
1035
while i < len(argv):
1037
if a == '--profile':
1039
elif a == '--lsprof':
1041
elif a == '--lsprof-file':
1043
opt_lsprof_file = argv[i + 1]
1045
elif a == '--no-plugins':
1046
opt_no_plugins = True
1047
elif a == '--no-aliases':
1048
opt_no_aliases = True
1049
elif a == '--builtin':
1051
elif a == '--concurrency':
1052
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1054
elif a == '--coverage':
1055
opt_coverage_dir = argv[i + 1]
1057
elif a.startswith('-D'):
1058
debug.debug_flags.add(a[2:])
1063
debug.set_debug_flags_from_config()
1065
if not opt_no_plugins:
1072
get_cmd_object('help').run_argv_aliases([])
1075
if argv[0] == '--version':
1076
get_cmd_object('version').run_argv_aliases([])
1081
if not opt_no_aliases:
1082
alias_argv = get_alias(argv[0])
1084
argv[0] = alias_argv.pop(0)
1087
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1088
run = cmd_obj.run_argv_aliases
1089
run_argv = [argv, alias_argv]
1092
# We can be called recursively (tests for example), but we don't want
1093
# the verbosity level to propagate.
1094
saved_verbosity_level = option._verbosity_level
1095
option._verbosity_level = 0
1097
if opt_coverage_dir:
1099
'--coverage ignored, because --lsprof is in use.')
1100
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1102
if opt_coverage_dir:
1104
'--coverage ignored, because --profile is in use.')
1105
ret = apply_profiled(run, *run_argv)
1106
elif opt_coverage_dir:
1107
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1109
ret = run(*run_argv)
1112
# reset, in case we may do other commands later within the same
1113
# process. Commands that want to execute sub-commands must propagate
1114
# --verbose in their own way.
1115
if 'memory' in debug.debug_flags:
1116
trace.debug_memory('Process status after command:', short=False)
1117
option._verbosity_level = saved_verbosity_level
1120
def display_command(func):
1121
"""Decorator that suppresses pipe/interrupt errors."""
1122
def ignore_pipe(*args, **kwargs):
1124
result = func(*args, **kwargs)
1128
if getattr(e, 'errno', None) is None:
1130
if e.errno != errno.EPIPE:
1131
# Win32 raises IOError with errno=0 on a broken pipe
1132
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1135
except KeyboardInterrupt:
1140
def install_bzr_command_hooks():
1141
"""Install the hooks to supply bzr's own commands."""
1142
if _list_bzr_commands in Command.hooks["list_commands"]:
1144
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1146
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1148
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1149
"bzr plugin commands")
1150
Command.hooks.install_named_hook("get_command", _get_external_command,
1151
"bzr external command lookup")
1152
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1153
"bzr plugin-provider-db check")
1157
def _specified_or_unicode_argv(argv):
1158
# For internal or testing use, argv can be passed. Otherwise, get it from
1159
# the process arguments in a unicode-safe way.
1161
return osutils.get_unicode_argv()
1165
# ensure all arguments are unicode strings
1167
if isinstance(a, unicode):
1170
new_argv.append(a.decode('ascii'))
1171
except UnicodeDecodeError:
1172
raise errors.BzrError("argv should be list of unicode strings.")
1176
def main(argv=None):
1177
"""Main entry point of command-line interface.
1179
Typically `bzrlib.initialize` should be called first.
1181
:param argv: list of unicode command-line arguments similar to sys.argv.
1182
argv[0] is script name usually, it will be ignored.
1183
Don't pass here sys.argv because this list contains plain strings
1184
and not unicode; pass None instead.
1186
:return: exit code of bzr command.
1188
argv = _specified_or_unicode_argv(argv)
1189
_register_builtin_commands()
1190
ret = run_bzr_catch_errors(argv)
1191
bzrlib.ui.ui_factory.log_transport_activity(
1192
display=('bytes' in debug.debug_flags))
1193
trace.mutter("return code %d", ret)
1197
def run_bzr_catch_errors(argv):
1198
"""Run a bzr command with parameters as described by argv.
1200
This function assumed that that UI layer is setup, that symbol deprecations
1201
are already applied, and that unicode decoding has already been performed on argv.
1203
# done here so that they're covered for every test run
1204
install_bzr_command_hooks()
1205
return exception_to_return_code(run_bzr, argv)
1208
def run_bzr_catch_user_errors(argv):
1209
"""Run bzr and report user errors, but let internal errors propagate.
1211
This is used for the test suite, and might be useful for other programs
1212
that want to wrap the commandline interface.
1214
# done here so that they're covered for every test run
1215
install_bzr_command_hooks()
1217
return run_bzr(argv)
849
1218
except Exception, e:
850
log_error('bzr: exception: %s\n' % e)
851
log_error(' see .bzr.log for details\n')
852
traceback.print_exc(None, bzrlib.trace._tracefile)
853
traceback.print_exc(None, sys.stderr)
856
# TODO: Maybe nicer handling of IOError?
860
if __name__ == '__main__':
861
sys.exit(main(sys.argv))
863
##profile.run('main(sys.argv)')
1219
if (isinstance(e, (OSError, IOError))
1220
or not getattr(e, 'internal_error', True)):
1221
trace.report_exception(sys.exc_info(), sys.stderr)
1227
class HelpCommandIndex(object):
1228
"""A index for bzr help that returns commands."""
1231
self.prefix = 'commands/'
1233
def get_topics(self, topic):
1234
"""Search for topic amongst commands.
1236
:param topic: A topic to search for.
1237
:return: A list which is either empty or contains a single
1240
if topic and topic.startswith(self.prefix):
1241
topic = topic[len(self.prefix):]
1243
cmd = _get_cmd_object(topic, check_missing=False)
1250
class Provider(object):
1251
'''Generic class to be overriden by plugins'''
1253
def plugin_for_command(self, cmd_name):
1254
'''Takes a command and returns the information for that plugin
1256
:return: A dictionary with all the available information
1257
for the requested plugin
1259
raise NotImplementedError
1262
class ProvidersRegistry(registry.Registry):
1263
'''This registry exists to allow other providers to exist'''
1266
for key, provider in self.iteritems():
1269
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
