138
33
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
139
35
return cmd[4:].replace('_','-')
142
def _builtin_commands():
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
150
if name.startswith("cmd_"):
151
real_name = _unsquish_command_name(name)
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
181
return _builtin_commands().keys()
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
return plugin_cmds.keys()
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
199
d = _builtin_commands()
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
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()
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():
206
def get_cmd_object(cmd_name, plugins_override=True):
207
"""Return the command object for a command.
210
If true, plugin commands can override builtins.
213
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
219
"""Get a command object.
221
:param cmd_name: The name of the command.
222
:param plugins_override: Allow plugins to override builtins.
223
:return: A Command object instance
224
:raises KeyError: If no command is found.
226
# We want only 'ascii' command names, but the user may have typed
227
# in a Unicode name. In that case, they should just get a
228
# 'command not found' error later.
229
# In the future, we may actually support Unicode command names.
232
for hook in Command.hooks['get_command']:
233
cmd = hook(cmd, cmd_name)
234
if cmd is not None and not plugins_override and not cmd.plugin_name():
235
# We've found a non-plugin command, don't permit it to be
239
for hook in Command.hooks['get_missing_command']:
246
# Allow plugins to extend commands
247
for hook in Command.hooks['extend_command']:
252
def _try_plugin_provider(cmd_name):
253
"""Probe for a plugin provider having cmd_name."""
255
plugin_metadata, provider = probe_for_provider(cmd_name)
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
262
def probe_for_provider(cmd_name):
263
"""Look for a provider for cmd_name.
265
:param cmd_name: The command name.
266
:return: plugin_metadata, provider for getting cmd_name.
267
:raises NoPluginAvailable: When no provider can supply the plugin.
269
# look for providers that provide this command but aren't installed
270
for provider in command_providers_registry:
272
return provider.plugin_for_command(cmd_name), provider
273
except errors.NoPluginAvailable:
275
raise errors.NoPluginAvailable(cmd_name)
278
def _get_bzr_command(cmd_or_None, cmd_name):
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
282
return cmds[cmd_name]()
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]
285
170
# look for any command which claims this as an alias
286
for real_cmd_name, cmd_class in cmds.iteritems():
287
if cmd_name in cmd_class.aliases:
292
def _get_external_command(cmd_or_None, cmd_name):
293
"""Lookup a command that is a shell script."""
294
# Only do external command lookups when no command is found so far.
295
if cmd_or_None is not None:
297
from bzrlib.externalcommand import ExternalCommand
298
cmd_obj = ExternalCommand.find_command(cmd_name)
303
def _get_plugin_command(cmd_or_None, cmd_name):
304
"""Get a command from bzr's plugins."""
306
return plugin_cmds.get(cmd_name)()
309
for key in plugin_cmds.keys():
310
info = plugin_cmds.get_info(key)
311
if cmd_name in info.aliases:
312
return plugin_cmds.get(key)()
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)
316
182
class Command(object):
317
183
"""Base class for commands.
319
Commands are the heart of the command-line bzr interface.
321
The command object mostly handles the mapping of command-line
322
parameters into one or more bzrlib operations, and of the results
325
Commands normally don't have any state. All their arguments are
326
passed in to the run method. (Subclasses may take a different
327
policy if the behaviour of the instance needs to depend on e.g. a
328
shell plugin and not just its Python class.)
330
185
The docstring for an actual command should give a single-line
331
186
summary, then a complete description of the command. A grammar
332
187
description will be inserted.
335
Other accepted names for this command.
338
190
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
194
List of options that may be given for this command.
355
If true, this command isn't advertised. This is typically
356
for commands intended for expert users.
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
373
:cvar hooks: An instance of CommandHooks.
197
If true, this command isn't advertised.
377
202
takes_options = []
378
encoding_type = 'strict'
383
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
386
# List of standard options directly supported
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
"""Register a function to call after self.run returns or raises.
393
Functions will be called in LIFO order.
395
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
397
def cleanup_now(self):
398
"""Execute and empty pending cleanup functions immediately.
400
After cleanup_now all registered cleanups are forgotten. add_cleanup
401
may be called again after cleanup_now; these cleanups will be called
402
after self.run returns or raises (or when cleanup_now is next called).
404
This is useful for releasing expensive or contentious resources (such
405
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
424
"""Return single-line grammar for this command.
426
Only describes arguments, not options.
428
s = 'bzr ' + self.name() + ' '
429
for aname in self.takes_args:
430
aname = aname.upper()
431
if aname[-1] in ['$', '+']:
432
aname = aname[:-1] + '...'
433
elif aname[-1] == '?':
434
aname = '[' + aname[:-1] + ']'
435
elif aname[-1] == '*':
436
aname = '[' + aname[:-1] + '...]'
438
s = s[:-1] # remove last space
441
def get_help_text(self, additional_see_also=None, plain=True,
442
see_also_as_links=False, verbose=True):
443
"""Return a text string with help for this command.
445
:param additional_see_also: Additional help topics to be
447
:param plain: if False, raw help (reStructuredText) is
448
returned instead of plain text.
449
:param see_also_as_links: if True, convert items in 'See also'
450
list to internal links (used by bzr_man rstx generator)
451
:param verbose: if True, display the full help, otherwise
452
leave out the descriptive sections and just display
453
usage help (e.g. Purpose, Usage, Options) with a
454
message explaining how to obtain full help.
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
460
# Extract the summary (purpose) and sections out from the text
461
purpose,sections,order = self._get_help_parts(doc)
463
# If a custom usage section was provided, use it
464
if sections.has_key('Usage'):
465
usage = sections.pop('Usage')
467
usage = self._usage()
469
# The header is the purpose and usage
471
result += ':Purpose: %s\n' % purpose
472
if usage.find('\n') >= 0:
473
result += ':Usage:\n%s\n' % usage
475
result += ':Usage: %s\n' % usage
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
490
options = options.replace(' format:\n', ' format::\n\n', 1)
491
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
501
# Add the description, indenting it 2 spaces
502
# to match the indentation of the options
503
if sections.has_key(None):
504
text = sections.pop(None)
505
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
508
# Add the custom sections (e.g. Examples). Note that there's no need
509
# to indent these as they must be indented already in the source.
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
519
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
522
result += ', '.join(self.aliases) + '\n'
523
plugin_name = self.plugin_name()
524
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
526
see_also = self.get_see_also(additional_see_also)
528
if not plain and see_also_as_links:
530
for item in see_also:
532
# topics doesn't have an independent section
533
# so don't create a real link
534
see_also_links.append(item)
536
# Use a Sphinx link for this entry
537
link_text = ":doc:`%s <%s-help>`" % (item, item)
538
see_also_links.append(link_text)
539
see_also = see_also_links
540
result += ':See also: '
541
result += ', '.join(see_also) + '\n'
543
# If this will be rendered as plain text, convert it
545
import bzrlib.help_topics
546
result = bzrlib.help_topics.help_as_plain_text(result)
550
def _get_help_parts(text):
551
"""Split help text into a summary and named sections.
553
:return: (summary,sections,order) where summary is the top line and
554
sections is a dictionary of the rest indexed by section name.
555
order is the order the section appear in the text.
556
A section starts with a heading line of the form ":xxx:".
557
Indented text on following lines is the section value.
558
All text found outside a named section is assigned to the
559
default section which is given the key of None.
561
def save_section(sections, order, label, section):
563
if sections.has_key(label):
564
sections[label] += '\n' + section
567
sections[label] = section
569
lines = text.rstrip().splitlines()
570
summary = lines.pop(0)
573
label,section = None,''
575
if line.startswith(':') and line.endswith(':') and len(line) > 2:
576
save_section(sections, order, label, section)
577
label,section = line[1:-1],''
578
elif (label is not None) and len(line) > 1 and not line[0].isspace():
579
save_section(sections, order, label, section)
580
label,section = None,line
583
section += '\n' + line
586
save_section(sections, order, label, section)
587
return summary, sections, order
589
def get_help_topic(self):
590
"""Return the commands help topic - its name."""
593
def get_see_also(self, additional_terms=None):
594
"""Return a list of help topics that are related to this command.
596
The list is derived from the content of the _see_also attribute. Any
597
duplicates are removed and the result is in lexical order.
598
:param additional_terms: Additional help topics to cross-reference.
599
:return: A list of help topics.
601
see_also = set(getattr(self, '_see_also', []))
603
see_also.update(additional_terms)
604
return sorted(see_also)
607
"""Return dict of valid options for this command.
609
Maps from long option name to option object."""
610
r = Option.STD_OPTIONS.copy()
612
for o in self.takes_options:
613
if isinstance(o, basestring):
614
o = option.Option.OPTIONS[o]
616
if o.name in std_names:
617
self.supported_std_options.append(o.name)
620
def _setup_outf(self):
621
"""Return a file linked to stdout, which has proper encoding."""
622
self.outf = ui.ui_factory.make_output_stream(
623
encoding_type=self.encoding_type)
625
def run_argv_aliases(self, argv, alias_argv=None):
626
"""Parse the command line and run with extra aliases in alias_argv."""
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
629
DeprecationWarning, stacklevel=2)
631
args, opts = parse_args(self, argv, alias_argv)
633
# Process the standard options
634
if 'help' in opts: # e.g. bzr add --help
635
sys.stdout.write(self.get_help_text())
637
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
640
trace.set_verbosity_level(option._verbosity_level)
641
if 'verbose' in self.supported_std_options:
642
opts['verbose'] = trace.is_verbose()
643
elif opts.has_key('verbose'):
645
if 'quiet' in self.supported_std_options:
646
opts['quiet'] = trace.is_quiet()
647
elif opts.has_key('quiet'):
650
# mix arguments and options into one dictionary
651
cmdargs = _match_argform(self.name(), self.takes_args, args)
653
for k, v in opts.items():
654
cmdopts[k.replace('-', '_')] = v
656
all_cmd_args = cmdargs.copy()
657
all_cmd_args.update(cmdopts)
661
return self.run_direct(**all_cmd_args)
663
def run_direct(self, *args, **kwargs):
664
"""Call run directly with objects (without parsing an argv list)."""
665
return self._operation.run_simple(*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)
668
"""Actually run the command.
220
"""Override this in sub-classes.
670
222
This is invoked with the options and arguments bound to
671
223
keyword parameters.
673
Return 0 or None if the command was successful, or a non-zero
674
shell error code if not. It's OK for this method to allow
675
an exception to raise up.
677
raise NotImplementedError('no implementation of command %r'
681
"""Return help message for this class."""
682
from inspect import getdoc
683
if self.__doc__ is Command.__doc__:
688
return _unsquish_command_name(self.__class__.__name__)
690
def plugin_name(self):
691
"""Get the name of the plugin that provides this command.
693
:return: The name of the plugin or None if the command is builtin.
695
mod_parts = self.__module__.split('.')
696
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
702
class CommandHooks(Hooks):
703
"""Hooks related to Command object creation/enumeration."""
706
"""Create the default hooks.
708
These are all empty initially, because by default nothing should get
712
self.create_hook(HookPoint('extend_command',
713
"Called after creating a command object to allow modifications "
714
"such as adding or removing options, docs etc. Called with the "
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
717
"Called when creating a single command. Called with "
718
"(cmd_or_None, command_name). get_command should either return "
719
"the cmd_or_None parameter, or a replacement Command object that "
720
"should be used for the command. Note that the Command.hooks "
721
"hooks are core infrastructure. Many users will prefer to use "
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
725
"Called when creating a single command if no command could be "
726
"found. Called with (command_name). get_missing_command should "
727
"either return None, or a Command object to be used for the "
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
730
"Called when enumerating commands. Called with a set of "
731
"cmd_name strings for all the commands found so far. This set "
732
" is safe to mutate - e.g. to remove a command. "
733
"list_commands should return the updated set of command names.",
736
Command.hooks = CommandHooks()
739
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
# TODO: If either of these fail, we should detect that and
263
# assume that path is not really a bzr plugin after all.
265
pipe = os.popen('%s --bzr-usage' % path, 'r')
266
self.takes_options = pipe.readline().split()
267
self.takes_args = pipe.readline().split()
270
pipe = os.popen('%s --bzr-help' % path, 'r')
271
self.__doc__ = pipe.read()
274
def __call__(self, options, arguments):
275
Command.__init__(self, options, arguments)
278
def run(self, **kargs):
286
if OPTIONS.has_key(name):
288
opts.append('--%s' % name)
289
if value is not None and value is not True:
290
opts.append(str(value))
292
# it's an arg, or arg list
293
if type(value) is not list:
299
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
303
class cmd_status(Command):
304
"""Display status summary.
306
This reports on versioned and unknown files, reporting them
307
grouped by state. Possible states are:
310
Versioned in the working copy but not in the previous revision.
313
Versioned in the previous revision but removed or deleted
317
Path of this file changed from the previous revision;
318
the text may also have changed. This includes files whose
319
parent directory was renamed.
322
Text has changed since the previous revision.
325
Nothing about this file has changed since the previous revision.
326
Only shown with --all.
329
Not versioned and not matching an ignore pattern.
331
To see ignored files use 'bzr ignored'. For details in the
332
changes to file texts, use 'bzr diff'.
334
If no arguments are specified, the status of the entire working
335
directory is shown. Otherwise, only the status of the specified
336
files or directories is reported. If a directory is given, status
337
is reported for everything inside that directory.
339
takes_args = ['file*']
340
takes_options = ['all', 'show-ids']
341
aliases = ['st', 'stat']
343
def run(self, all=False, show_ids=False, file_list=None):
345
b = Branch(file_list[0])
346
file_list = [b.relpath(x) for x in file_list]
347
# special case: only one path was given and it's the root
349
if file_list == ['']:
354
status.show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
358
class cmd_cat_revision(Command):
359
"""Write out metadata for a revision."""
362
takes_args = ['revision_id']
364
def run(self, revision_id):
365
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
368
class cmd_revno(Command):
369
"""Show current revision number.
371
This is equal to the number of revisions on this branch."""
373
print Branch('.').revno()
376
class cmd_add(Command):
377
"""Add specified files or directories.
379
In non-recursive mode, all the named items are added, regardless
380
of whether they were previously ignored. A warning is given if
381
any of the named files are already versioned.
383
In recursive mode (the default), files are treated the same way
384
but the behaviour for directories is different. Directories that
385
are already versioned do not give a warning. All directories,
386
whether already versioned or not, are searched for files or
387
subdirectories that are neither versioned or ignored, and these
388
are added. This search proceeds recursively into versioned
391
Therefore simply saying 'bzr add .' will version all files that
392
are currently unknown.
394
TODO: Perhaps adding a file whose directly is not versioned should
395
recursively add that parent, rather than giving an error?
397
takes_args = ['file+']
398
takes_options = ['verbose', 'no-recurse']
400
def run(self, file_list, verbose=False, no_recurse=False):
401
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
404
class cmd_relpath(Command):
405
"""Show path of a file relative to root"""
406
takes_args = ['filename']
409
def run(self, filename):
410
print Branch(filename).relpath(filename)
414
class cmd_inventory(Command):
415
"""Show inventory of the current working copy or a revision."""
416
takes_options = ['revision', 'show-ids']
418
def run(self, revision=None, show_ids=False):
421
inv = b.read_working_inventory()
423
inv = b.get_revision_inventory(b.lookup_revision(revision))
425
for path, entry in inv.entries():
427
print '%-50s %s' % (path, entry.file_id)
432
class cmd_move(Command):
433
"""Move files to a different directory.
438
The destination must be a versioned directory in the same branch.
440
takes_args = ['source$', 'dest']
441
def run(self, source_list, dest):
444
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
447
class cmd_rename(Command):
448
"""Change the name of an entry.
451
bzr rename frob.c frobber.c
452
bzr rename src/frob.c lib/frob.c
454
It is an error if the destination name exists.
456
See also the 'move' command, which moves files into a different
457
directory without changing their name.
459
TODO: Some way to rename multiple files without invoking bzr for each
461
takes_args = ['from_name', 'to_name']
463
def run(self, from_name, to_name):
465
b.rename_one(b.relpath(from_name), b.relpath(to_name))
471
class cmd_pull(Command):
472
"""Pull any changes from another branch into the current one.
474
If the location is omitted, the last-used location will be used.
475
Both the revision history and the working directory will be
478
This command only works on branches that have not diverged. Branches are
479
considered diverged if both branches have had commits without first
480
pulling from the other.
482
If branches have diverged, you can use 'bzr merge' to pull the text changes
483
from one into the other.
485
takes_args = ['location?']
487
def run(self, location=None):
488
from bzrlib.merge import merge
494
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
496
if errno == errno.ENOENT:
499
location = stored_loc
501
raise BzrCommandError("No pull location known or specified.")
502
from branch import find_branch, DivergedBranches
503
br_from = find_branch(location)
504
location = pull_loc(br_from)
505
old_revno = br_to.revno()
507
br_to.update_revisions(br_from)
508
except DivergedBranches:
509
raise BzrCommandError("These branches have diverged. Try merge.")
511
merge(('.', -1), ('.', old_revno), check_clean=False)
512
if location != stored_loc:
513
br_to.controlfile("x-pull", "wb").write(location + "\n")
517
class cmd_branch(Command):
518
"""Create a new copy of a branch.
520
If the TO_LOCATION is omitted, the last component of the
521
FROM_LOCATION will be used. In other words,
522
"branch ../foo/bar" will attempt to create ./bar.
524
takes_args = ['from_location', 'to_location?']
526
def run(self, from_location, to_location=None):
528
from bzrlib.merge import merge
530
if to_location is None:
531
to_location = os.path.basename(from_location)
532
# FIXME: If there's a trailing slash, keep removing them
533
# until we find the right bit
536
os.mkdir(to_location)
538
if e.errno == errno.EEXIST:
539
raise BzrCommandError('Target directory "%s" already exists.' %
541
if e.errno == errno.ENOENT:
542
raise BzrCommandError('Parent of "%s" does not exist.' %
546
br_to = Branch(to_location, init=True)
547
from branch import find_branch, DivergedBranches
549
br_from = find_branch(from_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Source location "%s" does not exist.' %
557
from_location = pull_loc(br_from)
558
br_to.update_revisions(br_from)
559
merge((to_location, -1), (to_location, 0), this_dir=to_location,
561
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
564
def pull_loc(branch):
565
# TODO: Should perhaps just make attribute be 'base' in
566
# RemoteBranch and Branch?
567
if hasattr(branch, "baseurl"):
568
return branch.baseurl
574
class cmd_renames(Command):
575
"""Show list of renamed files.
577
TODO: Option to show renames between two historical versions.
579
TODO: Only show renames under dir, rather than in the whole branch.
581
takes_args = ['dir?']
583
def run(self, dir='.'):
585
old_inv = b.basis_tree().inventory
586
new_inv = b.read_working_inventory()
588
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
590
for old_name, new_name in renames:
591
print "%s => %s" % (old_name, new_name)
594
class cmd_info(Command):
595
"""Show statistical information about a branch."""
596
takes_args = ['branch?']
598
def run(self, branch=None):
601
from branch import find_branch
602
b = find_branch(branch)
606
class cmd_remove(Command):
607
"""Make a file unversioned.
609
This makes bzr stop tracking changes to a versioned file. It does
610
not delete the working copy.
612
takes_args = ['file+']
613
takes_options = ['verbose']
615
def run(self, file_list, verbose=False):
616
b = Branch(file_list[0])
617
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
620
class cmd_file_id(Command):
621
"""Print file_id of a particular file or directory.
623
The file_id is assigned when the file is first added and remains the
624
same through all revisions where the file exists, even when it is
628
takes_args = ['filename']
629
def run(self, filename):
631
i = b.inventory.path2id(b.relpath(filename))
633
bailout("%r is not a versioned file" % filename)
638
class cmd_file_path(Command):
639
"""Print path of file_ids to a file or directory.
641
This prints one line for each directory down to the target,
642
starting at the branch root."""
644
takes_args = ['filename']
645
def run(self, filename):
648
fid = inv.path2id(b.relpath(filename))
650
bailout("%r is not a versioned file" % filename)
651
for fip in inv.get_idpath(fid):
655
class cmd_revision_history(Command):
656
"""Display list of revision ids on this branch."""
659
for patchid in Branch('.').revision_history():
663
class cmd_directories(Command):
664
"""Display list of versioned directories in this branch."""
666
for name, ie in Branch('.').read_working_inventory().directories():
673
class cmd_init(Command):
674
"""Make a directory into a versioned branch.
676
Use this to create an empty branch, or before importing an
679
Recipe for importing a tree of files:
684
bzr commit -m 'imported project'
687
Branch('.', init=True)
690
class cmd_diff(Command):
691
"""Show differences in working tree.
693
If files are listed, only the changes in those files are listed.
694
Otherwise, all changes for the tree are listed.
696
TODO: Given two revision arguments, show the difference between them.
698
TODO: Allow diff across branches.
700
TODO: Option to use external diff command; could be GNU diff, wdiff,
703
TODO: Python difflib is not exactly the same as unidiff; should
704
either fix it up or prefer to use an external diff.
706
TODO: If a directory is given, diff everything under that.
708
TODO: Selected-file diff is inefficient and doesn't show you
711
TODO: This probably handles non-Unix newlines poorly.
714
takes_args = ['file*']
715
takes_options = ['revision', 'diff-options']
716
aliases = ['di', 'dif']
718
def run(self, revision=None, file_list=None, diff_options=None):
719
from bzrlib.diff import show_diff
720
from bzrlib import find_branch
723
b = find_branch(file_list[0])
724
file_list = [b.relpath(f) for f in file_list]
725
if file_list == ['']:
726
# just pointing to top-of-tree
731
show_diff(b, revision, specific_files=file_list,
732
external_diff_options=diff_options)
738
class cmd_deleted(Command):
739
"""List files deleted in the working tree.
741
TODO: Show files deleted since a previous revision, or between two revisions.
743
def run(self, show_ids=False):
746
new = b.working_tree()
748
## TODO: Much more efficient way to do this: read in new
749
## directories with readdir, rather than stating each one. Same
750
## level of effort but possibly much less IO. (Or possibly not,
751
## if the directories are very large...)
753
for path, ie in old.inventory.iter_entries():
754
if not new.has_id(ie.file_id):
756
print '%-50s %s' % (path, ie.file_id)
761
class cmd_modified(Command):
762
"""List files modified in working tree."""
767
inv = b.read_working_inventory()
768
sc = statcache.update_cache(b, inv)
769
basis = b.basis_tree()
770
basis_inv = basis.inventory
772
# We used to do this through iter_entries(), but that's slow
773
# when most of the files are unmodified, as is usually the
774
# case. So instead we iterate by inventory entry, and only
775
# calculate paths as necessary.
777
for file_id in basis_inv:
778
cacheentry = sc.get(file_id)
779
if not cacheentry: # deleted
781
ie = basis_inv[file_id]
782
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
783
path = inv.id2path(file_id)
788
class cmd_added(Command):
789
"""List files added in working tree."""
793
wt = b.working_tree()
794
basis_inv = b.basis_tree().inventory
797
if file_id in basis_inv:
799
path = inv.id2path(file_id)
800
if not os.access(b.abspath(path), os.F_OK):
806
class cmd_root(Command):
807
"""Show the tree root directory.
809
The root is the nearest enclosing directory with a .bzr control
811
takes_args = ['filename?']
812
def run(self, filename=None):
813
"""Print the branch root."""
814
from branch import find_branch
815
b = find_branch(filename)
816
print getattr(b, 'base', None) or getattr(b, 'baseurl')
819
class cmd_log(Command):
820
"""Show log of this branch.
822
To request a range of logs, you can use the command -r begin:end
823
-r revision requests a specific revision, -r :end or -r begin: are
826
TODO: Make --revision support uuid: and hash: [future tag:] notation.
830
takes_args = ['filename?']
831
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
833
def run(self, filename=None, timezone='original',
838
from bzrlib import show_log, find_branch
841
direction = (forward and 'forward') or 'reverse'
844
b = find_branch(filename)
845
fp = b.relpath(filename)
847
file_id = b.read_working_inventory().path2id(fp)
849
file_id = None # points to branch root
855
revision = [None, None]
856
elif isinstance(revision, int):
857
revision = [revision, revision]
862
assert len(revision) == 2
864
mutter('encoding log as %r' % bzrlib.user_encoding)
866
# use 'replace' so that we don't abort if trying to write out
867
# in e.g. the default C locale.
868
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
871
show_timezone=timezone,
876
start_revision=revision[0],
877
end_revision=revision[1])
881
class cmd_touching_revisions(Command):
882
"""Return revision-ids which affected a particular file.
884
A more user-friendly interface is "bzr log FILE"."""
886
takes_args = ["filename"]
887
def run(self, filename):
889
inv = b.read_working_inventory()
890
file_id = inv.path2id(b.relpath(filename))
891
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
892
print "%6d %s" % (revno, what)
895
class cmd_ls(Command):
896
"""List files in a tree.
898
TODO: Take a revision or remote path and list that tree instead.
901
def run(self, revision=None, verbose=False):
904
tree = b.working_tree()
906
tree = b.revision_tree(b.lookup_revision(revision))
908
for fp, fc, kind, fid in tree.list_files():
910
if kind == 'directory':
917
print '%-8s %s%s' % (fc, fp, kindch)
923
class cmd_unknowns(Command):
924
"""List unknown files."""
926
for f in Branch('.').unknowns():
931
class cmd_ignore(Command):
932
"""Ignore a command or pattern.
934
To remove patterns from the ignore list, edit the .bzrignore file.
936
If the pattern contains a slash, it is compared to the whole path
937
from the branch root. Otherwise, it is comapred to only the last
938
component of the path.
940
Ignore patterns are case-insensitive on case-insensitive systems.
942
Note: wildcards must be quoted from the shell on Unix.
945
bzr ignore ./Makefile
948
takes_args = ['name_pattern']
950
def run(self, name_pattern):
951
from bzrlib.atomicfile import AtomicFile
955
ifn = b.abspath('.bzrignore')
957
if os.path.exists(ifn):
960
igns = f.read().decode('utf-8')
966
# TODO: If the file already uses crlf-style termination, maybe
967
# we should use that for the newly added lines?
969
if igns and igns[-1] != '\n':
971
igns += name_pattern + '\n'
974
f = AtomicFile(ifn, 'wt')
975
f.write(igns.encode('utf-8'))
980
inv = b.working_tree().inventory
981
if inv.path2id('.bzrignore'):
982
mutter('.bzrignore is already versioned')
984
mutter('need to make new .bzrignore file versioned')
985
b.add(['.bzrignore'])
989
class cmd_ignored(Command):
990
"""List ignored files and the patterns that matched them.
992
See also: bzr ignore"""
994
tree = Branch('.').working_tree()
995
for path, file_class, kind, file_id in tree.list_files():
996
if file_class != 'I':
998
## XXX: Slightly inefficient since this was already calculated
999
pat = tree.is_ignored(path)
1000
print '%-50s %s' % (path, pat)
1003
class cmd_lookup_revision(Command):
1004
"""Lookup the revision-id from a revision-number
1007
bzr lookup-revision 33
1010
takes_args = ['revno']
1012
def run(self, revno):
1016
raise BzrCommandError("not a valid revision-number: %r" % revno)
1018
print Branch('.').lookup_revision(revno)
1021
class cmd_export(Command):
1022
"""Export past revision to destination directory.
1024
If no revision is specified this exports the last committed revision."""
1025
takes_args = ['dest']
1026
takes_options = ['revision']
1027
def run(self, dest, revision=None):
1029
if revision == None:
1030
rh = b.revision_history()[-1]
1032
rh = b.lookup_revision(int(revision))
1033
t = b.revision_tree(rh)
1037
class cmd_cat(Command):
1038
"""Write a file's text from a previous revision."""
1040
takes_options = ['revision']
1041
takes_args = ['filename']
1043
def run(self, filename, revision=None):
1044
if revision == None:
1045
raise BzrCommandError("bzr cat requires a revision number")
1047
b.print_file(b.relpath(filename), int(revision))
1050
class cmd_local_time_offset(Command):
1051
"""Show the offset in seconds from GMT to local time."""
1054
print bzrlib.osutils.local_time_offset()
1058
class cmd_commit(Command):
1059
"""Commit changes into a new revision.
1061
If selected files are specified, only changes to those files are
1062
committed. If a directory is specified then its contents are also
1065
A selected-file commit may fail in some cases where the committed
1066
tree would be invalid, such as trying to commit a file in a
1067
newly-added directory that is not itself committed.
1069
TODO: Run hooks on tree to-be-committed, and after commit.
1071
TODO: Strict commit that fails if there are unknown or deleted files.
1073
takes_args = ['selected*']
1074
takes_options = ['message', 'file', 'verbose']
1075
aliases = ['ci', 'checkin']
1077
def run(self, message=None, file=None, verbose=True, selected_list=None):
1078
from bzrlib.commit import commit
1080
## Warning: shadows builtin file()
1081
if not message and not file:
1082
raise BzrCommandError("please specify a commit message",
1083
["use either --message or --file"])
1084
elif message and file:
1085
raise BzrCommandError("please specify either --message or --file")
1089
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1092
commit(b, message, verbose=verbose, specific_files=selected_list)
1095
class cmd_check(Command):
1096
"""Validate consistency of branch history.
1098
This command checks various invariants about the branch storage to
1099
detect data corruption or bzr bugs.
1101
takes_args = ['dir?']
1102
def run(self, dir='.'):
1104
bzrlib.check.check(Branch(dir))
1108
class cmd_whoami(Command):
1109
"""Show bzr user id."""
1110
takes_options = ['email']
1112
def run(self, email=False):
1114
print bzrlib.osutils.user_email()
1116
print bzrlib.osutils.username()
1119
class cmd_selftest(Command):
1120
"""Run internal test suite"""
1123
from bzrlib.selftest import selftest
1131
class cmd_version(Command):
1132
"""Show version of bzr."""
1137
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1138
# is bzrlib itself in a branch?
1139
bzrrev = bzrlib.get_bzr_revision()
1141
print " (bzr checkout, revision %d {%s})" % bzrrev
1142
print bzrlib.__copyright__
1143
print "http://bazaar-ng.org/"
1145
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1146
print "you may use, modify and redistribute it under the terms of the GNU"
1147
print "General Public License version 2 or later."
1150
class cmd_rocks(Command):
1151
"""Statement of optimism."""
1154
print "it sure does!"
1156
def parse_spec(spec):
1158
>>> parse_spec(None)
1160
>>> parse_spec("./")
1162
>>> parse_spec("../@")
1164
>>> parse_spec("../f/@35")
1170
parsed = spec.split('/@')
1171
assert len(parsed) == 2
1175
parsed[1] = int(parsed[1])
1176
assert parsed[1] >=0
1178
parsed = [spec, None]
1183
class cmd_merge(Command):
1184
"""Perform a three-way merge of trees.
1186
The SPEC parameters are working tree or revision specifiers. Working trees
1187
are specified using standard paths or urls. No component of a directory
1188
path may begin with '@'.
1190
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1192
Revisions are specified using a dirname/@revno pair, where dirname is the
1193
branch directory and revno is the revision within that branch. If no revno
1194
is specified, the latest revision is used.
1196
Revision examples: './@127', 'foo/@', '../@1'
1198
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1199
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1202
merge refuses to run if there are any uncommitted changes, unless
1205
takes_args = ['other_spec', 'base_spec?']
1206
takes_options = ['force']
1208
def run(self, other_spec, base_spec=None, force=False):
1209
from bzrlib.merge import merge
1210
merge(parse_spec(other_spec), parse_spec(base_spec),
1211
check_clean=(not force))
1214
class cmd_revert(Command):
1215
"""Reverse all changes since the last commit.
1217
Only versioned files are affected.
1219
TODO: Store backups of any files that will be reverted, so
1220
that the revert can be undone.
1222
takes_options = ['revision']
1224
def run(self, revision=-1):
1225
from bzrlib.merge import merge
1226
merge(('.', revision), parse_spec('.'),
1231
class cmd_assert_fail(Command):
1232
"""Test reporting of assertion failures"""
1235
assert False, "always fails"
1238
class cmd_help(Command):
1239
"""Show help on a command or other topic.
1241
For a list of all available commands, say 'bzr help commands'."""
1242
takes_args = ['topic?']
1245
def run(self, topic=None):
1250
class cmd_update_stat_cache(Command):
1251
"""Update stat-cache mapping inodes to SHA-1 hashes.
1253
For testing only."""
1258
statcache.update_cache(b.base, b.read_working_inventory())
1262
# list of all available options; the rhs can be either None for an
1263
# option that takes no argument, or a constructor function that checks
1267
'diff-options': str,
1275
'revision': _parse_revision_str,
1292
def parse_args(argv):
740
1293
"""Parse command line.
742
1295
Arguments and options are parsed at this level before being passed
743
1296
down to specific command handlers. This routine knows, from a
744
1297
lookup table, something about the available options, what optargs
745
1298
they take, and which commands will accept them.
1300
>>> parse_args('--help'.split())
1301
([], {'help': True})
1302
>>> parse_args('--version'.split())
1303
([], {'version': True})
1304
>>> parse_args('status --all'.split())
1305
(['status'], {'all': True})
1306
>>> parse_args('commit --message=biter'.split())
1307
(['commit'], {'message': u'biter'})
747
# TODO: make it a method of the Command?
748
parser = option.get_optparser(command.options())
749
if alias_argv is not None:
750
args = alias_argv + argv
754
options, args = parser.parse_args(args)
755
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
756
v is not option.OptionParser.DEFAULT_VALUE])
1312
# TODO: Maybe handle '--' to end options?
1317
# option names must not be unicode
1321
mutter(" got option %r" % a)
1323
optname, optarg = a[2:].split('=', 1)
1326
if optname not in OPTIONS:
1327
bailout('unknown long option %r' % a)
1330
if shortopt not in SHORT_OPTIONS:
1331
bailout('unknown short option %r' % a)
1332
optname = SHORT_OPTIONS[shortopt]
1335
# XXX: Do we ever want to support this, e.g. for -r?
1336
bailout('repeated option %r' % a)
1338
optargfn = OPTIONS[optname]
1342
bailout('option %r needs an argument' % a)
1344
optarg = argv.pop(0)
1345
opts[optname] = optargfn(optarg)
1348
bailout('option %r takes no argument' % optname)
1349
opts[optname] = True
757
1353
return args, opts
760
1358
def _match_argform(cmd, takes_args, args):
774
1372
argdict[argname + '_list'] = None
775
1373
elif ap[-1] == '+':
777
raise errors.BzrCommandError("command %r needs one or more %s"
778
% (cmd, argname.upper()))
1375
raise BzrCommandError("command %r needs one or more %s"
1376
% (cmd, argname.upper()))
780
1378
argdict[argname + '_list'] = args[:]
782
1380
elif ap[-1] == '$': # all but one
783
1381
if len(args) < 2:
784
raise errors.BzrCommandError("command %r needs one or more %s"
785
% (cmd, argname.upper()))
1382
raise BzrCommandError("command %r needs one or more %s"
1383
% (cmd, argname.upper()))
786
1384
argdict[argname + '_list'] = args[:-1]
789
1387
# just a plain arg
792
raise errors.BzrCommandError("command %r requires argument %s"
793
% (cmd, argname.upper()))
1390
raise BzrCommandError("command %r requires argument %s"
1391
% (cmd, argname.upper()))
795
1393
argdict[argname] = args.pop(0)
798
raise errors.BzrCommandError("extra argument to command %s: %s"
1396
raise BzrCommandError("extra argument to command %s: %s"
803
def apply_coveraged(dirname, the_callable, *args, **kwargs):
804
# Cannot use "import trace", as that would import bzrlib.trace instead of
805
# the standard library's trace.
806
trace = __import__('trace')
808
tracer = trace.Trace(count=1, trace=0)
809
sys.settrace(tracer.globaltrace)
810
threading.settrace(tracer.globaltrace)
813
return exception_to_return_code(the_callable, *args, **kwargs)
816
results = tracer.results()
817
results.write_results(show_missing=1, summary=False,
821
def apply_profiled(the_callable, *args, **kwargs):
825
pffileno, pfname = tempfile.mkstemp()
827
prof = hotshot.Profile(pfname)
829
ret = prof.runcall(exception_to_return_code, the_callable, *args,
833
stats = hotshot.stats.load(pfname)
835
stats.sort_stats('cum') # 'time'
836
## XXX: Might like to write to stderr or the trace file instead but
837
## print_stats seems hardcoded to stdout
838
stats.print_stats(20)
845
def exception_to_return_code(the_callable, *args, **kwargs):
846
"""UI level helper for profiling and coverage.
848
This transforms exceptions into a return value of 3. As such its only
849
relevant to the UI layer, and should never be called where catching
850
exceptions may be desirable.
853
return the_callable(*args, **kwargs)
854
except (KeyboardInterrupt, Exception), e:
855
# used to handle AssertionError and KeyboardInterrupt
856
# specially here, but hopefully they're handled ok by the logger now
857
exc_info = sys.exc_info()
858
exitcode = trace.report_exception(exc_info, sys.stderr)
859
if os.environ.get('BZR_PDB'):
860
print '**** entering debugger'
863
if sys.version_info[:2] < (2, 6):
865
# pdb.post_mortem(tb)
866
# but because pdb.post_mortem gives bad results for tracebacks
867
# from inside generators, we do it manually.
868
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
870
# Setup pdb on the traceback
873
p.setup(tb.tb_frame, tb)
874
# Point the debugger at the deepest frame of the stack
875
p.curindex = len(p.stack) - 1
876
p.curframe = p.stack[p.curindex][0]
877
# Start the pdb prompt.
878
p.print_stack_entry(p.stack[p.curindex])
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
887
from bzrlib.lsprof import profile
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
894
trace.note('Profile data written to "%s".', filename)
898
def shlex_split_unicode(unsplit):
900
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
903
def get_alias(cmd, config=None):
904
"""Return an expanded alias, or None if no alias exists.
907
Command to be checked for an alias.
909
Used to specify an alternative config to use,
910
which is especially useful for testing.
911
If it is unspecified, the global config will be used.
915
config = bzrlib.config.GlobalConfig()
916
alias = config.get_alias(cmd)
918
return shlex_split_unicode(alias)
922
1403
def run_bzr(argv):
923
1404
"""Execute a command.
926
The command-line arguments, without the program name from argv[0]
927
These should already be decoded. All library/test code calling
928
run_bzr should be passing valid strings (don't need decoding).
930
Returns a command status or raises an exception.
932
Special master options: these must come before the command because
933
they control how the command is interpreted.
936
Do not load plugin modules at all
942
Only use builtin commands. (Plugins are still allowed to change
946
Run under the Python hotshot profiler.
949
Run under the Python lsprof profiler.
952
Generate line coverage report in the specified directory.
955
Specify the number of processes that can be run concurrently (selftest).
1406
This is similar to main(), but without all the trappings for
1407
logging and error handling.
957
trace.mutter("bazaar version: " + bzrlib.__version__)
959
trace.mutter("bzr arguments: %r", argv)
961
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
962
opt_no_aliases = False
963
opt_lsprof_file = opt_coverage_dir = None
965
# --no-plugins is handled specially at a very early stage. We need
966
# to load plugins before doing other command parsing so that they
967
# can override commands, but this needs to happen first.
975
elif a == '--lsprof':
977
elif a == '--lsprof-file':
979
opt_lsprof_file = argv[i + 1]
981
elif a == '--no-plugins':
982
opt_no_plugins = True
983
elif a == '--no-aliases':
984
opt_no_aliases = True
985
elif a == '--builtin':
987
elif a == '--concurrency':
988
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
990
elif a == '--coverage':
991
opt_coverage_dir = argv[i + 1]
993
elif a.startswith('-D'):
994
debug.debug_flags.add(a[2:])
999
debug.set_debug_flags_from_config()
1003
from bzrlib.builtins import cmd_help
1004
cmd_help().run_argv_aliases([])
1007
if argv[0] == '--version':
1008
from bzrlib.builtins import cmd_version
1009
cmd_version().run_argv_aliases([])
1012
if not opt_no_plugins:
1013
from bzrlib.plugin import load_plugins
1016
from bzrlib.plugin import disable_plugins
1021
if not opt_no_aliases:
1022
alias_argv = get_alias(argv[0])
1024
user_encoding = osutils.get_user_encoding()
1025
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1026
argv[0] = alias_argv.pop(0)
1029
# We want only 'ascii' command names, but the user may have typed
1030
# in a Unicode name. In that case, they should just get a
1031
# 'command not found' error later.
1033
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1034
run = cmd_obj.run_argv_aliases
1035
run_argv = [argv, alias_argv]
1038
# We can be called recursively (tests for example), but we don't want
1039
# the verbosity level to propagate.
1040
saved_verbosity_level = option._verbosity_level
1041
option._verbosity_level = 0
1043
if opt_coverage_dir:
1045
'--coverage ignored, because --lsprof is in use.')
1046
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1048
if opt_coverage_dir:
1050
'--coverage ignored, because --profile is in use.')
1051
ret = apply_profiled(run, *run_argv)
1052
elif opt_coverage_dir:
1053
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1055
ret = run(*run_argv)
1409
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1411
include_plugins=True
1413
args, opts = parse_args(argv[1:])
1421
elif 'version' in opts:
1424
elif args and args[0] == 'builtin':
1425
include_plugins=False
1427
cmd = str(args.pop(0))
1434
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1437
if 'profile' in opts:
1443
# check options are reasonable
1444
allowed = cmd_class.takes_options
1446
if oname not in allowed:
1447
raise BzrCommandError("option '--%s' is not allowed for command %r"
1450
# mix arguments and options into one dictionary
1451
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1453
for k, v in opts.items():
1454
cmdopts[k.replace('-', '_')] = v
1457
import hotshot, tempfile
1458
pffileno, pfname = tempfile.mkstemp()
1460
prof = hotshot.Profile(pfname)
1461
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1464
import hotshot.stats
1465
stats = hotshot.stats.load(pfname)
1467
stats.sort_stats('time')
1468
## XXX: Might like to write to stderr or the trace file instead but
1469
## print_stats seems hardcoded to stdout
1470
stats.print_stats(20)
1478
return cmd_class(cmdopts, cmdargs).status
1481
def _report_exception(summary, quiet=False):
1483
log_error('bzr: ' + summary)
1484
bzrlib.trace.log_exception()
1487
tb = sys.exc_info()[2]
1488
exinfo = traceback.extract_tb(tb)
1490
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1491
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1498
bzrlib.open_tracefile(argv)
1503
return run_bzr(argv)
1505
# do this here inside the exception wrappers to catch EPIPE
1508
quiet = isinstance(e, (BzrCommandError))
1509
_report_exception('error: ' + e.args[0], quiet=quiet)
1512
# some explanation or hints
1515
except AssertionError, e:
1516
msg = 'assertion failed'
1518
msg += ': ' + str(e)
1519
_report_exception(msg)
1521
except KeyboardInterrupt, e:
1522
_report_exception('interrupted', quiet=True)
1524
except Exception, e:
1526
if (isinstance(e, IOError)
1527
and hasattr(e, 'errno')
1528
and e.errno == errno.EPIPE):
1532
msg = str(e).rstrip('\n')
1533
_report_exception(msg, quiet)
1058
# reset, in case we may do other commands later within the same
1059
# process. Commands that want to execute sub-commands must propagate
1060
# --verbose in their own way.
1061
if 'memory' in debug.debug_flags:
1062
trace.debug_memory('Process status after command:', short=False)
1063
option._verbosity_level = saved_verbosity_level
1066
def display_command(func):
1067
"""Decorator that suppresses pipe/interrupt errors."""
1068
def ignore_pipe(*args, **kwargs):
1070
result = func(*args, **kwargs)
1074
if getattr(e, 'errno', None) is None:
1076
if e.errno != errno.EPIPE:
1077
# Win32 raises IOError with errno=0 on a broken pipe
1078
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1081
except KeyboardInterrupt:
1086
def install_bzr_command_hooks():
1087
"""Install the hooks to supply bzr's own commands."""
1088
if _list_bzr_commands in Command.hooks["list_commands"]:
1090
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1092
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1094
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1095
"bzr plugin commands")
1096
Command.hooks.install_named_hook("get_command", _get_external_command,
1097
"bzr external command lookup")
1098
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
"bzr plugin-provider-db check")
1102
def main(argv=None):
1103
"""Main entry point of command-line interface.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
1113
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
sys.stdin, sys.stdout, sys.stderr)
1116
# Is this a final release version? If so, we should suppress warnings
1117
if bzrlib.version_info[3] == 'final':
1118
suppress_deprecation_warnings(override=True)
1120
argv = osutils.get_unicode_argv()
1124
# ensure all arguments are unicode strings
1126
if isinstance(a, unicode):
1129
new_argv.append(a.decode('ascii'))
1130
except UnicodeDecodeError:
1131
raise errors.BzrError("argv should be list of unicode strings.")
1133
ret = run_bzr_catch_errors(argv)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1136
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
1141
def run_bzr_catch_errors(argv):
1142
"""Run a bzr command with parameters as described by argv.
1144
This function assumed that that UI layer is setup, that symbol deprecations
1145
are already applied, and that unicode decoding has already been performed on argv.
1147
install_bzr_command_hooks()
1148
return exception_to_return_code(run_bzr, argv)
1151
def run_bzr_catch_user_errors(argv):
1152
"""Run bzr and report user errors, but let internal errors propagate.
1154
This is used for the test suite, and might be useful for other programs
1155
that want to wrap the commandline interface.
1157
install_bzr_command_hooks()
1159
return run_bzr(argv)
1160
except Exception, e:
1161
if (isinstance(e, (OSError, IOError))
1162
or not getattr(e, 'internal_error', True)):
1163
trace.report_exception(sys.exc_info(), sys.stderr)
1169
class HelpCommandIndex(object):
1170
"""A index for bzr help that returns commands."""
1173
self.prefix = 'commands/'
1175
def get_topics(self, topic):
1176
"""Search for topic amongst commands.
1178
:param topic: A topic to search for.
1179
:return: A list which is either empty or contains a single
1182
if topic and topic.startswith(self.prefix):
1183
topic = topic[len(self.prefix):]
1185
cmd = _get_cmd_object(topic)
1192
class Provider(object):
1193
'''Generic class to be overriden by plugins'''
1195
def plugin_for_command(self, cmd_name):
1196
'''Takes a command and returns the information for that plugin
1198
:return: A dictionary with all the available information
1199
for the requested plugin
1201
raise NotImplementedError
1204
class ProvidersRegistry(registry.Registry):
1205
'''This registry exists to allow other providers to exist'''
1208
for key, provider in self.iteritems():
1211
command_providers_registry = ProvidersRegistry()
1536
bzrlib.trace.close_trace()
1214
1539
if __name__ == '__main__':
added
removed
bzrlib/commands.py
