36
135
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
38
136
return cmd[4:].replace('_','-')
41
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
47
"""Return the canonical name and command class for a command.
49
cmd = str(cmd) # not unicode
51
# first look up this command under the specified name
53
return cmd, globals()[_squish_command_name(cmd)]
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():
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]()
57
282
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
62
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)()
313
class Command(object):
66
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.)
68
327
The docstring for an actual command should give a single-line
69
328
summary, then a complete description of the command. A grammar
70
329
description will be inserted.
332
Other accepted names for this command.
73
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
77
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().
80
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.
85
374
takes_options = []
375
encoding_type = 'strict'
89
def __init__(self, options, arguments):
90
"""Construct and run the command.
92
Sets self.status to the return value of run()."""
93
assert isinstance(options, dict)
94
assert isinstance(arguments, dict)
95
cmdargs = options.copy()
96
cmdargs.update(arguments)
97
assert self.__doc__ != Command.__doc__, \
98
("No help message set for %r" % self)
99
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)
103
"""Override this in sub-classes.
650
"""Actually run the command.
105
652
This is invoked with the options and arguments bound to
106
653
keyword parameters.
108
Return 0 or None if the command was successful, or a shell
115
class cmd_status(Command):
116
"""Display status summary.
118
For each file there is a single line giving its file state and name.
119
The name is that in the current revision unless it is deleted or
120
missing, in which case the old name is shown.
122
takes_options = ['all']
123
aliases = ['st', 'stat']
125
def run(self, all=False):
126
#import bzrlib.status
127
#bzrlib.status.tree_status(Branch('.'))
128
Branch('.').show_status(show_all=all)
131
class cmd_cat_revision(Command):
132
"""Write out metadata for a revision."""
135
takes_args = ['revision_id']
137
def run(self, revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
141
class cmd_revno(Command):
142
"""Show current revision number.
144
This is equal to the number of revisions on this branch."""
146
print Branch('.').revno()
149
class cmd_add(Command):
150
"""Add specified files or directories.
152
In non-recursive mode, all the named items are added, regardless
153
of whether they were previously ignored. A warning is given if
154
any of the named files are already versioned.
156
In recursive mode (the default), files are treated the same way
157
but the behaviour for directories is different. Directories that
158
are already versioned do not give a warning. All directories,
159
whether already versioned or not, are searched for files or
160
subdirectories that are neither versioned or ignored, and these
161
are added. This search proceeds recursively into versioned
164
Therefore simply saying 'bzr add .' will version all files that
165
are currently unknown.
167
TODO: Perhaps adding a file whose directly is not versioned should
168
recursively add that parent, rather than giving an error?
170
takes_args = ['file+']
171
takes_options = ['verbose']
173
def run(self, file_list, verbose=False):
174
bzrlib.add.smart_add(file_list, verbose)
177
class cmd_relpath(Command):
178
"""Show path of a file relative to root"""
179
takes_args = ['filename']
181
def run(self, filename):
182
print Branch(filename).relpath(filename)
186
class cmd_inventory(Command):
187
"""Show inventory of the current working copy or a revision."""
188
takes_options = ['revision']
190
def run(self, revision=None):
193
inv = b.read_working_inventory()
195
inv = b.get_revision_inventory(b.lookup_revision(revision))
197
for path, entry in inv.iter_entries():
198
print '%-50s %s' % (entry.file_id, path)
201
class cmd_move(Command):
202
"""Move files to a different directory.
207
The destination must be a versioned directory in the same branch.
209
takes_args = ['source$', 'dest']
210
def run(self, source_list, dest):
213
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
216
class cmd_rename(Command):
217
"""Change the name of an entry.
220
bzr rename frob.c frobber.c
221
bzr rename src/frob.c lib/frob.c
223
It is an error if the destination name exists.
225
See also the 'move' command, which moves files into a different
226
directory without changing their name.
228
TODO: Some way to rename multiple files without invoking bzr for each
230
takes_args = ['from_name', 'to_name']
232
def run(self, from_name, to_name):
234
b.rename_one(b.relpath(from_name), b.relpath(to_name))
238
class cmd_renames(Command):
239
"""Show list of renamed files.
241
TODO: Option to show renames between two historical versions.
243
TODO: Only show renames under dir, rather than in the whole branch.
245
takes_args = ['dir?']
247
def run(self, dir='.'):
249
old_inv = b.basis_tree().inventory
250
new_inv = b.read_working_inventory()
252
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
254
for old_name, new_name in renames:
255
print "%s => %s" % (old_name, new_name)
258
class cmd_info(Command):
259
"""Show statistical information for this branch"""
262
info.show_info(Branch('.'))
265
class cmd_remove(Command):
266
"""Make a file unversioned.
268
This makes bzr stop tracking changes to a versioned file. It does
269
not delete the working copy.
271
takes_args = ['file+']
272
takes_options = ['verbose']
274
def run(self, file_list, verbose=False):
275
b = Branch(file_list[0])
276
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
279
class cmd_file_id(Command):
280
"""Print file_id of a particular file or directory.
282
The file_id is assigned when the file is first added and remains the
283
same through all revisions where the file exists, even when it is
287
takes_args = ['filename']
288
def run(self, filename):
290
i = b.inventory.path2id(b.relpath(filename))
292
bailout("%r is not a versioned file" % filename)
297
class cmd_file_path(Command):
298
"""Print path of file_ids to a file or directory.
300
This prints one line for each directory down to the target,
301
starting at the branch root."""
303
takes_args = ['filename']
304
def run(self, filename):
307
fid = inv.path2id(b.relpath(filename))
309
bailout("%r is not a versioned file" % filename)
310
for fip in inv.get_idpath(fid):
314
class cmd_revision_history(Command):
315
"""Display list of revision ids on this branch."""
317
for patchid in Branch('.').revision_history():
321
class cmd_directories(Command):
322
"""Display list of versioned directories in this branch."""
324
for name, ie in Branch('.').read_working_inventory().directories():
331
class cmd_init(Command):
332
"""Make a directory into a versioned branch.
334
Use this to create an empty branch, or before importing an
337
Recipe for importing a tree of files:
342
bzr commit -m 'imported project'
345
Branch('.', init=True)
348
class cmd_diff(Command):
349
"""Show differences in working tree.
351
If files are listed, only the changes in those files are listed.
352
Otherwise, all changes for the tree are listed.
354
TODO: Given two revision arguments, show the difference between them.
356
TODO: Allow diff across branches.
358
TODO: Option to use external diff command; could be GNU diff, wdiff,
361
TODO: Python difflib is not exactly the same as unidiff; should
362
either fix it up or prefer to use an external diff.
364
TODO: If a directory is given, diff everything under that.
366
TODO: Selected-file diff is inefficient and doesn't show you
369
TODO: This probably handles non-Unix newlines poorly.
372
takes_args = ['file*']
373
takes_options = ['revision']
376
def run(self, revision=None, file_list=None):
377
from bzrlib.diff import show_diff
379
show_diff(Branch('.'), revision, file_list)
382
class cmd_deleted(Command):
383
"""List files deleted in the working tree.
385
TODO: Show files deleted since a previous revision, or between two revisions.
387
def run(self, show_ids=False):
390
new = b.working_tree()
392
## TODO: Much more efficient way to do this: read in new
393
## directories with readdir, rather than stating each one. Same
394
## level of effort but possibly much less IO. (Or possibly not,
395
## if the directories are very large...)
397
for path, ie in old.inventory.iter_entries():
398
if not new.has_id(ie.file_id):
400
print '%-50s %s' % (path, ie.file_id)
404
class cmd_root(Command):
405
"""Show the tree root directory.
407
The root is the nearest enclosing directory with a .bzr control
409
takes_args = ['filename?']
410
def run(self, filename=None):
411
"""Print the branch root."""
412
print bzrlib.branch.find_branch_root(filename)
416
class cmd_log(Command):
417
"""Show log of this branch.
419
TODO: Option to limit range.
421
TODO: Perhaps show most-recent first with an option for last.
423
takes_args = ['filename?']
424
takes_options = ['timezone', 'verbose', 'show-ids']
425
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
426
b = Branch((filename or '.'), lock_mode='r')
428
filename = b.relpath(filename)
429
bzrlib.show_log(b, filename,
430
show_timezone=timezone,
436
class cmd_touching_revisions(Command):
437
"""Return revision-ids which affected a particular file."""
439
takes_args = ["filename"]
440
def run(self, filename):
441
b = Branch(filename, lock_mode='r')
442
inv = b.read_working_inventory()
443
file_id = inv.path2id(b.relpath(filename))
444
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
445
print "%6d %s" % (revno, what)
448
class cmd_ls(Command):
449
"""List files in a tree.
451
TODO: Take a revision or remote path and list that tree instead.
454
def run(self, revision=None, verbose=False):
457
tree = b.working_tree()
459
tree = b.revision_tree(b.lookup_revision(revision))
461
for fp, fc, kind, fid in tree.list_files():
463
if kind == 'directory':
470
print '%-8s %s%s' % (fc, fp, kindch)
476
class cmd_unknowns(Command):
477
"""List unknown files"""
479
for f in Branch('.').unknowns():
484
class cmd_ignore(Command):
485
"""Ignore a command or pattern"""
486
takes_args = ['name_pattern']
488
def run(self, name_pattern):
491
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
492
f = open(b.abspath('.bzrignore'), 'at')
493
f.write(name_pattern + '\n')
496
inv = b.working_tree().inventory
497
if inv.path2id('.bzrignore'):
498
mutter('.bzrignore is already versioned')
500
mutter('need to make new .bzrignore file versioned')
501
b.add(['.bzrignore'])
505
class cmd_ignored(Command):
506
"""List ignored files and the patterns that matched them."""
508
tree = Branch('.').working_tree()
509
for path, file_class, kind, file_id in tree.list_files():
510
if file_class != 'I':
512
## XXX: Slightly inefficient since this was already calculated
513
pat = tree.is_ignored(path)
514
print '%-50s %s' % (path, pat)
517
class cmd_lookup_revision(Command):
518
"""Lookup the revision-id from a revision-number
521
bzr lookup-revision 33
524
takes_args = ['revno']
526
def run(self, revno):
530
raise BzrCommandError("not a valid revision-number: %r" % revno)
532
print Branch('.').lookup_revision(revno)
535
class cmd_export(Command):
536
"""Export past revision to destination directory.
538
If no revision is specified this exports the last committed revision."""
539
takes_args = ['dest']
540
takes_options = ['revision']
541
def run(self, dest, revision=None):
544
rh = b.revision_history()[-1]
546
rh = b.lookup_revision(int(revision))
547
t = b.revision_tree(rh)
551
class cmd_cat(Command):
552
"""Write a file's text from a previous revision."""
554
takes_options = ['revision']
555
takes_args = ['filename']
557
def run(self, filename, revision=None):
559
raise BzrCommandError("bzr cat requires a revision number")
561
b.print_file(b.relpath(filename), int(revision))
564
class cmd_local_time_offset(Command):
565
"""Show the offset in seconds from GMT to local time."""
568
print bzrlib.osutils.local_time_offset()
572
class cmd_commit(Command):
573
"""Commit changes into a new revision.
575
TODO: Commit only selected files.
577
TODO: Run hooks on tree to-be-committed, and after commit.
579
TODO: Strict commit that fails if there are unknown or deleted files.
581
takes_options = ['message', 'file', 'verbose']
582
aliases = ['ci', 'checkin']
584
def run(self, message=None, file=None, verbose=False):
585
## Warning: shadows builtin file()
586
if not message and not file:
587
raise BzrCommandError("please specify a commit message",
588
["use either --message or --file"])
589
elif message and file:
590
raise BzrCommandError("please specify either --message or --file")
594
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
596
Branch('.').commit(message, verbose=verbose)
599
class cmd_check(Command):
600
"""Validate consistency of branch history.
602
This command checks various invariants about the branch storage to
603
detect data corruption or bzr bugs.
605
takes_args = ['dir?']
606
def run(self, dir='.'):
608
bzrlib.check.check(Branch(dir, find_root=False))
612
class cmd_whoami(Command):
613
"""Show bzr user id."""
614
takes_options = ['email']
616
def run(self, email=False):
618
print bzrlib.osutils.user_email()
620
print bzrlib.osutils.username()
623
class cmd_selftest(Command):
624
"""Run internal test suite"""
627
failures, tests = 0, 0
629
import doctest, bzrlib.store, bzrlib.tests
630
bzrlib.trace.verbose = False
632
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
633
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
634
mf, mt = doctest.testmod(m)
637
print '%-40s %3d tests' % (m.__name__, mt),
639
print '%3d FAILED!' % mf
643
print '%-40s %3d tests' % ('total', tests),
645
print '%3d FAILED!' % failures
651
class cmd_version(Command):
652
"""Show version of bzr"""
657
print "bzr (bazaar-ng) %s" % bzrlib.__version__
658
print bzrlib.__copyright__
659
print "http://bazaar-ng.org/"
661
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
662
print "you may use, modify and redistribute it under the terms of the GNU"
663
print "General Public License version 2 or later."
666
class cmd_rocks(Command):
667
"""Statement of optimism."""
670
print "it sure does!"
673
class cmd_assert_fail(Command):
674
"""Test reporting of assertion failures"""
677
assert False, "always fails"
680
class cmd_help(Command):
681
"""Show help on a command or other topic.
683
For a list of all available commands, say 'bzr help commands'."""
684
takes_args = ['topic?']
687
def run(self, topic=None):
692
######################################################################
696
# list of all available options; the rhs can be either None for an
697
# option that takes no argument, or a constructor function that checks
721
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):
722
722
"""Parse command line.
724
724
Arguments and options are parsed at this level before being passed
725
725
down to specific command handlers. This routine knows, from a
726
726
lookup table, something about the available options, what optargs
727
727
they take, and which commands will accept them.
729
>>> parse_args('--help'.split())
731
>>> parse_args('--version'.split())
732
([], {'version': True})
733
>>> parse_args('status --all'.split())
734
(['status'], {'all': True})
735
>>> parse_args('commit --message=biter'.split())
736
(['commit'], {'message': u'biter'})
741
# TODO: Maybe handle '--' to end options?
746
# option names must not be unicode
750
mutter(" got option %r" % a)
752
optname, optarg = a[2:].split('=', 1)
755
if optname not in OPTIONS:
756
bailout('unknown long option %r' % a)
759
if shortopt not in SHORT_OPTIONS:
760
bailout('unknown short option %r' % a)
761
optname = SHORT_OPTIONS[shortopt]
764
# XXX: Do we ever want to support this, e.g. for -r?
765
bailout('repeated option %r' % a)
767
optargfn = OPTIONS[optname]
771
bailout('option %r needs an argument' % a)
774
opts[optname] = optargfn(optarg)
777
bailout('option %r takes no argument' % optname)
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])
782
739
return args, opts
787
742
def _match_argform(cmd, takes_args, args):
801
756
argdict[argname + '_list'] = None
802
757
elif ap[-1] == '+':
804
raise BzrCommandError("command %r needs one or more %s"
805
% (cmd, argname.upper()))
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
807
762
argdict[argname + '_list'] = args[:]
809
764
elif ap[-1] == '$': # all but one
810
765
if len(args) < 2:
811
raise BzrCommandError("command %r needs one or more %s"
812
% (cmd, argname.upper()))
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
813
768
argdict[argname + '_list'] = args[:-1]
816
771
# just a plain arg
819
raise BzrCommandError("command %r requires argument %s"
820
% (cmd, argname.upper()))
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
822
777
argdict[argname] = args.pop(0)
825
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)
832
904
def run_bzr(argv):
833
905
"""Execute a command.
835
This is similar to main(), but without all the trappings for
836
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.
838
argv = [a.decode(bzrlib.user_encoding) for a in argv]
841
args, opts = parse_args(argv[1:])
849
elif 'version' in opts:
852
cmd = str(args.pop(0))
854
log_error('usage: bzr COMMAND')
855
log_error(' try "bzr help"')
858
canonical_cmd, cmd_class = get_cmd_class(cmd)
861
if 'profile' in opts:
867
# check options are reasonable
868
allowed = cmd_class.takes_options
870
if oname not in allowed:
871
raise BzrCommandError("option '--%s' is not allowed for command %r"
874
# mix arguments and options into one dictionary
875
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
877
for k, v in opts.items():
878
cmdopts[k.replace('-', '_')] = v
881
import hotshot, tempfile
882
pffileno, pfname = tempfile.mkstemp()
884
prof = hotshot.Profile(pfname)
885
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
889
stats = hotshot.stats.load(pfname)
891
stats.sort_stats('time')
892
## XXX: Might like to write to stderr or the trace file instead but
893
## print_stats seems hardcoded to stdout
894
stats.print_stats(20)
902
cmdobj = cmd_class(cmdopts, cmdargs).status
905
def _report_exception(summary, quiet=False):
907
log_error('bzr: ' + summary)
908
bzrlib.trace.log_exception()
911
tb = sys.exc_info()[2]
912
exinfo = traceback.extract_tb(tb)
914
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
915
sys.stderr.write(' see ~/.bzr.log for debug information\n')
922
bzrlib.open_tracefile(argv)
929
# do this here inside the exception wrappers to catch EPIPE
932
quiet = isinstance(e, (BzrCommandError))
933
_report_exception('error: ' + e.args[0], quiet=quiet)
936
# some explanation or hints
939
except AssertionError, e:
940
msg = 'assertion failed'
943
_report_exception(msg)
945
except KeyboardInterrupt, e:
946
_report_exception('interrupted', quiet=True)
950
if isinstance(e, IOError) and e.errno == errno.EPIPE:
954
msg = str(e).rstrip('\n')
955
_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)
958
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()
961
1186
if __name__ == '__main__':
added
removed
bzrlib/commands.py
