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
# 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
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
88
from bzrlib.store import ImmutableStore
89
from bzrlib.trace import mutter, note, log_error
90
from bzrlib.errors import bailout, BzrError
91
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
92
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
93
from bzrlib.revision import Revision
94
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
97
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
98
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
100
## standard representation
101
NONE_STRING = '(none)'
105
## TODO: Perhaps a different version of inventory commands that
106
## returns iterators...
108
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
110
## TODO: Some kind of locking on branches. Perhaps there should be a
111
## parameter to the branch object saying whether we want a read or
112
## write lock; release it from destructor. Perhaps don't even need a
113
## read lock to look at immutable objects?
115
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
116
## to compare output?
121
######################################################################
125
def cmd_status(all=False):
126
"""Display status summary.
128
For each file there is a single line giving its file state and name.
129
The name is that in the current revision unless it is deleted or
130
missing, in which case the old name is shown.
132
:todo: Don't show unchanged files unless ``--all`` is given?
134
Branch('.').show_status(show_all=all)
138
######################################################################
140
def cmd_get_revision(revision_id):
141
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
144
def cmd_get_inventory(inventory_id):
145
"""Return inventory in XML by hash"""
146
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
149
def cmd_get_revision_inventory(revision_id):
150
"""Output inventory for a revision."""
152
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
155
def cmd_get_file_text(text_id):
156
"""Get contents of a file by hash."""
157
sf = Branch('.').text_store[text_id]
158
pumpfile(sf, sys.stdout)
162
######################################################################
167
"""Show number of revisions on this branch"""
168
print Branch('.').revno()
171
def cmd_add(file_list, verbose=False):
172
"""Add specified files.
174
Fails if the files are already added.
176
Branch('.').add(file_list, verbose=verbose)
179
def cmd_inventory(revision=None):
180
"""Show inventory of the current working copy."""
181
## TODO: Also optionally show a previous inventory
182
## TODO: Format options
185
inv = b.read_working_inventory()
187
inv = b.get_revision_inventory(b.lookup_revision(revision))
189
for path, entry in inv.iter_entries():
190
print '%-50s %s' % (entry.file_id, path)
196
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
197
print 'revision number:', b.revno()
198
print 'number of versioned files:', len(b.read_working_inventory())
201
def cmd_remove(file_list, verbose=False):
202
Branch('.').remove(file_list, verbose=verbose)
206
def cmd_file_id(filename):
207
i = Branch('.').read_working_inventory().path2id(filename)
209
bailout("%s is not a versioned file" % filename)
214
def cmd_find_filename(fileid):
215
n = find_filename(fileid)
217
bailout("%s is not a live file id" % fileid)
222
def cmd_revision_history():
223
for patchid in Branch('.').revision_history():
229
# TODO: Check we're not already in a working directory? At the
230
# moment you'll get an ugly error.
232
# TODO: What if we're in a subdirectory of a branch? Would like
233
# to allow that, but then the parent may need to understand that
234
# the children have disappeared, or should they be versioned in
237
# TODO: Take an argument/option for branch name.
238
Branch('.', init=True)
241
def cmd_diff(revision=None):
242
"""Show diff from basis to working copy.
244
:todo: Take one or two revision arguments, look up those trees,
247
:todo: Allow diff across branches.
249
:todo: Mangle filenames in diff to be more relevant.
251
:todo: Shouldn't be in the cmd function.
257
old_tree = b.basis_tree()
259
old_tree = b.revision_tree(b.lookup_revision(revision))
261
new_tree = b.working_tree()
262
old_inv = old_tree.inventory
263
new_inv = new_tree.inventory
265
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
269
DEVNULL = '/dev/null'
270
# Windows users, don't panic about this filename -- it is a
271
# special signal to GNU patch that the file should be created or
272
# deleted respectively.
274
# TODO: Generation of pseudo-diffs for added/deleted files could
275
# be usefully made into a much faster special case.
277
# TODO: Better to return them in sorted order I think.
279
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
282
# Don't show this by default; maybe do it if an option is passed
283
# idlabel = ' {%s}' % fid
286
# FIXME: Something about the diff format makes patch unhappy
287
# with newly-added files.
289
def diffit(*a, **kw):
290
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
293
if file_state in ['.', '?', 'I']:
295
elif file_state == 'A':
296
print '*** added %s %r' % (kind, new_name)
299
new_tree.get_file(fid).readlines(),
301
tofile=new_label + new_name + idlabel)
302
elif file_state == 'D':
303
assert isinstance(old_name, types.StringTypes)
304
print '*** deleted %s %r' % (kind, old_name)
306
diffit(old_tree.get_file(fid).readlines(), [],
307
fromfile=old_label + old_name + idlabel,
309
elif file_state in ['M', 'R']:
310
if file_state == 'M':
311
assert kind == 'file'
312
assert old_name == new_name
313
print '*** modified %s %r' % (kind, new_name)
314
elif file_state == 'R':
315
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
318
diffit(old_tree.get_file(fid).readlines(),
319
new_tree.get_file(fid).readlines(),
320
fromfile=old_label + old_name + idlabel,
321
tofile=new_label + new_name)
323
bailout("can't represent state %s {%s}" % (file_state, fid))
327
def cmd_log(timezone='original'):
328
"""Show log of this branch.
330
:todo: Options for utc; to show ids; to limit range; etc.
332
Branch('.').write_log(show_timezone=timezone)
335
def cmd_ls(revision=None, verbose=False):
336
"""List files in a tree.
338
:todo: Take a revision or remote path and list that tree instead.
342
tree = b.working_tree()
344
tree = b.revision_tree(b.lookup_revision(revision))
346
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 = []
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). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
491
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
493
usage = sections.pop('Usage')
495
usage = self._usage()
497
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
500
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
503
result += ':Usage: %s\n' % usage
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
348
if kind == 'directory':
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
547
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
550
result += ', '.join(self.aliases) + '\n'
551
plugin_name = self.plugin_name()
552
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
554
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
578
def _get_help_parts(text):
579
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
A section starts with a heading line of the form ":xxx:".
585
Indented text on following lines is the section value.
586
All text found outside a named section is assigned to the
587
default section which is given the key of None.
589
def save_section(sections, order, label, section):
591
if sections.has_key(label):
592
sections[label] += '\n' + section
595
sections[label] = section
597
lines = text.rstrip().splitlines()
598
summary = lines.pop(0)
601
label,section = None,''
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
608
label,section = None,line
355
print '%-8s %s%s' % (fc, fp, kindch)
611
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
617
def get_help_topic(self):
618
"""Return the commands help topic - its name."""
621
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
624
The list is derived from the content of the _see_also attribute. Any
625
duplicates are removed and the result is in lexical order.
626
:param additional_terms: Additional help topics to cross-reference.
627
:return: A list of help topics.
629
see_also = set(getattr(self, '_see_also', []))
631
see_also.update(additional_terms)
632
return sorted(see_also)
635
"""Return dict of valid options for this command.
637
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
640
for o in self.takes_options:
641
if isinstance(o, basestring):
642
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
def _setup_outf(self):
649
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
653
def run_argv_aliases(self, argv, alias_argv=None):
654
"""Parse the command line and run with extra aliases in alias_argv."""
655
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
674
# mix arguments and options into one dictionary
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
677
for k, v in opts.items():
678
cmdopts[k.replace('-', '_')] = v
680
all_cmd_args = cmdargs.copy()
681
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
711
"""Actually run the command.
713
This is invoked with the options and arguments bound to
716
Return 0 or None if the command was successful, or a non-zero
717
shell error code if not. It's OK for this method to allow
718
an exception to raise up.
720
This method is automatically wrapped by Command.__init__ with a
721
cleanup operation, stored as self._operation. This can be used
722
via self.add_cleanup to perform automatic cleanups at the end of
725
The argument for run are assembled by introspection. So for instance,
726
if your command takes an argument files, you would declare::
728
def run(self, files=None):
731
raise NotImplementedError('no implementation of command %r'
735
"""Return help message for this class."""
736
from inspect import getdoc
737
if self.__doc__ is Command.__doc__:
742
return _unsquish_command_name(self.__class__.__name__)
744
def plugin_name(self):
745
"""Get the name of the plugin that provides this command.
747
:return: The name of the plugin or None if the command is builtin.
749
mod_parts = self.__module__.split('.')
750
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
362
"""List unknown files"""
363
for f in Branch('.').unknowns():
367
def cmd_lookup_revision(revno):
371
bailout("usage: lookup-revision REVNO",
372
["REVNO is a non-negative revision number for this branch"])
374
print Branch('.').lookup_revision(revno) or NONE_STRING
378
def cmd_export(revno, dest):
379
"""Export past revision to destination directory."""
381
rh = b.lookup_revision(int(revno))
382
t = b.revision_tree(rh)
387
######################################################################
388
# internal/test commands
392
"""Print a newly-generated UUID."""
397
def cmd_local_time_offset():
398
print bzrlib.osutils.local_time_offset()
402
def cmd_commit(message, verbose=False):
403
Branch('.').commit(message, verbose=verbose)
407
"""Check consistency of the branch."""
411
def cmd_is(pred, *rest):
412
"""Test whether PREDICATE is true."""
414
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
416
bailout("unknown predicate: %s" % quotefn(pred))
420
except BzrCheckError:
421
# by default we don't print the message so that this can
422
# be used from shell scripts without producing noise
427
print bzrlib.osutils.username()
430
def cmd_user_email():
431
print bzrlib.osutils.user_email()
434
def cmd_gen_revision_id():
436
print bzrlib.branch._gen_revision_id(time.time())
440
"""Run internal doctest suite"""
441
## -v, if present, is seen by doctest; the argument is just here
442
## so our parser doesn't complain
444
## TODO: --verbose option
446
import bzr, doctest, bzrlib.store
447
bzrlib.trace.verbose = False
449
doctest.testmod(bzrlib.store)
450
doctest.testmod(bzrlib.inventory)
451
doctest.testmod(bzrlib.branch)
452
doctest.testmod(bzrlib.osutils)
453
doctest.testmod(bzrlib.tree)
455
# more strenuous tests;
457
doctest.testmod(bzrlib.tests)
460
######################################################################
465
# TODO: Specific help for particular commands
470
print "bzr (bazaar-ng) %s" % __version__
472
print "http://bazaar-ng.org/"
475
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
476
you may use, modify and redistribute it under the terms of the GNU
477
General Public License version 2 or later."""
481
"""Statement of optimism."""
482
print "it sure does!"
486
######################################################################
490
# list of all available options; the rhs can be either None for an
491
# 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
'log': ['show-ids', 'timezone'],
518
'ls': ['revision', 'verbose'],
519
'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):
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
793
def parse_args(command, argv, alias_argv=None):
543
794
"""Parse command line.
545
796
Arguments and options are parsed at this level before being passed
546
797
down to specific command handlers. This routine knows, from a
547
798
lookup table, something about the available options, what optargs
548
799
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})
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)
801
# TODO: make it a method of the Command?
802
parser = option.get_optparser(command.options())
803
if alias_argv is not None:
804
args = alias_argv + argv
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
594
811
return args, opts
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, [])
814
def _match_argform(cmd, takes_args, args):
613
# TODO: Need a way to express 'cp SRC... DEST', where it matches
817
# step through args and takes_args, allowing appropriate 0-many matches
818
for ap in takes_args:
616
819
argname = ap[:-1]
617
820
if ap[-1] == '?':
822
argdict[argname] = args.pop(0)
823
elif ap[-1] == '*': # all remaining arguments
825
argdict[argname + '_list'] = args[:]
828
argdict[argname + '_list'] = None
621
829
elif ap[-1] == '+':
623
bailout("command %r needs one or more %s"
624
% (cmd, argname.upper()))
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
626
834
argdict[argname + '_list'] = args[:]
836
elif ap[-1] == '$': # all but one
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
840
argdict[argname + '_list'] = args[:-1]
629
843
# just a plain arg
632
bailout("command %r requires argument %s"
633
% (cmd, argname.upper()))
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
635
849
argdict[argname] = args.pop(0)
638
bailout("extra arguments to command %s: %r"
852
raise errors.BzrCommandError("extra argument to command %s: %s"
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
859
# the standard library's trace.
860
trace = __import__('trace')
862
tracer = trace.Trace(count=1, trace=0)
863
sys.settrace(tracer.globaltrace)
864
threading.settrace(tracer.globaltrace)
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
875
def apply_profiled(the_callable, *args, **kwargs):
879
pffileno, pfname = tempfile.mkstemp()
881
prof = hotshot.Profile(pfname)
883
ret = prof.runcall(exception_to_return_code, the_callable, *args,
887
stats = hotshot.stats.load(pfname)
889
stats.sort_stats('cum') # 'time'
890
## XXX: Might like to write to stderr or the trace file instead but
891
## print_stats seems hardcoded to stdout
892
stats.print_stats(20)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
948
trace.note('Profile data written to "%s".', filename)
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
957
def get_alias(cmd, config=None):
958
"""Return an expanded alias, or None if no alias exists.
961
Command to be checked for an alias.
963
Used to specify an alternative config to use,
964
which is especially useful for testing.
965
If it is unspecified, the global config will be used.
969
config = bzrlib.config.GlobalConfig()
970
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
646
977
"""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))
717
log_error('bzr: error: ' + e.args[0] + '\n')
720
log_error(' ' + h + '\n')
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
992
Special master options: these must come before the command because
993
they control how the command is interpreted.
996
Do not load plugin modules at all
1002
Only use builtin commands. (Plugins are still allowed to change
1006
Run under the Python hotshot profiler.
1009
Run under the Python lsprof profiler.
1012
Generate line coverage report in the specified directory.
1015
Specify the number of processes that can be run concurrently (selftest).
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof_file = opt_coverage_dir = None
1025
# --no-plugins is handled specially at a very early stage. We need
1026
# to load plugins before doing other command parsing so that they
1027
# can override commands, but this needs to happen first.
1031
while i < len(argv):
1033
if a == '--profile':
1035
elif a == '--lsprof':
1037
elif a == '--lsprof-file':
1039
opt_lsprof_file = argv[i + 1]
1041
elif a == '--no-plugins':
1042
opt_no_plugins = True
1043
elif a == '--no-aliases':
1044
opt_no_aliases = True
1045
elif a == '--builtin':
1047
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1050
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
1053
elif a.startswith('-D'):
1054
debug.debug_flags.add(a[2:])
1059
debug.set_debug_flags_from_config()
1061
if not opt_no_plugins:
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1077
if not opt_no_aliases:
1078
alias_argv = get_alias(argv[0])
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
argv[0] = alias_argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1090
run = cmd_obj.run_argv_aliases
1091
run_argv = [argv, alias_argv]
1094
# We can be called recursively (tests for example), but we don't want
1095
# the verbosity level to propagate.
1096
saved_verbosity_level = option._verbosity_level
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
'--coverage ignored, because --lsprof is in use.')
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
1107
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
ret = run(*run_argv)
1114
# reset, in case we may do other commands later within the same
1115
# process. Commands that want to execute sub-commands must propagate
1116
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
option._verbosity_level = saved_verbosity_level
1122
def display_command(func):
1123
"""Decorator that suppresses pipe/interrupt errors."""
1124
def ignore_pipe(*args, **kwargs):
1126
result = func(*args, **kwargs)
1130
if getattr(e, 'errno', None) is None:
1132
if e.errno != errno.EPIPE:
1133
# Win32 raises IOError with errno=0 on a broken pipe
1134
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1137
except KeyboardInterrupt:
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
trace.mutter("return code %d", ret)
1199
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
return run_bzr(argv)
722
1220
except Exception, e:
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)')
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
1229
class HelpCommandIndex(object):
1230
"""A index for bzr help that returns commands."""
1233
self.prefix = 'commands/'
1235
def get_topics(self, topic):
1236
"""Search for topic amongst commands.
1238
:param topic: A topic to search for.
1239
:return: A list which is either empty or contains a single
1242
if topic and topic.startswith(self.prefix):
1243
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
