33
135
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
35
136
return cmd[4:].replace('_','-')
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
145
for k, v in globals().iteritems():
146
if k.startswith("cmd_"):
147
d[_unsquish_command_name(k)] = v
149
d.update(_find_plugins())
152
def get_all_cmds(include_plugins=True):
153
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
139
def _builtin_commands():
140
import bzrlib.builtins
141
return _scan_module_for_commands(bzrlib.builtins)
144
def _scan_module_for_commands(module):
146
for name, obj in module.__dict__.iteritems():
147
if name.startswith("cmd_"):
148
real_name = _unsquish_command_name(name)
153
def _list_bzr_commands(names):
154
"""Find commands from bzr's core and plugins."""
155
# to eliminate duplicates
156
names.update(builtin_command_names())
157
names.update(plugin_command_names())
161
def all_command_names():
162
"""Return a set of all command names."""
164
for hook in Command.hooks['list_commands']:
167
raise AssertionError(
168
'hook %s returned None' % Command.hooks.get_hook_name(hook))
172
def builtin_command_names():
173
"""Return list of builtin command names.
175
Use of all_command_names() is encouraged rather than builtin_command_names
176
and/or plugin_command_names.
178
return _builtin_commands().keys()
181
def plugin_command_names():
182
"""Returns command names from commands registered by plugins."""
183
return plugin_cmds.keys()
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
196
d = _builtin_commands()
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
158
def get_cmd_class(cmd,include_plugins=True):
159
"""Return the canonical name and command class for a command.
161
cmd = str(cmd) # not unicode
163
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
166
return cmd, cmds[cmd]
203
def get_cmd_object(cmd_name, plugins_override=True):
204
"""Return the command object for a command.
207
If true, plugin commands can override builtins.
210
return _get_cmd_object(cmd_name, plugins_override)
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
def _get_cmd_object(cmd_name, plugins_override=True):
216
"""Get a command object.
218
:param cmd_name: The name of the command.
219
:param plugins_override: Allow plugins to override builtins.
220
:return: A Command object instance
221
:raises KeyError: If no command is found.
223
# We want only 'ascii' command names, but the user may have typed
224
# in a Unicode name. In that case, they should just get a
225
# 'command not found' error later.
226
# In the future, we may actually support Unicode command names.
229
for hook in Command.hooks['get_command']:
230
cmd = hook(cmd, cmd_name)
231
if cmd is not None and not plugins_override and not cmd.plugin_name():
232
# We've found a non-plugin command, don't permit it to be
236
for hook in Command.hooks['get_missing_command']:
243
# Allow plugins to extend commands
244
for hook in Command.hooks['extend_command']:
249
def _try_plugin_provider(cmd_name):
250
"""Probe for a plugin provider having cmd_name."""
252
plugin_metadata, provider = probe_for_provider(cmd_name)
253
raise errors.CommandAvailableInPlugin(cmd_name,
254
plugin_metadata, provider)
255
except errors.NoPluginAvailable:
259
def probe_for_provider(cmd_name):
260
"""Look for a provider for cmd_name.
262
:param cmd_name: The command name.
263
:return: plugin_metadata, provider for getting cmd_name.
264
:raises NoPluginAvailable: When no provider can supply the plugin.
266
# look for providers that provide this command but aren't installed
267
for provider in command_providers_registry:
269
return provider.plugin_for_command(cmd_name), provider
270
except errors.NoPluginAvailable:
272
raise errors.NoPluginAvailable(cmd_name)
275
def _get_bzr_command(cmd_or_None, cmd_name):
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
279
return cmds[cmd_name]()
170
282
# look for any command which claims this as an alias
171
for cmdname, cmdclass in cmds.iteritems():
172
if cmd in cmdclass.aliases:
173
return cmdname, cmdclass
175
cmdclass = ExternalCommand.find_command(cmd)
179
raise BzrCommandError("unknown command %r" % cmd)
283
for real_cmd_name, cmd_class in cmds.iteritems():
284
if cmd_name in cmd_class.aliases:
289
def _get_external_command(cmd_or_None, cmd_name):
290
"""Lookup a command that is a shell script."""
291
# Only do external command lookups when no command is found so far.
292
if cmd_or_None is not None:
294
from bzrlib.externalcommand import ExternalCommand
295
cmd_obj = ExternalCommand.find_command(cmd_name)
300
def _get_plugin_command(cmd_or_None, cmd_name):
301
"""Get a command from bzr's plugins."""
303
return plugin_cmds.get(cmd_name)()
306
for key in plugin_cmds.keys():
307
info = plugin_cmds.get_info(key)
308
if cmd_name in info.aliases:
309
return plugin_cmds.get(key)()
182
313
class Command(object):
183
314
"""Base class for commands.
316
Commands are the heart of the command-line bzr interface.
318
The command object mostly handles the mapping of command-line
319
parameters into one or more bzrlib operations, and of the results
322
Commands normally don't have any state. All their arguments are
323
passed in to the run method. (Subclasses may take a different
324
policy if the behaviour of the instance needs to depend on e.g. a
325
shell plugin and not just its Python class.)
185
327
The docstring for an actual command should give a single-line
186
328
summary, then a complete description of the command. A grammar
187
329
description will be inserted.
332
Other accepted names for this command.
190
335
List of argument forms, marked with whether they are optional,
340
['to_location', 'from_branch?', 'file*']
342
'to_location' is required
343
'from_branch' is optional
344
'file' can be specified 0 or more times
194
List of options that may be given for this command.
347
List of options that may be given for this command. These can
348
be either strings, referring to globally-defined options,
349
or option objects. Retrieve through options().
197
If true, this command isn't advertised.
352
If true, this command isn't advertised. This is typically
353
for commands intended for expert users.
356
Command objects will get a 'outf' attribute, which has been
357
setup to properly handle encoding of unicode strings.
358
encoding_type determines what will happen when characters cannot
360
strict - abort if we cannot decode
361
replace - put in a bogus character (typically '?')
362
exact - do not encode sys.stdout
364
NOTE: by default on Windows, sys.stdout is opened as a text
365
stream, therefore LF line-endings are converted to CRLF.
366
When a command uses encoding_type = 'exact', then
367
sys.stdout is forced to be a binary stream, and line-endings
370
:cvar hooks: An instance of CommandHooks.
202
374
takes_options = []
375
encoding_type = 'strict'
206
def __init__(self, options, arguments):
207
"""Construct and run the command.
209
Sets self.status to the return value of run()."""
210
assert isinstance(options, dict)
211
assert isinstance(arguments, dict)
212
cmdargs = options.copy()
213
cmdargs.update(arguments)
214
assert self.__doc__ != Command.__doc__, \
215
("No help message set for %r" % self)
216
self.status = self.run(**cmdargs)
380
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
383
# List of standard options directly supported
384
self.supported_std_options = []
386
def _maybe_expand_globs(self, file_list):
387
"""Glob expand file_list if the platform does not do that itself.
389
:return: A possibly empty list of unicode paths.
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
400
"""Return single-line grammar for this command.
402
Only describes arguments, not options.
404
s = 'bzr ' + self.name() + ' '
405
for aname in self.takes_args:
406
aname = aname.upper()
407
if aname[-1] in ['$', '+']:
408
aname = aname[:-1] + '...'
409
elif aname[-1] == '?':
410
aname = '[' + aname[:-1] + ']'
411
elif aname[-1] == '*':
412
aname = '[' + aname[:-1] + '...]'
414
s = s[:-1] # remove last space
417
def get_help_text(self, additional_see_also=None, plain=True,
418
see_also_as_links=False, verbose=True):
419
"""Return a text string with help for this command.
421
:param additional_see_also: Additional help topics to be
423
:param plain: if False, raw help (reStructuredText) is
424
returned instead of plain text.
425
:param see_also_as_links: if True, convert items in 'See also'
426
list to internal links (used by bzr_man rstx generator)
427
:param verbose: if True, display the full help, otherwise
428
leave out the descriptive sections and just display
429
usage help (e.g. Purpose, Usage, Options) with a
430
message explaining how to obtain full help.
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
436
# Extract the summary (purpose) and sections out from the text
437
purpose,sections,order = self._get_help_parts(doc)
439
# If a custom usage section was provided, use it
440
if sections.has_key('Usage'):
441
usage = sections.pop('Usage')
443
usage = self._usage()
445
# The header is the purpose and usage
447
result += ':Purpose: %s\n' % purpose
448
if usage.find('\n') >= 0:
449
result += ':Usage:\n%s\n' % usage
451
result += ':Usage: %s\n' % usage
456
# XXX: optparse implicitly rewraps the help, and not always perfectly,
457
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
options = option.get_optparser(self.options()).format_option_help()
460
if options.startswith('Options:'):
461
result += ':' + options
462
elif options.startswith('options:'):
463
# Python 2.4 version of optparse
464
result += ':Options:' + options[len('options:'):]
470
# Add the description, indenting it 2 spaces
471
# to match the indentation of the options
472
if sections.has_key(None):
473
text = sections.pop(None)
474
text = '\n '.join(text.splitlines())
475
result += ':%s:\n %s\n\n' % ('Description',text)
477
# Add the custom sections (e.g. Examples). Note that there's no need
478
# to indent these as they must be indented already in the source.
481
if sections.has_key(label):
482
result += ':%s:\n%s\n' % (label,sections[label])
485
result += ("See bzr help %s for more details and examples.\n\n"
488
# Add the aliases, source (plug-in) and see also links, if any
490
result += ':Aliases: '
491
result += ', '.join(self.aliases) + '\n'
492
plugin_name = self.plugin_name()
493
if plugin_name is not None:
494
result += ':From: plugin "%s"\n' % plugin_name
495
see_also = self.get_see_also(additional_see_also)
497
if not plain and see_also_as_links:
499
for item in see_also:
501
# topics doesn't have an independent section
502
# so don't create a real link
503
see_also_links.append(item)
505
# Use a reST link for this entry
506
see_also_links.append("`%s`_" % (item,))
507
see_also = see_also_links
508
result += ':See also: '
509
result += ', '.join(see_also) + '\n'
511
# If this will be rendered as plain text, convert it
513
import bzrlib.help_topics
514
result = bzrlib.help_topics.help_as_plain_text(result)
518
def _get_help_parts(text):
519
"""Split help text into a summary and named sections.
521
:return: (summary,sections,order) where summary is the top line and
522
sections is a dictionary of the rest indexed by section name.
523
order is the order the section appear in the text.
524
A section starts with a heading line of the form ":xxx:".
525
Indented text on following lines is the section value.
526
All text found outside a named section is assigned to the
527
default section which is given the key of None.
529
def save_section(sections, order, label, section):
531
if sections.has_key(label):
532
sections[label] += '\n' + section
535
sections[label] = section
537
lines = text.rstrip().splitlines()
538
summary = lines.pop(0)
541
label,section = None,''
543
if line.startswith(':') and line.endswith(':') and len(line) > 2:
544
save_section(sections, order, label, section)
545
label,section = line[1:-1],''
546
elif (label is not None) and len(line) > 1 and not line[0].isspace():
547
save_section(sections, order, label, section)
548
label,section = None,line
551
section += '\n' + line
554
save_section(sections, order, label, section)
555
return summary, sections, order
557
def get_help_topic(self):
558
"""Return the commands help topic - its name."""
561
def get_see_also(self, additional_terms=None):
562
"""Return a list of help topics that are related to this command.
564
The list is derived from the content of the _see_also attribute. Any
565
duplicates are removed and the result is in lexical order.
566
:param additional_terms: Additional help topics to cross-reference.
567
:return: A list of help topics.
569
see_also = set(getattr(self, '_see_also', []))
571
see_also.update(additional_terms)
572
return sorted(see_also)
575
"""Return dict of valid options for this command.
577
Maps from long option name to option object."""
578
r = Option.STD_OPTIONS.copy()
580
for o in self.takes_options:
581
if isinstance(o, basestring):
582
o = option.Option.OPTIONS[o]
584
if o.name in std_names:
585
self.supported_std_options.append(o.name)
588
def _setup_outf(self):
589
"""Return a file linked to stdout, which has proper encoding."""
590
# Originally I was using self.stdout, but that looks
591
# *way* too much like sys.stdout
592
if self.encoding_type == 'exact':
593
# force sys.stdout to be binary stream on win32
594
if sys.platform == 'win32':
595
fileno = getattr(sys.stdout, 'fileno', None)
598
msvcrt.setmode(fileno(), os.O_BINARY)
599
self.outf = sys.stdout
602
output_encoding = osutils.get_terminal_encoding()
604
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
605
errors=self.encoding_type)
606
# For whatever reason codecs.getwriter() does not advertise its encoding
607
# it just returns the encoding of the wrapped file, which is completely
608
# bogus. So set the attribute, so we can find the correct encoding later.
609
self.outf.encoding = output_encoding
611
def run_argv_aliases(self, argv, alias_argv=None):
612
"""Parse the command line and run with extra aliases in alias_argv."""
614
warn("Passing None for [] is deprecated from bzrlib 0.10",
615
DeprecationWarning, stacklevel=2)
617
args, opts = parse_args(self, argv, alias_argv)
619
# Process the standard options
620
if 'help' in opts: # e.g. bzr add --help
621
sys.stdout.write(self.get_help_text())
623
if 'usage' in opts: # e.g. bzr add --usage
624
sys.stdout.write(self.get_help_text(verbose=False))
626
trace.set_verbosity_level(option._verbosity_level)
627
if 'verbose' in self.supported_std_options:
628
opts['verbose'] = trace.is_verbose()
629
elif opts.has_key('verbose'):
631
if 'quiet' in self.supported_std_options:
632
opts['quiet'] = trace.is_quiet()
633
elif opts.has_key('quiet'):
636
# mix arguments and options into one dictionary
637
cmdargs = _match_argform(self.name(), self.takes_args, args)
639
for k, v in opts.items():
640
cmdopts[k.replace('-', '_')] = v
642
all_cmd_args = cmdargs.copy()
643
all_cmd_args.update(cmdopts)
647
return self.run(**all_cmd_args)
220
"""Override this in sub-classes.
650
"""Actually run the command.
222
652
This is invoked with the options and arguments bound to
223
653
keyword parameters.
225
Return 0 or None if the command was successful, or a shell
231
class ExternalCommand(Command):
232
"""Class to wrap external commands.
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
246
def find_command(cls, cmd):
248
bzrpath = os.environ.get('BZRPATH', '')
250
for dir in bzrpath.split(os.pathsep):
251
path = os.path.join(dir, cmd)
252
if os.path.isfile(path):
253
return ExternalCommand(path)
257
find_command = classmethod(find_command)
259
def __init__(self, path):
262
pipe = os.popen('%s --bzr-usage' % path, 'r')
263
self.takes_options = pipe.readline().split()
265
for opt in self.takes_options:
266
if not opt in OPTIONS:
267
bailout("Unknown option '%s' returned by external command %s"
270
# TODO: Is there any way to check takes_args is valid here?
271
self.takes_args = pipe.readline().split()
273
if pipe.close() is not None:
274
bailout("Failed funning '%s --bzr-usage'" % path)
276
pipe = os.popen('%s --bzr-help' % path, 'r')
277
self.__doc__ = pipe.read()
278
if pipe.close() is not None:
279
bailout("Failed funning '%s --bzr-help'" % path)
281
def __call__(self, options, arguments):
282
Command.__init__(self, options, arguments)
285
def run(self, **kargs):
292
optname = name.replace('_','-')
294
if OPTIONS.has_key(optname):
296
opts.append('--%s' % optname)
297
if value is not None and value is not True:
298
opts.append(str(value))
300
# it's an arg, or arg list
301
if type(value) is not list:
307
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
311
class cmd_status(Command):
312
"""Display status summary.
314
This reports on versioned and unknown files, reporting them
315
grouped by state. Possible states are:
318
Versioned in the working copy but not in the previous revision.
321
Versioned in the previous revision but removed or deleted
325
Path of this file changed from the previous revision;
326
the text may also have changed. This includes files whose
327
parent directory was renamed.
330
Text has changed since the previous revision.
333
Nothing about this file has changed since the previous revision.
334
Only shown with --all.
337
Not versioned and not matching an ignore pattern.
339
To see ignored files use 'bzr ignored'. For details in the
340
changes to file texts, use 'bzr diff'.
342
If no arguments are specified, the status of the entire working
343
directory is shown. Otherwise, only the status of the specified
344
files or directories is reported. If a directory is given, status
345
is reported for everything inside that directory.
347
takes_args = ['file*']
348
takes_options = ['all', 'show-ids']
349
aliases = ['st', 'stat']
351
def run(self, all=False, show_ids=False, file_list=None):
353
b = Branch(file_list[0])
354
file_list = [b.relpath(x) for x in file_list]
355
# special case: only one path was given and it's the root
357
if file_list == ['']:
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
366
class cmd_cat_revision(Command):
367
"""Write out metadata for a revision."""
370
takes_args = ['revision_id']
372
def run(self, revision_id):
373
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
376
class cmd_revno(Command):
377
"""Show current revision number.
379
This is equal to the number of revisions on this branch."""
381
print Branch('.').revno()
384
class cmd_add(Command):
385
"""Add specified files or directories.
387
In non-recursive mode, all the named items are added, regardless
388
of whether they were previously ignored. A warning is given if
389
any of the named files are already versioned.
391
In recursive mode (the default), files are treated the same way
392
but the behaviour for directories is different. Directories that
393
are already versioned do not give a warning. All directories,
394
whether already versioned or not, are searched for files or
395
subdirectories that are neither versioned or ignored, and these
396
are added. This search proceeds recursively into versioned
399
Therefore simply saying 'bzr add .' will version all files that
400
are currently unknown.
402
TODO: Perhaps adding a file whose directly is not versioned should
403
recursively add that parent, rather than giving an error?
405
takes_args = ['file+']
406
takes_options = ['verbose', 'no-recurse']
408
def run(self, file_list, verbose=False, no_recurse=False):
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
412
class cmd_relpath(Command):
413
"""Show path of a file relative to root"""
414
takes_args = ['filename']
417
def run(self, filename):
418
print Branch(filename).relpath(filename)
422
class cmd_inventory(Command):
423
"""Show inventory of the current working copy or a revision."""
424
takes_options = ['revision', 'show-ids']
426
def run(self, revision=None, show_ids=False):
429
inv = b.read_working_inventory()
431
inv = b.get_revision_inventory(b.lookup_revision(revision))
433
for path, entry in inv.entries():
435
print '%-50s %s' % (path, entry.file_id)
440
class cmd_move(Command):
441
"""Move files to a different directory.
446
The destination must be a versioned directory in the same branch.
448
takes_args = ['source$', 'dest']
449
def run(self, source_list, dest):
452
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
455
class cmd_rename(Command):
456
"""Change the name of an entry.
459
bzr rename frob.c frobber.c
460
bzr rename src/frob.c lib/frob.c
462
It is an error if the destination name exists.
464
See also the 'move' command, which moves files into a different
465
directory without changing their name.
467
TODO: Some way to rename multiple files without invoking bzr for each
469
takes_args = ['from_name', 'to_name']
471
def run(self, from_name, to_name):
473
b.rename_one(b.relpath(from_name), b.relpath(to_name))
479
class cmd_pull(Command):
480
"""Pull any changes from another branch into the current one.
482
If the location is omitted, the last-used location will be used.
483
Both the revision history and the working directory will be
486
This command only works on branches that have not diverged. Branches are
487
considered diverged if both branches have had commits without first
488
pulling from the other.
490
If branches have diverged, you can use 'bzr merge' to pull the text changes
491
from one into the other.
493
takes_args = ['location?']
495
def run(self, location=None):
496
from bzrlib.merge import merge
502
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
504
if errno == errno.ENOENT:
507
location = stored_loc
509
raise BzrCommandError("No pull location known or specified.")
510
from branch import find_branch, DivergedBranches
511
br_from = find_branch(location)
512
location = pull_loc(br_from)
513
old_revno = br_to.revno()
515
br_to.update_revisions(br_from)
516
except DivergedBranches:
517
raise BzrCommandError("These branches have diverged. Try merge.")
519
merge(('.', -1), ('.', old_revno), check_clean=False)
520
if location != stored_loc:
521
br_to.controlfile("x-pull", "wb").write(location + "\n")
525
class cmd_branch(Command):
526
"""Create a new copy of a branch.
528
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
529
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
531
To retrieve the branch as of a particular revision, supply the --revision
532
parameter, as in "branch foo/bar -r 5".
534
takes_args = ['from_location', 'to_location?']
535
takes_options = ['revision']
537
def run(self, from_location, to_location=None, revision=None):
539
from bzrlib.merge import merge
540
from branch import find_branch, DivergedBranches, NoSuchRevision
541
from shutil import rmtree
543
br_from = find_branch(from_location)
545
if e.errno == errno.ENOENT:
546
raise BzrCommandError('Source location "%s" does not exist.' %
551
if to_location is None:
552
to_location = os.path.basename(from_location.rstrip("/\\"))
555
os.mkdir(to_location)
557
if e.errno == errno.EEXIST:
558
raise BzrCommandError('Target directory "%s" already exists.' %
560
if e.errno == errno.ENOENT:
561
raise BzrCommandError('Parent of "%s" does not exist.' %
565
br_to = Branch(to_location, init=True)
568
br_to.update_revisions(br_from, stop_revision=revision)
569
except NoSuchRevision:
571
msg = "The branch %s has no revision %d." % (from_location,
573
raise BzrCommandError(msg)
574
merge((to_location, -1), (to_location, 0), this_dir=to_location,
576
from_location = pull_loc(br_from)
577
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
580
def pull_loc(branch):
581
# TODO: Should perhaps just make attribute be 'base' in
582
# RemoteBranch and Branch?
583
if hasattr(branch, "baseurl"):
584
return branch.baseurl
590
class cmd_renames(Command):
591
"""Show list of renamed files.
593
TODO: Option to show renames between two historical versions.
595
TODO: Only show renames under dir, rather than in the whole branch.
597
takes_args = ['dir?']
599
def run(self, dir='.'):
601
old_inv = b.basis_tree().inventory
602
new_inv = b.read_working_inventory()
604
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
606
for old_name, new_name in renames:
607
print "%s => %s" % (old_name, new_name)
610
class cmd_info(Command):
611
"""Show statistical information about a branch."""
612
takes_args = ['branch?']
614
def run(self, branch=None):
617
from branch import find_branch
618
b = find_branch(branch)
622
class cmd_remove(Command):
623
"""Make a file unversioned.
625
This makes bzr stop tracking changes to a versioned file. It does
626
not delete the working copy.
628
takes_args = ['file+']
629
takes_options = ['verbose']
631
def run(self, file_list, verbose=False):
632
b = Branch(file_list[0])
633
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
636
class cmd_file_id(Command):
637
"""Print file_id of a particular file or directory.
639
The file_id is assigned when the file is first added and remains the
640
same through all revisions where the file exists, even when it is
644
takes_args = ['filename']
645
def run(self, filename):
647
i = b.inventory.path2id(b.relpath(filename))
649
bailout("%r is not a versioned file" % filename)
654
class cmd_file_path(Command):
655
"""Print path of file_ids to a file or directory.
657
This prints one line for each directory down to the target,
658
starting at the branch root."""
660
takes_args = ['filename']
661
def run(self, filename):
664
fid = inv.path2id(b.relpath(filename))
666
bailout("%r is not a versioned file" % filename)
667
for fip in inv.get_idpath(fid):
671
class cmd_revision_history(Command):
672
"""Display list of revision ids on this branch."""
675
for patchid in Branch('.').revision_history():
679
class cmd_directories(Command):
680
"""Display list of versioned directories in this branch."""
682
for name, ie in Branch('.').read_working_inventory().directories():
689
class cmd_init(Command):
690
"""Make a directory into a versioned branch.
692
Use this to create an empty branch, or before importing an
695
Recipe for importing a tree of files:
700
bzr commit -m 'imported project'
703
Branch('.', init=True)
706
class cmd_diff(Command):
707
"""Show differences in working tree.
709
If files are listed, only the changes in those files are listed.
710
Otherwise, all changes for the tree are listed.
712
TODO: Given two revision arguments, show the difference between them.
714
TODO: Allow diff across branches.
716
TODO: Option to use external diff command; could be GNU diff, wdiff,
719
TODO: Python difflib is not exactly the same as unidiff; should
720
either fix it up or prefer to use an external diff.
722
TODO: If a directory is given, diff everything under that.
724
TODO: Selected-file diff is inefficient and doesn't show you
727
TODO: This probably handles non-Unix newlines poorly.
730
takes_args = ['file*']
731
takes_options = ['revision', 'diff-options']
732
aliases = ['di', 'dif']
734
def run(self, revision=None, file_list=None, diff_options=None):
735
from bzrlib.diff import show_diff
736
from bzrlib import find_branch
739
b = find_branch(file_list[0])
740
file_list = [b.relpath(f) for f in file_list]
741
if file_list == ['']:
742
# just pointing to top-of-tree
747
show_diff(b, revision, specific_files=file_list,
748
external_diff_options=diff_options)
754
class cmd_deleted(Command):
755
"""List files deleted in the working tree.
757
TODO: Show files deleted since a previous revision, or between two revisions.
759
def run(self, show_ids=False):
762
new = b.working_tree()
764
## TODO: Much more efficient way to do this: read in new
765
## directories with readdir, rather than stating each one. Same
766
## level of effort but possibly much less IO. (Or possibly not,
767
## if the directories are very large...)
769
for path, ie in old.inventory.iter_entries():
770
if not new.has_id(ie.file_id):
772
print '%-50s %s' % (path, ie.file_id)
777
class cmd_modified(Command):
778
"""List files modified in working tree."""
783
inv = b.read_working_inventory()
784
sc = statcache.update_cache(b, inv)
785
basis = b.basis_tree()
786
basis_inv = basis.inventory
788
# We used to do this through iter_entries(), but that's slow
789
# when most of the files are unmodified, as is usually the
790
# case. So instead we iterate by inventory entry, and only
791
# calculate paths as necessary.
793
for file_id in basis_inv:
794
cacheentry = sc.get(file_id)
795
if not cacheentry: # deleted
797
ie = basis_inv[file_id]
798
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
799
path = inv.id2path(file_id)
804
class cmd_added(Command):
805
"""List files added in working tree."""
809
wt = b.working_tree()
810
basis_inv = b.basis_tree().inventory
813
if file_id in basis_inv:
815
path = inv.id2path(file_id)
816
if not os.access(b.abspath(path), os.F_OK):
822
class cmd_root(Command):
823
"""Show the tree root directory.
825
The root is the nearest enclosing directory with a .bzr control
827
takes_args = ['filename?']
828
def run(self, filename=None):
829
"""Print the branch root."""
830
from branch import find_branch
831
b = find_branch(filename)
832
print getattr(b, 'base', None) or getattr(b, 'baseurl')
835
class cmd_log(Command):
836
"""Show log of this branch.
838
To request a range of logs, you can use the command -r begin:end
839
-r revision requests a specific revision, -r :end or -r begin: are
842
TODO: Make --revision support uuid: and hash: [future tag:] notation.
846
takes_args = ['filename?']
847
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
849
def run(self, filename=None, timezone='original',
854
from bzrlib import show_log, find_branch
857
direction = (forward and 'forward') or 'reverse'
860
b = find_branch(filename)
861
fp = b.relpath(filename)
863
file_id = b.read_working_inventory().path2id(fp)
865
file_id = None # points to branch root
871
revision = [None, None]
872
elif isinstance(revision, int):
873
revision = [revision, revision]
878
assert len(revision) == 2
880
mutter('encoding log as %r' % bzrlib.user_encoding)
882
# use 'replace' so that we don't abort if trying to write out
883
# in e.g. the default C locale.
884
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
887
show_timezone=timezone,
892
start_revision=revision[0],
893
end_revision=revision[1])
897
class cmd_touching_revisions(Command):
898
"""Return revision-ids which affected a particular file.
900
A more user-friendly interface is "bzr log FILE"."""
902
takes_args = ["filename"]
903
def run(self, filename):
905
inv = b.read_working_inventory()
906
file_id = inv.path2id(b.relpath(filename))
907
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
908
print "%6d %s" % (revno, what)
911
class cmd_ls(Command):
912
"""List files in a tree.
914
TODO: Take a revision or remote path and list that tree instead.
917
def run(self, revision=None, verbose=False):
920
tree = b.working_tree()
922
tree = b.revision_tree(b.lookup_revision(revision))
924
for fp, fc, kind, fid in tree.list_files():
926
if kind == 'directory':
933
print '%-8s %s%s' % (fc, fp, kindch)
939
class cmd_unknowns(Command):
940
"""List unknown files."""
942
for f in Branch('.').unknowns():
947
class cmd_ignore(Command):
948
"""Ignore a command or pattern.
950
To remove patterns from the ignore list, edit the .bzrignore file.
952
If the pattern contains a slash, it is compared to the whole path
953
from the branch root. Otherwise, it is comapred to only the last
954
component of the path.
956
Ignore patterns are case-insensitive on case-insensitive systems.
958
Note: wildcards must be quoted from the shell on Unix.
961
bzr ignore ./Makefile
964
takes_args = ['name_pattern']
966
def run(self, name_pattern):
967
from bzrlib.atomicfile import AtomicFile
971
ifn = b.abspath('.bzrignore')
973
if os.path.exists(ifn):
976
igns = f.read().decode('utf-8')
982
# TODO: If the file already uses crlf-style termination, maybe
983
# we should use that for the newly added lines?
985
if igns and igns[-1] != '\n':
987
igns += name_pattern + '\n'
990
f = AtomicFile(ifn, 'wt')
991
f.write(igns.encode('utf-8'))
996
inv = b.working_tree().inventory
997
if inv.path2id('.bzrignore'):
998
mutter('.bzrignore is already versioned')
1000
mutter('need to make new .bzrignore file versioned')
1001
b.add(['.bzrignore'])
1005
class cmd_ignored(Command):
1006
"""List ignored files and the patterns that matched them.
1008
See also: bzr ignore"""
1010
tree = Branch('.').working_tree()
1011
for path, file_class, kind, file_id in tree.list_files():
1012
if file_class != 'I':
1014
## XXX: Slightly inefficient since this was already calculated
1015
pat = tree.is_ignored(path)
1016
print '%-50s %s' % (path, pat)
1019
class cmd_lookup_revision(Command):
1020
"""Lookup the revision-id from a revision-number
1023
bzr lookup-revision 33
1026
takes_args = ['revno']
1028
def run(self, revno):
1032
raise BzrCommandError("not a valid revision-number: %r" % revno)
1034
print Branch('.').lookup_revision(revno)
1037
class cmd_export(Command):
1038
"""Export past revision to destination directory.
1040
If no revision is specified this exports the last committed revision.
1042
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1043
given, exports to a directory (equivalent to --format=dir)."""
1044
# TODO: list known exporters
1045
takes_args = ['dest']
1046
takes_options = ['revision', 'format']
1047
def run(self, dest, revision=None, format='dir'):
1049
if revision == None:
1050
rh = b.revision_history()[-1]
1052
rh = b.lookup_revision(int(revision))
1053
t = b.revision_tree(rh)
1054
t.export(dest, format)
1057
class cmd_cat(Command):
1058
"""Write a file's text from a previous revision."""
1060
takes_options = ['revision']
1061
takes_args = ['filename']
1063
def run(self, filename, revision=None):
1064
if revision == None:
1065
raise BzrCommandError("bzr cat requires a revision number")
1067
b.print_file(b.relpath(filename), int(revision))
1070
class cmd_local_time_offset(Command):
1071
"""Show the offset in seconds from GMT to local time."""
1074
print bzrlib.osutils.local_time_offset()
1078
class cmd_commit(Command):
1079
"""Commit changes into a new revision.
1081
If selected files are specified, only changes to those files are
1082
committed. If a directory is specified then its contents are also
1085
A selected-file commit may fail in some cases where the committed
1086
tree would be invalid, such as trying to commit a file in a
1087
newly-added directory that is not itself committed.
1089
TODO: Run hooks on tree to-be-committed, and after commit.
1091
TODO: Strict commit that fails if there are unknown or deleted files.
1093
takes_args = ['selected*']
1094
takes_options = ['message', 'file', 'verbose']
1095
aliases = ['ci', 'checkin']
1097
def run(self, message=None, file=None, verbose=True, selected_list=None):
1098
from bzrlib.commit import commit
1100
## Warning: shadows builtin file()
1101
if not message and not file:
1102
raise BzrCommandError("please specify a commit message",
1103
["use either --message or --file"])
1104
elif message and file:
1105
raise BzrCommandError("please specify either --message or --file")
1109
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1112
commit(b, message, verbose=verbose, specific_files=selected_list)
1115
class cmd_check(Command):
1116
"""Validate consistency of branch history.
1118
This command checks various invariants about the branch storage to
1119
detect data corruption or bzr bugs.
1121
If given the --update flag, it will update some optional fields
1122
to help ensure data consistency.
1124
takes_args = ['dir?']
1125
takes_options = ['update']
1127
def run(self, dir='.', update=False):
1129
bzrlib.check.check(Branch(dir), update=update)
1133
class cmd_whoami(Command):
1134
"""Show bzr user id."""
1135
takes_options = ['email']
1137
def run(self, email=False):
1139
print bzrlib.osutils.user_email()
1141
print bzrlib.osutils.username()
1144
class cmd_selftest(Command):
1145
"""Run internal test suite"""
1148
from bzrlib.selftest import selftest
1156
class cmd_version(Command):
1157
"""Show version of bzr."""
1162
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1163
# is bzrlib itself in a branch?
1164
bzrrev = bzrlib.get_bzr_revision()
1166
print " (bzr checkout, revision %d {%s})" % bzrrev
1167
print bzrlib.__copyright__
1168
print "http://bazaar-ng.org/"
1170
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1171
print "you may use, modify and redistribute it under the terms of the GNU"
1172
print "General Public License version 2 or later."
1175
class cmd_rocks(Command):
1176
"""Statement of optimism."""
1179
print "it sure does!"
1181
def parse_spec(spec):
1183
>>> parse_spec(None)
1185
>>> parse_spec("./")
1187
>>> parse_spec("../@")
1189
>>> parse_spec("../f/@35")
1195
parsed = spec.split('/@')
1196
assert len(parsed) == 2
1200
parsed[1] = int(parsed[1])
1201
assert parsed[1] >=0
1203
parsed = [spec, None]
1208
class cmd_merge(Command):
1209
"""Perform a three-way merge of trees.
1211
The SPEC parameters are working tree or revision specifiers. Working trees
1212
are specified using standard paths or urls. No component of a directory
1213
path may begin with '@'.
1215
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1217
Revisions are specified using a dirname/@revno pair, where dirname is the
1218
branch directory and revno is the revision within that branch. If no revno
1219
is specified, the latest revision is used.
1221
Revision examples: './@127', 'foo/@', '../@1'
1223
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1224
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1227
merge refuses to run if there are any uncommitted changes, unless
1230
takes_args = ['other_spec', 'base_spec?']
1231
takes_options = ['force']
1233
def run(self, other_spec, base_spec=None, force=False):
1234
from bzrlib.merge import merge
1235
merge(parse_spec(other_spec), parse_spec(base_spec),
1236
check_clean=(not force))
1239
class cmd_revert(Command):
1240
"""Reverse all changes since the last commit.
1242
Only versioned files are affected.
1244
TODO: Store backups of any files that will be reverted, so
1245
that the revert can be undone.
1247
takes_options = ['revision']
1249
def run(self, revision=-1):
1250
from bzrlib.merge import merge
1251
merge(('.', revision), parse_spec('.'),
1256
class cmd_assert_fail(Command):
1257
"""Test reporting of assertion failures"""
1260
assert False, "always fails"
1263
class cmd_help(Command):
1264
"""Show help on a command or other topic.
1266
For a list of all available commands, say 'bzr help commands'."""
1267
takes_args = ['topic?']
1270
def run(self, topic=None):
1275
class cmd_update_stat_cache(Command):
1276
"""Update stat-cache mapping inodes to SHA-1 hashes.
1278
For testing only."""
1283
statcache.update_cache(b.base, b.read_working_inventory())
1287
# list of all available options; the rhs can be either None for an
1288
# option that takes no argument, or a constructor function that checks
1292
'diff-options': str,
1301
'revision': _parse_revision_str,
1319
def parse_args(argv):
655
Return 0 or None if the command was successful, or a non-zero
656
shell error code if not. It's OK for this method to allow
657
an exception to raise up.
659
raise NotImplementedError('no implementation of command %r'
663
"""Return help message for this class."""
664
from inspect import getdoc
665
if self.__doc__ is Command.__doc__:
670
return _unsquish_command_name(self.__class__.__name__)
672
def plugin_name(self):
673
"""Get the name of the plugin that provides this command.
675
:return: The name of the plugin or None if the command is builtin.
677
mod_parts = self.__module__.split('.')
678
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
684
class CommandHooks(Hooks):
685
"""Hooks related to Command object creation/enumeration."""
688
"""Create the default hooks.
690
These are all empty initially, because by default nothing should get
694
self.create_hook(HookPoint('extend_command',
695
"Called after creating a command object to allow modifications "
696
"such as adding or removing options, docs etc. Called with the "
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
699
"Called when creating a single command. Called with "
700
"(cmd_or_None, command_name). get_command should either return "
701
"the cmd_or_None parameter, or a replacement Command object that "
702
"should be used for the command. Note that the Command.hooks "
703
"hooks are core infrastructure. Many users will prefer to use "
704
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
706
self.create_hook(HookPoint('get_missing_command',
707
"Called when creating a single command if no command could be "
708
"found. Called with (command_name). get_missing_command should "
709
"either return None, or a Command object to be used for the "
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
712
"Called when enumerating commands. Called with a set of "
713
"cmd_name strings for all the commands found so far. This set "
714
" is safe to mutate - e.g. to remove a command. "
715
"list_commands should return the updated set of command names.",
718
Command.hooks = CommandHooks()
721
def parse_args(command, argv, alias_argv=None):
1320
722
"""Parse command line.
1322
724
Arguments and options are parsed at this level before being passed
1323
725
down to specific command handlers. This routine knows, from a
1324
726
lookup table, something about the available options, what optargs
1325
727
they take, and which commands will accept them.
1327
>>> parse_args('--help'.split())
1328
([], {'help': True})
1329
>>> parse_args('--version'.split())
1330
([], {'version': True})
1331
>>> parse_args('status --all'.split())
1332
(['status'], {'all': True})
1333
>>> parse_args('commit --message=biter'.split())
1334
(['commit'], {'message': u'biter'})
1335
>>> parse_args('log -r 500'.split())
1336
(['log'], {'revision': 500})
1337
>>> parse_args('log -r500:600'.split())
1338
(['log'], {'revision': [500, 600]})
1339
>>> parse_args('log -vr500:600'.split())
1340
(['log'], {'verbose': True, 'revision': [500, 600]})
1341
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1342
Traceback (most recent call last):
1344
ValueError: invalid literal for int(): v500
1349
# TODO: Maybe handle '--' to end options?
1354
# option names must not be unicode
1358
mutter(" got option %r" % a)
1360
optname, optarg = a[2:].split('=', 1)
1363
if optname not in OPTIONS:
1364
bailout('unknown long option %r' % a)
1367
if shortopt in SHORT_OPTIONS:
1368
# Multi-character options must have a space to delimit
1370
optname = SHORT_OPTIONS[shortopt]
1372
# Single character short options, can be chained,
1373
# and have their value appended to their name
1375
if shortopt not in SHORT_OPTIONS:
1376
# We didn't find the multi-character name, and we
1377
# didn't find the single char name
1378
bailout('unknown short option %r' % a)
1379
optname = SHORT_OPTIONS[shortopt]
1382
# There are extra things on this option
1383
# see if it is the value, or if it is another
1385
optargfn = OPTIONS[optname]
1386
if optargfn is None:
1387
# This option does not take an argument, so the
1388
# next entry is another short option, pack it back
1390
argv.insert(0, '-' + a[2:])
1392
# This option takes an argument, so pack it
1397
# XXX: Do we ever want to support this, e.g. for -r?
1398
bailout('repeated option %r' % a)
1400
optargfn = OPTIONS[optname]
1404
bailout('option %r needs an argument' % a)
1406
optarg = argv.pop(0)
1407
opts[optname] = optargfn(optarg)
1410
bailout('option %r takes no argument' % optname)
1411
opts[optname] = True
729
# TODO: make it a method of the Command?
730
parser = option.get_optparser(command.options())
731
if alias_argv is not None:
732
args = alias_argv + argv
736
options, args = parser.parse_args(args)
737
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
738
v is not option.OptionParser.DEFAULT_VALUE])
1415
739
return args, opts
1420
742
def _match_argform(cmd, takes_args, args):
1434
756
argdict[argname + '_list'] = None
1435
757
elif ap[-1] == '+':
1437
raise BzrCommandError("command %r needs one or more %s"
1438
% (cmd, argname.upper()))
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
1440
762
argdict[argname + '_list'] = args[:]
1442
764
elif ap[-1] == '$': # all but one
1443
765
if len(args) < 2:
1444
raise BzrCommandError("command %r needs one or more %s"
1445
% (cmd, argname.upper()))
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
1446
768
argdict[argname + '_list'] = args[:-1]
1449
771
# just a plain arg
1452
raise BzrCommandError("command %r requires argument %s"
1453
% (cmd, argname.upper()))
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
1455
777
argdict[argname] = args.pop(0)
1458
raise BzrCommandError("extra argument to command %s: %s"
780
raise errors.BzrCommandError("extra argument to command %s: %s"
785
def apply_coveraged(dirname, the_callable, *args, **kwargs):
786
# Cannot use "import trace", as that would import bzrlib.trace instead of
787
# the standard library's trace.
788
trace = __import__('trace')
790
tracer = trace.Trace(count=1, trace=0)
791
sys.settrace(tracer.globaltrace)
792
threading.settrace(tracer.globaltrace)
795
return exception_to_return_code(the_callable, *args, **kwargs)
798
results = tracer.results()
799
results.write_results(show_missing=1, summary=False,
803
def apply_profiled(the_callable, *args, **kwargs):
807
pffileno, pfname = tempfile.mkstemp()
809
prof = hotshot.Profile(pfname)
811
ret = prof.runcall(exception_to_return_code, the_callable, *args,
815
stats = hotshot.stats.load(pfname)
817
stats.sort_stats('cum') # 'time'
818
## XXX: Might like to write to stderr or the trace file instead but
819
## print_stats seems hardcoded to stdout
820
stats.print_stats(20)
827
def exception_to_return_code(the_callable, *args, **kwargs):
828
"""UI level helper for profiling and coverage.
830
This transforms exceptions into a return value of 3. As such its only
831
relevant to the UI layer, and should never be called where catching
832
exceptions may be desirable.
835
return the_callable(*args, **kwargs)
836
except (KeyboardInterrupt, Exception), e:
837
# used to handle AssertionError and KeyboardInterrupt
838
# specially here, but hopefully they're handled ok by the logger now
839
exc_info = sys.exc_info()
840
exitcode = trace.report_exception(exc_info, sys.stderr)
841
if os.environ.get('BZR_PDB'):
842
print '**** entering debugger'
845
if sys.version_info[:2] < (2, 6):
847
# pdb.post_mortem(tb)
848
# but because pdb.post_mortem gives bad results for tracebacks
849
# from inside generators, we do it manually.
850
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
852
# Setup pdb on the traceback
855
p.setup(tb.tb_frame, tb)
856
# Point the debugger at the deepest frame of the stack
857
p.curindex = len(p.stack) - 1
858
p.curframe = p.stack[p.curindex][0]
859
# Start the pdb prompt.
860
p.print_stack_entry(p.stack[p.curindex])
868
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
869
from bzrlib.lsprof import profile
870
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
876
trace.note('Profile data written to "%s".', filename)
880
def shlex_split_unicode(unsplit):
882
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
885
def get_alias(cmd, config=None):
886
"""Return an expanded alias, or None if no alias exists.
889
Command to be checked for an alias.
891
Used to specify an alternative config to use,
892
which is especially useful for testing.
893
If it is unspecified, the global config will be used.
897
config = bzrlib.config.GlobalConfig()
898
alias = config.get_alias(cmd)
900
return shlex_split_unicode(alias)
1465
904
def run_bzr(argv):
1466
905
"""Execute a command.
1468
This is similar to main(), but without all the trappings for
1469
logging and error handling.
908
The command-line arguments, without the program name from argv[0]
909
These should already be decoded. All library/test code calling
910
run_bzr should be passing valid strings (don't need decoding).
912
Returns a command status or raises an exception.
914
Special master options: these must come before the command because
915
they control how the command is interpreted.
918
Do not load plugin modules at all
924
Only use builtin commands. (Plugins are still allowed to change
928
Run under the Python hotshot profiler.
931
Run under the Python lsprof profiler.
934
Generate line coverage report in the specified directory.
1471
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1473
include_plugins=True
1475
args, opts = parse_args(argv[1:])
1483
elif 'version' in opts:
1486
elif args and args[0] == 'builtin':
1487
include_plugins=False
1489
cmd = str(args.pop(0))
1496
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1499
if 'profile' in opts:
1505
# check options are reasonable
1506
allowed = cmd_class.takes_options
1508
if oname not in allowed:
1509
raise BzrCommandError("option '--%s' is not allowed for command %r"
1512
# mix arguments and options into one dictionary
1513
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1515
for k, v in opts.items():
1516
cmdopts[k.replace('-', '_')] = v
1519
import hotshot, tempfile
1520
pffileno, pfname = tempfile.mkstemp()
1522
prof = hotshot.Profile(pfname)
1523
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1526
import hotshot.stats
1527
stats = hotshot.stats.load(pfname)
1529
stats.sort_stats('time')
1530
## XXX: Might like to write to stderr or the trace file instead but
1531
## print_stats seems hardcoded to stdout
1532
stats.print_stats(20)
1540
return cmd_class(cmdopts, cmdargs).status
1543
def _report_exception(summary, quiet=False):
1545
log_error('bzr: ' + summary)
1546
bzrlib.trace.log_exception()
1549
tb = sys.exc_info()[2]
1550
exinfo = traceback.extract_tb(tb)
1552
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1553
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1560
bzrlib.open_tracefile(argv)
1565
return run_bzr(argv)
1567
# do this here inside the exception wrappers to catch EPIPE
1570
quiet = isinstance(e, (BzrCommandError))
1571
_report_exception('error: ' + e.args[0], quiet=quiet)
1574
# some explanation or hints
1577
except AssertionError, e:
1578
msg = 'assertion failed'
1580
msg += ': ' + str(e)
1581
_report_exception(msg)
1583
except KeyboardInterrupt, e:
1584
_report_exception('interrupted', quiet=True)
1586
except Exception, e:
1588
if (isinstance(e, IOError)
1589
and hasattr(e, 'errno')
1590
and e.errno == errno.EPIPE):
1594
msg = str(e).rstrip('\n')
1595
_report_exception(msg, quiet)
937
trace.mutter("bzr arguments: %r", argv)
939
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
940
opt_no_aliases = False
941
opt_lsprof_file = opt_coverage_dir = None
943
# --no-plugins is handled specially at a very early stage. We need
944
# to load plugins before doing other command parsing so that they
945
# can override commands, but this needs to happen first.
953
elif a == '--lsprof':
955
elif a == '--lsprof-file':
957
opt_lsprof_file = argv[i + 1]
959
elif a == '--no-plugins':
960
opt_no_plugins = True
961
elif a == '--no-aliases':
962
opt_no_aliases = True
963
elif a == '--builtin':
965
elif a == '--coverage':
966
opt_coverage_dir = argv[i + 1]
968
elif a.startswith('-D'):
969
debug.debug_flags.add(a[2:])
974
debug.set_debug_flags_from_config()
978
from bzrlib.builtins import cmd_help
979
cmd_help().run_argv_aliases([])
982
if argv[0] == '--version':
983
from bzrlib.builtins import cmd_version
984
cmd_version().run_argv_aliases([])
987
if not opt_no_plugins:
988
from bzrlib.plugin import load_plugins
991
from bzrlib.plugin import disable_plugins
996
if not opt_no_aliases:
997
alias_argv = get_alias(argv[0])
999
user_encoding = osutils.get_user_encoding()
1000
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1001
argv[0] = alias_argv.pop(0)
1004
# We want only 'ascii' command names, but the user may have typed
1005
# in a Unicode name. In that case, they should just get a
1006
# 'command not found' error later.
1008
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1009
run = cmd_obj.run_argv_aliases
1010
run_argv = [argv, alias_argv]
1013
# We can be called recursively (tests for example), but we don't want
1014
# the verbosity level to propagate.
1015
saved_verbosity_level = option._verbosity_level
1016
option._verbosity_level = 0
1018
if opt_coverage_dir:
1020
'--coverage ignored, because --lsprof is in use.')
1021
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1023
if opt_coverage_dir:
1025
'--coverage ignored, because --profile is in use.')
1026
ret = apply_profiled(run, *run_argv)
1027
elif opt_coverage_dir:
1028
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1030
ret = run(*run_argv)
1031
if 'memory' in debug.debug_flags:
1032
trace.debug_memory('Process status after command:', short=False)
1598
bzrlib.trace.close_trace()
1035
# reset, in case we may do other commands later within the same
1036
# process. Commands that want to execute sub-commands must propagate
1037
# --verbose in their own way.
1038
option._verbosity_level = saved_verbosity_level
1041
def display_command(func):
1042
"""Decorator that suppresses pipe/interrupt errors."""
1043
def ignore_pipe(*args, **kwargs):
1045
result = func(*args, **kwargs)
1049
if getattr(e, 'errno', None) is None:
1051
if e.errno != errno.EPIPE:
1052
# Win32 raises IOError with errno=0 on a broken pipe
1053
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1056
except KeyboardInterrupt:
1061
def install_bzr_command_hooks():
1062
"""Install the hooks to supply bzr's own commands."""
1063
if _list_bzr_commands in Command.hooks["list_commands"]:
1065
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1067
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1069
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1070
"bzr plugin commands")
1071
Command.hooks.install_named_hook("get_command", _get_external_command,
1072
"bzr external command lookup")
1073
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1074
"bzr plugin-provider-db check")
1077
def main(argv=None):
1078
"""Main entry point of command-line interface.
1080
:param argv: list of unicode command-line arguments similar to sys.argv.
1081
argv[0] is script name usually, it will be ignored.
1082
Don't pass here sys.argv because this list contains plain strings
1083
and not unicode; pass None instead.
1085
:return: exit code of bzr command.
1088
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1089
sys.stdin, sys.stdout, sys.stderr)
1091
# Is this a final release version? If so, we should suppress warnings
1092
if bzrlib.version_info[3] == 'final':
1093
suppress_deprecation_warnings(override=False)
1095
argv = osutils.get_unicode_argv()
1099
# ensure all arguments are unicode strings
1101
if isinstance(a, unicode):
1104
new_argv.append(a.decode('ascii'))
1105
except UnicodeDecodeError:
1106
raise errors.BzrError("argv should be list of unicode strings.")
1108
ret = run_bzr_catch_errors(argv)
1109
trace.mutter("return code %d", ret)
1113
def run_bzr_catch_errors(argv):
1114
"""Run a bzr command with parameters as described by argv.
1116
This function assumed that that UI layer is setup, that symbol deprecations
1117
are already applied, and that unicode decoding has already been performed on argv.
1119
install_bzr_command_hooks()
1120
return exception_to_return_code(run_bzr, argv)
1123
def run_bzr_catch_user_errors(argv):
1124
"""Run bzr and report user errors, but let internal errors propagate.
1126
This is used for the test suite, and might be useful for other programs
1127
that want to wrap the commandline interface.
1129
install_bzr_command_hooks()
1131
return run_bzr(argv)
1132
except Exception, e:
1133
if (isinstance(e, (OSError, IOError))
1134
or not getattr(e, 'internal_error', True)):
1135
trace.report_exception(sys.exc_info(), sys.stderr)
1141
class HelpCommandIndex(object):
1142
"""A index for bzr help that returns commands."""
1145
self.prefix = 'commands/'
1147
def get_topics(self, topic):
1148
"""Search for topic amongst commands.
1150
:param topic: A topic to search for.
1151
:return: A list which is either empty or contains a single
1154
if topic and topic.startswith(self.prefix):
1155
topic = topic[len(self.prefix):]
1157
cmd = _get_cmd_object(topic)
1164
class Provider(object):
1165
'''Generic class to be overriden by plugins'''
1167
def plugin_for_command(self, cmd_name):
1168
'''Takes a command and returns the information for that plugin
1170
:return: A dictionary with all the available information
1171
for the requested plugin
1173
raise NotImplementedError
1176
class ProvidersRegistry(registry.Registry):
1177
'''This registry exists to allow other providers to exist'''
1180
for key, provider in self.iteritems():
1183
command_providers_registry = ProvidersRegistry()
1601
1186
if __name__ == '__main__':
added
removed
bzrlib/commands.py
