1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
13
# GNU General Public License for more details.
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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(), """
38
from warnings import warn
19
"""Bazaar-NG -- a free distributed version-control tool
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* No handling of subdirectories, symlinks or any non-text files.
30
* Insufficient error handling.
32
* Many commands unimplemented or partially implemented.
34
* Space-inefficient storage.
36
* No merge operators yet.
38
Interesting commands::
41
Show summary help screen
43
Show software version/licence/non-warranty.
45
Start versioning the current directory
49
Show revision history.
51
Show changes from last revision to working copy.
52
bzr commit -m 'MESSAGE'
53
Store current state as new revision.
54
bzr export REVNO DESTINATION
55
Export the branch state at a previous version.
57
Show summary of pending changes.
59
Make a file not versioned.
61
Show statistics about this branch.
66
__copyright__ = "Copyright 2005 Canonical Development Ltd."
67
__author__ = "Martin Pool <mbp@canonical.com>"
68
__docformat__ = "restructuredtext en"
72
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
73
import traceback, socket, fnmatch, difflib
76
from pprint import pprint
51
from bzrlib.symbol_versioning import (
56
from bzrlib.option import Option
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
90
def _squish_command_name(cmd):
91
return 'cmd_' + cmd.replace('-', '_')
94
def _unsquish_command_name(cmd):
95
assert cmd.startswith("cmd_")
96
return cmd[4:].replace('_','-')
99
def _builtin_commands():
100
import bzrlib.builtins
102
builtins = bzrlib.builtins.__dict__
103
for name in builtins:
104
if name.startswith("cmd_"):
105
real_name = _unsquish_command_name(name)
106
r[real_name] = builtins[name]
110
def builtin_command_names():
111
"""Return list of builtin command names."""
112
return _builtin_commands().keys()
115
def plugin_command_names():
116
return plugin_cmds.keys()
119
def _get_cmd_dict(plugins_override=True):
120
"""Return name->class mapping for all commands."""
121
d = _builtin_commands()
123
d.update(plugin_cmds)
127
def get_all_cmds(plugins_override=True):
128
"""Return canonical name and class for all registered commands."""
129
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
133
def get_cmd_object(cmd_name, plugins_override=True):
134
"""Return the canonical name and command class for a command.
137
If true, plugin commands can override builtins.
140
return _get_cmd_object(cmd_name, plugins_override)
142
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
145
def _get_cmd_object(cmd_name, plugins_override=True):
146
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
147
from bzrlib.externalcommand import ExternalCommand
149
# We want only 'ascii' command names, but the user may have typed
150
# in a Unicode name. In that case, they should just get a
151
# 'command not found' error later.
152
# In the future, we may actually support Unicode command names.
154
# first look up this command under the specified name
155
cmds = _get_cmd_dict(plugins_override=plugins_override)
157
return cmds[cmd_name]()
161
# look for any command which claims this as an alias
162
for real_cmd_name, cmd_class in cmds.iteritems():
163
if cmd_name in cmd_class.aliases:
166
cmd_obj = ExternalCommand.find_command(cmd_name)
172
class Command(object):
173
"""Base class for commands.
175
Commands are the heart of the command-line bzr interface.
177
The command object mostly handles the mapping of command-line
178
parameters into one or more bzrlib operations, and of the results
181
Commands normally don't have any state. All their arguments are
182
passed in to the run method. (Subclasses may take a different
183
policy if the behaviour of the instance needs to depend on e.g. a
184
shell plugin and not just its Python class.)
186
The docstring for an actual command should give a single-line
187
summary, then a complete description of the command. A grammar
188
description will be inserted.
191
Other accepted names for this command.
194
List of argument forms, marked with whether they are optional,
199
['to_location', 'from_branch?', 'file*']
201
'to_location' is required
202
'from_branch' is optional
203
'file' can be specified 0 or more times
206
List of options that may be given for this command. These can
207
be either strings, referring to globally-defined options,
208
or option objects. Retrieve through options().
211
If true, this command isn't advertised. This is typically
212
for commands intended for expert users.
215
Command objects will get a 'outf' attribute, which has been
216
setup to properly handle encoding of unicode strings.
217
encoding_type determines what will happen when characters cannot
219
strict - abort if we cannot decode
220
replace - put in a bogus character (typically '?')
221
exact - do not encode sys.stdout
223
NOTE: by default on Windows, sys.stdout is opened as a text
224
stream, therefore LF line-endings are converted to CRLF.
225
When a command uses encoding_type = 'exact', then
226
sys.stdout is forced to be a binary stream, and line-endings
233
encoding_type = 'strict'
238
"""Construct an instance of this command."""
239
if self.__doc__ == Command.__doc__:
240
warn("No help message set for %r" % self)
242
def _maybe_expand_globs(self, file_list):
243
"""Glob expand file_list if the platform does not do that itself.
245
:return: A possibly empty list of unicode paths.
247
Introduced in bzrlib 0.18.
251
if sys.platform == 'win32':
252
file_list = win32utils.glob_expand(file_list)
253
return list(file_list)
256
"""Return single-line grammar for this command.
258
Only describes arguments, not options.
260
s = 'bzr ' + self.name() + ' '
261
for aname in self.takes_args:
262
aname = aname.upper()
263
if aname[-1] in ['$', '+']:
264
aname = aname[:-1] + '...'
265
elif aname[-1] == '?':
266
aname = '[' + aname[:-1] + ']'
267
elif aname[-1] == '*':
268
aname = '[' + aname[:-1] + '...]'
81
from bzrlib.store import ImmutableStore
82
from bzrlib.trace import mutter, note, log_error
83
from bzrlib.errors import bailout, BzrError
84
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
85
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
86
from bzrlib.revision import Revision
87
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
90
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
91
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
93
## standard representation
94
NONE_STRING = '(none)'
98
## TODO: Perhaps a different version of inventory commands that
99
## returns iterators...
101
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
103
## TODO: Some kind of locking on branches. Perhaps there should be a
104
## parameter to the branch object saying whether we want a read or
105
## write lock; release it from destructor. Perhaps don't even need a
106
## read lock to look at immutable objects?
108
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
109
## to compare output?
111
## TODO: Some kind of global code to generate the right Branch object
112
## to work on. Almost, but not quite all, commands need one, and it
113
## can be taken either from their parameters or their working
116
## TODO: rename command, needed soon: check destination doesn't exist
117
## either in working copy or tree; move working copy; update
118
## inventory; write out
120
## TODO: move command; check destination is a directory and will not
123
## TODO: command to show renames, one per line, as to->from
128
def cmd_status(all=False):
129
"""Display status summary.
131
For each file there is a single line giving its file state and name.
132
The name is that in the current revision unless it is deleted or
133
missing, in which case the old name is shown.
135
:todo: Don't show unchanged files unless ``--all`` is given?
137
Branch('.').show_status(show_all=all)
141
######################################################################
143
def cmd_get_revision(revision_id):
144
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
147
def cmd_get_file_text(text_id):
148
"""Get contents of a file by hash."""
149
sf = Branch('.').text_store[text_id]
150
pumpfile(sf, sys.stdout)
154
######################################################################
159
"""Show number of revisions on this branch"""
160
print Branch('.').revno()
164
def cmd_add(file_list, verbose=False):
165
"""Add specified files or directories.
167
In non-recursive mode, all the named items are added, regardless
168
of whether they were previously ignored. A warning is given if
169
any of the named files are already versioned.
171
In recursive mode (the default), files are treated the same way
172
but the behaviour for directories is different. Directories that
173
are already versioned do not give a warning. All directories,
174
whether already versioned or not, are searched for files or
175
subdirectories that are neither versioned or ignored, and these
176
are added. This search proceeds recursively into versioned
179
Therefore simply saying 'bzr add .' will version all files that
180
are currently unknown.
183
bzrlib.add.smart_add(file_list, verbose)
187
b = Branch(file_list[0], find_root=True)
188
b.add([b.relpath(f) for f in file_list], verbose=verbose)
192
def cmd_relpath(filename):
193
print Branch(filename).relpath(filename)
196
def cmd_inventory(revision=None):
197
"""Show inventory of the current working copy."""
198
## TODO: Also optionally show a previous inventory
199
## TODO: Format options
202
inv = b.read_working_inventory()
204
inv = b.get_revision_inventory(b.lookup_revision(revision))
206
for path, entry in inv.iter_entries():
207
print '%-50s %s' % (entry.file_id, path)
213
info.show_info(Branch('.'))
217
def cmd_remove(file_list, verbose=False):
218
b = Branch(file_list[0])
219
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
223
def cmd_file_id(filename):
225
i = b.inventory.path2id(b.relpath(filename))
227
bailout("%s is not a versioned file" % filename)
232
def cmd_find_filename(fileid):
233
n = find_filename(fileid)
235
bailout("%s is not a live file id" % fileid)
240
def cmd_revision_history():
241
for patchid in Branch('.').revision_history():
247
# TODO: Check we're not already in a working directory? At the
248
# moment you'll get an ugly error.
250
# TODO: What if we're in a subdirectory of a branch? Would like
251
# to allow that, but then the parent may need to understand that
252
# the children have disappeared, or should they be versioned in
255
# TODO: Take an argument/option for branch name.
256
Branch('.', init=True)
259
def cmd_diff(revision=None):
260
"""Show diff from basis to working copy.
262
:todo: Take one or two revision arguments, look up those trees,
265
:todo: Allow diff across branches.
267
:todo: Mangle filenames in diff to be more relevant.
269
:todo: Shouldn't be in the cmd function.
275
old_tree = b.basis_tree()
277
old_tree = b.revision_tree(b.lookup_revision(revision))
279
new_tree = b.working_tree()
280
old_inv = old_tree.inventory
281
new_inv = new_tree.inventory
283
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
287
DEVNULL = '/dev/null'
288
# Windows users, don't panic about this filename -- it is a
289
# special signal to GNU patch that the file should be created or
290
# deleted respectively.
292
# TODO: Generation of pseudo-diffs for added/deleted files could
293
# be usefully made into a much faster special case.
295
# TODO: Better to return them in sorted order I think.
297
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
300
# Don't show this by default; maybe do it if an option is passed
301
# idlabel = ' {%s}' % fid
304
# FIXME: Something about the diff format makes patch unhappy
305
# with newly-added files.
307
def diffit(*a, **kw):
308
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
311
if file_state in ['.', '?', 'I']:
313
elif file_state == 'A':
314
print '*** added %s %r' % (kind, new_name)
317
new_tree.get_file(fid).readlines(),
319
tofile=new_label + new_name + idlabel)
320
elif file_state == 'D':
321
assert isinstance(old_name, types.StringTypes)
322
print '*** deleted %s %r' % (kind, old_name)
324
diffit(old_tree.get_file(fid).readlines(), [],
325
fromfile=old_label + old_name + idlabel,
327
elif file_state in ['M', 'R']:
328
if file_state == 'M':
329
assert kind == 'file'
330
assert old_name == new_name
331
print '*** modified %s %r' % (kind, new_name)
332
elif file_state == 'R':
333
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
336
diffit(old_tree.get_file(fid).readlines(),
337
new_tree.get_file(fid).readlines(),
338
fromfile=old_label + old_name + idlabel,
339
tofile=new_label + new_name)
341
bailout("can't represent state %s {%s}" % (file_state, fid))
345
def cmd_root(filename=None):
346
"""Print the branch root."""
347
print bzrlib.branch.find_branch_root(filename)
350
def cmd_log(timezone='original'):
351
"""Show log of this branch.
353
:todo: Options for utc; to show ids; to limit range; etc.
355
Branch('.').write_log(show_timezone=timezone)
358
def cmd_ls(revision=None, verbose=False):
359
"""List files in a tree.
361
:todo: Take a revision or remote path and list that tree instead.
365
tree = b.working_tree()
367
tree = b.revision_tree(b.lookup_revision(revision))
369
for fp, fc, kind, fid in tree.list_files():
371
if kind == 'directory':
275
def get_help_text(self, additional_see_also=None, plain=True,
276
see_also_as_links=False):
277
"""Return a text string with help for this command.
279
:param additional_see_also: Additional help topics to be
281
:param plain: if False, raw help (reStructuredText) is
282
returned instead of plain text.
283
:param see_also_as_links: if True, convert items in 'See also'
284
list to internal links (used by bzr_man rstx generator)
288
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
290
# Extract the summary (purpose) and sections out from the text
291
purpose,sections = self._get_help_parts(doc)
293
# If a custom usage section was provided, use it
294
if sections.has_key('Usage'):
295
usage = sections.pop('Usage')
297
usage = self._usage()
299
# The header is the purpose and usage
301
result += ':Purpose: %s\n' % purpose
302
if usage.find('\n') >= 0:
303
result += ':Usage:\n%s\n' % usage
305
result += ':Usage: %s\n' % usage
309
options = option.get_optparser(self.options()).format_option_help()
310
if options.startswith('Options:'):
311
result += ':' + options
312
elif options.startswith('options:'):
313
# Python 2.4 version of optparse
314
result += ':Options:' + options[len('options:'):]
319
# Add the description, indenting it 2 spaces
320
# to match the indentation of the options
321
if sections.has_key(None):
322
text = sections.pop(None)
323
text = '\n '.join(text.splitlines())
324
result += ':%s:\n %s\n\n' % ('Description',text)
326
# Add the custom sections (e.g. Examples). Note that there's no need
327
# to indent these as they must be indented already in the source.
329
labels = sorted(sections.keys())
331
result += ':%s:\n%s\n\n' % (label,sections[label])
333
# Add the aliases, source (plug-in) and see also links, if any
335
result += ':Aliases: '
336
result += ', '.join(self.aliases) + '\n'
337
plugin_name = self.plugin_name()
338
if plugin_name is not None:
339
result += ':From: plugin "%s"\n' % plugin_name
340
see_also = self.get_see_also(additional_see_also)
342
if not plain and see_also_as_links:
344
for item in see_also:
346
# topics doesn't have an independent section
347
# so don't create a real link
348
see_also_links.append(item)
350
# Use a reST link for this entry
351
see_also_links.append("`%s`_" % (item,))
352
see_also = see_also_links
353
result += ':See also: '
354
result += ', '.join(see_also) + '\n'
356
# If this will be rendered as plan text, convert it
358
import bzrlib.help_topics
359
result = bzrlib.help_topics.help_as_plain_text(result)
363
def _get_help_parts(text):
364
"""Split help text into a summary and named sections.
366
:return: (summary,sections) where summary is the top line and
367
sections is a dictionary of the rest indexed by section name.
368
A section starts with a heading line of the form ":xxx:".
369
Indented text on following lines is the section value.
370
All text found outside a named section is assigned to the
371
default section which is given the key of None.
373
def save_section(sections, label, section):
375
if sections.has_key(label):
376
sections[label] += '\n' + section
378
sections[label] = section
380
lines = text.rstrip().splitlines()
381
summary = lines.pop(0)
383
label,section = None,''
385
if line.startswith(':') and line.endswith(':') and len(line) > 2:
386
save_section(sections, label, section)
387
label,section = line[1:-1],''
388
elif label != None and len(line) > 1 and not line[0].isspace():
389
save_section(sections, label, section)
390
label,section = None,line
393
section += '\n' + line
396
save_section(sections, label, section)
397
return summary, sections
399
def get_help_topic(self):
400
"""Return the commands help topic - its name."""
403
def get_see_also(self, additional_terms=None):
404
"""Return a list of help topics that are related to this command.
406
The list is derived from the content of the _see_also attribute. Any
407
duplicates are removed and the result is in lexical order.
408
:param additional_terms: Additional help topics to cross-reference.
409
:return: A list of help topics.
411
see_also = set(getattr(self, '_see_also', []))
413
see_also.update(additional_terms)
414
return sorted(see_also)
417
"""Return dict of valid options for this command.
419
Maps from long option name to option object."""
421
r['help'] = option._help_option
422
for o in self.takes_options:
423
if isinstance(o, basestring):
424
o = option.Option.OPTIONS[o]
428
def _setup_outf(self):
429
"""Return a file linked to stdout, which has proper encoding."""
430
assert self.encoding_type in ['strict', 'exact', 'replace']
432
# Originally I was using self.stdout, but that looks
433
# *way* too much like sys.stdout
434
if self.encoding_type == 'exact':
435
# force sys.stdout to be binary stream on win32
436
if sys.platform == 'win32':
437
fileno = getattr(sys.stdout, 'fileno', None)
440
msvcrt.setmode(fileno(), os.O_BINARY)
441
self.outf = sys.stdout
444
output_encoding = osutils.get_terminal_encoding()
446
# use 'replace' so that we don't abort if trying to write out
447
# in e.g. the default C locale.
448
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
449
# For whatever reason codecs.getwriter() does not advertise its encoding
450
# it just returns the encoding of the wrapped file, which is completely
451
# bogus. So set the attribute, so we can find the correct encoding later.
452
self.outf.encoding = output_encoding
454
def run_argv_aliases(self, argv, alias_argv=None):
455
"""Parse the command line and run with extra aliases in alias_argv."""
457
warn("Passing None for [] is deprecated from bzrlib 0.10",
458
DeprecationWarning, stacklevel=2)
460
args, opts = parse_args(self, argv, alias_argv)
461
if 'help' in opts: # e.g. bzr add --help
462
sys.stdout.write(self.get_help_text())
464
# mix arguments and options into one dictionary
465
cmdargs = _match_argform(self.name(), self.takes_args, args)
467
for k, v in opts.items():
468
cmdopts[k.replace('-', '_')] = v
470
all_cmd_args = cmdargs.copy()
471
all_cmd_args.update(cmdopts)
475
return self.run(**all_cmd_args)
478
"""Actually run the command.
480
This is invoked with the options and arguments bound to
483
Return 0 or None if the command was successful, or a non-zero
484
shell error code if not. It's OK for this method to allow
485
an exception to raise up.
487
raise NotImplementedError('no implementation of command %r'
491
"""Return help message for this class."""
492
from inspect import getdoc
493
if self.__doc__ is Command.__doc__:
498
return _unsquish_command_name(self.__class__.__name__)
500
def plugin_name(self):
501
"""Get the name of the plugin that provides this command.
503
:return: The name of the plugin or None if the command is builtin.
505
mod_parts = self.__module__.split('.')
506
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
512
def parse_args(command, argv, alias_argv=None):
378
print '%-8s %s%s' % (fc, fp, kindch)
385
"""List unknown files"""
386
for f in Branch('.').unknowns():
390
def cmd_lookup_revision(revno):
394
bailout("usage: lookup-revision REVNO",
395
["REVNO is a non-negative revision number for this branch"])
397
print Branch('.').lookup_revision(revno) or NONE_STRING
401
def cmd_export(revno, dest):
402
"""Export past revision to destination directory."""
404
rh = b.lookup_revision(int(revno))
405
t = b.revision_tree(rh)
410
######################################################################
411
# internal/test commands
415
"""Print a newly-generated UUID."""
416
print bzrlib.osutils.uuid()
420
def cmd_local_time_offset():
421
print bzrlib.osutils.local_time_offset()
425
def cmd_commit(message=None, verbose=False):
427
bailout("please specify a commit message")
428
Branch('.').commit(message, verbose=verbose)
432
"""Check consistency of the branch."""
436
def cmd_is(pred, *rest):
437
"""Test whether PREDICATE is true."""
439
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
441
bailout("unknown predicate: %s" % quotefn(pred))
445
except BzrCheckError:
446
# by default we don't print the message so that this can
447
# be used from shell scripts without producing noise
452
print bzrlib.osutils.username()
455
def cmd_user_email():
456
print bzrlib.osutils.user_email()
459
def cmd_gen_revision_id():
461
print bzrlib.branch._gen_revision_id(time.time())
464
def cmd_selftest(verbose=False):
465
"""Run internal test suite"""
466
## -v, if present, is seen by doctest; the argument is just here
467
## so our parser doesn't complain
469
## TODO: --verbose option
471
failures, tests = 0, 0
473
import doctest, bzrlib.store, bzrlib.tests
474
bzrlib.trace.verbose = False
476
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
477
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
478
mf, mt = doctest.testmod(m)
481
print '%-40s %3d tests' % (m.__name__, mt),
483
print '%3d FAILED!' % mf
487
print '%-40s %3d tests' % ('total', tests),
489
print '%3d FAILED!' % failures
496
cmd_doctest = cmd_selftest
499
######################################################################
504
# TODO: Specific help for particular commands
509
print "bzr (bazaar-ng) %s" % __version__
511
print "http://bazaar-ng.org/"
514
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
515
you may use, modify and redistribute it under the terms of the GNU
516
General Public License version 2 or later."""
520
"""Statement of optimism."""
521
print "it sure does!"
525
######################################################################
529
# list of all available options; the rhs can be either None for an
530
# option that takes no argument, or a constructor function that checks
549
# List of options that apply to particular commands; commands not
553
'commit': ['message', 'verbose'],
554
'diff': ['revision'],
555
'inventory': ['revision'],
556
'log': ['show-ids', 'timezone'],
557
'ls': ['revision', 'verbose'],
558
'remove': ['verbose'],
568
'file-id': ['filename'],
569
'root': ['filename?'],
570
'relpath': ['filename'],
571
'get-file-text': ['text_id'],
572
'get-inventory': ['inventory_id'],
573
'get-revision': ['revision_id'],
574
'get-revision-inventory': ['revision_id'],
576
'lookup-revision': ['revno'],
577
'export': ['revno', 'dest'],
583
def parse_args(argv):
513
584
"""Parse command line.
515
586
Arguments and options are parsed at this level before being passed
516
587
down to specific command handlers. This routine knows, from a
517
588
lookup table, something about the available options, what optargs
518
589
they take, and which commands will accept them.
591
>>> parse_args('--help'.split())
593
>>> parse_args('--version'.split())
594
([], {'version': True})
595
>>> parse_args('status --all'.split())
596
(['status'], {'all': True})
597
>>> parse_args('commit --message=biter'.split())
598
(['commit'], {'message': u'biter'})
520
# TODO: make it a method of the Command?
521
parser = option.get_optparser(command.options())
522
if alias_argv is not None:
523
args = alias_argv + argv
527
options, args = parser.parse_args(args)
528
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
529
v is not option.OptionParser.DEFAULT_VALUE])
603
# TODO: Maybe handle '--' to end options?
610
mutter(" got option %r" % a)
612
optname, optarg = a[2:].split('=', 1)
615
if optname not in OPTIONS:
616
bailout('unknown long option %r' % a)
619
if shortopt not in SHORT_OPTIONS:
620
bailout('unknown short option %r' % a)
621
optname = SHORT_OPTIONS[shortopt]
624
# XXX: Do we ever want to support this, e.g. for -r?
625
bailout('repeated option %r' % a)
627
optargfn = OPTIONS[optname]
631
bailout('option %r needs an argument' % a)
634
opts[optname] = optargfn(optarg)
635
mutter(" option argument %r" % opts[optname])
638
bailout('option %r takes no argument' % optname)
530
643
return args, opts
533
def _match_argform(cmd, takes_args, args):
647
def _match_args(cmd, args):
648
"""Check non-option arguments match required pattern.
650
>>> _match_args('status', ['asdasdsadasd'])
651
Traceback (most recent call last):
653
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
654
>>> _match_args('add', ['asdasdsadasd'])
655
{'file_list': ['asdasdsadasd']}
656
>>> _match_args('add', 'abc def gj'.split())
657
{'file_list': ['abc', 'def', 'gj']}
659
# match argument pattern
660
argform = cmd_args.get(cmd, [])
662
# TODO: Need a way to express 'cp SRC... DEST', where it matches
536
# step through args and takes_args, allowing appropriate 0-many matches
537
for ap in takes_args:
665
# step through args and argform, allowing appropriate 0-many matches
538
667
argname = ap[:-1]
539
668
if ap[-1] == '?':
541
670
argdict[argname] = args.pop(0)
542
elif ap[-1] == '*': # all remaining arguments
544
argdict[argname + '_list'] = args[:]
547
argdict[argname + '_list'] = None
548
673
elif ap[-1] == '+':
550
raise errors.BzrCommandError("command %r needs one or more %s"
551
% (cmd, argname.upper()))
675
bailout("command %r needs one or more %s"
676
% (cmd, argname.upper()))
553
678
argdict[argname + '_list'] = args[:]
555
elif ap[-1] == '$': # all but one
557
raise errors.BzrCommandError("command %r needs one or more %s"
558
% (cmd, argname.upper()))
559
argdict[argname + '_list'] = args[:-1]
562
681
# just a plain arg
565
raise errors.BzrCommandError("command %r requires argument %s"
566
% (cmd, argname.upper()))
684
bailout("command %r requires argument %s"
685
% (cmd, argname.upper()))
568
687
argdict[argname] = args.pop(0)
571
raise errors.BzrCommandError("extra argument to command %s: %s"
690
bailout("extra arguments to command %s: %r"
578
def apply_profiled(the_callable, *args, **kwargs):
582
pffileno, pfname = tempfile.mkstemp()
584
prof = hotshot.Profile(pfname)
586
ret = prof.runcall(the_callable, *args, **kwargs) or 0
589
stats = hotshot.stats.load(pfname)
591
stats.sort_stats('cum') # 'time'
592
## XXX: Might like to write to stderr or the trace file instead but
593
## print_stats seems hardcoded to stdout
594
stats.print_stats(20)
601
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
602
from bzrlib.lsprof import profile
603
ret, stats = profile(the_callable, *args, **kwargs)
609
trace.note('Profile data written to "%s".', filename)
613
def get_alias(cmd, config=None):
614
"""Return an expanded alias, or None if no alias exists.
617
Command to be checked for an alias.
619
Used to specify an alternative config to use,
620
which is especially useful for testing.
621
If it is unspecified, the global config will be used.
625
config = bzrlib.config.GlobalConfig()
626
alias = config.get_alias(cmd)
629
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
633
697
def run_bzr(argv):
634
698
"""Execute a command.
636
700
This is similar to main(), but without all the trappings for
637
logging and error handling.
640
The command-line arguments, without the program name from argv[0]
641
These should already be decoded. All library/test code calling
642
run_bzr should be passing valid strings (don't need decoding).
644
Returns a command status or raises an exception.
646
Special master options: these must come before the command because
647
they control how the command is interpreted.
650
Do not load plugin modules at all
656
Only use builtin commands. (Plugins are still allowed to change
660
Run under the Python hotshot profiler.
663
Run under the Python lsprof profiler.
701
logging and error handling.
666
trace.mutter("bzr arguments: %r", argv)
668
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
669
opt_no_aliases = False
670
opt_lsprof_file = None
672
# --no-plugins is handled specially at a very early stage. We need
673
# to load plugins before doing other command parsing so that they
674
# can override commands, but this needs to happen first.
682
elif a == '--lsprof':
684
elif a == '--lsprof-file':
686
opt_lsprof_file = argv[i + 1]
688
elif a == '--no-plugins':
689
opt_no_plugins = True
690
elif a == '--no-aliases':
691
opt_no_aliases = True
692
elif a == '--builtin':
694
elif a in ('--quiet', '-q'):
696
elif a.startswith('-D'):
697
debug.debug_flags.add(a[2:])
704
from bzrlib.builtins import cmd_help
705
cmd_help().run_argv_aliases([])
708
if argv[0] == '--version':
709
from bzrlib.version import show_version
713
if not opt_no_plugins:
714
from bzrlib.plugin import load_plugins
717
from bzrlib.plugin import disable_plugins
722
if not opt_no_aliases:
723
alias_argv = get_alias(argv[0])
725
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
726
argv[0] = alias_argv.pop(0)
729
# We want only 'ascii' command names, but the user may have typed
730
# in a Unicode name. In that case, they should just get a
731
# 'command not found' error later.
733
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
734
run = cmd_obj.run_argv_aliases
735
run_argv = [argv, alias_argv]
739
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
741
ret = apply_profiled(run, *run_argv)
746
# reset, in case we may do other commands later within the same process
747
trace.be_quiet(False)
749
def display_command(func):
750
"""Decorator that suppresses pipe/interrupt errors."""
751
def ignore_pipe(*args, **kwargs):
753
result = func(*args, **kwargs)
757
if getattr(e, 'errno', None) is None:
759
if e.errno != errno.EPIPE:
760
# Win32 raises IOError with errno=0 on a broken pipe
761
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
764
except KeyboardInterrupt:
704
args, opts = parse_args(argv[1:])
706
# TODO: pass down other arguments in case they asked for
707
# help on a command name?
710
elif 'version' in opts:
715
log_error('usage: bzr COMMAND\n')
716
log_error(' try "bzr help"\n')
720
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
722
bailout("unknown command " + `cmd`)
724
# TODO: special --profile option to turn on the Python profiler
726
# check options are reasonable
727
allowed = cmd_options.get(cmd, [])
729
if oname not in allowed:
730
bailout("option %r is not allowed for command %r"
733
cmdargs = _match_args(cmd, args)
736
ret = cmd_handler(**cmdargs) or 0
771
from bzrlib.ui.text import TextUIFactory
772
bzrlib.ui.ui_factory = TextUIFactory()
773
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
774
ret = run_bzr_catch_errors(argv)
775
trace.mutter("return code %d", ret)
779
def run_bzr_catch_errors(argv):
741
## TODO: Handle command-line options; probably know what options are valid for
744
## TODO: If the arguments are wrong, give a usage message rather
745
## than just a backtrace.
747
bzrlib.trace.create_tracefile(argv)
782
except (KeyboardInterrupt, Exception), e:
783
# used to handle AssertionError and KeyboardInterrupt
784
# specially here, but hopefully they're handled ok by the logger now
785
trace.report_exception(sys.exc_info(), sys.stderr)
786
if os.environ.get('BZR_PDB'):
787
print '**** entering debugger'
789
pdb.post_mortem(sys.exc_traceback)
793
class HelpCommandIndex(object):
794
"""A index for bzr help that returns commands."""
797
self.prefix = 'commands/'
799
def get_topics(self, topic):
800
"""Search for topic amongst commands.
802
:param topic: A topic to search for.
803
:return: A list which is either empty or contains a single
806
if topic and topic.startswith(self.prefix):
807
topic = topic[len(self.prefix):]
809
cmd = _get_cmd_object(topic)
753
log_error('bzr: error: ' + e.args[0] + '\n')
756
log_error(' ' + h + '\n')
759
log_error('bzr: exception: %s\n' % e)
760
log_error(' see .bzr.log for details\n')
761
traceback.print_exc(None, bzrlib.trace._tracefile)
762
traceback.print_exc(None, sys.stderr)
765
# TODO: Maybe nicer handling of IOError?
816
769
if __name__ == '__main__':
817
770
sys.exit(main(sys.argv))
772
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
