164
37
def _unsquish_command_name(cmd):
38
assert cmd.startswith("cmd_")
165
39
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):
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)
343
71
"""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
73
The docstring for an actual command should give a single-line
357
74
summary, then a complete description of the command. A grammar
358
75
description will be inserted.
361
Other accepted names for this command.
364
78
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().
82
List of options that may be given for this command.
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.
85
If true, this command isn't advertised.
403
90
takes_options = []
404
encoding_type = 'strict'
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
491
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
493
usage = sections.pop('Usage')
495
usage = self._usage()
497
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
500
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
503
result += ':Usage: %s\n' % usage
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
547
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
550
result += ', '.join(self.aliases) + '\n'
551
plugin_name = self.plugin_name()
552
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
554
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
578
def _get_help_parts(text):
579
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
A section starts with a heading line of the form ":xxx:".
585
Indented text on following lines is the section value.
586
All text found outside a named section is assigned to the
587
default section which is given the key of None.
589
def save_section(sections, order, label, section):
591
if sections.has_key(label):
592
sections[label] += '\n' + section
595
sections[label] = section
597
lines = text.rstrip().splitlines()
598
summary = lines.pop(0)
601
label,section = None,''
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
608
label,section = None,line
611
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
617
def get_help_topic(self):
618
"""Return the commands help topic - its name."""
621
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
624
The list is derived from the content of the _see_also attribute. Any
625
duplicates are removed and the result is in lexical order.
626
:param additional_terms: Additional help topics to cross-reference.
627
:return: A list of help topics.
629
see_also = set(getattr(self, '_see_also', []))
631
see_also.update(additional_terms)
632
return sorted(see_also)
635
"""Return dict of valid options for this command.
637
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
640
for o in self.takes_options:
641
if isinstance(o, basestring):
642
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
def _setup_outf(self):
649
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
653
def run_argv_aliases(self, argv, alias_argv=None):
654
"""Parse the command line and run with extra aliases in alias_argv."""
655
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
674
# mix arguments and options into one dictionary
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
677
for k, v in opts.items():
678
cmdopts[k.replace('-', '_')] = v
680
all_cmd_args = cmdargs.copy()
681
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
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)
711
"""Actually run the command.
108
"""Override this in sub-classes.
713
110
This is invoked with the options and arguments bound to
714
111
keyword parameters.
716
Return 0 or None if the command was successful, or a non-zero
717
shell error code if not. It's OK for this method to allow
718
an exception to raise up.
720
This method is automatically wrapped by Command.__init__ with a
721
cleanup operation, stored as self._operation. This can be used
722
via self.add_cleanup to perform automatic cleanups at the end of
725
The argument for run are assembled by introspection. So for instance,
726
if your command takes an argument files, you would declare::
728
def run(self, files=None):
731
raise NotImplementedError('no implementation of command %r'
735
"""Return help message for this class."""
736
from inspect import getdoc
737
if self.__doc__ is Command.__doc__:
742
return _unsquish_command_name(self.__class__.__name__)
744
def plugin_name(self):
745
"""Get the name of the plugin that provides this command.
747
:return: The name of the plugin or None if the command is builtin.
749
mod_parts = self.__module__.split('.')
750
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
793
def parse_args(command, argv, alias_argv=None):
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: Option to show in forward order.
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 bzrlib import show_log, find_branch
598
b = find_branch(filename, lock_mode='r')
599
fp = b.relpath(filename)
601
file_id = b.read_working_inventory().path2id(fp)
603
file_id = None # points to branch root
605
b = find_branch('.', lock_mode='r')
609
show_timezone=timezone,
616
class cmd_touching_revisions(Command):
617
"""Return revision-ids which affected a particular file.
619
A more user-friendly interface is "bzr log FILE"."""
621
takes_args = ["filename"]
622
def run(self, filename):
623
b = Branch(filename, lock_mode='r')
624
inv = b.read_working_inventory()
625
file_id = inv.path2id(b.relpath(filename))
626
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
627
print "%6d %s" % (revno, what)
630
class cmd_ls(Command):
631
"""List files in a tree.
633
TODO: Take a revision or remote path and list that tree instead.
636
def run(self, revision=None, verbose=False):
639
tree = b.working_tree()
641
tree = b.revision_tree(b.lookup_revision(revision))
643
for fp, fc, kind, fid in tree.list_files():
645
if kind == 'directory':
652
print '%-8s %s%s' % (fc, fp, kindch)
658
class cmd_unknowns(Command):
659
"""List unknown files"""
661
for f in Branch('.').unknowns():
666
class cmd_ignore(Command):
667
"""Ignore a command or pattern
669
To remove patterns from the ignore list, edit the .bzrignore file.
671
If the pattern contains a slash, it is compared to the whole path
672
from the branch root. Otherwise, it is comapred to only the last
673
component of the path.
675
Ignore patterns are case-insensitive on case-insensitive systems.
677
Note: wildcards must be quoted from the shell on Unix.
680
bzr ignore ./Makefile
683
takes_args = ['name_pattern']
685
def run(self, name_pattern):
686
from bzrlib.atomicfile import AtomicFile
690
ifn = b.abspath('.bzrignore')
692
if os.path.exists(ifn):
695
igns = f.read().decode('utf-8')
701
if igns and igns[-1] != '\n':
703
igns += name_pattern + '\n'
706
f = AtomicFile(ifn, 'wt')
707
f.write(igns.encode('utf-8'))
712
inv = b.working_tree().inventory
713
if inv.path2id('.bzrignore'):
714
mutter('.bzrignore is already versioned')
716
mutter('need to make new .bzrignore file versioned')
717
b.add(['.bzrignore'])
721
class cmd_ignored(Command):
722
"""List ignored files and the patterns that matched them.
724
See also: bzr ignore"""
726
tree = Branch('.').working_tree()
727
for path, file_class, kind, file_id in tree.list_files():
728
if file_class != 'I':
730
## XXX: Slightly inefficient since this was already calculated
731
pat = tree.is_ignored(path)
732
print '%-50s %s' % (path, pat)
735
class cmd_lookup_revision(Command):
736
"""Lookup the revision-id from a revision-number
739
bzr lookup-revision 33
742
takes_args = ['revno']
744
def run(self, revno):
748
raise BzrCommandError("not a valid revision-number: %r" % revno)
750
print Branch('.').lookup_revision(revno)
753
class cmd_export(Command):
754
"""Export past revision to destination directory.
756
If no revision is specified this exports the last committed revision."""
757
takes_args = ['dest']
758
takes_options = ['revision']
759
def run(self, dest, revision=None):
762
rh = b.revision_history()[-1]
764
rh = b.lookup_revision(int(revision))
765
t = b.revision_tree(rh)
769
class cmd_cat(Command):
770
"""Write a file's text from a previous revision."""
772
takes_options = ['revision']
773
takes_args = ['filename']
775
def run(self, filename, revision=None):
777
raise BzrCommandError("bzr cat requires a revision number")
779
b.print_file(b.relpath(filename), int(revision))
782
class cmd_local_time_offset(Command):
783
"""Show the offset in seconds from GMT to local time."""
786
print bzrlib.osutils.local_time_offset()
790
class cmd_commit(Command):
791
"""Commit changes into a new revision.
793
If selected files are specified, only changes to those files are
794
committed. If a directory is specified then its contents are also
797
A selected-file commit may fail in some cases where the committed
798
tree would be invalid, such as trying to commit a file in a
799
newly-added directory that is not itself committed.
801
TODO: Run hooks on tree to-be-committed, and after commit.
803
TODO: Strict commit that fails if there are unknown or deleted files.
805
takes_args = ['selected*']
806
takes_options = ['message', 'file', 'verbose']
807
aliases = ['ci', 'checkin']
809
def run(self, message=None, file=None, verbose=True, selected_list=None):
810
from bzrlib.commit import commit
812
## Warning: shadows builtin file()
813
if not message and not file:
814
raise BzrCommandError("please specify a commit message",
815
["use either --message or --file"])
816
elif message and file:
817
raise BzrCommandError("please specify either --message or --file")
821
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
824
commit(b, message, verbose=verbose, specific_files=selected_list)
827
class cmd_check(Command):
828
"""Validate consistency of branch history.
830
This command checks various invariants about the branch storage to
831
detect data corruption or bzr bugs.
833
takes_args = ['dir?']
834
def run(self, dir='.'):
836
bzrlib.check.check(Branch(dir))
840
class cmd_whoami(Command):
841
"""Show bzr user id."""
842
takes_options = ['email']
844
def run(self, email=False):
846
print bzrlib.osutils.user_email()
848
print bzrlib.osutils.username()
851
class cmd_selftest(Command):
852
"""Run internal test suite"""
855
failures, tests = 0, 0
857
import doctest, bzrlib.store
858
bzrlib.trace.verbose = False
860
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
861
bzrlib.tree, bzrlib.commands, bzrlib.add:
862
mf, mt = doctest.testmod(m)
865
print '%-40s %3d tests' % (m.__name__, mt),
867
print '%3d FAILED!' % mf
871
print '%-40s %3d tests' % ('total', tests),
873
print '%3d FAILED!' % failures
881
class cmd_version(Command):
882
"""Show version of bzr"""
887
print "bzr (bazaar-ng) %s" % bzrlib.__version__
888
print bzrlib.__copyright__
889
print "http://bazaar-ng.org/"
891
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
892
print "you may use, modify and redistribute it under the terms of the GNU"
893
print "General Public License version 2 or later."
896
class cmd_rocks(Command):
897
"""Statement of optimism."""
900
print "it sure does!"
902
def parse_spec(spec):
904
parsed = spec.split('/@')
905
assert len(parsed) == 2
909
parsed[1] = int(parsed[1])
912
parsed = [spec, None]
915
class cmd_merge(Command):
916
"""Perform a three-way merge of trees."""
917
takes_args = ['other_spec', 'base_spec']
919
def run(self, other_spec, base_spec):
920
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
922
class cmd_assert_fail(Command):
923
"""Test reporting of assertion failures"""
926
assert False, "always fails"
929
class cmd_help(Command):
930
"""Show help on a command or other topic.
932
For a list of all available commands, say 'bzr help commands'."""
933
takes_args = ['topic?']
936
def run(self, topic=None):
941
class cmd_update_stat_cache(Command):
942
"""Update stat-cache mapping inodes to SHA-1 hashes.
949
statcache.update_cache(b.base, b.read_working_inventory())
952
######################################################################
956
# list of all available options; the rhs can be either None for an
957
# option that takes no argument, or a constructor function that checks
981
def parse_args(argv):
794
982
"""Parse command line.
796
984
Arguments and options are parsed at this level before being passed
797
985
down to specific command handlers. This routine knows, from a
798
986
lookup table, something about the available options, what optargs
799
987
they take, and which commands will accept them.
989
>>> parse_args('--help'.split())
991
>>> parse_args('--version'.split())
992
([], {'version': True})
993
>>> parse_args('status --all'.split())
994
(['status'], {'all': True})
995
>>> parse_args('commit --message=biter'.split())
996
(['commit'], {'message': u'biter'})
801
# TODO: make it a method of the Command?
802
parser = option.get_optparser(command.options())
803
if alias_argv is not None:
804
args = alias_argv + argv
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
1001
# TODO: Maybe handle '--' to end options?
1006
# option names must not be unicode
1010
mutter(" got option %r" % a)
1012
optname, optarg = a[2:].split('=', 1)
1015
if optname not in OPTIONS:
1016
bailout('unknown long option %r' % a)
1019
if shortopt not in SHORT_OPTIONS:
1020
bailout('unknown short option %r' % a)
1021
optname = SHORT_OPTIONS[shortopt]
1024
# XXX: Do we ever want to support this, e.g. for -r?
1025
bailout('repeated option %r' % a)
1027
optargfn = OPTIONS[optname]
1031
bailout('option %r needs an argument' % a)
1033
optarg = argv.pop(0)
1034
opts[optname] = optargfn(optarg)
1037
bailout('option %r takes no argument' % optname)
1038
opts[optname] = True
811
1042
return args, opts
814
1047
def _match_argform(cmd, takes_args, args):
828
1061
argdict[argname + '_list'] = None
829
1062
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
1064
raise BzrCommandError("command %r needs one or more %s"
1065
% (cmd, argname.upper()))
834
1067
argdict[argname + '_list'] = args[:]
836
1069
elif ap[-1] == '$': # all but one
837
1070
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
1071
raise BzrCommandError("command %r needs one or more %s"
1072
% (cmd, argname.upper()))
840
1073
argdict[argname + '_list'] = args[:-1]
843
1076
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
1079
raise BzrCommandError("command %r requires argument %s"
1080
% (cmd, argname.upper()))
849
1082
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
1085
raise BzrCommandError("extra argument to command %s: %s"
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
859
# the standard library's trace.
860
trace = __import__('trace')
862
tracer = trace.Trace(count=1, trace=0)
863
sys.settrace(tracer.globaltrace)
864
threading.settrace(tracer.globaltrace)
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
875
def apply_profiled(the_callable, *args, **kwargs):
879
pffileno, pfname = tempfile.mkstemp()
881
prof = hotshot.Profile(pfname)
1093
"""Execute a command.
1095
This is similar to main(), but without all the trappings for
1096
logging and error handling.
1098
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1101
args, opts = parse_args(argv[1:])
1109
elif 'version' in opts:
1112
cmd = str(args.pop(0))
1119
canonical_cmd, cmd_class = get_cmd_class(cmd)
1122
if 'profile' in opts:
1128
# check options are reasonable
1129
allowed = cmd_class.takes_options
1131
if oname not in allowed:
1132
raise BzrCommandError("option '--%s' is not allowed for command %r"
1135
# mix arguments and options into one dictionary
1136
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1138
for k, v in opts.items():
1139
cmdopts[k.replace('-', '_')] = v
1142
import hotshot, tempfile
1143
pffileno, pfname = tempfile.mkstemp()
883
ret = prof.runcall(exception_to_return_code, the_callable, *args,
1145
prof = hotshot.Profile(pfname)
1146
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
887
stats = hotshot.stats.load(pfname)
889
stats.sort_stats('cum') # 'time'
890
## XXX: Might like to write to stderr or the trace file instead but
891
## print_stats seems hardcoded to stdout
892
stats.print_stats(20)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
1149
import hotshot.stats
1150
stats = hotshot.stats.load(pfname)
1152
stats.sort_stats('time')
1153
## XXX: Might like to write to stderr or the trace file instead but
1154
## print_stats seems hardcoded to stdout
1155
stats.print_stats(20)
1163
return cmd_class(cmdopts, cmdargs).status
1166
def _report_exception(summary, quiet=False):
1168
log_error('bzr: ' + summary)
1169
bzrlib.trace.log_exception()
1172
tb = sys.exc_info()[2]
1173
exinfo = traceback.extract_tb(tb)
1175
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1176
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1183
bzrlib.open_tracefile(argv)
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
1188
return run_bzr(argv)
1190
# do this here inside the exception wrappers to catch EPIPE
1193
quiet = isinstance(e, (BzrCommandError))
1194
_report_exception('error: ' + e.args[0], quiet=quiet)
1197
# some explanation or hints
1200
except AssertionError, e:
1201
msg = 'assertion failed'
1203
msg += ': ' + str(e)
1204
_report_exception(msg)
1206
except KeyboardInterrupt, e:
1207
_report_exception('interrupted', quiet=True)
1209
except Exception, e:
1211
if (isinstance(e, IOError)
1212
and hasattr(e, 'errno')
1213
and e.errno == errno.EPIPE):
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
948
trace.note('Profile data written to "%s".', filename)
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
957
def get_alias(cmd, config=None):
958
"""Return an expanded alias, or None if no alias exists.
961
Command to be checked for an alias.
963
Used to specify an alternative config to use,
964
which is especially useful for testing.
965
If it is unspecified, the global config will be used.
969
config = bzrlib.config.GlobalConfig()
970
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
992
Special master options: these must come before the command because
993
they control how the command is interpreted.
996
Do not load plugin modules at all
1002
Only use builtin commands. (Plugins are still allowed to change
1006
Run under the Python hotshot profiler.
1009
Run under the Python lsprof profiler.
1012
Generate line coverage report in the specified directory.
1015
Specify the number of processes that can be run concurrently (selftest).
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof_file = opt_coverage_dir = None
1025
# --no-plugins is handled specially at a very early stage. We need
1026
# to load plugins before doing other command parsing so that they
1027
# can override commands, but this needs to happen first.
1031
while i < len(argv):
1033
if a == '--profile':
1035
elif a == '--lsprof':
1037
elif a == '--lsprof-file':
1039
opt_lsprof_file = argv[i + 1]
1041
elif a == '--no-plugins':
1042
opt_no_plugins = True
1043
elif a == '--no-aliases':
1044
opt_no_aliases = True
1045
elif a == '--builtin':
1047
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1050
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
1053
elif a.startswith('-D'):
1054
debug.debug_flags.add(a[2:])
1059
debug.set_debug_flags_from_config()
1061
if not opt_no_plugins:
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1077
if not opt_no_aliases:
1078
alias_argv = get_alias(argv[0])
1080
argv[0] = alias_argv.pop(0)
1083
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1084
run = cmd_obj.run_argv_aliases
1085
run_argv = [argv, alias_argv]
1088
# We can be called recursively (tests for example), but we don't want
1089
# the verbosity level to propagate.
1090
saved_verbosity_level = option._verbosity_level
1091
option._verbosity_level = 0
1093
if opt_coverage_dir:
1095
'--coverage ignored, because --lsprof is in use.')
1096
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1098
if opt_coverage_dir:
1100
'--coverage ignored, because --profile is in use.')
1101
ret = apply_profiled(run, *run_argv)
1102
elif opt_coverage_dir:
1103
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1105
ret = run(*run_argv)
1217
msg = str(e).rstrip('\n')
1218
_report_exception(msg, quiet)
1108
# reset, in case we may do other commands later within the same
1109
# process. Commands that want to execute sub-commands must propagate
1110
# --verbose in their own way.
1111
if 'memory' in debug.debug_flags:
1112
trace.debug_memory('Process status after command:', short=False)
1113
option._verbosity_level = saved_verbosity_level
1116
def display_command(func):
1117
"""Decorator that suppresses pipe/interrupt errors."""
1118
def ignore_pipe(*args, **kwargs):
1120
result = func(*args, **kwargs)
1124
if getattr(e, 'errno', None) is None:
1126
if e.errno != errno.EPIPE:
1127
# Win32 raises IOError with errno=0 on a broken pipe
1128
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1131
except KeyboardInterrupt:
1136
def install_bzr_command_hooks():
1137
"""Install the hooks to supply bzr's own commands."""
1138
if _list_bzr_commands in Command.hooks["list_commands"]:
1140
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1142
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1144
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1145
"bzr plugin commands")
1146
Command.hooks.install_named_hook("get_command", _get_external_command,
1147
"bzr external command lookup")
1148
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1149
"bzr plugin-provider-db check")
1153
def _specified_or_unicode_argv(argv):
1154
# For internal or testing use, argv can be passed. Otherwise, get it from
1155
# the process arguments in a unicode-safe way.
1157
return osutils.get_unicode_argv()
1161
# ensure all arguments are unicode strings
1163
if isinstance(a, unicode):
1166
new_argv.append(a.decode('ascii'))
1167
except UnicodeDecodeError:
1168
raise errors.BzrError("argv should be list of unicode strings.")
1172
def main(argv=None):
1173
"""Main entry point of command-line interface.
1175
Typically `bzrlib.initialize` should be called first.
1177
:param argv: list of unicode command-line arguments similar to sys.argv.
1178
argv[0] is script name usually, it will be ignored.
1179
Don't pass here sys.argv because this list contains plain strings
1180
and not unicode; pass None instead.
1182
:return: exit code of bzr command.
1184
argv = _specified_or_unicode_argv(argv)
1185
_register_builtin_commands()
1186
ret = run_bzr_catch_errors(argv)
1187
bzrlib.ui.ui_factory.log_transport_activity(
1188
display=('bytes' in debug.debug_flags))
1189
trace.mutter("return code %d", ret)
1193
def run_bzr_catch_errors(argv):
1194
"""Run a bzr command with parameters as described by argv.
1196
This function assumed that that UI layer is setup, that symbol deprecations
1197
are already applied, and that unicode decoding has already been performed on argv.
1199
# done here so that they're covered for every test run
1200
install_bzr_command_hooks()
1201
return exception_to_return_code(run_bzr, argv)
1204
def run_bzr_catch_user_errors(argv):
1205
"""Run bzr and report user errors, but let internal errors propagate.
1207
This is used for the test suite, and might be useful for other programs
1208
that want to wrap the commandline interface.
1210
# done here so that they're covered for every test run
1211
install_bzr_command_hooks()
1213
return run_bzr(argv)
1214
except Exception, e:
1215
if (isinstance(e, (OSError, IOError))
1216
or not getattr(e, 'internal_error', True)):
1217
trace.report_exception(sys.exc_info(), sys.stderr)
1223
class HelpCommandIndex(object):
1224
"""A index for bzr help that returns commands."""
1227
self.prefix = 'commands/'
1229
def get_topics(self, topic):
1230
"""Search for topic amongst commands.
1232
:param topic: A topic to search for.
1233
:return: A list which is either empty or contains a single
1236
if topic and topic.startswith(self.prefix):
1237
topic = topic[len(self.prefix):]
1239
cmd = _get_cmd_object(topic, check_missing=False)
1246
class Provider(object):
1247
'''Generic class to be overriden by plugins'''
1249
def plugin_for_command(self, cmd_name):
1250
'''Takes a command and returns the information for that plugin
1252
:return: A dictionary with all the available information
1253
for the requested plugin
1255
raise NotImplementedError
1258
class ProvidersRegistry(registry.Registry):
1259
'''This registry exists to allow other providers to exist'''
1262
for key, provider in self.iteritems():
1265
command_providers_registry = ProvidersRegistry()
1221
bzrlib.trace.close_trace()
1224
if __name__ == '__main__':
1225
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
