1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2006 by 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?
33
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)
38
from bzrlib.errors import (BzrError,
43
from bzrlib.option import Option
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib.symbol_versioning import *
47
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
52
def register_command(cmd, decorate=False):
53
"""Utility function to help register a command
55
:param cmd: Command subclass to register
56
:param decorate: If true, allow overriding an existing command
57
of the same name; the old command is returned by this function.
58
Otherwise it is an error to try to override an existing command.
62
if k.startswith("cmd_"):
63
k_unsquished = _unsquish_command_name(k)
66
if not plugin_cmds.has_key(k_unsquished):
67
plugin_cmds[k_unsquished] = cmd
68
mutter('registered plugin command %s', k_unsquished)
69
if decorate and k_unsquished in builtin_command_names():
70
return _builtin_commands()[k_unsquished]
72
result = plugin_cmds[k_unsquished]
73
plugin_cmds[k_unsquished] = cmd
76
log_error('Two plugins defined the same command: %r' % k)
77
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
80
def _squish_command_name(cmd):
81
return 'cmd_' + cmd.replace('-', '_')
84
def _unsquish_command_name(cmd):
85
assert cmd.startswith("cmd_")
86
return cmd[4:].replace('_','-')
89
def _builtin_commands():
90
import bzrlib.builtins
92
builtins = bzrlib.builtins.__dict__
94
if name.startswith("cmd_"):
95
real_name = _unsquish_command_name(name)
96
r[real_name] = builtins[name]
100
def builtin_command_names():
101
"""Return list of builtin command names."""
102
return _builtin_commands().keys()
105
def plugin_command_names():
106
return plugin_cmds.keys()
109
def _get_cmd_dict(plugins_override=True):
110
"""Return name->class mapping for all commands."""
111
d = _builtin_commands()
113
d.update(plugin_cmds)
117
def get_all_cmds(plugins_override=True):
118
"""Return canonical name and class for all registered commands."""
119
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
123
def get_cmd_object(cmd_name, plugins_override=True):
124
"""Return the canonical name and command class for a command.
127
If true, plugin commands can override builtins.
129
from bzrlib.externalcommand import ExternalCommand
131
cmd_name = str(cmd_name) # not unicode
133
# first look up this command under the specified name
134
cmds = _get_cmd_dict(plugins_override=plugins_override)
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
136
return cmds[cmd_name]()
109
raise BzrError("unknown command %r" % cmd)
111
return cmd, cmd_class
140
# look for any command which claims this as an alias
141
for real_cmd_name, cmd_class in cmds.iteritems():
142
if cmd_name in cmd_class.aliases:
145
cmd_obj = ExternalCommand.find_command(cmd_name)
149
raise BzrCommandError("unknown command %r" % cmd_name)
152
class Command(object):
116
153
"""Base class for commands.
155
Commands are the heart of the command-line bzr interface.
157
The command object mostly handles the mapping of command-line
158
parameters into one or more bzrlib operations, and of the results
161
Commands normally don't have any state. All their arguments are
162
passed in to the run method. (Subclasses may take a different
163
policy if the behaviour of the instance needs to depend on e.g. a
164
shell plugin and not just its Python class.)
118
166
The docstring for an actual command should give a single-line
119
167
summary, then a complete description of the command. A grammar
120
168
description will be inserted.
171
Other accepted names for this command.
123
174
List of argument forms, marked with whether they are optional,
179
['to_location', 'from_branch?', 'file*']
181
'to_location' is required
182
'from_branch' is optional
183
'file' can be specified 0 or more times
127
List of options that may be given for this command.
186
List of options that may be given for this command. These can
187
be either strings, referring to globally-defined options,
188
or option objects. Retrieve through options().
130
If true, this command isn't advertised.
191
If true, this command isn't advertised. This is typically
192
for commands intended for expert users.
195
Command objects will get a 'outf' attribute, which has been
196
setup to properly handle encoding of unicode strings.
197
encoding_type determines what will happen when characters cannot
199
strict - abort if we cannot decode
200
replace - put in a bogus character (typically '?')
201
exact - do not encode sys.stdout
135
206
takes_options = []
207
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)
212
"""Construct an instance of this command."""
213
if self.__doc__ == Command.__doc__:
214
warn("No help message set for %r" % self)
217
"""Return dict of valid options for this command.
219
Maps from long option name to option object."""
221
r['help'] = Option.OPTIONS['help']
222
for o in self.takes_options:
223
if not isinstance(o, Option):
224
o = Option.OPTIONS[o]
228
def _setup_outf(self):
229
"""Return a file linked to stdout, which has proper encoding."""
230
assert self.encoding_type in ['strict', 'exact', 'replace']
232
# Originally I was using self.stdout, but that looks
233
# *way* too much like sys.stdout
234
if self.encoding_type == 'exact':
235
self.outf = sys.stdout
238
output_encoding = getattr(sys.stdout, 'encoding', None)
239
if not output_encoding:
240
input_encoding = getattr(sys.stdin, 'encoding', None)
241
if not input_encoding:
242
output_encoding = bzrlib.user_encoding
243
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
245
output_encoding = input_encoding
246
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
248
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
250
# use 'replace' so that we don't abort if trying to write out
251
# in e.g. the default C locale.
252
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
253
# For whatever reason codecs.getwriter() does not advertise its encoding
254
# it just returns the encoding of the wrapped file, which is completely
255
# bogus. So set the attribute, so we can find the correct encoding later.
256
self.outf.encoding = output_encoding
258
@deprecated_method(zero_eight)
259
def run_argv(self, argv):
260
"""Parse command line and run.
262
See run_argv_aliases for the 0.8 and beyond api.
264
return self.run_argv_aliases(argv)
266
def run_argv_aliases(self, argv, alias_argv=None):
267
"""Parse the command line and run with extra aliases in alias_argv."""
268
args, opts = parse_args(self, argv, alias_argv)
269
if 'help' in opts: # e.g. bzr add --help
270
from bzrlib.help import help_on_command
271
help_on_command(self.name())
273
# XXX: This should be handled by the parser
274
allowed_names = self.options().keys()
276
if oname not in allowed_names:
277
raise BzrCommandError("option '--%s' is not allowed for"
278
" command %r" % (oname, self.name()))
279
# mix arguments and options into one dictionary
280
cmdargs = _match_argform(self.name(), self.takes_args, args)
282
for k, v in opts.items():
283
cmdopts[k.replace('-', '_')] = v
285
all_cmd_args = cmdargs.copy()
286
all_cmd_args.update(cmdopts)
290
return self.run(**all_cmd_args)
153
"""Override this in sub-classes.
293
"""Actually run the command.
155
295
This is invoked with the options and arguments bound to
156
296
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
if cmdclass.takes_options:
747
for on in cmdclass.takes_options:
752
"""List all commands"""
756
for k, v in globals().items():
757
if k.startswith('cmd_'):
758
accu.append((k[4:].replace('_','-'), v))
760
for cmdname, cmdclass in accu:
764
help = inspect.getdoc(cmdclass)
766
print " " + help.split('\n', 1)[0]
769
######################################################################
773
# list of all available options; the rhs can be either None for an
774
# option that takes no argument, or a constructor function that checks
796
def parse_args(argv):
298
Return 0 or None if the command was successful, or a non-zero
299
shell error code if not. It's OK for this method to allow
300
an exception to raise up.
302
raise NotImplementedError('no implementation of command %r'
306
"""Return help message for this class."""
307
from inspect import getdoc
308
if self.__doc__ is Command.__doc__:
313
return _unsquish_command_name(self.__class__.__name__)
316
def parse_spec(spec):
322
>>> parse_spec("../@")
324
>>> parse_spec("../f/@35")
326
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
327
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
332
parsed = spec.split('/@')
333
assert len(parsed) == 2
338
parsed[1] = int(parsed[1])
340
pass # We can allow stuff like ./@revid:blahblahblah
344
parsed = [spec, None]
347
def parse_args(command, argv, alias_argv=None):
797
348
"""Parse command line.
799
350
Arguments and options are parsed at this level before being passed
800
351
down to specific command handlers. This routine knows, from a
801
352
lookup table, something about the available options, what optargs
802
353
they take, and which commands will accept them.
804
>>> parse_args('--help'.split())
806
>>> parse_args('--version'.split())
807
([], {'version': True})
808
>>> parse_args('status --all'.split())
809
(['status'], {'all': True})
810
>>> parse_args('commit --message=biter'.split())
811
(['commit'], {'message': u'biter'})
355
# TODO: chop up this beast; make it a method of the Command
816
# TODO: Maybe handle '--' to end options?
821
# option names must not be unicode
825
mutter(" got option %r" % a)
827
optname, optarg = a[2:].split('=', 1)
360
cmd_options = command.options()
362
proc_aliasarg = True # Are we processing alias_argv now?
363
for proc_argv in alias_argv, argv:
370
# We've received a standalone -- No more flags
374
# option names must not be unicode
378
mutter(" got option %r", a)
380
optname, optarg = a[2:].split('=', 1)
383
if optname not in cmd_options:
384
raise BzrOptionError('unknown long option %r for'
830
if optname not in OPTIONS:
831
bailout('unknown long option %r' % a)
834
if shortopt not in SHORT_OPTIONS:
835
bailout('unknown short option %r' % a)
836
optname = SHORT_OPTIONS[shortopt]
839
# XXX: Do we ever want to support this, e.g. for -r?
840
bailout('repeated option %r' % a)
389
if shortopt in Option.SHORT_OPTIONS:
390
# Multi-character options must have a space to delimit
392
# ^^^ what does this mean? mbp 20051014
393
optname = Option.SHORT_OPTIONS[shortopt].name
395
# Single character short options, can be chained,
396
# and have their value appended to their name
398
if shortopt not in Option.SHORT_OPTIONS:
399
# We didn't find the multi-character name, and we
400
# didn't find the single char name
401
raise BzrError('unknown short option %r' % a)
402
optname = Option.SHORT_OPTIONS[shortopt].name
405
# There are extra things on this option
406
# see if it is the value, or if it is another
408
optargfn = Option.OPTIONS[optname].type
410
# This option does not take an argument, so the
411
# next entry is another short option, pack it
413
proc_argv.insert(0, '-' + a[2:])
415
# This option takes an argument, so pack it
842
optargfn = OPTIONS[optname]
846
bailout('option %r needs an argument' % a)
419
if optname not in cmd_options:
420
raise BzrOptionError('unknown short option %r for'
422
(shortopt, command.name()))
424
# XXX: Do we ever want to support this, e.g. for -r?
426
raise BzrError('repeated option %r' % a)
427
elif optname in alias_opts:
428
# Replace what's in the alias with what's in the real
430
del alias_opts[optname]
432
proc_argv.insert(0, a)
849
opts[optname] = optargfn(optarg)
435
raise BzrError('repeated option %r' % a)
437
option_obj = cmd_options[optname]
438
optargfn = option_obj.type
442
raise BzrError('option %r needs an argument' % a)
444
optarg = proc_argv.pop(0)
445
opts[optname] = optargfn(optarg)
447
alias_opts[optname] = optargfn(optarg)
450
raise BzrError('option %r takes no argument' % optname)
453
alias_opts[optname] = True
852
bailout('option %r takes no argument' % optname)
456
proc_aliasarg = False # Done with alias argv
857
457
return args, opts
862
460
def _match_argform(cmd, takes_args, args):
505
def apply_profiled(the_callable, *args, **kwargs):
509
pffileno, pfname = tempfile.mkstemp()
511
prof = hotshot.Profile(pfname)
513
ret = prof.runcall(the_callable, *args, **kwargs) or 0
516
stats = hotshot.stats.load(pfname)
518
stats.sort_stats('cum') # 'time'
519
## XXX: Might like to write to stderr or the trace file instead but
520
## print_stats seems hardcoded to stdout
521
stats.print_stats(20)
528
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
529
from bzrlib.lsprof import profile
531
ret, stats = profile(the_callable, *args, **kwargs)
537
cPickle.dump(stats, open(filename, 'w'), 2)
538
print 'Profile data written to %r.' % filename
543
"""Return an expanded alias, or None if no alias exists"""
545
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
547
return alias.split(' ')
907
551
def run_bzr(argv):
908
552
"""Execute a command.
910
554
This is similar to main(), but without all the trappings for
911
555
logging and error handling.
558
The command-line arguments, without the program name from argv[0]
559
These should already be decoded. All library/test code calling
560
run_bzr should be passing valid strings (don't need decoding).
562
Returns a command status or raises an exception.
564
Special master options: these must come before the command because
565
they control how the command is interpreted.
568
Do not load plugin modules at all
574
Only use builtin commands. (Plugins are still allowed to change
578
Run under the Python hotshot profiler.
581
Run under the Python lsprof profiler.
914
argv = [a.decode(bzrlib.user_encoding) for a in argv]
585
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
586
opt_no_aliases = False
587
opt_lsprof_file = None
589
# --no-plugins is handled specially at a very early stage. We need
590
# to load plugins before doing other command parsing so that they
591
# can override commands, but this needs to happen first.
599
elif a == '--lsprof':
601
elif a == '--lsprof-file':
602
opt_lsprof_file = argv[i + 1]
604
elif a == '--no-plugins':
605
opt_no_plugins = True
606
elif a == '--no-aliases':
607
opt_no_aliases = True
608
elif a == '--builtin':
610
elif a in ('--quiet', '-q'):
618
from bzrlib.builtins import cmd_help
619
cmd_help().run_argv_aliases([])
622
if argv[0] == '--version':
623
from bzrlib.builtins import show_version
627
if not opt_no_plugins:
628
from bzrlib.plugin import load_plugins
631
from bzrlib.plugin import disable_plugins
636
if not opt_no_aliases:
637
alias_argv = get_alias(argv[0])
639
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
640
argv[0] = alias_argv.pop(0)
642
cmd = str(argv.pop(0))
644
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
645
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
646
run = cmd_obj.run_argv
649
run = cmd_obj.run_argv_aliases
650
run_argv = [argv, alias_argv]
917
args, opts = parse_args(argv[1:])
924
elif 'version' in opts:
927
cmd = str(args.pop(0))
929
log_error('usage: bzr COMMAND')
930
log_error(' try "bzr help"')
933
canonical_cmd, cmd_class = get_cmd_class(cmd)
936
if 'profile' in opts:
942
# check options are reasonable
943
allowed = cmd_class.takes_options
945
if oname not in allowed:
946
raise BzrCommandError("option %r is not allowed for command %r"
949
# mix arguments and options into one dictionary
950
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
952
for k, v in opts.items():
953
cmdopts[k.replace('-', '_')] = v
957
pffileno, pfname = tempfile.mkstemp()
654
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
656
ret = apply_profiled(run, *run_argv)
661
# reset, in case we may do other commands later within the same process
664
def display_command(func):
665
"""Decorator that suppresses pipe/interrupt errors."""
666
def ignore_pipe(*args, **kwargs):
959
prof = hotshot.Profile(pfname)
960
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
964
stats = hotshot.stats.load(pfname)
966
stats.sort_stats('time')
967
## XXX: Might like to write to stderr or the trace file instead but
968
## print_stats seems hardcoded to stdout
969
stats.print_stats(20)
977
cmdobj = cmd_class(cmdopts, cmdargs) or 0
981
def _report_exception(e, summary, quiet=False):
983
log_error('bzr: ' + summary)
984
bzrlib.trace.log_exception(e)
987
tb = sys.exc_info()[2]
988
exinfo = traceback.extract_tb(tb)
990
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
991
sys.stderr.write(' see ~/.bzr.log for debug information\n')
668
result = func(*args, **kwargs)
672
if not hasattr(e, 'errno'):
674
if e.errno != errno.EPIPE:
677
except KeyboardInterrupt:
998
bzrlib.trace.create_tracefile(argv)
684
from bzrlib.ui.text import TextUIFactory
685
## bzrlib.trace.enable_default_logging()
686
bzrlib.trace.log_startup(argv)
687
bzrlib.ui.ui_factory = TextUIFactory()
689
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
690
ret = run_bzr_catch_errors(argv)
691
mutter("return code %d", ret)
695
def run_bzr_catch_errors(argv):
1003
# do this here to catch EPIPE
700
# do this here inside the exception wrappers to catch EPIPE
1004
701
sys.stdout.flush()
1007
quiet = isinstance(e, (BzrCommandError))
1008
_report_exception(e, 'error: ' + e.args[0], quiet=quiet)
1011
# some explanation or hints
1014
except AssertionError, e:
1015
msg = 'assertion failed'
1017
msg += ': ' + str(e)
1018
_report_exception(e, msg)
1020
except KeyboardInterrupt, e:
1021
_report_exception(e, 'interrupted', quiet=True)
1023
except Exception, e:
1025
if isinstance(e, IOError) and e.errno == errno.EPIPE:
1029
msg = str(e).rstrip('\n')
1030
_report_exception(e, msg, quiet)
1033
bzrlib.trace.close_trace()
703
# used to handle AssertionError and KeyboardInterrupt
704
# specially here, but hopefully they're handled ok by the logger now
706
if (isinstance(e, IOError)
707
and hasattr(e, 'errno')
708
and e.errno == errno.EPIPE):
709
bzrlib.trace.note('broken pipe')
712
bzrlib.trace.log_exception()
713
if os.environ.get('BZR_PDB'):
714
print '**** entering debugger'
716
pdb.post_mortem(sys.exc_traceback)
1036
719
if __name__ == '__main__':
1037
720
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
