50
163
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
164
return cmd[4:].replace('_','-')
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)
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
171
import bzrlib.builtins
172
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
builtin_command_registry.register(cmd_class)
174
bzrlib.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
179
for name, obj in module.__dict__.iteritems():
180
if name.startswith("cmd_"):
181
real_name = _unsquish_command_name(name)
186
def _list_bzr_commands(names):
187
"""Find commands from bzr's core and plugins.
189
This is not the public interface, just the default hook called by all_command_names.
191
# to eliminate duplicates
192
names.update(builtin_command_names())
193
names.update(plugin_command_names())
197
def all_command_names():
198
"""Return a set of all command names."""
200
for hook in Command.hooks['list_commands']:
203
raise AssertionError(
204
'hook %s returned None' % Command.hooks.get_hook_name(hook))
208
def builtin_command_names():
209
"""Return list of builtin command names.
211
Use of all_command_names() is encouraged rather than builtin_command_names
212
and/or plugin_command_names.
214
_register_builtin_commands()
215
return builtin_command_registry.keys()
218
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
220
return plugin_cmds.keys()
223
def get_cmd_object(cmd_name, plugins_override=True):
224
"""Return the command object for a command.
227
If true, plugin commands can override builtins.
230
return _get_cmd_object(cmd_name, plugins_override)
232
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
235
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
236
"""Get a command object.
238
:param cmd_name: The name of the command.
239
:param plugins_override: Allow plugins to override builtins.
240
:param check_missing: Look up commands not found in the regular index via
241
the get_missing_command hook.
242
:return: A Command object instance
243
:raises KeyError: If no command is found.
245
# We want only 'ascii' command names, but the user may have typed
246
# in a Unicode name. In that case, they should just get a
247
# 'command not found' error later.
248
# In the future, we may actually support Unicode command names.
251
for hook in Command.hooks['get_command']:
252
cmd = hook(cmd, cmd_name)
253
if cmd is not None and not plugins_override and not cmd.plugin_name():
254
# We've found a non-plugin command, don't permit it to be
257
if cmd is None and check_missing:
258
for hook in Command.hooks['get_missing_command']:
265
# Allow plugins to extend commands
266
for hook in Command.hooks['extend_command']:
268
if getattr(cmd, 'invoked_as', None) is None:
269
cmd.invoked_as = cmd_name
273
def _try_plugin_provider(cmd_name):
274
"""Probe for a plugin provider having cmd_name."""
276
plugin_metadata, provider = probe_for_provider(cmd_name)
277
raise errors.CommandAvailableInPlugin(cmd_name,
278
plugin_metadata, provider)
279
except errors.NoPluginAvailable:
283
def probe_for_provider(cmd_name):
284
"""Look for a provider for cmd_name.
286
:param cmd_name: The command name.
287
:return: plugin_metadata, provider for getting cmd_name.
288
:raises NoPluginAvailable: When no provider can supply the plugin.
290
# look for providers that provide this command but aren't installed
291
for provider in command_providers_registry:
293
return provider.plugin_for_command(cmd_name), provider
294
except errors.NoPluginAvailable:
296
raise errors.NoPluginAvailable(cmd_name)
299
def _get_bzr_command(cmd_or_None, cmd_name):
300
"""Get a command from bzr's core."""
302
cmd_class = builtin_command_registry.get(cmd_name)
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)
310
def _get_external_command(cmd_or_None, cmd_name):
311
"""Lookup a command that is a shell script."""
312
# Only do external command lookups when no command is found so far.
313
if cmd_or_None is not None:
315
from bzrlib.externalcommand import ExternalCommand
316
cmd_obj = ExternalCommand.find_command(cmd_name)
321
def _get_plugin_command(cmd_or_None, cmd_name):
322
"""Get a command from bzr's plugins."""
155
return cmd, cmds[cmd]
324
return plugin_cmds.get(cmd_name)()
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)
327
for key in plugin_cmds.keys():
328
info = plugin_cmds.get_info(key)
329
if cmd_name in info.aliases:
330
return plugin_cmds.get(key)()
171
334
class Command(object):
172
335
"""Base class for commands.
337
Commands are the heart of the command-line bzr interface.
339
The command object mostly handles the mapping of command-line
340
parameters into one or more bzrlib operations, and of the results
343
Commands normally don't have any state. All their arguments are
344
passed in to the run method. (Subclasses may take a different
345
policy if the behaviour of the instance needs to depend on e.g. a
346
shell plugin and not just its Python class.)
174
348
The docstring for an actual command should give a single-line
175
349
summary, then a complete description of the command. A grammar
176
350
description will be inserted.
179
List of argument forms, marked with whether they are optional,
183
List of options that may be given for this command.
186
If true, this command isn't advertised.
352
:cvar aliases: Other accepted names for this command.
354
:cvar takes_args: List of argument forms, marked with whether they are
355
optional, repeated, etc. Examples::
357
['to_location', 'from_branch?', 'file*']
359
* 'to_location' is required
360
* 'from_branch' is optional
361
* 'file' can be specified 0 or more times
363
:cvar takes_options: List of options that may be given for this command.
364
These can be either strings, referring to globally-defined options, or
365
option objects. Retrieve through options().
367
:cvar hidden: If true, this command isn't advertised. This is typically
368
for commands intended for expert users.
370
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
been setup to properly handle encoding of unicode strings.
372
encoding_type determines what will happen when characters cannot be
375
* strict - abort if we cannot decode
376
* replace - put in a bogus character (typically '?')
377
* exact - do not encode sys.stdout
379
NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
therefore LF line-endings are converted to CRLF. When a command uses
381
encoding_type = 'exact', then sys.stdout is forced to be a binary
382
stream, and line-endings will not mangled.
385
A string indicating the real name under which this command was
386
invoked, before expansion of aliases.
387
(This may be None if the command was constructed and run in-process.)
389
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'bzr help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
191
400
takes_options = []
401
encoding_type = 'strict'
195
def __init__(self, options, arguments):
196
"""Construct and run the 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)
203
assert self.__doc__ != Command.__doc__, \
204
("No help message set for %r" % self)
205
self.status = self.run(**cmdargs)
408
"""Construct an instance of this command."""
409
# List of standard options directly supported
410
self.supported_std_options = []
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
436
"""Return single-line grammar for this command.
438
Only describes arguments, not options.
440
s = 'bzr ' + self.name() + ' '
441
for aname in self.takes_args:
442
aname = aname.upper()
443
if aname[-1] in ['$', '+']:
444
aname = aname[:-1] + '...'
445
elif aname[-1] == '?':
446
aname = '[' + aname[:-1] + ']'
447
elif aname[-1] == '*':
448
aname = '[' + aname[:-1] + '...]'
450
s = s[:-1] # remove last space
453
def get_help_text(self, additional_see_also=None, plain=True,
454
see_also_as_links=False, verbose=True):
455
"""Return a text string with help for this command.
457
:param additional_see_also: Additional help topics to be
459
:param plain: if False, raw help (reStructuredText) is
460
returned instead of plain text.
461
:param see_also_as_links: if True, convert items in 'See also'
462
list to internal links (used by bzr_man rstx generator)
463
:param verbose: if True, display the full help, otherwise
464
leave out the descriptive sections and just display
465
usage help (e.g. Purpose, Usage, Options) with a
466
message explaining how to obtain full help.
469
i18n.install() # Install i18n only for get_help_text for now.
472
# Note: If self.gettext() translates ':Usage:\n', the section will
473
# be shown after "Description" section and we don't want to
474
# translate the usage string.
475
# Though, bzr export-pot don't exports :Usage: section and it must
477
doc = self.gettext(doc)
479
doc = gettext("No help for this command.")
481
# Extract the summary (purpose) and sections out from the text
482
purpose,sections,order = self._get_help_parts(doc)
484
# If a custom usage section was provided, use it
485
if sections.has_key('Usage'):
486
usage = sections.pop('Usage')
488
usage = self._usage()
490
# The header is the purpose and usage
492
result += gettext(':Purpose: %s\n') % (purpose,)
493
if usage.find('\n') >= 0:
494
result += gettext(':Usage:\n%s\n') % (usage,)
496
result += gettext(':Usage: %s\n') % (usage,)
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
504
parser = option.get_optparser(self.options())
505
options = parser.format_option_help()
506
# FIXME: According to the spec, ReST option lists actually don't
507
# support options like --1.14 so that causes syntax errors (in Sphinx
508
# at least). As that pattern always appears in the commands that
509
# break, we trap on that and then format that block of 'format' options
510
# as a literal block. We use the most recent format still listed so we
511
# don't have to do that too often -- vila 20110514
512
if not plain and options.find(' --1.14 ') != -1:
513
options = options.replace(' format:\n', ' format::\n\n', 1)
514
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
521
# Add the description, indenting it 2 spaces
522
# to match the indentation of the options
523
if sections.has_key(None):
524
text = sections.pop(None)
525
text = '\n '.join(text.splitlines())
526
result += gettext(':Description:\n %s\n\n') % (text,)
528
# Add the custom sections (e.g. Examples). Note that there's no need
529
# to indent these as they must be indented already in the source.
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
539
# Add the aliases, source (plug-in) and see also links, if any
541
result += gettext(':Aliases: ')
542
result += ', '.join(self.aliases) + '\n'
543
plugin_name = self.plugin_name()
544
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
546
see_also = self.get_see_also(additional_see_also)
548
if not plain and see_also_as_links:
550
for item in see_also:
552
# topics doesn't have an independent section
553
# so don't create a real link
554
see_also_links.append(item)
556
# Use a Sphinx link for this entry
557
link_text = gettext(":doc:`{0} <{1}-help>`").format(
559
see_also_links.append(link_text)
560
see_also = see_also_links
561
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
563
# If this will be rendered as plain text, convert it
565
import bzrlib.help_topics
566
result = bzrlib.help_topics.help_as_plain_text(result)
570
def _get_help_parts(text):
571
"""Split help text into a summary and named sections.
573
:return: (summary,sections,order) where summary is the top line and
574
sections is a dictionary of the rest indexed by section name.
575
order is the order the section appear in the text.
576
A section starts with a heading line of the form ":xxx:".
577
Indented text on following lines is the section value.
578
All text found outside a named section is assigned to the
579
default section which is given the key of None.
581
def save_section(sections, order, label, section):
583
if sections.has_key(label):
584
sections[label] += '\n' + section
587
sections[label] = section
589
lines = text.rstrip().splitlines()
590
summary = lines.pop(0)
593
label,section = None,''
595
if line.startswith(':') and line.endswith(':') and len(line) > 2:
596
save_section(sections, order, label, section)
597
label,section = line[1:-1],''
598
elif (label is not None) and len(line) > 1 and not line[0].isspace():
599
save_section(sections, order, label, section)
600
label,section = None,line
603
section += '\n' + line
606
save_section(sections, order, label, section)
607
return summary, sections, order
609
def get_help_topic(self):
610
"""Return the commands help topic - its name."""
613
def get_see_also(self, additional_terms=None):
614
"""Return a list of help topics that are related to this command.
616
The list is derived from the content of the _see_also attribute. Any
617
duplicates are removed and the result is in lexical order.
618
:param additional_terms: Additional help topics to cross-reference.
619
:return: A list of help topics.
621
see_also = set(getattr(self, '_see_also', []))
623
see_also.update(additional_terms)
624
return sorted(see_also)
627
"""Return dict of valid options for this command.
629
Maps from long option name to option object."""
630
r = Option.STD_OPTIONS.copy()
632
for o in self.takes_options:
633
if isinstance(o, basestring):
634
o = option.Option.OPTIONS[o]
636
if o.name in std_names:
637
self.supported_std_options.append(o.name)
640
def _setup_outf(self):
641
"""Return a file linked to stdout, which has proper encoding."""
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
645
def run_argv_aliases(self, argv, alias_argv=None):
646
"""Parse the command line and run with extra aliases in alias_argv."""
647
args, opts = parse_args(self, argv, alias_argv)
650
# Process the standard options
651
if 'help' in opts: # e.g. bzr add --help
652
self.outf.write(self.get_help_text())
654
if 'usage' in opts: # e.g. bzr add --usage
655
self.outf.write(self.get_help_text(verbose=False))
657
trace.set_verbosity_level(option._verbosity_level)
658
if 'verbose' in self.supported_std_options:
659
opts['verbose'] = trace.is_verbose()
660
elif opts.has_key('verbose'):
662
if 'quiet' in self.supported_std_options:
663
opts['quiet'] = trace.is_quiet()
664
elif opts.has_key('quiet'):
666
# mix arguments and options into one dictionary
667
cmdargs = _match_argform(self.name(), self.takes_args, args)
669
for k, v in opts.items():
670
cmdopts[k.replace('-', '_')] = v
672
all_cmd_args = cmdargs.copy()
673
all_cmd_args.update(cmdopts)
676
return self.run(**all_cmd_args)
678
# reset it, so that other commands run in the same process won't
679
# inherit state. Before we reset it, log any activity, so that it
680
# gets properly tracked.
681
ui.ui_factory.log_transport_activity(
682
display=('bytes' in debug.debug_flags))
683
trace.set_verbosity_level(0)
685
def _setup_run(self):
686
"""Wrap the defined run method on self with a cleanup.
688
This is called by __init__ to make the Command be able to be run
689
by just calling run(), as it could be before cleanups were added.
691
If a different form of cleanups are in use by your Command subclass,
692
you can override this method.
695
def run(*args, **kwargs):
696
self._operation = cleanup.OperationWithCleanups(class_run)
698
return self._operation.run_simple(*args, **kwargs)
209
"""Override this in sub-classes.
704
"""Actually run the command.
211
706
This is invoked with the options and arguments bound to
212
707
keyword parameters.
214
Return 0 or None if the command was successful, or a shell
709
Return 0 or None if the command was successful, or a non-zero
710
shell error code if not. It's OK for this method to allow
711
an exception to raise up.
713
This method is automatically wrapped by Command.__init__ with a
714
cleanup operation, stored as self._operation. This can be used
715
via self.add_cleanup to perform automatic cleanups at the end of
718
The argument for run are assembled by introspection. So for instance,
719
if your command takes an argument files, you would declare::
721
def run(self, files=None):
220
class ExternalCommand(Command):
221
"""Class to wrap external commands.
223
We cheat a little here, when get_cmd_class() calls us we actually give it back
224
an object we construct that has the appropriate path, help, options etc for the
227
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
228
method, which we override to call the Command.__init__ method. That then calls
229
our run method which is pretty straight forward.
231
The only wrinkle is that we have to map bzr's dictionary of options and arguments
232
back into command line options and arguments for the script.
235
def find_command(cls, cmd):
237
bzrpath = os.environ.get('BZRPATH', '')
239
for dir in bzrpath.split(os.pathsep):
240
path = os.path.join(dir, cmd)
241
if os.path.isfile(path):
242
return ExternalCommand(path)
246
find_command = classmethod(find_command)
248
def __init__(self, path):
251
pipe = os.popen('%s --bzr-usage' % path, 'r')
252
self.takes_options = pipe.readline().split()
254
for opt in self.takes_options:
255
if not opt in OPTIONS:
256
raise BzrError("Unknown option '%s' returned by external command %s"
259
# TODO: Is there any way to check takes_args is valid here?
260
self.takes_args = pipe.readline().split()
262
if pipe.close() is not None:
263
raise BzrError("Failed funning '%s --bzr-usage'" % path)
265
pipe = os.popen('%s --bzr-help' % path, 'r')
266
self.__doc__ = pipe.read()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-help'" % path)
270
def __call__(self, options, arguments):
271
Command.__init__(self, options, arguments)
274
def run(self, **kargs):
281
optname = name.replace('_','-')
283
if OPTIONS.has_key(optname):
285
opts.append('--%s' % optname)
286
if value is not None and value is not True:
287
opts.append(str(value))
289
# it's an arg, or arg list
290
if type(value) is not list:
296
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
300
class cmd_status(Command):
301
"""Display status summary.
303
This reports on versioned and unknown files, reporting them
304
grouped by state. Possible states are:
307
Versioned in the working copy but not in the previous revision.
310
Versioned in the previous revision but removed or deleted
314
Path of this file changed from the previous revision;
315
the text may also have changed. This includes files whose
316
parent directory was renamed.
319
Text has changed since the previous revision.
322
Nothing about this file has changed since the previous revision.
323
Only shown with --all.
326
Not versioned and not matching an ignore pattern.
328
To see ignored files use 'bzr ignored'. For details in the
329
changes to file texts, use 'bzr diff'.
331
If no arguments are specified, the status of the entire working
332
directory is shown. Otherwise, only the status of the specified
333
files or directories is reported. If a directory is given, status
334
is reported for everything inside that directory.
336
If a revision is specified, the changes since that revision are shown.
338
takes_args = ['file*']
339
takes_options = ['all', 'show-ids', 'revision']
340
aliases = ['st', 'stat']
342
def run(self, all=False, show_ids=False, file_list=None):
344
b = find_branch(file_list[0])
345
file_list = [b.relpath(x) for x in file_list]
346
# special case: only one path was given and it's the root
348
if file_list == ['']:
353
from bzrlib.status import show_status
354
show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
358
class cmd_cat_revision(Command):
359
"""Write out metadata for a revision."""
362
takes_args = ['revision_id']
364
def run(self, revision_id):
365
from bzrlib.xml import pack_xml
366
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
369
class cmd_revno(Command):
370
"""Show current revision number.
372
This is equal to the number of revisions on this branch."""
374
print find_branch('.').revno()
376
class cmd_revision_info(Command):
377
"""Show revision number and revision id for a given revision identifier.
380
takes_args = ['revision_info*']
381
takes_options = ['revision']
382
def run(self, revision=None, revision_info_list=None):
383
from bzrlib.branch import find_branch
386
if revision is not None:
387
revs.extend(revision)
388
if revision_info_list is not None:
389
revs.extend(revision_info_list)
391
raise BzrCommandError('You must supply a revision identifier')
396
print '%4d %s' % b.get_revision_info(rev)
399
class cmd_add(Command):
400
"""Add specified files or directories.
402
In non-recursive mode, all the named items are added, regardless
403
of whether they were previously ignored. A warning is given if
404
any of the named files are already versioned.
406
In recursive mode (the default), files are treated the same way
407
but the behaviour for directories is different. Directories that
408
are already versioned do not give a warning. All directories,
409
whether already versioned or not, are searched for files or
410
subdirectories that are neither versioned or ignored, and these
411
are added. This search proceeds recursively into versioned
414
Therefore simply saying 'bzr add .' will version all files that
415
are currently unknown.
417
TODO: Perhaps adding a file whose directly is not versioned should
418
recursively add that parent, rather than giving an error?
420
takes_args = ['file+']
421
takes_options = ['verbose', 'no-recurse']
423
def run(self, file_list, verbose=False, no_recurse=False):
424
from bzrlib.add import smart_add
425
smart_add(file_list, verbose, not no_recurse)
429
class cmd_mkdir(Command):
430
"""Create a new versioned directory.
432
This is equivalent to creating the directory and then adding it.
434
takes_args = ['dir+']
436
def run(self, dir_list):
443
b.add([d], verbose=True)
446
class cmd_relpath(Command):
447
"""Show path of a file relative to root"""
448
takes_args = ['filename']
451
def run(self, filename):
452
print find_branch(filename).relpath(filename)
456
class cmd_inventory(Command):
457
"""Show inventory of the current working copy or a revision."""
458
takes_options = ['revision', 'show-ids']
460
def run(self, revision=None, show_ids=False):
463
inv = b.read_working_inventory()
465
if len(revision) > 1:
466
raise BzrCommandError('bzr inventory --revision takes'
467
' exactly one revision identifier')
468
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
470
for path, entry in inv.entries():
472
print '%-50s %s' % (path, entry.file_id)
477
class cmd_move(Command):
478
"""Move files to a different directory.
483
The destination must be a versioned directory in the same branch.
485
takes_args = ['source$', 'dest']
486
def run(self, source_list, dest):
489
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
492
class cmd_rename(Command):
493
"""Change the name of an entry.
496
bzr rename frob.c frobber.c
497
bzr rename src/frob.c lib/frob.c
499
It is an error if the destination name exists.
501
See also the 'move' command, which moves files into a different
502
directory without changing their name.
504
TODO: Some way to rename multiple files without invoking bzr for each
506
takes_args = ['from_name', 'to_name']
508
def run(self, from_name, to_name):
510
b.rename_one(b.relpath(from_name), b.relpath(to_name))
516
class cmd_pull(Command):
517
"""Pull any changes from another branch into the current one.
519
If the location is omitted, the last-used location will be used.
520
Both the revision history and the working directory will be
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if both branches have had commits without first
525
pulling from the other.
527
If branches have diverged, you can use 'bzr merge' to pull the text changes
528
from one into the other.
530
takes_args = ['location?']
532
def run(self, location=None):
533
from bzrlib.merge import merge
535
from shutil import rmtree
538
br_to = find_branch('.')
541
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
543
if e.errno != errno.ENOENT:
546
if stored_loc is None:
547
raise BzrCommandError("No pull location known or specified.")
549
print "Using last location: %s" % stored_loc
550
location = stored_loc
551
cache_root = tempfile.mkdtemp()
552
from bzrlib.branch import DivergedBranches
553
br_from = find_branch(location)
554
location = pull_loc(br_from)
555
old_revno = br_to.revno()
557
from branch import find_cached_branch, DivergedBranches
558
br_from = find_cached_branch(location, cache_root)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
562
br_to.update_revisions(br_from)
563
except DivergedBranches:
564
raise BzrCommandError("These branches have diverged."
567
merge(('.', -1), ('.', old_revno), check_clean=False)
568
if location != stored_loc:
569
br_to.controlfile("x-pull", "wb").write(location + "\n")
575
class cmd_branch(Command):
576
"""Create a new copy of a branch.
578
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
579
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
581
To retrieve the branch as of a particular revision, supply the --revision
582
parameter, as in "branch foo/bar -r 5".
584
takes_args = ['from_location', 'to_location?']
585
takes_options = ['revision']
587
def run(self, from_location, to_location=None, revision=None):
589
from bzrlib.merge import merge
590
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
591
find_cached_branch, Branch
592
from shutil import rmtree
593
from meta_store import CachedStore
595
cache_root = tempfile.mkdtemp()
599
elif len(revision) > 1:
600
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
604
br_from = find_cached_branch(from_location, cache_root)
606
if e.errno == errno.ENOENT:
607
raise BzrCommandError('Source location "%s" does not'
608
' exist.' % to_location)
612
if to_location is None:
613
to_location = os.path.basename(from_location.rstrip("/\\"))
616
os.mkdir(to_location)
618
if e.errno == errno.EEXIST:
619
raise BzrCommandError('Target directory "%s" already'
620
' exists.' % to_location)
621
if e.errno == errno.ENOENT:
622
raise BzrCommandError('Parent of "%s" does not exist.' %
626
br_to = Branch(to_location, init=True)
628
br_to.set_root_id(br_from.get_root_id())
631
if revision[0] is None:
632
revno = br_from.revno()
634
revno, rev_id = br_from.get_revision_info(revision[0])
636
br_to.update_revisions(br_from, stop_revision=revno)
637
except NoSuchRevision:
639
msg = "The branch %s has no revision %d." % (from_location,
641
raise BzrCommandError(msg)
643
merge((to_location, -1), (to_location, 0), this_dir=to_location,
644
check_clean=False, ignore_zero=True)
645
from_location = pull_loc(br_from)
646
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
651
def pull_loc(branch):
652
# TODO: Should perhaps just make attribute be 'base' in
653
# RemoteBranch and Branch?
654
if hasattr(branch, "baseurl"):
655
return branch.baseurl
661
class cmd_renames(Command):
662
"""Show list of renamed files.
664
TODO: Option to show renames between two historical versions.
666
TODO: Only show renames under dir, rather than in the whole branch.
668
takes_args = ['dir?']
670
def run(self, dir='.'):
672
old_inv = b.basis_tree().inventory
673
new_inv = b.read_working_inventory()
675
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
677
for old_name, new_name in renames:
678
print "%s => %s" % (old_name, new_name)
681
class cmd_info(Command):
682
"""Show statistical information about a branch."""
683
takes_args = ['branch?']
685
def run(self, branch=None):
688
b = find_branch(branch)
692
class cmd_remove(Command):
693
"""Make a file unversioned.
695
This makes bzr stop tracking changes to a versioned file. It does
696
not delete the working copy.
698
takes_args = ['file+']
699
takes_options = ['verbose']
701
def run(self, file_list, verbose=False):
702
b = find_branch(file_list[0])
703
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
706
class cmd_file_id(Command):
707
"""Print file_id of a particular file or directory.
709
The file_id is assigned when the file is first added and remains the
710
same through all revisions where the file exists, even when it is
714
takes_args = ['filename']
715
def run(self, filename):
716
b = find_branch(filename)
717
i = b.inventory.path2id(b.relpath(filename))
719
raise BzrError("%r is not a versioned file" % filename)
724
class cmd_file_path(Command):
725
"""Print path of file_ids to a file or directory.
727
This prints one line for each directory down to the target,
728
starting at the branch root."""
730
takes_args = ['filename']
731
def run(self, filename):
732
b = find_branch(filename)
734
fid = inv.path2id(b.relpath(filename))
736
raise BzrError("%r is not a versioned file" % filename)
737
for fip in inv.get_idpath(fid):
741
class cmd_revision_history(Command):
742
"""Display list of revision ids on this branch."""
745
for patchid in find_branch('.').revision_history():
749
class cmd_directories(Command):
750
"""Display list of versioned directories in this branch."""
752
for name, ie in find_branch('.').read_working_inventory().directories():
759
class cmd_init(Command):
760
"""Make a directory into a versioned branch.
762
Use this to create an empty branch, or before importing an
765
Recipe for importing a tree of files:
770
bzr commit -m 'imported project'
773
from bzrlib.branch import Branch
774
Branch('.', init=True)
777
class cmd_diff(Command):
778
"""Show differences in working tree.
780
If files are listed, only the changes in those files are listed.
781
Otherwise, all changes for the tree are listed.
783
TODO: Given two revision arguments, show the difference between them.
785
TODO: Allow diff across branches.
787
TODO: Option to use external diff command; could be GNU diff, wdiff,
790
TODO: Python difflib is not exactly the same as unidiff; should
791
either fix it up or prefer to use an external diff.
793
TODO: If a directory is given, diff everything under that.
795
TODO: Selected-file diff is inefficient and doesn't show you
798
TODO: This probably handles non-Unix newlines poorly.
801
takes_args = ['file*']
802
takes_options = ['revision', 'diff-options']
803
aliases = ['di', 'dif']
805
def run(self, revision=None, file_list=None, diff_options=None):
806
from bzrlib.diff import show_diff
809
b = find_branch(file_list[0])
810
file_list = [b.relpath(f) for f in file_list]
811
if file_list == ['']:
812
# just pointing to top-of-tree
817
# TODO: Make show_diff support taking 2 arguments
819
if revision is not None:
820
if len(revision) != 1:
821
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
822
base_rev = revision[0]
824
show_diff(b, base_rev, specific_files=file_list,
825
external_diff_options=diff_options)
831
class cmd_deleted(Command):
832
"""List files deleted in the working tree.
834
TODO: Show files deleted since a previous revision, or between two revisions.
836
def run(self, show_ids=False):
839
new = b.working_tree()
841
## TODO: Much more efficient way to do this: read in new
842
## directories with readdir, rather than stating each one. Same
843
## level of effort but possibly much less IO. (Or possibly not,
844
## if the directories are very large...)
846
for path, ie in old.inventory.iter_entries():
847
if not new.has_id(ie.file_id):
849
print '%-50s %s' % (path, ie.file_id)
854
class cmd_modified(Command):
855
"""List files modified in working tree."""
858
from bzrlib.diff import compare_trees
861
td = compare_trees(b.basis_tree(), b.working_tree())
863
for path, id, kind in td.modified:
868
class cmd_added(Command):
869
"""List files added in working tree."""
873
wt = b.working_tree()
874
basis_inv = b.basis_tree().inventory
877
if file_id in basis_inv:
879
path = inv.id2path(file_id)
880
if not os.access(b.abspath(path), os.F_OK):
886
class cmd_root(Command):
887
"""Show the tree root directory.
889
The root is the nearest enclosing directory with a .bzr control
891
takes_args = ['filename?']
892
def run(self, filename=None):
893
"""Print the branch root."""
894
b = find_branch(filename)
895
print getattr(b, 'base', None) or getattr(b, 'baseurl')
898
class cmd_log(Command):
899
"""Show log of this branch.
901
To request a range of logs, you can use the command -r begin:end
902
-r revision requests a specific revision, -r :end or -r begin: are
905
--message allows you to give a regular expression, which will be evaluated
906
so that only matching entries will be displayed.
908
TODO: Make --revision support uuid: and hash: [future tag:] notation.
912
takes_args = ['filename?']
913
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
915
def run(self, filename=None, timezone='original',
922
from bzrlib.branch import find_branch
923
from bzrlib.log import log_formatter, show_log
926
direction = (forward and 'forward') or 'reverse'
929
b = find_branch(filename)
930
fp = b.relpath(filename)
932
file_id = b.read_working_inventory().path2id(fp)
934
file_id = None # points to branch root
942
elif len(revision) == 1:
943
rev1 = rev2 = b.get_revision_info(revision[0])[0]
944
elif len(revision) == 2:
945
rev1 = b.get_revision_info(revision[0])[0]
946
rev2 = b.get_revision_info(revision[1])[0]
948
raise BzrCommandError('bzr log --revision takes one or two values.')
955
mutter('encoding log as %r' % bzrlib.user_encoding)
957
# use 'replace' so that we don't abort if trying to write out
958
# in e.g. the default C locale.
959
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
965
lf = log_formatter(log_format,
968
show_timezone=timezone)
981
class cmd_touching_revisions(Command):
982
"""Return revision-ids which affected a particular file.
984
A more user-friendly interface is "bzr log FILE"."""
986
takes_args = ["filename"]
987
def run(self, filename):
988
b = find_branch(filename)
989
inv = b.read_working_inventory()
990
file_id = inv.path2id(b.relpath(filename))
991
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
992
print "%6d %s" % (revno, what)
995
class cmd_ls(Command):
996
"""List files in a tree.
998
TODO: Take a revision or remote path and list that tree instead.
1001
def run(self, revision=None, verbose=False):
1002
b = find_branch('.')
1003
if revision == None:
1004
tree = b.working_tree()
1006
tree = b.revision_tree(b.lookup_revision(revision))
1008
for fp, fc, kind, fid in tree.list_files():
1010
if kind == 'directory':
1012
elif kind == 'file':
1017
print '%-8s %s%s' % (fc, fp, kindch)
1023
class cmd_unknowns(Command):
1024
"""List unknown files."""
1026
from bzrlib.osutils import quotefn
1027
for f in find_branch('.').unknowns():
1032
class cmd_ignore(Command):
1033
"""Ignore a command or pattern.
1035
To remove patterns from the ignore list, edit the .bzrignore file.
1037
If the pattern contains a slash, it is compared to the whole path
1038
from the branch root. Otherwise, it is comapred to only the last
1039
component of the path.
1041
Ignore patterns are case-insensitive on case-insensitive systems.
1043
Note: wildcards must be quoted from the shell on Unix.
1046
bzr ignore ./Makefile
1047
bzr ignore '*.class'
1049
takes_args = ['name_pattern']
1051
def run(self, name_pattern):
1052
from bzrlib.atomicfile import AtomicFile
1055
b = find_branch('.')
1056
ifn = b.abspath('.bzrignore')
1058
if os.path.exists(ifn):
1061
igns = f.read().decode('utf-8')
1067
# TODO: If the file already uses crlf-style termination, maybe
1068
# we should use that for the newly added lines?
1070
if igns and igns[-1] != '\n':
1072
igns += name_pattern + '\n'
1075
f = AtomicFile(ifn, 'wt')
1076
f.write(igns.encode('utf-8'))
1081
inv = b.working_tree().inventory
1082
if inv.path2id('.bzrignore'):
1083
mutter('.bzrignore is already versioned')
1085
mutter('need to make new .bzrignore file versioned')
1086
b.add(['.bzrignore'])
1090
class cmd_ignored(Command):
1091
"""List ignored files and the patterns that matched them.
1093
See also: bzr ignore"""
1095
tree = find_branch('.').working_tree()
1096
for path, file_class, kind, file_id in tree.list_files():
1097
if file_class != 'I':
1099
## XXX: Slightly inefficient since this was already calculated
1100
pat = tree.is_ignored(path)
1101
print '%-50s %s' % (path, pat)
1104
class cmd_lookup_revision(Command):
1105
"""Lookup the revision-id from a revision-number
1108
bzr lookup-revision 33
1111
takes_args = ['revno']
1113
def run(self, revno):
1117
raise BzrCommandError("not a valid revision-number: %r" % revno)
1119
print find_branch('.').lookup_revision(revno)
1122
class cmd_export(Command):
1123
"""Export past revision to destination directory.
1125
If no revision is specified this exports the last committed revision.
1127
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1128
given, try to find the format with the extension. If no extension
1129
is found exports to a directory (equivalent to --format=dir).
1131
Root may be the top directory for tar, tgz and tbz2 formats. If none
1132
is given, the top directory will be the root name of the file."""
1133
# TODO: list known exporters
1134
takes_args = ['dest']
1135
takes_options = ['revision', 'format', 'root']
1136
def run(self, dest, revision=None, format=None, root=None):
1138
b = find_branch('.')
1139
if revision is None:
1140
rev_id = b.last_patch()
1142
if len(revision) != 1:
1143
raise BzrError('bzr export --revision takes exactly 1 argument')
1144
revno, rev_id = b.get_revision_info(revision[0])
1145
t = b.revision_tree(rev_id)
1146
root, ext = os.path.splitext(dest)
1148
if ext in (".tar",):
1150
elif ext in (".gz", ".tgz"):
1152
elif ext in (".bz2", ".tbz2"):
1156
t.export(dest, format, root)
1159
class cmd_cat(Command):
1160
"""Write a file's text from a previous revision."""
1162
takes_options = ['revision']
1163
takes_args = ['filename']
1165
def run(self, filename, revision=None):
1166
if revision == None:
1167
raise BzrCommandError("bzr cat requires a revision number")
1168
elif len(revision) != 1:
1169
raise BzrCommandError("bzr cat --revision takes exactly one number")
1170
b = find_branch('.')
1171
b.print_file(b.relpath(filename), revision[0])
1174
class cmd_local_time_offset(Command):
1175
"""Show the offset in seconds from GMT to local time."""
1178
print bzrlib.osutils.local_time_offset()
1182
class cmd_commit(Command):
1183
"""Commit changes into a new revision.
1185
If selected files are specified, only changes to those files are
1186
committed. If a directory is specified then its contents are also
1189
A selected-file commit may fail in some cases where the committed
1190
tree would be invalid, such as trying to commit a file in a
1191
newly-added directory that is not itself committed.
1193
TODO: Run hooks on tree to-be-committed, and after commit.
1195
TODO: Strict commit that fails if there are unknown or deleted files.
1197
takes_args = ['selected*']
1198
takes_options = ['message', 'file', 'verbose', 'unchanged']
1199
aliases = ['ci', 'checkin']
1201
def run(self, message=None, file=None, verbose=True, selected_list=None,
1203
from bzrlib.errors import PointlessCommit
1204
from bzrlib.osutils import get_text_message
1206
## Warning: shadows builtin file()
1207
if not message and not file:
1210
catcher = cStringIO.StringIO()
1211
sys.stdout = catcher
1212
cmd_status({"file_list":selected_list}, {})
1213
info = catcher.getvalue()
1215
message = get_text_message(info)
1218
raise BzrCommandError("please specify a commit message",
1219
["use either --message or --file"])
1220
elif message and file:
1221
raise BzrCommandError("please specify either --message or --file")
1225
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1227
b = find_branch('.')
1230
b.commit(message, verbose=verbose,
1231
specific_files=selected_list,
1232
allow_pointless=unchanged)
1233
except PointlessCommit:
1234
# FIXME: This should really happen before the file is read in;
1235
# perhaps prepare the commit; get the message; then actually commit
1236
raise BzrCommandError("no changes to commit",
1237
["use --unchanged to commit anyhow"])
1240
class cmd_check(Command):
1241
"""Validate consistency of branch history.
1243
This command checks various invariants about the branch storage to
1244
detect data corruption or bzr bugs.
1246
If given the --update flag, it will update some optional fields
1247
to help ensure data consistency.
1249
takes_args = ['dir?']
1251
def run(self, dir='.'):
1252
from bzrlib.check import check
1253
check(find_branch(dir))
1257
class cmd_scan_cache(Command):
1260
from bzrlib.hashcache import HashCache
1267
print '%6d stats' % c.stat_count
1268
print '%6d in hashcache' % len(c._cache)
1269
print '%6d files removed from cache' % c.removed_count
1270
print '%6d hashes updated' % c.update_count
1271
print '%6d files changed too recently to cache' % c.danger_count
1278
class cmd_upgrade(Command):
1279
"""Upgrade branch storage to current format.
1281
This should normally be used only after the check command tells
1284
takes_args = ['dir?']
1286
def run(self, dir='.'):
1287
from bzrlib.upgrade import upgrade
1288
upgrade(find_branch(dir))
1292
class cmd_whoami(Command):
1293
"""Show bzr user id."""
1294
takes_options = ['email']
1296
def run(self, email=False):
1298
print bzrlib.osutils.user_email()
1300
print bzrlib.osutils.username()
1303
class cmd_selftest(Command):
1304
"""Run internal test suite"""
1307
from bzrlib.selftest import selftest
1308
return int(not selftest())
1311
class cmd_version(Command):
1312
"""Show version of bzr."""
1317
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1318
# is bzrlib itself in a branch?
1319
bzrrev = bzrlib.get_bzr_revision()
1321
print " (bzr checkout, revision %d {%s})" % bzrrev
1322
print bzrlib.__copyright__
1323
print "http://bazaar-ng.org/"
1325
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1326
print "you may use, modify and redistribute it under the terms of the GNU"
1327
print "General Public License version 2 or later."
1330
class cmd_rocks(Command):
1331
"""Statement of optimism."""
1334
print "it sure does!"
1336
def parse_spec(spec):
1338
>>> parse_spec(None)
1340
>>> parse_spec("./")
1342
>>> parse_spec("../@")
1344
>>> parse_spec("../f/@35")
1346
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1347
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1352
parsed = spec.split('/@')
1353
assert len(parsed) == 2
1358
parsed[1] = int(parsed[1])
1360
pass # We can allow stuff like ./@revid:blahblahblah
1362
assert parsed[1] >=0
1364
parsed = [spec, None]
1369
class cmd_merge(Command):
1370
"""Perform a three-way merge of trees.
1372
The SPEC parameters are working tree or revision specifiers. Working trees
1373
are specified using standard paths or urls. No component of a directory
1374
path may begin with '@'.
1376
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1378
Revisions are specified using a dirname/@revno pair, where dirname is the
1379
branch directory and revno is the revision within that branch. If no revno
1380
is specified, the latest revision is used.
1382
Revision examples: './@127', 'foo/@', '../@1'
1384
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1385
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1388
merge refuses to run if there are any uncommitted changes, unless
1391
takes_args = ['other_spec', 'base_spec?']
1392
takes_options = ['force']
1394
def run(self, other_spec, base_spec=None, force=False):
1395
from bzrlib.merge import merge
1396
merge(parse_spec(other_spec), parse_spec(base_spec),
1397
check_clean=(not force))
1401
class cmd_revert(Command):
1402
"""Restore selected files from a previous revision.
1404
takes_args = ['file+']
1405
def run(self, file_list):
1406
from bzrlib.branch import find_branch
1411
b = find_branch(file_list[0])
1413
b.revert([b.relpath(f) for f in file_list])
1416
class cmd_merge_revert(Command):
1417
"""Reverse all changes since the last commit.
1419
Only versioned files are affected.
1421
TODO: Store backups of any files that will be reverted, so
1422
that the revert can be undone.
1424
takes_options = ['revision']
1426
def run(self, revision=None):
1427
from bzrlib.merge import merge
1428
if revision is None:
1430
elif len(revision) != 1:
1431
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1432
merge(('.', revision[0]), parse_spec('.'),
1437
class cmd_assert_fail(Command):
1438
"""Test reporting of assertion failures"""
1441
assert False, "always fails"
1444
class cmd_help(Command):
1445
"""Show help on a command or other topic.
1447
For a list of all available commands, say 'bzr help commands'."""
1448
takes_args = ['topic?']
1451
def run(self, topic=None):
1458
class cmd_plugins(Command):
1462
import bzrlib.plugin
724
raise NotImplementedError('no implementation of command %r'
728
"""Return help message for this class."""
1463
729
from inspect import getdoc
1464
from pprint import pprint
1465
for plugin in bzrlib.plugin.all_plugins:
1466
print plugin.__path__[0]
1469
print '\t', d.split('\n')[0]
1471
#pprint(bzrlib.plugin.all_plugins)
1475
# list of all available options; the rhs can be either None for an
1476
# option that takes no argument, or a constructor function that checks
1480
'diff-options': str,
1489
'revision': _parse_revision_str,
1511
def parse_args(argv):
730
if self.__doc__ is Command.__doc__:
734
def gettext(self, message):
735
"""Returns the gettext function used to translate this command's help.
737
Commands provided by plugins should override this to use their
740
return i18n.gettext_per_paragraph(message)
743
"""Return the canonical name for this command.
745
The name under which it was actually invoked is available in invoked_as.
747
return _unsquish_command_name(self.__class__.__name__)
749
def plugin_name(self):
750
"""Get the name of the plugin that provides this command.
752
:return: The name of the plugin or None if the command is builtin.
754
mod_parts = self.__module__.split('.')
755
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
761
class CommandHooks(Hooks):
762
"""Hooks related to Command object creation/enumeration."""
765
"""Create the default hooks.
767
These are all empty initially, because by default nothing should get
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.add_hook('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
788
self.add_hook('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
795
Command.hooks = CommandHooks()
798
def parse_args(command, argv, alias_argv=None):
1512
799
"""Parse command line.
1514
801
Arguments and options are parsed at this level before being passed
1515
802
down to specific command handlers. This routine knows, from a
1516
803
lookup table, something about the available options, what optargs
1517
804
they take, and which commands will accept them.
1519
>>> parse_args('--help'.split())
1520
([], {'help': True})
1521
>>> parse_args('--version'.split())
1522
([], {'version': True})
1523
>>> parse_args('status --all'.split())
1524
(['status'], {'all': True})
1525
>>> parse_args('commit --message=biter'.split())
1526
(['commit'], {'message': u'biter'})
1527
>>> parse_args('log -r 500'.split())
1528
(['log'], {'revision': [500]})
1529
>>> parse_args('log -r500..600'.split())
1530
(['log'], {'revision': [500, 600]})
1531
>>> parse_args('log -vr500..600'.split())
1532
(['log'], {'verbose': True, 'revision': [500, 600]})
1533
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1534
(['log'], {'revision': ['v500', 600]})
1539
# TODO: Maybe handle '--' to end options?
1544
# option names must not be unicode
1548
mutter(" got option %r" % a)
1550
optname, optarg = a[2:].split('=', 1)
1553
if optname not in OPTIONS:
1554
raise BzrError('unknown long option %r' % a)
1557
if shortopt in SHORT_OPTIONS:
1558
# Multi-character options must have a space to delimit
1560
optname = SHORT_OPTIONS[shortopt]
1562
# Single character short options, can be chained,
1563
# and have their value appended to their name
1565
if shortopt not in SHORT_OPTIONS:
1566
# We didn't find the multi-character name, and we
1567
# didn't find the single char name
1568
raise BzrError('unknown short option %r' % a)
1569
optname = SHORT_OPTIONS[shortopt]
1572
# There are extra things on this option
1573
# see if it is the value, or if it is another
1575
optargfn = OPTIONS[optname]
1576
if optargfn is None:
1577
# This option does not take an argument, so the
1578
# next entry is another short option, pack it back
1580
argv.insert(0, '-' + a[2:])
1582
# This option takes an argument, so pack it
1587
# XXX: Do we ever want to support this, e.g. for -r?
1588
raise BzrError('repeated option %r' % a)
1590
optargfn = OPTIONS[optname]
1594
raise BzrError('option %r needs an argument' % a)
1596
optarg = argv.pop(0)
1597
opts[optname] = optargfn(optarg)
1600
raise BzrError('option %r takes no argument' % optname)
1601
opts[optname] = True
806
# TODO: make it a method of the Command?
807
parser = option.get_optparser(command.options())
808
if alias_argv is not None:
809
args = alias_argv + argv
813
# for python 2.5 and later, optparse raises this exception if a non-ascii
814
# option name is given. See http://bugs.python.org/issue2931
816
options, args = parser.parse_args(args)
817
except UnicodeEncodeError,e:
818
raise errors.BzrCommandError(
819
gettext('Only ASCII permitted in option names'))
821
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
822
v is not option.OptionParser.DEFAULT_VALUE])
1605
823
return args, opts
1610
826
def _match_argform(cmd, takes_args, args):
1624
840
argdict[argname + '_list'] = None
1625
841
elif ap[-1] == '+':
1627
raise BzrCommandError("command %r needs one or more %s"
1628
% (cmd, argname.upper()))
843
raise errors.BzrCommandError(gettext(
844
"command {0!r} needs one or more {1}").format(
845
cmd, argname.upper()))
1630
847
argdict[argname + '_list'] = args[:]
1632
849
elif ap[-1] == '$': # all but one
1633
850
if len(args) < 2:
1634
raise BzrCommandError("command %r needs one or more %s"
1635
% (cmd, argname.upper()))
851
raise errors.BzrCommandError(
852
gettext("command {0!r} needs one or more {1}").format(
853
cmd, argname.upper()))
1636
854
argdict[argname + '_list'] = args[:-1]
1639
857
# just a plain arg
1642
raise BzrCommandError("command %r requires argument %s"
1643
% (cmd, argname.upper()))
860
raise errors.BzrCommandError(
861
gettext("command {0!r} requires argument {1}").format(
862
cmd, argname.upper()))
1645
864
argdict[argname] = args.pop(0)
1648
raise BzrCommandError("extra argument to command %s: %s"
867
raise errors.BzrCommandError( gettext(
868
"extra argument to command {0}: {1}").format(
1654
def _parse_master_args(argv):
1655
"""Parse the arguments that always go with the original command.
1656
These are things like bzr --no-plugins, etc.
1658
There are now 2 types of option flags. Ones that come *before* the command,
1659
and ones that come *after* the command.
1660
Ones coming *before* the command are applied against all possible commands.
1661
And are generally applied before plugins are loaded.
1663
The current list are:
1664
--builtin Allow plugins to load, but don't let them override builtin commands,
1665
they will still be allowed if they do not override a builtin.
1666
--no-plugins Don't load any plugins. This lets you get back to official source
1668
--profile Enable the hotspot profile before running the command.
1669
For backwards compatibility, this is also a non-master option.
1670
--version Spit out the version of bzr that is running and exit.
1671
This is also a non-master option.
1672
--help Run help and exit, also a non-master option (I think that should stay, though)
1674
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1675
Traceback (most recent call last):
1677
BzrCommandError: Invalid master option: 'test'
1678
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1681
>>> print opts['version']
1683
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1685
['command', '--more-options']
1686
>>> print opts['profile']
1688
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1691
>>> print opts['no-plugins']
1693
>>> print opts['profile']
1695
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1697
['command', '--profile']
1698
>>> print opts['profile']
1701
master_opts = {'builtin':False,
1708
# This is the point where we could hook into argv[0] to determine
1709
# what front-end is supposed to be run
1710
# For now, we are just ignoring it.
1711
cmd_name = argv.pop(0)
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
873
def apply_coveraged(dirname, the_callable, *args, **kwargs):
874
# Cannot use "import trace", as that would import bzrlib.trace instead of
875
# the standard library's trace.
876
trace = __import__('trace')
878
tracer = trace.Trace(count=1, trace=0)
879
sys.settrace(tracer.globaltrace)
880
threading.settrace(tracer.globaltrace)
883
return exception_to_return_code(the_callable, *args, **kwargs)
886
results = tracer.results()
887
results.write_results(show_missing=1, summary=False,
891
def apply_profiled(the_callable, *args, **kwargs):
895
pffileno, pfname = tempfile.mkstemp()
897
prof = hotshot.Profile(pfname)
899
ret = prof.runcall(exception_to_return_code, the_callable, *args,
903
stats = hotshot.stats.load(pfname)
905
stats.sort_stats('cum') # 'time'
906
## XXX: Might like to write to stderr or the trace file instead but
907
## print_stats seems hardcoded to stdout
908
stats.print_stats(20)
915
def exception_to_return_code(the_callable, *args, **kwargs):
916
"""UI level helper for profiling and coverage.
918
This transforms exceptions into a return value of 3. As such its only
919
relevant to the UI layer, and should never be called where catching
920
exceptions may be desirable.
923
return the_callable(*args, **kwargs)
924
except (KeyboardInterrupt, Exception), e:
925
# used to handle AssertionError and KeyboardInterrupt
926
# specially here, but hopefully they're handled ok by the logger now
927
exc_info = sys.exc_info()
928
exitcode = trace.report_exception(exc_info, sys.stderr)
929
if os.environ.get('BZR_PDB'):
930
print '**** entering debugger'
933
if sys.version_info[:2] < (2, 6):
935
# pdb.post_mortem(tb)
936
# but because pdb.post_mortem gives bad results for tracebacks
937
# from inside generators, we do it manually.
938
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
940
# Setup pdb on the traceback
943
p.setup(tb.tb_frame, tb)
944
# Point the debugger at the deepest frame of the stack
945
p.curindex = len(p.stack) - 1
946
p.curframe = p.stack[p.curindex][0]
947
# Start the pdb prompt.
948
p.print_stack_entry(p.stack[p.curindex])
956
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
from bzrlib.lsprof import profile
958
ret, stats = profile(exception_to_return_code, the_callable,
965
trace.note(gettext('Profile data written to "%s".'), filename)
969
def get_alias(cmd, config=None):
970
"""Return an expanded alias, or None if no alias exists.
973
Command to be checked for an alias.
975
Used to specify an alternative config to use,
976
which is especially useful for testing.
977
If it is unspecified, the global config will be used.
981
config = bzrlib.config.GlobalConfig()
982
alias = config.get_alias(cmd)
984
return cmdline.split(alias)
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1727
989
"""Execute a command.
1729
This is similar to main(), but without all the trappings for
1730
logging and error handling.
991
:param argv: The command-line arguments, without the program name from
992
argv[0] These should already be decoded. All library/test code calling
993
run_bzr should be passing valid strings (don't need decoding).
994
:param load_plugins: What function to call when triggering plugin loading.
995
This function should take no arguments and cause all plugins to be
997
:param disable_plugins: What function to call when disabling plugin
998
loading. This function should take no arguments and cause all plugin
999
loading to be prohibited (so that code paths in your application that
1000
know about some plugins possibly being present will fail to import
1001
those plugins even if they are installed.)
1002
:return: Returns a command exit code or raises an exception.
1004
Special master options: these must come before the command because
1005
they control how the command is interpreted.
1008
Do not load plugin modules at all
1011
Do not allow aliases
1014
Only use builtin commands. (Plugins are still allowed to change
1018
Run under the Python hotshot profiler.
1021
Run under the Python lsprof profiler.
1024
Generate line coverage report in the specified directory.
1027
Specify the number of processes that can be run concurrently (selftest).
1732
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1735
# some options like --builtin and --no-plugins have special effects
1736
argv, master_opts = _parse_master_args(argv)
1737
if not master_opts['no-plugins']:
1738
from bzrlib.plugin import load_plugins
1741
args, opts = parse_args(argv)
1743
if master_opts['help']:
1744
from bzrlib.help import help
1752
from bzrlib.help import help
1758
elif 'version' in opts:
1761
elif args and args[0] == 'builtin':
1762
include_plugins=False
1764
cmd = str(args.pop(0))
1771
plugins_override = not (master_opts['builtin'])
1772
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1774
profile = master_opts['profile']
1775
# For backwards compatibility, I would rather stick with --profile being a
1776
# master/global option
1777
if 'profile' in opts:
1781
# check options are reasonable
1782
allowed = cmd_class.takes_options
1784
if oname not in allowed:
1785
raise BzrCommandError("option '--%s' is not allowed for command %r"
1788
# mix arguments and options into one dictionary
1789
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1791
for k, v in opts.items():
1792
cmdopts[k.replace('-', '_')] = v
1795
import hotshot, tempfile
1796
pffileno, pfname = tempfile.mkstemp()
1798
prof = hotshot.Profile(pfname)
1799
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1802
import hotshot.stats
1803
stats = hotshot.stats.load(pfname)
1805
stats.sort_stats('time')
1806
## XXX: Might like to write to stderr or the trace file instead but
1807
## print_stats seems hardcoded to stdout
1808
stats.print_stats(20)
1029
trace.mutter("bazaar version: " + bzrlib.__version__)
1030
argv = _specified_or_unicode_argv(argv)
1031
trace.mutter("bzr arguments: %r", argv)
1033
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1034
opt_no_l10n = opt_no_aliases = False
1035
opt_lsprof_file = opt_coverage_dir = None
1037
# --no-plugins is handled specially at a very early stage. We need
1038
# to load plugins before doing other command parsing so that they
1039
# can override commands, but this needs to happen first.
1043
override_config = []
1044
while i < len(argv):
1046
if a == '--profile':
1048
elif a == '--lsprof':
1050
elif a == '--lsprof-file':
1052
opt_lsprof_file = argv[i + 1]
1054
elif a == '--no-plugins':
1055
opt_no_plugins = True
1056
elif a == '--no-aliases':
1057
opt_no_aliases = True
1058
elif a == '--no-l10n':
1060
elif a == '--builtin':
1062
elif a == '--concurrency':
1063
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1065
elif a == '--coverage':
1066
opt_coverage_dir = argv[i + 1]
1068
elif a == '--profile-imports':
1069
pass # already handled in startup script Bug #588277
1070
elif a.startswith('-D'):
1071
debug.debug_flags.add(a[2:])
1072
elif a.startswith('-O'):
1073
override_config.append(a[2:])
1078
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1080
debug.set_debug_flags_from_config()
1082
if not opt_no_plugins:
1816
return cmd_class(cmdopts, cmdargs).status
1819
def _report_exception(summary, quiet=False):
1821
log_error('bzr: ' + summary)
1822
bzrlib.trace.log_exception()
1825
tb = sys.exc_info()[2]
1826
exinfo = traceback.extract_tb(tb)
1828
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1829
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1835
bzrlib.trace.open_tracefile(argv)
1089
get_cmd_object('help').run_argv_aliases([])
1092
if argv[0] == '--version':
1093
get_cmd_object('version').run_argv_aliases([])
1098
if not opt_no_aliases:
1099
alias_argv = get_alias(argv[0])
1101
argv[0] = alias_argv.pop(0)
1104
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1107
run = cmd_obj.run_argv_aliases
1108
run_argv = [argv, alias_argv]
1840
return run_bzr(argv)
1842
# do this here inside the exception wrappers to catch EPIPE
1845
quiet = isinstance(e, (BzrCommandError))
1846
_report_exception('error: ' + e.args[0], quiet=quiet)
1849
# some explanation or hints
1852
except AssertionError, e:
1853
msg = 'assertion failed'
1855
msg += ': ' + str(e)
1856
_report_exception(msg)
1858
except KeyboardInterrupt, e:
1859
_report_exception('interrupted', quiet=True)
1861
except Exception, e:
1864
if (isinstance(e, IOError)
1865
and hasattr(e, 'errno')
1866
and e.errno == errno.EPIPE):
1870
msg = str(e).rstrip('\n')
1871
_report_exception(msg, quiet)
1111
# We can be called recursively (tests for example), but we don't want
1112
# the verbosity level to propagate.
1113
saved_verbosity_level = option._verbosity_level
1114
option._verbosity_level = 0
1116
if opt_coverage_dir:
1118
'--coverage ignored, because --lsprof is in use.')
1119
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1121
if opt_coverage_dir:
1123
'--coverage ignored, because --profile is in use.')
1124
ret = apply_profiled(run, *run_argv)
1125
elif opt_coverage_dir:
1126
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1128
ret = run(*run_argv)
1874
bzrlib.trace.close_trace()
1877
if __name__ == '__main__':
1878
sys.exit(main(sys.argv))
1131
# reset, in case we may do other commands later within the same
1132
# process. Commands that want to execute sub-commands must propagate
1133
# --verbose in their own way.
1134
if 'memory' in debug.debug_flags:
1135
trace.debug_memory('Process status after command:', short=False)
1136
option._verbosity_level = saved_verbosity_level
1137
# Reset the overrides
1138
bzrlib.global_state.cmdline_overrides._reset()
1141
def display_command(func):
1142
"""Decorator that suppresses pipe/interrupt errors."""
1143
def ignore_pipe(*args, **kwargs):
1145
result = func(*args, **kwargs)
1149
if getattr(e, 'errno', None) is None:
1151
if e.errno != errno.EPIPE:
1152
# Win32 raises IOError with errno=0 on a broken pipe
1153
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1156
except KeyboardInterrupt:
1161
def install_bzr_command_hooks():
1162
"""Install the hooks to supply bzr's own commands."""
1163
if _list_bzr_commands in Command.hooks["list_commands"]:
1165
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1167
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1169
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1170
"bzr plugin commands")
1171
Command.hooks.install_named_hook("get_command", _get_external_command,
1172
"bzr external command lookup")
1173
Command.hooks.install_named_hook("get_missing_command",
1174
_try_plugin_provider,
1175
"bzr plugin-provider-db check")
1179
def _specified_or_unicode_argv(argv):
1180
# For internal or testing use, argv can be passed. Otherwise, get it from
1181
# the process arguments in a unicode-safe way.
1183
return osutils.get_unicode_argv()
1187
# ensure all arguments are unicode strings
1189
if isinstance(a, unicode):
1192
new_argv.append(a.decode('ascii'))
1193
except UnicodeDecodeError:
1194
raise errors.BzrError("argv should be list of unicode strings.")
1198
def main(argv=None):
1199
"""Main entry point of command-line interface.
1201
Typically `bzrlib.initialize` should be called first.
1203
:param argv: list of unicode command-line arguments similar to sys.argv.
1204
argv[0] is script name usually, it will be ignored.
1205
Don't pass here sys.argv because this list contains plain strings
1206
and not unicode; pass None instead.
1208
:return: exit code of bzr command.
1210
if argv is not None:
1212
_register_builtin_commands()
1213
ret = run_bzr_catch_errors(argv)
1214
trace.mutter("return code %d", ret)
1218
def run_bzr_catch_errors(argv):
1219
"""Run a bzr command with parameters as described by argv.
1221
This function assumed that that UI layer is setup, that symbol deprecations
1222
are already applied, and that unicode decoding has already been performed on argv.
1224
# done here so that they're covered for every test run
1225
install_bzr_command_hooks()
1226
return exception_to_return_code(run_bzr, argv)
1229
def run_bzr_catch_user_errors(argv):
1230
"""Run bzr and report user errors, but let internal errors propagate.
1232
This is used for the test suite, and might be useful for other programs
1233
that want to wrap the commandline interface.
1235
# done here so that they're covered for every test run
1236
install_bzr_command_hooks()
1238
return run_bzr(argv)
1239
except Exception, e:
1240
if (isinstance(e, (OSError, IOError))
1241
or not getattr(e, 'internal_error', True)):
1242
trace.report_exception(sys.exc_info(), sys.stderr)
1248
class HelpCommandIndex(object):
1249
"""A index for bzr help that returns commands."""
1252
self.prefix = 'commands/'
1254
def get_topics(self, topic):
1255
"""Search for topic amongst commands.
1257
:param topic: A topic to search for.
1258
:return: A list which is either empty or contains a single
1261
if topic and topic.startswith(self.prefix):
1262
topic = topic[len(self.prefix):]
1264
cmd = _get_cmd_object(topic, check_missing=False)
1271
class Provider(object):
1272
"""Generic class to be overriden by plugins"""
1274
def plugin_for_command(self, cmd_name):
1275
"""Takes a command and returns the information for that plugin
1277
:return: A dictionary with all the available information
1278
for the requested plugin
1280
raise NotImplementedError
1283
class ProvidersRegistry(registry.Registry):
1284
"""This registry exists to allow other providers to exist"""
1287
for key, provider in self.iteritems():
1290
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
