37
164
def _unsquish_command_name(cmd):
38
assert cmd.startswith("cmd_")
39
165
return cmd[4:].replace('_','-')
42
"""Return canonical name and class for all registered commands."""
43
for k, v in globals().iteritems():
44
if k.startswith("cmd_"):
45
yield _unsquish_command_name(k), v
47
def get_cmd_class(cmd):
48
"""Return the canonical name and command class for a command.
50
cmd = str(cmd) # not unicode
52
# first look up this command under the specified name
54
return cmd, globals()[_squish_command_name(cmd)]
58
# look for any command which claims this as an alias
59
for cmdname, cmdclass in get_all_cmds():
60
if cmd in cmdclass.aliases:
61
return cmdname, cmdclass
63
cmdclass = ExternalCommand.find_command(cmd)
67
raise BzrCommandError("unknown command %r" % cmd)
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
_register_builtin_commands()
226
return builtin_command_registry.keys()
229
def plugin_command_names():
230
"""Returns command names from commands registered by plugins."""
231
return plugin_cmds.keys()
234
def get_cmd_object(cmd_name, plugins_override=True):
235
"""Return the command object for a command.
238
If true, plugin commands can override builtins.
241
return _get_cmd_object(cmd_name, plugins_override)
243
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
247
"""Get a command object.
249
:param cmd_name: The name of the command.
250
:param plugins_override: Allow plugins to override builtins.
251
:param check_missing: Look up commands not found in the regular index via
252
the get_missing_command hook.
253
:return: A Command object instance
254
:raises KeyError: If no command is found.
256
# We want only 'ascii' command names, but the user may have typed
257
# in a Unicode name. In that case, they should just get a
258
# 'command not found' error later.
259
# In the future, we may actually support Unicode command names.
262
for hook in Command.hooks['get_command']:
263
cmd = hook(cmd, cmd_name)
264
if cmd is not None and not plugins_override and not cmd.plugin_name():
265
# We've found a non-plugin command, don't permit it to be
268
if cmd is None and check_missing:
269
for hook in Command.hooks['get_missing_command']:
276
# Allow plugins to extend commands
277
for hook in Command.hooks['extend_command']:
282
def _try_plugin_provider(cmd_name):
283
"""Probe for a plugin provider having cmd_name."""
285
plugin_metadata, provider = probe_for_provider(cmd_name)
286
raise errors.CommandAvailableInPlugin(cmd_name,
287
plugin_metadata, provider)
288
except errors.NoPluginAvailable:
292
def probe_for_provider(cmd_name):
293
"""Look for a provider for cmd_name.
295
:param cmd_name: The command name.
296
:return: plugin_metadata, provider for getting cmd_name.
297
:raises NoPluginAvailable: When no provider can supply the plugin.
299
# look for providers that provide this command but aren't installed
300
for provider in command_providers_registry:
302
return provider.plugin_for_command(cmd_name), provider
303
except errors.NoPluginAvailable:
305
raise errors.NoPluginAvailable(cmd_name)
308
def _get_bzr_command(cmd_or_None, cmd_name):
309
"""Get a command from bzr's core."""
311
cmd_class = builtin_command_registry.get(cmd_name)
319
def _get_external_command(cmd_or_None, cmd_name):
320
"""Lookup a command that is a shell script."""
321
# Only do external command lookups when no command is found so far.
322
if cmd_or_None is not None:
324
from bzrlib.externalcommand import ExternalCommand
325
cmd_obj = ExternalCommand.find_command(cmd_name)
330
def _get_plugin_command(cmd_or_None, cmd_name):
331
"""Get a command from bzr's plugins."""
333
return plugin_cmds.get(cmd_name)()
336
for key in plugin_cmds.keys():
337
info = plugin_cmds.get_info(key)
338
if cmd_name in info.aliases:
339
return plugin_cmds.get(key)()
343
class Command(object):
71
344
"""Base class for commands.
346
Commands are the heart of the command-line bzr interface.
348
The command object mostly handles the mapping of command-line
349
parameters into one or more bzrlib operations, and of the results
352
Commands normally don't have any state. All their arguments are
353
passed in to the run method. (Subclasses may take a different
354
policy if the behaviour of the instance needs to depend on e.g. a
355
shell plugin and not just its Python class.)
73
357
The docstring for an actual command should give a single-line
74
358
summary, then a complete description of the command. A grammar
75
359
description will be inserted.
362
Other accepted names for this command.
78
365
List of argument forms, marked with whether they are optional,
370
['to_location', 'from_branch?', 'file*']
372
'to_location' is required
373
'from_branch' is optional
374
'file' can be specified 0 or more times
82
List of options that may be given for this command.
377
List of options that may be given for this command. These can
378
be either strings, referring to globally-defined options,
379
or option objects. Retrieve through options().
85
If true, this command isn't advertised.
382
If true, this command isn't advertised. This is typically
383
for commands intended for expert users.
386
Command objects will get a 'outf' attribute, which has been
387
setup to properly handle encoding of unicode strings.
388
encoding_type determines what will happen when characters cannot
390
strict - abort if we cannot decode
391
replace - put in a bogus character (typically '?')
392
exact - do not encode sys.stdout
394
NOTE: by default on Windows, sys.stdout is opened as a text
395
stream, therefore LF line-endings are converted to CRLF.
396
When a command uses encoding_type = 'exact', then
397
sys.stdout is forced to be a binary stream, and line-endings
400
:cvar hooks: An instance of CommandHooks.
401
:ivar __doc__: The help shown by 'bzr help command' for this command.
402
This is set by assigning explicitly to __doc__ so that -OO can
406
__doc__ = "My help goes here"
90
410
takes_options = []
411
encoding_type = 'strict'
94
def __init__(self, options, arguments):
95
"""Construct and run the command.
97
Sets self.status to the return value of run()."""
98
assert isinstance(options, dict)
99
assert isinstance(arguments, dict)
100
cmdargs = options.copy()
101
cmdargs.update(arguments)
102
assert self.__doc__ != Command.__doc__, \
103
("No help message set for %r" % self)
104
self.status = self.run(**cmdargs)
416
"""Construct an instance of this command."""
417
# List of standard options directly supported
418
self.supported_std_options = []
421
def add_cleanup(self, cleanup_func, *args, **kwargs):
422
"""Register a function to call after self.run returns or raises.
424
Functions will be called in LIFO order.
426
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
428
def cleanup_now(self):
429
"""Execute and empty pending cleanup functions immediately.
431
After cleanup_now all registered cleanups are forgotten. add_cleanup
432
may be called again after cleanup_now; these cleanups will be called
433
after self.run returns or raises (or when cleanup_now is next called).
435
This is useful for releasing expensive or contentious resources (such
436
as write locks) before doing further work that does not require those
437
resources (such as writing results to self.outf). Note though, that
438
as it releases all resources, this may release locks that the command
439
wants to hold, so use should be done with care.
441
self._operation.cleanup_now()
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
def _maybe_expand_globs(self, file_list):
445
"""Glob expand file_list if the platform does not do that itself.
447
Not used anymore, now that the bzr command-line parser globs on
450
:return: A possibly empty list of unicode paths.
452
Introduced in bzrlib 0.18.
457
"""Return single-line grammar for this command.
459
Only describes arguments, not options.
461
s = 'bzr ' + self.name() + ' '
462
for aname in self.takes_args:
463
aname = aname.upper()
464
if aname[-1] in ['$', '+']:
465
aname = aname[:-1] + '...'
466
elif aname[-1] == '?':
467
aname = '[' + aname[:-1] + ']'
468
elif aname[-1] == '*':
469
aname = '[' + aname[:-1] + '...]'
471
s = s[:-1] # remove last space
474
def get_help_text(self, additional_see_also=None, plain=True,
475
see_also_as_links=False, verbose=True):
476
"""Return a text string with help for this command.
478
:param additional_see_also: Additional help topics to be
480
:param plain: if False, raw help (reStructuredText) is
481
returned instead of plain text.
482
:param see_also_as_links: if True, convert items in 'See also'
483
list to internal links (used by bzr_man rstx generator)
484
:param verbose: if True, display the full help, otherwise
485
leave out the descriptive sections and just display
486
usage help (e.g. Purpose, Usage, Options) with a
487
message explaining how to obtain full help.
491
doc = "No help for this command."
493
# Extract the summary (purpose) and sections out from the text
494
purpose,sections,order = self._get_help_parts(doc)
496
# If a custom usage section was provided, use it
497
if sections.has_key('Usage'):
498
usage = sections.pop('Usage')
500
usage = self._usage()
502
# The header is the purpose and usage
504
result += ':Purpose: %s\n' % purpose
505
if usage.find('\n') >= 0:
506
result += ':Usage:\n%s\n' % usage
508
result += ':Usage: %s\n' % usage
513
# XXX: optparse implicitly rewraps the help, and not always perfectly,
514
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
516
options = option.get_optparser(self.options()).format_option_help()
517
# XXX: According to the spec, ReST option lists actually don't support
518
# options like --1.9 so that causes syntax errors (in Sphinx at least).
519
# As that pattern always appears in the commands that break, we trap
520
# on that and then format that block of 'format' options as a literal
522
if not plain and options.find(' --1.9 ') != -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:'):]
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
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)
690
return self.run(**all_cmd_args)
692
def _setup_run(self):
693
"""Wrap the defined run method on self with a cleanup.
695
This is called by __init__ to make the Command be able to be run
696
by just calling run(), as it could be before cleanups were added.
698
If a different form of cleanups are in use by your Command subclass,
699
you can override this method.
702
def run(*args, **kwargs):
703
self._operation = cleanup.OperationWithCleanups(class_run)
705
return self._operation.run_simple(*args, **kwargs)
710
@deprecated_method(deprecated_in((2, 2, 0)))
711
def run_direct(self, *args, **kwargs):
712
"""Deprecated thunk from bzrlib 2.1."""
713
return self.run(*args, **kwargs)
108
"""Override this in sub-classes.
716
"""Actually run the command.
110
718
This is invoked with the options and arguments bound to
111
719
keyword parameters.
113
Return 0 or None if the command was successful, or a shell
119
class ExternalCommand(Command):
120
"""Class to wrap external commands.
122
We cheat a little here, when get_cmd_class() calls us we actually give it back
123
an object we construct that has the appropriate path, help, options etc for the
126
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
127
method, which we override to call the Command.__init__ method. That then calls
128
our run method which is pretty straight forward.
130
The only wrinkle is that we have to map bzr's dictionary of options and arguments
131
back into command line options and arguments for the script.
134
def find_command(cls, cmd):
135
bzrpath = os.environ.get('BZRPATH', '')
137
for dir in bzrpath.split(':'):
138
path = os.path.join(dir, cmd)
139
if os.path.isfile(path):
140
return ExternalCommand(path)
144
find_command = classmethod(find_command)
146
def __init__(self, path):
149
# TODO: If either of these fail, we should detect that and
150
# assume that path is not really a bzr plugin after all.
152
pipe = os.popen('%s --bzr-usage' % path, 'r')
153
self.takes_options = pipe.readline().split()
154
self.takes_args = pipe.readline().split()
157
pipe = os.popen('%s --bzr-help' % path, 'r')
158
self.__doc__ = pipe.read()
161
def __call__(self, options, arguments):
162
Command.__init__(self, options, arguments)
165
def run(self, **kargs):
173
if OPTIONS.has_key(name):
175
opts.append('--%s' % name)
176
if value is not None and value is not True:
177
opts.append(str(value))
179
# it's an arg, or arg list
180
if type(value) is not list:
186
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
190
class cmd_status(Command):
191
"""Display status summary.
193
This reports on versioned and unknown files, reporting them
194
grouped by state. Possible states are:
197
Versioned in the working copy but not in the previous revision.
200
Versioned in the previous revision but removed or deleted
204
Path of this file changed from the previous revision;
205
the text may also have changed. This includes files whose
206
parent directory was renamed.
209
Text has changed since the previous revision.
212
Nothing about this file has changed since the previous revision.
213
Only shown with --all.
216
Not versioned and not matching an ignore pattern.
218
To see ignored files use 'bzr ignored'. For details in the
219
changes to file texts, use 'bzr diff'.
221
If no arguments are specified, the status of the entire working
222
directory is shown. Otherwise, only the status of the specified
223
files or directories is reported. If a directory is given, status
224
is reported for everything inside that directory.
226
takes_args = ['file*']
227
takes_options = ['all', 'show-ids']
228
aliases = ['st', 'stat']
230
def run(self, all=False, show_ids=False, file_list=None):
232
b = Branch(file_list[0], lock_mode='r')
233
file_list = [b.relpath(x) for x in file_list]
234
# special case: only one path was given and it's the root
236
if file_list == ['']:
239
b = Branch('.', lock_mode='r')
241
status.show_status(b, show_unchanged=all, show_ids=show_ids,
242
specific_files=file_list)
245
class cmd_cat_revision(Command):
246
"""Write out metadata for a revision."""
249
takes_args = ['revision_id']
251
def run(self, revision_id):
252
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
255
class cmd_revno(Command):
256
"""Show current revision number.
258
This is equal to the number of revisions on this branch."""
260
print Branch('.').revno()
263
class cmd_add(Command):
264
"""Add specified files or directories.
266
In non-recursive mode, all the named items are added, regardless
267
of whether they were previously ignored. A warning is given if
268
any of the named files are already versioned.
270
In recursive mode (the default), files are treated the same way
271
but the behaviour for directories is different. Directories that
272
are already versioned do not give a warning. All directories,
273
whether already versioned or not, are searched for files or
274
subdirectories that are neither versioned or ignored, and these
275
are added. This search proceeds recursively into versioned
278
Therefore simply saying 'bzr add .' will version all files that
279
are currently unknown.
281
TODO: Perhaps adding a file whose directly is not versioned should
282
recursively add that parent, rather than giving an error?
284
takes_args = ['file+']
285
takes_options = ['verbose']
287
def run(self, file_list, verbose=False):
288
bzrlib.add.smart_add(file_list, verbose)
291
class cmd_relpath(Command):
292
"""Show path of a file relative to root"""
293
takes_args = ['filename']
295
def run(self, filename):
296
print Branch(filename).relpath(filename)
300
class cmd_inventory(Command):
301
"""Show inventory of the current working copy or a revision."""
302
takes_options = ['revision']
304
def run(self, revision=None):
307
inv = b.read_working_inventory()
309
inv = b.get_revision_inventory(b.lookup_revision(revision))
311
for path, entry in inv.iter_entries():
312
print '%-50s %s' % (entry.file_id, path)
315
class cmd_move(Command):
316
"""Move files to a different directory.
321
The destination must be a versioned directory in the same branch.
323
takes_args = ['source$', 'dest']
324
def run(self, source_list, dest):
327
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
330
class cmd_rename(Command):
331
"""Change the name of an entry.
334
bzr rename frob.c frobber.c
335
bzr rename src/frob.c lib/frob.c
337
It is an error if the destination name exists.
339
See also the 'move' command, which moves files into a different
340
directory without changing their name.
342
TODO: Some way to rename multiple files without invoking bzr for each
344
takes_args = ['from_name', 'to_name']
346
def run(self, from_name, to_name):
348
b.rename_one(b.relpath(from_name), b.relpath(to_name))
352
class cmd_renames(Command):
353
"""Show list of renamed files.
355
TODO: Option to show renames between two historical versions.
357
TODO: Only show renames under dir, rather than in the whole branch.
359
takes_args = ['dir?']
361
def run(self, dir='.'):
363
old_inv = b.basis_tree().inventory
364
new_inv = b.read_working_inventory()
366
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
368
for old_name, new_name in renames:
369
print "%s => %s" % (old_name, new_name)
372
class cmd_info(Command):
373
"""Show statistical information about a branch."""
374
takes_args = ['branch?']
376
def run(self, branch=None):
379
from branch import find_branch
380
b = find_branch(branch)
384
class cmd_remove(Command):
385
"""Make a file unversioned.
387
This makes bzr stop tracking changes to a versioned file. It does
388
not delete the working copy.
390
takes_args = ['file+']
391
takes_options = ['verbose']
393
def run(self, file_list, verbose=False):
394
b = Branch(file_list[0])
395
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
398
class cmd_file_id(Command):
399
"""Print file_id of a particular file or directory.
401
The file_id is assigned when the file is first added and remains the
402
same through all revisions where the file exists, even when it is
406
takes_args = ['filename']
407
def run(self, filename):
409
i = b.inventory.path2id(b.relpath(filename))
411
bailout("%r is not a versioned file" % filename)
416
class cmd_file_path(Command):
417
"""Print path of file_ids to a file or directory.
419
This prints one line for each directory down to the target,
420
starting at the branch root."""
422
takes_args = ['filename']
423
def run(self, filename):
426
fid = inv.path2id(b.relpath(filename))
428
bailout("%r is not a versioned file" % filename)
429
for fip in inv.get_idpath(fid):
433
class cmd_revision_history(Command):
434
"""Display list of revision ids on this branch."""
436
for patchid in Branch('.').revision_history():
440
class cmd_directories(Command):
441
"""Display list of versioned directories in this branch."""
443
for name, ie in Branch('.').read_working_inventory().directories():
450
class cmd_init(Command):
451
"""Make a directory into a versioned branch.
453
Use this to create an empty branch, or before importing an
456
Recipe for importing a tree of files:
461
bzr commit -m 'imported project'
464
Branch('.', init=True)
467
class cmd_diff(Command):
468
"""Show differences in working tree.
470
If files are listed, only the changes in those files are listed.
471
Otherwise, all changes for the tree are listed.
473
TODO: Given two revision arguments, show the difference between them.
475
TODO: Allow diff across branches.
477
TODO: Option to use external diff command; could be GNU diff, wdiff,
480
TODO: Python difflib is not exactly the same as unidiff; should
481
either fix it up or prefer to use an external diff.
483
TODO: If a directory is given, diff everything under that.
485
TODO: Selected-file diff is inefficient and doesn't show you
488
TODO: This probably handles non-Unix newlines poorly.
491
takes_args = ['file*']
492
takes_options = ['revision']
495
def run(self, revision=None, file_list=None):
496
from bzrlib.diff import show_diff
498
show_diff(Branch('.'), revision, specific_files=file_list)
504
class cmd_deleted(Command):
505
"""List files deleted in the working tree.
507
TODO: Show files deleted since a previous revision, or between two revisions.
509
def run(self, show_ids=False):
512
new = b.working_tree()
514
## TODO: Much more efficient way to do this: read in new
515
## directories with readdir, rather than stating each one. Same
516
## level of effort but possibly much less IO. (Or possibly not,
517
## if the directories are very large...)
519
for path, ie in old.inventory.iter_entries():
520
if not new.has_id(ie.file_id):
522
print '%-50s %s' % (path, ie.file_id)
527
class cmd_modified(Command):
528
"""List files modified in working tree."""
533
inv = b.read_working_inventory()
534
sc = statcache.update_cache(b, inv)
535
basis = b.basis_tree()
536
basis_inv = basis.inventory
538
# We used to do this through iter_entries(), but that's slow
539
# when most of the files are unmodified, as is usually the
540
# case. So instead we iterate by inventory entry, and only
541
# calculate paths as necessary.
543
for file_id in basis_inv:
544
cacheentry = sc.get(file_id)
545
if not cacheentry: # deleted
547
ie = basis_inv[file_id]
548
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
549
path = inv.id2path(file_id)
554
class cmd_added(Command):
555
"""List files added in working tree."""
559
wt = b.working_tree()
560
basis_inv = b.basis_tree().inventory
563
if file_id in basis_inv:
565
path = inv.id2path(file_id)
566
if not os.access(b.abspath(path), os.F_OK):
572
class cmd_root(Command):
573
"""Show the tree root directory.
575
The root is the nearest enclosing directory with a .bzr control
577
takes_args = ['filename?']
578
def run(self, filename=None):
579
"""Print the branch root."""
580
from branch import find_branch
581
b = find_branch(filename)
582
print getattr(b, 'base', None) or getattr(b, 'baseurl')
585
class cmd_log(Command):
586
"""Show log of this branch.
588
TODO: Option to limit range.
590
TODO: Perhaps show most-recent first with an option for last.
592
takes_args = ['filename?']
593
takes_options = ['timezone', 'verbose', 'show-ids']
594
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
595
from branch import find_branch
596
b = find_branch((filename or '.'), lock_mode='r')
598
filename = b.relpath(filename)
599
bzrlib.show_log(b, filename,
600
show_timezone=timezone,
606
class cmd_touching_revisions(Command):
607
"""Return revision-ids which affected a particular file."""
609
takes_args = ["filename"]
610
def run(self, filename):
611
b = Branch(filename, lock_mode='r')
612
inv = b.read_working_inventory()
613
file_id = inv.path2id(b.relpath(filename))
614
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
615
print "%6d %s" % (revno, what)
618
class cmd_ls(Command):
619
"""List files in a tree.
621
TODO: Take a revision or remote path and list that tree instead.
624
def run(self, revision=None, verbose=False):
627
tree = b.working_tree()
629
tree = b.revision_tree(b.lookup_revision(revision))
631
for fp, fc, kind, fid in tree.list_files():
633
if kind == 'directory':
640
print '%-8s %s%s' % (fc, fp, kindch)
646
class cmd_unknowns(Command):
647
"""List unknown files"""
649
for f in Branch('.').unknowns():
654
class cmd_ignore(Command):
655
"""Ignore a command or pattern
657
To remove patterns from the ignore list, edit the .bzrignore file.
659
If the pattern contains a slash, it is compared to the whole path
660
from the branch root. Otherwise, it is comapred to only the last
661
component of the path.
663
Ignore patterns are case-insensitive on case-insensitive systems.
665
Note: wildcards must be quoted from the shell on Unix.
668
bzr ignore ./Makefile
671
takes_args = ['name_pattern']
673
def run(self, name_pattern):
674
from bzrlib.atomicfile import AtomicFile
678
ifn = b.abspath('.bzrignore')
680
if os.path.exists(ifn):
683
igns = f.read().decode('utf-8')
689
if igns and igns[-1] != '\n':
691
igns += name_pattern + '\n'
694
f = AtomicFile(ifn, 'wt')
695
f.write(igns.encode('utf-8'))
700
inv = b.working_tree().inventory
701
if inv.path2id('.bzrignore'):
702
mutter('.bzrignore is already versioned')
704
mutter('need to make new .bzrignore file versioned')
705
b.add(['.bzrignore'])
709
class cmd_ignored(Command):
710
"""List ignored files and the patterns that matched them.
712
See also: bzr ignore"""
714
tree = Branch('.').working_tree()
715
for path, file_class, kind, file_id in tree.list_files():
716
if file_class != 'I':
718
## XXX: Slightly inefficient since this was already calculated
719
pat = tree.is_ignored(path)
720
print '%-50s %s' % (path, pat)
723
class cmd_lookup_revision(Command):
724
"""Lookup the revision-id from a revision-number
727
bzr lookup-revision 33
730
takes_args = ['revno']
732
def run(self, revno):
736
raise BzrCommandError("not a valid revision-number: %r" % revno)
738
print Branch('.').lookup_revision(revno)
741
class cmd_export(Command):
742
"""Export past revision to destination directory.
744
If no revision is specified this exports the last committed revision."""
745
takes_args = ['dest']
746
takes_options = ['revision']
747
def run(self, dest, revision=None):
750
rh = b.revision_history()[-1]
752
rh = b.lookup_revision(int(revision))
753
t = b.revision_tree(rh)
757
class cmd_cat(Command):
758
"""Write a file's text from a previous revision."""
760
takes_options = ['revision']
761
takes_args = ['filename']
763
def run(self, filename, revision=None):
765
raise BzrCommandError("bzr cat requires a revision number")
767
b.print_file(b.relpath(filename), int(revision))
770
class cmd_local_time_offset(Command):
771
"""Show the offset in seconds from GMT to local time."""
774
print bzrlib.osutils.local_time_offset()
778
class cmd_commit(Command):
779
"""Commit changes into a new revision.
781
If selected files are specified, only changes to those files are
782
committed. If a directory is specified then its contents are also
785
A selected-file commit may fail in some cases where the committed
786
tree would be invalid, such as trying to commit a file in a
787
newly-added directory that is not itself committed.
789
TODO: Run hooks on tree to-be-committed, and after commit.
791
TODO: Strict commit that fails if there are unknown or deleted files.
793
takes_args = ['selected*']
794
takes_options = ['message', 'file', 'verbose']
795
aliases = ['ci', 'checkin']
797
def run(self, message=None, file=None, verbose=True, selected_list=None):
798
from bzrlib.commit import commit
800
## Warning: shadows builtin file()
801
if not message and not file:
802
raise BzrCommandError("please specify a commit message",
803
["use either --message or --file"])
804
elif message and file:
805
raise BzrCommandError("please specify either --message or --file")
809
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
812
commit(b, message, verbose=verbose, specific_files=selected_list)
815
class cmd_check(Command):
816
"""Validate consistency of branch history.
818
This command checks various invariants about the branch storage to
819
detect data corruption or bzr bugs.
821
takes_args = ['dir?']
822
def run(self, dir='.'):
824
bzrlib.check.check(Branch(dir))
828
class cmd_whoami(Command):
829
"""Show bzr user id."""
830
takes_options = ['email']
832
def run(self, email=False):
834
print bzrlib.osutils.user_email()
836
print bzrlib.osutils.username()
839
class cmd_selftest(Command):
840
"""Run internal test suite"""
843
failures, tests = 0, 0
845
import doctest, bzrlib.store, bzrlib.tests
846
bzrlib.trace.verbose = False
848
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
849
bzrlib.tree, bzrlib.commands, bzrlib.add:
850
mf, mt = doctest.testmod(m)
853
print '%-40s %3d tests' % (m.__name__, mt),
855
print '%3d FAILED!' % mf
859
print '%-40s %3d tests' % ('total', tests),
861
print '%3d FAILED!' % failures
869
class cmd_version(Command):
870
"""Show version of bzr"""
875
print "bzr (bazaar-ng) %s" % bzrlib.__version__
876
print bzrlib.__copyright__
877
print "http://bazaar-ng.org/"
879
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
880
print "you may use, modify and redistribute it under the terms of the GNU"
881
print "General Public License version 2 or later."
884
class cmd_rocks(Command):
885
"""Statement of optimism."""
888
print "it sure does!"
890
def parse_spec(spec):
892
parsed = spec.split('/@')
893
assert len(parsed) == 2
897
parsed[1] = int(parsed[1])
900
parsed = [spec, None]
903
class cmd_merge(Command):
904
"""Perform a three-way merge of trees."""
905
takes_args = ['other_spec', 'base_spec']
907
def run(self, other_spec, base_spec):
908
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
910
class cmd_assert_fail(Command):
911
"""Test reporting of assertion failures"""
914
assert False, "always fails"
917
class cmd_help(Command):
918
"""Show help on a command or other topic.
920
For a list of all available commands, say 'bzr help commands'."""
921
takes_args = ['topic?']
924
def run(self, topic=None):
929
class cmd_update_stat_cache(Command):
930
"""Update stat-cache mapping inodes to SHA-1 hashes.
937
statcache.update_cache(b.base, b.read_working_inventory())
940
######################################################################
944
# list of all available options; the rhs can be either None for an
945
# option that takes no argument, or a constructor function that checks
969
def parse_args(argv):
721
Return 0 or None if the command was successful, or a non-zero
722
shell error code if not. It's OK for this method to allow
723
an exception to raise up.
725
This method is automatically wrapped by Command.__init__ with a
726
cleanup operation, stored as self._operation. This can be used
727
via self.add_cleanup to perform automatic cleanups at the end of
730
The argument for run are assembled by introspection. So for instance,
731
if your command takes an argument files, you would declare::
733
def run(self, files=None):
736
raise NotImplementedError('no implementation of command %r'
740
"""Return help message for this class."""
741
from inspect import getdoc
742
if self.__doc__ is Command.__doc__:
747
return _unsquish_command_name(self.__class__.__name__)
749
def plugin_name(self):
750
"""Get the name of the plugin that provides this command.
752
:return: The name of the plugin or None if the command is builtin.
754
mod_parts = self.__module__.split('.')
755
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
761
class CommandHooks(Hooks):
762
"""Hooks related to Command object creation/enumeration."""
765
"""Create the default hooks.
767
These are all empty initially, because by default nothing should get
771
self.create_hook(HookPoint('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13), None))
775
self.create_hook(HookPoint('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.create_hook(HookPoint('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
787
"command.", (1, 17), None))
788
self.create_hook(HookPoint('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
795
Command.hooks = CommandHooks()
798
def parse_args(command, argv, alias_argv=None):
970
799
"""Parse command line.
972
801
Arguments and options are parsed at this level before being passed
973
802
down to specific command handlers. This routine knows, from a
974
803
lookup table, something about the available options, what optargs
975
804
they take, and which commands will accept them.
977
>>> parse_args('--help'.split())
979
>>> parse_args('--version'.split())
980
([], {'version': True})
981
>>> parse_args('status --all'.split())
982
(['status'], {'all': True})
983
>>> parse_args('commit --message=biter'.split())
984
(['commit'], {'message': u'biter'})
989
# TODO: Maybe handle '--' to end options?
994
# option names must not be unicode
998
mutter(" got option %r" % a)
1000
optname, optarg = a[2:].split('=', 1)
1003
if optname not in OPTIONS:
1004
bailout('unknown long option %r' % a)
1007
if shortopt not in SHORT_OPTIONS:
1008
bailout('unknown short option %r' % a)
1009
optname = SHORT_OPTIONS[shortopt]
1012
# XXX: Do we ever want to support this, e.g. for -r?
1013
bailout('repeated option %r' % a)
1015
optargfn = OPTIONS[optname]
1019
bailout('option %r needs an argument' % a)
1021
optarg = argv.pop(0)
1022
opts[optname] = optargfn(optarg)
1025
bailout('option %r takes no argument' % optname)
1026
opts[optname] = True
806
# TODO: make it a method of the Command?
807
parser = option.get_optparser(command.options())
808
if alias_argv is not None:
809
args = alias_argv + argv
813
options, args = parser.parse_args(args)
814
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
815
v is not option.OptionParser.DEFAULT_VALUE])
1030
816
return args, opts
1035
819
def _match_argform(cmd, takes_args, args):
1049
833
argdict[argname + '_list'] = None
1050
834
elif ap[-1] == '+':
1052
raise BzrCommandError("command %r needs one or more %s"
1053
% (cmd, argname.upper()))
836
raise errors.BzrCommandError("command %r needs one or more %s"
837
% (cmd, argname.upper()))
1055
839
argdict[argname + '_list'] = args[:]
1057
841
elif ap[-1] == '$': # all but one
1058
842
if len(args) < 2:
1059
raise BzrCommandError("command %r needs one or more %s"
1060
% (cmd, argname.upper()))
843
raise errors.BzrCommandError("command %r needs one or more %s"
844
% (cmd, argname.upper()))
1061
845
argdict[argname + '_list'] = args[:-1]
1064
848
# just a plain arg
1067
raise BzrCommandError("command %r requires argument %s"
1068
% (cmd, argname.upper()))
851
raise errors.BzrCommandError("command %r requires argument %s"
852
% (cmd, argname.upper()))
1070
854
argdict[argname] = args.pop(0)
1073
raise BzrCommandError("extra argument to command %s: %s"
857
raise errors.BzrCommandError("extra argument to command %s: %s"
862
def apply_coveraged(dirname, the_callable, *args, **kwargs):
863
# Cannot use "import trace", as that would import bzrlib.trace instead of
864
# the standard library's trace.
865
trace = __import__('trace')
867
tracer = trace.Trace(count=1, trace=0)
868
sys.settrace(tracer.globaltrace)
869
threading.settrace(tracer.globaltrace)
872
return exception_to_return_code(the_callable, *args, **kwargs)
875
results = tracer.results()
876
results.write_results(show_missing=1, summary=False,
880
def apply_profiled(the_callable, *args, **kwargs):
884
pffileno, pfname = tempfile.mkstemp()
886
prof = hotshot.Profile(pfname)
888
ret = prof.runcall(exception_to_return_code, the_callable, *args,
892
stats = hotshot.stats.load(pfname)
894
stats.sort_stats('cum') # 'time'
895
## XXX: Might like to write to stderr or the trace file instead but
896
## print_stats seems hardcoded to stdout
897
stats.print_stats(20)
904
def exception_to_return_code(the_callable, *args, **kwargs):
905
"""UI level helper for profiling and coverage.
907
This transforms exceptions into a return value of 3. As such its only
908
relevant to the UI layer, and should never be called where catching
909
exceptions may be desirable.
912
return the_callable(*args, **kwargs)
913
except (KeyboardInterrupt, Exception), e:
914
# used to handle AssertionError and KeyboardInterrupt
915
# specially here, but hopefully they're handled ok by the logger now
916
exc_info = sys.exc_info()
917
exitcode = trace.report_exception(exc_info, sys.stderr)
918
if os.environ.get('BZR_PDB'):
919
print '**** entering debugger'
922
if sys.version_info[:2] < (2, 6):
924
# pdb.post_mortem(tb)
925
# but because pdb.post_mortem gives bad results for tracebacks
926
# from inside generators, we do it manually.
927
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
929
# Setup pdb on the traceback
932
p.setup(tb.tb_frame, tb)
933
# Point the debugger at the deepest frame of the stack
934
p.curindex = len(p.stack) - 1
935
p.curframe = p.stack[p.curindex][0]
936
# Start the pdb prompt.
937
p.print_stack_entry(p.stack[p.curindex])
945
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
946
from bzrlib.lsprof import profile
947
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
953
trace.note('Profile data written to "%s".', filename)
957
@deprecated_function(deprecated_in((2, 2, 0)))
958
def shlex_split_unicode(unsplit):
959
return cmdline.split(unsplit)
962
def get_alias(cmd, config=None):
963
"""Return an expanded alias, or None if no alias exists.
966
Command to be checked for an alias.
968
Used to specify an alternative config to use,
969
which is especially useful for testing.
970
If it is unspecified, the global config will be used.
974
config = bzrlib.config.GlobalConfig()
975
alias = config.get_alias(cmd)
977
return cmdline.split(alias)
981
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1081
982
"""Execute a command.
1083
This is similar to main(), but without all the trappings for
1084
logging and error handling.
984
:param argv: The command-line arguments, without the program name from
985
argv[0] These should already be decoded. All library/test code calling
986
run_bzr should be passing valid strings (don't need decoding).
987
:param load_plugins: What function to call when triggering plugin loading.
988
This function should take no arguments and cause all plugins to be
990
:param disable_plugins: What function to call when disabling plugin
991
loading. This function should take no arguments and cause all plugin
992
loading to be prohibited (so that code paths in your application that
993
know about some plugins possibly being present will fail to import
994
those plugins even if they are installed.)
995
:return: Returns a command exit code or raises an exception.
997
Special master options: these must come before the command because
998
they control how the command is interpreted.
1001
Do not load plugin modules at all
1004
Do not allow aliases
1007
Only use builtin commands. (Plugins are still allowed to change
1011
Run under the Python hotshot profiler.
1014
Run under the Python lsprof profiler.
1017
Generate line coverage report in the specified directory.
1020
Specify the number of processes that can be run concurrently (selftest).
1086
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1089
args, opts = parse_args(argv[1:])
1097
elif 'version' in opts:
1100
cmd = str(args.pop(0))
1107
canonical_cmd, cmd_class = get_cmd_class(cmd)
1110
if 'profile' in opts:
1116
# check options are reasonable
1117
allowed = cmd_class.takes_options
1119
if oname not in allowed:
1120
raise BzrCommandError("option '--%s' is not allowed for command %r"
1123
# mix arguments and options into one dictionary
1124
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1126
for k, v in opts.items():
1127
cmdopts[k.replace('-', '_')] = v
1130
import hotshot, tempfile
1131
pffileno, pfname = tempfile.mkstemp()
1133
prof = hotshot.Profile(pfname)
1134
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1137
import hotshot.stats
1138
stats = hotshot.stats.load(pfname)
1140
stats.sort_stats('time')
1141
## XXX: Might like to write to stderr or the trace file instead but
1142
## print_stats seems hardcoded to stdout
1143
stats.print_stats(20)
1151
return cmd_class(cmdopts, cmdargs).status
1154
def _report_exception(summary, quiet=False):
1156
log_error('bzr: ' + summary)
1157
bzrlib.trace.log_exception()
1160
tb = sys.exc_info()[2]
1161
exinfo = traceback.extract_tb(tb)
1163
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1164
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1171
bzrlib.open_tracefile(argv)
1176
return run_bzr(argv)
1178
# do this here inside the exception wrappers to catch EPIPE
1181
quiet = isinstance(e, (BzrCommandError))
1182
_report_exception('error: ' + e.args[0], quiet=quiet)
1185
# some explanation or hints
1188
except AssertionError, e:
1189
msg = 'assertion failed'
1191
msg += ': ' + str(e)
1192
_report_exception(msg)
1194
except KeyboardInterrupt, e:
1195
_report_exception('interrupted', quiet=True)
1197
except Exception, e:
1199
if (isinstance(e, IOError)
1200
and hasattr(e, 'errno')
1201
and e.errno == errno.EPIPE):
1205
msg = str(e).rstrip('\n')
1206
_report_exception(msg, quiet)
1022
trace.mutter("bazaar version: " + bzrlib.__version__)
1024
trace.mutter("bzr arguments: %r", argv)
1026
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1027
opt_no_aliases = False
1028
opt_lsprof_file = opt_coverage_dir = None
1030
# --no-plugins is handled specially at a very early stage. We need
1031
# to load plugins before doing other command parsing so that they
1032
# can override commands, but this needs to happen first.
1036
while i < len(argv):
1038
if a == '--profile':
1040
elif a == '--lsprof':
1042
elif a == '--lsprof-file':
1044
opt_lsprof_file = argv[i + 1]
1046
elif a == '--no-plugins':
1047
opt_no_plugins = True
1048
elif a == '--no-aliases':
1049
opt_no_aliases = True
1050
elif a == '--builtin':
1052
elif a == '--concurrency':
1053
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1055
elif a == '--coverage':
1056
opt_coverage_dir = argv[i + 1]
1058
elif a == '--profile-imports':
1059
pass # already handled in startup script Bug #588277
1060
elif a.startswith('-D'):
1061
debug.debug_flags.add(a[2:])
1066
debug.set_debug_flags_from_config()
1068
if not opt_no_plugins:
1075
get_cmd_object('help').run_argv_aliases([])
1078
if argv[0] == '--version':
1079
get_cmd_object('version').run_argv_aliases([])
1084
if not opt_no_aliases:
1085
alias_argv = get_alias(argv[0])
1087
argv[0] = alias_argv.pop(0)
1090
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
run = cmd_obj.run_argv_aliases
1092
run_argv = [argv, alias_argv]
1095
# We can be called recursively (tests for example), but we don't want
1096
# the verbosity level to propagate.
1097
saved_verbosity_level = option._verbosity_level
1098
option._verbosity_level = 0
1100
if opt_coverage_dir:
1102
'--coverage ignored, because --lsprof is in use.')
1103
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1105
if opt_coverage_dir:
1107
'--coverage ignored, because --profile is in use.')
1108
ret = apply_profiled(run, *run_argv)
1109
elif opt_coverage_dir:
1110
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1112
ret = run(*run_argv)
1209
bzrlib.trace.close_trace()
1212
if __name__ == '__main__':
1213
sys.exit(main(sys.argv))
1115
# reset, in case we may do other commands later within the same
1116
# process. Commands that want to execute sub-commands must propagate
1117
# --verbose in their own way.
1118
if 'memory' in debug.debug_flags:
1119
trace.debug_memory('Process status after command:', short=False)
1120
option._verbosity_level = saved_verbosity_level
1123
def display_command(func):
1124
"""Decorator that suppresses pipe/interrupt errors."""
1125
def ignore_pipe(*args, **kwargs):
1127
result = func(*args, **kwargs)
1131
if getattr(e, 'errno', None) is None:
1133
if e.errno != errno.EPIPE:
1134
# Win32 raises IOError with errno=0 on a broken pipe
1135
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1138
except KeyboardInterrupt:
1143
def install_bzr_command_hooks():
1144
"""Install the hooks to supply bzr's own commands."""
1145
if _list_bzr_commands in Command.hooks["list_commands"]:
1147
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1149
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1151
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1152
"bzr plugin commands")
1153
Command.hooks.install_named_hook("get_command", _get_external_command,
1154
"bzr external command lookup")
1155
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1156
"bzr plugin-provider-db check")
1160
def _specified_or_unicode_argv(argv):
1161
# For internal or testing use, argv can be passed. Otherwise, get it from
1162
# the process arguments in a unicode-safe way.
1164
return osutils.get_unicode_argv()
1168
# ensure all arguments are unicode strings
1170
if isinstance(a, unicode):
1173
new_argv.append(a.decode('ascii'))
1174
except UnicodeDecodeError:
1175
raise errors.BzrError("argv should be list of unicode strings.")
1179
def main(argv=None):
1180
"""Main entry point of command-line interface.
1182
Typically `bzrlib.initialize` should be called first.
1184
:param argv: list of unicode command-line arguments similar to sys.argv.
1185
argv[0] is script name usually, it will be ignored.
1186
Don't pass here sys.argv because this list contains plain strings
1187
and not unicode; pass None instead.
1189
:return: exit code of bzr command.
1191
argv = _specified_or_unicode_argv(argv)
1192
_register_builtin_commands()
1193
ret = run_bzr_catch_errors(argv)
1194
bzrlib.ui.ui_factory.log_transport_activity(
1195
display=('bytes' in debug.debug_flags))
1196
trace.mutter("return code %d", ret)
1200
def run_bzr_catch_errors(argv):
1201
"""Run a bzr command with parameters as described by argv.
1203
This function assumed that that UI layer is setup, that symbol deprecations
1204
are already applied, and that unicode decoding has already been performed on argv.
1206
# done here so that they're covered for every test run
1207
install_bzr_command_hooks()
1208
return exception_to_return_code(run_bzr, argv)
1211
def run_bzr_catch_user_errors(argv):
1212
"""Run bzr and report user errors, but let internal errors propagate.
1214
This is used for the test suite, and might be useful for other programs
1215
that want to wrap the commandline interface.
1217
# done here so that they're covered for every test run
1218
install_bzr_command_hooks()
1220
return run_bzr(argv)
1221
except Exception, e:
1222
if (isinstance(e, (OSError, IOError))
1223
or not getattr(e, 'internal_error', True)):
1224
trace.report_exception(sys.exc_info(), sys.stderr)
1230
class HelpCommandIndex(object):
1231
"""A index for bzr help that returns commands."""
1234
self.prefix = 'commands/'
1236
def get_topics(self, topic):
1237
"""Search for topic amongst commands.
1239
:param topic: A topic to search for.
1240
:return: A list which is either empty or contains a single
1243
if topic and topic.startswith(self.prefix):
1244
topic = topic[len(self.prefix):]
1246
cmd = _get_cmd_object(topic, check_missing=False)
1253
class Provider(object):
1254
'''Generic class to be overriden by plugins'''
1256
def plugin_for_command(self, cmd_name):
1257
'''Takes a command and returns the information for that plugin
1259
:return: A dictionary with all the available information
1260
for the requested plugin
1262
raise NotImplementedError
1265
class ProvidersRegistry(registry.Registry):
1266
'''This registry exists to allow other providers to exist'''
1269
for key, provider in self.iteritems():
1272
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
