164
33
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
165
35
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:
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
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)()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
145
for k, v in globals().iteritems():
146
if k.startswith("cmd_"):
147
d[_unsquish_command_name(k)] = v
149
d.update(_find_plugins())
152
def get_all_cmds(include_plugins=True):
153
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
158
def get_cmd_class(cmd,include_plugins=True):
159
"""Return the canonical name and command class for a command.
161
cmd = str(cmd) # not unicode
163
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
166
return cmd, cmds[cmd]
170
# look for any command which claims this as an alias
171
for cmdname, cmdclass in cmds.iteritems():
172
if cmd in cmdclass.aliases:
173
return cmdname, cmdclass
175
cmdclass = ExternalCommand.find_command(cmd)
179
raise BzrCommandError("unknown command %r" % cmd)
342
182
class Command(object):
343
183
"""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
185
The docstring for an actual command should give a single-line
357
186
summary, then a complete description of the command. A grammar
358
187
description will be inserted.
361
Other accepted names for this command.
364
190
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().
194
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.
197
If true, this command isn't advertised.
403
202
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)
206
def __init__(self, options, arguments):
207
"""Construct and run the command.
209
Sets self.status to the return value of run()."""
210
assert isinstance(options, dict)
211
assert isinstance(arguments, dict)
212
cmdargs = options.copy()
213
cmdargs.update(arguments)
214
assert self.__doc__ != Command.__doc__, \
215
("No help message set for %r" % self)
216
self.status = self.run(**cmdargs)
711
"""Actually run the command.
220
"""Override this in sub-classes.
713
222
This is invoked with the options and arguments bound to
714
223
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):
225
Return 0 or None if the command was successful, or a shell
231
class ExternalCommand(Command):
232
"""Class to wrap external commands.
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
246
def find_command(cls, cmd):
248
bzrpath = os.environ.get('BZRPATH', '')
250
for dir in bzrpath.split(os.pathsep):
251
path = os.path.join(dir, cmd)
252
if os.path.isfile(path):
253
return ExternalCommand(path)
257
find_command = classmethod(find_command)
259
def __init__(self, path):
262
pipe = os.popen('%s --bzr-usage' % path, 'r')
263
self.takes_options = pipe.readline().split()
265
for opt in self.takes_options:
266
if not opt in OPTIONS:
267
bailout("Unknown option '%s' returned by external command %s"
270
# TODO: Is there any way to check takes_args is valid here?
271
self.takes_args = pipe.readline().split()
273
if pipe.close() is not None:
274
bailout("Failed funning '%s --bzr-usage'" % path)
276
pipe = os.popen('%s --bzr-help' % path, 'r')
277
self.__doc__ = pipe.read()
278
if pipe.close() is not None:
279
bailout("Failed funning '%s --bzr-help'" % path)
281
def __call__(self, options, arguments):
282
Command.__init__(self, options, arguments)
285
def run(self, **kargs):
293
if OPTIONS.has_key(name):
295
opts.append('--%s' % name)
296
if value is not None and value is not True:
297
opts.append(str(value))
299
# it's an arg, or arg list
300
if type(value) is not list:
306
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
310
class cmd_status(Command):
311
"""Display status summary.
313
This reports on versioned and unknown files, reporting them
314
grouped by state. Possible states are:
317
Versioned in the working copy but not in the previous revision.
320
Versioned in the previous revision but removed or deleted
324
Path of this file changed from the previous revision;
325
the text may also have changed. This includes files whose
326
parent directory was renamed.
329
Text has changed since the previous revision.
332
Nothing about this file has changed since the previous revision.
333
Only shown with --all.
336
Not versioned and not matching an ignore pattern.
338
To see ignored files use 'bzr ignored'. For details in the
339
changes to file texts, use 'bzr diff'.
341
If no arguments are specified, the status of the entire working
342
directory is shown. Otherwise, only the status of the specified
343
files or directories is reported. If a directory is given, status
344
is reported for everything inside that directory.
346
takes_args = ['file*']
347
takes_options = ['all', 'show-ids']
348
aliases = ['st', 'stat']
350
def run(self, all=False, show_ids=False, file_list=None):
352
b = Branch(file_list[0])
353
file_list = [b.relpath(x) for x in file_list]
354
# special case: only one path was given and it's the root
356
if file_list == ['']:
361
status.show_status(b, show_unchanged=all, show_ids=show_ids,
362
specific_files=file_list)
365
class cmd_cat_revision(Command):
366
"""Write out metadata for a revision."""
369
takes_args = ['revision_id']
371
def run(self, revision_id):
372
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
375
class cmd_revno(Command):
376
"""Show current revision number.
378
This is equal to the number of revisions on this branch."""
380
print Branch('.').revno()
383
class cmd_add(Command):
384
"""Add specified files or directories.
386
In non-recursive mode, all the named items are added, regardless
387
of whether they were previously ignored. A warning is given if
388
any of the named files are already versioned.
390
In recursive mode (the default), files are treated the same way
391
but the behaviour for directories is different. Directories that
392
are already versioned do not give a warning. All directories,
393
whether already versioned or not, are searched for files or
394
subdirectories that are neither versioned or ignored, and these
395
are added. This search proceeds recursively into versioned
398
Therefore simply saying 'bzr add .' will version all files that
399
are currently unknown.
401
TODO: Perhaps adding a file whose directly is not versioned should
402
recursively add that parent, rather than giving an error?
404
takes_args = ['file+']
405
takes_options = ['verbose', 'no-recurse']
407
def run(self, file_list, verbose=False, no_recurse=False):
408
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
411
class cmd_relpath(Command):
412
"""Show path of a file relative to root"""
413
takes_args = ['filename']
416
def run(self, filename):
417
print Branch(filename).relpath(filename)
421
class cmd_inventory(Command):
422
"""Show inventory of the current working copy or a revision."""
423
takes_options = ['revision', 'show-ids']
425
def run(self, revision=None, show_ids=False):
428
inv = b.read_working_inventory()
430
inv = b.get_revision_inventory(b.lookup_revision(revision))
432
for path, entry in inv.entries():
434
print '%-50s %s' % (path, entry.file_id)
439
class cmd_move(Command):
440
"""Move files to a different directory.
445
The destination must be a versioned directory in the same branch.
447
takes_args = ['source$', 'dest']
448
def run(self, source_list, dest):
451
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
454
class cmd_rename(Command):
455
"""Change the name of an entry.
458
bzr rename frob.c frobber.c
459
bzr rename src/frob.c lib/frob.c
461
It is an error if the destination name exists.
463
See also the 'move' command, which moves files into a different
464
directory without changing their name.
466
TODO: Some way to rename multiple files without invoking bzr for each
468
takes_args = ['from_name', 'to_name']
470
def run(self, from_name, to_name):
472
b.rename_one(b.relpath(from_name), b.relpath(to_name))
478
class cmd_pull(Command):
479
"""Pull any changes from another branch into the current one.
481
If the location is omitted, the last-used location will be used.
482
Both the revision history and the working directory will be
485
This command only works on branches that have not diverged. Branches are
486
considered diverged if both branches have had commits without first
487
pulling from the other.
489
If branches have diverged, you can use 'bzr merge' to pull the text changes
490
from one into the other.
492
takes_args = ['location?']
494
def run(self, location=None):
495
from bzrlib.merge import merge
501
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
503
if errno == errno.ENOENT:
506
location = stored_loc
508
raise BzrCommandError("No pull location known or specified.")
509
from branch import find_branch, DivergedBranches
510
br_from = find_branch(location)
511
location = pull_loc(br_from)
512
old_revno = br_to.revno()
514
br_to.update_revisions(br_from)
515
except DivergedBranches:
516
raise BzrCommandError("These branches have diverged. Try merge.")
518
merge(('.', -1), ('.', old_revno), check_clean=False)
519
if location != stored_loc:
520
br_to.controlfile("x-pull", "wb").write(location + "\n")
524
class cmd_branch(Command):
525
"""Create a new copy of a branch.
527
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
528
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
530
To retrieve the branch as of a particular revision, supply the --revision
531
parameter, as in "branch foo/bar -r 5".
533
takes_args = ['from_location', 'to_location?']
534
takes_options = ['revision']
536
def run(self, from_location, to_location=None, revision=None):
538
from bzrlib.merge import merge
539
from branch import find_branch, DivergedBranches, NoSuchRevision
540
from shutil import rmtree
542
br_from = find_branch(from_location)
544
if e.errno == errno.ENOENT:
545
raise BzrCommandError('Source location "%s" does not exist.' %
550
if to_location is None:
551
to_location = os.path.basename(from_location.rstrip("/\\"))
554
os.mkdir(to_location)
556
if e.errno == errno.EEXIST:
557
raise BzrCommandError('Target directory "%s" already exists.' %
559
if e.errno == errno.ENOENT:
560
raise BzrCommandError('Parent of "%s" does not exist.' %
564
br_to = Branch(to_location, init=True)
567
br_to.update_revisions(br_from, stop_revision=revision)
568
except NoSuchRevision:
570
msg = "The branch %s has no revision %d." % (from_location,
572
raise BzrCommandError(msg)
573
merge((to_location, -1), (to_location, 0), this_dir=to_location,
575
from_location = pull_loc(br_from)
576
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
579
def pull_loc(branch):
580
# TODO: Should perhaps just make attribute be 'base' in
581
# RemoteBranch and Branch?
582
if hasattr(branch, "baseurl"):
583
return branch.baseurl
589
class cmd_renames(Command):
590
"""Show list of renamed files.
592
TODO: Option to show renames between two historical versions.
594
TODO: Only show renames under dir, rather than in the whole branch.
596
takes_args = ['dir?']
598
def run(self, dir='.'):
600
old_inv = b.basis_tree().inventory
601
new_inv = b.read_working_inventory()
603
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
605
for old_name, new_name in renames:
606
print "%s => %s" % (old_name, new_name)
609
class cmd_info(Command):
610
"""Show statistical information about a branch."""
611
takes_args = ['branch?']
613
def run(self, branch=None):
616
from branch import find_branch
617
b = find_branch(branch)
621
class cmd_remove(Command):
622
"""Make a file unversioned.
624
This makes bzr stop tracking changes to a versioned file. It does
625
not delete the working copy.
627
takes_args = ['file+']
628
takes_options = ['verbose']
630
def run(self, file_list, verbose=False):
631
b = Branch(file_list[0])
632
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
635
class cmd_file_id(Command):
636
"""Print file_id of a particular file or directory.
638
The file_id is assigned when the file is first added and remains the
639
same through all revisions where the file exists, even when it is
643
takes_args = ['filename']
644
def run(self, filename):
646
i = b.inventory.path2id(b.relpath(filename))
648
bailout("%r is not a versioned file" % filename)
653
class cmd_file_path(Command):
654
"""Print path of file_ids to a file or directory.
656
This prints one line for each directory down to the target,
657
starting at the branch root."""
659
takes_args = ['filename']
660
def run(self, filename):
663
fid = inv.path2id(b.relpath(filename))
665
bailout("%r is not a versioned file" % filename)
666
for fip in inv.get_idpath(fid):
670
class cmd_revision_history(Command):
671
"""Display list of revision ids on this branch."""
674
for patchid in Branch('.').revision_history():
678
class cmd_directories(Command):
679
"""Display list of versioned directories in this branch."""
681
for name, ie in Branch('.').read_working_inventory().directories():
688
class cmd_init(Command):
689
"""Make a directory into a versioned branch.
691
Use this to create an empty branch, or before importing an
694
Recipe for importing a tree of files:
699
bzr commit -m 'imported project'
702
Branch('.', init=True)
705
class cmd_diff(Command):
706
"""Show differences in working tree.
708
If files are listed, only the changes in those files are listed.
709
Otherwise, all changes for the tree are listed.
711
TODO: Given two revision arguments, show the difference between them.
713
TODO: Allow diff across branches.
715
TODO: Option to use external diff command; could be GNU diff, wdiff,
718
TODO: Python difflib is not exactly the same as unidiff; should
719
either fix it up or prefer to use an external diff.
721
TODO: If a directory is given, diff everything under that.
723
TODO: Selected-file diff is inefficient and doesn't show you
726
TODO: This probably handles non-Unix newlines poorly.
729
takes_args = ['file*']
730
takes_options = ['revision', 'diff-options']
731
aliases = ['di', 'dif']
733
def run(self, revision=None, file_list=None, diff_options=None):
734
from bzrlib.diff import show_diff
735
from bzrlib import find_branch
738
b = find_branch(file_list[0])
739
file_list = [b.relpath(f) for f in file_list]
740
if file_list == ['']:
741
# just pointing to top-of-tree
746
show_diff(b, revision, specific_files=file_list,
747
external_diff_options=diff_options)
753
class cmd_deleted(Command):
754
"""List files deleted in the working tree.
756
TODO: Show files deleted since a previous revision, or between two revisions.
758
def run(self, show_ids=False):
761
new = b.working_tree()
763
## TODO: Much more efficient way to do this: read in new
764
## directories with readdir, rather than stating each one. Same
765
## level of effort but possibly much less IO. (Or possibly not,
766
## if the directories are very large...)
768
for path, ie in old.inventory.iter_entries():
769
if not new.has_id(ie.file_id):
771
print '%-50s %s' % (path, ie.file_id)
776
class cmd_modified(Command):
777
"""List files modified in working tree."""
782
inv = b.read_working_inventory()
783
sc = statcache.update_cache(b, inv)
784
basis = b.basis_tree()
785
basis_inv = basis.inventory
787
# We used to do this through iter_entries(), but that's slow
788
# when most of the files are unmodified, as is usually the
789
# case. So instead we iterate by inventory entry, and only
790
# calculate paths as necessary.
792
for file_id in basis_inv:
793
cacheentry = sc.get(file_id)
794
if not cacheentry: # deleted
796
ie = basis_inv[file_id]
797
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
798
path = inv.id2path(file_id)
803
class cmd_added(Command):
804
"""List files added in working tree."""
808
wt = b.working_tree()
809
basis_inv = b.basis_tree().inventory
812
if file_id in basis_inv:
814
path = inv.id2path(file_id)
815
if not os.access(b.abspath(path), os.F_OK):
821
class cmd_root(Command):
822
"""Show the tree root directory.
824
The root is the nearest enclosing directory with a .bzr control
826
takes_args = ['filename?']
827
def run(self, filename=None):
828
"""Print the branch root."""
829
from branch import find_branch
830
b = find_branch(filename)
831
print getattr(b, 'base', None) or getattr(b, 'baseurl')
834
class cmd_log(Command):
835
"""Show log of this branch.
837
To request a range of logs, you can use the command -r begin:end
838
-r revision requests a specific revision, -r :end or -r begin: are
841
TODO: Make --revision support uuid: and hash: [future tag:] notation.
845
takes_args = ['filename?']
846
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
848
def run(self, filename=None, timezone='original',
853
from bzrlib import show_log, find_branch
856
direction = (forward and 'forward') or 'reverse'
859
b = find_branch(filename)
860
fp = b.relpath(filename)
862
file_id = b.read_working_inventory().path2id(fp)
864
file_id = None # points to branch root
870
revision = [None, None]
871
elif isinstance(revision, int):
872
revision = [revision, revision]
877
assert len(revision) == 2
879
mutter('encoding log as %r' % bzrlib.user_encoding)
881
# use 'replace' so that we don't abort if trying to write out
882
# in e.g. the default C locale.
883
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
886
show_timezone=timezone,
891
start_revision=revision[0],
892
end_revision=revision[1])
896
class cmd_touching_revisions(Command):
897
"""Return revision-ids which affected a particular file.
899
A more user-friendly interface is "bzr log FILE"."""
901
takes_args = ["filename"]
902
def run(self, filename):
904
inv = b.read_working_inventory()
905
file_id = inv.path2id(b.relpath(filename))
906
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
907
print "%6d %s" % (revno, what)
910
class cmd_ls(Command):
911
"""List files in a tree.
913
TODO: Take a revision or remote path and list that tree instead.
916
def run(self, revision=None, verbose=False):
919
tree = b.working_tree()
921
tree = b.revision_tree(b.lookup_revision(revision))
923
for fp, fc, kind, fid in tree.list_files():
925
if kind == 'directory':
932
print '%-8s %s%s' % (fc, fp, kindch)
938
class cmd_unknowns(Command):
939
"""List unknown files."""
941
for f in Branch('.').unknowns():
946
class cmd_ignore(Command):
947
"""Ignore a command or pattern.
949
To remove patterns from the ignore list, edit the .bzrignore file.
951
If the pattern contains a slash, it is compared to the whole path
952
from the branch root. Otherwise, it is comapred to only the last
953
component of the path.
955
Ignore patterns are case-insensitive on case-insensitive systems.
957
Note: wildcards must be quoted from the shell on Unix.
960
bzr ignore ./Makefile
963
takes_args = ['name_pattern']
965
def run(self, name_pattern):
966
from bzrlib.atomicfile import AtomicFile
970
ifn = b.abspath('.bzrignore')
972
if os.path.exists(ifn):
975
igns = f.read().decode('utf-8')
981
# TODO: If the file already uses crlf-style termination, maybe
982
# we should use that for the newly added lines?
984
if igns and igns[-1] != '\n':
986
igns += name_pattern + '\n'
989
f = AtomicFile(ifn, 'wt')
990
f.write(igns.encode('utf-8'))
995
inv = b.working_tree().inventory
996
if inv.path2id('.bzrignore'):
997
mutter('.bzrignore is already versioned')
999
mutter('need to make new .bzrignore file versioned')
1000
b.add(['.bzrignore'])
1004
class cmd_ignored(Command):
1005
"""List ignored files and the patterns that matched them.
1007
See also: bzr ignore"""
1009
tree = Branch('.').working_tree()
1010
for path, file_class, kind, file_id in tree.list_files():
1011
if file_class != 'I':
1013
## XXX: Slightly inefficient since this was already calculated
1014
pat = tree.is_ignored(path)
1015
print '%-50s %s' % (path, pat)
1018
class cmd_lookup_revision(Command):
1019
"""Lookup the revision-id from a revision-number
1022
bzr lookup-revision 33
1025
takes_args = ['revno']
1027
def run(self, revno):
1031
raise BzrCommandError("not a valid revision-number: %r" % revno)
1033
print Branch('.').lookup_revision(revno)
1036
class cmd_export(Command):
1037
"""Export past revision to destination directory.
1039
If no revision is specified this exports the last committed revision.
1041
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1042
given, exports to a directory (equivalent to --format=dir)."""
1043
# TODO: list known exporters
1044
takes_args = ['dest']
1045
takes_options = ['revision', 'format']
1046
def run(self, dest, revision=None, format='dir'):
1048
if revision == None:
1049
rh = b.revision_history()[-1]
1051
rh = b.lookup_revision(int(revision))
1052
t = b.revision_tree(rh)
1053
t.export(dest, format)
1056
class cmd_cat(Command):
1057
"""Write a file's text from a previous revision."""
1059
takes_options = ['revision']
1060
takes_args = ['filename']
1062
def run(self, filename, revision=None):
1063
if revision == None:
1064
raise BzrCommandError("bzr cat requires a revision number")
1066
b.print_file(b.relpath(filename), int(revision))
1069
class cmd_local_time_offset(Command):
1070
"""Show the offset in seconds from GMT to local time."""
1073
print bzrlib.osutils.local_time_offset()
1077
class cmd_commit(Command):
1078
"""Commit changes into a new revision.
1080
If selected files are specified, only changes to those files are
1081
committed. If a directory is specified then its contents are also
1084
A selected-file commit may fail in some cases where the committed
1085
tree would be invalid, such as trying to commit a file in a
1086
newly-added directory that is not itself committed.
1088
TODO: Run hooks on tree to-be-committed, and after commit.
1090
TODO: Strict commit that fails if there are unknown or deleted files.
1092
takes_args = ['selected*']
1093
takes_options = ['message', 'file', 'verbose']
1094
aliases = ['ci', 'checkin']
1096
def run(self, message=None, file=None, verbose=True, selected_list=None):
1097
from bzrlib.commit import commit
1099
## Warning: shadows builtin file()
1100
if not message and not file:
1101
raise BzrCommandError("please specify a commit message",
1102
["use either --message or --file"])
1103
elif message and file:
1104
raise BzrCommandError("please specify either --message or --file")
1108
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1111
commit(b, message, verbose=verbose, specific_files=selected_list)
1114
class cmd_check(Command):
1115
"""Validate consistency of branch history.
1117
This command checks various invariants about the branch storage to
1118
detect data corruption or bzr bugs.
1120
If given the --update flag, it will update some optional fields
1121
to help ensure data consistency.
1123
takes_args = ['dir?']
1124
takes_options = ['update']
1126
def run(self, dir='.', update=False):
1128
bzrlib.check.check(Branch(dir), update=update)
1132
class cmd_whoami(Command):
1133
"""Show bzr user id."""
1134
takes_options = ['email']
1136
def run(self, email=False):
1138
print bzrlib.osutils.user_email()
1140
print bzrlib.osutils.username()
1143
class cmd_selftest(Command):
1144
"""Run internal test suite"""
1147
from bzrlib.selftest import selftest
1155
class cmd_version(Command):
1156
"""Show version of bzr."""
1161
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1162
# is bzrlib itself in a branch?
1163
bzrrev = bzrlib.get_bzr_revision()
1165
print " (bzr checkout, revision %d {%s})" % bzrrev
1166
print bzrlib.__copyright__
1167
print "http://bazaar-ng.org/"
1169
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1170
print "you may use, modify and redistribute it under the terms of the GNU"
1171
print "General Public License version 2 or later."
1174
class cmd_rocks(Command):
1175
"""Statement of optimism."""
1178
print "it sure does!"
1180
def parse_spec(spec):
1182
>>> parse_spec(None)
1184
>>> parse_spec("./")
1186
>>> parse_spec("../@")
1188
>>> parse_spec("../f/@35")
1194
parsed = spec.split('/@')
1195
assert len(parsed) == 2
1199
parsed[1] = int(parsed[1])
1200
assert parsed[1] >=0
1202
parsed = [spec, None]
1207
class cmd_merge(Command):
1208
"""Perform a three-way merge of trees.
1210
The SPEC parameters are working tree or revision specifiers. Working trees
1211
are specified using standard paths or urls. No component of a directory
1212
path may begin with '@'.
1214
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1216
Revisions are specified using a dirname/@revno pair, where dirname is the
1217
branch directory and revno is the revision within that branch. If no revno
1218
is specified, the latest revision is used.
1220
Revision examples: './@127', 'foo/@', '../@1'
1222
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1223
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1226
merge refuses to run if there are any uncommitted changes, unless
1229
takes_args = ['other_spec', 'base_spec?']
1230
takes_options = ['force']
1232
def run(self, other_spec, base_spec=None, force=False):
1233
from bzrlib.merge import merge
1234
merge(parse_spec(other_spec), parse_spec(base_spec),
1235
check_clean=(not force))
1238
class cmd_revert(Command):
1239
"""Reverse all changes since the last commit.
1241
Only versioned files are affected.
1243
TODO: Store backups of any files that will be reverted, so
1244
that the revert can be undone.
1246
takes_options = ['revision']
1248
def run(self, revision=-1):
1249
from bzrlib.merge import merge
1250
merge(('.', revision), parse_spec('.'),
1255
class cmd_assert_fail(Command):
1256
"""Test reporting of assertion failures"""
1259
assert False, "always fails"
1262
class cmd_help(Command):
1263
"""Show help on a command or other topic.
1265
For a list of all available commands, say 'bzr help commands'."""
1266
takes_args = ['topic?']
1269
def run(self, topic=None):
1274
class cmd_update_stat_cache(Command):
1275
"""Update stat-cache mapping inodes to SHA-1 hashes.
1277
For testing only."""
1282
statcache.update_cache(b.base, b.read_working_inventory())
1286
# list of all available options; the rhs can be either None for an
1287
# option that takes no argument, or a constructor function that checks
1291
'diff-options': str,
1300
'revision': _parse_revision_str,
1318
def parse_args(argv):
794
1319
"""Parse command line.
796
1321
Arguments and options are parsed at this level before being passed
797
1322
down to specific command handlers. This routine knows, from a
798
1323
lookup table, something about the available options, what optargs
799
1324
they take, and which commands will accept them.
1326
>>> parse_args('--help'.split())
1327
([], {'help': True})
1328
>>> parse_args('--version'.split())
1329
([], {'version': True})
1330
>>> parse_args('status --all'.split())
1331
(['status'], {'all': True})
1332
>>> parse_args('commit --message=biter'.split())
1333
(['commit'], {'message': u'biter'})
1334
>>> parse_args('log -r 500'.split())
1335
(['log'], {'revision': 500})
1336
>>> parse_args('log -r500:600'.split())
1337
(['log'], {'revision': [500, 600]})
1338
>>> parse_args('log -vr500:600'.split())
1339
(['log'], {'verbose': True, 'revision': [500, 600]})
1340
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1341
Traceback (most recent call last):
1343
ValueError: invalid literal for int(): v500
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])
1348
# TODO: Maybe handle '--' to end options?
1353
# option names must not be unicode
1357
mutter(" got option %r" % a)
1359
optname, optarg = a[2:].split('=', 1)
1362
if optname not in OPTIONS:
1363
bailout('unknown long option %r' % a)
1366
if shortopt in SHORT_OPTIONS:
1367
# Multi-character options must have a space to delimit
1369
optname = SHORT_OPTIONS[shortopt]
1371
# Single character short options, can be chained,
1372
# and have their value appended to their name
1374
if shortopt not in SHORT_OPTIONS:
1375
# We didn't find the multi-character name, and we
1376
# didn't find the single char name
1377
bailout('unknown short option %r' % a)
1378
optname = SHORT_OPTIONS[shortopt]
1381
# There are extra things on this option
1382
# see if it is the value, or if it is another
1384
optargfn = OPTIONS[optname]
1385
if optargfn is None:
1386
# This option does not take an argument, so the
1387
# next entry is another short option, pack it back
1389
argv.insert(0, '-' + a[2:])
1391
# This option takes an argument, so pack it
1396
# XXX: Do we ever want to support this, e.g. for -r?
1397
bailout('repeated option %r' % a)
1399
optargfn = OPTIONS[optname]
1403
bailout('option %r needs an argument' % a)
1405
optarg = argv.pop(0)
1406
opts[optname] = optargfn(optarg)
1409
bailout('option %r takes no argument' % optname)
1410
opts[optname] = True
811
1414
return args, opts
814
1419
def _match_argform(cmd, takes_args, args):
828
1433
argdict[argname + '_list'] = None
829
1434
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
1436
raise BzrCommandError("command %r needs one or more %s"
1437
% (cmd, argname.upper()))
834
1439
argdict[argname + '_list'] = args[:]
836
1441
elif ap[-1] == '$': # all but one
837
1442
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
1443
raise BzrCommandError("command %r needs one or more %s"
1444
% (cmd, argname.upper()))
840
1445
argdict[argname + '_list'] = args[:-1]
843
1448
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
1451
raise BzrCommandError("command %r requires argument %s"
1452
% (cmd, argname.upper()))
849
1454
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
1457
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)
1465
"""Execute a command.
1467
This is similar to main(), but without all the trappings for
1468
logging and error handling.
1470
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1472
include_plugins=True
1474
args, opts = parse_args(argv[1:])
1482
elif 'version' in opts:
1485
elif args and args[0] == 'builtin':
1486
include_plugins=False
1488
cmd = str(args.pop(0))
1495
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1498
if 'profile' in opts:
1504
# check options are reasonable
1505
allowed = cmd_class.takes_options
1507
if oname not in allowed:
1508
raise BzrCommandError("option '--%s' is not allowed for command %r"
1511
# mix arguments and options into one dictionary
1512
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1514
for k, v in opts.items():
1515
cmdopts[k.replace('-', '_')] = v
1518
import hotshot, tempfile
1519
pffileno, pfname = tempfile.mkstemp()
883
ret = prof.runcall(exception_to_return_code, the_callable, *args,
1521
prof = hotshot.Profile(pfname)
1522
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.
1525
import hotshot.stats
1526
stats = hotshot.stats.load(pfname)
1528
stats.sort_stats('time')
1529
## XXX: Might like to write to stderr or the trace file instead but
1530
## print_stats seems hardcoded to stdout
1531
stats.print_stats(20)
1539
return cmd_class(cmdopts, cmdargs).status
1542
def _report_exception(summary, quiet=False):
1544
log_error('bzr: ' + summary)
1545
bzrlib.trace.log_exception()
1548
tb = sys.exc_info()[2]
1549
exinfo = traceback.extract_tb(tb)
1551
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1552
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1559
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])
1564
return run_bzr(argv)
1566
# do this here inside the exception wrappers to catch EPIPE
1569
quiet = isinstance(e, (BzrCommandError))
1570
_report_exception('error: ' + e.args[0], quiet=quiet)
1573
# some explanation or hints
1576
except AssertionError, e:
1577
msg = 'assertion failed'
1579
msg += ': ' + str(e)
1580
_report_exception(msg)
1582
except KeyboardInterrupt, e:
1583
_report_exception('interrupted', quiet=True)
1585
except Exception, e:
1587
if (isinstance(e, IOError)
1588
and hasattr(e, 'errno')
1589
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
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
argv[0] = alias_argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1090
run = cmd_obj.run_argv_aliases
1091
run_argv = [argv, alias_argv]
1094
# We can be called recursively (tests for example), but we don't want
1095
# the verbosity level to propagate.
1096
saved_verbosity_level = option._verbosity_level
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
'--coverage ignored, because --lsprof is in use.')
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
1107
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
ret = run(*run_argv)
1593
msg = str(e).rstrip('\n')
1594
_report_exception(msg, quiet)
1114
# reset, in case we may do other commands later within the same
1115
# process. Commands that want to execute sub-commands must propagate
1116
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
option._verbosity_level = saved_verbosity_level
1122
def display_command(func):
1123
"""Decorator that suppresses pipe/interrupt errors."""
1124
def ignore_pipe(*args, **kwargs):
1126
result = func(*args, **kwargs)
1130
if getattr(e, 'errno', None) is None:
1132
if e.errno != errno.EPIPE:
1133
# Win32 raises IOError with errno=0 on a broken pipe
1134
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1137
except KeyboardInterrupt:
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
trace.mutter("return code %d", ret)
1199
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
return run_bzr(argv)
1220
except Exception, e:
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
1229
class HelpCommandIndex(object):
1230
"""A index for bzr help that returns commands."""
1233
self.prefix = 'commands/'
1235
def get_topics(self, topic):
1236
"""Search for topic amongst commands.
1238
:param topic: A topic to search for.
1239
:return: A list which is either empty or contains a single
1242
if topic and topic.startswith(self.prefix):
1243
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
1597
bzrlib.trace.close_trace()
1600
if __name__ == '__main__':
1601
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
