138
36
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
139
38
return cmd[4:].replace('_','-')
142
def _builtin_commands():
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
150
if name.startswith("cmd_"):
151
real_name = _unsquish_command_name(name)
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
181
return _builtin_commands().keys()
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
return plugin_cmds.keys()
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
199
d = _builtin_commands()
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
206
def get_cmd_object(cmd_name, plugins_override=True):
207
"""Return the command object for a command.
210
If true, plugin commands can override builtins.
213
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
219
"""Get a command object.
221
:param cmd_name: The name of the command.
222
:param plugins_override: Allow plugins to override builtins.
223
:return: A Command object instance
224
:raises KeyError: If no command is found.
226
# We want only 'ascii' command names, but the user may have typed
227
# in a Unicode name. In that case, they should just get a
228
# 'command not found' error later.
229
# In the future, we may actually support Unicode command names.
232
for hook in Command.hooks['get_command']:
233
cmd = hook(cmd, cmd_name)
234
if cmd is not None and not plugins_override and not cmd.plugin_name():
235
# We've found a non-plugin command, don't permit it to be
239
for hook in Command.hooks['get_missing_command']:
246
# Allow plugins to extend commands
247
for hook in Command.hooks['extend_command']:
252
def _try_plugin_provider(cmd_name):
253
"""Probe for a plugin provider having cmd_name."""
255
plugin_metadata, provider = probe_for_provider(cmd_name)
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
262
def probe_for_provider(cmd_name):
263
"""Look for a provider for cmd_name.
265
:param cmd_name: The command name.
266
:return: plugin_metadata, provider for getting cmd_name.
267
:raises NoPluginAvailable: When no provider can supply the plugin.
269
# look for providers that provide this command but aren't installed
270
for provider in command_providers_registry:
272
return provider.plugin_for_command(cmd_name), provider
273
except errors.NoPluginAvailable:
275
raise errors.NoPluginAvailable(cmd_name)
278
def _get_bzr_command(cmd_or_None, cmd_name):
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
282
return cmds[cmd_name]()
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)]
285
57
# look for any command which claims this as an alias
286
for real_cmd_name, cmd_class in cmds.iteritems():
287
if cmd_name in cmd_class.aliases:
292
def _get_external_command(cmd_or_None, cmd_name):
293
"""Lookup a command that is a shell script."""
294
# Only do external command lookups when no command is found so far.
295
if cmd_or_None is not None:
297
from bzrlib.externalcommand import ExternalCommand
298
cmd_obj = ExternalCommand.find_command(cmd_name)
303
def _get_plugin_command(cmd_or_None, cmd_name):
304
"""Get a command from bzr's plugins."""
306
return plugin_cmds.get(cmd_name)()
309
for key in plugin_cmds.keys():
310
info = plugin_cmds.get_info(key)
311
if cmd_name in info.aliases:
312
return plugin_cmds.get(key)()
316
class Command(object):
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)
317
66
"""Base class for commands.
319
Commands are the heart of the command-line bzr interface.
321
The command object mostly handles the mapping of command-line
322
parameters into one or more bzrlib operations, and of the results
325
Commands normally don't have any state. All their arguments are
326
passed in to the run method. (Subclasses may take a different
327
policy if the behaviour of the instance needs to depend on e.g. a
328
shell plugin and not just its Python class.)
330
68
The docstring for an actual command should give a single-line
331
69
summary, then a complete description of the command. A grammar
332
70
description will be inserted.
335
Other accepted names for this command.
338
73
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
77
List of options that may be given for this command.
355
If true, this command isn't advertised. This is typically
356
for commands intended for expert users.
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
373
:cvar hooks: An instance of CommandHooks.
80
If true, this command isn't advertised.
377
85
takes_options = []
378
encoding_type = 'strict'
383
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
386
# List of standard options directly supported
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
"""Register a function to call after self.run returns or raises.
393
Functions will be called in LIFO order.
395
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
397
def cleanup_now(self):
398
"""Execute and empty pending cleanup functions immediately.
400
After cleanup_now all registered cleanups are forgotten. add_cleanup
401
may be called again after cleanup_now; these cleanups will be called
402
after self.run returns or raises (or when cleanup_now is next called).
404
This is useful for releasing expensive or contentious resources (such
405
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
424
"""Return single-line grammar for this command.
426
Only describes arguments, not options.
428
s = 'bzr ' + self.name() + ' '
429
for aname in self.takes_args:
430
aname = aname.upper()
431
if aname[-1] in ['$', '+']:
432
aname = aname[:-1] + '...'
433
elif aname[-1] == '?':
434
aname = '[' + aname[:-1] + ']'
435
elif aname[-1] == '*':
436
aname = '[' + aname[:-1] + '...]'
438
s = s[:-1] # remove last space
441
def get_help_text(self, additional_see_also=None, plain=True,
442
see_also_as_links=False, verbose=True):
443
"""Return a text string with help for this command.
445
:param additional_see_also: Additional help topics to be
447
:param plain: if False, raw help (reStructuredText) is
448
returned instead of plain text.
449
:param see_also_as_links: if True, convert items in 'See also'
450
list to internal links (used by bzr_man rstx generator)
451
:param verbose: if True, display the full help, otherwise
452
leave out the descriptive sections and just display
453
usage help (e.g. Purpose, Usage, Options) with a
454
message explaining how to obtain full help.
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
460
# Extract the summary (purpose) and sections out from the text
461
purpose,sections,order = self._get_help_parts(doc)
463
# If a custom usage section was provided, use it
464
if sections.has_key('Usage'):
465
usage = sections.pop('Usage')
467
usage = self._usage()
469
# The header is the purpose and usage
471
result += ':Purpose: %s\n' % purpose
472
if usage.find('\n') >= 0:
473
result += ':Usage:\n%s\n' % usage
475
result += ':Usage: %s\n' % usage
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
490
options = options.replace(' format:\n', ' format::\n\n', 1)
491
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
501
# Add the description, indenting it 2 spaces
502
# to match the indentation of the options
503
if sections.has_key(None):
504
text = sections.pop(None)
505
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
508
# Add the custom sections (e.g. Examples). Note that there's no need
509
# to indent these as they must be indented already in the source.
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
519
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
522
result += ', '.join(self.aliases) + '\n'
523
plugin_name = self.plugin_name()
524
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
526
see_also = self.get_see_also(additional_see_also)
528
if not plain and see_also_as_links:
530
for item in see_also:
532
# topics doesn't have an independent section
533
# so don't create a real link
534
see_also_links.append(item)
536
# Use a Sphinx link for this entry
537
link_text = ":doc:`%s <%s-help>`" % (item, item)
538
see_also_links.append(link_text)
539
see_also = see_also_links
540
result += ':See also: '
541
result += ', '.join(see_also) + '\n'
543
# If this will be rendered as plain text, convert it
545
import bzrlib.help_topics
546
result = bzrlib.help_topics.help_as_plain_text(result)
550
def _get_help_parts(text):
551
"""Split help text into a summary and named sections.
553
:return: (summary,sections,order) where summary is the top line and
554
sections is a dictionary of the rest indexed by section name.
555
order is the order the section appear in the text.
556
A section starts with a heading line of the form ":xxx:".
557
Indented text on following lines is the section value.
558
All text found outside a named section is assigned to the
559
default section which is given the key of None.
561
def save_section(sections, order, label, section):
563
if sections.has_key(label):
564
sections[label] += '\n' + section
567
sections[label] = section
569
lines = text.rstrip().splitlines()
570
summary = lines.pop(0)
573
label,section = None,''
575
if line.startswith(':') and line.endswith(':') and len(line) > 2:
576
save_section(sections, order, label, section)
577
label,section = line[1:-1],''
578
elif (label is not None) and len(line) > 1 and not line[0].isspace():
579
save_section(sections, order, label, section)
580
label,section = None,line
583
section += '\n' + line
586
save_section(sections, order, label, section)
587
return summary, sections, order
589
def get_help_topic(self):
590
"""Return the commands help topic - its name."""
593
def get_see_also(self, additional_terms=None):
594
"""Return a list of help topics that are related to this command.
596
The list is derived from the content of the _see_also attribute. Any
597
duplicates are removed and the result is in lexical order.
598
:param additional_terms: Additional help topics to cross-reference.
599
:return: A list of help topics.
601
see_also = set(getattr(self, '_see_also', []))
603
see_also.update(additional_terms)
604
return sorted(see_also)
607
"""Return dict of valid options for this command.
609
Maps from long option name to option object."""
610
r = Option.STD_OPTIONS.copy()
612
for o in self.takes_options:
613
if isinstance(o, basestring):
614
o = option.Option.OPTIONS[o]
616
if o.name in std_names:
617
self.supported_std_options.append(o.name)
620
def _setup_outf(self):
621
"""Return a file linked to stdout, which has proper encoding."""
622
self.outf = ui.ui_factory.make_output_stream(
623
encoding_type=self.encoding_type)
625
def run_argv_aliases(self, argv, alias_argv=None):
626
"""Parse the command line and run with extra aliases in alias_argv."""
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
629
DeprecationWarning, stacklevel=2)
631
args, opts = parse_args(self, argv, alias_argv)
633
# Process the standard options
634
if 'help' in opts: # e.g. bzr add --help
635
sys.stdout.write(self.get_help_text())
637
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
640
trace.set_verbosity_level(option._verbosity_level)
641
if 'verbose' in self.supported_std_options:
642
opts['verbose'] = trace.is_verbose()
643
elif opts.has_key('verbose'):
645
if 'quiet' in self.supported_std_options:
646
opts['quiet'] = trace.is_quiet()
647
elif opts.has_key('quiet'):
650
# mix arguments and options into one dictionary
651
cmdargs = _match_argform(self.name(), self.takes_args, args)
653
for k, v in opts.items():
654
cmdopts[k.replace('-', '_')] = v
656
all_cmd_args = cmdargs.copy()
657
all_cmd_args.update(cmdopts)
661
return self.run_direct(**all_cmd_args)
663
def run_direct(self, *args, **kwargs):
664
"""Call run directly with objects (without parsing an argv list)."""
665
return self._operation.run_simple(*args, **kwargs)
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)
668
"""Actually run the command.
103
"""Override this in sub-classes.
670
105
This is invoked with the options and arguments bound to
671
106
keyword parameters.
673
Return 0 or None if the command was successful, or a non-zero
674
shell error code if not. It's OK for this method to allow
675
an exception to raise up.
677
raise NotImplementedError('no implementation of command %r'
681
"""Return help message for this class."""
682
from inspect import getdoc
683
if self.__doc__ is Command.__doc__:
688
return _unsquish_command_name(self.__class__.__name__)
690
def plugin_name(self):
691
"""Get the name of the plugin that provides this command.
693
:return: The name of the plugin or None if the command is builtin.
695
mod_parts = self.__module__.split('.')
696
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
702
class CommandHooks(Hooks):
703
"""Hooks related to Command object creation/enumeration."""
706
"""Create the default hooks.
708
These are all empty initially, because by default nothing should get
712
self.create_hook(HookPoint('extend_command',
713
"Called after creating a command object to allow modifications "
714
"such as adding or removing options, docs etc. Called with the "
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
717
"Called when creating a single command. Called with "
718
"(cmd_or_None, command_name). get_command should either return "
719
"the cmd_or_None parameter, or a replacement Command object that "
720
"should be used for the command. Note that the Command.hooks "
721
"hooks are core infrastructure. Many users will prefer to use "
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
725
"Called when creating a single command if no command could be "
726
"found. Called with (command_name). get_missing_command should "
727
"either return None, or a Command object to be used for the "
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
730
"Called when enumerating commands. Called with a set of "
731
"cmd_name strings for all the commands found so far. This set "
732
" is safe to mutate - e.g. to remove a command. "
733
"list_commands should return the updated set of command names.",
736
Command.hooks = CommandHooks()
739
def parse_args(command, argv, alias_argv=None):
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
def Relpath(Command):
178
"""Show path of a file relative to root"""
179
takes_args = ('filename')
182
print Branch(self.args['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
TODO: Option to limit to only a single file or to get log for a
426
takes_options = ['timezone', 'verbose', 'show-ids']
427
def run(self, timezone='original', verbose=False, show_ids=False):
428
b = Branch('.', lock_mode='r')
429
b.show_log(show_timezone=timezone,
434
class cmd_ls(Command):
435
"""List files in a tree.
437
TODO: Take a revision or remote path and list that tree instead.
440
def run(self, revision=None, verbose=False):
443
tree = b.working_tree()
445
tree = b.revision_tree(b.lookup_revision(revision))
447
for fp, fc, kind, fid in tree.list_files():
449
if kind == 'directory':
456
print '%-8s %s%s' % (fc, fp, kindch)
462
class cmd_unknowns(Command):
463
"""List unknown files"""
465
for f in Branch('.').unknowns():
470
class cmd_ignore(Command):
471
"""Ignore a command or pattern"""
472
takes_args = ['name_pattern']
474
def run(self, name_pattern):
477
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
478
f = open(b.abspath('.bzrignore'), 'at')
479
f.write(name_pattern + '\n')
482
inv = b.working_tree().inventory
483
if inv.path2id('.bzrignore'):
484
mutter('.bzrignore is already versioned')
486
mutter('need to make new .bzrignore file versioned')
487
b.add(['.bzrignore'])
491
class cmd_ignored(Command):
492
"""List ignored files and the patterns that matched them."""
494
tree = Branch('.').working_tree()
495
for path, file_class, kind, file_id in tree.list_files():
496
if file_class != 'I':
498
## XXX: Slightly inefficient since this was already calculated
499
pat = tree.is_ignored(path)
500
print '%-50s %s' % (path, pat)
503
class cmd_lookup_revision(Command):
504
"""Lookup the revision-id from a revision-number
507
bzr lookup-revision 33
510
takes_args = ['revno']
512
def run(self, revno):
516
raise BzrCommandError("not a valid revision-number: %r" % revno)
518
print Branch('.').lookup_revision(revno)
521
class cmd_export(Command):
522
"""Export past revision to destination directory.
524
If no revision is specified this exports the last committed revision."""
525
takes_args = ['dest']
526
takes_options = ['revision']
527
def run(self, dest, revno=None):
530
rh = b.revision_history[-1]
532
rh = b.lookup_revision(int(revno))
533
t = b.revision_tree(rh)
537
class cmd_cat(Command):
538
"""Write a file's text from a previous revision."""
540
takes_options = ['revision']
541
takes_args = ['filename']
543
def run(self, filename, revision=None):
545
raise BzrCommandError("bzr cat requires a revision number")
547
b.print_file(b.relpath(filename), int(revision))
550
class cmd_local_time_offset(Command):
551
"""Show the offset in seconds from GMT to local time."""
554
print bzrlib.osutils.local_time_offset()
558
class cmd_commit(Command):
559
"""Commit changes into a new revision.
561
TODO: Commit only selected files.
563
TODO: Run hooks on tree to-be-committed, and after commit.
565
TODO: Strict commit that fails if there are unknown or deleted files.
567
takes_options = ['message', 'verbose']
568
aliases = ['ci', 'checkin']
570
def run(self, message=None, verbose=False):
572
raise BzrCommandError("please specify a commit message")
573
Branch('.').commit(message, verbose=verbose)
576
class cmd_check(Command):
577
"""Validate consistency of branch history.
579
This command checks various invariants about the branch storage to
580
detect data corruption or bzr bugs.
582
takes_args = ['dir?']
583
def run(self, dir='.'):
585
bzrlib.check.check(Branch(dir, find_root=False))
589
class cmd_whoami(Command):
590
"""Show bzr user id."""
591
takes_options = ['email']
593
def run(self, email=False):
595
print bzrlib.osutils.user_email()
597
print bzrlib.osutils.username()
600
class cmd_selftest(Command):
601
"""Run internal test suite"""
604
failures, tests = 0, 0
606
import doctest, bzrlib.store, bzrlib.tests
607
bzrlib.trace.verbose = False
609
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
610
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
611
mf, mt = doctest.testmod(m)
614
print '%-40s %3d tests' % (m.__name__, mt),
616
print '%3d FAILED!' % mf
620
print '%-40s %3d tests' % ('total', tests),
622
print '%3d FAILED!' % failures
628
class cmd_version(Command):
629
"""Show version of bzr"""
634
print "bzr (bazaar-ng) %s" % bzrlib.__version__
635
print bzrlib.__copyright__
636
print "http://bazaar-ng.org/"
638
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
639
print "you may use, modify and redistribute it under the terms of the GNU"
640
print "General Public License version 2 or later."
643
class cmd_rocks(Command):
644
"""Statement of optimism."""
647
print "it sure does!"
650
class cmd_assert_fail(Command):
651
"""Test reporting of assertion failures"""
654
assert False, "always fails"
657
class cmd_help(Command):
658
"""Show help on a command or other topic.
660
For a list of all available commands, say 'bzr help commands'."""
661
takes_args = ['topic?']
664
def run(self, topic=None):
669
######################################################################
673
# list of all available options; the rhs can be either None for an
674
# option that takes no argument, or a constructor function that checks
696
def parse_args(argv):
740
697
"""Parse command line.
742
699
Arguments and options are parsed at this level before being passed
743
700
down to specific command handlers. This routine knows, from a
744
701
lookup table, something about the available options, what optargs
745
702
they take, and which commands will accept them.
704
>>> parse_args('--help'.split())
706
>>> parse_args('--version'.split())
707
([], {'version': True})
708
>>> parse_args('status --all'.split())
709
(['status'], {'all': True})
710
>>> parse_args('commit --message=biter'.split())
711
(['commit'], {'message': u'biter'})
747
# TODO: make it a method of the Command?
748
parser = option.get_optparser(command.options())
749
if alias_argv is not None:
750
args = alias_argv + argv
754
options, args = parser.parse_args(args)
755
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
756
v is not option.OptionParser.DEFAULT_VALUE])
716
# TODO: Maybe handle '--' to end options?
721
# option names must not be unicode
725
mutter(" got option %r" % a)
727
optname, optarg = a[2:].split('=', 1)
730
if optname not in OPTIONS:
731
bailout('unknown long option %r' % a)
734
if shortopt not in SHORT_OPTIONS:
735
bailout('unknown short option %r' % a)
736
optname = SHORT_OPTIONS[shortopt]
739
# XXX: Do we ever want to support this, e.g. for -r?
740
bailout('repeated option %r' % a)
742
optargfn = OPTIONS[optname]
746
bailout('option %r needs an argument' % a)
749
opts[optname] = optargfn(optarg)
752
bailout('option %r takes no argument' % optname)
757
757
return args, opts
760
762
def _match_argform(cmd, takes_args, args):
774
776
argdict[argname + '_list'] = None
775
777
elif ap[-1] == '+':
777
raise errors.BzrCommandError("command %r needs one or more %s"
778
% (cmd, argname.upper()))
779
raise BzrCommandError("command %r needs one or more %s"
780
% (cmd, argname.upper()))
780
782
argdict[argname + '_list'] = args[:]
782
784
elif ap[-1] == '$': # all but one
783
785
if len(args) < 2:
784
raise errors.BzrCommandError("command %r needs one or more %s"
785
% (cmd, argname.upper()))
786
raise BzrCommandError("command %r needs one or more %s"
787
% (cmd, argname.upper()))
786
788
argdict[argname + '_list'] = args[:-1]
789
791
# just a plain arg
792
raise errors.BzrCommandError("command %r requires argument %s"
793
% (cmd, argname.upper()))
794
raise BzrCommandError("command %r requires argument %s"
795
% (cmd, argname.upper()))
795
797
argdict[argname] = args.pop(0)
798
raise errors.BzrCommandError("extra argument to command %s: %s"
800
raise BzrCommandError("extra argument to command %s: %s"
803
def apply_coveraged(dirname, the_callable, *args, **kwargs):
804
# Cannot use "import trace", as that would import bzrlib.trace instead of
805
# the standard library's trace.
806
trace = __import__('trace')
808
tracer = trace.Trace(count=1, trace=0)
809
sys.settrace(tracer.globaltrace)
810
threading.settrace(tracer.globaltrace)
813
return exception_to_return_code(the_callable, *args, **kwargs)
816
results = tracer.results()
817
results.write_results(show_missing=1, summary=False,
821
def apply_profiled(the_callable, *args, **kwargs):
825
pffileno, pfname = tempfile.mkstemp()
827
prof = hotshot.Profile(pfname)
829
ret = prof.runcall(exception_to_return_code, the_callable, *args,
833
stats = hotshot.stats.load(pfname)
835
stats.sort_stats('cum') # 'time'
836
## XXX: Might like to write to stderr or the trace file instead but
837
## print_stats seems hardcoded to stdout
838
stats.print_stats(20)
845
def exception_to_return_code(the_callable, *args, **kwargs):
846
"""UI level helper for profiling and coverage.
848
This transforms exceptions into a return value of 3. As such its only
849
relevant to the UI layer, and should never be called where catching
850
exceptions may be desirable.
853
return the_callable(*args, **kwargs)
854
except (KeyboardInterrupt, Exception), e:
855
# used to handle AssertionError and KeyboardInterrupt
856
# specially here, but hopefully they're handled ok by the logger now
857
exc_info = sys.exc_info()
858
exitcode = trace.report_exception(exc_info, sys.stderr)
859
if os.environ.get('BZR_PDB'):
860
print '**** entering debugger'
863
if sys.version_info[:2] < (2, 6):
865
# pdb.post_mortem(tb)
866
# but because pdb.post_mortem gives bad results for tracebacks
867
# from inside generators, we do it manually.
868
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
870
# Setup pdb on the traceback
873
p.setup(tb.tb_frame, tb)
874
# Point the debugger at the deepest frame of the stack
875
p.curindex = len(p.stack) - 1
876
p.curframe = p.stack[p.curindex][0]
877
# Start the pdb prompt.
878
p.print_stack_entry(p.stack[p.curindex])
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
887
from bzrlib.lsprof import profile
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
894
trace.note('Profile data written to "%s".', filename)
898
def shlex_split_unicode(unsplit):
900
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
903
def get_alias(cmd, config=None):
904
"""Return an expanded alias, or None if no alias exists.
907
Command to be checked for an alias.
909
Used to specify an alternative config to use,
910
which is especially useful for testing.
911
If it is unspecified, the global config will be used.
915
config = bzrlib.config.GlobalConfig()
916
alias = config.get_alias(cmd)
918
return shlex_split_unicode(alias)
922
807
def run_bzr(argv):
923
808
"""Execute a command.
926
The command-line arguments, without the program name from argv[0]
927
These should already be decoded. All library/test code calling
928
run_bzr should be passing valid strings (don't need decoding).
930
Returns a command status or raises an exception.
932
Special master options: these must come before the command because
933
they control how the command is interpreted.
936
Do not load plugin modules at all
942
Only use builtin commands. (Plugins are still allowed to change
946
Run under the Python hotshot profiler.
949
Run under the Python lsprof profiler.
952
Generate line coverage report in the specified directory.
955
Specify the number of processes that can be run concurrently (selftest).
810
This is similar to main(), but without all the trappings for
811
logging and error handling.
957
trace.mutter("bazaar version: " + bzrlib.__version__)
959
trace.mutter("bzr arguments: %r", argv)
961
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
962
opt_no_aliases = False
963
opt_lsprof_file = opt_coverage_dir = None
965
# --no-plugins is handled specially at a very early stage. We need
966
# to load plugins before doing other command parsing so that they
967
# can override commands, but this needs to happen first.
975
elif a == '--lsprof':
977
elif a == '--lsprof-file':
979
opt_lsprof_file = argv[i + 1]
981
elif a == '--no-plugins':
982
opt_no_plugins = True
983
elif a == '--no-aliases':
984
opt_no_aliases = True
985
elif a == '--builtin':
987
elif a == '--concurrency':
988
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
990
elif a == '--coverage':
991
opt_coverage_dir = argv[i + 1]
993
elif a.startswith('-D'):
994
debug.debug_flags.add(a[2:])
999
debug.set_debug_flags_from_config()
1003
from bzrlib.builtins import cmd_help
1004
cmd_help().run_argv_aliases([])
1007
if argv[0] == '--version':
1008
from bzrlib.builtins import cmd_version
1009
cmd_version().run_argv_aliases([])
1012
if not opt_no_plugins:
1013
from bzrlib.plugin import load_plugins
1016
from bzrlib.plugin import disable_plugins
1021
if not opt_no_aliases:
1022
alias_argv = get_alias(argv[0])
1024
user_encoding = osutils.get_user_encoding()
1025
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1026
argv[0] = alias_argv.pop(0)
1029
# We want only 'ascii' command names, but the user may have typed
1030
# in a Unicode name. In that case, they should just get a
1031
# 'command not found' error later.
1033
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1034
run = cmd_obj.run_argv_aliases
1035
run_argv = [argv, alias_argv]
1038
# We can be called recursively (tests for example), but we don't want
1039
# the verbosity level to propagate.
1040
saved_verbosity_level = option._verbosity_level
1041
option._verbosity_level = 0
1043
if opt_coverage_dir:
1045
'--coverage ignored, because --lsprof is in use.')
1046
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1048
if opt_coverage_dir:
1050
'--coverage ignored, because --profile is in use.')
1051
ret = apply_profiled(run, *run_argv)
1052
elif opt_coverage_dir:
1053
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1055
ret = run(*run_argv)
813
argv = [a.decode(bzrlib.user_encoding) for a in argv]
816
args, opts = parse_args(argv[1:])
824
elif 'version' in opts:
827
cmd = str(args.pop(0))
829
log_error('usage: bzr COMMAND')
830
log_error(' try "bzr help"')
833
canonical_cmd, cmd_class = get_cmd_class(cmd)
836
if 'profile' in opts:
842
# check options are reasonable
843
allowed = cmd_class.takes_options
845
if oname not in allowed:
846
raise BzrCommandError("option %r is not allowed for command %r"
849
# mix arguments and options into one dictionary
850
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
852
for k, v in opts.items():
853
cmdopts[k.replace('-', '_')] = v
856
import hotshot, tempfile
857
pffileno, pfname = tempfile.mkstemp()
859
prof = hotshot.Profile(pfname)
860
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
864
stats = hotshot.stats.load(pfname)
866
stats.sort_stats('time')
867
## XXX: Might like to write to stderr or the trace file instead but
868
## print_stats seems hardcoded to stdout
869
stats.print_stats(20)
877
cmdobj = cmd_class(cmdopts, cmdargs).status
880
def _report_exception(summary, quiet=False):
882
log_error('bzr: ' + summary)
883
bzrlib.trace.log_exception()
886
tb = sys.exc_info()[2]
887
exinfo = traceback.extract_tb(tb)
889
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
890
sys.stderr.write(' see ~/.bzr.log for debug information\n')
897
bzrlib.open_tracefile(argv)
904
# do this here inside the exception wrappers to catch EPIPE
907
quiet = isinstance(e, (BzrCommandError))
908
_report_exception('error: ' + e.args[0], quiet=quiet)
911
# some explanation or hints
914
except AssertionError, e:
915
msg = 'assertion failed'
918
_report_exception(msg)
920
except KeyboardInterrupt, e:
921
_report_exception('interrupted', quiet=True)
925
if isinstance(e, IOError) and e.errno == errno.EPIPE:
929
msg = str(e).rstrip('\n')
930
_report_exception(msg, quiet)
1058
# reset, in case we may do other commands later within the same
1059
# process. Commands that want to execute sub-commands must propagate
1060
# --verbose in their own way.
1061
if 'memory' in debug.debug_flags:
1062
trace.debug_memory('Process status after command:', short=False)
1063
option._verbosity_level = saved_verbosity_level
1066
def display_command(func):
1067
"""Decorator that suppresses pipe/interrupt errors."""
1068
def ignore_pipe(*args, **kwargs):
1070
result = func(*args, **kwargs)
1074
if getattr(e, 'errno', None) is None:
1076
if e.errno != errno.EPIPE:
1077
# Win32 raises IOError with errno=0 on a broken pipe
1078
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1081
except KeyboardInterrupt:
1086
def install_bzr_command_hooks():
1087
"""Install the hooks to supply bzr's own commands."""
1088
if _list_bzr_commands in Command.hooks["list_commands"]:
1090
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1092
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1094
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1095
"bzr plugin commands")
1096
Command.hooks.install_named_hook("get_command", _get_external_command,
1097
"bzr external command lookup")
1098
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
"bzr plugin-provider-db check")
1102
def main(argv=None):
1103
"""Main entry point of command-line interface.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
1113
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
sys.stdin, sys.stdout, sys.stderr)
1116
# Is this a final release version? If so, we should suppress warnings
1117
if bzrlib.version_info[3] == 'final':
1118
suppress_deprecation_warnings(override=True)
1120
argv = osutils.get_unicode_argv()
1124
# ensure all arguments are unicode strings
1126
if isinstance(a, unicode):
1129
new_argv.append(a.decode('ascii'))
1130
except UnicodeDecodeError:
1131
raise errors.BzrError("argv should be list of unicode strings.")
1133
ret = run_bzr_catch_errors(argv)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1136
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
1141
def run_bzr_catch_errors(argv):
1142
"""Run a bzr command with parameters as described by argv.
1144
This function assumed that that UI layer is setup, that symbol deprecations
1145
are already applied, and that unicode decoding has already been performed on argv.
1147
install_bzr_command_hooks()
1148
return exception_to_return_code(run_bzr, argv)
1151
def run_bzr_catch_user_errors(argv):
1152
"""Run bzr and report user errors, but let internal errors propagate.
1154
This is used for the test suite, and might be useful for other programs
1155
that want to wrap the commandline interface.
1157
install_bzr_command_hooks()
1159
return run_bzr(argv)
1160
except Exception, e:
1161
if (isinstance(e, (OSError, IOError))
1162
or not getattr(e, 'internal_error', True)):
1163
trace.report_exception(sys.exc_info(), sys.stderr)
1169
class HelpCommandIndex(object):
1170
"""A index for bzr help that returns commands."""
1173
self.prefix = 'commands/'
1175
def get_topics(self, topic):
1176
"""Search for topic amongst commands.
1178
:param topic: A topic to search for.
1179
:return: A list which is either empty or contains a single
1182
if topic and topic.startswith(self.prefix):
1183
topic = topic[len(self.prefix):]
1185
cmd = _get_cmd_object(topic)
1192
class Provider(object):
1193
'''Generic class to be overriden by plugins'''
1195
def plugin_for_command(self, cmd_name):
1196
'''Takes a command and returns the information for that plugin
1198
:return: A dictionary with all the available information
1199
for the requested plugin
1201
raise NotImplementedError
1204
class ProvidersRegistry(registry.Registry):
1205
'''This registry exists to allow other providers to exist'''
1208
for key, provider in self.iteritems():
1211
command_providers_registry = ProvidersRegistry()
933
bzrlib.trace.close_trace()
1214
936
if __name__ == '__main__':
added
removed
bzrlib/commands.py
