4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
8
3
# This program is free software; you can redistribute it and/or modify
9
4
# it under the terms of the GNU General Public License as published by
10
5
# the Free Software Foundation; either version 2 of the License, or
11
6
# (at your option) any later version.
13
8
# This program is distributed in the hope that it will be useful,
14
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
11
# GNU General Public License for more details.
18
13
# You should have received a copy of the GNU General Public License
19
14
# along with this program; if not, write to the Free Software
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
# Show some information about this branch.
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
81
from pprint import pprint
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
86
from bzrlib.store import ImmutableStore
87
from bzrlib.trace import mutter, note, log_error
88
from bzrlib.errors import bailout, BzrError
89
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
from bzrlib.revision import Revision
92
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
98
## standard representation
99
NONE_STRING = '(none)'
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
108
## TODO: Some kind of locking on branches. Perhaps there should be a
109
## parameter to the branch object saying whether we want a read or
110
## write lock; release it from destructor. Perhaps don't even need a
111
## read lock to look at immutable objects?
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
116
## TODO: Some kind of global code to generate the right Branch object
117
## to work on. Almost, but not quite all, commands need one, and it
118
## can be taken either from their parameters or their working
123
def cmd_status(all=False):
124
"""Display status summary.
126
For each file there is a single line giving its file state and name.
127
The name is that in the current revision unless it is deleted or
128
missing, in which case the old name is shown.
130
:todo: Don't show unchanged files unless ``--all`` is given?
132
Branch('.').show_status(show_all=all)
136
######################################################################
138
def cmd_get_revision(revision_id):
139
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
142
def cmd_get_file_text(text_id):
143
"""Get contents of a file by hash."""
144
sf = Branch('.').text_store[text_id]
145
pumpfile(sf, sys.stdout)
149
######################################################################
154
"""Show number of revisions on this branch"""
155
print Branch('.').revno()
158
def cmd_add(file_list, verbose=False):
159
"""Add specified files.
161
Fails if the files are already added.
163
Branch('.').add(file_list, verbose=verbose)
166
def cmd_inventory(revision=None):
167
"""Show inventory of the current working copy."""
168
## TODO: Also optionally show a previous inventory
169
## TODO: Format options
172
inv = b.read_working_inventory()
174
inv = b.get_revision_inventory(b.lookup_revision(revision))
176
for path, entry in inv.iter_entries():
177
print '%-50s %s' % (entry.file_id, path)
183
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
185
def plural(n, base='', pl=None):
193
count_version_dirs = 0
195
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
196
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
198
count_status[fs] += 1
199
if fs not in ['I', '?'] and st_tup[4] == 'directory':
200
count_version_dirs += 1
203
print 'in the working tree:'
204
for name, fs in (('unchanged', '.'),
205
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
206
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
208
print ' %5d %s' % (count_status[fs], name)
209
print ' %5d versioned subdirector%s' % (count_version_dirs,
210
plural(count_version_dirs, 'y', 'ies'))
213
print 'branch history:'
214
history = b.revision_history()
216
print ' %5d revision%s' % (revno, plural(revno))
219
committers.add(b.get_revision(rev).committer)
220
print ' %5d committer%s' % (len(committers), plural(len(committers)))
222
firstrev = b.get_revision(history[0])
223
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
224
print ' %5d day%s old' % (age, plural(age))
225
print ' first revision: %s' % format_date(firstrev.timestamp,
228
lastrev = b.get_revision(history[-1])
229
print ' latest revision: %s' % format_date(lastrev.timestamp,
235
def cmd_remove(file_list, verbose=False):
236
Branch('.').remove(file_list, verbose=verbose)
240
def cmd_file_id(filename):
241
i = Branch('.').read_working_inventory().path2id(filename)
243
bailout("%s is not a versioned file" % filename)
248
def cmd_find_filename(fileid):
249
n = find_filename(fileid)
251
bailout("%s is not a live file id" % fileid)
256
def cmd_revision_history():
257
for patchid in Branch('.').revision_history():
263
# TODO: Check we're not already in a working directory? At the
264
# moment you'll get an ugly error.
266
# TODO: What if we're in a subdirectory of a branch? Would like
267
# to allow that, but then the parent may need to understand that
268
# the children have disappeared, or should they be versioned in
271
# TODO: Take an argument/option for branch name.
272
Branch('.', init=True)
275
def cmd_diff(revision=None):
276
"""Show diff from basis to working copy.
278
:todo: Take one or two revision arguments, look up those trees,
281
:todo: Allow diff across branches.
283
:todo: Mangle filenames in diff to be more relevant.
285
:todo: Shouldn't be in the cmd function.
291
old_tree = b.basis_tree()
293
old_tree = b.revision_tree(b.lookup_revision(revision))
295
new_tree = b.working_tree()
296
old_inv = old_tree.inventory
297
new_inv = new_tree.inventory
299
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
303
DEVNULL = '/dev/null'
304
# Windows users, don't panic about this filename -- it is a
305
# special signal to GNU patch that the file should be created or
306
# deleted respectively.
308
# TODO: Generation of pseudo-diffs for added/deleted files could
309
# be usefully made into a much faster special case.
311
# TODO: Better to return them in sorted order I think.
313
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
316
# Don't show this by default; maybe do it if an option is passed
317
# idlabel = ' {%s}' % fid
320
# FIXME: Something about the diff format makes patch unhappy
321
# with newly-added files.
323
def diffit(*a, **kw):
324
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
327
if file_state in ['.', '?', 'I']:
329
elif file_state == 'A':
330
print '*** added %s %r' % (kind, new_name)
333
new_tree.get_file(fid).readlines(),
335
tofile=new_label + new_name + idlabel)
336
elif file_state == 'D':
337
assert isinstance(old_name, types.StringTypes)
338
print '*** deleted %s %r' % (kind, old_name)
340
diffit(old_tree.get_file(fid).readlines(), [],
341
fromfile=old_label + old_name + idlabel,
343
elif file_state in ['M', 'R']:
344
if file_state == 'M':
345
assert kind == 'file'
346
assert old_name == new_name
347
print '*** modified %s %r' % (kind, new_name)
348
elif file_state == 'R':
349
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
352
diffit(old_tree.get_file(fid).readlines(),
353
new_tree.get_file(fid).readlines(),
354
fromfile=old_label + old_name + idlabel,
355
tofile=new_label + new_name)
357
bailout("can't represent state %s {%s}" % (file_state, fid))
361
def cmd_log(timezone='original'):
362
"""Show log of this branch.
364
:todo: Options for utc; to show ids; to limit range; etc.
366
Branch('.').write_log(show_timezone=timezone)
369
def cmd_ls(revision=None, verbose=False):
370
"""List files in a tree.
372
:todo: Take a revision or remote path and list that tree instead.
376
tree = b.working_tree()
378
tree = b.revision_tree(b.lookup_revision(revision))
380
for fp, fc, kind, fid in tree.list_files():
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
return builtin_command_registry.keys()
228
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
return plugin_cmds.keys()
233
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
237
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
324
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
342
class Command(object):
343
"""Base class for commands.
345
Commands are the heart of the command-line bzr interface.
347
The command object mostly handles the mapping of command-line
348
parameters into one or more bzrlib operations, and of the results
351
Commands normally don't have any state. All their arguments are
352
passed in to the run method. (Subclasses may take a different
353
policy if the behaviour of the instance needs to depend on e.g. a
354
shell plugin and not just its Python class.)
356
The docstring for an actual command should give a single-line
357
summary, then a complete description of the command. A grammar
358
description will be inserted.
361
Other accepted names for this command.
364
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
381
If true, this command isn't advertised. This is typically
382
for commands intended for expert users.
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
399
:cvar hooks: An instance of CommandHooks.
404
encoding_type = 'strict'
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
414
self._operation = cleanup.OperationWithCleanups(self.run)
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf).
434
self._operation.cleanup_now()
436
@deprecated_method(deprecated_in((2, 1, 0)))
437
def _maybe_expand_globs(self, file_list):
438
"""Glob expand file_list if the platform does not do that itself.
440
Not used anymore, now that the bzr command-line parser globs on
443
:return: A possibly empty list of unicode paths.
445
Introduced in bzrlib 0.18.
450
"""Return single-line grammar for this command.
452
Only describes arguments, not options.
454
s = 'bzr ' + self.name() + ' '
455
for aname in self.takes_args:
456
aname = aname.upper()
457
if aname[-1] in ['$', '+']:
458
aname = aname[:-1] + '...'
459
elif aname[-1] == '?':
460
aname = '[' + aname[:-1] + ']'
461
elif aname[-1] == '*':
462
aname = '[' + aname[:-1] + '...]'
464
s = s[:-1] # remove last space
467
def get_help_text(self, additional_see_also=None, plain=True,
468
see_also_as_links=False, verbose=True):
469
"""Return a text string with help for this command.
471
:param additional_see_also: Additional help topics to be
473
:param plain: if False, raw help (reStructuredText) is
474
returned instead of plain text.
475
:param see_also_as_links: if True, convert items in 'See also'
476
list to internal links (used by bzr_man rstx generator)
477
:param verbose: if True, display the full help, otherwise
478
leave out the descriptive sections and just display
479
usage help (e.g. Purpose, Usage, Options) with a
480
message explaining how to obtain full help.
484
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
486
# Extract the summary (purpose) and sections out from the text
487
purpose,sections,order = self._get_help_parts(doc)
489
# If a custom usage section was provided, use it
490
if sections.has_key('Usage'):
491
usage = sections.pop('Usage')
493
usage = self._usage()
495
# The header is the purpose and usage
497
result += ':Purpose: %s\n' % purpose
498
if usage.find('\n') >= 0:
499
result += ':Usage:\n%s\n' % usage
501
result += ':Usage: %s\n' % usage
506
# XXX: optparse implicitly rewraps the help, and not always perfectly,
507
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
509
options = option.get_optparser(self.options()).format_option_help()
510
# XXX: According to the spec, ReST option lists actually don't support
511
# options like --1.9 so that causes syntax errors (in Sphinx at least).
512
# As that pattern always appears in the commands that break, we trap
513
# on that and then format that block of 'format' options as a literal
515
if not plain and options.find(' --1.9 ') != -1:
516
options = options.replace(' format:\n', ' format::\n\n', 1)
517
if options.startswith('Options:'):
518
result += ':' + options
519
elif options.startswith('options:'):
520
# Python 2.4 version of optparse
521
result += ':Options:' + options[len('options:'):]
382
if kind == 'directory':
527
# Add the description, indenting it 2 spaces
528
# to match the indentation of the options
529
if sections.has_key(None):
530
text = sections.pop(None)
531
text = '\n '.join(text.splitlines())
532
result += ':%s:\n %s\n\n' % ('Description',text)
534
# Add the custom sections (e.g. Examples). Note that there's no need
535
# to indent these as they must be indented already in the source.
538
if sections.has_key(label):
539
result += ':%s:\n%s\n' % (label,sections[label])
542
result += ("See bzr help %s for more details and examples.\n\n"
545
# Add the aliases, source (plug-in) and see also links, if any
547
result += ':Aliases: '
548
result += ', '.join(self.aliases) + '\n'
549
plugin_name = self.plugin_name()
550
if plugin_name is not None:
551
result += ':From: plugin "%s"\n' % plugin_name
552
see_also = self.get_see_also(additional_see_also)
554
if not plain and see_also_as_links:
556
for item in see_also:
558
# topics doesn't have an independent section
559
# so don't create a real link
560
see_also_links.append(item)
562
# Use a Sphinx link for this entry
563
link_text = ":doc:`%s <%s-help>`" % (item, item)
564
see_also_links.append(link_text)
565
see_also = see_also_links
566
result += ':See also: '
567
result += ', '.join(see_also) + '\n'
569
# If this will be rendered as plain text, convert it
571
import bzrlib.help_topics
572
result = bzrlib.help_topics.help_as_plain_text(result)
576
def _get_help_parts(text):
577
"""Split help text into a summary and named sections.
579
:return: (summary,sections,order) where summary is the top line and
580
sections is a dictionary of the rest indexed by section name.
581
order is the order the section appear in the text.
582
A section starts with a heading line of the form ":xxx:".
583
Indented text on following lines is the section value.
584
All text found outside a named section is assigned to the
585
default section which is given the key of None.
587
def save_section(sections, order, label, section):
589
if sections.has_key(label):
590
sections[label] += '\n' + section
593
sections[label] = section
595
lines = text.rstrip().splitlines()
596
summary = lines.pop(0)
599
label,section = None,''
601
if line.startswith(':') and line.endswith(':') and len(line) > 2:
602
save_section(sections, order, label, section)
603
label,section = line[1:-1],''
604
elif (label is not None) and len(line) > 1 and not line[0].isspace():
605
save_section(sections, order, label, section)
606
label,section = None,line
389
print '%-8s %s%s' % (fc, fp, kindch)
609
section += '\n' + line
612
save_section(sections, order, label, section)
613
return summary, sections, order
615
def get_help_topic(self):
616
"""Return the commands help topic - its name."""
619
def get_see_also(self, additional_terms=None):
620
"""Return a list of help topics that are related to this command.
622
The list is derived from the content of the _see_also attribute. Any
623
duplicates are removed and the result is in lexical order.
624
:param additional_terms: Additional help topics to cross-reference.
625
:return: A list of help topics.
627
see_also = set(getattr(self, '_see_also', []))
629
see_also.update(additional_terms)
630
return sorted(see_also)
633
"""Return dict of valid options for this command.
635
Maps from long option name to option object."""
636
r = Option.STD_OPTIONS.copy()
638
for o in self.takes_options:
639
if isinstance(o, basestring):
640
o = option.Option.OPTIONS[o]
642
if o.name in std_names:
643
self.supported_std_options.append(o.name)
646
def _setup_outf(self):
647
"""Return a file linked to stdout, which has proper encoding."""
648
self.outf = ui.ui_factory.make_output_stream(
649
encoding_type=self.encoding_type)
651
def run_argv_aliases(self, argv, alias_argv=None):
652
"""Parse the command line and run with extra aliases in alias_argv."""
653
args, opts = parse_args(self, argv, alias_argv)
655
# Process the standard options
656
if 'help' in opts: # e.g. bzr add --help
657
sys.stdout.write(self.get_help_text())
659
if 'usage' in opts: # e.g. bzr add --usage
660
sys.stdout.write(self.get_help_text(verbose=False))
662
trace.set_verbosity_level(option._verbosity_level)
663
if 'verbose' in self.supported_std_options:
664
opts['verbose'] = trace.is_verbose()
665
elif opts.has_key('verbose'):
667
if 'quiet' in self.supported_std_options:
668
opts['quiet'] = trace.is_quiet()
669
elif opts.has_key('quiet'):
672
# mix arguments and options into one dictionary
673
cmdargs = _match_argform(self.name(), self.takes_args, args)
675
for k, v in opts.items():
676
cmdopts[k.replace('-', '_')] = v
678
all_cmd_args = cmdargs.copy()
679
all_cmd_args.update(cmdopts)
683
return self.run_direct(**all_cmd_args)
685
def run_direct(self, *args, **kwargs):
686
"""Call run directly with objects (without parsing an argv list)."""
687
return self._operation.run_simple(*args, **kwargs)
690
"""Actually run the command.
692
This is invoked with the options and arguments bound to
695
Return 0 or None if the command was successful, or a non-zero
696
shell error code if not. It's OK for this method to allow
697
an exception to raise up.
699
raise NotImplementedError('no implementation of command %r'
703
"""Return help message for this class."""
704
from inspect import getdoc
705
if self.__doc__ is Command.__doc__:
710
return _unsquish_command_name(self.__class__.__name__)
712
def plugin_name(self):
713
"""Get the name of the plugin that provides this command.
715
:return: The name of the plugin or None if the command is builtin.
717
mod_parts = self.__module__.split('.')
718
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
396
"""List unknown files"""
397
for f in Branch('.').unknowns():
401
def cmd_lookup_revision(revno):
405
bailout("usage: lookup-revision REVNO",
406
["REVNO is a non-negative revision number for this branch"])
408
print Branch('.').lookup_revision(revno) or NONE_STRING
412
def cmd_export(revno, dest):
413
"""Export past revision to destination directory."""
415
rh = b.lookup_revision(int(revno))
416
t = b.revision_tree(rh)
421
######################################################################
422
# internal/test commands
426
"""Print a newly-generated UUID."""
431
def cmd_local_time_offset():
432
print bzrlib.osutils.local_time_offset()
436
def cmd_commit(message, verbose=False):
437
Branch('.').commit(message, verbose=verbose)
441
"""Check consistency of the branch."""
445
def cmd_is(pred, *rest):
446
"""Test whether PREDICATE is true."""
448
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
450
bailout("unknown predicate: %s" % quotefn(pred))
454
except BzrCheckError:
455
# by default we don't print the message so that this can
456
# be used from shell scripts without producing noise
461
print bzrlib.osutils.username()
464
def cmd_user_email():
465
print bzrlib.osutils.user_email()
468
def cmd_gen_revision_id():
470
print bzrlib.branch._gen_revision_id(time.time())
474
"""Run internal doctest suite"""
475
## -v, if present, is seen by doctest; the argument is just here
476
## so our parser doesn't complain
478
## TODO: --verbose option
480
import bzr, doctest, bzrlib.store
481
bzrlib.trace.verbose = False
483
doctest.testmod(bzrlib.store)
484
doctest.testmod(bzrlib.inventory)
485
doctest.testmod(bzrlib.branch)
486
doctest.testmod(bzrlib.osutils)
487
doctest.testmod(bzrlib.tree)
489
# more strenuous tests;
491
doctest.testmod(bzrlib.tests)
494
######################################################################
499
# TODO: Specific help for particular commands
504
print "bzr (bazaar-ng) %s" % __version__
506
print "http://bazaar-ng.org/"
509
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
510
you may use, modify and redistribute it under the terms of the GNU
511
General Public License version 2 or later."""
515
"""Statement of optimism."""
516
print "it sure does!"
520
######################################################################
524
# list of all available options; the rhs can be either None for an
525
# option that takes no argument, or a constructor function that checks
544
# List of options that apply to particular commands; commands not
548
'commit': ['message', 'verbose'],
549
'diff': ['revision'],
550
'inventory': ['revision'],
551
'log': ['show-ids', 'timezone'],
552
'ls': ['revision', 'verbose'],
553
'remove': ['verbose'],
563
'file-id': ['filename'],
564
'get-file-text': ['text_id'],
565
'get-inventory': ['inventory_id'],
566
'get-revision': ['revision_id'],
567
'get-revision-inventory': ['revision_id'],
569
'lookup-revision': ['revno'],
570
'export': ['revno', 'dest'],
576
def parse_args(argv):
724
class CommandHooks(Hooks):
725
"""Hooks related to Command object creation/enumeration."""
728
"""Create the default hooks.
730
These are all empty initially, because by default nothing should get
734
self.create_hook(HookPoint('extend_command',
735
"Called after creating a command object to allow modifications "
736
"such as adding or removing options, docs etc. Called with the "
737
"new bzrlib.commands.Command object.", (1, 13), None))
738
self.create_hook(HookPoint('get_command',
739
"Called when creating a single command. Called with "
740
"(cmd_or_None, command_name). get_command should either return "
741
"the cmd_or_None parameter, or a replacement Command object that "
742
"should be used for the command. Note that the Command.hooks "
743
"hooks are core infrastructure. Many users will prefer to use "
744
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
746
self.create_hook(HookPoint('get_missing_command',
747
"Called when creating a single command if no command could be "
748
"found. Called with (command_name). get_missing_command should "
749
"either return None, or a Command object to be used for the "
750
"command.", (1, 17), None))
751
self.create_hook(HookPoint('list_commands',
752
"Called when enumerating commands. Called with a set of "
753
"cmd_name strings for all the commands found so far. This set "
754
" is safe to mutate - e.g. to remove a command. "
755
"list_commands should return the updated set of command names.",
758
Command.hooks = CommandHooks()
761
def parse_args(command, argv, alias_argv=None):
577
762
"""Parse command line.
579
764
Arguments and options are parsed at this level before being passed
580
765
down to specific command handlers. This routine knows, from a
581
766
lookup table, something about the available options, what optargs
582
767
they take, and which commands will accept them.
584
>>> parse_args('--help'.split())
586
>>> parse_args('--version'.split())
587
([], {'version': True})
588
>>> parse_args('status --all'.split())
589
(['status'], {'all': True})
590
>>> parse_args('commit --message=biter'.split())
591
(['commit'], {'message': u'biter'})
596
# TODO: Maybe handle '--' to end options?
603
mutter(" got option %r" % a)
605
optname, optarg = a[2:].split('=', 1)
608
if optname not in OPTIONS:
609
bailout('unknown long option %r' % a)
612
if shortopt not in SHORT_OPTIONS:
613
bailout('unknown short option %r' % a)
614
optname = SHORT_OPTIONS[shortopt]
617
# XXX: Do we ever want to support this, e.g. for -r?
618
bailout('repeated option %r' % a)
620
optargfn = OPTIONS[optname]
624
bailout('option %r needs an argument' % a)
627
opts[optname] = optargfn(optarg)
628
mutter(" option argument %r" % opts[optname])
631
bailout('option %r takes no argument' % optname)
769
# TODO: make it a method of the Command?
770
parser = option.get_optparser(command.options())
771
if alias_argv is not None:
772
args = alias_argv + argv
776
options, args = parser.parse_args(args)
777
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
778
v is not option.OptionParser.DEFAULT_VALUE])
636
779
return args, opts
640
def _match_args(cmd, args):
641
"""Check non-option arguments match required pattern.
643
>>> _match_args('status', ['asdasdsadasd'])
644
Traceback (most recent call last):
646
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
647
>>> _match_args('add', ['asdasdsadasd'])
648
{'file_list': ['asdasdsadasd']}
649
>>> _match_args('add', 'abc def gj'.split())
650
{'file_list': ['abc', 'def', 'gj']}
652
# match argument pattern
653
argform = cmd_args.get(cmd, [])
782
def _match_argform(cmd, takes_args, args):
655
# TODO: Need a way to express 'cp SRC... DEST', where it matches
785
# step through args and takes_args, allowing appropriate 0-many matches
786
for ap in takes_args:
659
787
argname = ap[:-1]
660
788
if ap[-1] == '?':
790
argdict[argname] = args.pop(0)
791
elif ap[-1] == '*': # all remaining arguments
793
argdict[argname + '_list'] = args[:]
796
argdict[argname + '_list'] = None
664
797
elif ap[-1] == '+':
666
bailout("command %r needs one or more %s"
667
% (cmd, argname.upper()))
799
raise errors.BzrCommandError("command %r needs one or more %s"
800
% (cmd, argname.upper()))
669
802
argdict[argname + '_list'] = args[:]
804
elif ap[-1] == '$': # all but one
806
raise errors.BzrCommandError("command %r needs one or more %s"
807
% (cmd, argname.upper()))
808
argdict[argname + '_list'] = args[:-1]
672
811
# just a plain arg
675
bailout("command %r requires argument %s"
676
% (cmd, argname.upper()))
814
raise errors.BzrCommandError("command %r requires argument %s"
815
% (cmd, argname.upper()))
678
817
argdict[argname] = args.pop(0)
681
bailout("extra arguments to command %s: %r"
820
raise errors.BzrCommandError("extra argument to command %s: %s"
825
def apply_coveraged(dirname, the_callable, *args, **kwargs):
826
# Cannot use "import trace", as that would import bzrlib.trace instead of
827
# the standard library's trace.
828
trace = __import__('trace')
830
tracer = trace.Trace(count=1, trace=0)
831
sys.settrace(tracer.globaltrace)
832
threading.settrace(tracer.globaltrace)
835
return exception_to_return_code(the_callable, *args, **kwargs)
838
results = tracer.results()
839
results.write_results(show_missing=1, summary=False,
843
def apply_profiled(the_callable, *args, **kwargs):
847
pffileno, pfname = tempfile.mkstemp()
849
prof = hotshot.Profile(pfname)
851
ret = prof.runcall(exception_to_return_code, the_callable, *args,
855
stats = hotshot.stats.load(pfname)
857
stats.sort_stats('cum') # 'time'
858
## XXX: Might like to write to stderr or the trace file instead but
859
## print_stats seems hardcoded to stdout
860
stats.print_stats(20)
867
def exception_to_return_code(the_callable, *args, **kwargs):
868
"""UI level helper for profiling and coverage.
870
This transforms exceptions into a return value of 3. As such its only
871
relevant to the UI layer, and should never be called where catching
872
exceptions may be desirable.
875
return the_callable(*args, **kwargs)
876
except (KeyboardInterrupt, Exception), e:
877
# used to handle AssertionError and KeyboardInterrupt
878
# specially here, but hopefully they're handled ok by the logger now
879
exc_info = sys.exc_info()
880
exitcode = trace.report_exception(exc_info, sys.stderr)
881
if os.environ.get('BZR_PDB'):
882
print '**** entering debugger'
885
if sys.version_info[:2] < (2, 6):
887
# pdb.post_mortem(tb)
888
# but because pdb.post_mortem gives bad results for tracebacks
889
# from inside generators, we do it manually.
890
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
892
# Setup pdb on the traceback
895
p.setup(tb.tb_frame, tb)
896
# Point the debugger at the deepest frame of the stack
897
p.curindex = len(p.stack) - 1
898
p.curframe = p.stack[p.curindex][0]
899
# Start the pdb prompt.
900
p.print_stack_entry(p.stack[p.curindex])
908
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
909
from bzrlib.lsprof import profile
910
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
916
trace.note('Profile data written to "%s".', filename)
920
@deprecated_function(deprecated_in((2, 2, 0)))
921
def shlex_split_unicode(unsplit):
922
return cmdline.split(unsplit)
925
def get_alias(cmd, config=None):
926
"""Return an expanded alias, or None if no alias exists.
929
Command to be checked for an alias.
931
Used to specify an alternative config to use,
932
which is especially useful for testing.
933
If it is unspecified, the global config will be used.
937
config = bzrlib.config.GlobalConfig()
938
alias = config.get_alias(cmd)
940
return cmdline.split(alias)
944
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
689
945
"""Execute a command.
691
This is similar to main(), but without all the trappings for
692
logging and error handling.
695
args, opts = parse_args(argv[1:])
697
# TODO: pass down other arguments in case they asked for
698
# help on a command name?
701
elif 'version' in opts:
706
log_error('usage: bzr COMMAND\n')
707
log_error(' try "bzr help"\n')
711
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
713
bailout("unknown command " + `cmd`)
715
# TODO: special --profile option to turn on the Python profiler
717
# check options are reasonable
718
allowed = cmd_options.get(cmd, [])
720
if oname not in allowed:
721
bailout("option %r is not allowed for command %r"
724
cmdargs = _match_args(cmd, args)
727
ret = cmd_handler(**cmdargs) or 0
732
## TODO: Handle command-line options; probably know what options are valid for
735
## TODO: If the arguments are wrong, give a usage message rather
736
## than just a backtrace.
739
# TODO: Lift into separate function in trace.py
740
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
741
# Perhaps that should eventually go into the platform library?
742
# TODO: If the file doesn't exist, add a note describing it.
743
t = bzrlib.trace._tracefile
744
t.write('-' * 60 + '\n')
745
t.write('bzr invoked at %s\n' % format_date(time.time()))
746
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
747
t.write(' arguments: %r\n' % argv)
749
starttime = os.times()[4]
752
t.write(' platform: %s\n' % platform.platform())
753
t.write(' python: %s\n' % platform.python_version())
758
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
760
mutter(" %.3f elapsed" % (times[4] - starttime))
764
log_error('bzr: error: ' + e.args[0] + '\n')
767
log_error(' ' + h + '\n')
947
:param argv: The command-line arguments, without the program name from
948
argv[0] These should already be decoded. All library/test code calling
949
run_bzr should be passing valid strings (don't need decoding).
950
:param load_plugins: What function to call when triggering plugin loading.
951
This function should take no arguments and cause all plugins to be
953
:param disable_plugins: What function to call when disabling plugin
954
loading. This function should take no arguments and cause all plugin
955
loading to be prohibited (so that code paths in your application that
956
know about some plugins possibly being present will fail to import
957
those plugins even if they are installed.)
958
:return: Returns a command exit code or raises an exception.
960
Special master options: these must come before the command because
961
they control how the command is interpreted.
964
Do not load plugin modules at all
970
Only use builtin commands. (Plugins are still allowed to change
974
Run under the Python hotshot profiler.
977
Run under the Python lsprof profiler.
980
Generate line coverage report in the specified directory.
983
Specify the number of processes that can be run concurrently (selftest).
985
trace.mutter("bazaar version: " + bzrlib.__version__)
987
trace.mutter("bzr arguments: %r", argv)
989
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
990
opt_no_aliases = False
991
opt_lsprof_file = opt_coverage_dir = None
993
# --no-plugins is handled specially at a very early stage. We need
994
# to load plugins before doing other command parsing so that they
995
# can override commands, but this needs to happen first.
1001
if a == '--profile':
1003
elif a == '--lsprof':
1005
elif a == '--lsprof-file':
1007
opt_lsprof_file = argv[i + 1]
1009
elif a == '--no-plugins':
1010
opt_no_plugins = True
1011
elif a == '--no-aliases':
1012
opt_no_aliases = True
1013
elif a == '--builtin':
1015
elif a == '--concurrency':
1016
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1018
elif a == '--coverage':
1019
opt_coverage_dir = argv[i + 1]
1021
elif a.startswith('-D'):
1022
debug.debug_flags.add(a[2:])
1027
debug.set_debug_flags_from_config()
1029
if not opt_no_plugins:
1036
get_cmd_object('help').run_argv_aliases([])
1039
if argv[0] == '--version':
1040
get_cmd_object('version').run_argv_aliases([])
1045
if not opt_no_aliases:
1046
alias_argv = get_alias(argv[0])
1048
user_encoding = osutils.get_user_encoding()
1049
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1050
argv[0] = alias_argv.pop(0)
1053
# We want only 'ascii' command names, but the user may have typed
1054
# in a Unicode name. In that case, they should just get a
1055
# 'command not found' error later.
1057
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1058
run = cmd_obj.run_argv_aliases
1059
run_argv = [argv, alias_argv]
1062
# We can be called recursively (tests for example), but we don't want
1063
# the verbosity level to propagate.
1064
saved_verbosity_level = option._verbosity_level
1065
option._verbosity_level = 0
1067
if opt_coverage_dir:
1069
'--coverage ignored, because --lsprof is in use.')
1070
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1072
if opt_coverage_dir:
1074
'--coverage ignored, because --profile is in use.')
1075
ret = apply_profiled(run, *run_argv)
1076
elif opt_coverage_dir:
1077
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1079
ret = run(*run_argv)
1082
# reset, in case we may do other commands later within the same
1083
# process. Commands that want to execute sub-commands must propagate
1084
# --verbose in their own way.
1085
if 'memory' in debug.debug_flags:
1086
trace.debug_memory('Process status after command:', short=False)
1087
option._verbosity_level = saved_verbosity_level
1090
def display_command(func):
1091
"""Decorator that suppresses pipe/interrupt errors."""
1092
def ignore_pipe(*args, **kwargs):
1094
result = func(*args, **kwargs)
1098
if getattr(e, 'errno', None) is None:
1100
if e.errno != errno.EPIPE:
1101
# Win32 raises IOError with errno=0 on a broken pipe
1102
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1105
except KeyboardInterrupt:
1110
def install_bzr_command_hooks():
1111
"""Install the hooks to supply bzr's own commands."""
1112
if _list_bzr_commands in Command.hooks["list_commands"]:
1114
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1116
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1118
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1119
"bzr plugin commands")
1120
Command.hooks.install_named_hook("get_command", _get_external_command,
1121
"bzr external command lookup")
1122
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1123
"bzr plugin-provider-db check")
1127
def _specified_or_unicode_argv(argv):
1128
# For internal or testing use, argv can be passed. Otherwise, get it from
1129
# the process arguments in a unicode-safe way.
1131
return osutils.get_unicode_argv()
1135
# ensure all arguments are unicode strings
1137
if isinstance(a, unicode):
1140
new_argv.append(a.decode('ascii'))
1141
except UnicodeDecodeError:
1142
raise errors.BzrError("argv should be list of unicode strings.")
1146
def main(argv=None):
1147
"""Main entry point of command-line interface.
1149
Typically `bzrlib.initialize` should be called first.
1151
:param argv: list of unicode command-line arguments similar to sys.argv.
1152
argv[0] is script name usually, it will be ignored.
1153
Don't pass here sys.argv because this list contains plain strings
1154
and not unicode; pass None instead.
1156
:return: exit code of bzr command.
1158
argv = _specified_or_unicode_argv(argv)
1159
_register_builtin_commands()
1160
ret = run_bzr_catch_errors(argv)
1161
bzrlib.ui.ui_factory.log_transport_activity(
1162
display=('bytes' in debug.debug_flags))
1163
trace.mutter("return code %d", ret)
1167
def run_bzr_catch_errors(argv):
1168
"""Run a bzr command with parameters as described by argv.
1170
This function assumed that that UI layer is setup, that symbol deprecations
1171
are already applied, and that unicode decoding has already been performed on argv.
1173
# done here so that they're covered for every test run
1174
install_bzr_command_hooks()
1175
return exception_to_return_code(run_bzr, argv)
1178
def run_bzr_catch_user_errors(argv):
1179
"""Run bzr and report user errors, but let internal errors propagate.
1181
This is used for the test suite, and might be useful for other programs
1182
that want to wrap the commandline interface.
1184
# done here so that they're covered for every test run
1185
install_bzr_command_hooks()
1187
return run_bzr(argv)
769
1188
except Exception, e:
770
log_error('bzr: exception: %s\n' % e)
771
log_error(' see .bzr.log for details\n')
772
traceback.print_exc(None, bzrlib.trace._tracefile)
773
traceback.print_exc(None, sys.stderr)
776
# TODO: Maybe nicer handling of IOError?
780
if __name__ == '__main__':
781
sys.exit(main(sys.argv))
783
##profile.run('main(sys.argv)')
1189
if (isinstance(e, (OSError, IOError))
1190
or not getattr(e, 'internal_error', True)):
1191
trace.report_exception(sys.exc_info(), sys.stderr)
1197
class HelpCommandIndex(object):
1198
"""A index for bzr help that returns commands."""
1201
self.prefix = 'commands/'
1203
def get_topics(self, topic):
1204
"""Search for topic amongst commands.
1206
:param topic: A topic to search for.
1207
:return: A list which is either empty or contains a single
1210
if topic and topic.startswith(self.prefix):
1211
topic = topic[len(self.prefix):]
1213
cmd = _get_cmd_object(topic, check_missing=False)
1220
class Provider(object):
1221
'''Generic class to be overriden by plugins'''
1223
def plugin_for_command(self, cmd_name):
1224
'''Takes a command and returns the information for that plugin
1226
:return: A dictionary with all the available information
1227
for the requested plugin
1229
raise NotImplementedError
1232
class ProvidersRegistry(registry.Registry):
1233
'''This registry exists to allow other providers to exist'''
1236
for key, provider in self.iteritems():
1239
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
