1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Bazaar-NG -- a free distributed version-control tool
20
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
* Metadata format is not stable yet -- you may need to
23
discard history in the future.
25
* Many commands unimplemented or partially implemented.
27
* Space-inefficient storage.
29
* No merge operators yet.
36
Show software version/licence/non-warranty.
38
Start versioning the current directory
42
Show revision history.
45
bzr move FROM... DESTDIR
46
Move one or more files to a different directory.
48
Show changes from last revision to working copy.
49
bzr commit -m 'MESSAGE'
50
Store current state as new revision.
51
bzr export [-r REVNO] DESTINATION
52
Export the branch state at a previous version.
54
Show summary of pending changes.
56
Make a file not versioned.
58
Show statistics about this branch.
60
Verify history is stored safely.
61
(for more type 'bzr help commands')
67
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
69
from pprint import pprint
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
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
101
def get_cmd_class(cmd):
104
cmd = CMD_ALIASES.get(cmd, cmd)
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
109
raise BzrError("unknown command %r" % cmd)
111
return cmd, cmd_class
51
from bzrlib.symbol_versioning import (
58
from bzrlib.option import Option
64
def register_command(cmd, decorate=False):
65
"""Utility function to help register a command
67
:param cmd: Command subclass to register
68
:param decorate: If true, allow overriding an existing command
69
of the same name; the old command is returned by this function.
70
Otherwise it is an error to try to override an existing command.
74
if k.startswith("cmd_"):
75
k_unsquished = _unsquish_command_name(k)
78
if k_unsquished not in plugin_cmds:
79
plugin_cmds[k_unsquished] = cmd
80
## trace.mutter('registered plugin command %s', k_unsquished)
81
if decorate and k_unsquished in builtin_command_names():
82
return _builtin_commands()[k_unsquished]
84
result = plugin_cmds[k_unsquished]
85
plugin_cmds[k_unsquished] = cmd
88
trace.log_error('Two plugins defined the same command: %r' % k)
89
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__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):
116
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.)
118
188
The docstring for an actual command should give a single-line
119
189
summary, then a complete description of the command. A grammar
120
190
description will be inserted.
193
Other accepted names for this command.
123
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
127
List of options that may be given for this command.
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().
130
If true, this command isn't advertised.
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
135
234
takes_options = []
235
encoding_type = 'strict'
139
def __init__(self, options, arguments):
140
"""Construct and run the command.
142
Sets self.status to the return value of run()."""
143
assert isinstance(options, dict)
144
assert isinstance(arguments, dict)
145
cmdargs = options.copy()
146
cmdargs.update(arguments)
147
assert self.__doc__ != Command.__doc__, \
148
("No help message set for %r" % self)
149
self.status = self.run(**cmdargs)
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
244
def _maybe_expand_globs(self, file_list):
245
"""Glob expand file_list if the platform does not do that itself.
247
:return: A possibly empty list of unicode paths.
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
258
"""Return single-line grammar for this command.
260
Only describes arguments, not options.
262
s = 'bzr ' + self.name() + ' '
263
for aname in self.takes_args:
264
aname = aname.upper()
265
if aname[-1] in ['$', '+']:
266
aname = aname[:-1] + '...'
267
elif aname[-1] == '?':
268
aname = '[' + aname[:-1] + ']'
269
elif aname[-1] == '*':
270
aname = '[' + aname[:-1] + '...]'
277
def get_help_text(self, additional_see_also=None):
278
"""Return a text string with help for this command.
280
:param additional_see_also: Additional help topics to be
285
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
288
result += 'usage: %s\n' % self._usage()
291
result += 'aliases: '
292
result += ', '.join(self.aliases) + '\n'
296
plugin_name = self.plugin_name()
297
if plugin_name is not None:
298
result += '(From plugin "%s")' % plugin_name
302
if result[-1] != '\n':
305
result += option.get_optparser(self.options()).format_option_help()
306
see_also = self.get_see_also(additional_see_also)
308
result += '\nSee also: '
309
result += ', '.join(see_also)
313
def get_help_topic(self):
314
"""Return the commands help topic - its name."""
317
def get_see_also(self, additional_terms=None):
318
"""Return a list of help topics that are related to this ommand.
320
The list is derived from the content of the _see_also attribute. Any
321
duplicates are removed and the result is in lexical order.
322
:param additional_terms: Additional help topics to cross-reference.
323
:return: A list of help topics.
325
see_also = set(getattr(self, '_see_also', []))
327
see_also.update(additional_terms)
328
return sorted(see_also)
331
"""Return dict of valid options for this command.
333
Maps from long option name to option object."""
335
r['help'] = option.Option.OPTIONS['help']
336
for o in self.takes_options:
337
if isinstance(o, basestring):
338
o = option.Option.OPTIONS[o]
342
def _setup_outf(self):
343
"""Return a file linked to stdout, which has proper encoding."""
344
assert self.encoding_type in ['strict', 'exact', 'replace']
346
# Originally I was using self.stdout, but that looks
347
# *way* too much like sys.stdout
348
if self.encoding_type == 'exact':
349
# force sys.stdout to be binary stream on win32
350
if sys.platform == 'win32':
351
fileno = getattr(sys.stdout, 'fileno', None)
354
msvcrt.setmode(fileno(), os.O_BINARY)
355
self.outf = sys.stdout
358
output_encoding = osutils.get_terminal_encoding()
360
# use 'replace' so that we don't abort if trying to write out
361
# in e.g. the default C locale.
362
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
363
# For whatever reason codecs.getwriter() does not advertise its encoding
364
# it just returns the encoding of the wrapped file, which is completely
365
# bogus. So set the attribute, so we can find the correct encoding later.
366
self.outf.encoding = output_encoding
368
def run_argv_aliases(self, argv, alias_argv=None):
369
"""Parse the command line and run with extra aliases in alias_argv."""
371
warn("Passing None for [] is deprecated from bzrlib 0.10",
372
DeprecationWarning, stacklevel=2)
374
args, opts = parse_args(self, argv, alias_argv)
375
if 'help' in opts: # e.g. bzr add --help
376
sys.stdout.write(self.get_help_text())
378
# mix arguments and options into one dictionary
379
cmdargs = _match_argform(self.name(), self.takes_args, args)
381
for k, v in opts.items():
382
cmdopts[k.replace('-', '_')] = v
384
all_cmd_args = cmdargs.copy()
385
all_cmd_args.update(cmdopts)
389
return self.run(**all_cmd_args)
153
"""Override this in sub-classes.
392
"""Actually run the command.
155
394
This is invoked with the options and arguments bound to
156
395
keyword parameters.
158
Return True if the command was successful, False if not.
164
class cmd_status(Command):
165
"""Display status summary.
167
For each file there is a single line giving its file state and name.
168
The name is that in the current revision unless it is deleted or
169
missing, in which case the old name is shown.
171
takes_options = ['all']
173
def run(self, all=False):
174
#import bzrlib.status
175
#bzrlib.status.tree_status(Branch('.'))
176
Branch('.').show_status(show_all=all)
179
class cmd_cat_revision(Command):
180
"""Write out metadata for a revision."""
183
takes_args = ['revision_id']
185
def run(self, revision_id):
186
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
189
class cmd_revno(Command):
190
"""Show current revision number.
192
This is equal to the number of revisions on this branch."""
194
print Branch('.').revno()
197
class cmd_add(Command):
198
"""Add specified files or directories.
200
In non-recursive mode, all the named items are added, regardless
201
of whether they were previously ignored. A warning is given if
202
any of the named files are already versioned.
204
In recursive mode (the default), files are treated the same way
205
but the behaviour for directories is different. Directories that
206
are already versioned do not give a warning. All directories,
207
whether already versioned or not, are searched for files or
208
subdirectories that are neither versioned or ignored, and these
209
are added. This search proceeds recursively into versioned
212
Therefore simply saying 'bzr add .' will version all files that
213
are currently unknown.
215
TODO: Perhaps adding a file whose directly is not versioned should
216
recursively add that parent, rather than giving an error?
218
takes_args = ['file+']
219
takes_options = ['verbose']
221
def run(self, file_list, verbose=False):
222
bzrlib.add.smart_add(file_list, verbose)
225
def Relpath(Command):
226
"""Show path of a file relative to root"""
227
takes_args = ('filename')
230
print Branch(self.args['filename']).relpath(filename)
234
class cmd_inventory(Command):
235
"""Show inventory of the current working copy or a revision."""
236
takes_options = ['revision']
238
def run(self, revision=None):
241
inv = b.read_working_inventory()
243
inv = b.get_revision_inventory(b.lookup_revision(revision))
245
for path, entry in inv.iter_entries():
246
print '%-50s %s' % (entry.file_id, path)
249
class cmd_move(Command):
250
"""Move files to a different directory.
255
The destination must be a versioned directory in the same branch.
257
takes_args = ['source$', 'dest']
258
def run(self, source_list, dest):
261
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
264
class cmd_rename(Command):
265
"""Change the name of an entry.
268
bzr rename frob.c frobber.c
269
bzr rename src/frob.c lib/frob.c
271
It is an error if the destination name exists.
273
See also the 'move' command, which moves files into a different
274
directory without changing their name.
276
TODO: Some way to rename multiple files without invoking bzr for each
278
takes_args = ['from_name', 'to_name']
280
def run(self, from_name, to_name):
282
b.rename_one(b.relpath(from_name), b.relpath(to_name))
286
class cmd_renames(Command):
287
"""Show list of renamed files.
289
TODO: Option to show renames between two historical versions.
291
TODO: Only show renames under dir, rather than in the whole branch.
293
takes_args = ['dir?']
295
def run(self, dir='.'):
297
old_inv = b.basis_tree().inventory
298
new_inv = b.read_working_inventory()
300
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
302
for old_name, new_name in renames:
303
print "%s => %s" % (old_name, new_name)
306
class cmd_info(Command):
307
"""Show statistical information for this branch"""
310
info.show_info(Branch('.'))
313
class cmd_remove(Command):
314
"""Make a file unversioned.
316
This makes bzr stop tracking changes to a versioned file. It does
317
not delete the working copy.
319
takes_args = ['file+']
320
takes_options = ['verbose']
322
def run(self, file_list, verbose=False):
323
b = Branch(file_list[0])
324
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
327
class cmd_file_id(Command):
328
"""Print file_id of a particular file or directory.
330
The file_id is assigned when the file is first added and remains the
331
same through all revisions where the file exists, even when it is
335
takes_args = ['filename']
336
def run(self, filename):
338
i = b.inventory.path2id(b.relpath(filename))
340
bailout("%r is not a versioned file" % filename)
345
class cmd_file_path(Command):
346
"""Print path of file_ids to a file or directory.
348
This prints one line for each directory down to the target,
349
starting at the branch root."""
351
takes_args = ['filename']
352
def run(self, filename):
355
fid = inv.path2id(b.relpath(filename))
357
bailout("%r is not a versioned file" % filename)
358
for fip in inv.get_idpath(fid):
362
class cmd_revision_history(Command):
363
"""Display list of revision ids on this branch."""
365
for patchid in Branch('.').revision_history():
369
class cmd_directories(Command):
370
"""Display list of versioned directories in this branch."""
372
for name, ie in Branch('.').read_working_inventory().directories():
379
class cmd_init(Command):
380
"""Make a directory into a versioned branch.
382
Use this to create an empty branch, or before importing an
385
Recipe for importing a tree of files:
390
bzr commit -m 'imported project'
393
Branch('.', init=True)
396
class cmd_diff(Command):
397
"""Show differences in working tree.
399
If files are listed, only the changes in those files are listed.
400
Otherwise, all changes for the tree are listed.
402
TODO: Given two revision arguments, show the difference between them.
404
TODO: Allow diff across branches.
406
TODO: Option to use external diff command; could be GNU diff, wdiff,
409
TODO: Python difflib is not exactly the same as unidiff; should
410
either fix it up or prefer to use an external diff.
412
TODO: If a directory is given, diff everything under that.
414
TODO: Selected-file diff is inefficient and doesn't show you
417
TODO: This probably handles non-Unix newlines poorly.
420
takes_args = ['file*']
421
takes_options = ['revision']
423
def run(self, revision=None, file_list=None):
424
from bzrlib.diff import show_diff
426
show_diff(Branch('.'), revision, file_list)
429
class cmd_deleted(Command):
430
"""List files deleted in the working tree.
432
TODO: Show files deleted since a previous revision, or between two revisions.
434
def run(self, show_ids=False):
437
new = b.working_tree()
439
## TODO: Much more efficient way to do this: read in new
440
## directories with readdir, rather than stating each one. Same
441
## level of effort but possibly much less IO. (Or possibly not,
442
## if the directories are very large...)
444
for path, ie in old.inventory.iter_entries():
445
if not new.has_id(ie.file_id):
447
print '%-50s %s' % (path, ie.file_id)
451
class cmd_root(Command):
452
"""Show the tree root directory.
454
The root is the nearest enclosing directory with a .bzr control
456
takes_args = ['filename?']
457
def run(self, filename=None):
458
"""Print the branch root."""
459
print bzrlib.branch.find_branch_root(filename)
463
class cmd_log(Command):
464
"""Show log of this branch.
466
TODO: Options to show ids; to limit range; etc.
468
takes_options = ['timezone', 'verbose']
469
def run(self, timezone='original', verbose=False):
470
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
473
class cmd_ls(Command):
474
"""List files in a tree.
476
TODO: Take a revision or remote path and list that tree instead.
479
def run(self, revision=None, verbose=False):
482
tree = b.working_tree()
484
tree = b.revision_tree(b.lookup_revision(revision))
486
for fp, fc, kind, fid in tree.list_files():
488
if kind == 'directory':
495
print '%-8s %s%s' % (fc, fp, kindch)
501
class cmd_unknowns(Command):
502
"""List unknown files"""
504
for f in Branch('.').unknowns():
509
class cmd_ignore(Command):
510
"""Ignore a command or pattern"""
511
takes_args = ['name_pattern']
513
def run(self, name_pattern):
516
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
517
f = open(b.abspath('.bzrignore'), 'at')
518
f.write(name_pattern + '\n')
521
inv = b.working_tree().inventory
522
if inv.path2id('.bzrignore'):
523
mutter('.bzrignore is already versioned')
525
mutter('need to make new .bzrignore file versioned')
526
b.add(['.bzrignore'])
530
class cmd_ignored(Command):
531
"""List ignored files and the patterns that matched them."""
533
tree = Branch('.').working_tree()
534
for path, file_class, kind, file_id in tree.list_files():
535
if file_class != 'I':
537
## XXX: Slightly inefficient since this was already calculated
538
pat = tree.is_ignored(path)
539
print '%-50s %s' % (path, pat)
542
class cmd_lookup_revision(Command):
543
"""Lookup the revision-id from a revision-number
546
bzr lookup-revision 33
549
def run(self, revno):
553
raise BzrError("not a valid revision-number: %r" % revno)
555
print Branch('.').lookup_revision(revno) or NONE_STRING
559
class cmd_export(Command):
560
"""Export past revision to destination directory.
562
If no revision is specified this exports the last committed revision."""
563
takes_args = ['dest']
564
takes_options = ['revision']
565
def run(self, dest, revno=None):
568
rh = b.revision_history[-1]
570
rh = b.lookup_revision(int(revno))
571
t = b.revision_tree(rh)
575
class cmd_cat(Command):
576
"""Write a file's text from a previous revision."""
578
takes_options = ['revision']
579
takes_args = ['filename']
581
def run(self, filename, revision=None):
583
raise BzrCommandError("bzr cat requires a revision number")
585
b.print_file(b.relpath(filename), int(revision))
588
class cmd_local_time_offset(Command):
589
"""Show the offset in seconds from GMT to local time."""
592
print bzrlib.osutils.local_time_offset()
596
class cmd_commit(Command):
597
"""Commit changes into a new revision.
599
TODO: Commit only selected files.
601
TODO: Run hooks on tree to-be-committed, and after commit.
603
TODO: Strict commit that fails if there are unknown or deleted files.
605
takes_options = ['message', 'verbose']
607
def run(self, message=None, verbose=False):
609
raise BzrCommandError("please specify a commit message")
610
Branch('.').commit(message, verbose=verbose)
613
class cmd_check(Command):
614
"""Validate consistency of branch history.
616
This command checks various invariants about the branch storage to
617
detect data corruption or bzr bugs.
619
takes_args = ['dir?']
620
def run(self, dir='.'):
622
bzrlib.check.check(Branch(dir, find_root=False))
626
class cmd_whoami(Command):
627
"""Show bzr user id."""
628
takes_options = ['email']
630
def run(self, email=False):
632
print bzrlib.osutils.user_email()
634
print bzrlib.osutils.username()
637
class cmd_selftest(Command):
638
"""Run internal test suite"""
641
failures, tests = 0, 0
643
import doctest, bzrlib.store, bzrlib.tests
644
bzrlib.trace.verbose = False
646
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
647
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
648
mf, mt = doctest.testmod(m)
651
print '%-40s %3d tests' % (m.__name__, mt),
653
print '%3d FAILED!' % mf
657
print '%-40s %3d tests' % ('total', tests),
659
print '%3d FAILED!' % failures
665
class cmd_version(Command):
666
"""Show version of bzr"""
671
print "bzr (bazaar-ng) %s" % bzrlib.__version__
672
print bzrlib.__copyright__
673
print "http://bazaar-ng.org/"
675
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
676
print "you may use, modify and redistribute it under the terms of the GNU"
677
print "General Public License version 2 or later."
680
class cmd_rocks(Command):
681
"""Statement of optimism."""
684
print "it sure does!"
687
class cmd_assert_fail(Command):
688
"""Test reporting of assertion failures"""
691
assert False, "always fails"
694
class cmd_help(Command):
695
"""Show help on a command or other topic.
697
For a list of all available commands, say 'bzr help commands'."""
698
takes_args = ['topic?']
700
def run(self, topic=None):
704
def help(topic=None):
707
elif topic == 'commands':
710
help_on_command(topic)
713
def help_on_command(cmdname):
714
cmdname = str(cmdname)
716
from inspect import getdoc
717
topic, cmdclass = get_cmd_class(cmdname)
719
doc = getdoc(cmdclass)
721
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
724
short, rest = doc.split('\n', 1)
729
print 'usage: bzr ' + topic,
730
for aname in cmdclass.takes_args:
731
aname = aname.upper()
732
if aname[-1] in ['$', '+']:
733
aname = aname[:-1] + '...'
734
elif aname[-1] == '?':
735
aname = '[' + aname[:-1] + ']'
736
elif aname[-1] == '*':
737
aname = '[' + aname[:-1] + '...]'
744
help_on_option(cmdclass.takes_options)
747
def help_on_option(options):
755
for shortname, longname in SHORT_OPTIONS.items():
757
l += ', -' + shortname
763
"""List all commands"""
767
for k, v in globals().items():
768
if k.startswith('cmd_'):
769
accu.append((k[4:].replace('_','-'), v))
771
for cmdname, cmdclass in accu:
775
help = inspect.getdoc(cmdclass)
777
print " " + help.split('\n', 1)[0]
780
######################################################################
784
# list of all available options; the rhs can be either None for an
785
# option that takes no argument, or a constructor function that checks
807
def parse_args(argv):
397
Return 0 or None if the command was successful, or a non-zero
398
shell error code if not. It's OK for this method to allow
399
an exception to raise up.
401
raise NotImplementedError('no implementation of command %r'
405
"""Return help message for this class."""
406
from inspect import getdoc
407
if self.__doc__ is Command.__doc__:
412
return _unsquish_command_name(self.__class__.__name__)
414
def plugin_name(self):
415
"""Get the name of the plugin that provides this command.
417
:return: The name of the plugin or None if the command is builtin.
419
mod_parts = self.__module__.split('.')
420
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
426
# Technically, this function hasn't been use in a *really* long time
427
# but we are only deprecating it now.
428
@deprecated_function(zero_eleven)
429
def parse_spec(spec):
435
>>> parse_spec("../@")
437
>>> parse_spec("../f/@35")
439
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
440
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
445
parsed = spec.split('/@')
446
assert len(parsed) == 2
451
parsed[1] = int(parsed[1])
453
pass # We can allow stuff like ./@revid:blahblahblah
457
parsed = [spec, None]
460
def parse_args(command, argv, alias_argv=None):
808
461
"""Parse command line.
810
463
Arguments and options are parsed at this level before being passed
811
464
down to specific command handlers. This routine knows, from a
812
465
lookup table, something about the available options, what optargs
813
466
they take, and which commands will accept them.
815
>>> parse_args('--help'.split())
817
>>> parse_args('--version'.split())
818
([], {'version': True})
819
>>> parse_args('status --all'.split())
820
(['status'], {'all': True})
821
>>> parse_args('commit --message=biter'.split())
822
(['commit'], {'message': u'biter'})
827
# TODO: Maybe handle '--' to end options?
832
# option names must not be unicode
836
mutter(" got option %r" % a)
838
optname, optarg = a[2:].split('=', 1)
841
if optname not in OPTIONS:
842
bailout('unknown long option %r' % a)
845
if shortopt not in SHORT_OPTIONS:
846
bailout('unknown short option %r' % a)
847
optname = SHORT_OPTIONS[shortopt]
850
# XXX: Do we ever want to support this, e.g. for -r?
851
bailout('repeated option %r' % a)
853
optargfn = OPTIONS[optname]
857
bailout('option %r needs an argument' % a)
860
opts[optname] = optargfn(optarg)
863
bailout('option %r takes no argument' % optname)
468
# TODO: make it a method of the Command?
469
parser = option.get_optparser(command.options())
470
if alias_argv is not None:
471
args = alias_argv + argv
475
options, args = parser.parse_args(args)
476
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
477
v is not option.OptionParser.DEFAULT_VALUE])
868
478
return args, opts
873
481
def _match_argform(cmd, takes_args, args):
887
495
argdict[argname + '_list'] = None
888
496
elif ap[-1] == '+':
890
raise BzrCommandError("command %r needs one or more %s"
891
% (cmd, argname.upper()))
498
raise errors.BzrCommandError("command %r needs one or more %s"
499
% (cmd, argname.upper()))
893
501
argdict[argname + '_list'] = args[:]
895
503
elif ap[-1] == '$': # all but one
896
504
if len(args) < 2:
897
raise BzrCommandError("command %r needs one or more %s"
898
% (cmd, argname.upper()))
505
raise errors.BzrCommandError("command %r needs one or more %s"
506
% (cmd, argname.upper()))
899
507
argdict[argname + '_list'] = args[:-1]
902
510
# just a plain arg
905
raise BzrCommandError("command %r requires argument %s"
906
% (cmd, argname.upper()))
513
raise errors.BzrCommandError("command %r requires argument %s"
514
% (cmd, argname.upper()))
908
516
argdict[argname] = args.pop(0)
911
raise BzrCommandError("extra argument to command %s: %s"
519
raise errors.BzrCommandError("extra argument to command %s: %s"
526
def apply_profiled(the_callable, *args, **kwargs):
530
pffileno, pfname = tempfile.mkstemp()
532
prof = hotshot.Profile(pfname)
534
ret = prof.runcall(the_callable, *args, **kwargs) or 0
537
stats = hotshot.stats.load(pfname)
539
stats.sort_stats('cum') # 'time'
540
## XXX: Might like to write to stderr or the trace file instead but
541
## print_stats seems hardcoded to stdout
542
stats.print_stats(20)
549
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
550
from bzrlib.lsprof import profile
551
ret, stats = profile(the_callable, *args, **kwargs)
557
trace.note('Profile data written to "%s".', filename)
561
def get_alias(cmd, config=None):
562
"""Return an expanded alias, or None if no alias exists.
565
Command to be checked for an alias.
567
Used to specify an alternative config to use,
568
which is especially useful for testing.
569
If it is unspecified, the global config will be used.
573
config = bzrlib.config.GlobalConfig()
574
alias = config.get_alias(cmd)
577
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
918
581
def run_bzr(argv):
919
582
"""Execute a command.
921
584
This is similar to main(), but without all the trappings for
922
585
logging and error handling.
588
The command-line arguments, without the program name from argv[0]
589
These should already be decoded. All library/test code calling
590
run_bzr should be passing valid strings (don't need decoding).
592
Returns a command status or raises an exception.
594
Special master options: these must come before the command because
595
they control how the command is interpreted.
598
Do not load plugin modules at all
604
Only use builtin commands. (Plugins are still allowed to change
608
Run under the Python hotshot profiler.
611
Run under the Python lsprof profiler.
925
argv = [a.decode(bzrlib.user_encoding) for a in argv]
614
trace.mutter("bzr arguments: %r", argv)
616
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
617
opt_no_aliases = False
618
opt_lsprof_file = None
620
# --no-plugins is handled specially at a very early stage. We need
621
# to load plugins before doing other command parsing so that they
622
# can override commands, but this needs to happen first.
630
elif a == '--lsprof':
632
elif a == '--lsprof-file':
634
opt_lsprof_file = argv[i + 1]
636
elif a == '--no-plugins':
637
opt_no_plugins = True
638
elif a == '--no-aliases':
639
opt_no_aliases = True
640
elif a == '--builtin':
642
elif a in ('--quiet', '-q'):
644
elif a.startswith('-D'):
645
debug.debug_flags.add(a[2:])
652
from bzrlib.builtins import cmd_help
653
cmd_help().run_argv_aliases([])
656
if argv[0] == '--version':
657
from bzrlib.version import show_version
661
if not opt_no_plugins:
662
from bzrlib.plugin import load_plugins
665
from bzrlib.plugin import disable_plugins
670
if not opt_no_aliases:
671
alias_argv = get_alias(argv[0])
673
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
674
argv[0] = alias_argv.pop(0)
677
# We want only 'ascii' command names, but the user may have typed
678
# in a Unicode name. In that case, they should just get a
679
# 'command not found' error later.
681
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
682
run = cmd_obj.run_argv_aliases
683
run_argv = [argv, alias_argv]
928
args, opts = parse_args(argv[1:])
935
elif 'version' in opts:
938
cmd = str(args.pop(0))
940
log_error('usage: bzr COMMAND')
941
log_error(' try "bzr help"')
944
canonical_cmd, cmd_class = get_cmd_class(cmd)
947
if 'profile' in opts:
953
# check options are reasonable
954
allowed = cmd_class.takes_options
956
if oname not in allowed:
957
raise BzrCommandError("option %r is not allowed for command %r"
960
# mix arguments and options into one dictionary
961
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
963
for k, v in opts.items():
964
cmdopts[k.replace('-', '_')] = v
968
pffileno, pfname = tempfile.mkstemp()
687
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
689
ret = apply_profiled(run, *run_argv)
694
# reset, in case we may do other commands later within the same process
695
trace.be_quiet(False)
697
def display_command(func):
698
"""Decorator that suppresses pipe/interrupt errors."""
699
def ignore_pipe(*args, **kwargs):
970
prof = hotshot.Profile(pfname)
971
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
975
stats = hotshot.stats.load(pfname)
977
stats.sort_stats('time')
978
## XXX: Might like to write to stderr or the trace file instead but
979
## print_stats seems hardcoded to stdout
980
stats.print_stats(20)
988
cmdobj = cmd_class(cmdopts, cmdargs) or 0
992
def _report_exception(e, summary, quiet=False):
994
log_error('bzr: ' + summary)
995
bzrlib.trace.log_exception(e)
998
tb = sys.exc_info()[2]
999
exinfo = traceback.extract_tb(tb)
1001
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1002
sys.stderr.write(' see ~/.bzr.log for debug information\n')
701
result = func(*args, **kwargs)
705
if getattr(e, 'errno', None) is None:
707
if e.errno != errno.EPIPE:
708
# Win32 raises IOError with errno=0 on a broken pipe
709
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
712
except KeyboardInterrupt:
1009
bzrlib.trace.create_tracefile(argv)
719
from bzrlib.ui.text import TextUIFactory
720
bzrlib.ui.ui_factory = TextUIFactory()
721
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
722
ret = run_bzr_catch_errors(argv)
723
trace.mutter("return code %d", ret)
727
def run_bzr_catch_errors(argv):
730
except (KeyboardInterrupt, Exception), e:
731
# used to handle AssertionError and KeyboardInterrupt
732
# specially here, but hopefully they're handled ok by the logger now
733
trace.report_exception(sys.exc_info(), sys.stderr)
734
if os.environ.get('BZR_PDB'):
735
print '**** entering debugger'
737
pdb.post_mortem(sys.exc_traceback)
741
class HelpCommandIndex(object):
742
"""A index for bzr help that returns commands."""
745
self.prefix = 'commands/'
747
def get_topics(self, topic):
748
"""Search for topic amongst commands.
750
:param topic: A topic to search for.
751
:return: A list which is either empty or contains a single
754
if topic and topic.startswith(self.prefix):
755
topic = topic[len(self.prefix):]
1014
# do this here to catch EPIPE
1018
quiet = isinstance(e, (BzrCommandError))
1019
_report_exception(e, 'error: ' + e.args[0], quiet=quiet)
1022
# some explanation or hints
1025
except AssertionError, e:
1026
msg = 'assertion failed'
1028
msg += ': ' + str(e)
1029
_report_exception(e, msg)
1031
except KeyboardInterrupt, e:
1032
_report_exception(e, 'interrupted', quiet=True)
1034
except Exception, e:
1036
if isinstance(e, IOError) and e.errno == errno.EPIPE:
1040
msg = str(e).rstrip('\n')
1041
_report_exception(e, msg, quiet)
1044
bzrlib.trace.close_trace()
757
cmd = _get_cmd_object(topic)
1047
764
if __name__ == '__main__':
added
removed
bzrlib/commands.py
