50
160
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
161
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)
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
168
import bzrlib.builtins
169
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
170
builtin_command_registry.register(cmd_class)
171
bzrlib.builtins._register_lazy_builtins()
174
def _scan_module_for_commands(module):
176
for name, obj in module.__dict__.iteritems():
177
if name.startswith("cmd_"):
178
real_name = _unsquish_command_name(name)
183
def _list_bzr_commands(names):
184
"""Find commands from bzr's core and plugins.
186
This is not the public interface, just the default hook called by all_command_names.
188
# to eliminate duplicates
189
names.update(builtin_command_names())
190
names.update(plugin_command_names())
194
def all_command_names():
195
"""Return a set of all command names."""
197
for hook in Command.hooks['list_commands']:
200
raise AssertionError(
201
'hook %s returned None' % Command.hooks.get_hook_name(hook))
205
def builtin_command_names():
206
"""Return list of builtin command names.
208
Use of all_command_names() is encouraged rather than builtin_command_names
209
and/or plugin_command_names.
211
_register_builtin_commands()
212
return builtin_command_registry.keys()
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
217
return plugin_cmds.keys()
220
def get_cmd_object(cmd_name, plugins_override=True):
221
"""Return the command object for a command.
224
If true, plugin commands can override builtins.
227
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
233
"""Get a command object.
235
:param cmd_name: The name of the command.
236
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
239
:return: A Command object instance
240
:raises KeyError: If no command is found.
242
# We want only 'ascii' command names, but the user may have typed
243
# in a Unicode name. In that case, they should just get a
244
# 'command not found' error later.
245
# In the future, we may actually support Unicode command names.
248
for hook in Command.hooks['get_command']:
249
cmd = hook(cmd, cmd_name)
250
if cmd is not None and not plugins_override and not cmd.plugin_name():
251
# We've found a non-plugin command, don't permit it to be
254
if cmd is None and check_missing:
255
for hook in Command.hooks['get_missing_command']:
262
# Allow plugins to extend commands
263
for hook in Command.hooks['extend_command']:
265
if getattr(cmd, 'invoked_as', None) is None:
266
cmd.invoked_as = cmd_name
270
def _try_plugin_provider(cmd_name):
271
"""Probe for a plugin provider having cmd_name."""
273
plugin_metadata, provider = probe_for_provider(cmd_name)
274
raise errors.CommandAvailableInPlugin(cmd_name,
275
plugin_metadata, provider)
276
except errors.NoPluginAvailable:
280
def probe_for_provider(cmd_name):
281
"""Look for a provider for cmd_name.
283
:param cmd_name: The command name.
284
:return: plugin_metadata, provider for getting cmd_name.
285
:raises NoPluginAvailable: When no provider can supply the plugin.
287
# look for providers that provide this command but aren't installed
288
for provider in command_providers_registry:
290
return provider.plugin_for_command(cmd_name), provider
291
except errors.NoPluginAvailable:
293
raise errors.NoPluginAvailable(cmd_name)
296
def _get_bzr_command(cmd_or_None, cmd_name):
297
"""Get a command from bzr's core."""
299
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)
307
def _get_external_command(cmd_or_None, cmd_name):
308
"""Lookup a command that is a shell script."""
309
# Only do external command lookups when no command is found so far.
310
if cmd_or_None is not None:
312
from bzrlib.externalcommand import ExternalCommand
313
cmd_obj = ExternalCommand.find_command(cmd_name)
318
def _get_plugin_command(cmd_or_None, cmd_name):
319
"""Get a command from bzr's plugins."""
155
return cmd, cmds[cmd]
321
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)
324
for key in plugin_cmds.keys():
325
info = plugin_cmds.get_info(key)
326
if cmd_name in info.aliases:
327
return plugin_cmds.get(key)()
171
331
class Command(object):
172
332
"""Base class for commands.
334
Commands are the heart of the command-line bzr interface.
336
The command object mostly handles the mapping of command-line
337
parameters into one or more bzrlib operations, and of the results
340
Commands normally don't have any state. All their arguments are
341
passed in to the run method. (Subclasses may take a different
342
policy if the behaviour of the instance needs to depend on e.g. a
343
shell plugin and not just its Python class.)
174
345
The docstring for an actual command should give a single-line
175
346
summary, then a complete description of the command. A grammar
176
347
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.
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
365
for commands intended for expert users.
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
191
397
takes_options = []
398
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)
405
"""Construct an instance of this command."""
406
# List of standard options directly supported
407
self.supported_std_options = []
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
"""Register a function to call after self.run returns or raises.
413
Functions will be called in LIFO order.
415
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
417
def cleanup_now(self):
418
"""Execute and empty pending cleanup functions immediately.
420
After cleanup_now all registered cleanups are forgotten. add_cleanup
421
may be called again after cleanup_now; these cleanups will be called
422
after self.run returns or raises (or when cleanup_now is next called).
424
This is useful for releasing expensive or contentious resources (such
425
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
430
self._operation.cleanup_now()
433
"""Return single-line grammar for this command.
435
Only describes arguments, not options.
437
s = 'bzr ' + self.name() + ' '
438
for aname in self.takes_args:
439
aname = aname.upper()
440
if aname[-1] in ['$', '+']:
441
aname = aname[:-1] + '...'
442
elif aname[-1] == '?':
443
aname = '[' + aname[:-1] + ']'
444
elif aname[-1] == '*':
445
aname = '[' + aname[:-1] + '...]'
447
s = s[:-1] # remove last space
450
def get_help_text(self, additional_see_also=None, plain=True,
451
see_also_as_links=False, verbose=True):
452
"""Return a text string with help for this command.
454
:param additional_see_also: Additional help topics to be
456
:param plain: if False, raw help (reStructuredText) is
457
returned instead of plain text.
458
:param see_also_as_links: if True, convert items in 'See also'
459
list to internal links (used by bzr_man rstx generator)
460
:param verbose: if True, display the full help, otherwise
461
leave out the descriptive sections and just display
462
usage help (e.g. Purpose, Usage, Options) with a
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
478
# Extract the summary (purpose) and sections out from the text
479
purpose,sections,order = self._get_help_parts(doc)
481
# If a custom usage section was provided, use it
482
if sections.has_key('Usage'):
483
usage = sections.pop('Usage')
485
usage = self._usage()
487
# The header is the purpose and usage
489
result += gettext(':Purpose: %s\n') % (purpose,)
490
if usage.find('\n') >= 0:
491
result += gettext(':Usage:\n%s\n') % (usage,)
493
result += gettext(':Usage: %s\n') % (usage,)
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
510
options = options.replace(' format:\n', ' format::\n\n', 1)
511
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
518
# Add the description, indenting it 2 spaces
519
# to match the indentation of the options
520
if sections.has_key(None):
521
text = sections.pop(None)
522
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
525
# Add the custom sections (e.g. Examples). Note that there's no need
526
# to indent these as they must be indented already in the source.
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
536
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
539
result += ', '.join(self.aliases) + '\n'
540
plugin_name = self.plugin_name()
541
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
543
see_also = self.get_see_also(additional_see_also)
545
if not plain and see_also_as_links:
547
for item in see_also:
549
# topics doesn't have an independent section
550
# so don't create a real link
551
see_also_links.append(item)
553
# Use a Sphinx link for this entry
554
link_text = gettext(":doc:`{0} <{1}-help>`").format(
556
see_also_links.append(link_text)
557
see_also = see_also_links
558
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
560
# If this will be rendered as plain text, convert it
562
import bzrlib.help_topics
563
result = bzrlib.help_topics.help_as_plain_text(result)
567
def _get_help_parts(text):
568
"""Split help text into a summary and named sections.
570
:return: (summary,sections,order) where summary is the top line and
571
sections is a dictionary of the rest indexed by section name.
572
order is the order the section appear in the text.
573
A section starts with a heading line of the form ":xxx:".
574
Indented text on following lines is the section value.
575
All text found outside a named section is assigned to the
576
default section which is given the key of None.
578
def save_section(sections, order, label, section):
580
if sections.has_key(label):
581
sections[label] += '\n' + section
584
sections[label] = section
586
lines = text.rstrip().splitlines()
587
summary = lines.pop(0)
590
label,section = None,''
592
if line.startswith(':') and line.endswith(':') and len(line) > 2:
593
save_section(sections, order, label, section)
594
label,section = line[1:-1],''
595
elif (label is not None) and len(line) > 1 and not line[0].isspace():
596
save_section(sections, order, label, section)
597
label,section = None,line
600
section += '\n' + line
603
save_section(sections, order, label, section)
604
return summary, sections, order
606
def get_help_topic(self):
607
"""Return the commands help topic - its name."""
610
def get_see_also(self, additional_terms=None):
611
"""Return a list of help topics that are related to this command.
613
The list is derived from the content of the _see_also attribute. Any
614
duplicates are removed and the result is in lexical order.
615
:param additional_terms: Additional help topics to cross-reference.
616
:return: A list of help topics.
618
see_also = set(getattr(self, '_see_also', []))
620
see_also.update(additional_terms)
621
return sorted(see_also)
624
"""Return dict of valid options for this command.
626
Maps from long option name to option object."""
627
r = Option.STD_OPTIONS.copy()
629
for o in self.takes_options:
630
if isinstance(o, basestring):
631
o = option.Option.OPTIONS[o]
633
if o.name in std_names:
634
self.supported_std_options.append(o.name)
637
def _setup_outf(self):
638
"""Return a file linked to stdout, which has proper encoding."""
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
642
def run_argv_aliases(self, argv, alias_argv=None):
643
"""Parse the command line and run with extra aliases in alias_argv."""
644
args, opts = parse_args(self, argv, alias_argv)
647
# Process the standard options
648
if 'help' in opts: # e.g. bzr add --help
649
self.outf.write(self.get_help_text())
651
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
654
trace.set_verbosity_level(option._verbosity_level)
655
if 'verbose' in self.supported_std_options:
656
opts['verbose'] = trace.is_verbose()
657
elif opts.has_key('verbose'):
659
if 'quiet' in self.supported_std_options:
660
opts['quiet'] = trace.is_quiet()
661
elif opts.has_key('quiet'):
663
# mix arguments and options into one dictionary
664
cmdargs = _match_argform(self.name(), self.takes_args, args)
666
for k, v in opts.items():
667
cmdopts[k.replace('-', '_')] = v
669
all_cmd_args = cmdargs.copy()
670
all_cmd_args.update(cmdopts)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
682
def _setup_run(self):
683
"""Wrap the defined run method on self with a cleanup.
685
This is called by __init__ to make the Command be able to be run
686
by just calling run(), as it could be before cleanups were added.
688
If a different form of cleanups are in use by your Command subclass,
689
you can override this method.
692
def run(*args, **kwargs):
693
for hook in Command.hooks['pre_command']:
695
self._operation = cleanup.OperationWithCleanups(class_run)
697
return self._operation.run_simple(*args, **kwargs)
700
for hook in Command.hooks['post_command']:
209
"""Override this in sub-classes.
705
"""Actually run the command.
211
707
This is invoked with the options and arguments bound to
212
708
keyword parameters.
214
Return 0 or None if the command was successful, or a shell
710
Return 0 or None if the command was successful, or a non-zero
711
shell error code if not. It's OK for this method to allow
712
an exception to raise up.
714
This method is automatically wrapped by Command.__init__ with a
715
cleanup operation, stored as self._operation. This can be used
716
via self.add_cleanup to perform automatic cleanups at the end of
719
The argument for run are assembled by introspection. So for instance,
720
if your command takes an argument files, you would declare::
722
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()
597
if revision is not None:
598
if len(revision) > 1:
599
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
revno = br_to.lookup_revision(revision[0])
633
br_to.update_revisions(br_from, stop_revision=revno)
634
except NoSuchRevision:
636
msg = "The branch %s has no revision %d." % (from_location,
638
raise BzrCommandError(msg)
640
merge((to_location, -1), (to_location, 0), this_dir=to_location,
641
check_clean=False, ignore_zero=True)
642
from_location = pull_loc(br_from)
643
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
648
def pull_loc(branch):
649
# TODO: Should perhaps just make attribute be 'base' in
650
# RemoteBranch and Branch?
651
if hasattr(branch, "baseurl"):
652
return branch.baseurl
658
class cmd_renames(Command):
659
"""Show list of renamed files.
661
TODO: Option to show renames between two historical versions.
663
TODO: Only show renames under dir, rather than in the whole branch.
665
takes_args = ['dir?']
667
def run(self, dir='.'):
669
old_inv = b.basis_tree().inventory
670
new_inv = b.read_working_inventory()
672
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
674
for old_name, new_name in renames:
675
print "%s => %s" % (old_name, new_name)
678
class cmd_info(Command):
679
"""Show statistical information about a branch."""
680
takes_args = ['branch?']
682
def run(self, branch=None):
685
b = find_branch(branch)
689
class cmd_remove(Command):
690
"""Make a file unversioned.
692
This makes bzr stop tracking changes to a versioned file. It does
693
not delete the working copy.
695
takes_args = ['file+']
696
takes_options = ['verbose']
698
def run(self, file_list, verbose=False):
699
b = find_branch(file_list[0])
700
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
703
class cmd_file_id(Command):
704
"""Print file_id of a particular file or directory.
706
The file_id is assigned when the file is first added and remains the
707
same through all revisions where the file exists, even when it is
711
takes_args = ['filename']
712
def run(self, filename):
713
b = find_branch(filename)
714
i = b.inventory.path2id(b.relpath(filename))
716
raise BzrError("%r is not a versioned file" % filename)
721
class cmd_file_path(Command):
722
"""Print path of file_ids to a file or directory.
724
This prints one line for each directory down to the target,
725
starting at the branch root."""
727
takes_args = ['filename']
728
def run(self, filename):
729
b = find_branch(filename)
731
fid = inv.path2id(b.relpath(filename))
733
raise BzrError("%r is not a versioned file" % filename)
734
for fip in inv.get_idpath(fid):
738
class cmd_revision_history(Command):
739
"""Display list of revision ids on this branch."""
742
for patchid in find_branch('.').revision_history():
746
class cmd_directories(Command):
747
"""Display list of versioned directories in this branch."""
749
for name, ie in find_branch('.').read_working_inventory().directories():
756
class cmd_init(Command):
757
"""Make a directory into a versioned branch.
759
Use this to create an empty branch, or before importing an
762
Recipe for importing a tree of files:
767
bzr commit -m 'imported project'
770
from bzrlib.branch import Branch
771
Branch('.', init=True)
774
class cmd_diff(Command):
775
"""Show differences in working tree.
777
If files are listed, only the changes in those files are listed.
778
Otherwise, all changes for the tree are listed.
780
TODO: Given two revision arguments, show the difference between them.
782
TODO: Allow diff across branches.
784
TODO: Option to use external diff command; could be GNU diff, wdiff,
787
TODO: Python difflib is not exactly the same as unidiff; should
788
either fix it up or prefer to use an external diff.
790
TODO: If a directory is given, diff everything under that.
792
TODO: Selected-file diff is inefficient and doesn't show you
795
TODO: This probably handles non-Unix newlines poorly.
798
takes_args = ['file*']
799
takes_options = ['revision', 'diff-options']
800
aliases = ['di', 'dif']
802
def run(self, revision=None, file_list=None, diff_options=None):
803
from bzrlib.diff import show_diff
806
b = find_branch(file_list[0])
807
file_list = [b.relpath(f) for f in file_list]
808
if file_list == ['']:
809
# just pointing to top-of-tree
814
# TODO: Make show_diff support taking 2 arguments
816
if revision is not None:
817
if len(revision) != 1:
818
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
819
base_rev = revision[0]
821
show_diff(b, base_rev, specific_files=file_list,
822
external_diff_options=diff_options)
828
class cmd_deleted(Command):
829
"""List files deleted in the working tree.
831
TODO: Show files deleted since a previous revision, or between two revisions.
833
def run(self, show_ids=False):
836
new = b.working_tree()
838
## TODO: Much more efficient way to do this: read in new
839
## directories with readdir, rather than stating each one. Same
840
## level of effort but possibly much less IO. (Or possibly not,
841
## if the directories are very large...)
843
for path, ie in old.inventory.iter_entries():
844
if not new.has_id(ie.file_id):
846
print '%-50s %s' % (path, ie.file_id)
851
class cmd_modified(Command):
852
"""List files modified in working tree."""
855
from bzrlib.diff import compare_trees
858
td = compare_trees(b.basis_tree(), b.working_tree())
860
for path, id, kind in td.modified:
865
class cmd_added(Command):
866
"""List files added in working tree."""
870
wt = b.working_tree()
871
basis_inv = b.basis_tree().inventory
874
if file_id in basis_inv:
876
path = inv.id2path(file_id)
877
if not os.access(b.abspath(path), os.F_OK):
883
class cmd_root(Command):
884
"""Show the tree root directory.
886
The root is the nearest enclosing directory with a .bzr control
888
takes_args = ['filename?']
889
def run(self, filename=None):
890
"""Print the branch root."""
891
b = find_branch(filename)
892
print getattr(b, 'base', None) or getattr(b, 'baseurl')
895
class cmd_log(Command):
896
"""Show log of this branch.
898
To request a range of logs, you can use the command -r begin:end
899
-r revision requests a specific revision, -r :end or -r begin: are
902
--message allows you to give a regular expression, which will be evaluated
903
so that only matching entries will be displayed.
905
TODO: Make --revision support uuid: and hash: [future tag:] notation.
909
takes_args = ['filename?']
910
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
912
def run(self, filename=None, timezone='original',
919
from bzrlib.branch import find_branch
920
from bzrlib.log import log_formatter, show_log
923
direction = (forward and 'forward') or 'reverse'
926
b = find_branch(filename)
927
fp = b.relpath(filename)
929
file_id = b.read_working_inventory().path2id(fp)
931
file_id = None # points to branch root
939
elif len(revision) == 1:
940
rev1 = rev2 = b.get_revision_info(revision[0])[0]
941
elif len(revision) == 2:
942
rev1 = b.get_revision_info(revision[0])[0]
943
rev2 = b.get_revision_info(revision[1])[0]
945
raise BzrCommandError('bzr log --revision takes one or two values.')
952
mutter('encoding log as %r' % bzrlib.user_encoding)
954
# use 'replace' so that we don't abort if trying to write out
955
# in e.g. the default C locale.
956
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
962
lf = log_formatter(log_format,
965
show_timezone=timezone)
978
class cmd_touching_revisions(Command):
979
"""Return revision-ids which affected a particular file.
981
A more user-friendly interface is "bzr log FILE"."""
983
takes_args = ["filename"]
984
def run(self, filename):
985
b = find_branch(filename)
986
inv = b.read_working_inventory()
987
file_id = inv.path2id(b.relpath(filename))
988
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
989
print "%6d %s" % (revno, what)
992
class cmd_ls(Command):
993
"""List files in a tree.
995
TODO: Take a revision or remote path and list that tree instead.
998
def run(self, revision=None, verbose=False):
1000
if revision == None:
1001
tree = b.working_tree()
1003
tree = b.revision_tree(b.lookup_revision(revision))
1005
for fp, fc, kind, fid in tree.list_files():
1007
if kind == 'directory':
1009
elif kind == 'file':
1014
print '%-8s %s%s' % (fc, fp, kindch)
1020
class cmd_unknowns(Command):
1021
"""List unknown files."""
1023
from bzrlib.osutils import quotefn
1024
for f in find_branch('.').unknowns():
1029
class cmd_ignore(Command):
1030
"""Ignore a command or pattern.
1032
To remove patterns from the ignore list, edit the .bzrignore file.
1034
If the pattern contains a slash, it is compared to the whole path
1035
from the branch root. Otherwise, it is comapred to only the last
1036
component of the path.
1038
Ignore patterns are case-insensitive on case-insensitive systems.
1040
Note: wildcards must be quoted from the shell on Unix.
1043
bzr ignore ./Makefile
1044
bzr ignore '*.class'
1046
takes_args = ['name_pattern']
1048
def run(self, name_pattern):
1049
from bzrlib.atomicfile import AtomicFile
1052
b = find_branch('.')
1053
ifn = b.abspath('.bzrignore')
1055
if os.path.exists(ifn):
1058
igns = f.read().decode('utf-8')
1064
# TODO: If the file already uses crlf-style termination, maybe
1065
# we should use that for the newly added lines?
1067
if igns and igns[-1] != '\n':
1069
igns += name_pattern + '\n'
1072
f = AtomicFile(ifn, 'wt')
1073
f.write(igns.encode('utf-8'))
1078
inv = b.working_tree().inventory
1079
if inv.path2id('.bzrignore'):
1080
mutter('.bzrignore is already versioned')
1082
mutter('need to make new .bzrignore file versioned')
1083
b.add(['.bzrignore'])
1087
class cmd_ignored(Command):
1088
"""List ignored files and the patterns that matched them.
1090
See also: bzr ignore"""
1092
tree = find_branch('.').working_tree()
1093
for path, file_class, kind, file_id in tree.list_files():
1094
if file_class != 'I':
1096
## XXX: Slightly inefficient since this was already calculated
1097
pat = tree.is_ignored(path)
1098
print '%-50s %s' % (path, pat)
1101
class cmd_lookup_revision(Command):
1102
"""Lookup the revision-id from a revision-number
1105
bzr lookup-revision 33
1108
takes_args = ['revno']
1110
def run(self, revno):
1114
raise BzrCommandError("not a valid revision-number: %r" % revno)
1116
print find_branch('.').lookup_revision(revno)
1119
class cmd_export(Command):
1120
"""Export past revision to destination directory.
1122
If no revision is specified this exports the last committed revision.
1124
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1125
given, try to find the format with the extension. If no extension
1126
is found exports to a directory (equivalent to --format=dir).
1128
Root may be the top directory for tar, tgz and tbz2 formats. If none
1129
is given, the top directory will be the root name of the file."""
1130
# TODO: list known exporters
1131
takes_args = ['dest']
1132
takes_options = ['revision', 'format', 'root']
1133
def run(self, dest, revision=None, format=None, root=None):
1135
b = find_branch('.')
1136
if revision is None:
1137
rev_id = b.last_patch()
1139
if len(revision) != 1:
1140
raise BzrError('bzr export --revision takes exactly 1 argument')
1141
revno, rev_id = b.get_revision_info(revision[0])
1142
t = b.revision_tree(rev_id)
1143
root, ext = os.path.splitext(dest)
1145
if ext in (".tar",):
1147
elif ext in (".gz", ".tgz"):
1149
elif ext in (".bz2", ".tbz2"):
1153
t.export(dest, format, root)
1156
class cmd_cat(Command):
1157
"""Write a file's text from a previous revision."""
1159
takes_options = ['revision']
1160
takes_args = ['filename']
1162
def run(self, filename, revision=None):
1163
if revision == None:
1164
raise BzrCommandError("bzr cat requires a revision number")
1165
elif len(revision) != 1:
1166
raise BzrCommandError("bzr cat --revision takes exactly one number")
1167
b = find_branch('.')
1168
b.print_file(b.relpath(filename), revision[0])
1171
class cmd_local_time_offset(Command):
1172
"""Show the offset in seconds from GMT to local time."""
1175
print bzrlib.osutils.local_time_offset()
1179
class cmd_commit(Command):
1180
"""Commit changes into a new revision.
1182
If selected files are specified, only changes to those files are
1183
committed. If a directory is specified then its contents are also
1186
A selected-file commit may fail in some cases where the committed
1187
tree would be invalid, such as trying to commit a file in a
1188
newly-added directory that is not itself committed.
1190
TODO: Run hooks on tree to-be-committed, and after commit.
1192
TODO: Strict commit that fails if there are unknown or deleted files.
1194
takes_args = ['selected*']
1195
takes_options = ['message', 'file', 'verbose', 'unchanged']
1196
aliases = ['ci', 'checkin']
1198
def run(self, message=None, file=None, verbose=True, selected_list=None,
1200
from bzrlib.errors import PointlessCommit
1201
from bzrlib.osutils import get_text_message
1203
## Warning: shadows builtin file()
1204
if not message and not file:
1207
catcher = cStringIO.StringIO()
1208
sys.stdout = catcher
1209
cmd_status({"file_list":selected_list}, {})
1210
info = catcher.getvalue()
1212
message = get_text_message(info)
1215
raise BzrCommandError("please specify a commit message",
1216
["use either --message or --file"])
1217
elif message and file:
1218
raise BzrCommandError("please specify either --message or --file")
1222
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1224
b = find_branch('.')
1227
b.commit(message, verbose=verbose,
1228
specific_files=selected_list,
1229
allow_pointless=unchanged)
1230
except PointlessCommit:
1231
# FIXME: This should really happen before the file is read in;
1232
# perhaps prepare the commit; get the message; then actually commit
1233
raise BzrCommandError("no changes to commit",
1234
["use --unchanged to commit anyhow"])
1237
class cmd_check(Command):
1238
"""Validate consistency of branch history.
1240
This command checks various invariants about the branch storage to
1241
detect data corruption or bzr bugs.
1243
If given the --update flag, it will update some optional fields
1244
to help ensure data consistency.
1246
takes_args = ['dir?']
1248
def run(self, dir='.'):
1249
from bzrlib.check import check
1250
check(find_branch(dir))
1254
class cmd_upgrade(Command):
1255
"""Upgrade branch storage to current format.
1257
This should normally be used only after the check command tells
1260
takes_args = ['dir?']
1262
def run(self, dir='.'):
1263
from bzrlib.upgrade import upgrade
1264
upgrade(find_branch(dir))
1268
class cmd_whoami(Command):
1269
"""Show bzr user id."""
1270
takes_options = ['email']
1272
def run(self, email=False):
1274
print bzrlib.osutils.user_email()
1276
print bzrlib.osutils.username()
1279
class cmd_selftest(Command):
1280
"""Run internal test suite"""
1283
from bzrlib.selftest import selftest
1284
return int(not selftest())
1287
class cmd_version(Command):
1288
"""Show version of bzr."""
1293
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1294
# is bzrlib itself in a branch?
1295
bzrrev = bzrlib.get_bzr_revision()
1297
print " (bzr checkout, revision %d {%s})" % bzrrev
1298
print bzrlib.__copyright__
1299
print "http://bazaar-ng.org/"
1301
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1302
print "you may use, modify and redistribute it under the terms of the GNU"
1303
print "General Public License version 2 or later."
1306
class cmd_rocks(Command):
1307
"""Statement of optimism."""
1310
print "it sure does!"
1312
def parse_spec(spec):
1314
>>> parse_spec(None)
1316
>>> parse_spec("./")
1318
>>> parse_spec("../@")
1320
>>> parse_spec("../f/@35")
1322
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1323
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1328
parsed = spec.split('/@')
1329
assert len(parsed) == 2
1334
parsed[1] = int(parsed[1])
1336
pass # We can allow stuff like ./@revid:blahblahblah
1338
assert parsed[1] >=0
1340
parsed = [spec, None]
1345
class cmd_merge(Command):
1346
"""Perform a three-way merge of trees.
1348
The SPEC parameters are working tree or revision specifiers. Working trees
1349
are specified using standard paths or urls. No component of a directory
1350
path may begin with '@'.
1352
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1354
Revisions are specified using a dirname/@revno pair, where dirname is the
1355
branch directory and revno is the revision within that branch. If no revno
1356
is specified, the latest revision is used.
1358
Revision examples: './@127', 'foo/@', '../@1'
1360
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1361
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1364
merge refuses to run if there are any uncommitted changes, unless
1367
takes_args = ['other_spec', 'base_spec?']
1368
takes_options = ['force']
1370
def run(self, other_spec, base_spec=None, force=False):
1371
from bzrlib.merge import merge
1372
merge(parse_spec(other_spec), parse_spec(base_spec),
1373
check_clean=(not force))
1377
class cmd_revert(Command):
1378
"""Restore selected files from a previous revision.
1380
takes_args = ['file+']
1381
def run(self, file_list):
1382
from bzrlib.branch import find_branch
1387
b = find_branch(file_list[0])
1389
b.revert([b.relpath(f) for f in file_list])
1392
class cmd_merge_revert(Command):
1393
"""Reverse all changes since the last commit.
1395
Only versioned files are affected.
1397
TODO: Store backups of any files that will be reverted, so
1398
that the revert can be undone.
1400
takes_options = ['revision']
1402
def run(self, revision=None):
1403
from bzrlib.merge import merge
1404
if revision is None:
1406
elif len(revision) != 1:
1407
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1408
merge(('.', revision[0]), parse_spec('.'),
1413
class cmd_assert_fail(Command):
1414
"""Test reporting of assertion failures"""
1417
assert False, "always fails"
1420
class cmd_help(Command):
1421
"""Show help on a command or other topic.
1423
For a list of all available commands, say 'bzr help commands'."""
1424
takes_args = ['topic?']
1427
def run(self, topic=None):
1434
class cmd_plugins(Command):
1438
import bzrlib.plugin
725
raise NotImplementedError('no implementation of command %r'
729
"""Return help message for this class."""
1439
730
from inspect import getdoc
1440
from pprint import pprint
1441
for plugin in bzrlib.plugin.all_plugins:
1442
print plugin.__path__[0]
1445
print '\t', d.split('\n')[0]
1447
#pprint(bzrlib.plugin.all_plugins)
1451
# list of all available options; the rhs can be either None for an
1452
# option that takes no argument, or a constructor function that checks
1456
'diff-options': str,
1465
'revision': _parse_revision_str,
1487
def parse_args(argv):
731
if self.__doc__ is Command.__doc__:
735
def gettext(self, message):
736
"""Returns the gettext function used to translate this command's help.
738
Commands provided by plugins should override this to use their
741
return i18n.gettext_per_paragraph(message)
744
"""Return the canonical name for this command.
746
The name under which it was actually invoked is available in invoked_as.
748
return _unsquish_command_name(self.__class__.__name__)
750
def plugin_name(self):
751
"""Get the name of the plugin that provides this command.
753
:return: The name of the plugin or None if the command is builtin.
755
mod_parts = self.__module__.split('.')
756
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
762
class CommandHooks(Hooks):
763
"""Hooks related to Command object creation/enumeration."""
766
"""Create the default hooks.
768
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
773
"Called after creating a command object to allow modifications "
774
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
777
"Called when creating a single command. Called with "
778
"(cmd_or_None, command_name). get_command should either return "
779
"the cmd_or_None parameter, or a replacement Command object that "
780
"should be used for the command. Note that the Command.hooks "
781
"hooks are core infrastructure. Many users will prefer to use "
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
785
"Called when creating a single command if no command could be "
786
"found. Called with (command_name). get_missing_command should "
787
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
790
"Called when enumerating commands. Called with a set of "
791
"cmd_name strings for all the commands found so far. This set "
792
" is safe to mutate - e.g. to remove a command. "
793
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
802
Command.hooks = CommandHooks()
805
def parse_args(command, argv, alias_argv=None):
1488
806
"""Parse command line.
1490
808
Arguments and options are parsed at this level before being passed
1491
809
down to specific command handlers. This routine knows, from a
1492
810
lookup table, something about the available options, what optargs
1493
811
they take, and which commands will accept them.
1495
>>> parse_args('--help'.split())
1496
([], {'help': True})
1497
>>> parse_args('--version'.split())
1498
([], {'version': True})
1499
>>> parse_args('status --all'.split())
1500
(['status'], {'all': True})
1501
>>> parse_args('commit --message=biter'.split())
1502
(['commit'], {'message': u'biter'})
1503
>>> parse_args('log -r 500'.split())
1504
(['log'], {'revision': [500]})
1505
>>> parse_args('log -r500..600'.split())
1506
(['log'], {'revision': [500, 600]})
1507
>>> parse_args('log -vr500..600'.split())
1508
(['log'], {'verbose': True, 'revision': [500, 600]})
1509
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1510
(['log'], {'revision': ['v500', 600]})
1515
# TODO: Maybe handle '--' to end options?
1520
# option names must not be unicode
1524
mutter(" got option %r" % a)
1526
optname, optarg = a[2:].split('=', 1)
1529
if optname not in OPTIONS:
1530
raise BzrError('unknown long option %r' % a)
1533
if shortopt in SHORT_OPTIONS:
1534
# Multi-character options must have a space to delimit
1536
optname = SHORT_OPTIONS[shortopt]
1538
# Single character short options, can be chained,
1539
# and have their value appended to their name
1541
if shortopt not in SHORT_OPTIONS:
1542
# We didn't find the multi-character name, and we
1543
# didn't find the single char name
1544
raise BzrError('unknown short option %r' % a)
1545
optname = SHORT_OPTIONS[shortopt]
1548
# There are extra things on this option
1549
# see if it is the value, or if it is another
1551
optargfn = OPTIONS[optname]
1552
if optargfn is None:
1553
# This option does not take an argument, so the
1554
# next entry is another short option, pack it back
1556
argv.insert(0, '-' + a[2:])
1558
# This option takes an argument, so pack it
1563
# XXX: Do we ever want to support this, e.g. for -r?
1564
raise BzrError('repeated option %r' % a)
1566
optargfn = OPTIONS[optname]
1570
raise BzrError('option %r needs an argument' % a)
1572
optarg = argv.pop(0)
1573
opts[optname] = optargfn(optarg)
1576
raise BzrError('option %r takes no argument' % optname)
1577
opts[optname] = True
813
# TODO: make it a method of the Command?
814
parser = option.get_optparser(command.options())
815
if alias_argv is not None:
816
args = alias_argv + argv
820
# for python 2.5 and later, optparse raises this exception if a non-ascii
821
# option name is given. See http://bugs.python.org/issue2931
823
options, args = parser.parse_args(args)
824
except UnicodeEncodeError,e:
825
raise errors.BzrCommandError(
826
gettext('Only ASCII permitted in option names'))
828
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
v is not option.OptionParser.DEFAULT_VALUE])
1581
830
return args, opts
1586
833
def _match_argform(cmd, takes_args, args):
1600
847
argdict[argname + '_list'] = None
1601
848
elif ap[-1] == '+':
1603
raise BzrCommandError("command %r needs one or more %s"
1604
% (cmd, argname.upper()))
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
1606
854
argdict[argname + '_list'] = args[:]
1608
856
elif ap[-1] == '$': # all but one
1609
857
if len(args) < 2:
1610
raise BzrCommandError("command %r needs one or more %s"
1611
% (cmd, argname.upper()))
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
1612
861
argdict[argname + '_list'] = args[:-1]
1615
864
# just a plain arg
1618
raise BzrCommandError("command %r requires argument %s"
1619
% (cmd, argname.upper()))
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
1621
871
argdict[argname] = args.pop(0)
1624
raise BzrCommandError("extra argument to command %s: %s"
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
1630
def _parse_master_args(argv):
1631
"""Parse the arguments that always go with the original command.
1632
These are things like bzr --no-plugins, etc.
1634
There are now 2 types of option flags. Ones that come *before* the command,
1635
and ones that come *after* the command.
1636
Ones coming *before* the command are applied against all possible commands.
1637
And are generally applied before plugins are loaded.
1639
The current list are:
1640
--builtin Allow plugins to load, but don't let them override builtin commands,
1641
they will still be allowed if they do not override a builtin.
1642
--no-plugins Don't load any plugins. This lets you get back to official source
1644
--profile Enable the hotspot profile before running the command.
1645
For backwards compatibility, this is also a non-master option.
1646
--version Spit out the version of bzr that is running and exit.
1647
This is also a non-master option.
1648
--help Run help and exit, also a non-master option (I think that should stay, though)
1650
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1651
Traceback (most recent call last):
1653
BzrCommandError: Invalid master option: 'test'
1654
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1657
>>> print opts['version']
1659
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1661
['command', '--more-options']
1662
>>> print opts['profile']
1664
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1667
>>> print opts['no-plugins']
1669
>>> print opts['profile']
1671
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1673
['command', '--profile']
1674
>>> print opts['profile']
1677
master_opts = {'builtin':False,
1684
# This is the point where we could hook into argv[0] to determine
1685
# what front-end is supposed to be run
1686
# For now, we are just ignoring it.
1687
cmd_name = argv.pop(0)
1689
if arg[:2] != '--': # at the first non-option, we return the rest
1691
arg = arg[2:] # Remove '--'
1692
if arg not in master_opts:
1693
# We could say that this is not an error, that we should
1694
# just let it be handled by the main section instead
1695
raise BzrCommandError('Invalid master option: %r' % arg)
1696
argv.pop(0) # We are consuming this entry
1697
master_opts[arg] = True
1698
return argv, master_opts
880
def apply_coveraged(dirname, the_callable, *args, **kwargs):
881
# Cannot use "import trace", as that would import bzrlib.trace instead of
882
# the standard library's trace.
883
trace = __import__('trace')
885
tracer = trace.Trace(count=1, trace=0)
886
sys.settrace(tracer.globaltrace)
887
threading.settrace(tracer.globaltrace)
890
return exception_to_return_code(the_callable, *args, **kwargs)
893
results = tracer.results()
894
results.write_results(show_missing=1, summary=False,
898
def apply_profiled(the_callable, *args, **kwargs):
902
pffileno, pfname = tempfile.mkstemp()
904
prof = hotshot.Profile(pfname)
906
ret = prof.runcall(exception_to_return_code, the_callable, *args,
910
stats = hotshot.stats.load(pfname)
912
stats.sort_stats('cum') # 'time'
913
## XXX: Might like to write to stderr or the trace file instead but
914
## print_stats seems hardcoded to stdout
915
stats.print_stats(20)
922
def exception_to_return_code(the_callable, *args, **kwargs):
923
"""UI level helper for profiling and coverage.
925
This transforms exceptions into a return value of 3. As such its only
926
relevant to the UI layer, and should never be called where catching
927
exceptions may be desirable.
930
return the_callable(*args, **kwargs)
931
except (KeyboardInterrupt, Exception), e:
932
# used to handle AssertionError and KeyboardInterrupt
933
# specially here, but hopefully they're handled ok by the logger now
934
exc_info = sys.exc_info()
935
exitcode = trace.report_exception(exc_info, sys.stderr)
936
if os.environ.get('BZR_PDB'):
937
print '**** entering debugger'
939
pdb.post_mortem(exc_info[2])
943
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
944
from bzrlib.lsprof import profile
945
ret, stats = profile(exception_to_return_code, the_callable,
952
trace.note(gettext('Profile data written to "%s".'), filename)
956
def get_alias(cmd, config=None):
957
"""Return an expanded alias, or None if no alias exists.
960
Command to be checked for an alias.
962
Used to specify an alternative config to use,
963
which is especially useful for testing.
964
If it is unspecified, the global config will be used.
968
config = bzrlib.config.GlobalConfig()
969
alias = config.get_alias(cmd)
971
return cmdline.split(alias)
975
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1703
976
"""Execute a command.
1705
This is similar to main(), but without all the trappings for
1706
logging and error handling.
978
:param argv: The command-line arguments, without the program name from
979
argv[0] These should already be decoded. All library/test code calling
980
run_bzr should be passing valid strings (don't need decoding).
981
:param load_plugins: What function to call when triggering plugin loading.
982
This function should take no arguments and cause all plugins to be
984
:param disable_plugins: What function to call when disabling plugin
985
loading. This function should take no arguments and cause all plugin
986
loading to be prohibited (so that code paths in your application that
987
know about some plugins possibly being present will fail to import
988
those plugins even if they are installed.)
989
:return: Returns a command exit code or raises an exception.
991
Special master options: these must come before the command because
992
they control how the command is interpreted.
995
Do not load plugin modules at all
1001
Only use builtin commands. (Plugins are still allowed to change
1005
Run under the Python hotshot profiler.
1008
Run under the Python lsprof profiler.
1011
Generate line coverage report in the specified directory.
1014
Specify the number of processes that can be run concurrently (selftest).
1708
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1711
# some options like --builtin and --no-plugins have special effects
1712
argv, master_opts = _parse_master_args(argv)
1713
if not master_opts['no-plugins']:
1714
from bzrlib.plugin import load_plugins
1717
args, opts = parse_args(argv)
1719
if master_opts['help']:
1720
from bzrlib.help import help
1728
from bzrlib.help import help
1734
elif 'version' in opts:
1737
elif args and args[0] == 'builtin':
1738
include_plugins=False
1740
cmd = str(args.pop(0))
1747
plugins_override = not (master_opts['builtin'])
1748
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1750
profile = master_opts['profile']
1751
# For backwards compatibility, I would rather stick with --profile being a
1752
# master/global option
1753
if 'profile' in opts:
1757
# check options are reasonable
1758
allowed = cmd_class.takes_options
1760
if oname not in allowed:
1761
raise BzrCommandError("option '--%s' is not allowed for command %r"
1764
# mix arguments and options into one dictionary
1765
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1767
for k, v in opts.items():
1768
cmdopts[k.replace('-', '_')] = v
1771
import hotshot, tempfile
1772
pffileno, pfname = tempfile.mkstemp()
1774
prof = hotshot.Profile(pfname)
1775
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1778
import hotshot.stats
1779
stats = hotshot.stats.load(pfname)
1781
stats.sort_stats('time')
1782
## XXX: Might like to write to stderr or the trace file instead but
1783
## print_stats seems hardcoded to stdout
1784
stats.print_stats(20)
1792
return cmd_class(cmdopts, cmdargs).status
1795
def _report_exception(summary, quiet=False):
1797
log_error('bzr: ' + summary)
1798
bzrlib.trace.log_exception()
1801
tb = sys.exc_info()[2]
1802
exinfo = traceback.extract_tb(tb)
1804
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1805
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1811
bzrlib.trace.open_tracefile(argv)
1816
return run_bzr(argv)
1818
# do this here inside the exception wrappers to catch EPIPE
1821
quiet = isinstance(e, (BzrCommandError))
1822
_report_exception('error: ' + e.args[0], quiet=quiet)
1825
# some explanation or hints
1828
except AssertionError, e:
1829
msg = 'assertion failed'
1831
msg += ': ' + str(e)
1832
_report_exception(msg)
1834
except KeyboardInterrupt, e:
1835
_report_exception('interrupted', quiet=True)
1837
except Exception, e:
1840
if (isinstance(e, IOError)
1841
and hasattr(e, 'errno')
1842
and e.errno == errno.EPIPE):
1846
msg = str(e).rstrip('\n')
1847
_report_exception(msg, quiet)
1016
trace.mutter("bazaar version: " + bzrlib.__version__)
1017
argv = _specified_or_unicode_argv(argv)
1018
trace.mutter("bzr arguments: %r", argv)
1020
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1021
opt_no_l10n = opt_no_aliases = False
1022
opt_lsprof_file = opt_coverage_dir = None
1024
# --no-plugins is handled specially at a very early stage. We need
1025
# to load plugins before doing other command parsing so that they
1026
# can override commands, but this needs to happen first.
1030
override_config = []
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 == '--no-l10n':
1047
elif a == '--builtin':
1049
elif a == '--concurrency':
1050
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1052
elif a == '--coverage':
1053
opt_coverage_dir = argv[i + 1]
1055
elif a == '--profile-imports':
1056
pass # already handled in startup script Bug #588277
1057
elif a.startswith('-D'):
1058
debug.debug_flags.add(a[2:])
1059
elif a.startswith('-O'):
1060
override_config.append(a[2:])
1065
if bzrlib.global_state is None:
1066
# FIXME: Workaround for users that imported bzrlib but didn't call
1067
# bzrlib.initialize -- vila 2012-01-19
1068
cmdline_overrides = config.CommandLineStore()
1070
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1071
cmdline_overrides._from_cmdline(override_config)
1073
debug.set_debug_flags_from_config()
1075
if not opt_no_plugins:
1082
get_cmd_object('help').run_argv_aliases([])
1085
if argv[0] == '--version':
1086
get_cmd_object('version').run_argv_aliases([])
1091
if not opt_no_aliases:
1092
alias_argv = get_alias(argv[0])
1094
argv[0] = alias_argv.pop(0)
1097
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1100
run = cmd_obj.run_argv_aliases
1101
run_argv = [argv, alias_argv]
1104
# We can be called recursively (tests for example), but we don't want
1105
# the verbosity level to propagate.
1106
saved_verbosity_level = option._verbosity_level
1107
option._verbosity_level = 0
1109
if opt_coverage_dir:
1111
'--coverage ignored, because --lsprof is in use.')
1112
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1114
if opt_coverage_dir:
1116
'--coverage ignored, because --profile is in use.')
1117
ret = apply_profiled(run, *run_argv)
1118
elif opt_coverage_dir:
1119
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1121
ret = run(*run_argv)
1850
bzrlib.trace.close_trace()
1853
if __name__ == '__main__':
1854
sys.exit(main(sys.argv))
1124
# reset, in case we may do other commands later within the same
1125
# process. Commands that want to execute sub-commands must propagate
1126
# --verbose in their own way.
1127
if 'memory' in debug.debug_flags:
1128
trace.debug_memory('Process status after command:', short=False)
1129
option._verbosity_level = saved_verbosity_level
1130
# Reset the overrides
1131
cmdline_overrides._reset()
1134
def display_command(func):
1135
"""Decorator that suppresses pipe/interrupt errors."""
1136
def ignore_pipe(*args, **kwargs):
1138
result = func(*args, **kwargs)
1142
if getattr(e, 'errno', None) is None:
1144
if e.errno != errno.EPIPE:
1145
# Win32 raises IOError with errno=0 on a broken pipe
1146
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1149
except KeyboardInterrupt:
1154
def install_bzr_command_hooks():
1155
"""Install the hooks to supply bzr's own commands."""
1156
if _list_bzr_commands in Command.hooks["list_commands"]:
1158
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1160
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1162
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1163
"bzr plugin commands")
1164
Command.hooks.install_named_hook("get_command", _get_external_command,
1165
"bzr external command lookup")
1166
Command.hooks.install_named_hook("get_missing_command",
1167
_try_plugin_provider,
1168
"bzr plugin-provider-db check")
1172
def _specified_or_unicode_argv(argv):
1173
# For internal or testing use, argv can be passed. Otherwise, get it from
1174
# the process arguments in a unicode-safe way.
1176
return osutils.get_unicode_argv()
1180
# ensure all arguments are unicode strings
1182
if isinstance(a, unicode):
1185
new_argv.append(a.decode('ascii'))
1186
except UnicodeDecodeError:
1187
raise errors.BzrError("argv should be list of unicode strings.")
1191
def main(argv=None):
1192
"""Main entry point of command-line interface.
1194
Typically `bzrlib.initialize` should be called first.
1196
:param argv: list of unicode command-line arguments similar to sys.argv.
1197
argv[0] is script name usually, it will be ignored.
1198
Don't pass here sys.argv because this list contains plain strings
1199
and not unicode; pass None instead.
1201
:return: exit code of bzr command.
1203
if argv is not None:
1205
_register_builtin_commands()
1206
ret = run_bzr_catch_errors(argv)
1207
trace.mutter("return code %d", ret)
1211
def run_bzr_catch_errors(argv):
1212
"""Run a bzr command with parameters as described by argv.
1214
This function assumed that that UI layer is setup, that symbol deprecations
1215
are already applied, and that unicode decoding has already been performed on argv.
1217
# done here so that they're covered for every test run
1218
install_bzr_command_hooks()
1219
return exception_to_return_code(run_bzr, argv)
1222
def run_bzr_catch_user_errors(argv):
1223
"""Run bzr and report user errors, but let internal errors propagate.
1225
This is used for the test suite, and might be useful for other programs
1226
that want to wrap the commandline interface.
1228
# done here so that they're covered for every test run
1229
install_bzr_command_hooks()
1231
return run_bzr(argv)
1232
except Exception, e:
1233
if (isinstance(e, (OSError, IOError))
1234
or not getattr(e, 'internal_error', True)):
1235
trace.report_exception(sys.exc_info(), sys.stderr)
1241
class HelpCommandIndex(object):
1242
"""A index for bzr help that returns commands."""
1245
self.prefix = 'commands/'
1247
def get_topics(self, topic):
1248
"""Search for topic amongst commands.
1250
:param topic: A topic to search for.
1251
:return: A list which is either empty or contains a single
1254
if topic and topic.startswith(self.prefix):
1255
topic = topic[len(self.prefix):]
1257
cmd = _get_cmd_object(topic, check_missing=False)
1264
class Provider(object):
1265
"""Generic class to be overriden by plugins"""
1267
def plugin_for_command(self, cmd_name):
1268
"""Takes a command and returns the information for that plugin
1270
:return: A dictionary with all the available information
1271
for the requested plugin
1273
raise NotImplementedError
1276
class ProvidersRegistry(registry.Registry):
1277
"""This registry exists to allow other providers to exist"""
1280
for key, provider in self.iteritems():
1283
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
