4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2006, 2008, 2009 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: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
39
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():
54
from bzrlib.hooks import HookPoint, Hooks
55
# Compatibility - Option used to be in commands.
56
from bzrlib.option import Option
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
suppress_deprecation_warnings,
66
class CommandInfo(object):
67
"""Information about a command."""
69
def __init__(self, aliases):
70
"""The list of aliases for the command."""
71
self.aliases = aliases
74
def from_command(klass, command):
75
"""Factory to construct a CommandInfo from a command."""
76
return klass(command.aliases)
79
class CommandRegistry(registry.Registry):
82
def _get_name(command_name):
83
if command_name.startswith("cmd_"):
84
return _unsquish_command_name(command_name)
88
def register(self, cmd, decorate=False):
89
"""Utility function to help register a command
91
:param cmd: Command subclass to register
92
:param decorate: If true, allow overriding an existing command
93
of the same name; the old command is returned by this function.
94
Otherwise it is an error to try to override an existing command.
97
k_unsquished = self._get_name(k)
99
previous = self.get(k_unsquished)
101
previous = _builtin_commands().get(k_unsquished)
102
info = CommandInfo.from_command(cmd)
104
registry.Registry.register(self, k_unsquished, cmd,
105
override_existing=decorate, info=info)
107
trace.warning('Two plugins defined the same command: %r' % k)
108
trace.warning('Not loading the one in %r' %
109
sys.modules[cmd.__module__])
110
trace.warning('Previously this command was registered from %r' %
111
sys.modules[previous.__module__])
114
def register_lazy(self, command_name, aliases, module_name):
115
"""Register a command without loading its module.
117
:param command_name: The primary name of the command.
118
:param aliases: A list of aliases for the command.
119
:module_name: The module that the command lives in.
121
key = self._get_name(command_name)
122
registry.Registry.register_lazy(self, key, module_name, command_name,
123
info=CommandInfo(aliases))
126
plugin_cmds = CommandRegistry()
129
def register_command(cmd, decorate=False):
131
return plugin_cmds.register(cmd, decorate)
134
def _squish_command_name(cmd):
135
return 'cmd_' + cmd.replace('-', '_')
138
def _unsquish_command_name(cmd):
139
return cmd[4:].replace('_','-')
142
def _builtin_commands():
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
150
if name.startswith("cmd_"):
151
real_name = _unsquish_command_name(name)
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
181
return _builtin_commands().keys()
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
return plugin_cmds.keys()
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
199
d = _builtin_commands()
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
206
def get_cmd_object(cmd_name, plugins_override=True):
207
"""Return the command object for a command.
210
If true, plugin commands can override builtins.
213
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
219
"""Get a command object.
221
:param cmd_name: The name of the command.
222
:param plugins_override: Allow plugins to override builtins.
223
:return: A Command object instance
224
:raises KeyError: If no command is found.
226
# We want only 'ascii' command names, but the user may have typed
227
# in a Unicode name. In that case, they should just get a
228
# 'command not found' error later.
229
# In the future, we may actually support Unicode command names.
232
for hook in Command.hooks['get_command']:
233
cmd = hook(cmd, cmd_name)
234
if cmd is not None and not plugins_override and not cmd.plugin_name():
235
# We've found a non-plugin command, don't permit it to be
239
for hook in Command.hooks['get_missing_command']:
246
# Allow plugins to extend commands
247
for hook in Command.hooks['extend_command']:
252
def _try_plugin_provider(cmd_name):
253
"""Probe for a plugin provider having cmd_name."""
255
plugin_metadata, provider = probe_for_provider(cmd_name)
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
262
def probe_for_provider(cmd_name):
263
"""Look for a provider for cmd_name.
265
:param cmd_name: The command name.
266
:return: plugin_metadata, provider for getting cmd_name.
267
:raises NoPluginAvailable: When no provider can supply the plugin.
269
# look for providers that provide this command but aren't installed
270
for provider in command_providers_registry:
272
return provider.plugin_for_command(cmd_name), provider
273
except errors.NoPluginAvailable:
275
raise errors.NoPluginAvailable(cmd_name)
278
def _get_bzr_command(cmd_or_None, cmd_name):
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
282
return cmds[cmd_name]()
285
# look for any command which claims this as an alias
286
for real_cmd_name, cmd_class in cmds.iteritems():
287
if cmd_name in cmd_class.aliases:
292
def _get_external_command(cmd_or_None, cmd_name):
293
"""Lookup a command that is a shell script."""
294
# Only do external command lookups when no command is found so far.
295
if cmd_or_None is not None:
297
from bzrlib.externalcommand import ExternalCommand
298
cmd_obj = ExternalCommand.find_command(cmd_name)
303
def _get_plugin_command(cmd_or_None, cmd_name):
304
"""Get a command from bzr's plugins."""
306
return plugin_cmds.get(cmd_name)()
309
for key in plugin_cmds.keys():
310
info = plugin_cmds.get_info(key)
311
if cmd_name in info.aliases:
312
return plugin_cmds.get(key)()
316
class Command(object):
317
"""Base class for commands.
319
Commands are the heart of the command-line bzr interface.
321
The command object mostly handles the mapping of command-line
322
parameters into one or more bzrlib operations, and of the results
325
Commands normally don't have any state. All their arguments are
326
passed in to the run method. (Subclasses may take a different
327
policy if the behaviour of the instance needs to depend on e.g. a
328
shell plugin and not just its Python class.)
330
The docstring for an actual command should give a single-line
331
summary, then a complete description of the command. A grammar
332
description will be inserted.
335
Other accepted names for this command.
338
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
355
If true, this command isn't advertised. This is typically
356
for commands intended for expert users.
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
373
:cvar hooks: An instance of CommandHooks.
378
encoding_type = 'strict'
383
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
386
# List of standard options directly supported
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
"""Register a function to call after self.run returns or raises.
393
Functions will be called in LIFO order.
395
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
397
def cleanup_now(self):
398
"""Execute and empty pending cleanup functions immediately.
400
After cleanup_now all registered cleanups are forgotten. add_cleanup
401
may be called again after cleanup_now; these cleanups will be called
402
after self.run returns or raises (or when cleanup_now is next called).
404
This is useful for releasing expensive or contentious resources (such
405
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
424
"""Return single-line grammar for this command.
426
Only describes arguments, not options.
428
s = 'bzr ' + self.name() + ' '
429
for aname in self.takes_args:
430
aname = aname.upper()
431
if aname[-1] in ['$', '+']:
432
aname = aname[:-1] + '...'
433
elif aname[-1] == '?':
434
aname = '[' + aname[:-1] + ']'
435
elif aname[-1] == '*':
436
aname = '[' + aname[:-1] + '...]'
438
s = s[:-1] # remove last space
441
def get_help_text(self, additional_see_also=None, plain=True,
442
see_also_as_links=False, verbose=True):
443
"""Return a text string with help for this command.
445
:param additional_see_also: Additional help topics to be
447
:param plain: if False, raw help (reStructuredText) is
448
returned instead of plain text.
449
:param see_also_as_links: if True, convert items in 'See also'
450
list to internal links (used by bzr_man rstx generator)
451
:param verbose: if True, display the full help, otherwise
452
leave out the descriptive sections and just display
453
usage help (e.g. Purpose, Usage, Options) with a
454
message explaining how to obtain full help.
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
460
# Extract the summary (purpose) and sections out from the text
461
purpose,sections,order = self._get_help_parts(doc)
463
# If a custom usage section was provided, use it
464
if sections.has_key('Usage'):
465
usage = sections.pop('Usage')
467
usage = self._usage()
469
# The header is the purpose and usage
471
result += ':Purpose: %s\n' % purpose
472
if usage.find('\n') >= 0:
473
result += ':Usage:\n%s\n' % usage
475
result += ':Usage: %s\n' % usage
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
490
options = options.replace(' format:\n', ' format::\n\n', 1)
491
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
348
if kind == 'directory':
501
# Add the description, indenting it 2 spaces
502
# to match the indentation of the options
503
if sections.has_key(None):
504
text = sections.pop(None)
505
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
508
# Add the custom sections (e.g. Examples). Note that there's no need
509
# to indent these as they must be indented already in the source.
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
519
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
522
result += ', '.join(self.aliases) + '\n'
523
plugin_name = self.plugin_name()
524
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
526
see_also = self.get_see_also(additional_see_also)
528
if not plain and see_also_as_links:
530
for item in see_also:
532
# topics doesn't have an independent section
533
# so don't create a real link
534
see_also_links.append(item)
536
# Use a Sphinx link for this entry
537
link_text = ":doc:`%s <%s-help>`" % (item, item)
538
see_also_links.append(link_text)
539
see_also = see_also_links
540
result += ':See also: '
541
result += ', '.join(see_also) + '\n'
543
# If this will be rendered as plain text, convert it
545
import bzrlib.help_topics
546
result = bzrlib.help_topics.help_as_plain_text(result)
550
def _get_help_parts(text):
551
"""Split help text into a summary and named sections.
553
:return: (summary,sections,order) where summary is the top line and
554
sections is a dictionary of the rest indexed by section name.
555
order is the order the section appear in the text.
556
A section starts with a heading line of the form ":xxx:".
557
Indented text on following lines is the section value.
558
All text found outside a named section is assigned to the
559
default section which is given the key of None.
561
def save_section(sections, order, label, section):
563
if sections.has_key(label):
564
sections[label] += '\n' + section
567
sections[label] = section
569
lines = text.rstrip().splitlines()
570
summary = lines.pop(0)
573
label,section = None,''
575
if line.startswith(':') and line.endswith(':') and len(line) > 2:
576
save_section(sections, order, label, section)
577
label,section = line[1:-1],''
578
elif (label is not None) and len(line) > 1 and not line[0].isspace():
579
save_section(sections, order, label, section)
580
label,section = None,line
355
print '%-8s %s%s' % (fc, fp, kindch)
583
section += '\n' + line
586
save_section(sections, order, label, section)
587
return summary, sections, order
589
def get_help_topic(self):
590
"""Return the commands help topic - its name."""
593
def get_see_also(self, additional_terms=None):
594
"""Return a list of help topics that are related to this command.
596
The list is derived from the content of the _see_also attribute. Any
597
duplicates are removed and the result is in lexical order.
598
:param additional_terms: Additional help topics to cross-reference.
599
:return: A list of help topics.
601
see_also = set(getattr(self, '_see_also', []))
603
see_also.update(additional_terms)
604
return sorted(see_also)
607
"""Return dict of valid options for this command.
609
Maps from long option name to option object."""
610
r = Option.STD_OPTIONS.copy()
612
for o in self.takes_options:
613
if isinstance(o, basestring):
614
o = option.Option.OPTIONS[o]
616
if o.name in std_names:
617
self.supported_std_options.append(o.name)
620
def _setup_outf(self):
621
"""Return a file linked to stdout, which has proper encoding."""
622
self.outf = ui.ui_factory.make_output_stream(
623
encoding_type=self.encoding_type)
625
def run_argv_aliases(self, argv, alias_argv=None):
626
"""Parse the command line and run with extra aliases in alias_argv."""
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
629
DeprecationWarning, stacklevel=2)
631
args, opts = parse_args(self, argv, alias_argv)
633
# Process the standard options
634
if 'help' in opts: # e.g. bzr add --help
635
sys.stdout.write(self.get_help_text())
637
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
640
trace.set_verbosity_level(option._verbosity_level)
641
if 'verbose' in self.supported_std_options:
642
opts['verbose'] = trace.is_verbose()
643
elif opts.has_key('verbose'):
645
if 'quiet' in self.supported_std_options:
646
opts['quiet'] = trace.is_quiet()
647
elif opts.has_key('quiet'):
650
# mix arguments and options into one dictionary
651
cmdargs = _match_argform(self.name(), self.takes_args, args)
653
for k, v in opts.items():
654
cmdopts[k.replace('-', '_')] = v
656
all_cmd_args = cmdargs.copy()
657
all_cmd_args.update(cmdopts)
661
return self.run_direct(**all_cmd_args)
663
def run_direct(self, *args, **kwargs):
664
"""Call run directly with objects (without parsing an argv list)."""
665
return self._operation.run_simple(*args, **kwargs)
668
"""Actually run the command.
670
This is invoked with the options and arguments bound to
673
Return 0 or None if the command was successful, or a non-zero
674
shell error code if not. It's OK for this method to allow
675
an exception to raise up.
677
raise NotImplementedError('no implementation of command %r'
681
"""Return help message for this class."""
682
from inspect import getdoc
683
if self.__doc__ is Command.__doc__:
688
return _unsquish_command_name(self.__class__.__name__)
690
def plugin_name(self):
691
"""Get the name of the plugin that provides this command.
693
:return: The name of the plugin or None if the command is builtin.
695
mod_parts = self.__module__.split('.')
696
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
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):
702
class CommandHooks(Hooks):
703
"""Hooks related to Command object creation/enumeration."""
706
"""Create the default hooks.
708
These are all empty initially, because by default nothing should get
712
self.create_hook(HookPoint('extend_command',
713
"Called after creating a command object to allow modifications "
714
"such as adding or removing options, docs etc. Called with the "
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
717
"Called when creating a single command. Called with "
718
"(cmd_or_None, command_name). get_command should either return "
719
"the cmd_or_None parameter, or a replacement Command object that "
720
"should be used for the command. Note that the Command.hooks "
721
"hooks are core infrastructure. Many users will prefer to use "
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
725
"Called when creating a single command if no command could be "
726
"found. Called with (command_name). get_missing_command should "
727
"either return None, or a Command object to be used for the "
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
730
"Called when enumerating commands. Called with a set of "
731
"cmd_name strings for all the commands found so far. This set "
732
" is safe to mutate - e.g. to remove a command. "
733
"list_commands should return the updated set of command names.",
736
Command.hooks = CommandHooks()
739
def parse_args(command, argv, alias_argv=None):
543
740
"""Parse command line.
545
742
Arguments and options are parsed at this level before being passed
546
743
down to specific command handlers. This routine knows, from a
547
744
lookup table, something about the available options, what optargs
548
745
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)
747
# TODO: make it a method of the Command?
748
parser = option.get_optparser(command.options())
749
if alias_argv is not None:
750
args = alias_argv + argv
754
options, args = parser.parse_args(args)
755
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
756
v is not option.OptionParser.DEFAULT_VALUE])
594
757
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, [])
760
def _match_argform(cmd, takes_args, args):
613
# TODO: Need a way to express 'cp SRC... DEST', where it matches
763
# step through args and takes_args, allowing appropriate 0-many matches
764
for ap in takes_args:
616
765
argname = ap[:-1]
617
766
if ap[-1] == '?':
768
argdict[argname] = args.pop(0)
769
elif ap[-1] == '*': # all remaining arguments
771
argdict[argname + '_list'] = args[:]
774
argdict[argname + '_list'] = None
621
775
elif ap[-1] == '+':
623
bailout("command %r needs one or more %s"
624
% (cmd, argname.upper()))
777
raise errors.BzrCommandError("command %r needs one or more %s"
778
% (cmd, argname.upper()))
626
780
argdict[argname + '_list'] = args[:]
782
elif ap[-1] == '$': # all but one
784
raise errors.BzrCommandError("command %r needs one or more %s"
785
% (cmd, argname.upper()))
786
argdict[argname + '_list'] = args[:-1]
629
789
# just a plain arg
632
bailout("command %r requires argument %s"
633
% (cmd, argname.upper()))
792
raise errors.BzrCommandError("command %r requires argument %s"
793
% (cmd, argname.upper()))
635
795
argdict[argname] = args.pop(0)
638
bailout("extra arguments to command %s: %r"
798
raise errors.BzrCommandError("extra argument to command %s: %s"
803
def apply_coveraged(dirname, the_callable, *args, **kwargs):
804
# Cannot use "import trace", as that would import bzrlib.trace instead of
805
# the standard library's trace.
806
trace = __import__('trace')
808
tracer = trace.Trace(count=1, trace=0)
809
sys.settrace(tracer.globaltrace)
810
threading.settrace(tracer.globaltrace)
813
return exception_to_return_code(the_callable, *args, **kwargs)
816
results = tracer.results()
817
results.write_results(show_missing=1, summary=False,
821
def apply_profiled(the_callable, *args, **kwargs):
825
pffileno, pfname = tempfile.mkstemp()
827
prof = hotshot.Profile(pfname)
829
ret = prof.runcall(exception_to_return_code, the_callable, *args,
833
stats = hotshot.stats.load(pfname)
835
stats.sort_stats('cum') # 'time'
836
## XXX: Might like to write to stderr or the trace file instead but
837
## print_stats seems hardcoded to stdout
838
stats.print_stats(20)
845
def exception_to_return_code(the_callable, *args, **kwargs):
846
"""UI level helper for profiling and coverage.
848
This transforms exceptions into a return value of 3. As such its only
849
relevant to the UI layer, and should never be called where catching
850
exceptions may be desirable.
853
return the_callable(*args, **kwargs)
854
except (KeyboardInterrupt, Exception), e:
855
# used to handle AssertionError and KeyboardInterrupt
856
# specially here, but hopefully they're handled ok by the logger now
857
exc_info = sys.exc_info()
858
exitcode = trace.report_exception(exc_info, sys.stderr)
859
if os.environ.get('BZR_PDB'):
860
print '**** entering debugger'
863
if sys.version_info[:2] < (2, 6):
865
# pdb.post_mortem(tb)
866
# but because pdb.post_mortem gives bad results for tracebacks
867
# from inside generators, we do it manually.
868
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
870
# Setup pdb on the traceback
873
p.setup(tb.tb_frame, tb)
874
# Point the debugger at the deepest frame of the stack
875
p.curindex = len(p.stack) - 1
876
p.curframe = p.stack[p.curindex][0]
877
# Start the pdb prompt.
878
p.print_stack_entry(p.stack[p.curindex])
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
887
from bzrlib.lsprof import profile
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
894
trace.note('Profile data written to "%s".', filename)
898
def shlex_split_unicode(unsplit):
900
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
903
def get_alias(cmd, config=None):
904
"""Return an expanded alias, or None if no alias exists.
907
Command to be checked for an alias.
909
Used to specify an alternative config to use,
910
which is especially useful for testing.
911
If it is unspecified, the global config will be used.
915
config = bzrlib.config.GlobalConfig()
916
alias = config.get_alias(cmd)
918
return shlex_split_unicode(alias)
645
922
def run_bzr(argv):
646
923
"""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')
926
The command-line arguments, without the program name from argv[0]
927
These should already be decoded. All library/test code calling
928
run_bzr should be passing valid strings (don't need decoding).
930
Returns a command status or raises an exception.
932
Special master options: these must come before the command because
933
they control how the command is interpreted.
936
Do not load plugin modules at all
942
Only use builtin commands. (Plugins are still allowed to change
946
Run under the Python hotshot profiler.
949
Run under the Python lsprof profiler.
952
Generate line coverage report in the specified directory.
955
Specify the number of processes that can be run concurrently (selftest).
957
trace.mutter("bazaar version: " + bzrlib.__version__)
959
trace.mutter("bzr arguments: %r", argv)
961
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
962
opt_no_aliases = False
963
opt_lsprof_file = opt_coverage_dir = None
965
# --no-plugins is handled specially at a very early stage. We need
966
# to load plugins before doing other command parsing so that they
967
# can override commands, but this needs to happen first.
975
elif a == '--lsprof':
977
elif a == '--lsprof-file':
979
opt_lsprof_file = argv[i + 1]
981
elif a == '--no-plugins':
982
opt_no_plugins = True
983
elif a == '--no-aliases':
984
opt_no_aliases = True
985
elif a == '--builtin':
987
elif a == '--concurrency':
988
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
990
elif a == '--coverage':
991
opt_coverage_dir = argv[i + 1]
993
elif a.startswith('-D'):
994
debug.debug_flags.add(a[2:])
999
debug.set_debug_flags_from_config()
1003
from bzrlib.builtins import cmd_help
1004
cmd_help().run_argv_aliases([])
1007
if argv[0] == '--version':
1008
from bzrlib.builtins import cmd_version
1009
cmd_version().run_argv_aliases([])
1012
if not opt_no_plugins:
1013
from bzrlib.plugin import load_plugins
1016
from bzrlib.plugin import disable_plugins
1021
if not opt_no_aliases:
1022
alias_argv = get_alias(argv[0])
1024
user_encoding = osutils.get_user_encoding()
1025
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1026
argv[0] = alias_argv.pop(0)
1029
# We want only 'ascii' command names, but the user may have typed
1030
# in a Unicode name. In that case, they should just get a
1031
# 'command not found' error later.
1033
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1034
run = cmd_obj.run_argv_aliases
1035
run_argv = [argv, alias_argv]
1038
# We can be called recursively (tests for example), but we don't want
1039
# the verbosity level to propagate.
1040
saved_verbosity_level = option._verbosity_level
1041
option._verbosity_level = 0
1043
if opt_coverage_dir:
1045
'--coverage ignored, because --lsprof is in use.')
1046
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1048
if opt_coverage_dir:
1050
'--coverage ignored, because --profile is in use.')
1051
ret = apply_profiled(run, *run_argv)
1052
elif opt_coverage_dir:
1053
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1055
ret = run(*run_argv)
1058
# reset, in case we may do other commands later within the same
1059
# process. Commands that want to execute sub-commands must propagate
1060
# --verbose in their own way.
1061
if 'memory' in debug.debug_flags:
1062
trace.debug_memory('Process status after command:', short=False)
1063
option._verbosity_level = saved_verbosity_level
1066
def display_command(func):
1067
"""Decorator that suppresses pipe/interrupt errors."""
1068
def ignore_pipe(*args, **kwargs):
1070
result = func(*args, **kwargs)
1074
if getattr(e, 'errno', None) is None:
1076
if e.errno != errno.EPIPE:
1077
# Win32 raises IOError with errno=0 on a broken pipe
1078
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1081
except KeyboardInterrupt:
1086
def install_bzr_command_hooks():
1087
"""Install the hooks to supply bzr's own commands."""
1088
if _list_bzr_commands in Command.hooks["list_commands"]:
1090
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1092
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1094
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1095
"bzr plugin commands")
1096
Command.hooks.install_named_hook("get_command", _get_external_command,
1097
"bzr external command lookup")
1098
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
"bzr plugin-provider-db check")
1102
def main(argv=None):
1103
"""Main entry point of command-line interface.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
1113
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
sys.stdin, sys.stdout, sys.stderr)
1116
# Is this a final release version? If so, we should suppress warnings
1117
if bzrlib.version_info[3] == 'final':
1118
suppress_deprecation_warnings(override=True)
1120
argv = osutils.get_unicode_argv()
1124
# ensure all arguments are unicode strings
1126
if isinstance(a, unicode):
1129
new_argv.append(a.decode('ascii'))
1130
except UnicodeDecodeError:
1131
raise errors.BzrError("argv should be list of unicode strings.")
1133
ret = run_bzr_catch_errors(argv)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1136
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
1141
def run_bzr_catch_errors(argv):
1142
"""Run a bzr command with parameters as described by argv.
1144
This function assumed that that UI layer is setup, that symbol deprecations
1145
are already applied, and that unicode decoding has already been performed on argv.
1147
install_bzr_command_hooks()
1148
return exception_to_return_code(run_bzr, argv)
1151
def run_bzr_catch_user_errors(argv):
1152
"""Run bzr and report user errors, but let internal errors propagate.
1154
This is used for the test suite, and might be useful for other programs
1155
that want to wrap the commandline interface.
1157
install_bzr_command_hooks()
1159
return run_bzr(argv)
722
1160
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?
1161
if (isinstance(e, (OSError, IOError))
1162
or not getattr(e, 'internal_error', True)):
1163
trace.report_exception(sys.exc_info(), sys.stderr)
1169
class HelpCommandIndex(object):
1170
"""A index for bzr help that returns commands."""
1173
self.prefix = 'commands/'
1175
def get_topics(self, topic):
1176
"""Search for topic amongst commands.
1178
:param topic: A topic to search for.
1179
:return: A list which is either empty or contains a single
1182
if topic and topic.startswith(self.prefix):
1183
topic = topic[len(self.prefix):]
1185
cmd = _get_cmd_object(topic)
1192
class Provider(object):
1193
'''Generic class to be overriden by plugins'''
1195
def plugin_for_command(self, cmd_name):
1196
'''Takes a command and returns the information for that plugin
1198
:return: A dictionary with all the available information
1199
for the requested plugin
1201
raise NotImplementedError
1204
class ProvidersRegistry(registry.Registry):
1205
'''This registry exists to allow other providers to exist'''
1208
for key, provider in self.iteritems():
1211
command_providers_registry = ProvidersRegistry()
733
1214
if __name__ == '__main__':
734
1215
sys.exit(main(sys.argv))
736
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
