33
159
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
35
160
return cmd[4:].replace('_','-')
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()
163
def _register_builtin_commands():
164
if builtin_command_registry.keys():
167
import bzrlib.builtins
168
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
169
builtin_command_registry.register(cmd_class)
170
bzrlib.builtins._register_lazy_builtins()
173
def _scan_module_for_commands(module):
175
for name, obj in module.__dict__.iteritems():
176
if name.startswith("cmd_"):
177
real_name = _unsquish_command_name(name)
182
def _list_bzr_commands(names):
183
"""Find commands from bzr's core and plugins.
185
This is not the public interface, just the default hook called by all_command_names.
187
# to eliminate duplicates
188
names.update(builtin_command_names())
189
names.update(plugin_command_names())
193
def all_command_names():
194
"""Return a set of all command names."""
196
for hook in Command.hooks['list_commands']:
199
raise AssertionError(
200
'hook %s returned None' % Command.hooks.get_hook_name(hook))
204
def builtin_command_names():
205
"""Return list of builtin command names.
207
Use of all_command_names() is encouraged rather than builtin_command_names
208
and/or plugin_command_names.
210
_register_builtin_commands()
211
return builtin_command_registry.keys()
214
def plugin_command_names():
215
"""Returns command names from commands registered by plugins."""
216
return plugin_cmds.keys()
219
def get_cmd_object(cmd_name, plugins_override=True):
220
"""Return the command object for a command.
223
If true, plugin commands can override builtins.
226
return _get_cmd_object(cmd_name, plugins_override)
228
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
231
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
232
"""Get a command object.
234
:param cmd_name: The name of the command.
235
:param plugins_override: Allow plugins to override builtins.
236
:param check_missing: Look up commands not found in the regular index via
237
the get_missing_command hook.
238
:return: A Command object instance
239
:raises KeyError: If no command is found.
241
# We want only 'ascii' command names, but the user may have typed
242
# in a Unicode name. In that case, they should just get a
243
# 'command not found' error later.
244
# In the future, we may actually support Unicode command names.
247
for hook in Command.hooks['get_command']:
248
cmd = hook(cmd, cmd_name)
249
if cmd is not None and not plugins_override and not cmd.plugin_name():
250
# We've found a non-plugin command, don't permit it to be
253
if cmd is None and check_missing:
254
for hook in Command.hooks['get_missing_command']:
261
# Allow plugins to extend commands
262
for hook in Command.hooks['extend_command']:
264
if getattr(cmd, 'invoked_as', None) is None:
265
cmd.invoked_as = cmd_name
269
def _try_plugin_provider(cmd_name):
270
"""Probe for a plugin provider having cmd_name."""
272
plugin_metadata, provider = probe_for_provider(cmd_name)
273
raise errors.CommandAvailableInPlugin(cmd_name,
274
plugin_metadata, provider)
275
except errors.NoPluginAvailable:
279
def probe_for_provider(cmd_name):
280
"""Look for a provider for cmd_name.
282
:param cmd_name: The command name.
283
:return: plugin_metadata, provider for getting cmd_name.
284
:raises NoPluginAvailable: When no provider can supply the plugin.
286
# look for providers that provide this command but aren't installed
287
for provider in command_providers_registry:
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)
289
return provider.plugin_for_command(cmd_name), provider
290
except errors.NoPluginAvailable:
292
raise errors.NoPluginAvailable(cmd_name)
295
def _get_bzr_command(cmd_or_None, cmd_name):
296
"""Get a command from bzr's core."""
298
cmd_class = builtin_command_registry.get(cmd_name)
306
def _get_external_command(cmd_or_None, cmd_name):
307
"""Lookup a command that is a shell script."""
308
# Only do external command lookups when no command is found so far.
309
if cmd_or_None is not None:
311
from bzrlib.externalcommand import ExternalCommand
312
cmd_obj = ExternalCommand.find_command(cmd_name)
317
def _get_plugin_command(cmd_or_None, cmd_name):
318
"""Get a command from bzr's plugins."""
320
return plugin_cmds.get(cmd_name)()
323
for key in plugin_cmds.keys():
324
info = plugin_cmds.get_info(key)
325
if cmd_name in info.aliases:
326
return plugin_cmds.get(key)()
182
330
class Command(object):
183
331
"""Base class for commands.
333
Commands are the heart of the command-line bzr interface.
335
The command object mostly handles the mapping of command-line
336
parameters into one or more bzrlib operations, and of the results
339
Commands normally don't have any state. All their arguments are
340
passed in to the run method. (Subclasses may take a different
341
policy if the behaviour of the instance needs to depend on e.g. a
342
shell plugin and not just its Python class.)
185
344
The docstring for an actual command should give a single-line
186
345
summary, then a complete description of the command. A grammar
187
346
description will be inserted.
190
List of argument forms, marked with whether they are optional,
194
List of options that may be given for this command.
197
If true, this command isn't advertised.
348
:cvar aliases: Other accepted names for this command.
350
:cvar takes_args: List of argument forms, marked with whether they are
351
optional, repeated, etc. Examples::
353
['to_location', 'from_branch?', 'file*']
355
* 'to_location' is required
356
* 'from_branch' is optional
357
* 'file' can be specified 0 or more times
359
:cvar takes_options: List of options that may be given for this command.
360
These can be either strings, referring to globally-defined options, or
361
option objects. Retrieve through options().
363
:cvar hidden: If true, this command isn't advertised. This is typically
364
for commands intended for expert users.
366
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
367
been setup to properly handle encoding of unicode strings.
368
encoding_type determines what will happen when characters cannot be
371
* strict - abort if we cannot decode
372
* replace - put in a bogus character (typically '?')
373
* exact - do not encode sys.stdout
375
NOTE: by default on Windows, sys.stdout is opened as a text stream,
376
therefore LF line-endings are converted to CRLF. When a command uses
377
encoding_type = 'exact', then sys.stdout is forced to be a binary
378
stream, and line-endings will not mangled.
381
A string indicating the real name under which this command was
382
invoked, before expansion of aliases.
383
(This may be None if the command was constructed and run in-process.)
385
:cvar hooks: An instance of CommandHooks.
387
:cvar __doc__: The help shown by 'bzr help command' for this command.
388
This is set by assigning explicitly to __doc__ so that -OO can
392
__doc__ = "My help goes here"
202
396
takes_options = []
397
encoding_type = 'strict'
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)
404
"""Construct an instance of this command."""
405
# List of standard options directly supported
406
self.supported_std_options = []
409
def add_cleanup(self, cleanup_func, *args, **kwargs):
410
"""Register a function to call after self.run returns or raises.
412
Functions will be called in LIFO order.
414
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
416
def cleanup_now(self):
417
"""Execute and empty pending cleanup functions immediately.
419
After cleanup_now all registered cleanups are forgotten. add_cleanup
420
may be called again after cleanup_now; these cleanups will be called
421
after self.run returns or raises (or when cleanup_now is next called).
423
This is useful for releasing expensive or contentious resources (such
424
as write locks) before doing further work that does not require those
425
resources (such as writing results to self.outf). Note though, that
426
as it releases all resources, this may release locks that the command
427
wants to hold, so use should be done with care.
429
self._operation.cleanup_now()
432
"""Return single-line grammar for this command.
434
Only describes arguments, not options.
436
s = 'bzr ' + self.name() + ' '
437
for aname in self.takes_args:
438
aname = aname.upper()
439
if aname[-1] in ['$', '+']:
440
aname = aname[:-1] + '...'
441
elif aname[-1] == '?':
442
aname = '[' + aname[:-1] + ']'
443
elif aname[-1] == '*':
444
aname = '[' + aname[:-1] + '...]'
446
s = s[:-1] # remove last space
449
def get_help_text(self, additional_see_also=None, plain=True,
450
see_also_as_links=False, verbose=True):
451
"""Return a text string with help for this command.
453
:param additional_see_also: Additional help topics to be
455
:param plain: if False, raw help (reStructuredText) is
456
returned instead of plain text.
457
:param see_also_as_links: if True, convert items in 'See also'
458
list to internal links (used by bzr_man rstx generator)
459
:param verbose: if True, display the full help, otherwise
460
leave out the descriptive sections and just display
461
usage help (e.g. Purpose, Usage, Options) with a
462
message explaining how to obtain full help.
465
i18n.install() # Install i18n only for get_help_text for now.
468
# Note: If self.gettext() translates ':Usage:\n', the section will
469
# be shown after "Description" section and we don't want to
470
# translate the usage string.
471
# Though, bzr export-pot don't exports :Usage: section and it must
473
doc = self.gettext(doc)
475
doc = gettext("No help for this command.")
477
# Extract the summary (purpose) and sections out from the text
478
purpose,sections,order = self._get_help_parts(doc)
480
# If a custom usage section was provided, use it
481
if sections.has_key('Usage'):
482
usage = sections.pop('Usage')
484
usage = self._usage()
486
# The header is the purpose and usage
488
result += gettext(':Purpose: %s\n') % (purpose,)
489
if usage.find('\n') >= 0:
490
result += gettext(':Usage:\n%s\n') % (usage,)
492
result += gettext(':Usage: %s\n') % (usage,)
497
# XXX: optparse implicitly rewraps the help, and not always perfectly,
498
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
500
parser = option.get_optparser(self.options())
501
options = parser.format_option_help()
502
# FIXME: According to the spec, ReST option lists actually don't
503
# support options like --1.14 so that causes syntax errors (in Sphinx
504
# at least). As that pattern always appears in the commands that
505
# break, we trap on that and then format that block of 'format' options
506
# as a literal block. We use the most recent format still listed so we
507
# don't have to do that too often -- vila 20110514
508
if not plain and options.find(' --1.14 ') != -1:
509
options = options.replace(' format:\n', ' format::\n\n', 1)
510
if options.startswith('Options:'):
511
result += gettext(':Options:%s') % (options[len('options:'):],)
517
# Add the description, indenting it 2 spaces
518
# to match the indentation of the options
519
if sections.has_key(None):
520
text = sections.pop(None)
521
text = '\n '.join(text.splitlines())
522
result += gettext(':Description:\n %s\n\n') % (text,)
524
# Add the custom sections (e.g. Examples). Note that there's no need
525
# to indent these as they must be indented already in the source.
528
if label in sections:
529
result += ':%s:\n%s\n' % (label, sections[label])
532
result += (gettext("See bzr help %s for more details and examples.\n\n")
535
# Add the aliases, source (plug-in) and see also links, if any
537
result += gettext(':Aliases: ')
538
result += ', '.join(self.aliases) + '\n'
539
plugin_name = self.plugin_name()
540
if plugin_name is not None:
541
result += gettext(':From: plugin "%s"\n') % plugin_name
542
see_also = self.get_see_also(additional_see_also)
544
if not plain and see_also_as_links:
546
for item in see_also:
548
# topics doesn't have an independent section
549
# so don't create a real link
550
see_also_links.append(item)
552
# Use a Sphinx link for this entry
553
link_text = gettext(":doc:`{0} <{1}-help>`").format(
555
see_also_links.append(link_text)
556
see_also = see_also_links
557
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
559
# If this will be rendered as plain text, convert it
561
import bzrlib.help_topics
562
result = bzrlib.help_topics.help_as_plain_text(result)
566
def _get_help_parts(text):
567
"""Split help text into a summary and named sections.
569
:return: (summary,sections,order) where summary is the top line and
570
sections is a dictionary of the rest indexed by section name.
571
order is the order the section appear in the text.
572
A section starts with a heading line of the form ":xxx:".
573
Indented text on following lines is the section value.
574
All text found outside a named section is assigned to the
575
default section which is given the key of None.
577
def save_section(sections, order, label, section):
579
if sections.has_key(label):
580
sections[label] += '\n' + section
583
sections[label] = section
585
lines = text.rstrip().splitlines()
586
summary = lines.pop(0)
589
label,section = None,''
591
if line.startswith(':') and line.endswith(':') and len(line) > 2:
592
save_section(sections, order, label, section)
593
label,section = line[1:-1],''
594
elif (label is not None) and len(line) > 1 and not line[0].isspace():
595
save_section(sections, order, label, section)
596
label,section = None,line
599
section += '\n' + line
602
save_section(sections, order, label, section)
603
return summary, sections, order
605
def get_help_topic(self):
606
"""Return the commands help topic - its name."""
609
def get_see_also(self, additional_terms=None):
610
"""Return a list of help topics that are related to this command.
612
The list is derived from the content of the _see_also attribute. Any
613
duplicates are removed and the result is in lexical order.
614
:param additional_terms: Additional help topics to cross-reference.
615
:return: A list of help topics.
617
see_also = set(getattr(self, '_see_also', []))
619
see_also.update(additional_terms)
620
return sorted(see_also)
623
"""Return dict of valid options for this command.
625
Maps from long option name to option object."""
626
r = Option.STD_OPTIONS.copy()
628
for o in self.takes_options:
629
if isinstance(o, basestring):
630
o = option.Option.OPTIONS[o]
632
if o.name in std_names:
633
self.supported_std_options.append(o.name)
636
def _setup_outf(self):
637
"""Return a file linked to stdout, which has proper encoding."""
638
self.outf = ui.ui_factory.make_output_stream(
639
encoding_type=self.encoding_type)
641
def run_argv_aliases(self, argv, alias_argv=None):
642
"""Parse the command line and run with extra aliases in alias_argv."""
643
args, opts = parse_args(self, argv, alias_argv)
646
# Process the standard options
647
if 'help' in opts: # e.g. bzr add --help
648
self.outf.write(self.get_help_text())
650
if 'usage' in opts: # e.g. bzr add --usage
651
self.outf.write(self.get_help_text(verbose=False))
653
trace.set_verbosity_level(option._verbosity_level)
654
if 'verbose' in self.supported_std_options:
655
opts['verbose'] = trace.is_verbose()
656
elif opts.has_key('verbose'):
658
if 'quiet' in self.supported_std_options:
659
opts['quiet'] = trace.is_quiet()
660
elif opts.has_key('quiet'):
662
# mix arguments and options into one dictionary
663
cmdargs = _match_argform(self.name(), self.takes_args, args)
665
for k, v in opts.items():
666
cmdopts[k.replace('-', '_')] = v
668
all_cmd_args = cmdargs.copy()
669
all_cmd_args.update(cmdopts)
672
return self.run(**all_cmd_args)
674
# reset it, so that other commands run in the same process won't
675
# inherit state. Before we reset it, log any activity, so that it
676
# gets properly tracked.
677
ui.ui_factory.log_transport_activity(
678
display=('bytes' in debug.debug_flags))
679
trace.set_verbosity_level(0)
681
def _setup_run(self):
682
"""Wrap the defined run method on self with a cleanup.
684
This is called by __init__ to make the Command be able to be run
685
by just calling run(), as it could be before cleanups were added.
687
If a different form of cleanups are in use by your Command subclass,
688
you can override this method.
691
def run(*args, **kwargs):
692
self._operation = cleanup.OperationWithCleanups(class_run)
694
return self._operation.run_simple(*args, **kwargs)
220
"""Override this in sub-classes.
700
"""Actually run the command.
222
702
This is invoked with the options and arguments bound to
223
703
keyword parameters.
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):
292
optname = name.replace('_','-')
294
if OPTIONS.has_key(optname):
296
opts.append('--%s' % optname)
297
if value is not None and value is not True:
298
opts.append(str(value))
300
# it's an arg, or arg list
301
if type(value) is not list:
307
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
311
class cmd_status(Command):
312
"""Display status summary.
314
This reports on versioned and unknown files, reporting them
315
grouped by state. Possible states are:
318
Versioned in the working copy but not in the previous revision.
321
Versioned in the previous revision but removed or deleted
325
Path of this file changed from the previous revision;
326
the text may also have changed. This includes files whose
327
parent directory was renamed.
330
Text has changed since the previous revision.
333
Nothing about this file has changed since the previous revision.
334
Only shown with --all.
337
Not versioned and not matching an ignore pattern.
339
To see ignored files use 'bzr ignored'. For details in the
340
changes to file texts, use 'bzr diff'.
342
If no arguments are specified, the status of the entire working
343
directory is shown. Otherwise, only the status of the specified
344
files or directories is reported. If a directory is given, status
345
is reported for everything inside that directory.
347
takes_args = ['file*']
348
takes_options = ['all', 'show-ids']
349
aliases = ['st', 'stat']
351
def run(self, all=False, show_ids=False, file_list=None):
353
b = Branch(file_list[0])
354
file_list = [b.relpath(x) for x in file_list]
355
# special case: only one path was given and it's the root
357
if file_list == ['']:
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
366
class cmd_cat_revision(Command):
367
"""Write out metadata for a revision."""
370
takes_args = ['revision_id']
372
def run(self, revision_id):
373
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
376
class cmd_revno(Command):
377
"""Show current revision number.
379
This is equal to the number of revisions on this branch."""
381
print Branch('.').revno()
384
class cmd_add(Command):
385
"""Add specified files or directories.
387
In non-recursive mode, all the named items are added, regardless
388
of whether they were previously ignored. A warning is given if
389
any of the named files are already versioned.
391
In recursive mode (the default), files are treated the same way
392
but the behaviour for directories is different. Directories that
393
are already versioned do not give a warning. All directories,
394
whether already versioned or not, are searched for files or
395
subdirectories that are neither versioned or ignored, and these
396
are added. This search proceeds recursively into versioned
399
Therefore simply saying 'bzr add .' will version all files that
400
are currently unknown.
402
TODO: Perhaps adding a file whose directly is not versioned should
403
recursively add that parent, rather than giving an error?
405
takes_args = ['file+']
406
takes_options = ['verbose', 'no-recurse']
408
def run(self, file_list, verbose=False, no_recurse=False):
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
412
class cmd_relpath(Command):
413
"""Show path of a file relative to root"""
414
takes_args = ['filename']
417
def run(self, filename):
418
print Branch(filename).relpath(filename)
422
class cmd_inventory(Command):
423
"""Show inventory of the current working copy or a revision."""
424
takes_options = ['revision', 'show-ids']
426
def run(self, revision=None, show_ids=False):
429
inv = b.read_working_inventory()
431
inv = b.get_revision_inventory(b.lookup_revision(revision))
433
for path, entry in inv.entries():
435
print '%-50s %s' % (path, entry.file_id)
440
class cmd_move(Command):
441
"""Move files to a different directory.
446
The destination must be a versioned directory in the same branch.
448
takes_args = ['source$', 'dest']
449
def run(self, source_list, dest):
452
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
455
class cmd_rename(Command):
456
"""Change the name of an entry.
459
bzr rename frob.c frobber.c
460
bzr rename src/frob.c lib/frob.c
462
It is an error if the destination name exists.
464
See also the 'move' command, which moves files into a different
465
directory without changing their name.
467
TODO: Some way to rename multiple files without invoking bzr for each
469
takes_args = ['from_name', 'to_name']
471
def run(self, from_name, to_name):
473
b.rename_one(b.relpath(from_name), b.relpath(to_name))
479
class cmd_pull(Command):
480
"""Pull any changes from another branch into the current one.
482
If the location is omitted, the last-used location will be used.
483
Both the revision history and the working directory will be
486
This command only works on branches that have not diverged. Branches are
487
considered diverged if both branches have had commits without first
488
pulling from the other.
490
If branches have diverged, you can use 'bzr merge' to pull the text changes
491
from one into the other.
493
takes_args = ['location?']
495
def run(self, location=None):
496
from bzrlib.merge import merge
502
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
504
if errno == errno.ENOENT:
507
location = stored_loc
509
raise BzrCommandError("No pull location known or specified.")
510
from branch import find_branch, DivergedBranches
511
br_from = find_branch(location)
512
location = pull_loc(br_from)
513
old_revno = br_to.revno()
515
br_to.update_revisions(br_from)
516
except DivergedBranches:
517
raise BzrCommandError("These branches have diverged. Try merge.")
519
merge(('.', -1), ('.', old_revno), check_clean=False)
520
if location != stored_loc:
521
br_to.controlfile("x-pull", "wb").write(location + "\n")
525
class cmd_branch(Command):
526
"""Create a new copy of a branch.
528
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
529
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
531
To retrieve the branch as of a particular revision, supply the --revision
532
parameter, as in "branch foo/bar -r 5".
534
takes_args = ['from_location', 'to_location?']
535
takes_options = ['revision']
537
def run(self, from_location, to_location=None, revision=None):
539
from bzrlib.merge import merge
540
from branch import find_branch, DivergedBranches, NoSuchRevision
541
from shutil import rmtree
543
br_from = find_branch(from_location)
545
if e.errno == errno.ENOENT:
546
raise BzrCommandError('Source location "%s" does not exist.' %
551
if to_location is None:
552
to_location = os.path.basename(from_location.rstrip("/\\"))
555
os.mkdir(to_location)
557
if e.errno == errno.EEXIST:
558
raise BzrCommandError('Target directory "%s" already exists.' %
560
if e.errno == errno.ENOENT:
561
raise BzrCommandError('Parent of "%s" does not exist.' %
565
br_to = Branch(to_location, init=True)
568
br_to.update_revisions(br_from, stop_revision=revision)
569
except NoSuchRevision:
571
msg = "The branch %s has no revision %d." % (from_location,
573
raise BzrCommandError(msg)
574
merge((to_location, -1), (to_location, 0), this_dir=to_location,
576
from_location = pull_loc(br_from)
577
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
580
def pull_loc(branch):
581
# TODO: Should perhaps just make attribute be 'base' in
582
# RemoteBranch and Branch?
583
if hasattr(branch, "baseurl"):
584
return branch.baseurl
590
class cmd_renames(Command):
591
"""Show list of renamed files.
593
TODO: Option to show renames between two historical versions.
595
TODO: Only show renames under dir, rather than in the whole branch.
597
takes_args = ['dir?']
599
def run(self, dir='.'):
601
old_inv = b.basis_tree().inventory
602
new_inv = b.read_working_inventory()
604
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
606
for old_name, new_name in renames:
607
print "%s => %s" % (old_name, new_name)
610
class cmd_info(Command):
611
"""Show statistical information about a branch."""
612
takes_args = ['branch?']
614
def run(self, branch=None):
617
from branch import find_branch
618
b = find_branch(branch)
622
class cmd_remove(Command):
623
"""Make a file unversioned.
625
This makes bzr stop tracking changes to a versioned file. It does
626
not delete the working copy.
628
takes_args = ['file+']
629
takes_options = ['verbose']
631
def run(self, file_list, verbose=False):
632
b = Branch(file_list[0])
633
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
636
class cmd_file_id(Command):
637
"""Print file_id of a particular file or directory.
639
The file_id is assigned when the file is first added and remains the
640
same through all revisions where the file exists, even when it is
644
takes_args = ['filename']
645
def run(self, filename):
647
i = b.inventory.path2id(b.relpath(filename))
649
bailout("%r is not a versioned file" % filename)
654
class cmd_file_path(Command):
655
"""Print path of file_ids to a file or directory.
657
This prints one line for each directory down to the target,
658
starting at the branch root."""
660
takes_args = ['filename']
661
def run(self, filename):
664
fid = inv.path2id(b.relpath(filename))
666
bailout("%r is not a versioned file" % filename)
667
for fip in inv.get_idpath(fid):
671
class cmd_revision_history(Command):
672
"""Display list of revision ids on this branch."""
675
for patchid in Branch('.').revision_history():
679
class cmd_directories(Command):
680
"""Display list of versioned directories in this branch."""
682
for name, ie in Branch('.').read_working_inventory().directories():
689
class cmd_init(Command):
690
"""Make a directory into a versioned branch.
692
Use this to create an empty branch, or before importing an
695
Recipe for importing a tree of files:
700
bzr commit -m 'imported project'
703
Branch('.', init=True)
706
class cmd_diff(Command):
707
"""Show differences in working tree.
709
If files are listed, only the changes in those files are listed.
710
Otherwise, all changes for the tree are listed.
712
TODO: Given two revision arguments, show the difference between them.
714
TODO: Allow diff across branches.
716
TODO: Option to use external diff command; could be GNU diff, wdiff,
719
TODO: Python difflib is not exactly the same as unidiff; should
720
either fix it up or prefer to use an external diff.
722
TODO: If a directory is given, diff everything under that.
724
TODO: Selected-file diff is inefficient and doesn't show you
727
TODO: This probably handles non-Unix newlines poorly.
730
takes_args = ['file*']
731
takes_options = ['revision', 'diff-options']
732
aliases = ['di', 'dif']
734
def run(self, revision=None, file_list=None, diff_options=None):
735
from bzrlib.diff import show_diff
736
from bzrlib import find_branch
739
b = find_branch(file_list[0])
740
file_list = [b.relpath(f) for f in file_list]
741
if file_list == ['']:
742
# just pointing to top-of-tree
747
show_diff(b, revision, specific_files=file_list,
748
external_diff_options=diff_options)
754
class cmd_deleted(Command):
755
"""List files deleted in the working tree.
757
TODO: Show files deleted since a previous revision, or between two revisions.
759
def run(self, show_ids=False):
762
new = b.working_tree()
764
## TODO: Much more efficient way to do this: read in new
765
## directories with readdir, rather than stating each one. Same
766
## level of effort but possibly much less IO. (Or possibly not,
767
## if the directories are very large...)
769
for path, ie in old.inventory.iter_entries():
770
if not new.has_id(ie.file_id):
772
print '%-50s %s' % (path, ie.file_id)
777
class cmd_modified(Command):
778
"""List files modified in working tree."""
783
inv = b.read_working_inventory()
784
sc = statcache.update_cache(b, inv)
785
basis = b.basis_tree()
786
basis_inv = basis.inventory
788
# We used to do this through iter_entries(), but that's slow
789
# when most of the files are unmodified, as is usually the
790
# case. So instead we iterate by inventory entry, and only
791
# calculate paths as necessary.
793
for file_id in basis_inv:
794
cacheentry = sc.get(file_id)
795
if not cacheentry: # deleted
797
ie = basis_inv[file_id]
798
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
799
path = inv.id2path(file_id)
804
class cmd_added(Command):
805
"""List files added in working tree."""
809
wt = b.working_tree()
810
basis_inv = b.basis_tree().inventory
813
if file_id in basis_inv:
815
path = inv.id2path(file_id)
816
if not os.access(b.abspath(path), os.F_OK):
822
class cmd_root(Command):
823
"""Show the tree root directory.
825
The root is the nearest enclosing directory with a .bzr control
827
takes_args = ['filename?']
828
def run(self, filename=None):
829
"""Print the branch root."""
830
from branch import find_branch
831
b = find_branch(filename)
832
print getattr(b, 'base', None) or getattr(b, 'baseurl')
835
class cmd_log(Command):
836
"""Show log of this branch.
838
To request a range of logs, you can use the command -r begin:end
839
-r revision requests a specific revision, -r :end or -r begin: are
842
TODO: Make --revision support uuid: and hash: [future tag:] notation.
846
takes_args = ['filename?']
847
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
849
def run(self, filename=None, timezone='original',
854
from bzrlib import show_log, find_branch
857
direction = (forward and 'forward') or 'reverse'
860
b = find_branch(filename)
861
fp = b.relpath(filename)
863
file_id = b.read_working_inventory().path2id(fp)
865
file_id = None # points to branch root
871
revision = [None, None]
872
elif isinstance(revision, int):
873
revision = [revision, revision]
878
assert len(revision) == 2
880
mutter('encoding log as %r' % bzrlib.user_encoding)
882
# use 'replace' so that we don't abort if trying to write out
883
# in e.g. the default C locale.
884
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
887
show_timezone=timezone,
892
start_revision=revision[0],
893
end_revision=revision[1])
897
class cmd_touching_revisions(Command):
898
"""Return revision-ids which affected a particular file.
900
A more user-friendly interface is "bzr log FILE"."""
902
takes_args = ["filename"]
903
def run(self, filename):
905
inv = b.read_working_inventory()
906
file_id = inv.path2id(b.relpath(filename))
907
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
908
print "%6d %s" % (revno, what)
911
class cmd_ls(Command):
912
"""List files in a tree.
914
TODO: Take a revision or remote path and list that tree instead.
917
def run(self, revision=None, verbose=False):
920
tree = b.working_tree()
922
tree = b.revision_tree(b.lookup_revision(revision))
924
for fp, fc, kind, fid in tree.list_files():
926
if kind == 'directory':
933
print '%-8s %s%s' % (fc, fp, kindch)
939
class cmd_unknowns(Command):
940
"""List unknown files."""
942
for f in Branch('.').unknowns():
947
class cmd_ignore(Command):
948
"""Ignore a command or pattern.
950
To remove patterns from the ignore list, edit the .bzrignore file.
952
If the pattern contains a slash, it is compared to the whole path
953
from the branch root. Otherwise, it is comapred to only the last
954
component of the path.
956
Ignore patterns are case-insensitive on case-insensitive systems.
958
Note: wildcards must be quoted from the shell on Unix.
961
bzr ignore ./Makefile
964
takes_args = ['name_pattern']
966
def run(self, name_pattern):
967
from bzrlib.atomicfile import AtomicFile
971
ifn = b.abspath('.bzrignore')
973
if os.path.exists(ifn):
976
igns = f.read().decode('utf-8')
982
# TODO: If the file already uses crlf-style termination, maybe
983
# we should use that for the newly added lines?
985
if igns and igns[-1] != '\n':
987
igns += name_pattern + '\n'
990
f = AtomicFile(ifn, 'wt')
991
f.write(igns.encode('utf-8'))
996
inv = b.working_tree().inventory
997
if inv.path2id('.bzrignore'):
998
mutter('.bzrignore is already versioned')
1000
mutter('need to make new .bzrignore file versioned')
1001
b.add(['.bzrignore'])
1005
class cmd_ignored(Command):
1006
"""List ignored files and the patterns that matched them.
1008
See also: bzr ignore"""
1010
tree = Branch('.').working_tree()
1011
for path, file_class, kind, file_id in tree.list_files():
1012
if file_class != 'I':
1014
## XXX: Slightly inefficient since this was already calculated
1015
pat = tree.is_ignored(path)
1016
print '%-50s %s' % (path, pat)
1019
class cmd_lookup_revision(Command):
1020
"""Lookup the revision-id from a revision-number
1023
bzr lookup-revision 33
1026
takes_args = ['revno']
1028
def run(self, revno):
1032
raise BzrCommandError("not a valid revision-number: %r" % revno)
1034
print Branch('.').lookup_revision(revno)
1037
class cmd_export(Command):
1038
"""Export past revision to destination directory.
1040
If no revision is specified this exports the last committed revision.
1042
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1043
given, exports to a directory (equivalent to --format=dir)."""
1044
# TODO: list known exporters
1045
takes_args = ['dest']
1046
takes_options = ['revision', 'format']
1047
def run(self, dest, revision=None, format='dir'):
1049
if revision == None:
1050
rh = b.revision_history()[-1]
1052
rh = b.lookup_revision(int(revision))
1053
t = b.revision_tree(rh)
1054
t.export(dest, format)
1057
class cmd_cat(Command):
1058
"""Write a file's text from a previous revision."""
1060
takes_options = ['revision']
1061
takes_args = ['filename']
1063
def run(self, filename, revision=None):
1064
if revision == None:
1065
raise BzrCommandError("bzr cat requires a revision number")
1067
b.print_file(b.relpath(filename), int(revision))
1070
class cmd_local_time_offset(Command):
1071
"""Show the offset in seconds from GMT to local time."""
1074
print bzrlib.osutils.local_time_offset()
1078
class cmd_commit(Command):
1079
"""Commit changes into a new revision.
1081
If selected files are specified, only changes to those files are
1082
committed. If a directory is specified then its contents are also
1085
A selected-file commit may fail in some cases where the committed
1086
tree would be invalid, such as trying to commit a file in a
1087
newly-added directory that is not itself committed.
1089
TODO: Run hooks on tree to-be-committed, and after commit.
1091
TODO: Strict commit that fails if there are unknown or deleted files.
1093
takes_args = ['selected*']
1094
takes_options = ['message', 'file', 'verbose']
1095
aliases = ['ci', 'checkin']
1097
def run(self, message=None, file=None, verbose=True, selected_list=None):
1098
from bzrlib.commit import commit
1100
## Warning: shadows builtin file()
1101
if not message and not file:
1102
raise BzrCommandError("please specify a commit message",
1103
["use either --message or --file"])
1104
elif message and file:
1105
raise BzrCommandError("please specify either --message or --file")
1109
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1112
commit(b, message, verbose=verbose, specific_files=selected_list)
1115
class cmd_check(Command):
1116
"""Validate consistency of branch history.
1118
This command checks various invariants about the branch storage to
1119
detect data corruption or bzr bugs.
1121
If given the --update flag, it will update some optional fields
1122
to help ensure data consistency.
1124
takes_args = ['dir?']
1125
takes_options = ['update']
1127
def run(self, dir='.', update=False):
1129
bzrlib.check.check(Branch(dir), update=update)
1133
class cmd_whoami(Command):
1134
"""Show bzr user id."""
1135
takes_options = ['email']
1137
def run(self, email=False):
1139
print bzrlib.osutils.user_email()
1141
print bzrlib.osutils.username()
1144
class cmd_selftest(Command):
1145
"""Run internal test suite"""
1148
from bzrlib.selftest import selftest
1156
class cmd_version(Command):
1157
"""Show version of bzr."""
1162
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1163
# is bzrlib itself in a branch?
1164
bzrrev = bzrlib.get_bzr_revision()
1166
print " (bzr checkout, revision %d {%s})" % bzrrev
1167
print bzrlib.__copyright__
1168
print "http://bazaar-ng.org/"
1170
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1171
print "you may use, modify and redistribute it under the terms of the GNU"
1172
print "General Public License version 2 or later."
1175
class cmd_rocks(Command):
1176
"""Statement of optimism."""
1179
print "it sure does!"
1181
def parse_spec(spec):
1183
>>> parse_spec(None)
1185
>>> parse_spec("./")
1187
>>> parse_spec("../@")
1189
>>> parse_spec("../f/@35")
1195
parsed = spec.split('/@')
1196
assert len(parsed) == 2
1200
parsed[1] = int(parsed[1])
1201
assert parsed[1] >=0
1203
parsed = [spec, None]
1208
class cmd_merge(Command):
1209
"""Perform a three-way merge of trees.
1211
The SPEC parameters are working tree or revision specifiers. Working trees
1212
are specified using standard paths or urls. No component of a directory
1213
path may begin with '@'.
1215
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1217
Revisions are specified using a dirname/@revno pair, where dirname is the
1218
branch directory and revno is the revision within that branch. If no revno
1219
is specified, the latest revision is used.
1221
Revision examples: './@127', 'foo/@', '../@1'
1223
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1224
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1227
merge refuses to run if there are any uncommitted changes, unless
1230
takes_args = ['other_spec', 'base_spec?']
1231
takes_options = ['force']
1233
def run(self, other_spec, base_spec=None, force=False):
1234
from bzrlib.merge import merge
1235
merge(parse_spec(other_spec), parse_spec(base_spec),
1236
check_clean=(not force))
1239
class cmd_revert(Command):
1240
"""Reverse all changes since the last commit.
1242
Only versioned files are affected.
1244
TODO: Store backups of any files that will be reverted, so
1245
that the revert can be undone.
1247
takes_options = ['revision']
1249
def run(self, revision=-1):
1250
from bzrlib.merge import merge
1251
merge(('.', revision), parse_spec('.'),
1256
class cmd_assert_fail(Command):
1257
"""Test reporting of assertion failures"""
1260
assert False, "always fails"
1263
class cmd_help(Command):
1264
"""Show help on a command or other topic.
1266
For a list of all available commands, say 'bzr help commands'."""
1267
takes_args = ['topic?']
1270
def run(self, topic=None):
1275
class cmd_update_stat_cache(Command):
1276
"""Update stat-cache mapping inodes to SHA-1 hashes.
1278
For testing only."""
1283
statcache.update_cache(b.base, b.read_working_inventory())
1287
# list of all available options; the rhs can be either None for an
1288
# option that takes no argument, or a constructor function that checks
1292
'diff-options': str,
1301
'revision': _parse_revision_str,
1319
def parse_args(argv):
705
Return 0 or None if the command was successful, or a non-zero
706
shell error code if not. It's OK for this method to allow
707
an exception to raise up.
709
This method is automatically wrapped by Command.__init__ with a
710
cleanup operation, stored as self._operation. This can be used
711
via self.add_cleanup to perform automatic cleanups at the end of
714
The argument for run are assembled by introspection. So for instance,
715
if your command takes an argument files, you would declare::
717
def run(self, files=None):
720
raise NotImplementedError('no implementation of command %r'
724
"""Return help message for this class."""
725
from inspect import getdoc
726
if self.__doc__ is Command.__doc__:
730
def gettext(self, message):
731
"""Returns the gettext function used to translate this command's help.
733
Commands provided by plugins should override this to use their
736
return i18n.gettext_per_paragraph(message)
739
"""Return the canonical name for this command.
741
The name under which it was actually invoked is available in invoked_as.
743
return _unsquish_command_name(self.__class__.__name__)
745
def plugin_name(self):
746
"""Get the name of the plugin that provides this command.
748
:return: The name of the plugin or None if the command is builtin.
750
mod_parts = self.__module__.split('.')
751
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
757
class CommandHooks(Hooks):
758
"""Hooks related to Command object creation/enumeration."""
761
"""Create the default hooks.
763
These are all empty initially, because by default nothing should get
766
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
767
self.add_hook('extend_command',
768
"Called after creating a command object to allow modifications "
769
"such as adding or removing options, docs etc. Called with the "
770
"new bzrlib.commands.Command object.", (1, 13))
771
self.add_hook('get_command',
772
"Called when creating a single command. Called with "
773
"(cmd_or_None, command_name). get_command should either return "
774
"the cmd_or_None parameter, or a replacement Command object that "
775
"should be used for the command. Note that the Command.hooks "
776
"hooks are core infrastructure. Many users will prefer to use "
777
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
779
self.add_hook('get_missing_command',
780
"Called when creating a single command if no command could be "
781
"found. Called with (command_name). get_missing_command should "
782
"either return None, or a Command object to be used for the "
784
self.add_hook('list_commands',
785
"Called when enumerating commands. Called with a set of "
786
"cmd_name strings for all the commands found so far. This set "
787
" is safe to mutate - e.g. to remove a command. "
788
"list_commands should return the updated set of command names.",
791
Command.hooks = CommandHooks()
794
def parse_args(command, argv, alias_argv=None):
1320
795
"""Parse command line.
1322
797
Arguments and options are parsed at this level before being passed
1323
798
down to specific command handlers. This routine knows, from a
1324
799
lookup table, something about the available options, what optargs
1325
800
they take, and which commands will accept them.
1327
>>> parse_args('--help'.split())
1328
([], {'help': True})
1329
>>> parse_args('--version'.split())
1330
([], {'version': True})
1331
>>> parse_args('status --all'.split())
1332
(['status'], {'all': True})
1333
>>> parse_args('commit --message=biter'.split())
1334
(['commit'], {'message': u'biter'})
1335
>>> parse_args('log -r 500'.split())
1336
(['log'], {'revision': 500})
1337
>>> parse_args('log -r500:600'.split())
1338
(['log'], {'revision': [500, 600]})
1339
>>> parse_args('log -vr500:600'.split())
1340
(['log'], {'verbose': True, 'revision': [500, 600]})
1341
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1342
Traceback (most recent call last):
1344
ValueError: invalid literal for int(): v500
1349
# TODO: Maybe handle '--' to end options?
1354
# option names must not be unicode
1358
mutter(" got option %r" % a)
1360
optname, optarg = a[2:].split('=', 1)
1363
if optname not in OPTIONS:
1364
bailout('unknown long option %r' % a)
1367
if shortopt in SHORT_OPTIONS:
1368
# Multi-character options must have a space to delimit
1370
optname = SHORT_OPTIONS[shortopt]
1372
# Single character short options, can be chained,
1373
# and have their value appended to their name
1375
if shortopt not in SHORT_OPTIONS:
1376
# We didn't find the multi-character name, and we
1377
# didn't find the single char name
1378
bailout('unknown short option %r' % a)
1379
optname = SHORT_OPTIONS[shortopt]
1382
# There are extra things on this option
1383
# see if it is the value, or if it is another
1385
optargfn = OPTIONS[optname]
1386
if optargfn is None:
1387
# This option does not take an argument, so the
1388
# next entry is another short option, pack it back
1390
argv.insert(0, '-' + a[2:])
1392
# This option takes an argument, so pack it
1397
# XXX: Do we ever want to support this, e.g. for -r?
1398
bailout('repeated option %r' % a)
1400
optargfn = OPTIONS[optname]
1404
bailout('option %r needs an argument' % a)
1406
optarg = argv.pop(0)
1407
opts[optname] = optargfn(optarg)
1410
bailout('option %r takes no argument' % optname)
1411
opts[optname] = True
802
# TODO: make it a method of the Command?
803
parser = option.get_optparser(command.options())
804
if alias_argv is not None:
805
args = alias_argv + argv
809
# for python 2.5 and later, optparse raises this exception if a non-ascii
810
# option name is given. See http://bugs.python.org/issue2931
812
options, args = parser.parse_args(args)
813
except UnicodeEncodeError,e:
814
raise errors.BzrCommandError(
815
gettext('Only ASCII permitted in option names'))
817
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
818
v is not option.OptionParser.DEFAULT_VALUE])
1415
819
return args, opts
1420
822
def _match_argform(cmd, takes_args, args):
1434
836
argdict[argname + '_list'] = None
1435
837
elif ap[-1] == '+':
1437
raise BzrCommandError("command %r needs one or more %s"
1438
% (cmd, argname.upper()))
839
raise errors.BzrCommandError(gettext(
840
"command {0!r} needs one or more {1}").format(
841
cmd, argname.upper()))
1440
843
argdict[argname + '_list'] = args[:]
1442
845
elif ap[-1] == '$': # all but one
1443
846
if len(args) < 2:
1444
raise BzrCommandError("command %r needs one or more %s"
1445
% (cmd, argname.upper()))
847
raise errors.BzrCommandError(
848
gettext("command {0!r} needs one or more {1}").format(
849
cmd, argname.upper()))
1446
850
argdict[argname + '_list'] = args[:-1]
1449
853
# just a plain arg
1452
raise BzrCommandError("command %r requires argument %s"
1453
% (cmd, argname.upper()))
856
raise errors.BzrCommandError(
857
gettext("command {0!r} requires argument {1}").format(
858
cmd, argname.upper()))
1455
860
argdict[argname] = args.pop(0)
1458
raise BzrCommandError("extra argument to command %s: %s"
863
raise errors.BzrCommandError( gettext(
864
"extra argument to command {0}: {1}").format(
869
def apply_coveraged(dirname, the_callable, *args, **kwargs):
870
# Cannot use "import trace", as that would import bzrlib.trace instead of
871
# the standard library's trace.
872
trace = __import__('trace')
874
tracer = trace.Trace(count=1, trace=0)
875
sys.settrace(tracer.globaltrace)
876
threading.settrace(tracer.globaltrace)
879
return exception_to_return_code(the_callable, *args, **kwargs)
882
results = tracer.results()
883
results.write_results(show_missing=1, summary=False,
887
def apply_profiled(the_callable, *args, **kwargs):
891
pffileno, pfname = tempfile.mkstemp()
893
prof = hotshot.Profile(pfname)
895
ret = prof.runcall(exception_to_return_code, the_callable, *args,
899
stats = hotshot.stats.load(pfname)
901
stats.sort_stats('cum') # 'time'
902
## XXX: Might like to write to stderr or the trace file instead but
903
## print_stats seems hardcoded to stdout
904
stats.print_stats(20)
911
def exception_to_return_code(the_callable, *args, **kwargs):
912
"""UI level helper for profiling and coverage.
914
This transforms exceptions into a return value of 3. As such its only
915
relevant to the UI layer, and should never be called where catching
916
exceptions may be desirable.
919
return the_callable(*args, **kwargs)
920
except (KeyboardInterrupt, Exception), e:
921
# used to handle AssertionError and KeyboardInterrupt
922
# specially here, but hopefully they're handled ok by the logger now
923
exc_info = sys.exc_info()
924
exitcode = trace.report_exception(exc_info, sys.stderr)
925
if os.environ.get('BZR_PDB'):
926
print '**** entering debugger'
929
if sys.version_info[:2] < (2, 6):
931
# pdb.post_mortem(tb)
932
# but because pdb.post_mortem gives bad results for tracebacks
933
# from inside generators, we do it manually.
934
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
936
# Setup pdb on the traceback
939
p.setup(tb.tb_frame, tb)
940
# Point the debugger at the deepest frame of the stack
941
p.curindex = len(p.stack) - 1
942
p.curframe = p.stack[p.curindex][0]
943
# Start the pdb prompt.
944
p.print_stack_entry(p.stack[p.curindex])
952
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
953
from bzrlib.lsprof import profile
954
ret, stats = profile(exception_to_return_code, the_callable,
961
trace.note(gettext('Profile data written to "%s".'), filename)
965
def get_alias(cmd, config=None):
966
"""Return an expanded alias, or None if no alias exists.
969
Command to be checked for an alias.
971
Used to specify an alternative config to use,
972
which is especially useful for testing.
973
If it is unspecified, the global config will be used.
977
config = bzrlib.config.GlobalConfig()
978
alias = config.get_alias(cmd)
980
return cmdline.split(alias)
984
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1466
985
"""Execute a command.
1468
This is similar to main(), but without all the trappings for
1469
logging and error handling.
987
:param argv: The command-line arguments, without the program name from
988
argv[0] These should already be decoded. All library/test code calling
989
run_bzr should be passing valid strings (don't need decoding).
990
:param load_plugins: What function to call when triggering plugin loading.
991
This function should take no arguments and cause all plugins to be
993
:param disable_plugins: What function to call when disabling plugin
994
loading. This function should take no arguments and cause all plugin
995
loading to be prohibited (so that code paths in your application that
996
know about some plugins possibly being present will fail to import
997
those plugins even if they are installed.)
998
:return: Returns a command exit code or raises an exception.
1000
Special master options: these must come before the command because
1001
they control how the command is interpreted.
1004
Do not load plugin modules at all
1007
Do not allow aliases
1010
Only use builtin commands. (Plugins are still allowed to change
1014
Run under the Python hotshot profiler.
1017
Run under the Python lsprof profiler.
1020
Generate line coverage report in the specified directory.
1023
Specify the number of processes that can be run concurrently (selftest).
1471
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1473
include_plugins=True
1475
args, opts = parse_args(argv[1:])
1483
elif 'version' in opts:
1486
elif args and args[0] == 'builtin':
1487
include_plugins=False
1489
cmd = str(args.pop(0))
1496
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1499
if 'profile' in opts:
1505
# check options are reasonable
1506
allowed = cmd_class.takes_options
1508
if oname not in allowed:
1509
raise BzrCommandError("option '--%s' is not allowed for command %r"
1512
# mix arguments and options into one dictionary
1513
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1515
for k, v in opts.items():
1516
cmdopts[k.replace('-', '_')] = v
1519
import hotshot, tempfile
1520
pffileno, pfname = tempfile.mkstemp()
1522
prof = hotshot.Profile(pfname)
1523
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1526
import hotshot.stats
1527
stats = hotshot.stats.load(pfname)
1529
stats.sort_stats('time')
1530
## XXX: Might like to write to stderr or the trace file instead but
1531
## print_stats seems hardcoded to stdout
1532
stats.print_stats(20)
1540
return cmd_class(cmdopts, cmdargs).status
1543
def _report_exception(summary, quiet=False):
1545
log_error('bzr: ' + summary)
1546
bzrlib.trace.log_exception()
1549
tb = sys.exc_info()[2]
1550
exinfo = traceback.extract_tb(tb)
1552
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1553
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1560
bzrlib.open_tracefile(argv)
1565
return run_bzr(argv)
1567
# do this here inside the exception wrappers to catch EPIPE
1570
quiet = isinstance(e, (BzrCommandError))
1571
_report_exception('error: ' + e.args[0], quiet=quiet)
1574
# some explanation or hints
1577
except AssertionError, e:
1578
msg = 'assertion failed'
1580
msg += ': ' + str(e)
1581
_report_exception(msg)
1583
except KeyboardInterrupt, e:
1584
_report_exception('interrupted', quiet=True)
1586
except Exception, e:
1588
if (isinstance(e, IOError)
1589
and hasattr(e, 'errno')
1590
and e.errno == errno.EPIPE):
1594
msg = str(e).rstrip('\n')
1595
_report_exception(msg, quiet)
1025
trace.mutter("bazaar version: " + bzrlib.__version__)
1026
argv = _specified_or_unicode_argv(argv)
1027
trace.mutter("bzr arguments: %r", argv)
1029
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1030
opt_no_l10n = opt_no_aliases = False
1031
opt_lsprof_file = opt_coverage_dir = None
1033
# --no-plugins is handled specially at a very early stage. We need
1034
# to load plugins before doing other command parsing so that they
1035
# can override commands, but this needs to happen first.
1039
override_config = []
1040
while i < len(argv):
1042
if a == '--profile':
1044
elif a == '--lsprof':
1046
elif a == '--lsprof-file':
1048
opt_lsprof_file = argv[i + 1]
1050
elif a == '--no-plugins':
1051
opt_no_plugins = True
1052
elif a == '--no-aliases':
1053
opt_no_aliases = True
1054
elif a == '--no-l10n':
1056
elif a == '--builtin':
1058
elif a == '--concurrency':
1059
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1061
elif a == '--coverage':
1062
opt_coverage_dir = argv[i + 1]
1064
elif a == '--profile-imports':
1065
pass # already handled in startup script Bug #588277
1066
elif a.startswith('-D'):
1067
debug.debug_flags.add(a[2:])
1068
elif a.startswith('-O'):
1069
override_config.append(a[2:])
1074
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1076
debug.set_debug_flags_from_config()
1078
if not opt_no_plugins:
1085
get_cmd_object('help').run_argv_aliases([])
1088
if argv[0] == '--version':
1089
get_cmd_object('version').run_argv_aliases([])
1094
if not opt_no_aliases:
1095
alias_argv = get_alias(argv[0])
1097
argv[0] = alias_argv.pop(0)
1100
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1103
run = cmd_obj.run_argv_aliases
1104
run_argv = [argv, alias_argv]
1107
# We can be called recursively (tests for example), but we don't want
1108
# the verbosity level to propagate.
1109
saved_verbosity_level = option._verbosity_level
1110
option._verbosity_level = 0
1112
if opt_coverage_dir:
1114
'--coverage ignored, because --lsprof is in use.')
1115
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1117
if opt_coverage_dir:
1119
'--coverage ignored, because --profile is in use.')
1120
ret = apply_profiled(run, *run_argv)
1121
elif opt_coverage_dir:
1122
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1124
ret = run(*run_argv)
1598
bzrlib.trace.close_trace()
1601
if __name__ == '__main__':
1602
sys.exit(main(sys.argv))
1127
# reset, in case we may do other commands later within the same
1128
# process. Commands that want to execute sub-commands must propagate
1129
# --verbose in their own way.
1130
if 'memory' in debug.debug_flags:
1131
trace.debug_memory('Process status after command:', short=False)
1132
option._verbosity_level = saved_verbosity_level
1133
# Reset the overrides
1134
bzrlib.global_state.cmdline_overrides._reset()
1137
def display_command(func):
1138
"""Decorator that suppresses pipe/interrupt errors."""
1139
def ignore_pipe(*args, **kwargs):
1141
result = func(*args, **kwargs)
1145
if getattr(e, 'errno', None) is None:
1147
if e.errno != errno.EPIPE:
1148
# Win32 raises IOError with errno=0 on a broken pipe
1149
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1152
except KeyboardInterrupt:
1157
def install_bzr_command_hooks():
1158
"""Install the hooks to supply bzr's own commands."""
1159
if _list_bzr_commands in Command.hooks["list_commands"]:
1161
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1163
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1165
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1166
"bzr plugin commands")
1167
Command.hooks.install_named_hook("get_command", _get_external_command,
1168
"bzr external command lookup")
1169
Command.hooks.install_named_hook("get_missing_command",
1170
_try_plugin_provider,
1171
"bzr plugin-provider-db check")
1175
def _specified_or_unicode_argv(argv):
1176
# For internal or testing use, argv can be passed. Otherwise, get it from
1177
# the process arguments in a unicode-safe way.
1179
return osutils.get_unicode_argv()
1183
# ensure all arguments are unicode strings
1185
if isinstance(a, unicode):
1188
new_argv.append(a.decode('ascii'))
1189
except UnicodeDecodeError:
1190
raise errors.BzrError("argv should be list of unicode strings.")
1194
def main(argv=None):
1195
"""Main entry point of command-line interface.
1197
Typically `bzrlib.initialize` should be called first.
1199
:param argv: list of unicode command-line arguments similar to sys.argv.
1200
argv[0] is script name usually, it will be ignored.
1201
Don't pass here sys.argv because this list contains plain strings
1202
and not unicode; pass None instead.
1204
:return: exit code of bzr command.
1206
if argv is not None:
1208
_register_builtin_commands()
1209
ret = run_bzr_catch_errors(argv)
1210
trace.mutter("return code %d", ret)
1214
def run_bzr_catch_errors(argv):
1215
"""Run a bzr command with parameters as described by argv.
1217
This function assumed that that UI layer is setup, that symbol deprecations
1218
are already applied, and that unicode decoding has already been performed on argv.
1220
# done here so that they're covered for every test run
1221
install_bzr_command_hooks()
1222
return exception_to_return_code(run_bzr, argv)
1225
def run_bzr_catch_user_errors(argv):
1226
"""Run bzr and report user errors, but let internal errors propagate.
1228
This is used for the test suite, and might be useful for other programs
1229
that want to wrap the commandline interface.
1231
# done here so that they're covered for every test run
1232
install_bzr_command_hooks()
1234
return run_bzr(argv)
1235
except Exception, e:
1236
if (isinstance(e, (OSError, IOError))
1237
or not getattr(e, 'internal_error', True)):
1238
trace.report_exception(sys.exc_info(), sys.stderr)
1244
class HelpCommandIndex(object):
1245
"""A index for bzr help that returns commands."""
1248
self.prefix = 'commands/'
1250
def get_topics(self, topic):
1251
"""Search for topic amongst commands.
1253
:param topic: A topic to search for.
1254
:return: A list which is either empty or contains a single
1257
if topic and topic.startswith(self.prefix):
1258
topic = topic[len(self.prefix):]
1260
cmd = _get_cmd_object(topic, check_missing=False)
1267
class Provider(object):
1268
"""Generic class to be overriden by plugins"""
1270
def plugin_for_command(self, cmd_name):
1271
"""Takes a command and returns the information for that plugin
1273
:return: A dictionary with all the available information
1274
for the requested plugin
1276
raise NotImplementedError
1279
class ProvidersRegistry(registry.Registry):
1280
"""This registry exists to allow other providers to exist"""
1283
for key, provider in self.iteritems():
1286
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
