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
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
67
from pprint import pprint
70
from inspect import getdoc
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__])
88
trace.log_error('Previously this command was registered from %r' %
89
sys.modules[plugin_cmds[k_unsquished].__module__])
92
def _squish_command_name(cmd):
93
return 'cmd_' + cmd.replace('-', '_')
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
98
return cmd[4:].replace('_','-')
101
def _builtin_commands():
102
import bzrlib.builtins
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
106
if name.startswith("cmd_"):
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
112
def builtin_command_names():
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
117
def plugin_command_names():
118
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
135
def get_cmd_object(cmd_name, plugins_override=True):
136
"""Return the canonical name and command class for a command.
139
If true, plugin commands can override builtins.
142
return _get_cmd_object(cmd_name, plugins_override)
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
151
# We want only 'ascii' command names, but the user may have typed
152
# in a Unicode name. In that case, they should just get a
153
# 'command not found' error later.
154
# In the future, we may actually support Unicode command names.
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
163
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
168
cmd_obj = ExternalCommand.find_command(cmd_name)
174
class Command(object):
175
"""Base class for commands.
177
Commands are the heart of the command-line bzr interface.
179
The command object mostly handles the mapping of command-line
180
parameters into one or more bzrlib operations, and of the results
183
Commands normally don't have any state. All their arguments are
184
passed in to the run method. (Subclasses may take a different
185
policy if the behaviour of the instance needs to depend on e.g. a
186
shell plugin and not just its Python class.)
188
The docstring for an actual command should give a single-line
189
summary, then a complete description of the command. A grammar
190
description will be inserted.
193
Other accepted names for this command.
196
List of argument forms, marked with whether they are optional,
201
['to_location', 'from_branch?', 'file*']
203
'to_location' is required
204
'from_branch' is optional
205
'file' can be specified 0 or more times
208
List of options that may be given for this command. These can
209
be either strings, referring to globally-defined options,
210
or option objects. Retrieve through options().
213
If true, this command isn't advertised. This is typically
214
for commands intended for expert users.
217
Command objects will get a 'outf' attribute, which has been
218
setup to properly handle encoding of unicode strings.
219
encoding_type determines what will happen when characters cannot
221
strict - abort if we cannot decode
222
replace - put in a bogus character (typically '?')
223
exact - do not encode sys.stdout
225
NOTE: by default on Windows, sys.stdout is opened as a text
226
stream, therefore LF line-endings are converted to CRLF.
227
When a command uses encoding_type = 'exact', then
228
sys.stdout is forced to be a binary stream, and line-endings
235
encoding_type = 'strict'
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
243
# List of standard options directly supported
244
self.supported_std_options = []
246
def _maybe_expand_globs(self, file_list):
247
"""Glob expand file_list if the platform does not do that itself.
249
:return: A possibly empty list of unicode paths.
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
260
"""Return single-line grammar for this command.
262
Only describes arguments, not options.
264
s = 'bzr ' + self.name() + ' '
265
for aname in self.takes_args:
266
aname = aname.upper()
267
if aname[-1] in ['$', '+']:
268
aname = aname[:-1] + '...'
269
elif aname[-1] == '?':
270
aname = '[' + aname[:-1] + ']'
271
elif aname[-1] == '*':
272
aname = '[' + aname[:-1] + '...]'
279
def get_help_text(self, additional_see_also=None, plain=True,
280
see_also_as_links=False):
281
"""Return a text string with help for this command.
283
:param additional_see_also: Additional help topics to be
285
:param plain: if False, raw help (reStructuredText) is
286
returned instead of plain text.
287
:param see_also_as_links: if True, convert items in 'See also'
288
list to internal links (used by bzr_man rstx generator)
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
294
# Extract the summary (purpose) and sections out from the text
295
purpose,sections = self._get_help_parts(doc)
297
# If a custom usage section was provided, use it
298
if sections.has_key('Usage'):
299
usage = sections.pop('Usage')
301
usage = self._usage()
303
# The header is the purpose and usage
305
result += ':Purpose: %s\n' % purpose
306
if usage.find('\n') >= 0:
307
result += ':Usage:\n%s\n' % usage
309
result += ':Usage: %s\n' % usage
313
options = option.get_optparser(self.options()).format_option_help()
314
if options.startswith('Options:'):
315
result += ':' + options
316
elif options.startswith('options:'):
317
# Python 2.4 version of optparse
318
result += ':Options:' + options[len('options:'):]
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
337
# Add the aliases, source (plug-in) and see also links, if any
339
result += ':Aliases: '
340
result += ', '.join(self.aliases) + '\n'
341
plugin_name = self.plugin_name()
342
if plugin_name is not None:
343
result += ':From: plugin "%s"\n' % plugin_name
344
see_also = self.get_see_also(additional_see_also)
346
if not plain and see_also_as_links:
348
for item in see_also:
350
# topics doesn't have an independent section
351
# so don't create a real link
352
see_also_links.append(item)
354
# Use a reST link for this entry
355
see_also_links.append("`%s`_" % (item,))
356
see_also = see_also_links
357
result += ':See also: '
358
result += ', '.join(see_also) + '\n'
360
# If this will be rendered as plan text, convert it
362
import bzrlib.help_topics
363
result = bzrlib.help_topics.help_as_plain_text(result)
367
def _get_help_parts(text):
368
"""Split help text into a summary and named sections.
370
:return: (summary,sections) where summary is the top line and
371
sections is a dictionary of the rest indexed by section name.
372
A section starts with a heading line of the form ":xxx:".
373
Indented text on following lines is the section value.
374
All text found outside a named section is assigned to the
375
default section which is given the key of None.
377
def save_section(sections, label, section):
379
if sections.has_key(label):
380
sections[label] += '\n' + section
382
sections[label] = section
384
lines = text.rstrip().splitlines()
385
summary = lines.pop(0)
387
label,section = None,''
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
390
save_section(sections, label, section)
391
label,section = line[1:-1],''
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
394
label,section = None,line
397
section += '\n' + line
400
save_section(sections, label, section)
401
return summary, sections
403
def get_help_topic(self):
404
"""Return the commands help topic - its name."""
407
def get_see_also(self, additional_terms=None):
408
"""Return a list of help topics that are related to this command.
410
The list is derived from the content of the _see_also attribute. Any
411
duplicates are removed and the result is in lexical order.
412
:param additional_terms: Additional help topics to cross-reference.
413
:return: A list of help topics.
415
see_also = set(getattr(self, '_see_also', []))
417
see_also.update(additional_terms)
418
return sorted(see_also)
421
"""Return dict of valid options for this command.
423
Maps from long option name to option object."""
424
r = Option.STD_OPTIONS.copy()
426
for o in self.takes_options:
427
if isinstance(o, basestring):
428
o = option.Option.OPTIONS[o]
430
if o.name in std_names:
431
self.supported_std_options.append(o.name)
434
def _setup_outf(self):
435
"""Return a file linked to stdout, which has proper encoding."""
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
459
def run_argv_aliases(self, argv, alias_argv=None):
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
465
args, opts = parse_args(self, argv, alias_argv)
467
# Process the standard options
468
if 'help' in opts: # e.g. bzr add --help
469
sys.stdout.write(self.get_help_text())
471
trace.set_verbosity_level(option._verbosity_level)
472
if 'verbose' in self.supported_std_options:
473
opts['verbose'] = trace.is_verbose()
474
elif opts.has_key('verbose'):
476
if 'quiet' in self.supported_std_options:
477
opts['quiet'] = trace.is_quiet()
478
elif opts.has_key('quiet'):
481
# mix arguments and options into one dictionary
482
cmdargs = _match_argform(self.name(), self.takes_args, args)
484
for k, v in opts.items():
485
cmdopts[k.replace('-', '_')] = v
487
all_cmd_args = cmdargs.copy()
488
all_cmd_args.update(cmdopts)
492
return self.run(**all_cmd_args)
495
"""Actually run the command.
497
This is invoked with the options and arguments bound to
500
Return 0 or None if the command was successful, or a non-zero
501
shell error code if not. It's OK for this method to allow
502
an exception to raise up.
504
raise NotImplementedError('no implementation of command %r'
508
"""Return help message for this class."""
509
from inspect import getdoc
510
if self.__doc__ is Command.__doc__:
515
return _unsquish_command_name(self.__class__.__name__)
517
def plugin_name(self):
518
"""Get the name of the plugin that provides this command.
520
:return: The name of the plugin or None if the command is builtin.
522
mod_parts = self.__module__.split('.')
523
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
529
def parse_args(command, argv, alias_argv=None):
73
from bzrlib.store import ImmutableStore
74
from bzrlib.trace import mutter, note, log_error
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
## standard representation
86
NONE_STRING = '(none)'
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
112
## TODO: move command; check destination is a directory and will not
115
## TODO: command to show renames, one per line, as to->from
120
def cmd_status(all=False):
121
"""Display status summary.
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
127
:todo: Don't show unchanged files unless ``--all`` is given?
129
#import bzrlib.status
130
#bzrlib.status.tree_status(Branch('.'))
131
Branch('.').show_status(show_all=all)
135
######################################################################
137
def cmd_get_revision(revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
141
def cmd_get_file_text(text_id):
142
"""Get contents of a file by hash."""
143
sf = Branch('.').text_store[text_id]
144
pumpfile(sf, sys.stdout)
148
######################################################################
153
"""Show number of revisions on this branch"""
154
print Branch('.').revno()
158
def cmd_add(file_list, verbose=False):
159
"""Add specified files or directories.
161
In non-recursive mode, all the named items are added, regardless
162
of whether they were previously ignored. A warning is given if
163
any of the named files are already versioned.
165
In recursive mode (the default), files are treated the same way
166
but the behaviour for directories is different. Directories that
167
are already versioned do not give a warning. All directories,
168
whether already versioned or not, are searched for files or
169
subdirectories that are neither versioned or ignored, and these
170
are added. This search proceeds recursively into versioned
173
Therefore simply saying 'bzr add .' will version all files that
174
are currently unknown.
176
bzrlib.add.smart_add(file_list, verbose)
179
def cmd_relpath(filename):
180
"""Show path of file relative to root"""
181
print Branch(filename).relpath(filename)
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)
200
# TODO: Maybe a 'mv' command that has the combined move/rename
201
# special behaviour of Unix?
203
def cmd_move(source_list, dest):
206
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
210
def cmd_rename(from_name, to_name):
211
"""Change the name of an entry.
213
usage: bzr rename FROM_NAME TO_NAME
216
bzr rename frob.c frobber.c
217
bzr rename src/frob.c lib/frob.c
219
It is an error if the destination name exists.
221
See also the 'move' command, which moves files into a different
222
directory without changing their name.
224
TODO: Some way to rename multiple files without invoking bzr for each
227
b.rename_one(b.relpath(from_name), b.relpath(to_name))
232
def cmd_renames(dir='.'):
233
"""Show list of renamed files.
235
usage: bzr renames [BRANCH]
237
TODO: Option to show renames between two historical versions.
239
TODO: Only show renames under dir, rather than in the whole branch.
242
old_inv = b.basis_tree().inventory
243
new_inv = b.read_working_inventory()
245
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
247
for old_name, new_name in renames:
248
print "%s => %s" % (old_name, new_name)
253
"""info: Show statistical information for this branch
257
info.show_info(Branch('.'))
261
def cmd_remove(file_list, verbose=False):
262
b = Branch(file_list[0])
263
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
267
def cmd_file_id(filename):
268
"""Print file_id of a particular file or directory.
270
usage: bzr file-id FILE
272
The file_id is assigned when the file is first added and remains the
273
same through all revisions where the file exists, even when it is
277
i = b.inventory.path2id(b.relpath(filename))
279
bailout("%r is not a versioned file" % filename)
284
def cmd_file_id_path(filename):
285
"""Print path of file_ids to a file or directory.
287
usage: bzr file-id-path FILE
289
This prints one line for each directory down to the target,
290
starting at the branch root."""
293
fid = inv.path2id(b.relpath(filename))
295
bailout("%r is not a versioned file" % filename)
296
for fip in inv.get_idpath(fid):
300
def cmd_revision_history():
301
for patchid in Branch('.').revision_history():
305
def cmd_directories():
306
for name, ie in Branch('.').read_working_inventory().directories():
314
for name, ie in Branch('.').working_tree().missing():
319
# TODO: Check we're not already in a working directory? At the
320
# moment you'll get an ugly error.
322
# TODO: What if we're in a subdirectory of a branch? Would like
323
# to allow that, but then the parent may need to understand that
324
# the children have disappeared, or should they be versioned in
327
# TODO: Take an argument/option for branch name.
328
Branch('.', init=True)
331
def cmd_diff(revision=None, file_list=None):
332
"""bzr diff: Show differences in working tree.
334
usage: bzr diff [-r REV] [FILE...]
337
Show changes since REV, rather than predecessor.
339
If files are listed, only the changes in those files are listed.
340
Otherwise, all changes for the tree are listed.
342
TODO: Given two revision arguments, show the difference between them.
344
TODO: Allow diff across branches.
346
TODO: Option to use external diff command; could be GNU diff, wdiff,
349
TODO: If a directory is given, diff everything under that.
351
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
354
## TODO: Shouldn't be in the cmd function.
359
old_tree = b.basis_tree()
361
old_tree = b.revision_tree(b.lookup_revision(revision))
363
new_tree = b.working_tree()
365
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
369
DEVNULL = '/dev/null'
370
# Windows users, don't panic about this filename -- it is a
371
# special signal to GNU patch that the file should be created or
372
# deleted respectively.
374
# TODO: Generation of pseudo-diffs for added/deleted files could
375
# be usefully made into a much faster special case.
377
# TODO: Better to return them in sorted order I think.
379
# FIXME: If given a file list, compare only those files rather
380
# than comparing everything and then throwing stuff away.
382
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
384
if file_list and new_name not in file_list:
387
# Don't show this by default; maybe do it if an option is passed
388
# idlabel = ' {%s}' % fid
391
# FIXME: Something about the diff format makes patch unhappy
392
# with newly-added files.
394
def diffit(oldlines, newlines, **kw):
395
# FIXME: difflib is wrong if there is no trailing newline.
397
# Special workaround for Python2.3, where difflib fails if
398
# both sequences are empty.
399
if oldlines or newlines:
400
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
403
if file_state in ['.', '?', 'I']:
405
elif file_state == 'A':
406
print '*** added %s %r' % (kind, new_name)
409
new_tree.get_file(fid).readlines(),
411
tofile=new_label + new_name + idlabel)
412
elif file_state == 'D':
413
assert isinstance(old_name, types.StringTypes)
414
print '*** deleted %s %r' % (kind, old_name)
416
diffit(old_tree.get_file(fid).readlines(), [],
417
fromfile=old_label + old_name + idlabel,
419
elif file_state in ['M', 'R']:
420
if file_state == 'M':
421
assert kind == 'file'
422
assert old_name == new_name
423
print '*** modified %s %r' % (kind, new_name)
424
elif file_state == 'R':
425
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
428
diffit(old_tree.get_file(fid).readlines(),
429
new_tree.get_file(fid).readlines(),
430
fromfile=old_label + old_name + idlabel,
431
tofile=new_label + new_name)
433
bailout("can't represent state %s {%s}" % (file_state, fid))
437
def cmd_deleted(show_ids=False):
438
"""List files deleted in the working tree.
440
TODO: Show files deleted since a previous revision, or between two revisions.
444
new = b.working_tree()
446
## TODO: Much more efficient way to do this: read in new
447
## directories with readdir, rather than stating each one. Same
448
## level of effort but possibly much less IO. (Or possibly not,
449
## if the directories are very large...)
451
for path, ie in old.inventory.iter_entries():
452
if not new.has_id(ie.file_id):
454
print '%-50s %s' % (path, ie.file_id)
460
def cmd_parse_inventory():
463
cElementTree.ElementTree().parse(file('.bzr/inventory'))
467
def cmd_load_inventory():
468
"""Load inventory for timing purposes"""
469
Branch('.').basis_tree().inventory
472
def cmd_dump_inventory():
473
Branch('.').read_working_inventory().write_xml(sys.stdout)
476
def cmd_dump_new_inventory():
477
import bzrlib.newinventory
478
inv = Branch('.').basis_tree().inventory
479
bzrlib.newinventory.write_inventory(inv, sys.stdout)
482
def cmd_load_new_inventory():
483
import bzrlib.newinventory
484
bzrlib.newinventory.read_new_inventory(sys.stdin)
487
def cmd_dump_slacker_inventory():
488
import bzrlib.newinventory
489
inv = Branch('.').basis_tree().inventory
490
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
494
def cmd_dump_text_inventory():
495
import bzrlib.textinv
496
inv = Branch('.').basis_tree().inventory
497
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
500
def cmd_load_text_inventory():
501
import bzrlib.textinv
502
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
503
print 'loaded %d entries' % len(inv)
507
def cmd_root(filename=None):
508
"""Print the branch root."""
509
print bzrlib.branch.find_branch_root(filename)
512
def cmd_log(timezone='original'):
513
"""Show log of this branch.
515
:todo: Options for utc; to show ids; to limit range; etc.
517
Branch('.').write_log(show_timezone=timezone)
520
def cmd_ls(revision=None, verbose=False):
521
"""List files in a tree.
523
:todo: Take a revision or remote path and list that tree instead.
527
tree = b.working_tree()
529
tree = b.revision_tree(b.lookup_revision(revision))
531
for fp, fc, kind, fid in tree.list_files():
533
if kind == 'directory':
540
print '%-8s %s%s' % (fc, fp, kindch)
547
"""List unknown files"""
548
for f in Branch('.').unknowns():
554
"""List ignored files and the patterns that matched them.
556
tree = Branch('.').working_tree()
557
for path, file_class, kind, file_id in tree.list_files():
558
if file_class != 'I':
560
## XXX: Slightly inefficient since this was already calculated
561
pat = tree.is_ignored(path)
562
print '%-50s %s' % (path, pat)
565
def cmd_lookup_revision(revno):
569
bailout("usage: lookup-revision REVNO",
570
["REVNO is a non-negative revision number for this branch"])
572
print Branch('.').lookup_revision(revno) or NONE_STRING
576
def cmd_export(revno, dest):
577
"""Export past revision to destination directory."""
579
rh = b.lookup_revision(int(revno))
580
t = b.revision_tree(rh)
583
def cmd_cat(revision, filename):
584
"""Print file to stdout."""
586
b.print_file(b.relpath(filename), int(revision))
589
######################################################################
590
# internal/test commands
594
"""Print a newly-generated UUID."""
595
print bzrlib.osutils.uuid()
599
def cmd_local_time_offset():
600
print bzrlib.osutils.local_time_offset()
604
def cmd_commit(message=None, verbose=False):
605
"""Commit changes to a new revision.
608
Description of changes in this revision; free form text.
609
It is recommended that the first line be a single-sentence
612
Show status of changed files,
614
TODO: Commit only selected files.
616
TODO: Run hooks on tree to-be-committed, and after commit.
618
TODO: Strict commit that fails if there are unknown or deleted files.
622
bailout("please specify a commit message")
623
Branch('.').commit(message, verbose=verbose)
626
def cmd_check(dir='.'):
627
"""check: Consistency check of branch history.
629
usage: bzr check [-v] [BRANCH]
632
--verbose, -v Show progress of checking.
634
This command checks various invariants about the branch storage to
635
detect data corruption or bzr bugs.
638
bzrlib.check.check(Branch(dir, find_root=False))
641
def cmd_is(pred, *rest):
642
"""Test whether PREDICATE is true."""
644
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
646
bailout("unknown predicate: %s" % quotefn(pred))
650
except BzrCheckError:
651
# by default we don't print the message so that this can
652
# be used from shell scripts without producing noise
657
print bzrlib.osutils.username()
660
def cmd_user_email():
661
print bzrlib.osutils.user_email()
664
def cmd_gen_revision_id():
665
print bzrlib.branch._gen_revision_id(time.time())
669
"""Run internal test suite"""
670
## -v, if present, is seen by doctest; the argument is just here
671
## so our parser doesn't complain
673
## TODO: --verbose option
675
failures, tests = 0, 0
677
import doctest, bzrlib.store, bzrlib.tests
678
bzrlib.trace.verbose = False
680
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
681
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
682
mf, mt = doctest.testmod(m)
685
print '%-40s %3d tests' % (m.__name__, mt),
687
print '%3d FAILED!' % mf
691
print '%-40s %3d tests' % ('total', tests),
693
print '%3d FAILED!' % failures
700
cmd_doctest = cmd_selftest
703
######################################################################
707
def cmd_help(topic=None):
712
# otherwise, maybe the name of a command?
714
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
716
bailout("no help for %r" % topic)
720
bailout("sorry, no detailed help yet for %r" % topic)
728
print "bzr (bazaar-ng) %s" % bzrlib.__version__
729
print bzrlib.__copyright__
730
print "http://bazaar-ng.org/"
733
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
734
you may use, modify and redistribute it under the terms of the GNU
735
General Public License version 2 or later."""
739
"""Statement of optimism."""
740
print "it sure does!"
744
######################################################################
748
# list of all available options; the rhs can be either None for an
749
# option that takes no argument, or a constructor function that checks
769
# List of options that apply to particular commands; commands not
774
'commit': ['message', 'verbose'],
775
'deleted': ['show-ids'],
776
'diff': ['revision'],
777
'inventory': ['revision'],
779
'ls': ['revision', 'verbose'],
780
'remove': ['verbose'],
790
'export': ['revno', 'dest'],
791
'file-id': ['filename'],
792
'file-id-path': ['filename'],
793
'get-file-text': ['text_id'],
794
'get-inventory': ['inventory_id'],
795
'get-revision': ['revision_id'],
796
'get-revision-inventory': ['revision_id'],
800
'lookup-revision': ['revno'],
801
'move': ['source$', 'dest'],
802
'relpath': ['filename'],
804
'rename': ['from_name', 'to_name'],
806
'root': ['filename?'],
811
def parse_args(argv):
530
812
"""Parse command line.
532
814
Arguments and options are parsed at this level before being passed
533
815
down to specific command handlers. This routine knows, from a
534
816
lookup table, something about the available options, what optargs
535
817
they take, and which commands will accept them.
819
>>> parse_args('--help'.split())
821
>>> parse_args('--version'.split())
822
([], {'version': True})
823
>>> parse_args('status --all'.split())
824
(['status'], {'all': True})
825
>>> parse_args('commit --message=biter'.split())
826
(['commit'], {'message': u'biter'})
537
# TODO: make it a method of the Command?
538
parser = option.get_optparser(command.options())
539
if alias_argv is not None:
540
args = alias_argv + argv
544
options, args = parser.parse_args(args)
545
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
546
v is not option.OptionParser.DEFAULT_VALUE])
831
# TODO: Maybe handle '--' to end options?
838
mutter(" got option %r" % a)
840
optname, optarg = a[2:].split('=', 1)
843
if optname not in OPTIONS:
844
bailout('unknown long option %r' % a)
847
if shortopt not in SHORT_OPTIONS:
848
bailout('unknown short option %r' % a)
849
optname = SHORT_OPTIONS[shortopt]
852
# XXX: Do we ever want to support this, e.g. for -r?
853
bailout('repeated option %r' % a)
855
optargfn = OPTIONS[optname]
859
bailout('option %r needs an argument' % a)
862
opts[optname] = optargfn(optarg)
865
bailout('option %r takes no argument' % optname)
547
870
return args, opts
550
def _match_argform(cmd, takes_args, args):
874
def _match_args(cmd, args):
875
"""Check non-option arguments match required pattern.
877
>>> _match_args('status', ['asdasdsadasd'])
878
Traceback (most recent call last):
880
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
881
>>> _match_args('add', ['asdasdsadasd'])
882
{'file_list': ['asdasdsadasd']}
883
>>> _match_args('add', 'abc def gj'.split())
884
{'file_list': ['abc', 'def', 'gj']}
886
# match argument pattern
887
argform = cmd_args.get(cmd, [])
889
# TODO: Need a way to express 'cp SRC... DEST', where it matches
553
# step through args and takes_args, allowing appropriate 0-many matches
554
for ap in takes_args:
892
# step through args and argform, allowing appropriate 0-many matches
555
894
argname = ap[:-1]
556
895
if ap[-1] == '?':
564
903
argdict[argname + '_list'] = None
565
904
elif ap[-1] == '+':
567
raise errors.BzrCommandError("command %r needs one or more %s"
568
% (cmd, argname.upper()))
906
bailout("command %r needs one or more %s"
907
% (cmd, argname.upper()))
570
909
argdict[argname + '_list'] = args[:]
572
911
elif ap[-1] == '$': # all but one
573
912
if len(args) < 2:
574
raise errors.BzrCommandError("command %r needs one or more %s"
575
% (cmd, argname.upper()))
913
bailout("command %r needs one or more %s"
914
% (cmd, argname.upper()))
576
915
argdict[argname + '_list'] = args[:-1]
579
918
# just a plain arg
582
raise errors.BzrCommandError("command %r requires argument %s"
583
% (cmd, argname.upper()))
921
bailout("command %r requires argument %s"
922
% (cmd, argname.upper()))
585
924
argdict[argname] = args.pop(0)
588
raise errors.BzrCommandError("extra argument to command %s: %s"
927
bailout("extra arguments to command %s: %r"
595
def apply_profiled(the_callable, *args, **kwargs):
599
pffileno, pfname = tempfile.mkstemp()
601
prof = hotshot.Profile(pfname)
603
ret = prof.runcall(the_callable, *args, **kwargs) or 0
606
stats = hotshot.stats.load(pfname)
608
stats.sort_stats('cum') # 'time'
609
## XXX: Might like to write to stderr or the trace file instead but
610
## print_stats seems hardcoded to stdout
611
stats.print_stats(20)
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
619
from bzrlib.lsprof import profile
620
ret, stats = profile(the_callable, *args, **kwargs)
626
trace.note('Profile data written to "%s".', filename)
630
def get_alias(cmd, config=None):
631
"""Return an expanded alias, or None if no alias exists.
634
Command to be checked for an alias.
636
Used to specify an alternative config to use,
637
which is especially useful for testing.
638
If it is unspecified, the global config will be used.
642
config = bzrlib.config.GlobalConfig()
643
alias = config.get_alias(cmd)
646
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
650
934
def run_bzr(argv):
651
935
"""Execute a command.
653
937
This is similar to main(), but without all the trappings for
654
logging and error handling.
657
The command-line arguments, without the program name from argv[0]
658
These should already be decoded. All library/test code calling
659
run_bzr should be passing valid strings (don't need decoding).
661
Returns a command status or raises an exception.
663
Special master options: these must come before the command because
664
they control how the command is interpreted.
667
Do not load plugin modules at all
673
Only use builtin commands. (Plugins are still allowed to change
677
Run under the Python hotshot profiler.
680
Run under the Python lsprof profiler.
938
logging and error handling.
683
trace.mutter("bzr arguments: %r", argv)
685
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
686
opt_no_aliases = False
687
opt_lsprof_file = None
689
# --no-plugins is handled specially at a very early stage. We need
690
# to load plugins before doing other command parsing so that they
691
# can override commands, but this needs to happen first.
699
elif a == '--lsprof':
701
elif a == '--lsprof-file':
703
opt_lsprof_file = argv[i + 1]
705
elif a == '--no-plugins':
706
opt_no_plugins = True
707
elif a == '--no-aliases':
708
opt_no_aliases = True
709
elif a == '--builtin':
711
elif a.startswith('-D'):
712
debug.debug_flags.add(a[2:])
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
723
if argv[0] == '--version':
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
728
if not opt_no_plugins:
729
from bzrlib.plugin import load_plugins
941
args, opts = parse_args(argv[1:])
943
# TODO: pass down other arguments in case they asked for
944
# help on a command name?
950
elif 'version' in opts:
955
log_error('usage: bzr COMMAND\n')
956
log_error(' try "bzr help"\n')
960
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
962
bailout("unknown command " + `cmd`)
965
if 'profile' in opts:
732
from bzrlib.plugin import disable_plugins
737
if not opt_no_aliases:
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
741
argv[0] = alias_argv.pop(0)
744
# We want only 'ascii' command names, but the user may have typed
745
# in a Unicode name. In that case, they should just get a
746
# 'command not found' error later.
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
749
run = cmd_obj.run_argv_aliases
750
run_argv = [argv, alias_argv]
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
756
ret = apply_profiled(run, *run_argv)
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
764
def display_command(func):
765
"""Decorator that suppresses pipe/interrupt errors."""
766
def ignore_pipe(*args, **kwargs):
971
# check options are reasonable
972
allowed = cmd_options.get(cmd, [])
974
if oname not in allowed:
975
bailout("option %r is not allowed for command %r"
978
# TODO: give an error if there are any mandatory options which are
979
# not specified? Or maybe there shouldn't be any "mandatory
980
# options" (it is an oxymoron)
982
# mix arguments and options into one dictionary
983
cmdargs = _match_args(cmd, args)
984
for k, v in opts.items():
985
cmdargs[k.replace('-', '_')] = v
989
pffileno, pfname = tempfile.mkstemp()
768
result = func(*args, **kwargs)
772
if getattr(e, 'errno', None) is None:
774
if e.errno != errno.EPIPE:
775
# Win32 raises IOError with errno=0 on a broken pipe
776
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
779
except KeyboardInterrupt:
991
prof = hotshot.Profile(pfname)
992
ret = prof.runcall(cmd_handler, **cmdargs) or 0
996
stats = hotshot.stats.load(pfname)
998
stats.sort_stats('time')
999
## XXX: Might like to write to stderr or the trace file instead but
1000
## print_stats seems hardcoded to stdout
1001
stats.print_stats(20)
1009
return cmd_handler(**cmdargs) or 0
786
from bzrlib.ui.text import TextUIFactory
787
bzrlib.ui.ui_factory = TextUIFactory()
789
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
790
except UnicodeDecodeError:
791
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
793
ret = run_bzr_catch_errors(argv)
794
trace.mutter("return code %d", ret)
798
def run_bzr_catch_errors(argv):
799
# Note: The except clause logic below should be kept in sync with the
800
# profile() routine in lsprof.py.
803
except (KeyboardInterrupt, Exception), e:
804
# used to handle AssertionError and KeyboardInterrupt
805
# specially here, but hopefully they're handled ok by the logger now
806
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
807
if os.environ.get('BZR_PDB'):
808
print '**** entering debugger'
810
pdb.post_mortem(sys.exc_traceback)
814
def run_bzr_catch_user_errors(argv):
815
"""Run bzr and report user errors, but let internal errors propagate.
817
This is used for the test suite, and might be useful for other programs
818
that want to wrap the commandline interface.
1014
## TODO: Handle command-line options; probably know what options are valid for
1017
## TODO: If the arguments are wrong, give a usage message rather
1018
## than just a backtrace.
1020
bzrlib.trace.create_tracefile(argv)
1026
log_error('bzr: error: ' + e.args[0] + '\n')
1029
log_error(' ' + h + '\n')
1030
traceback.print_exc(None, bzrlib.trace._tracefile)
1031
log_error('(see $HOME/.bzr.log for debug information)\n')
822
1033
except Exception, e:
823
if (isinstance(e, (OSError, IOError))
824
or not getattr(e, 'internal_error', True)):
825
trace.report_exception(sys.exc_info(), sys.stderr)
831
class HelpCommandIndex(object):
832
"""A index for bzr help that returns commands."""
835
self.prefix = 'commands/'
837
def get_topics(self, topic):
838
"""Search for topic amongst commands.
840
:param topic: A topic to search for.
841
:return: A list which is either empty or contains a single
844
if topic and topic.startswith(self.prefix):
845
topic = topic[len(self.prefix):]
847
cmd = _get_cmd_object(topic)
1034
log_error('bzr: exception: %s\n' % e)
1035
log_error('(see $HOME/.bzr.log for debug information)\n')
1036
traceback.print_exc(None, bzrlib.trace._tracefile)
1037
## traceback.print_exc(None, sys.stderr)
1040
## TODO: Trap AssertionError
1042
# TODO: Maybe nicer handling of IOError especially for broken pipe.
854
1046
if __name__ == '__main__':
855
1047
sys.exit(main(sys.argv))
1049
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
