1
# Copyright (C) 2006, 2008, 2009 Canonical Ltd
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
3
8
# This program is free software; you can redistribute it and/or modify
4
9
# it under the terms of the GNU General Public License as published by
5
10
# the Free Software Foundation; either version 2 of the License, or
6
11
# (at your option) any later version.
8
13
# This program is distributed in the hope that it will be useful,
9
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
16
# GNU General Public License for more details.
13
18
# You should have received a copy of the GNU General Public License
14
19
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: 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
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Run internal consistency checks.
69
# Show some information about this branch.
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
83
from pprint import pprint
86
from ElementTree import Element, ElementTree, SubElement
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
def get_cmd_object(cmd_name, plugins_override=True):
190
"""Return the command object for a command.
193
If true, plugin commands can override builtins.
196
return _get_cmd_object(cmd_name, plugins_override)
198
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
201
def _get_cmd_object(cmd_name, plugins_override=True):
202
"""Get a command object.
204
:param cmd_name: The name of the command.
205
:param plugins_override: Allow plugins to override builtins.
206
:return: A Command object instance
207
:raises KeyError: If no command is found.
209
# We want only 'ascii' command names, but the user may have typed
210
# in a Unicode name. In that case, they should just get a
211
# 'command not found' error later.
212
# In the future, we may actually support Unicode command names.
215
for hook in Command.hooks['get_command']:
216
cmd = hook(cmd, cmd_name)
217
if cmd is not None and not plugins_override and not cmd.plugin_name():
218
# We've found a non-plugin command, don't permit it to be
222
for hook in Command.hooks['get_missing_command']:
229
# Allow plugins to extend commands
230
for hook in Command.hooks['extend_command']:
235
def _try_plugin_provider(cmd_name):
236
"""Probe for a plugin provider having cmd_name."""
238
plugin_metadata, provider = probe_for_provider(cmd_name)
239
raise errors.CommandAvailableInPlugin(cmd_name,
240
plugin_metadata, provider)
241
except errors.NoPluginAvailable:
245
def probe_for_provider(cmd_name):
246
"""Look for a provider for cmd_name.
248
:param cmd_name: The command name.
249
:return: plugin_metadata, provider for getting cmd_name.
250
:raises NoPluginAvailable: When no provider can supply the plugin.
252
# look for providers that provide this command but aren't installed
253
for provider in command_providers_registry:
255
return provider.plugin_for_command(cmd_name), provider
256
except errors.NoPluginAvailable:
258
raise errors.NoPluginAvailable(cmd_name)
261
def _get_bzr_command(cmd_or_None, cmd_name):
262
"""Get a command from bzr's core."""
263
cmds = _builtin_commands()
265
return cmds[cmd_name]()
268
# look for any command which claims this as an alias
269
for real_cmd_name, cmd_class in cmds.iteritems():
270
if cmd_name in cmd_class.aliases:
275
def _get_external_command(cmd_or_None, cmd_name):
276
"""Lookup a command that is a shell script."""
277
# Only do external command lookups when no command is found so far.
278
if cmd_or_None is not None:
280
from bzrlib.externalcommand import ExternalCommand
281
cmd_obj = ExternalCommand.find_command(cmd_name)
286
def _get_plugin_command(cmd_or_None, cmd_name):
287
"""Get a command from bzr's plugins."""
289
return plugin_cmds.get(cmd_name)()
292
for key in plugin_cmds.keys():
293
info = plugin_cmds.get_info(key)
294
if cmd_name in info.aliases:
295
return plugin_cmds.get(key)()
299
class Command(object):
300
"""Base class for commands.
302
Commands are the heart of the command-line bzr interface.
304
The command object mostly handles the mapping of command-line
305
parameters into one or more bzrlib operations, and of the results
308
Commands normally don't have any state. All their arguments are
309
passed in to the run method. (Subclasses may take a different
310
policy if the behaviour of the instance needs to depend on e.g. a
311
shell plugin and not just its Python class.)
313
The docstring for an actual command should give a single-line
314
summary, then a complete description of the command. A grammar
315
description will be inserted.
318
Other accepted names for this command.
321
List of argument forms, marked with whether they are optional,
326
['to_location', 'from_branch?', 'file*']
328
'to_location' is required
329
'from_branch' is optional
330
'file' can be specified 0 or more times
333
List of options that may be given for this command. These can
334
be either strings, referring to globally-defined options,
335
or option objects. Retrieve through options().
338
If true, this command isn't advertised. This is typically
339
for commands intended for expert users.
342
Command objects will get a 'outf' attribute, which has been
343
setup to properly handle encoding of unicode strings.
344
encoding_type determines what will happen when characters cannot
346
strict - abort if we cannot decode
347
replace - put in a bogus character (typically '?')
348
exact - do not encode sys.stdout
350
NOTE: by default on Windows, sys.stdout is opened as a text
351
stream, therefore LF line-endings are converted to CRLF.
352
When a command uses encoding_type = 'exact', then
353
sys.stdout is forced to be a binary stream, and line-endings
356
:cvar hooks: An instance of CommandHooks.
361
encoding_type = 'strict'
366
"""Construct an instance of this command."""
367
if self.__doc__ == Command.__doc__:
368
warn("No help message set for %r" % self)
369
# List of standard options directly supported
370
self.supported_std_options = []
371
self._operation = cleanup.OperationWithCleanups(self.run)
373
def add_cleanup(self, cleanup_func, *args, **kwargs):
374
"""Register a function to call after self.run returns or raises.
376
Functions will be called in LIFO order.
378
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
380
def cleanup_now(self):
381
"""Execute and empty pending cleanup functions immediately.
383
After cleanup_now all registered cleanups are forgotten. add_cleanup
384
may be called again after cleanup_now; these cleanups will be called
385
after self.run returns or raises (or when cleanup_now is next called).
387
This is useful for releasing expensive or contentious resources (such
388
as write locks) before doing further work that does not require those
389
resources (such as writing results to self.outf).
391
self._operation.cleanup_now()
393
@deprecated_method(deprecated_in((2, 1, 0)))
394
def _maybe_expand_globs(self, file_list):
395
"""Glob expand file_list if the platform does not do that itself.
397
Not used anymore, now that the bzr command-line parser globs on
400
:return: A possibly empty list of unicode paths.
402
Introduced in bzrlib 0.18.
407
"""Return single-line grammar for this command.
409
Only describes arguments, not options.
411
s = 'bzr ' + self.name() + ' '
412
for aname in self.takes_args:
413
aname = aname.upper()
414
if aname[-1] in ['$', '+']:
415
aname = aname[:-1] + '...'
416
elif aname[-1] == '?':
417
aname = '[' + aname[:-1] + ']'
418
elif aname[-1] == '*':
419
aname = '[' + aname[:-1] + '...]'
421
s = s[:-1] # remove last space
424
def get_help_text(self, additional_see_also=None, plain=True,
425
see_also_as_links=False, verbose=True):
426
"""Return a text string with help for this command.
428
:param additional_see_also: Additional help topics to be
430
:param plain: if False, raw help (reStructuredText) is
431
returned instead of plain text.
432
:param see_also_as_links: if True, convert items in 'See also'
433
list to internal links (used by bzr_man rstx generator)
434
:param verbose: if True, display the full help, otherwise
435
leave out the descriptive sections and just display
436
usage help (e.g. Purpose, Usage, Options) with a
437
message explaining how to obtain full help.
441
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
443
# Extract the summary (purpose) and sections out from the text
444
purpose,sections,order = self._get_help_parts(doc)
446
# If a custom usage section was provided, use it
447
if sections.has_key('Usage'):
448
usage = sections.pop('Usage')
450
usage = self._usage()
452
# The header is the purpose and usage
454
result += ':Purpose: %s\n' % purpose
455
if usage.find('\n') >= 0:
456
result += ':Usage:\n%s\n' % usage
458
result += ':Usage: %s\n' % usage
463
# XXX: optparse implicitly rewraps the help, and not always perfectly,
464
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
466
options = option.get_optparser(self.options()).format_option_help()
467
# XXX: According to the spec, ReST option lists actually don't support
468
# options like --1.9 so that causes syntax errors (in Sphinx at least).
469
# As that pattern always appears in the commands that break, we trap
470
# on that and then format that block of 'format' options as a literal
472
if not plain and options.find(' --1.9 ') != -1:
473
options = options.replace(' format:\n', ' format::\n\n', 1)
474
if options.startswith('Options:'):
475
result += ':' + options
476
elif options.startswith('options:'):
477
# Python 2.4 version of optparse
478
result += ':Options:' + options[len('options:'):]
89
from bzrlib.store import ImmutableStore
90
from bzrlib.trace import mutter, note, log_error
91
from bzrlib.errors import bailout, BzrError
92
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
93
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
94
from bzrlib.revision import Revision
95
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
98
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
99
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
101
## standard representation
102
NONE_STRING = '(none)'
106
## TODO: Perhaps a different version of inventory commands that
107
## returns iterators...
109
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
111
## TODO: Some kind of locking on branches. Perhaps there should be a
112
## parameter to the branch object saying whether we want a read or
113
## write lock; release it from destructor. Perhaps don't even need a
114
## read lock to look at immutable objects?
116
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
117
## to compare output?
119
## TODO: Is ElementTree really all that much better for our purposes?
120
## Perhaps using the standard MiniDOM would be enough?
127
######################################################################
131
def cmd_status(all=False):
132
"""Display status summary.
134
For each file there is a single line giving its file state and name.
135
The name is that in the current revision unless it is deleted or
136
missing, in which case the old name is shown.
138
:todo: Don't show unchanged files unless ``--all`` is given?
140
Branch('.').show_status(show_all=all)
144
######################################################################
146
def cmd_get_revision(revision_id):
147
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
150
def cmd_get_inventory(inventory_id):
151
"""Return inventory in XML by hash"""
152
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
155
def cmd_get_revision_inventory(revision_id):
156
"""Output inventory for a revision."""
158
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
161
def cmd_get_file_text(text_id):
162
"""Get contents of a file by hash."""
163
sf = Branch('.').text_store[text_id]
164
pumpfile(sf, sys.stdout)
168
######################################################################
173
"""Show number of revisions on this branch"""
174
print Branch('.').revno()
177
def cmd_add(file_list, verbose=False):
178
"""Add specified files.
180
Fails if the files are already added.
182
Branch('.').add(file_list, verbose=verbose)
185
def cmd_inventory(revision=None):
186
"""Show inventory of the current working copy."""
187
## TODO: Also optionally show a previous inventory
188
## TODO: Format options
191
inv = b.read_working_inventory()
193
inv = b.get_revision_inventory(b.lookup_revision(revision))
195
for path, entry in inv.iter_entries():
196
print '%-50s %s' % (entry.file_id, path)
202
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
203
print 'revision number:', b.revno()
204
print 'number of versioned files:', len(b.read_working_inventory())
207
def cmd_remove(file_list, verbose=False):
208
Branch('.').remove(file_list, verbose=verbose)
212
def cmd_file_id(filename):
213
i = Branch('.').read_working_inventory().path2id(filename)
215
bailout("%s is not a versioned file" % filename)
220
def cmd_find_filename(fileid):
221
n = find_filename(fileid)
223
bailout("%s is not a live file id" % fileid)
228
def cmd_revision_history():
229
for patchid in Branch('.').revision_history():
235
# TODO: Check we're not already in a working directory? At the
236
# moment you'll get an ugly error.
238
# TODO: What if we're in a subdirectory of a branch? Would like
239
# to allow that, but then the parent may need to understand that
240
# the children have disappeared, or should they be versioned in
243
# TODO: Take an argument/option for branch name.
244
Branch('.', init=True)
247
def cmd_diff(revision=None):
248
"""Show diff from basis to working copy.
250
:todo: Take one or two revision arguments, look up those trees,
253
:todo: Allow diff across branches.
255
:todo: Mangle filenames in diff to be more relevant.
257
:todo: Shouldn't be in the cmd function.
263
old_tree = b.basis_tree()
265
old_tree = b.revision_tree(b.lookup_revision(revision))
267
new_tree = b.working_tree()
268
old_inv = old_tree.inventory
269
new_inv = new_tree.inventory
271
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
275
DEVNULL = '/dev/null'
276
# Windows users, don't panic about this filename -- it is a
277
# special signal to GNU patch that the file should be created or
278
# deleted respectively.
280
# TODO: Generation of pseudo-diffs for added/deleted files could
281
# be usefully made into a much faster special case.
283
# TODO: Better to return them in sorted order I think.
285
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
288
# Don't show this by default; maybe do it if an option is passed
289
# idlabel = ' {%s}' % fid
292
# FIXME: Something about the diff format makes patch unhappy
293
# with newly-added files.
295
def diffit(*a, **kw):
296
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
299
if file_state in ['.', '?', 'I']:
301
elif file_state == 'A':
302
print '*** added %s %r' % (kind, new_name)
305
new_tree.get_file(fid).readlines(),
307
tofile=new_label + new_name + idlabel)
308
elif file_state == 'D':
309
assert isinstance(old_name, types.StringTypes)
310
print '*** deleted %s %r' % (kind, old_name)
312
diffit(old_tree.get_file(fid).readlines(), [],
313
fromfile=old_label + old_name + idlabel,
315
elif file_state in ['M', 'R']:
316
if file_state == 'M':
317
assert kind == 'file'
318
assert old_name == new_name
319
print '*** modified %s %r' % (kind, new_name)
320
elif file_state == 'R':
321
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
324
diffit(old_tree.get_file(fid).readlines(),
325
new_tree.get_file(fid).readlines(),
326
fromfile=old_label + old_name + idlabel,
327
tofile=new_label + new_name)
329
bailout("can't represent state %s {%s}" % (file_state, fid))
334
"""Show log of this branch.
336
:todo: Options for utc; to show ids; to limit range; etc.
338
Branch('.').write_log()
341
def cmd_ls(revision=None, verbose=False):
342
"""List files in a tree.
344
:todo: Take a revision or remote path and list that tree instead.
348
tree = b.working_tree()
350
tree = b.revision_tree(b.lookup_revision(revision))
352
for fp, fc, kind, fid in tree.list_files():
484
# Add the description, indenting it 2 spaces
485
# to match the indentation of the options
486
if sections.has_key(None):
487
text = sections.pop(None)
488
text = '\n '.join(text.splitlines())
489
result += ':%s:\n %s\n\n' % ('Description',text)
491
# Add the custom sections (e.g. Examples). Note that there's no need
492
# to indent these as they must be indented already in the source.
495
if sections.has_key(label):
496
result += ':%s:\n%s\n' % (label,sections[label])
499
result += ("See bzr help %s for more details and examples.\n\n"
502
# Add the aliases, source (plug-in) and see also links, if any
504
result += ':Aliases: '
505
result += ', '.join(self.aliases) + '\n'
506
plugin_name = self.plugin_name()
507
if plugin_name is not None:
508
result += ':From: plugin "%s"\n' % plugin_name
509
see_also = self.get_see_also(additional_see_also)
511
if not plain and see_also_as_links:
513
for item in see_also:
515
# topics doesn't have an independent section
516
# so don't create a real link
517
see_also_links.append(item)
519
# Use a Sphinx link for this entry
520
link_text = ":doc:`%s <%s-help>`" % (item, item)
521
see_also_links.append(link_text)
522
see_also = see_also_links
523
result += ':See also: '
524
result += ', '.join(see_also) + '\n'
526
# If this will be rendered as plain text, convert it
528
import bzrlib.help_topics
529
result = bzrlib.help_topics.help_as_plain_text(result)
533
def _get_help_parts(text):
534
"""Split help text into a summary and named sections.
536
:return: (summary,sections,order) where summary is the top line and
537
sections is a dictionary of the rest indexed by section name.
538
order is the order the section appear in the text.
539
A section starts with a heading line of the form ":xxx:".
540
Indented text on following lines is the section value.
541
All text found outside a named section is assigned to the
542
default section which is given the key of None.
544
def save_section(sections, order, label, section):
546
if sections.has_key(label):
547
sections[label] += '\n' + section
550
sections[label] = section
552
lines = text.rstrip().splitlines()
553
summary = lines.pop(0)
556
label,section = None,''
558
if line.startswith(':') and line.endswith(':') and len(line) > 2:
559
save_section(sections, order, label, section)
560
label,section = line[1:-1],''
561
elif (label is not None) and len(line) > 1 and not line[0].isspace():
562
save_section(sections, order, label, section)
563
label,section = None,line
354
if kind == 'directory':
566
section += '\n' + line
569
save_section(sections, order, label, section)
570
return summary, sections, order
572
def get_help_topic(self):
573
"""Return the commands help topic - its name."""
576
def get_see_also(self, additional_terms=None):
577
"""Return a list of help topics that are related to this command.
579
The list is derived from the content of the _see_also attribute. Any
580
duplicates are removed and the result is in lexical order.
581
:param additional_terms: Additional help topics to cross-reference.
582
:return: A list of help topics.
584
see_also = set(getattr(self, '_see_also', []))
586
see_also.update(additional_terms)
587
return sorted(see_also)
590
"""Return dict of valid options for this command.
592
Maps from long option name to option object."""
593
r = Option.STD_OPTIONS.copy()
595
for o in self.takes_options:
596
if isinstance(o, basestring):
597
o = option.Option.OPTIONS[o]
599
if o.name in std_names:
600
self.supported_std_options.append(o.name)
603
def _setup_outf(self):
604
"""Return a file linked to stdout, which has proper encoding."""
605
self.outf = ui.ui_factory.make_output_stream(
606
encoding_type=self.encoding_type)
608
def run_argv_aliases(self, argv, alias_argv=None):
609
"""Parse the command line and run with extra aliases in alias_argv."""
610
args, opts = parse_args(self, argv, alias_argv)
612
# Process the standard options
613
if 'help' in opts: # e.g. bzr add --help
614
sys.stdout.write(self.get_help_text())
616
if 'usage' in opts: # e.g. bzr add --usage
617
sys.stdout.write(self.get_help_text(verbose=False))
619
trace.set_verbosity_level(option._verbosity_level)
620
if 'verbose' in self.supported_std_options:
621
opts['verbose'] = trace.is_verbose()
622
elif opts.has_key('verbose'):
624
if 'quiet' in self.supported_std_options:
625
opts['quiet'] = trace.is_quiet()
626
elif opts.has_key('quiet'):
629
# mix arguments and options into one dictionary
630
cmdargs = _match_argform(self.name(), self.takes_args, args)
632
for k, v in opts.items():
633
cmdopts[k.replace('-', '_')] = v
635
all_cmd_args = cmdargs.copy()
636
all_cmd_args.update(cmdopts)
640
return self.run_direct(**all_cmd_args)
642
def run_direct(self, *args, **kwargs):
643
"""Call run directly with objects (without parsing an argv list)."""
644
return self._operation.run_simple(*args, **kwargs)
647
"""Actually run the command.
649
This is invoked with the options and arguments bound to
652
Return 0 or None if the command was successful, or a non-zero
653
shell error code if not. It's OK for this method to allow
654
an exception to raise up.
656
raise NotImplementedError('no implementation of command %r'
660
"""Return help message for this class."""
661
from inspect import getdoc
662
if self.__doc__ is Command.__doc__:
667
return _unsquish_command_name(self.__class__.__name__)
669
def plugin_name(self):
670
"""Get the name of the plugin that provides this command.
672
:return: The name of the plugin or None if the command is builtin.
674
mod_parts = self.__module__.split('.')
675
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
361
print '%-8s %s%s' % (fc, fp, kindch)
681
class CommandHooks(Hooks):
682
"""Hooks related to Command object creation/enumeration."""
685
"""Create the default hooks.
687
These are all empty initially, because by default nothing should get
691
self.create_hook(HookPoint('extend_command',
692
"Called after creating a command object to allow modifications "
693
"such as adding or removing options, docs etc. Called with the "
694
"new bzrlib.commands.Command object.", (1, 13), None))
695
self.create_hook(HookPoint('get_command',
696
"Called when creating a single command. Called with "
697
"(cmd_or_None, command_name). get_command should either return "
698
"the cmd_or_None parameter, or a replacement Command object that "
699
"should be used for the command. Note that the Command.hooks "
700
"hooks are core infrastructure. Many users will prefer to use "
701
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
703
self.create_hook(HookPoint('get_missing_command',
704
"Called when creating a single command if no command could be "
705
"found. Called with (command_name). get_missing_command should "
706
"either return None, or a Command object to be used for the "
707
"command.", (1, 17), None))
708
self.create_hook(HookPoint('list_commands',
709
"Called when enumerating commands. Called with a set of "
710
"cmd_name strings for all the commands found so far. This set "
711
" is safe to mutate - e.g. to remove a command. "
712
"list_commands should return the updated set of command names.",
715
Command.hooks = CommandHooks()
718
def parse_args(command, argv, alias_argv=None):
368
"""List unknown files"""
369
for f in Branch('.').unknowns():
373
def cmd_lookup_revision(revno):
377
bailout("usage: lookup-revision REVNO",
378
["REVNO is a non-negative revision number for this branch"])
380
print Branch('.').lookup_revision(revno) or NONE_STRING
384
def cmd_export(revno, dest):
385
"""Export past revision to destination directory."""
387
rh = b.lookup_revision(int(revno))
388
t = b.revision_tree(rh)
393
######################################################################
394
# internal/test commands
398
"""Print a newly-generated UUID."""
403
def cmd_commit(message, verbose=False):
404
Branch('.').commit(message, verbose=verbose)
408
"""Check consistency of the branch."""
412
def cmd_is(pred, *rest):
413
"""Test whether PREDICATE is true."""
415
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
417
bailout("unknown predicate: %s" % quotefn(pred))
421
except BzrCheckError:
422
# by default we don't print the message so that this can
423
# be used from shell scripts without producing noise
428
print bzrlib.osutils.username()
431
def cmd_user_email():
432
print bzrlib.osutils.user_email()
435
def cmd_gen_revision_id():
437
print bzrlib.branch._gen_revision_id(time.time())
441
"""Run internal doctest suite"""
442
## -v, if present, is seen by doctest; the argument is just here
443
## so our parser doesn't complain
445
## TODO: --verbose option
447
import bzr, doctest, bzrlib.store
448
bzrlib.trace.verbose = False
450
doctest.testmod(bzrlib.store)
451
doctest.testmod(bzrlib.inventory)
452
doctest.testmod(bzrlib.branch)
453
doctest.testmod(bzrlib.osutils)
454
doctest.testmod(bzrlib.tree)
456
# more strenuous tests;
458
doctest.testmod(bzrlib.tests)
461
######################################################################
466
# TODO: Specific help for particular commands
471
print "bzr (bazaar-ng) %s" % __version__
473
print "http://bazaar-ng.org/"
476
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
477
you may use, modify and redistribute it under the terms of the GNU
478
General Public License version 2 or later."""
482
"""Statement of optimism."""
483
print "it sure does!"
487
######################################################################
491
# list of all available options; the rhs can be either None for an
492
# option that takes no argument, or a constructor function that checks
510
# List of options that apply to particular commands; commands not
514
'commit': ['message', 'verbose'],
515
'diff': ['revision'],
516
'inventory': ['revision'],
517
'ls': ['revision', 'verbose'],
520
'remove': ['verbose'],
529
'file-id': ['filename'],
530
'get-file-text': ['text_id'],
531
'get-inventory': ['inventory_id'],
532
'get-revision': ['revision_id'],
533
'get-revision-inventory': ['revision_id'],
535
'lookup-revision': ['revno'],
536
'export': ['revno', 'dest'],
542
def parse_args(argv):
719
543
"""Parse command line.
721
545
Arguments and options are parsed at this level before being passed
722
546
down to specific command handlers. This routine knows, from a
723
547
lookup table, something about the available options, what optargs
724
548
they take, and which commands will accept them.
550
>>> parse_args('bzr --help'.split())
552
>>> parse_args('bzr --version'.split())
553
([], {'version': True})
554
>>> parse_args('bzr status --all'.split())
555
(['status'], {'all': True})
726
# TODO: make it a method of the Command?
727
parser = option.get_optparser(command.options())
728
if alias_argv is not None:
729
args = alias_argv + argv
733
options, args = parser.parse_args(args)
734
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
735
v is not option.OptionParser.DEFAULT_VALUE])
560
# TODO: Maybe handle '--' to end options?
567
mutter(" got option %r" % a)
569
if optname not in OPTIONS:
570
bailout('unknown long option %r' % a)
573
if shortopt not in SHORT_OPTIONS:
574
bailout('unknown short option %r' % a)
575
optname = SHORT_OPTIONS[shortopt]
578
# XXX: Do we ever want to support this, e.g. for -r?
579
bailout('repeated option %r' % a)
580
optargfn = OPTIONS[optname]
583
bailout('option %r needs an argument' % a)
584
opts[optname] = optargfn(it.next())
585
mutter(" option argument %r" % opts[optname])
587
# takes no option argument
590
bailout('unknown short option %r' % a)
736
594
return args, opts
739
def _match_argform(cmd, takes_args, args):
598
def _match_args(cmd, args):
599
"""Check non-option arguments match required pattern.
601
>>> _match_args('status', ['asdasdsadasd'])
602
Traceback (most recent call last):
604
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
605
>>> _match_args('add', ['asdasdsadasd'])
606
{'file_list': ['asdasdsadasd']}
607
>>> _match_args('add', 'abc def gj'.split())
608
{'file_list': ['abc', 'def', 'gj']}
610
# match argument pattern
611
argform = cmd_args.get(cmd, [])
742
# step through args and takes_args, allowing appropriate 0-many matches
743
for ap in takes_args:
613
# TODO: Need a way to express 'cp SRC... DEST', where it matches
744
616
argname = ap[:-1]
745
617
if ap[-1] == '?':
747
argdict[argname] = args.pop(0)
748
elif ap[-1] == '*': # all remaining arguments
750
argdict[argname + '_list'] = args[:]
753
argdict[argname + '_list'] = None
754
621
elif ap[-1] == '+':
756
raise errors.BzrCommandError("command %r needs one or more %s"
757
% (cmd, argname.upper()))
623
bailout("command %r needs one or more %s"
624
% (cmd, argname.upper()))
759
626
argdict[argname + '_list'] = args[:]
761
elif ap[-1] == '$': # all but one
763
raise errors.BzrCommandError("command %r needs one or more %s"
764
% (cmd, argname.upper()))
765
argdict[argname + '_list'] = args[:-1]
768
629
# just a plain arg
771
raise errors.BzrCommandError("command %r requires argument %s"
772
% (cmd, argname.upper()))
632
bailout("command %r requires argument %s"
633
% (cmd, argname.upper()))
774
635
argdict[argname] = args.pop(0)
777
raise errors.BzrCommandError("extra argument to command %s: %s"
638
bailout("extra arguments to command %s: %r"
782
def apply_coveraged(dirname, the_callable, *args, **kwargs):
783
# Cannot use "import trace", as that would import bzrlib.trace instead of
784
# the standard library's trace.
785
trace = __import__('trace')
787
tracer = trace.Trace(count=1, trace=0)
788
sys.settrace(tracer.globaltrace)
789
threading.settrace(tracer.globaltrace)
792
return exception_to_return_code(the_callable, *args, **kwargs)
795
results = tracer.results()
796
results.write_results(show_missing=1, summary=False,
800
def apply_profiled(the_callable, *args, **kwargs):
804
pffileno, pfname = tempfile.mkstemp()
806
prof = hotshot.Profile(pfname)
808
ret = prof.runcall(exception_to_return_code, the_callable, *args,
812
stats = hotshot.stats.load(pfname)
814
stats.sort_stats('cum') # 'time'
815
## XXX: Might like to write to stderr or the trace file instead but
816
## print_stats seems hardcoded to stdout
817
stats.print_stats(20)
824
def exception_to_return_code(the_callable, *args, **kwargs):
825
"""UI level helper for profiling and coverage.
827
This transforms exceptions into a return value of 3. As such its only
828
relevant to the UI layer, and should never be called where catching
829
exceptions may be desirable.
832
return the_callable(*args, **kwargs)
833
except (KeyboardInterrupt, Exception), e:
834
# used to handle AssertionError and KeyboardInterrupt
835
# specially here, but hopefully they're handled ok by the logger now
836
exc_info = sys.exc_info()
837
exitcode = trace.report_exception(exc_info, sys.stderr)
838
if os.environ.get('BZR_PDB'):
839
print '**** entering debugger'
842
if sys.version_info[:2] < (2, 6):
844
# pdb.post_mortem(tb)
845
# but because pdb.post_mortem gives bad results for tracebacks
846
# from inside generators, we do it manually.
847
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
849
# Setup pdb on the traceback
852
p.setup(tb.tb_frame, tb)
853
# Point the debugger at the deepest frame of the stack
854
p.curindex = len(p.stack) - 1
855
p.curframe = p.stack[p.curindex][0]
856
# Start the pdb prompt.
857
p.print_stack_entry(p.stack[p.curindex])
865
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
866
from bzrlib.lsprof import profile
867
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
873
trace.note('Profile data written to "%s".', filename)
877
def shlex_split_unicode(unsplit):
879
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
882
def get_alias(cmd, config=None):
883
"""Return an expanded alias, or None if no alias exists.
886
Command to be checked for an alias.
888
Used to specify an alternative config to use,
889
which is especially useful for testing.
890
If it is unspecified, the global config will be used.
894
config = bzrlib.config.GlobalConfig()
895
alias = config.get_alias(cmd)
897
return shlex_split_unicode(alias)
901
645
def run_bzr(argv):
902
646
"""Execute a command.
905
The command-line arguments, without the program name from argv[0]
906
These should already be decoded. All library/test code calling
907
run_bzr should be passing valid strings (don't need decoding).
909
Returns a command status or raises an exception.
911
Special master options: these must come before the command because
912
they control how the command is interpreted.
915
Do not load plugin modules at all
921
Only use builtin commands. (Plugins are still allowed to change
925
Run under the Python hotshot profiler.
928
Run under the Python lsprof profiler.
931
Generate line coverage report in the specified directory.
934
Specify the number of processes that can be run concurrently (selftest).
936
trace.mutter("bazaar version: " + bzrlib.__version__)
938
trace.mutter("bzr arguments: %r", argv)
940
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
941
opt_no_aliases = False
942
opt_lsprof_file = opt_coverage_dir = None
944
# --no-plugins is handled specially at a very early stage. We need
945
# to load plugins before doing other command parsing so that they
946
# can override commands, but this needs to happen first.
954
elif a == '--lsprof':
956
elif a == '--lsprof-file':
958
opt_lsprof_file = argv[i + 1]
960
elif a == '--no-plugins':
961
opt_no_plugins = True
962
elif a == '--no-aliases':
963
opt_no_aliases = True
964
elif a == '--builtin':
966
elif a == '--concurrency':
967
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
969
elif a == '--coverage':
970
opt_coverage_dir = argv[i + 1]
972
elif a.startswith('-D'):
973
debug.debug_flags.add(a[2:])
978
debug.set_debug_flags_from_config()
982
from bzrlib.builtins import cmd_help
983
cmd_help().run_argv_aliases([])
986
if argv[0] == '--version':
987
from bzrlib.builtins import cmd_version
988
cmd_version().run_argv_aliases([])
991
if not opt_no_plugins:
992
from bzrlib.plugin import load_plugins
995
from bzrlib.plugin import disable_plugins
1000
if not opt_no_aliases:
1001
alias_argv = get_alias(argv[0])
1003
user_encoding = osutils.get_user_encoding()
1004
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1005
argv[0] = alias_argv.pop(0)
1008
# We want only 'ascii' command names, but the user may have typed
1009
# in a Unicode name. In that case, they should just get a
1010
# 'command not found' error later.
1012
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1013
run = cmd_obj.run_argv_aliases
1014
run_argv = [argv, alias_argv]
1017
# We can be called recursively (tests for example), but we don't want
1018
# the verbosity level to propagate.
1019
saved_verbosity_level = option._verbosity_level
1020
option._verbosity_level = 0
1022
if opt_coverage_dir:
1024
'--coverage ignored, because --lsprof is in use.')
1025
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1027
if opt_coverage_dir:
1029
'--coverage ignored, because --profile is in use.')
1030
ret = apply_profiled(run, *run_argv)
1031
elif opt_coverage_dir:
1032
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1034
ret = run(*run_argv)
1037
# reset, in case we may do other commands later within the same
1038
# process. Commands that want to execute sub-commands must propagate
1039
# --verbose in their own way.
1040
if 'memory' in debug.debug_flags:
1041
trace.debug_memory('Process status after command:', short=False)
1042
option._verbosity_level = saved_verbosity_level
1045
def display_command(func):
1046
"""Decorator that suppresses pipe/interrupt errors."""
1047
def ignore_pipe(*args, **kwargs):
1049
result = func(*args, **kwargs)
1053
if getattr(e, 'errno', None) is None:
1055
if e.errno != errno.EPIPE:
1056
# Win32 raises IOError with errno=0 on a broken pipe
1057
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1060
except KeyboardInterrupt:
1065
def install_bzr_command_hooks():
1066
"""Install the hooks to supply bzr's own commands."""
1067
if _list_bzr_commands in Command.hooks["list_commands"]:
1069
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1071
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1073
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1074
"bzr plugin commands")
1075
Command.hooks.install_named_hook("get_command", _get_external_command,
1076
"bzr external command lookup")
1077
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1078
"bzr plugin-provider-db check")
1081
def main(argv=None):
1082
"""Main entry point of command-line interface.
1084
:param argv: list of unicode command-line arguments similar to sys.argv.
1085
argv[0] is script name usually, it will be ignored.
1086
Don't pass here sys.argv because this list contains plain strings
1087
and not unicode; pass None instead.
1089
:return: exit code of bzr command.
1092
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1093
sys.stdin, sys.stdout, sys.stderr)
1095
# Is this a final release version? If so, we should suppress warnings
1096
if bzrlib.version_info[3] == 'final':
1097
suppress_deprecation_warnings(override=True)
1099
argv = osutils.get_unicode_argv()
1103
# ensure all arguments are unicode strings
1105
if isinstance(a, unicode):
1108
new_argv.append(a.decode('ascii'))
1109
except UnicodeDecodeError:
1110
raise errors.BzrError("argv should be list of unicode strings.")
1112
ret = run_bzr_catch_errors(argv)
1113
bzrlib.ui.ui_factory.log_transport_activity(
1114
display=('bytes' in debug.debug_flags))
1115
trace.mutter("return code %d", ret)
1116
osutils.report_extension_load_failures()
1120
def run_bzr_catch_errors(argv):
1121
"""Run a bzr command with parameters as described by argv.
1123
This function assumed that that UI layer is setup, that symbol deprecations
1124
are already applied, and that unicode decoding has already been performed on argv.
1126
install_bzr_command_hooks()
1127
return exception_to_return_code(run_bzr, argv)
1130
def run_bzr_catch_user_errors(argv):
1131
"""Run bzr and report user errors, but let internal errors propagate.
1133
This is used for the test suite, and might be useful for other programs
1134
that want to wrap the commandline interface.
1136
install_bzr_command_hooks()
1138
return run_bzr(argv)
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')
1139
722
except Exception, e:
1140
if (isinstance(e, (OSError, IOError))
1141
or not getattr(e, 'internal_error', True)):
1142
trace.report_exception(sys.exc_info(), sys.stderr)
1148
class HelpCommandIndex(object):
1149
"""A index for bzr help that returns commands."""
1152
self.prefix = 'commands/'
1154
def get_topics(self, topic):
1155
"""Search for topic amongst commands.
1157
:param topic: A topic to search for.
1158
:return: A list which is either empty or contains a single
1161
if topic and topic.startswith(self.prefix):
1162
topic = topic[len(self.prefix):]
1164
cmd = _get_cmd_object(topic)
1171
class Provider(object):
1172
'''Generic class to be overriden by plugins'''
1174
def plugin_for_command(self, cmd_name):
1175
'''Takes a command and returns the information for that plugin
1177
:return: A dictionary with all the available information
1178
for the requested plugin
1180
raise NotImplementedError
1183
class ProvidersRegistry(registry.Registry):
1184
'''This registry exists to allow other providers to exist'''
1187
for key, provider in self.iteritems():
1190
command_providers_registry = ProvidersRegistry()
723
log_error('bzr: exception: %s\n' % e)
724
log_error(' see .bzr.log for details\n')
725
traceback.print_exc(None, bzrlib.trace._tracefile)
726
traceback.print_exc(None, sys.stderr)
729
# TODO: Maybe nicer handling of IOError?
1193
733
if __name__ == '__main__':
1194
734
sys.exit(main(sys.argv))
736
##profile.run('main(sys.argv)')
added
removed
bzr.py
