1
# Copyright (C) 2005-2011 Canonical Ltd
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
3
8
# This program is free software; you can redistribute it and/or modify
4
9
# it under the terms of the GNU General Public License as published by
5
10
# the Free Software Foundation; either version 2 of the License, or
6
11
# (at your option) any later version.
8
13
# This program is distributed in the hope that it will be useful,
9
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
16
# GNU General Public License for more details.
13
18
# You should have received a copy of the GNU General Public License
14
19
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Define arguments by objects, rather than just using names.
19
# Those objects can specify the expected type of the argument, which
20
# would help with validation and shell completion. They could also provide
21
# help/explanation for that argument in a structured way.
23
# TODO: Specific "examples" property on commands for consistent formatting.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
33
from warnings import warn
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Run internal consistency checks.
69
# Show some information about this branch.
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
83
from pprint import pprint
86
from ElementTree import Element, ElementTree, SubElement
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
157
return plugin_cmds.register(cmd, decorate)
160
def _squish_command_name(cmd):
161
return 'cmd_' + cmd.replace('-', '_')
164
def _unsquish_command_name(cmd):
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
191
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
def builtin_command_names():
220
"""Return list of builtin command names.
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
_register_builtin_commands()
226
return builtin_command_registry.keys()
229
def plugin_command_names():
230
"""Returns command names from commands registered by plugins."""
231
return plugin_cmds.keys()
234
def get_cmd_object(cmd_name, plugins_override=True):
235
"""Return the command object for a command.
238
If true, plugin commands can override builtins.
241
return _get_cmd_object(cmd_name, plugins_override)
243
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
247
"""Get a command object.
249
:param cmd_name: The name of the command.
250
:param plugins_override: Allow plugins to override builtins.
251
:param check_missing: Look up commands not found in the regular index via
252
the get_missing_command hook.
253
:return: A Command object instance
254
:raises KeyError: If no command is found.
256
# We want only 'ascii' command names, but the user may have typed
257
# in a Unicode name. In that case, they should just get a
258
# 'command not found' error later.
259
# In the future, we may actually support Unicode command names.
262
for hook in Command.hooks['get_command']:
263
cmd = hook(cmd, cmd_name)
264
if cmd is not None and not plugins_override and not cmd.plugin_name():
265
# We've found a non-plugin command, don't permit it to be
268
if cmd is None and check_missing:
269
for hook in Command.hooks['get_missing_command']:
276
# Allow plugins to extend commands
277
for hook in Command.hooks['extend_command']:
282
def _try_plugin_provider(cmd_name):
283
"""Probe for a plugin provider having cmd_name."""
285
plugin_metadata, provider = probe_for_provider(cmd_name)
286
raise errors.CommandAvailableInPlugin(cmd_name,
287
plugin_metadata, provider)
288
except errors.NoPluginAvailable:
292
def probe_for_provider(cmd_name):
293
"""Look for a provider for cmd_name.
295
:param cmd_name: The command name.
296
:return: plugin_metadata, provider for getting cmd_name.
297
:raises NoPluginAvailable: When no provider can supply the plugin.
299
# look for providers that provide this command but aren't installed
300
for provider in command_providers_registry:
302
return provider.plugin_for_command(cmd_name), provider
303
except errors.NoPluginAvailable:
305
raise errors.NoPluginAvailable(cmd_name)
308
def _get_bzr_command(cmd_or_None, cmd_name):
309
"""Get a command from bzr's core."""
311
cmd_class = builtin_command_registry.get(cmd_name)
319
def _get_external_command(cmd_or_None, cmd_name):
320
"""Lookup a command that is a shell script."""
321
# Only do external command lookups when no command is found so far.
322
if cmd_or_None is not None:
324
from bzrlib.externalcommand import ExternalCommand
325
cmd_obj = ExternalCommand.find_command(cmd_name)
330
def _get_plugin_command(cmd_or_None, cmd_name):
331
"""Get a command from bzr's plugins."""
333
return plugin_cmds.get(cmd_name)()
336
for key in plugin_cmds.keys():
337
info = plugin_cmds.get_info(key)
338
if cmd_name in info.aliases:
339
return plugin_cmds.get(key)()
343
class Command(object):
344
"""Base class for commands.
346
Commands are the heart of the command-line bzr interface.
348
The command object mostly handles the mapping of command-line
349
parameters into one or more bzrlib operations, and of the results
352
Commands normally don't have any state. All their arguments are
353
passed in to the run method. (Subclasses may take a different
354
policy if the behaviour of the instance needs to depend on e.g. a
355
shell plugin and not just its Python class.)
357
The docstring for an actual command should give a single-line
358
summary, then a complete description of the command. A grammar
359
description will be inserted.
362
Other accepted names for this command.
365
List of argument forms, marked with whether they are optional,
370
['to_location', 'from_branch?', 'file*']
372
'to_location' is required
373
'from_branch' is optional
374
'file' can be specified 0 or more times
377
List of options that may be given for this command. These can
378
be either strings, referring to globally-defined options,
379
or option objects. Retrieve through options().
382
If true, this command isn't advertised. This is typically
383
for commands intended for expert users.
386
Command objects will get a 'outf' attribute, which has been
387
setup to properly handle encoding of unicode strings.
388
encoding_type determines what will happen when characters cannot
390
strict - abort if we cannot decode
391
replace - put in a bogus character (typically '?')
392
exact - do not encode sys.stdout
394
NOTE: by default on Windows, sys.stdout is opened as a text
395
stream, therefore LF line-endings are converted to CRLF.
396
When a command uses encoding_type = 'exact', then
397
sys.stdout is forced to be a binary stream, and line-endings
400
:cvar hooks: An instance of CommandHooks.
401
:ivar __doc__: The help shown by 'bzr help command' for this command.
402
This is set by assigning explicitly to __doc__ so that -OO can
406
__doc__ = "My help goes here"
411
encoding_type = 'strict'
416
"""Construct an instance of this command."""
417
# List of standard options directly supported
418
self.supported_std_options = []
421
def add_cleanup(self, cleanup_func, *args, **kwargs):
422
"""Register a function to call after self.run returns or raises.
424
Functions will be called in LIFO order.
426
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
428
def cleanup_now(self):
429
"""Execute and empty pending cleanup functions immediately.
431
After cleanup_now all registered cleanups are forgotten. add_cleanup
432
may be called again after cleanup_now; these cleanups will be called
433
after self.run returns or raises (or when cleanup_now is next called).
435
This is useful for releasing expensive or contentious resources (such
436
as write locks) before doing further work that does not require those
437
resources (such as writing results to self.outf). Note though, that
438
as it releases all resources, this may release locks that the command
439
wants to hold, so use should be done with care.
441
self._operation.cleanup_now()
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
def _maybe_expand_globs(self, file_list):
445
"""Glob expand file_list if the platform does not do that itself.
447
Not used anymore, now that the bzr command-line parser globs on
450
:return: A possibly empty list of unicode paths.
452
Introduced in bzrlib 0.18.
457
"""Return single-line grammar for this command.
459
Only describes arguments, not options.
461
s = 'bzr ' + self.name() + ' '
462
for aname in self.takes_args:
463
aname = aname.upper()
464
if aname[-1] in ['$', '+']:
465
aname = aname[:-1] + '...'
466
elif aname[-1] == '?':
467
aname = '[' + aname[:-1] + ']'
468
elif aname[-1] == '*':
469
aname = '[' + aname[:-1] + '...]'
471
s = s[:-1] # remove last space
474
def get_help_text(self, additional_see_also=None, plain=True,
475
see_also_as_links=False, verbose=True):
476
"""Return a text string with help for this command.
478
:param additional_see_also: Additional help topics to be
480
:param plain: if False, raw help (reStructuredText) is
481
returned instead of plain text.
482
:param see_also_as_links: if True, convert items in 'See also'
483
list to internal links (used by bzr_man rstx generator)
484
:param verbose: if True, display the full help, otherwise
485
leave out the descriptive sections and just display
486
usage help (e.g. Purpose, Usage, Options) with a
487
message explaining how to obtain full help.
491
doc = "No help for this command."
493
# Extract the summary (purpose) and sections out from the text
494
purpose,sections,order = self._get_help_parts(doc)
496
# If a custom usage section was provided, use it
497
if sections.has_key('Usage'):
498
usage = sections.pop('Usage')
500
usage = self._usage()
502
# The header is the purpose and usage
504
result += ':Purpose: %s\n' % purpose
505
if usage.find('\n') >= 0:
506
result += ':Usage:\n%s\n' % usage
508
result += ':Usage: %s\n' % usage
513
# XXX: optparse implicitly rewraps the help, and not always perfectly,
514
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
516
options = option.get_optparser(self.options()).format_option_help()
517
# XXX: According to the spec, ReST option lists actually don't support
518
# options like --1.9 so that causes syntax errors (in Sphinx at least).
519
# As that pattern always appears in the commands that break, we trap
520
# on that and then format that block of 'format' options as a literal
522
if not plain and options.find(' --1.9 ') != -1:
523
options = options.replace(' format:\n', ' format::\n\n', 1)
524
if options.startswith('Options:'):
525
result += ':' + options
526
elif options.startswith('options:'):
527
# Python 2.4 version of optparse
528
result += ':Options:' + options[len('options:'):]
89
from bzrlib.store import ImmutableStore
90
from bzrlib.trace import mutter, note, log_error
91
from bzrlib.errors import bailout, BzrError
92
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
93
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
94
from bzrlib.revision import Revision
95
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
98
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
99
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
101
## standard representation
102
NONE_STRING = '(none)'
106
## TODO: Perhaps a different version of inventory commands that
107
## returns iterators...
109
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
111
## TODO: Some kind of locking on branches. Perhaps there should be a
112
## parameter to the branch object saying whether we want a read or
113
## write lock; release it from destructor. Perhaps don't even need a
114
## read lock to look at immutable objects?
116
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
117
## to compare output?
119
## TODO: Is ElementTree really all that much better for our purposes?
120
## Perhaps using the standard MiniDOM would be enough?
127
######################################################################
131
def cmd_status(all=False):
132
"""Display status summary.
134
For each file there is a single line giving its file state and name.
135
The name is that in the current revision unless it is deleted or
136
missing, in which case the old name is shown.
138
:todo: Don't show unchanged files unless ``--all`` is given?
140
Branch('.').show_status(show_all=all)
144
######################################################################
146
def cmd_get_revision(revision_id):
147
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
150
def cmd_get_inventory(inventory_id):
151
"""Return inventory in XML by hash"""
152
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
155
def cmd_get_revision_inventory(revision_id):
156
"""Output inventory for a revision."""
158
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
161
def cmd_get_file_text(text_id):
162
"""Get contents of a file by hash."""
163
sf = Branch('.').text_store[text_id]
164
pumpfile(sf, sys.stdout)
168
######################################################################
173
"""Show number of revisions on this branch"""
174
print Branch('.').revno()
177
def cmd_add(file_list, verbose=False):
178
"""Add specified files.
180
Fails if the files are already added.
182
Branch('.').add(file_list, verbose=verbose)
185
def cmd_inventory(revision=None):
186
"""Show inventory of the current working copy."""
187
## TODO: Also optionally show a previous inventory
188
## TODO: Format options
191
inv = b.read_working_inventory()
193
inv = b.get_revision_inventory(b.lookup_revision(revision))
195
for path, entry in inv.iter_entries():
196
print '%-50s %s' % (entry.file_id, path)
202
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
203
print 'revision number:', b.revno()
204
print 'number of versioned files:', len(b.read_working_inventory())
207
def cmd_remove(file_list, verbose=False):
208
Branch('.').remove(file_list, verbose=verbose)
212
def cmd_file_id(filename):
213
i = Branch('.').read_working_inventory().path2id(filename)
215
bailout("%s is not a versioned file" % filename)
220
def cmd_find_filename(fileid):
221
n = find_filename(fileid)
223
bailout("%s is not a live file id" % fileid)
228
def cmd_revision_history():
229
for patchid in Branch('.').revision_history():
235
# TODO: Check we're not already in a working directory? At the
236
# moment you'll get an ugly error.
238
# TODO: What if we're in a subdirectory of a branch? Would like
239
# to allow that, but then the parent may need to understand that
240
# the children have disappeared, or should they be versioned in
243
# TODO: Take an argument/option for branch name.
244
Branch('.', init=True)
247
def cmd_diff(revision=None):
248
"""Show diff from basis to working copy.
250
:todo: Take one or two revision arguments, look up those trees,
253
:todo: Allow diff across branches.
255
:todo: Mangle filenames in diff to be more relevant.
257
:todo: Shouldn't be in the cmd function.
263
old_tree = b.basis_tree()
265
old_tree = b.revision_tree(b.lookup_revision(revision))
267
new_tree = b.working_tree()
268
old_inv = old_tree.inventory
269
new_inv = new_tree.inventory
271
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
275
DEVNULL = '/dev/null'
276
# Windows users, don't panic about this filename -- it is a
277
# special signal to GNU patch that the file should be created or
278
# deleted respectively.
280
# TODO: Generation of pseudo-diffs for added/deleted files could
281
# be usefully made into a much faster special case.
283
# TODO: Better to return them in sorted order I think.
285
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
288
# Don't show this by default; maybe do it if an option is passed
289
# idlabel = ' {%s}' % fid
292
# FIXME: Something about the diff format makes patch unhappy
293
# with newly-added files.
295
def diffit(*a, **kw):
296
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
299
if file_state in ['.', '?', 'I']:
301
elif file_state == 'A':
302
print '*** added %s %r' % (kind, new_name)
305
new_tree.get_file(fid).readlines(),
307
tofile=new_label + new_name + idlabel)
308
elif file_state == 'D':
309
assert isinstance(old_name, types.StringTypes)
310
print '*** deleted %s %r' % (kind, old_name)
312
diffit(old_tree.get_file(fid).readlines(), [],
313
fromfile=old_label + old_name + idlabel,
315
elif file_state in ['M', 'R']:
316
if file_state == 'M':
317
assert kind == 'file'
318
assert old_name == new_name
319
print '*** modified %s %r' % (kind, new_name)
320
elif file_state == 'R':
321
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
324
diffit(old_tree.get_file(fid).readlines(),
325
new_tree.get_file(fid).readlines(),
326
fromfile=old_label + old_name + idlabel,
327
tofile=new_label + new_name)
329
bailout("can't represent state %s {%s}" % (file_state, fid))
334
"""Show log of this branch.
336
:todo: Options for utc; to show ids; to limit range; etc.
338
Branch('.').write_log()
341
def cmd_ls(revision=None, verbose=False):
342
"""List files in a tree.
344
:todo: Take a revision or remote path and list that tree instead.
348
tree = b.working_tree()
350
tree = b.revision_tree(b.lookup_revision(revision))
352
for fp, fc, kind, fid in tree.list_files():
534
# Add the description, indenting it 2 spaces
535
# to match the indentation of the options
536
if sections.has_key(None):
537
text = sections.pop(None)
538
text = '\n '.join(text.splitlines())
539
result += ':%s:\n %s\n\n' % ('Description',text)
541
# Add the custom sections (e.g. Examples). Note that there's no need
542
# to indent these as they must be indented already in the source.
545
if sections.has_key(label):
546
result += ':%s:\n%s\n' % (label,sections[label])
549
result += ("See bzr help %s for more details and examples.\n\n"
552
# Add the aliases, source (plug-in) and see also links, if any
554
result += ':Aliases: '
555
result += ', '.join(self.aliases) + '\n'
556
plugin_name = self.plugin_name()
557
if plugin_name is not None:
558
result += ':From: plugin "%s"\n' % plugin_name
559
see_also = self.get_see_also(additional_see_also)
561
if not plain and see_also_as_links:
563
for item in see_also:
565
# topics doesn't have an independent section
566
# so don't create a real link
567
see_also_links.append(item)
569
# Use a Sphinx link for this entry
570
link_text = ":doc:`%s <%s-help>`" % (item, item)
571
see_also_links.append(link_text)
572
see_also = see_also_links
573
result += ':See also: '
574
result += ', '.join(see_also) + '\n'
576
# If this will be rendered as plain text, convert it
578
import bzrlib.help_topics
579
result = bzrlib.help_topics.help_as_plain_text(result)
583
def _get_help_parts(text):
584
"""Split help text into a summary and named sections.
586
:return: (summary,sections,order) where summary is the top line and
587
sections is a dictionary of the rest indexed by section name.
588
order is the order the section appear in the text.
589
A section starts with a heading line of the form ":xxx:".
590
Indented text on following lines is the section value.
591
All text found outside a named section is assigned to the
592
default section which is given the key of None.
594
def save_section(sections, order, label, section):
596
if sections.has_key(label):
597
sections[label] += '\n' + section
600
sections[label] = section
602
lines = text.rstrip().splitlines()
603
summary = lines.pop(0)
606
label,section = None,''
608
if line.startswith(':') and line.endswith(':') and len(line) > 2:
609
save_section(sections, order, label, section)
610
label,section = line[1:-1],''
611
elif (label is not None) and len(line) > 1 and not line[0].isspace():
612
save_section(sections, order, label, section)
613
label,section = None,line
354
if kind == 'directory':
616
section += '\n' + line
619
save_section(sections, order, label, section)
620
return summary, sections, order
622
def get_help_topic(self):
623
"""Return the commands help topic - its name."""
626
def get_see_also(self, additional_terms=None):
627
"""Return a list of help topics that are related to this command.
629
The list is derived from the content of the _see_also attribute. Any
630
duplicates are removed and the result is in lexical order.
631
:param additional_terms: Additional help topics to cross-reference.
632
:return: A list of help topics.
634
see_also = set(getattr(self, '_see_also', []))
636
see_also.update(additional_terms)
637
return sorted(see_also)
640
"""Return dict of valid options for this command.
642
Maps from long option name to option object."""
643
r = Option.STD_OPTIONS.copy()
645
for o in self.takes_options:
646
if isinstance(o, basestring):
647
o = option.Option.OPTIONS[o]
649
if o.name in std_names:
650
self.supported_std_options.append(o.name)
653
def _setup_outf(self):
654
"""Return a file linked to stdout, which has proper encoding."""
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
658
def run_argv_aliases(self, argv, alias_argv=None):
659
"""Parse the command line and run with extra aliases in alias_argv."""
660
args, opts = parse_args(self, argv, alias_argv)
662
# Process the standard options
663
if 'help' in opts: # e.g. bzr add --help
664
sys.stdout.write(self.get_help_text())
666
if 'usage' in opts: # e.g. bzr add --usage
667
sys.stdout.write(self.get_help_text(verbose=False))
669
trace.set_verbosity_level(option._verbosity_level)
670
if 'verbose' in self.supported_std_options:
671
opts['verbose'] = trace.is_verbose()
672
elif opts.has_key('verbose'):
674
if 'quiet' in self.supported_std_options:
675
opts['quiet'] = trace.is_quiet()
676
elif opts.has_key('quiet'):
679
# mix arguments and options into one dictionary
680
cmdargs = _match_argform(self.name(), self.takes_args, args)
682
for k, v in opts.items():
683
cmdopts[k.replace('-', '_')] = v
685
all_cmd_args = cmdargs.copy()
686
all_cmd_args.update(cmdopts)
691
return self.run(**all_cmd_args)
693
# reset it, so that other commands run in the same process won't
694
# inherit state. Before we reset it, log any activity, so that it
695
# gets properly tracked.
696
ui.ui_factory.log_transport_activity(
697
display=('bytes' in debug.debug_flags))
698
trace.set_verbosity_level(0)
700
def _setup_run(self):
701
"""Wrap the defined run method on self with a cleanup.
703
This is called by __init__ to make the Command be able to be run
704
by just calling run(), as it could be before cleanups were added.
706
If a different form of cleanups are in use by your Command subclass,
707
you can override this method.
710
def run(*args, **kwargs):
711
self._operation = cleanup.OperationWithCleanups(class_run)
713
return self._operation.run_simple(*args, **kwargs)
718
@deprecated_method(deprecated_in((2, 2, 0)))
719
def run_direct(self, *args, **kwargs):
720
"""Deprecated thunk from bzrlib 2.1."""
721
return self.run(*args, **kwargs)
724
"""Actually run the command.
726
This is invoked with the options and arguments bound to
729
Return 0 or None if the command was successful, or a non-zero
730
shell error code if not. It's OK for this method to allow
731
an exception to raise up.
733
This method is automatically wrapped by Command.__init__ with a
734
cleanup operation, stored as self._operation. This can be used
735
via self.add_cleanup to perform automatic cleanups at the end of
738
The argument for run are assembled by introspection. So for instance,
739
if your command takes an argument files, you would declare::
741
def run(self, files=None):
744
raise NotImplementedError('no implementation of command %r'
748
"""Return help message for this class."""
749
from inspect import getdoc
750
if self.__doc__ is Command.__doc__:
755
return _unsquish_command_name(self.__class__.__name__)
757
def plugin_name(self):
758
"""Get the name of the plugin that provides this command.
760
:return: The name of the plugin or None if the command is builtin.
762
mod_parts = self.__module__.split('.')
763
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
361
print '%-8s %s%s' % (fc, fp, kindch)
769
class CommandHooks(Hooks):
770
"""Hooks related to Command object creation/enumeration."""
773
"""Create the default hooks.
775
These are all empty initially, because by default nothing should get
779
self.create_hook(HookPoint('extend_command',
780
"Called after creating a command object to allow modifications "
781
"such as adding or removing options, docs etc. Called with the "
782
"new bzrlib.commands.Command object.", (1, 13), None))
783
self.create_hook(HookPoint('get_command',
784
"Called when creating a single command. Called with "
785
"(cmd_or_None, command_name). get_command should either return "
786
"the cmd_or_None parameter, or a replacement Command object that "
787
"should be used for the command. Note that the Command.hooks "
788
"hooks are core infrastructure. Many users will prefer to use "
789
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
791
self.create_hook(HookPoint('get_missing_command',
792
"Called when creating a single command if no command could be "
793
"found. Called with (command_name). get_missing_command should "
794
"either return None, or a Command object to be used for the "
795
"command.", (1, 17), None))
796
self.create_hook(HookPoint('list_commands',
797
"Called when enumerating commands. Called with a set of "
798
"cmd_name strings for all the commands found so far. This set "
799
" is safe to mutate - e.g. to remove a command. "
800
"list_commands should return the updated set of command names.",
803
Command.hooks = CommandHooks()
806
def parse_args(command, argv, alias_argv=None):
368
"""List unknown files"""
369
for f in Branch('.').unknowns():
373
def cmd_lookup_revision(revno):
377
bailout("usage: lookup-revision REVNO",
378
["REVNO is a non-negative revision number for this branch"])
380
print Branch('.').lookup_revision(revno) or NONE_STRING
384
def cmd_export(revno, dest):
385
"""Export past revision to destination directory."""
387
rh = b.lookup_revision(int(revno))
388
t = b.revision_tree(rh)
393
######################################################################
394
# internal/test commands
398
"""Print a newly-generated UUID."""
403
def cmd_commit(message, verbose=False):
404
Branch('.').commit(message, verbose=verbose)
408
"""Check consistency of the branch."""
412
def cmd_is(pred, *rest):
413
"""Test whether PREDICATE is true."""
415
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
417
bailout("unknown predicate: %s" % quotefn(pred))
421
except BzrCheckError:
422
# by default we don't print the message so that this can
423
# be used from shell scripts without producing noise
428
print bzrlib.osutils.username()
431
def cmd_user_email():
432
print bzrlib.osutils.user_email()
435
def cmd_gen_revision_id():
437
print bzrlib.branch._gen_revision_id(time.time())
441
"""Run internal doctest suite"""
442
## -v, if present, is seen by doctest; the argument is just here
443
## so our parser doesn't complain
445
## TODO: --verbose option
447
import bzr, doctest, bzrlib.store
448
bzrlib.trace.verbose = False
450
doctest.testmod(bzrlib.store)
451
doctest.testmod(bzrlib.inventory)
452
doctest.testmod(bzrlib.branch)
453
doctest.testmod(bzrlib.osutils)
454
doctest.testmod(bzrlib.tree)
456
# more strenuous tests;
458
doctest.testmod(bzrlib.tests)
461
######################################################################
466
# TODO: Specific help for particular commands
471
print "bzr (bazaar-ng) %s" % __version__
473
print "http://bazaar-ng.org/"
476
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
477
you may use, modify and redistribute it under the terms of the GNU
478
General Public License version 2 or later."""
482
"""Statement of optimism."""
483
print "it sure does!"
487
######################################################################
491
# list of all available options; the rhs can be either None for an
492
# option that takes no argument, or a constructor function that checks
510
# List of options that apply to particular commands; commands not
514
'commit': ['message', 'verbose'],
515
'diff': ['revision'],
516
'inventory': ['revision'],
517
'ls': ['revision', 'verbose'],
520
'remove': ['verbose'],
529
'file-id': ['filename'],
530
'get-file-text': ['text_id'],
531
'get-inventory': ['inventory_id'],
532
'get-revision': ['revision_id'],
533
'get-revision-inventory': ['revision_id'],
535
'lookup-revision': ['revno'],
536
'export': ['revno', 'dest'],
542
def parse_args(argv):
807
543
"""Parse command line.
809
545
Arguments and options are parsed at this level before being passed
810
546
down to specific command handlers. This routine knows, from a
811
547
lookup table, something about the available options, what optargs
812
548
they take, and which commands will accept them.
550
>>> parse_args('bzr --help'.split())
552
>>> parse_args('bzr --version'.split())
553
([], {'version': True})
554
>>> parse_args('bzr status --all'.split())
555
(['status'], {'all': True})
814
# TODO: make it a method of the Command?
815
parser = option.get_optparser(command.options())
816
if alias_argv is not None:
817
args = alias_argv + argv
821
# for python 2.5 and later, optparse raises this exception if a non-ascii
822
# option name is given. See http://bugs.python.org/issue2931
824
options, args = parser.parse_args(args)
825
except UnicodeEncodeError,e:
826
raise errors.BzrCommandError('Only ASCII permitted in option names')
828
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
v is not option.OptionParser.DEFAULT_VALUE])
560
# TODO: Maybe handle '--' to end options?
567
mutter(" got option %r" % a)
569
if optname not in OPTIONS:
570
bailout('unknown long option %r' % a)
573
if shortopt not in SHORT_OPTIONS:
574
bailout('unknown short option %r' % a)
575
optname = SHORT_OPTIONS[shortopt]
578
# XXX: Do we ever want to support this, e.g. for -r?
579
bailout('repeated option %r' % a)
580
optargfn = OPTIONS[optname]
583
bailout('option %r needs an argument' % a)
584
opts[optname] = optargfn(it.next())
585
mutter(" option argument %r" % opts[optname])
587
# takes no option argument
590
bailout('unknown short option %r' % a)
830
594
return args, opts
833
def _match_argform(cmd, takes_args, args):
598
def _match_args(cmd, args):
599
"""Check non-option arguments match required pattern.
601
>>> _match_args('status', ['asdasdsadasd'])
602
Traceback (most recent call last):
604
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
605
>>> _match_args('add', ['asdasdsadasd'])
606
{'file_list': ['asdasdsadasd']}
607
>>> _match_args('add', 'abc def gj'.split())
608
{'file_list': ['abc', 'def', 'gj']}
610
# match argument pattern
611
argform = cmd_args.get(cmd, [])
836
# step through args and takes_args, allowing appropriate 0-many matches
837
for ap in takes_args:
613
# TODO: Need a way to express 'cp SRC... DEST', where it matches
838
616
argname = ap[:-1]
839
617
if ap[-1] == '?':
841
argdict[argname] = args.pop(0)
842
elif ap[-1] == '*': # all remaining arguments
844
argdict[argname + '_list'] = args[:]
847
argdict[argname + '_list'] = None
848
621
elif ap[-1] == '+':
850
raise errors.BzrCommandError("command %r needs one or more %s"
851
% (cmd, argname.upper()))
623
bailout("command %r needs one or more %s"
624
% (cmd, argname.upper()))
853
626
argdict[argname + '_list'] = args[:]
855
elif ap[-1] == '$': # all but one
857
raise errors.BzrCommandError("command %r needs one or more %s"
858
% (cmd, argname.upper()))
859
argdict[argname + '_list'] = args[:-1]
862
629
# just a plain arg
865
raise errors.BzrCommandError("command %r requires argument %s"
866
% (cmd, argname.upper()))
632
bailout("command %r requires argument %s"
633
% (cmd, argname.upper()))
868
635
argdict[argname] = args.pop(0)
871
raise errors.BzrCommandError("extra argument to command %s: %s"
638
bailout("extra arguments to command %s: %r"
876
def apply_coveraged(dirname, the_callable, *args, **kwargs):
877
# Cannot use "import trace", as that would import bzrlib.trace instead of
878
# the standard library's trace.
879
trace = __import__('trace')
881
tracer = trace.Trace(count=1, trace=0)
882
sys.settrace(tracer.globaltrace)
883
threading.settrace(tracer.globaltrace)
886
return exception_to_return_code(the_callable, *args, **kwargs)
889
results = tracer.results()
890
results.write_results(show_missing=1, summary=False,
894
def apply_profiled(the_callable, *args, **kwargs):
898
pffileno, pfname = tempfile.mkstemp()
900
prof = hotshot.Profile(pfname)
902
ret = prof.runcall(exception_to_return_code, the_callable, *args,
906
stats = hotshot.stats.load(pfname)
908
stats.sort_stats('cum') # 'time'
909
## XXX: Might like to write to stderr or the trace file instead but
910
## print_stats seems hardcoded to stdout
911
stats.print_stats(20)
646
"""Execute a command.
648
This is similar to main(), but without all the trappings for
649
logging and error handling.
652
args, opts = parse_args(argv)
654
# TODO: pass down other arguments in case they asked for
655
# help on a command name?
658
elif 'version' in opts:
663
log_error('usage: bzr COMMAND\n')
664
log_error(' try "bzr help"\n')
668
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
670
bailout("unknown command " + `cmd`)
672
# TODO: special --profile option to turn on the Python profiler
674
# check options are reasonable
675
allowed = cmd_options.get(cmd, [])
677
if oname not in allowed:
678
bailout("option %r is not allowed for command %r"
681
cmdargs = _match_args(cmd, args)
684
ret = cmd_handler(**cmdargs) or 0
689
## TODO: Handle command-line options; probably know what options are valid for
692
## TODO: If the arguments are wrong, give a usage message rather
693
## than just a backtrace.
696
t = bzrlib.trace._tracefile
697
t.write('-' * 60 + '\n')
698
t.write('bzr invoked at %s\n' % format_date(time.time()))
699
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
700
t.write(' arguments: %r\n' % argv)
702
starttime = os.times()[4]
705
t.write(' platform: %s\n' % platform.platform())
706
t.write(' python: %s\n' % platform.python_version())
711
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
713
mutter(" %.3f elapsed" % (times[4] - starttime))
918
def exception_to_return_code(the_callable, *args, **kwargs):
919
"""UI level helper for profiling and coverage.
921
This transforms exceptions into a return value of 3. As such its only
922
relevant to the UI layer, and should never be called where catching
923
exceptions may be desirable.
926
return the_callable(*args, **kwargs)
927
except (KeyboardInterrupt, Exception), e:
928
# used to handle AssertionError and KeyboardInterrupt
929
# specially here, but hopefully they're handled ok by the logger now
930
exc_info = sys.exc_info()
931
exitcode = trace.report_exception(exc_info, sys.stderr)
932
if os.environ.get('BZR_PDB'):
933
print '**** entering debugger'
936
if sys.version_info[:2] < (2, 6):
938
# pdb.post_mortem(tb)
939
# but because pdb.post_mortem gives bad results for tracebacks
940
# from inside generators, we do it manually.
941
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
943
# Setup pdb on the traceback
946
p.setup(tb.tb_frame, tb)
947
# Point the debugger at the deepest frame of the stack
948
p.curindex = len(p.stack) - 1
949
p.curframe = p.stack[p.curindex][0]
950
# Start the pdb prompt.
951
p.print_stack_entry(p.stack[p.curindex])
959
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
960
from bzrlib.lsprof import profile
961
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
967
trace.note('Profile data written to "%s".', filename)
971
@deprecated_function(deprecated_in((2, 2, 0)))
972
def shlex_split_unicode(unsplit):
973
return cmdline.split(unsplit)
976
def get_alias(cmd, config=None):
977
"""Return an expanded alias, or None if no alias exists.
980
Command to be checked for an alias.
982
Used to specify an alternative config to use,
983
which is especially useful for testing.
984
If it is unspecified, the global config will be used.
988
config = bzrlib.config.GlobalConfig()
989
alias = config.get_alias(cmd)
991
return cmdline.split(alias)
995
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
996
"""Execute a command.
998
:param argv: The command-line arguments, without the program name from
999
argv[0] These should already be decoded. All library/test code calling
1000
run_bzr should be passing valid strings (don't need decoding).
1001
:param load_plugins: What function to call when triggering plugin loading.
1002
This function should take no arguments and cause all plugins to be
1004
:param disable_plugins: What function to call when disabling plugin
1005
loading. This function should take no arguments and cause all plugin
1006
loading to be prohibited (so that code paths in your application that
1007
know about some plugins possibly being present will fail to import
1008
those plugins even if they are installed.)
1009
:return: Returns a command exit code or raises an exception.
1011
Special master options: these must come before the command because
1012
they control how the command is interpreted.
1015
Do not load plugin modules at all
1018
Do not allow aliases
1021
Only use builtin commands. (Plugins are still allowed to change
1025
Run under the Python hotshot profiler.
1028
Run under the Python lsprof profiler.
1031
Generate line coverage report in the specified directory.
1034
Specify the number of processes that can be run concurrently (selftest).
1036
trace.mutter("bazaar version: " + bzrlib.__version__)
1038
trace.mutter("bzr arguments: %r", argv)
1040
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1041
opt_no_aliases = False
1042
opt_lsprof_file = opt_coverage_dir = None
1044
# --no-plugins is handled specially at a very early stage. We need
1045
# to load plugins before doing other command parsing so that they
1046
# can override commands, but this needs to happen first.
1050
while i < len(argv):
1052
if a == '--profile':
1054
elif a == '--lsprof':
1056
elif a == '--lsprof-file':
1058
opt_lsprof_file = argv[i + 1]
1060
elif a == '--no-plugins':
1061
opt_no_plugins = True
1062
elif a == '--no-aliases':
1063
opt_no_aliases = True
1064
elif a == '--builtin':
1066
elif a == '--concurrency':
1067
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1069
elif a == '--coverage':
1070
opt_coverage_dir = argv[i + 1]
1072
elif a == '--profile-imports':
1073
pass # already handled in startup script Bug #588277
1074
elif a.startswith('-D'):
1075
debug.debug_flags.add(a[2:])
1080
debug.set_debug_flags_from_config()
1082
if not opt_no_plugins:
1089
get_cmd_object('help').run_argv_aliases([])
1092
if argv[0] == '--version':
1093
get_cmd_object('version').run_argv_aliases([])
1098
if not opt_no_aliases:
1099
alias_argv = get_alias(argv[0])
1101
argv[0] = alias_argv.pop(0)
1104
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1105
run = cmd_obj.run_argv_aliases
1106
run_argv = [argv, alias_argv]
1109
# We can be called recursively (tests for example), but we don't want
1110
# the verbosity level to propagate.
1111
saved_verbosity_level = option._verbosity_level
1112
option._verbosity_level = 0
1114
if opt_coverage_dir:
1116
'--coverage ignored, because --lsprof is in use.')
1117
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1119
if opt_coverage_dir:
1121
'--coverage ignored, because --profile is in use.')
1122
ret = apply_profiled(run, *run_argv)
1123
elif opt_coverage_dir:
1124
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1126
ret = run(*run_argv)
1129
# reset, in case we may do other commands later within the same
1130
# process. Commands that want to execute sub-commands must propagate
1131
# --verbose in their own way.
1132
if 'memory' in debug.debug_flags:
1133
trace.debug_memory('Process status after command:', short=False)
1134
option._verbosity_level = saved_verbosity_level
1137
def display_command(func):
1138
"""Decorator that suppresses pipe/interrupt errors."""
1139
def ignore_pipe(*args, **kwargs):
1141
result = func(*args, **kwargs)
1145
if getattr(e, 'errno', None) is None:
1147
if e.errno != errno.EPIPE:
1148
# Win32 raises IOError with errno=0 on a broken pipe
1149
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1152
except KeyboardInterrupt:
1157
def install_bzr_command_hooks():
1158
"""Install the hooks to supply bzr's own commands."""
1159
if _list_bzr_commands in Command.hooks["list_commands"]:
1161
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1163
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1165
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1166
"bzr plugin commands")
1167
Command.hooks.install_named_hook("get_command", _get_external_command,
1168
"bzr external command lookup")
1169
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1170
"bzr plugin-provider-db check")
1174
def _specified_or_unicode_argv(argv):
1175
# For internal or testing use, argv can be passed. Otherwise, get it from
1176
# the process arguments in a unicode-safe way.
1178
return osutils.get_unicode_argv()
1182
# ensure all arguments are unicode strings
1184
if isinstance(a, unicode):
1187
new_argv.append(a.decode('ascii'))
1188
except UnicodeDecodeError:
1189
raise errors.BzrError("argv should be list of unicode strings.")
1193
def main(argv=None):
1194
"""Main entry point of command-line interface.
1196
Typically `bzrlib.initialize` should be called first.
1198
:param argv: list of unicode command-line arguments similar to sys.argv.
1199
argv[0] is script name usually, it will be ignored.
1200
Don't pass here sys.argv because this list contains plain strings
1201
and not unicode; pass None instead.
1203
:return: exit code of bzr command.
1205
argv = _specified_or_unicode_argv(argv)
1206
_register_builtin_commands()
1207
ret = run_bzr_catch_errors(argv)
1208
trace.mutter("return code %d", ret)
1212
def run_bzr_catch_errors(argv):
1213
"""Run a bzr command with parameters as described by argv.
1215
This function assumed that that UI layer is setup, that symbol deprecations
1216
are already applied, and that unicode decoding has already been performed on argv.
1218
# done here so that they're covered for every test run
1219
install_bzr_command_hooks()
1220
return exception_to_return_code(run_bzr, argv)
1223
def run_bzr_catch_user_errors(argv):
1224
"""Run bzr and report user errors, but let internal errors propagate.
1226
This is used for the test suite, and might be useful for other programs
1227
that want to wrap the commandline interface.
1229
# done here so that they're covered for every test run
1230
install_bzr_command_hooks()
1232
return run_bzr(argv)
717
log_error('bzr: error: ' + e.args[0] + '\n')
720
log_error(' ' + h + '\n')
1233
722
except Exception, e:
1234
if (isinstance(e, (OSError, IOError))
1235
or not getattr(e, 'internal_error', True)):
1236
trace.report_exception(sys.exc_info(), sys.stderr)
1242
class HelpCommandIndex(object):
1243
"""A index for bzr help that returns commands."""
1246
self.prefix = 'commands/'
1248
def get_topics(self, topic):
1249
"""Search for topic amongst commands.
1251
:param topic: A topic to search for.
1252
:return: A list which is either empty or contains a single
1255
if topic and topic.startswith(self.prefix):
1256
topic = topic[len(self.prefix):]
1258
cmd = _get_cmd_object(topic, check_missing=False)
1265
class Provider(object):
1266
'''Generic class to be overriden by plugins'''
1268
def plugin_for_command(self, cmd_name):
1269
'''Takes a command and returns the information for that plugin
1271
:return: A dictionary with all the available information
1272
for the requested plugin
1274
raise NotImplementedError
1277
class ProvidersRegistry(registry.Registry):
1278
'''This registry exists to allow other providers to exist'''
1281
for key, provider in self.iteritems():
1284
command_providers_registry = ProvidersRegistry()
723
log_error('bzr: exception: %s\n' % e)
724
log_error(' see .bzr.log for details\n')
725
traceback.print_exc(None, bzrlib.trace._tracefile)
726
traceback.print_exc(None, sys.stderr)
729
# TODO: Maybe nicer handling of IOError?
733
if __name__ == '__main__':
734
sys.exit(main(sys.argv))
736
##profile.run('main(sys.argv)')
added
removed
bzr.py
