164
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
165
52
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
191
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
def builtin_command_names():
220
"""Return list of builtin command names.
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
return plugin_cmds.keys()
233
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
237
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
This always returns a list. The list will have one element for
60
It supports integers directly, but everything else it
61
defers for passing to Branch.get_revision_info()
63
>>> _parse_revision_str('234')
65
>>> _parse_revision_str('234..567')
67
>>> _parse_revision_str('..')
69
>>> _parse_revision_str('..234')
71
>>> _parse_revision_str('234..')
73
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
75
>>> _parse_revision_str('234....789') # Error?
77
>>> _parse_revision_str('revid:test@other.com-234234')
78
['revid:test@other.com-234234']
79
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
80
['revid:test@other.com-234234', 'revid:test@other.com-234235']
81
>>> _parse_revision_str('revid:test@other.com-234234..23')
82
['revid:test@other.com-234234', 23]
83
>>> _parse_revision_str('date:2005-04-12')
85
>>> _parse_revision_str('date:2005-04-12 12:24:33')
86
['date:2005-04-12 12:24:33']
87
>>> _parse_revision_str('date:2005-04-12T12:24:33')
88
['date:2005-04-12T12:24:33']
89
>>> _parse_revision_str('date:2005-04-12,12:24:33')
90
['date:2005-04-12,12:24:33']
91
>>> _parse_revision_str('-5..23')
93
>>> _parse_revision_str('-5')
95
>>> _parse_revision_str('123a')
97
>>> _parse_revision_str('abc')
101
old_format_re = re.compile('\d*:\d*')
102
m = old_format_re.match(revstr)
104
warning('Colon separator for revision numbers is deprecated.'
107
for rev in revstr.split(':'):
109
revs.append(int(rev))
114
for x in revstr.split('..'):
126
def _get_cmd_dict(plugins_override=True):
128
for k, v in globals().iteritems():
129
if k.startswith("cmd_"):
130
d[_unsquish_command_name(k)] = v
131
# If we didn't load plugins, the plugin_cmds dict will be empty
133
d.update(plugin_cmds)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
324
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
135
d2 = plugin_cmds.copy()
141
def get_all_cmds(plugins_override=True):
142
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
147
def get_cmd_class(cmd, plugins_override=True):
148
"""Return the canonical name and command class for a command.
150
cmd = str(cmd) # not unicode
152
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
155
return cmd, cmds[cmd]
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
159
# look for any command which claims this as an alias
160
for cmdname, cmdclass in cmds.iteritems():
161
if cmd in cmdclass.aliases:
162
return cmdname, cmdclass
164
cmdclass = ExternalCommand.find_command(cmd)
168
raise BzrCommandError("unknown command %r" % cmd)
342
171
class Command(object):
343
172
"""Base class for commands.
345
Commands are the heart of the command-line bzr interface.
347
The command object mostly handles the mapping of command-line
348
parameters into one or more bzrlib operations, and of the results
351
Commands normally don't have any state. All their arguments are
352
passed in to the run method. (Subclasses may take a different
353
policy if the behaviour of the instance needs to depend on e.g. a
354
shell plugin and not just its Python class.)
356
174
The docstring for an actual command should give a single-line
357
175
summary, then a complete description of the command. A grammar
358
176
description will be inserted.
361
Other accepted names for this command.
364
179
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
183
List of options that may be given for this command.
381
If true, this command isn't advertised. This is typically
382
for commands intended for expert users.
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
399
:cvar hooks: An instance of CommandHooks.
186
If true, this command isn't advertised.
403
191
takes_options = []
404
encoding_type = 'strict'
195
def __init__(self, options, arguments):
196
"""Construct and run the command.
409
"""Construct an instance of this command."""
198
Sets self.status to the return value of run()."""
199
assert isinstance(options, dict)
200
assert isinstance(arguments, dict)
201
cmdargs = options.copy()
202
cmdargs.update(arguments)
410
203
if self.__doc__ == Command.__doc__:
204
from warnings import warn
411
205
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
491
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
493
usage = sections.pop('Usage')
495
usage = self._usage()
497
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
500
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
503
result += ':Usage: %s\n' % usage
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
547
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
550
result += ', '.join(self.aliases) + '\n'
551
plugin_name = self.plugin_name()
552
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
554
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
578
def _get_help_parts(text):
579
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
A section starts with a heading line of the form ":xxx:".
585
Indented text on following lines is the section value.
586
All text found outside a named section is assigned to the
587
default section which is given the key of None.
589
def save_section(sections, order, label, section):
591
if sections.has_key(label):
592
sections[label] += '\n' + section
595
sections[label] = section
597
lines = text.rstrip().splitlines()
598
summary = lines.pop(0)
601
label,section = None,''
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
608
label,section = None,line
611
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
617
def get_help_topic(self):
618
"""Return the commands help topic - its name."""
621
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
624
The list is derived from the content of the _see_also attribute. Any
625
duplicates are removed and the result is in lexical order.
626
:param additional_terms: Additional help topics to cross-reference.
627
:return: A list of help topics.
629
see_also = set(getattr(self, '_see_also', []))
631
see_also.update(additional_terms)
632
return sorted(see_also)
635
"""Return dict of valid options for this command.
637
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
640
for o in self.takes_options:
641
if isinstance(o, basestring):
642
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
def _setup_outf(self):
649
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
653
def run_argv_aliases(self, argv, alias_argv=None):
654
"""Parse the command line and run with extra aliases in alias_argv."""
655
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
674
# mix arguments and options into one dictionary
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
677
for k, v in opts.items():
678
cmdopts[k.replace('-', '_')] = v
680
all_cmd_args = cmdargs.copy()
681
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
206
self.status = self.run(**cmdargs)
207
if self.status is None:
711
"""Actually run the command.
212
"""Override this in sub-classes.
713
214
This is invoked with the options and arguments bound to
714
215
keyword parameters.
716
Return 0 or None if the command was successful, or a non-zero
717
shell error code if not. It's OK for this method to allow
718
an exception to raise up.
720
This method is automatically wrapped by Command.__init__ with a
721
cleanup operation, stored as self._operation. This can be used
722
via self.add_cleanup to perform automatic cleanups at the end of
725
The argument for run are assembled by introspection. So for instance,
726
if your command takes an argument files, you would declare::
728
def run(self, files=None):
217
Return 0 or None if the command was successful, or a shell
731
raise NotImplementedError('no implementation of command %r'
735
"""Return help message for this class."""
223
class ExternalCommand(Command):
224
"""Class to wrap external commands.
226
We cheat a little here, when get_cmd_class() calls us we actually give it back
227
an object we construct that has the appropriate path, help, options etc for the
230
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
231
method, which we override to call the Command.__init__ method. That then calls
232
our run method which is pretty straight forward.
234
The only wrinkle is that we have to map bzr's dictionary of options and arguments
235
back into command line options and arguments for the script.
238
def find_command(cls, cmd):
240
bzrpath = os.environ.get('BZRPATH', '')
242
for dir in bzrpath.split(os.pathsep):
243
path = os.path.join(dir, cmd)
244
if os.path.isfile(path):
245
return ExternalCommand(path)
249
find_command = classmethod(find_command)
251
def __init__(self, path):
254
pipe = os.popen('%s --bzr-usage' % path, 'r')
255
self.takes_options = pipe.readline().split()
257
for opt in self.takes_options:
258
if not opt in OPTIONS:
259
raise BzrError("Unknown option '%s' returned by external command %s"
262
# TODO: Is there any way to check takes_args is valid here?
263
self.takes_args = pipe.readline().split()
265
if pipe.close() is not None:
266
raise BzrError("Failed funning '%s --bzr-usage'" % path)
268
pipe = os.popen('%s --bzr-help' % path, 'r')
269
self.__doc__ = pipe.read()
270
if pipe.close() is not None:
271
raise BzrError("Failed funning '%s --bzr-help'" % path)
273
def __call__(self, options, arguments):
274
Command.__init__(self, options, arguments)
277
def run(self, **kargs):
284
optname = name.replace('_','-')
286
if OPTIONS.has_key(optname):
288
opts.append('--%s' % optname)
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
If a revision is specified, the changes since that revision are shown.
341
takes_args = ['file*']
342
takes_options = ['all', 'show-ids', 'revision']
343
aliases = ['st', 'stat']
345
def run(self, all=False, show_ids=False, file_list=None):
347
b = find_branch(file_list[0])
348
file_list = [b.relpath(x) for x in file_list]
349
# special case: only one path was given and it's the root
351
if file_list == ['']:
356
from bzrlib.status import show_status
357
show_status(b, show_unchanged=all, show_ids=show_ids,
358
specific_files=file_list)
361
class cmd_cat_revision(Command):
362
"""Write out metadata for a revision."""
365
takes_args = ['revision_id']
367
def run(self, revision_id):
368
from bzrlib.xml import pack_xml
369
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
372
class cmd_revno(Command):
373
"""Show current revision number.
375
This is equal to the number of revisions on this branch."""
377
print find_branch('.').revno()
379
class cmd_revision_info(Command):
380
"""Show revision number and revision id for a given revision identifier.
383
takes_args = ['revision_info*']
384
takes_options = ['revision']
385
def run(self, revision=None, revision_info_list=None):
386
from bzrlib.branch import find_branch
389
if revision is not None:
390
revs.extend(revision)
391
if revision_info_list is not None:
392
revs.extend(revision_info_list)
394
raise BzrCommandError('You must supply a revision identifier')
399
print '%4d %s' % b.get_revision_info(rev)
402
class cmd_add(Command):
403
"""Add specified files or directories.
405
In non-recursive mode, all the named items are added, regardless
406
of whether they were previously ignored. A warning is given if
407
any of the named files are already versioned.
409
In recursive mode (the default), files are treated the same way
410
but the behaviour for directories is different. Directories that
411
are already versioned do not give a warning. All directories,
412
whether already versioned or not, are searched for files or
413
subdirectories that are neither versioned or ignored, and these
414
are added. This search proceeds recursively into versioned
415
directories. If no names are given '.' is assumed.
417
Therefore simply saying 'bzr add' will version all files that
418
are currently unknown.
420
TODO: Perhaps adding a file whose directly is not versioned should
421
recursively add that parent, rather than giving an error?
423
takes_args = ['file*']
424
takes_options = ['verbose', 'no-recurse']
426
def run(self, file_list, verbose=False, no_recurse=False):
427
from bzrlib.add import smart_add
428
smart_add(file_list, verbose, not no_recurse)
432
class cmd_mkdir(Command):
433
"""Create a new versioned directory.
435
This is equivalent to creating the directory and then adding it.
437
takes_args = ['dir+']
439
def run(self, dir_list):
446
b.add([d], verbose=True)
449
class cmd_relpath(Command):
450
"""Show path of a file relative to root"""
451
takes_args = ['filename']
454
def run(self, filename):
455
print find_branch(filename).relpath(filename)
459
class cmd_inventory(Command):
460
"""Show inventory of the current working copy or a revision."""
461
takes_options = ['revision', 'show-ids']
463
def run(self, revision=None, show_ids=False):
466
inv = b.read_working_inventory()
468
if len(revision) > 1:
469
raise BzrCommandError('bzr inventory --revision takes'
470
' exactly one revision identifier')
471
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
473
for path, entry in inv.entries():
475
print '%-50s %s' % (path, entry.file_id)
480
class cmd_move(Command):
481
"""Move files to a different directory.
486
The destination must be a versioned directory in the same branch.
488
takes_args = ['source$', 'dest']
489
def run(self, source_list, dest):
492
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
495
class cmd_rename(Command):
496
"""Change the name of an entry.
499
bzr rename frob.c frobber.c
500
bzr rename src/frob.c lib/frob.c
502
It is an error if the destination name exists.
504
See also the 'move' command, which moves files into a different
505
directory without changing their name.
507
TODO: Some way to rename multiple files without invoking bzr for each
509
takes_args = ['from_name', 'to_name']
511
def run(self, from_name, to_name):
513
b.rename_one(b.relpath(from_name), b.relpath(to_name))
519
class cmd_pull(Command):
520
"""Pull any changes from another branch into the current one.
522
If the location is omitted, the last-used location will be used.
523
Both the revision history and the working directory will be
526
This command only works on branches that have not diverged. Branches are
527
considered diverged if both branches have had commits without first
528
pulling from the other.
530
If branches have diverged, you can use 'bzr merge' to pull the text changes
531
from one into the other.
533
takes_args = ['location?']
535
def run(self, location=None):
536
from bzrlib.merge import merge
538
from shutil import rmtree
541
br_to = find_branch('.')
544
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
546
if e.errno != errno.ENOENT:
549
if stored_loc is None:
550
raise BzrCommandError("No pull location known or specified.")
552
print "Using last location: %s" % stored_loc
553
location = stored_loc
554
cache_root = tempfile.mkdtemp()
555
from bzrlib.branch import DivergedBranches
556
br_from = find_branch(location)
557
location = pull_loc(br_from)
558
old_revno = br_to.revno()
560
from branch import find_cached_branch, DivergedBranches
561
br_from = find_cached_branch(location, cache_root)
562
location = pull_loc(br_from)
563
old_revno = br_to.revno()
565
br_to.update_revisions(br_from)
566
except DivergedBranches:
567
raise BzrCommandError("These branches have diverged."
570
merge(('.', -1), ('.', old_revno), check_clean=False)
571
if location != stored_loc:
572
br_to.controlfile("x-pull", "wb").write(location + "\n")
578
class cmd_branch(Command):
579
"""Create a new copy of a branch.
581
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
582
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
584
To retrieve the branch as of a particular revision, supply the --revision
585
parameter, as in "branch foo/bar -r 5".
587
takes_args = ['from_location', 'to_location?']
588
takes_options = ['revision']
590
def run(self, from_location, to_location=None, revision=None):
592
from bzrlib.merge import merge
593
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
594
find_cached_branch, Branch
595
from shutil import rmtree
596
from meta_store import CachedStore
598
cache_root = tempfile.mkdtemp()
602
elif len(revision) > 1:
603
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
607
br_from = find_cached_branch(from_location, cache_root)
609
if e.errno == errno.ENOENT:
610
raise BzrCommandError('Source location "%s" does not'
611
' exist.' % to_location)
615
if to_location is None:
616
to_location = os.path.basename(from_location.rstrip("/\\"))
619
os.mkdir(to_location)
621
if e.errno == errno.EEXIST:
622
raise BzrCommandError('Target directory "%s" already'
623
' exists.' % to_location)
624
if e.errno == errno.ENOENT:
625
raise BzrCommandError('Parent of "%s" does not exist.' %
629
br_to = Branch(to_location, init=True)
631
br_to.set_root_id(br_from.get_root_id())
634
if revision[0] is None:
635
revno = br_from.revno()
637
revno, rev_id = br_from.get_revision_info(revision[0])
639
br_to.update_revisions(br_from, stop_revision=revno)
640
except NoSuchRevision:
642
msg = "The branch %s has no revision %d." % (from_location,
644
raise BzrCommandError(msg)
646
merge((to_location, -1), (to_location, 0), this_dir=to_location,
647
check_clean=False, ignore_zero=True)
648
from_location = pull_loc(br_from)
649
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
654
def pull_loc(branch):
655
# TODO: Should perhaps just make attribute be 'base' in
656
# RemoteBranch and Branch?
657
if hasattr(branch, "baseurl"):
658
return branch.baseurl
664
class cmd_renames(Command):
665
"""Show list of renamed files.
667
TODO: Option to show renames between two historical versions.
669
TODO: Only show renames under dir, rather than in the whole branch.
671
takes_args = ['dir?']
673
def run(self, dir='.'):
675
old_inv = b.basis_tree().inventory
676
new_inv = b.read_working_inventory()
678
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
680
for old_name, new_name in renames:
681
print "%s => %s" % (old_name, new_name)
684
class cmd_info(Command):
685
"""Show statistical information about a branch."""
686
takes_args = ['branch?']
688
def run(self, branch=None):
691
b = find_branch(branch)
695
class cmd_remove(Command):
696
"""Make a file unversioned.
698
This makes bzr stop tracking changes to a versioned file. It does
699
not delete the working copy.
701
takes_args = ['file+']
702
takes_options = ['verbose']
704
def run(self, file_list, verbose=False):
705
b = find_branch(file_list[0])
706
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
709
class cmd_file_id(Command):
710
"""Print file_id of a particular file or directory.
712
The file_id is assigned when the file is first added and remains the
713
same through all revisions where the file exists, even when it is
717
takes_args = ['filename']
718
def run(self, filename):
719
b = find_branch(filename)
720
i = b.inventory.path2id(b.relpath(filename))
722
raise BzrError("%r is not a versioned file" % filename)
727
class cmd_file_path(Command):
728
"""Print path of file_ids to a file or directory.
730
This prints one line for each directory down to the target,
731
starting at the branch root."""
733
takes_args = ['filename']
734
def run(self, filename):
735
b = find_branch(filename)
737
fid = inv.path2id(b.relpath(filename))
739
raise BzrError("%r is not a versioned file" % filename)
740
for fip in inv.get_idpath(fid):
744
class cmd_revision_history(Command):
745
"""Display list of revision ids on this branch."""
748
for patchid in find_branch('.').revision_history():
752
class cmd_directories(Command):
753
"""Display list of versioned directories in this branch."""
755
for name, ie in find_branch('.').read_working_inventory().directories():
762
class cmd_init(Command):
763
"""Make a directory into a versioned branch.
765
Use this to create an empty branch, or before importing an
768
Recipe for importing a tree of files:
773
bzr commit -m 'imported project'
776
from bzrlib.branch import Branch
777
Branch('.', init=True)
780
class cmd_diff(Command):
781
"""Show differences in working tree.
783
If files are listed, only the changes in those files are listed.
784
Otherwise, all changes for the tree are listed.
786
TODO: Given two revision arguments, show the difference between them.
788
TODO: Allow diff across branches.
790
TODO: Option to use external diff command; could be GNU diff, wdiff,
793
TODO: Python difflib is not exactly the same as unidiff; should
794
either fix it up or prefer to use an external diff.
796
TODO: If a directory is given, diff everything under that.
798
TODO: Selected-file diff is inefficient and doesn't show you
801
TODO: This probably handles non-Unix newlines poorly.
804
takes_args = ['file*']
805
takes_options = ['revision', 'diff-options']
806
aliases = ['di', 'dif']
808
def run(self, revision=None, file_list=None, diff_options=None):
809
from bzrlib.diff import show_diff
812
b = find_branch(file_list[0])
813
file_list = [b.relpath(f) for f in file_list]
814
if file_list == ['']:
815
# just pointing to top-of-tree
820
# TODO: Make show_diff support taking 2 arguments
822
if revision is not None:
823
if len(revision) != 1:
824
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
825
base_rev = revision[0]
827
show_diff(b, base_rev, specific_files=file_list,
828
external_diff_options=diff_options)
834
class cmd_deleted(Command):
835
"""List files deleted in the working tree.
837
TODO: Show files deleted since a previous revision, or between two revisions.
839
def run(self, show_ids=False):
842
new = b.working_tree()
844
## TODO: Much more efficient way to do this: read in new
845
## directories with readdir, rather than stating each one. Same
846
## level of effort but possibly much less IO. (Or possibly not,
847
## if the directories are very large...)
849
for path, ie in old.inventory.iter_entries():
850
if not new.has_id(ie.file_id):
852
print '%-50s %s' % (path, ie.file_id)
857
class cmd_modified(Command):
858
"""List files modified in working tree."""
861
from bzrlib.diff import compare_trees
864
td = compare_trees(b.basis_tree(), b.working_tree())
866
for path, id, kind in td.modified:
871
class cmd_added(Command):
872
"""List files added in working tree."""
876
wt = b.working_tree()
877
basis_inv = b.basis_tree().inventory
880
if file_id in basis_inv:
882
path = inv.id2path(file_id)
883
if not os.access(b.abspath(path), os.F_OK):
889
class cmd_root(Command):
890
"""Show the tree root directory.
892
The root is the nearest enclosing directory with a .bzr control
894
takes_args = ['filename?']
895
def run(self, filename=None):
896
"""Print the branch root."""
897
b = find_branch(filename)
898
print getattr(b, 'base', None) or getattr(b, 'baseurl')
901
class cmd_log(Command):
902
"""Show log of this branch.
904
To request a range of logs, you can use the command -r begin:end
905
-r revision requests a specific revision, -r :end or -r begin: are
908
--message allows you to give a regular expression, which will be evaluated
909
so that only matching entries will be displayed.
911
TODO: Make --revision support uuid: and hash: [future tag:] notation.
915
takes_args = ['filename?']
916
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
918
def run(self, filename=None, timezone='original',
925
from bzrlib.branch import find_branch
926
from bzrlib.log import log_formatter, show_log
929
direction = (forward and 'forward') or 'reverse'
932
b = find_branch(filename)
933
fp = b.relpath(filename)
935
file_id = b.read_working_inventory().path2id(fp)
937
file_id = None # points to branch root
945
elif len(revision) == 1:
946
rev1 = rev2 = b.get_revision_info(revision[0])[0]
947
elif len(revision) == 2:
948
rev1 = b.get_revision_info(revision[0])[0]
949
rev2 = b.get_revision_info(revision[1])[0]
951
raise BzrCommandError('bzr log --revision takes one or two values.')
958
mutter('encoding log as %r' % bzrlib.user_encoding)
960
# use 'replace' so that we don't abort if trying to write out
961
# in e.g. the default C locale.
962
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
968
lf = log_formatter(log_format,
971
show_timezone=timezone)
984
class cmd_touching_revisions(Command):
985
"""Return revision-ids which affected a particular file.
987
A more user-friendly interface is "bzr log FILE"."""
989
takes_args = ["filename"]
990
def run(self, filename):
991
b = find_branch(filename)
992
inv = b.read_working_inventory()
993
file_id = inv.path2id(b.relpath(filename))
994
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
995
print "%6d %s" % (revno, what)
998
class cmd_ls(Command):
999
"""List files in a tree.
1001
TODO: Take a revision or remote path and list that tree instead.
1004
def run(self, revision=None, verbose=False):
1005
b = find_branch('.')
1006
if revision == None:
1007
tree = b.working_tree()
1009
tree = b.revision_tree(b.lookup_revision(revision))
1011
for fp, fc, kind, fid in tree.list_files():
1013
if kind == 'directory':
1015
elif kind == 'file':
1020
print '%-8s %s%s' % (fc, fp, kindch)
1026
class cmd_unknowns(Command):
1027
"""List unknown files."""
1029
from bzrlib.osutils import quotefn
1030
for f in find_branch('.').unknowns():
1035
class cmd_ignore(Command):
1036
"""Ignore a command or pattern.
1038
To remove patterns from the ignore list, edit the .bzrignore file.
1040
If the pattern contains a slash, it is compared to the whole path
1041
from the branch root. Otherwise, it is comapred to only the last
1042
component of the path.
1044
Ignore patterns are case-insensitive on case-insensitive systems.
1046
Note: wildcards must be quoted from the shell on Unix.
1049
bzr ignore ./Makefile
1050
bzr ignore '*.class'
1052
takes_args = ['name_pattern']
1054
def run(self, name_pattern):
1055
from bzrlib.atomicfile import AtomicFile
1058
b = find_branch('.')
1059
ifn = b.abspath('.bzrignore')
1061
if os.path.exists(ifn):
1064
igns = f.read().decode('utf-8')
1070
# TODO: If the file already uses crlf-style termination, maybe
1071
# we should use that for the newly added lines?
1073
if igns and igns[-1] != '\n':
1075
igns += name_pattern + '\n'
1078
f = AtomicFile(ifn, 'wt')
1079
f.write(igns.encode('utf-8'))
1084
inv = b.working_tree().inventory
1085
if inv.path2id('.bzrignore'):
1086
mutter('.bzrignore is already versioned')
1088
mutter('need to make new .bzrignore file versioned')
1089
b.add(['.bzrignore'])
1093
class cmd_ignored(Command):
1094
"""List ignored files and the patterns that matched them.
1096
See also: bzr ignore"""
1098
tree = find_branch('.').working_tree()
1099
for path, file_class, kind, file_id in tree.list_files():
1100
if file_class != 'I':
1102
## XXX: Slightly inefficient since this was already calculated
1103
pat = tree.is_ignored(path)
1104
print '%-50s %s' % (path, pat)
1107
class cmd_lookup_revision(Command):
1108
"""Lookup the revision-id from a revision-number
1111
bzr lookup-revision 33
1114
takes_args = ['revno']
1116
def run(self, revno):
1120
raise BzrCommandError("not a valid revision-number: %r" % revno)
1122
print find_branch('.').lookup_revision(revno)
1125
class cmd_export(Command):
1126
"""Export past revision to destination directory.
1128
If no revision is specified this exports the last committed revision.
1130
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1131
given, try to find the format with the extension. If no extension
1132
is found exports to a directory (equivalent to --format=dir).
1134
Root may be the top directory for tar, tgz and tbz2 formats. If none
1135
is given, the top directory will be the root name of the file."""
1136
# TODO: list known exporters
1137
takes_args = ['dest']
1138
takes_options = ['revision', 'format', 'root']
1139
def run(self, dest, revision=None, format=None, root=None):
1141
b = find_branch('.')
1142
if revision is None:
1143
rev_id = b.last_patch()
1145
if len(revision) != 1:
1146
raise BzrError('bzr export --revision takes exactly 1 argument')
1147
revno, rev_id = b.get_revision_info(revision[0])
1148
t = b.revision_tree(rev_id)
1149
root, ext = os.path.splitext(dest)
1151
if ext in (".tar",):
1153
elif ext in (".gz", ".tgz"):
1155
elif ext in (".bz2", ".tbz2"):
1159
t.export(dest, format, root)
1162
class cmd_cat(Command):
1163
"""Write a file's text from a previous revision."""
1165
takes_options = ['revision']
1166
takes_args = ['filename']
1168
def run(self, filename, revision=None):
1169
if revision == None:
1170
raise BzrCommandError("bzr cat requires a revision number")
1171
elif len(revision) != 1:
1172
raise BzrCommandError("bzr cat --revision takes exactly one number")
1173
b = find_branch('.')
1174
b.print_file(b.relpath(filename), revision[0])
1177
class cmd_local_time_offset(Command):
1178
"""Show the offset in seconds from GMT to local time."""
1181
print bzrlib.osutils.local_time_offset()
1185
class cmd_commit(Command):
1186
"""Commit changes into a new revision.
1188
If selected files are specified, only changes to those files are
1189
committed. If a directory is specified then its contents are also
1192
A selected-file commit may fail in some cases where the committed
1193
tree would be invalid, such as trying to commit a file in a
1194
newly-added directory that is not itself committed.
1196
TODO: Run hooks on tree to-be-committed, and after commit.
1198
TODO: Strict commit that fails if there are unknown or deleted files.
1200
takes_args = ['selected*']
1201
takes_options = ['message', 'file', 'verbose', 'unchanged']
1202
aliases = ['ci', 'checkin']
1204
def run(self, message=None, file=None, verbose=True, selected_list=None,
1206
from bzrlib.errors import PointlessCommit
1207
from bzrlib.osutils import get_text_message
1209
## Warning: shadows builtin file()
1210
if not message and not file:
1213
catcher = cStringIO.StringIO()
1214
sys.stdout = catcher
1215
cmd_status({"file_list":selected_list}, {})
1216
info = catcher.getvalue()
1218
message = get_text_message(info)
1221
raise BzrCommandError("please specify a commit message",
1222
["use either --message or --file"])
1223
elif message and file:
1224
raise BzrCommandError("please specify either --message or --file")
1228
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1230
b = find_branch('.')
1233
b.commit(message, verbose=verbose,
1234
specific_files=selected_list,
1235
allow_pointless=unchanged)
1236
except PointlessCommit:
1237
# FIXME: This should really happen before the file is read in;
1238
# perhaps prepare the commit; get the message; then actually commit
1239
raise BzrCommandError("no changes to commit",
1240
["use --unchanged to commit anyhow"])
1243
class cmd_check(Command):
1244
"""Validate consistency of branch history.
1246
This command checks various invariants about the branch storage to
1247
detect data corruption or bzr bugs.
1249
If given the --update flag, it will update some optional fields
1250
to help ensure data consistency.
1252
takes_args = ['dir?']
1254
def run(self, dir='.'):
1255
from bzrlib.check import check
1256
check(find_branch(dir))
1260
class cmd_scan_cache(Command):
1263
from bzrlib.hashcache import HashCache
1270
print '%6d stats' % c.stat_count
1271
print '%6d in hashcache' % len(c._cache)
1272
print '%6d files removed from cache' % c.removed_count
1273
print '%6d hashes updated' % c.update_count
1274
print '%6d files changed too recently to cache' % c.danger_count
1281
class cmd_upgrade(Command):
1282
"""Upgrade branch storage to current format.
1284
This should normally be used only after the check command tells
1287
takes_args = ['dir?']
1289
def run(self, dir='.'):
1290
from bzrlib.upgrade import upgrade
1291
upgrade(find_branch(dir))
1295
class cmd_whoami(Command):
1296
"""Show bzr user id."""
1297
takes_options = ['email']
1299
def run(self, email=False):
1301
print bzrlib.osutils.user_email()
1303
print bzrlib.osutils.username()
1306
class cmd_selftest(Command):
1307
"""Run internal test suite"""
1309
takes_options = ['verbose']
1310
def run(self, verbose=False):
1311
from bzrlib.selftest import selftest
1312
return int(not selftest(verbose=verbose))
1315
class cmd_version(Command):
1316
"""Show version of bzr."""
1321
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1322
# is bzrlib itself in a branch?
1323
bzrrev = bzrlib.get_bzr_revision()
1325
print " (bzr checkout, revision %d {%s})" % bzrrev
1326
print bzrlib.__copyright__
1327
print "http://bazaar-ng.org/"
1329
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1330
print "you may use, modify and redistribute it under the terms of the GNU"
1331
print "General Public License version 2 or later."
1334
class cmd_rocks(Command):
1335
"""Statement of optimism."""
1338
print "it sure does!"
1340
def parse_spec(spec):
1342
>>> parse_spec(None)
1344
>>> parse_spec("./")
1346
>>> parse_spec("../@")
1348
>>> parse_spec("../f/@35")
1350
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1351
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1356
parsed = spec.split('/@')
1357
assert len(parsed) == 2
1362
parsed[1] = int(parsed[1])
1364
pass # We can allow stuff like ./@revid:blahblahblah
1366
assert parsed[1] >=0
1368
parsed = [spec, None]
1373
class cmd_merge(Command):
1374
"""Perform a three-way merge of trees.
1376
The SPEC parameters are working tree or revision specifiers. Working trees
1377
are specified using standard paths or urls. No component of a directory
1378
path may begin with '@'.
1380
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1382
Revisions are specified using a dirname/@revno pair, where dirname is the
1383
branch directory and revno is the revision within that branch. If no revno
1384
is specified, the latest revision is used.
1386
Revision examples: './@127', 'foo/@', '../@1'
1388
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1389
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1392
merge refuses to run if there are any uncommitted changes, unless
1395
takes_args = ['other_spec', 'base_spec?']
1396
takes_options = ['force']
1398
def run(self, other_spec, base_spec=None, force=False):
1399
from bzrlib.merge import merge
1400
merge(parse_spec(other_spec), parse_spec(base_spec),
1401
check_clean=(not force))
1405
class cmd_revert(Command):
1406
"""Restore selected files from a previous revision.
1408
takes_args = ['file+']
1409
def run(self, file_list):
1410
from bzrlib.branch import find_branch
1415
b = find_branch(file_list[0])
1417
b.revert([b.relpath(f) for f in file_list])
1420
class cmd_merge_revert(Command):
1421
"""Reverse all changes since the last commit.
1423
Only versioned files are affected.
1425
TODO: Store backups of any files that will be reverted, so
1426
that the revert can be undone.
1428
takes_options = ['revision']
1430
def run(self, revision=None):
1431
from bzrlib.merge import merge
1432
if revision is None:
1434
elif len(revision) != 1:
1435
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1436
merge(('.', revision[0]), parse_spec('.'),
1441
class cmd_assert_fail(Command):
1442
"""Test reporting of assertion failures"""
1445
assert False, "always fails"
1448
class cmd_help(Command):
1449
"""Show help on a command or other topic.
1451
For a list of all available commands, say 'bzr help commands'."""
1452
takes_args = ['topic?']
1455
def run(self, topic=None):
1462
class cmd_plugins(Command):
1466
import bzrlib.plugin
736
1467
from inspect import getdoc
737
if self.__doc__ is Command.__doc__:
742
return _unsquish_command_name(self.__class__.__name__)
744
def plugin_name(self):
745
"""Get the name of the plugin that provides this command.
747
:return: The name of the plugin or None if the command is builtin.
749
mod_parts = self.__module__.split('.')
750
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
793
def parse_args(command, argv, alias_argv=None):
1468
from pprint import pprint
1469
for plugin in bzrlib.plugin.all_plugins:
1470
print plugin.__path__[0]
1473
print '\t', d.split('\n')[0]
1475
#pprint(bzrlib.plugin.all_plugins)
1479
# list of all available options; the rhs can be either None for an
1480
# option that takes no argument, or a constructor function that checks
1484
'diff-options': str,
1493
'revision': _parse_revision_str,
1515
def parse_args(argv):
794
1516
"""Parse command line.
796
1518
Arguments and options are parsed at this level before being passed
797
1519
down to specific command handlers. This routine knows, from a
798
1520
lookup table, something about the available options, what optargs
799
1521
they take, and which commands will accept them.
1523
>>> parse_args('--help'.split())
1524
([], {'help': True})
1525
>>> parse_args('--version'.split())
1526
([], {'version': True})
1527
>>> parse_args('status --all'.split())
1528
(['status'], {'all': True})
1529
>>> parse_args('commit --message=biter'.split())
1530
(['commit'], {'message': u'biter'})
1531
>>> parse_args('log -r 500'.split())
1532
(['log'], {'revision': [500]})
1533
>>> parse_args('log -r500..600'.split())
1534
(['log'], {'revision': [500, 600]})
1535
>>> parse_args('log -vr500..600'.split())
1536
(['log'], {'verbose': True, 'revision': [500, 600]})
1537
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1538
(['log'], {'revision': ['v500', 600]})
801
# TODO: make it a method of the Command?
802
parser = option.get_optparser(command.options())
803
if alias_argv is not None:
804
args = alias_argv + argv
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
1543
# TODO: Maybe handle '--' to end options?
1548
# option names must not be unicode
1552
mutter(" got option %r" % a)
1554
optname, optarg = a[2:].split('=', 1)
1557
if optname not in OPTIONS:
1558
raise BzrError('unknown long option %r' % a)
1561
if shortopt in SHORT_OPTIONS:
1562
# Multi-character options must have a space to delimit
1564
optname = SHORT_OPTIONS[shortopt]
1566
# Single character short options, can be chained,
1567
# and have their value appended to their name
1569
if shortopt not in SHORT_OPTIONS:
1570
# We didn't find the multi-character name, and we
1571
# didn't find the single char name
1572
raise BzrError('unknown short option %r' % a)
1573
optname = SHORT_OPTIONS[shortopt]
1576
# There are extra things on this option
1577
# see if it is the value, or if it is another
1579
optargfn = OPTIONS[optname]
1580
if optargfn is None:
1581
# This option does not take an argument, so the
1582
# next entry is another short option, pack it back
1584
argv.insert(0, '-' + a[2:])
1586
# This option takes an argument, so pack it
1591
# XXX: Do we ever want to support this, e.g. for -r?
1592
raise BzrError('repeated option %r' % a)
1594
optargfn = OPTIONS[optname]
1598
raise BzrError('option %r needs an argument' % a)
1600
optarg = argv.pop(0)
1601
opts[optname] = optargfn(optarg)
1604
raise BzrError('option %r takes no argument' % optname)
1605
opts[optname] = True
811
1609
return args, opts
814
1614
def _match_argform(cmd, takes_args, args):
828
1628
argdict[argname + '_list'] = None
829
1629
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
1631
raise BzrCommandError("command %r needs one or more %s"
1632
% (cmd, argname.upper()))
834
1634
argdict[argname + '_list'] = args[:]
836
1636
elif ap[-1] == '$': # all but one
837
1637
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
1638
raise BzrCommandError("command %r needs one or more %s"
1639
% (cmd, argname.upper()))
840
1640
argdict[argname + '_list'] = args[:-1]
843
1643
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
1646
raise BzrCommandError("command %r requires argument %s"
1647
% (cmd, argname.upper()))
849
1649
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
1652
raise BzrCommandError("extra argument to command %s: %s"
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
859
# the standard library's trace.
860
trace = __import__('trace')
862
tracer = trace.Trace(count=1, trace=0)
863
sys.settrace(tracer.globaltrace)
864
threading.settrace(tracer.globaltrace)
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
875
def apply_profiled(the_callable, *args, **kwargs):
879
pffileno, pfname = tempfile.mkstemp()
881
prof = hotshot.Profile(pfname)
883
ret = prof.runcall(exception_to_return_code, the_callable, *args,
887
stats = hotshot.stats.load(pfname)
889
stats.sort_stats('cum') # 'time'
890
## XXX: Might like to write to stderr or the trace file instead but
891
## print_stats seems hardcoded to stdout
892
stats.print_stats(20)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
948
trace.note('Profile data written to "%s".', filename)
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
957
def get_alias(cmd, config=None):
958
"""Return an expanded alias, or None if no alias exists.
961
Command to be checked for an alias.
963
Used to specify an alternative config to use,
964
which is especially useful for testing.
965
If it is unspecified, the global config will be used.
969
config = bzrlib.config.GlobalConfig()
970
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1658
def _parse_master_args(argv):
1659
"""Parse the arguments that always go with the original command.
1660
These are things like bzr --no-plugins, etc.
1662
There are now 2 types of option flags. Ones that come *before* the command,
1663
and ones that come *after* the command.
1664
Ones coming *before* the command are applied against all possible commands.
1665
And are generally applied before plugins are loaded.
1667
The current list are:
1668
--builtin Allow plugins to load, but don't let them override builtin commands,
1669
they will still be allowed if they do not override a builtin.
1670
--no-plugins Don't load any plugins. This lets you get back to official source
1672
--profile Enable the hotspot profile before running the command.
1673
For backwards compatibility, this is also a non-master option.
1674
--version Spit out the version of bzr that is running and exit.
1675
This is also a non-master option.
1676
--help Run help and exit, also a non-master option (I think that should stay, though)
1678
>>> argv, opts = _parse_master_args(['--test'])
1679
Traceback (most recent call last):
1681
BzrCommandError: Invalid master option: 'test'
1682
>>> argv, opts = _parse_master_args(['--version', 'command'])
1685
>>> print opts['version']
1687
>>> argv, opts = _parse_master_args(['--profile', 'command', '--more-options'])
1689
['command', '--more-options']
1690
>>> print opts['profile']
1692
>>> argv, opts = _parse_master_args(['--no-plugins', 'command'])
1695
>>> print opts['no-plugins']
1697
>>> print opts['profile']
1699
>>> argv, opts = _parse_master_args(['command', '--profile'])
1701
['command', '--profile']
1702
>>> print opts['profile']
1705
master_opts = {'builtin':False,
1713
if arg[:2] != '--': # at the first non-option, we return the rest
1715
arg = arg[2:] # Remove '--'
1716
if arg not in master_opts:
1717
# We could say that this is not an error, that we should
1718
# just let it be handled by the main section instead
1719
raise BzrCommandError('Invalid master option: %r' % arg)
1720
argv.pop(0) # We are consuming this entry
1721
master_opts[arg] = True
1722
return argv, master_opts
977
1727
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
992
Special master options: these must come before the command because
993
they control how the command is interpreted.
996
Do not load plugin modules at all
1002
Only use builtin commands. (Plugins are still allowed to change
1006
Run under the Python hotshot profiler.
1009
Run under the Python lsprof profiler.
1012
Generate line coverage report in the specified directory.
1015
Specify the number of processes that can be run concurrently (selftest).
1729
This is similar to main(), but without all the trappings for
1730
logging and error handling.
1733
The command-line arguments, without the program name.
1735
Returns a command status or raises an exception.
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof_file = opt_coverage_dir = None
1025
# --no-plugins is handled specially at a very early stage. We need
1026
# to load plugins before doing other command parsing so that they
1027
# can override commands, but this needs to happen first.
1031
while i < len(argv):
1033
if a == '--profile':
1035
elif a == '--lsprof':
1037
elif a == '--lsprof-file':
1039
opt_lsprof_file = argv[i + 1]
1041
elif a == '--no-plugins':
1042
opt_no_plugins = True
1043
elif a == '--no-aliases':
1044
opt_no_aliases = True
1045
elif a == '--builtin':
1047
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1050
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
1053
elif a.startswith('-D'):
1054
debug.debug_flags.add(a[2:])
1059
debug.set_debug_flags_from_config()
1061
if not opt_no_plugins:
1737
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1739
# some options like --builtin and --no-plugins have special effects
1740
argv, master_opts = _parse_master_args(argv)
1741
if not master_opts['no-plugins']:
1742
from bzrlib.plugin import load_plugins
1745
args, opts = parse_args(argv)
1747
if master_opts.get('help') or 'help' in opts:
1748
from bzrlib.help import help
1755
if 'version' in opts:
1759
if args and args[0] == 'builtin':
1760
include_plugins=False
1764
cmd = str(args.pop(0))
1766
print >>sys.stderr, "please try 'bzr help' for help"
1769
plugins_override = not (master_opts['builtin'])
1770
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1772
profile = master_opts['profile']
1773
# For backwards compatibility, I would rather stick with --profile being a
1774
# master/global option
1775
if 'profile' in opts:
1779
# check options are reasonable
1780
allowed = cmd_class.takes_options
1782
if oname not in allowed:
1783
raise BzrCommandError("option '--%s' is not allowed for command %r"
1786
# mix arguments and options into one dictionary
1787
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1789
for k, v in opts.items():
1790
cmdopts[k.replace('-', '_')] = v
1793
import hotshot, tempfile
1794
pffileno, pfname = tempfile.mkstemp()
1796
prof = hotshot.Profile(pfname)
1797
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1800
import hotshot.stats
1801
stats = hotshot.stats.load(pfname)
1803
stats.sort_stats('time')
1804
## XXX: Might like to write to stderr or the trace file instead but
1805
## print_stats seems hardcoded to stdout
1806
stats.print_stats(20)
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1077
if not opt_no_aliases:
1078
alias_argv = get_alias(argv[0])
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
argv[0] = alias_argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1090
run = cmd_obj.run_argv_aliases
1091
run_argv = [argv, alias_argv]
1814
return cmd_class(cmdopts, cmdargs).status
1817
def _report_exception(summary, quiet=False):
1819
log_error('bzr: ' + summary)
1820
bzrlib.trace.log_exception()
1823
tb = sys.exc_info()[2]
1824
exinfo = traceback.extract_tb(tb)
1826
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1827
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1833
bzrlib.trace.open_tracefile(argv)
1094
# We can be called recursively (tests for example), but we don't want
1095
# the verbosity level to propagate.
1096
saved_verbosity_level = option._verbosity_level
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
'--coverage ignored, because --lsprof is in use.')
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
1107
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
ret = run(*run_argv)
1838
return run_bzr(argv[1:])
1840
# do this here inside the exception wrappers to catch EPIPE
1843
quiet = isinstance(e, (BzrCommandError))
1844
_report_exception('error: ' + e.args[0], quiet=quiet)
1847
# some explanation or hints
1850
except AssertionError, e:
1851
msg = 'assertion failed'
1853
msg += ': ' + str(e)
1854
_report_exception(msg)
1856
except KeyboardInterrupt, e:
1857
_report_exception('interrupted', quiet=True)
1859
except Exception, e:
1862
if (isinstance(e, IOError)
1863
and hasattr(e, 'errno')
1864
and e.errno == errno.EPIPE):
1868
msg = str(e).rstrip('\n')
1869
_report_exception(msg, quiet)
1114
# reset, in case we may do other commands later within the same
1115
# process. Commands that want to execute sub-commands must propagate
1116
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
option._verbosity_level = saved_verbosity_level
1122
def display_command(func):
1123
"""Decorator that suppresses pipe/interrupt errors."""
1124
def ignore_pipe(*args, **kwargs):
1126
result = func(*args, **kwargs)
1130
if getattr(e, 'errno', None) is None:
1132
if e.errno != errno.EPIPE:
1133
# Win32 raises IOError with errno=0 on a broken pipe
1134
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1137
except KeyboardInterrupt:
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
trace.mutter("return code %d", ret)
1199
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
return run_bzr(argv)
1220
except Exception, e:
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
1229
class HelpCommandIndex(object):
1230
"""A index for bzr help that returns commands."""
1233
self.prefix = 'commands/'
1235
def get_topics(self, topic):
1236
"""Search for topic amongst commands.
1238
:param topic: A topic to search for.
1239
:return: A list which is either empty or contains a single
1242
if topic and topic.startswith(self.prefix):
1243
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
1872
bzrlib.trace.close_trace()
1875
if __name__ == '__main__':
1876
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
