37
85
assert cmd.startswith("cmd_")
38
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):
41
118
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
119
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
123
def get_cmd_object(cmd_name, plugins_override=True):
47
124
"""Return the canonical name and command class for a command.
127
If true, plugin commands can override builtins.
49
cmd = str(cmd) # not unicode
129
from bzrlib.externalcommand import ExternalCommand
131
cmd_name = str(cmd_name) # not unicode
51
133
# first look up this command under the specified name
134
cmds = _get_cmd_dict(plugins_override=plugins_override)
53
return cmd, globals()[_squish_command_name(cmd)]
136
return cmds[cmd_name]()
57
140
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
62
cmdclass = ExternalCommand.find_command(cmd)
66
raise BzrCommandError("unknown command %r" % cmd)
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):
70
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.)
72
166
The docstring for an actual command should give a single-line
73
167
summary, then a complete description of the command. A grammar
74
168
description will be inserted.
171
Other accepted names for this command.
77
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
81
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().
84
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
89
206
takes_options = []
207
encoding_type = 'strict'
93
def __init__(self, options, arguments):
94
"""Construct and run the command.
96
Sets self.status to the return value of run()."""
97
assert isinstance(options, dict)
98
assert isinstance(arguments, dict)
99
cmdargs = options.copy()
100
cmdargs.update(arguments)
101
assert self.__doc__ != Command.__doc__, \
102
("No help message set for %r" % self)
103
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
output_encoding = bzrlib.user_encoding
241
mutter('encoding stdout bzrlib.user_encoding %r', output_encoding)
243
mutter('encoding stdout log as sys.stdout encoding %r', output_encoding)
245
# use 'replace' so that we don't abort if trying to write out
246
# in e.g. the default C locale.
247
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
249
@deprecated_method(zero_eight)
250
def run_argv(self, argv):
251
"""Parse command line and run.
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
257
def run_argv_aliases(self, argv, alias_argv=None):
258
"""Parse the command line and run with extra aliases in alias_argv."""
259
args, opts = parse_args(self, argv, alias_argv)
260
if 'help' in opts: # e.g. bzr add --help
261
from bzrlib.help import help_on_command
262
help_on_command(self.name())
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
267
if oname not in allowed_names:
268
raise BzrCommandError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
270
# mix arguments and options into one dictionary
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
273
for k, v in opts.items():
274
cmdopts[k.replace('-', '_')] = v
276
all_cmd_args = cmdargs.copy()
277
all_cmd_args.update(cmdopts)
281
return self.run(**all_cmd_args)
107
"""Override this in sub-classes.
284
"""Actually run the command.
109
286
This is invoked with the options and arguments bound to
110
287
keyword parameters.
112
Return 0 or None if the command was successful, or a shell
289
Return 0 or None if the command was successful, or a non-zero
290
shell error code if not. It's OK for this method to allow
291
an exception to raise up.
118
class ExternalCommand(Command):
119
"""Class to wrap external commands.
121
We cheat a little here, when get_cmd_class() calls us we actually give it back
122
an object we construct that has the appropriate path, help, options etc for the
125
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
126
method, which we override to call the Command.__init__ method. That then calls
127
our run method which is pretty straight forward.
129
The only wrinkle is that we have to map bzr's dictionary of options and arguments
130
back into command line options and arguments for the script.
133
def find_command(cls, cmd):
134
bzrpath = os.environ.get('BZRPATH', '')
136
for dir in bzrpath.split(':'):
137
path = os.path.join(dir, cmd)
138
if os.path.isfile(path):
139
return ExternalCommand(path)
143
find_command = classmethod(find_command)
145
def __init__(self, path):
148
# TODO: If either of these fail, we should detect that and
149
# assume that path is not really a bzr plugin after all.
151
pipe = os.popen('%s --bzr-usage' % path, 'r')
152
self.takes_options = pipe.readline().split()
153
self.takes_args = pipe.readline().split()
156
pipe = os.popen('%s --bzr-help' % path, 'r')
157
self.__doc__ = pipe.read()
160
def __call__(self, options, arguments):
161
Command.__init__(self, options, arguments)
164
def run(self, **kargs):
172
if OPTIONS.has_key(name):
174
opts.append('--%s' % name)
175
if value is not None and value is not True:
176
opts.append(str(value))
178
# it's an arg, or arg list
179
if type(value) is not list:
185
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
189
class cmd_status(Command):
190
"""Display status summary.
192
This reports on versioned and unknown files, reporting them
193
grouped by state. Possible states are:
196
Versioned in the working copy but not in the previous revision.
199
Versioned in the previous revision but removed or deleted
203
Path of this file changed from the previous revision;
204
the text may also have changed. This includes files whose
205
parent directory was renamed.
208
Text has changed since the previous revision.
211
Nothing about this file has changed since the previous revision.
212
Only shown with --all.
215
Not versioned and not matching an ignore pattern.
217
To see ignored files use 'bzr ignored'. For details in the
218
changes to file texts, use 'bzr diff'.
220
If no arguments are specified, the status of the entire working
221
directory is shown. Otherwise, only the status of the specified
222
files or directories is reported. If a directory is given, status
223
is reported for everything inside that directory.
225
takes_args = ['file*']
226
takes_options = ['all', 'show-ids']
227
aliases = ['st', 'stat']
229
def run(self, all=False, show_ids=False, file_list=None):
231
b = Branch(file_list[0], lock_mode='r')
232
file_list = [b.relpath(x) for x in file_list]
233
# special case: only one path was given and it's the root
235
if file_list == ['']:
238
b = Branch('.', lock_mode='r')
240
status.show_status(b, show_unchanged=all, show_ids=show_ids,
241
specific_files=file_list)
244
class cmd_cat_revision(Command):
245
"""Write out metadata for a revision."""
248
takes_args = ['revision_id']
250
def run(self, revision_id):
251
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
254
class cmd_revno(Command):
255
"""Show current revision number.
257
This is equal to the number of revisions on this branch."""
259
print Branch('.').revno()
262
class cmd_add(Command):
263
"""Add specified files or directories.
265
In non-recursive mode, all the named items are added, regardless
266
of whether they were previously ignored. A warning is given if
267
any of the named files are already versioned.
269
In recursive mode (the default), files are treated the same way
270
but the behaviour for directories is different. Directories that
271
are already versioned do not give a warning. All directories,
272
whether already versioned or not, are searched for files or
273
subdirectories that are neither versioned or ignored, and these
274
are added. This search proceeds recursively into versioned
277
Therefore simply saying 'bzr add .' will version all files that
278
are currently unknown.
280
TODO: Perhaps adding a file whose directly is not versioned should
281
recursively add that parent, rather than giving an error?
283
takes_args = ['file+']
284
takes_options = ['verbose']
286
def run(self, file_list, verbose=False):
287
bzrlib.add.smart_add(file_list, verbose)
290
class cmd_relpath(Command):
291
"""Show path of a file relative to root"""
292
takes_args = ['filename']
294
def run(self, filename):
295
print Branch(filename).relpath(filename)
299
class cmd_inventory(Command):
300
"""Show inventory of the current working copy or a revision."""
301
takes_options = ['revision']
303
def run(self, revision=None):
306
inv = b.read_working_inventory()
308
inv = b.get_revision_inventory(b.lookup_revision(revision))
310
for path, entry in inv.iter_entries():
311
print '%-50s %s' % (entry.file_id, path)
314
class cmd_move(Command):
315
"""Move files to a different directory.
320
The destination must be a versioned directory in the same branch.
322
takes_args = ['source$', 'dest']
323
def run(self, source_list, dest):
326
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
329
class cmd_rename(Command):
330
"""Change the name of an entry.
333
bzr rename frob.c frobber.c
334
bzr rename src/frob.c lib/frob.c
336
It is an error if the destination name exists.
338
See also the 'move' command, which moves files into a different
339
directory without changing their name.
341
TODO: Some way to rename multiple files without invoking bzr for each
343
takes_args = ['from_name', 'to_name']
345
def run(self, from_name, to_name):
347
b.rename_one(b.relpath(from_name), b.relpath(to_name))
351
class cmd_renames(Command):
352
"""Show list of renamed files.
354
TODO: Option to show renames between two historical versions.
356
TODO: Only show renames under dir, rather than in the whole branch.
358
takes_args = ['dir?']
360
def run(self, dir='.'):
362
old_inv = b.basis_tree().inventory
363
new_inv = b.read_working_inventory()
365
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
367
for old_name, new_name in renames:
368
print "%s => %s" % (old_name, new_name)
371
class cmd_info(Command):
372
"""Show statistical information about a branch."""
373
takes_args = ['branch?']
375
def run(self, branch=None):
378
from branch import find_branch
379
b = find_branch(branch)
383
class cmd_remove(Command):
384
"""Make a file unversioned.
386
This makes bzr stop tracking changes to a versioned file. It does
387
not delete the working copy.
389
takes_args = ['file+']
390
takes_options = ['verbose']
392
def run(self, file_list, verbose=False):
393
b = Branch(file_list[0])
394
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
397
class cmd_file_id(Command):
398
"""Print file_id of a particular file or directory.
400
The file_id is assigned when the file is first added and remains the
401
same through all revisions where the file exists, even when it is
405
takes_args = ['filename']
406
def run(self, filename):
408
i = b.inventory.path2id(b.relpath(filename))
410
bailout("%r is not a versioned file" % filename)
415
class cmd_file_path(Command):
416
"""Print path of file_ids to a file or directory.
418
This prints one line for each directory down to the target,
419
starting at the branch root."""
421
takes_args = ['filename']
422
def run(self, filename):
425
fid = inv.path2id(b.relpath(filename))
427
bailout("%r is not a versioned file" % filename)
428
for fip in inv.get_idpath(fid):
432
class cmd_revision_history(Command):
433
"""Display list of revision ids on this branch."""
435
for patchid in Branch('.').revision_history():
439
class cmd_directories(Command):
440
"""Display list of versioned directories in this branch."""
442
for name, ie in Branch('.').read_working_inventory().directories():
449
class cmd_init(Command):
450
"""Make a directory into a versioned branch.
452
Use this to create an empty branch, or before importing an
455
Recipe for importing a tree of files:
460
bzr commit -m 'imported project'
463
Branch('.', init=True)
466
class cmd_diff(Command):
467
"""Show differences in working tree.
469
If files are listed, only the changes in those files are listed.
470
Otherwise, all changes for the tree are listed.
472
TODO: Given two revision arguments, show the difference between them.
474
TODO: Allow diff across branches.
476
TODO: Option to use external diff command; could be GNU diff, wdiff,
479
TODO: Python difflib is not exactly the same as unidiff; should
480
either fix it up or prefer to use an external diff.
482
TODO: If a directory is given, diff everything under that.
484
TODO: Selected-file diff is inefficient and doesn't show you
487
TODO: This probably handles non-Unix newlines poorly.
490
takes_args = ['file*']
491
takes_options = ['revision']
494
def run(self, revision=None, file_list=None):
495
from bzrlib.diff import show_diff
497
show_diff(Branch('.'), revision, specific_files=file_list)
503
class cmd_deleted(Command):
504
"""List files deleted in the working tree.
506
TODO: Show files deleted since a previous revision, or between two revisions.
508
def run(self, show_ids=False):
511
new = b.working_tree()
513
## TODO: Much more efficient way to do this: read in new
514
## directories with readdir, rather than stating each one. Same
515
## level of effort but possibly much less IO. (Or possibly not,
516
## if the directories are very large...)
518
for path, ie in old.inventory.iter_entries():
519
if not new.has_id(ie.file_id):
521
print '%-50s %s' % (path, ie.file_id)
526
class cmd_modified(Command):
527
"""List files modified in working tree."""
532
inv = b.read_working_inventory()
533
sc = statcache.update_cache(b, inv)
534
basis = b.basis_tree()
535
basis_inv = basis.inventory
537
# We used to do this through iter_entries(), but that's slow
538
# when most of the files are unmodified, as is usually the
539
# case. So instead we iterate by inventory entry, and only
540
# calculate paths as necessary.
542
for file_id in basis_inv:
543
cacheentry = sc.get(file_id)
544
if not cacheentry: # deleted
546
ie = basis_inv[file_id]
547
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
548
path = inv.id2path(file_id)
553
class cmd_added(Command):
554
"""List files added in working tree."""
558
wt = b.working_tree()
559
basis_inv = b.basis_tree().inventory
562
if file_id in basis_inv:
564
path = inv.id2path(file_id)
565
if not os.access(b.abspath(path), os.F_OK):
571
class cmd_root(Command):
572
"""Show the tree root directory.
574
The root is the nearest enclosing directory with a .bzr control
576
takes_args = ['filename?']
577
def run(self, filename=None):
578
"""Print the branch root."""
579
from branch import find_branch
580
b = find_branch(filename)
581
print getattr(b, 'base', None) or getattr(b, 'baseurl')
584
class cmd_log(Command):
585
"""Show log of this branch.
587
TODO: Option to limit range.
589
TODO: Perhaps show most-recent first with an option for last.
591
takes_args = ['filename?']
592
takes_options = ['timezone', 'verbose', 'show-ids']
593
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
594
from branch import find_branch
595
b = find_branch((filename or '.'), lock_mode='r')
597
filename = b.relpath(filename)
598
bzrlib.show_log(b, filename,
599
show_timezone=timezone,
605
class cmd_touching_revisions(Command):
606
"""Return revision-ids which affected a particular file."""
608
takes_args = ["filename"]
609
def run(self, filename):
610
b = Branch(filename, lock_mode='r')
611
inv = b.read_working_inventory()
612
file_id = inv.path2id(b.relpath(filename))
613
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
614
print "%6d %s" % (revno, what)
617
class cmd_ls(Command):
618
"""List files in a tree.
620
TODO: Take a revision or remote path and list that tree instead.
623
def run(self, revision=None, verbose=False):
626
tree = b.working_tree()
628
tree = b.revision_tree(b.lookup_revision(revision))
630
for fp, fc, kind, fid in tree.list_files():
632
if kind == 'directory':
639
print '%-8s %s%s' % (fc, fp, kindch)
645
class cmd_unknowns(Command):
646
"""List unknown files"""
648
for f in Branch('.').unknowns():
653
class cmd_ignore(Command):
654
"""Ignore a command or pattern
656
To remove patterns from the ignore list, edit the .bzrignore file.
658
If the pattern contains a slash, it is compared to the whole path
659
from the branch root. Otherwise, it is comapred to only the last
660
component of the path.
662
Ignore patterns are case-insensitive on case-insensitive systems.
664
Note: wildcards must be quoted from the shell on Unix.
667
bzr ignore ./Makefile
670
takes_args = ['name_pattern']
672
def run(self, name_pattern):
673
from bzrlib.atomicfile import AtomicFile
677
ifn = b.abspath('.bzrignore')
679
# FIXME: probably doesn't handle non-ascii patterns
681
if os.path.exists(ifn):
682
f = b.controlfile(ifn, 'rt')
688
if igns and igns[-1] != '\n':
690
igns += name_pattern + '\n'
692
f = AtomicFile(ifn, 'wt')
696
inv = b.working_tree().inventory
697
if inv.path2id('.bzrignore'):
698
mutter('.bzrignore is already versioned')
700
mutter('need to make new .bzrignore file versioned')
701
b.add(['.bzrignore'])
705
class cmd_ignored(Command):
706
"""List ignored files and the patterns that matched them.
708
See also: bzr ignore"""
710
tree = Branch('.').working_tree()
711
for path, file_class, kind, file_id in tree.list_files():
712
if file_class != 'I':
714
## XXX: Slightly inefficient since this was already calculated
715
pat = tree.is_ignored(path)
716
print '%-50s %s' % (path, pat)
719
class cmd_lookup_revision(Command):
720
"""Lookup the revision-id from a revision-number
723
bzr lookup-revision 33
726
takes_args = ['revno']
728
def run(self, revno):
732
raise BzrCommandError("not a valid revision-number: %r" % revno)
734
print Branch('.').lookup_revision(revno)
737
class cmd_export(Command):
738
"""Export past revision to destination directory.
740
If no revision is specified this exports the last committed revision."""
741
takes_args = ['dest']
742
takes_options = ['revision']
743
def run(self, dest, revision=None):
746
rh = b.revision_history()[-1]
748
rh = b.lookup_revision(int(revision))
749
t = b.revision_tree(rh)
753
class cmd_cat(Command):
754
"""Write a file's text from a previous revision."""
756
takes_options = ['revision']
757
takes_args = ['filename']
759
def run(self, filename, revision=None):
761
raise BzrCommandError("bzr cat requires a revision number")
763
b.print_file(b.relpath(filename), int(revision))
766
class cmd_local_time_offset(Command):
767
"""Show the offset in seconds from GMT to local time."""
770
print bzrlib.osutils.local_time_offset()
774
class cmd_commit(Command):
775
"""Commit changes into a new revision.
777
TODO: Commit only selected files.
779
TODO: Run hooks on tree to-be-committed, and after commit.
781
TODO: Strict commit that fails if there are unknown or deleted files.
783
takes_options = ['message', 'file', 'verbose']
784
aliases = ['ci', 'checkin']
786
def run(self, message=None, file=None, verbose=False):
787
from bzrlib.commit import commit
789
## Warning: shadows builtin file()
790
if not message and not file:
791
raise BzrCommandError("please specify a commit message",
792
["use either --message or --file"])
793
elif message and file:
794
raise BzrCommandError("please specify either --message or --file")
798
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
801
commit(b, message, verbose=verbose)
804
class cmd_check(Command):
805
"""Validate consistency of branch history.
807
This command checks various invariants about the branch storage to
808
detect data corruption or bzr bugs.
810
takes_args = ['dir?']
811
def run(self, dir='.'):
813
bzrlib.check.check(Branch(dir, find_root=False))
817
class cmd_whoami(Command):
818
"""Show bzr user id."""
819
takes_options = ['email']
821
def run(self, email=False):
823
print bzrlib.osutils.user_email()
825
print bzrlib.osutils.username()
828
class cmd_selftest(Command):
829
"""Run internal test suite"""
832
failures, tests = 0, 0
834
import doctest, bzrlib.store, bzrlib.tests
835
bzrlib.trace.verbose = False
837
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
838
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
839
mf, mt = doctest.testmod(m)
842
print '%-40s %3d tests' % (m.__name__, mt),
844
print '%3d FAILED!' % mf
848
print '%-40s %3d tests' % ('total', tests),
850
print '%3d FAILED!' % failures
856
class cmd_version(Command):
857
"""Show version of bzr"""
862
print "bzr (bazaar-ng) %s" % bzrlib.__version__
863
print bzrlib.__copyright__
864
print "http://bazaar-ng.org/"
866
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
867
print "you may use, modify and redistribute it under the terms of the GNU"
868
print "General Public License version 2 or later."
871
class cmd_rocks(Command):
872
"""Statement of optimism."""
875
print "it sure does!"
878
class cmd_assert_fail(Command):
879
"""Test reporting of assertion failures"""
882
assert False, "always fails"
885
class cmd_help(Command):
886
"""Show help on a command or other topic.
888
For a list of all available commands, say 'bzr help commands'."""
889
takes_args = ['topic?']
892
def run(self, topic=None):
897
class cmd_update_stat_cache(Command):
898
"""Update stat-cache mapping inodes to SHA-1 hashes.
905
statcache.update_cache(b.base, b.read_working_inventory())
908
######################################################################
912
# list of all available options; the rhs can be either None for an
913
# option that takes no argument, or a constructor function that checks
937
def parse_args(argv):
293
raise NotImplementedError('no implementation of command %r'
297
"""Return help message for this class."""
298
from inspect import getdoc
299
if self.__doc__ is Command.__doc__:
304
return _unsquish_command_name(self.__class__.__name__)
307
def parse_spec(spec):
313
>>> parse_spec("../@")
315
>>> parse_spec("../f/@35")
317
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
318
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
323
parsed = spec.split('/@')
324
assert len(parsed) == 2
329
parsed[1] = int(parsed[1])
331
pass # We can allow stuff like ./@revid:blahblahblah
335
parsed = [spec, None]
338
def parse_args(command, argv, alias_argv=None):
938
339
"""Parse command line.
940
341
Arguments and options are parsed at this level before being passed
941
342
down to specific command handlers. This routine knows, from a
942
343
lookup table, something about the available options, what optargs
943
344
they take, and which commands will accept them.
945
>>> parse_args('--help'.split())
947
>>> parse_args('--version'.split())
948
([], {'version': True})
949
>>> parse_args('status --all'.split())
950
(['status'], {'all': True})
951
>>> parse_args('commit --message=biter'.split())
952
(['commit'], {'message': u'biter'})
346
# TODO: chop up this beast; make it a method of the Command
957
# TODO: Maybe handle '--' to end options?
962
# option names must not be unicode
966
mutter(" got option %r" % a)
968
optname, optarg = a[2:].split('=', 1)
351
cmd_options = command.options()
353
proc_aliasarg = True # Are we processing alias_argv now?
354
for proc_argv in alias_argv, argv:
361
# We've received a standalone -- No more flags
365
# option names must not be unicode
369
mutter(" got option %r", a)
371
optname, optarg = a[2:].split('=', 1)
374
if optname not in cmd_options:
375
raise BzrOptionError('unknown long option %r for'
971
if optname not in OPTIONS:
972
bailout('unknown long option %r' % a)
975
if shortopt not in SHORT_OPTIONS:
976
bailout('unknown short option %r' % a)
977
optname = SHORT_OPTIONS[shortopt]
980
# XXX: Do we ever want to support this, e.g. for -r?
981
bailout('repeated option %r' % a)
380
if shortopt in Option.SHORT_OPTIONS:
381
# Multi-character options must have a space to delimit
383
# ^^^ what does this mean? mbp 20051014
384
optname = Option.SHORT_OPTIONS[shortopt].name
386
# Single character short options, can be chained,
387
# and have their value appended to their name
389
if shortopt not in Option.SHORT_OPTIONS:
390
# We didn't find the multi-character name, and we
391
# didn't find the single char name
392
raise BzrError('unknown short option %r' % a)
393
optname = Option.SHORT_OPTIONS[shortopt].name
396
# There are extra things on this option
397
# see if it is the value, or if it is another
399
optargfn = Option.OPTIONS[optname].type
401
# This option does not take an argument, so the
402
# next entry is another short option, pack it
404
proc_argv.insert(0, '-' + a[2:])
406
# This option takes an argument, so pack it
983
optargfn = OPTIONS[optname]
987
bailout('option %r needs an argument' % a)
410
if optname not in cmd_options:
411
raise BzrOptionError('unknown short option %r for'
413
(shortopt, command.name()))
415
# XXX: Do we ever want to support this, e.g. for -r?
417
raise BzrError('repeated option %r' % a)
418
elif optname in alias_opts:
419
# Replace what's in the alias with what's in the real
421
del alias_opts[optname]
423
proc_argv.insert(0, a)
990
opts[optname] = optargfn(optarg)
426
raise BzrError('repeated option %r' % a)
428
option_obj = cmd_options[optname]
429
optargfn = option_obj.type
433
raise BzrError('option %r needs an argument' % a)
435
optarg = proc_argv.pop(0)
436
opts[optname] = optargfn(optarg)
438
alias_opts[optname] = optargfn(optarg)
441
raise BzrError('option %r takes no argument' % optname)
444
alias_opts[optname] = True
993
bailout('option %r takes no argument' % optname)
447
proc_aliasarg = False # Done with alias argv
998
448
return args, opts
1003
451
def _match_argform(cmd, takes_args, args):
496
def apply_profiled(the_callable, *args, **kwargs):
500
pffileno, pfname = tempfile.mkstemp()
502
prof = hotshot.Profile(pfname)
504
ret = prof.runcall(the_callable, *args, **kwargs) or 0
507
stats = hotshot.stats.load(pfname)
509
stats.sort_stats('cum') # 'time'
510
## XXX: Might like to write to stderr or the trace file instead but
511
## print_stats seems hardcoded to stdout
512
stats.print_stats(20)
519
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
520
from bzrlib.lsprof import profile
522
ret, stats = profile(the_callable, *args, **kwargs)
528
cPickle.dump(stats, open(filename, 'w'), 2)
529
print 'Profile data written to %r.' % filename
534
"""Return an expanded alias, or None if no alias exists"""
536
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
538
return alias.split(' ')
1048
542
def run_bzr(argv):
1049
543
"""Execute a command.
1051
545
This is similar to main(), but without all the trappings for
1052
546
logging and error handling.
549
The command-line arguments, without the program name from argv[0]
550
These should already be decoded. All library/test code calling
551
run_bzr should be passing valid strings (don't need decoding).
553
Returns a command status or raises an exception.
555
Special master options: these must come before the command because
556
they control how the command is interpreted.
559
Do not load plugin modules at all
565
Only use builtin commands. (Plugins are still allowed to change
569
Run under the Python hotshot profiler.
572
Run under the Python lsprof profiler.
1054
argv = [a.decode(bzrlib.user_encoding) for a in argv]
576
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
577
opt_no_aliases = False
578
opt_lsprof_file = None
580
# --no-plugins is handled specially at a very early stage. We need
581
# to load plugins before doing other command parsing so that they
582
# can override commands, but this needs to happen first.
590
elif a == '--lsprof':
592
elif a == '--lsprof-file':
593
opt_lsprof_file = argv[i + 1]
595
elif a == '--no-plugins':
596
opt_no_plugins = True
597
elif a == '--no-aliases':
598
opt_no_aliases = True
599
elif a == '--builtin':
601
elif a in ('--quiet', '-q'):
609
from bzrlib.builtins import cmd_help
610
cmd_help().run_argv_aliases([])
613
if argv[0] == '--version':
614
from bzrlib.builtins import show_version
618
if not opt_no_plugins:
619
from bzrlib.plugin import load_plugins
622
from bzrlib.plugin import disable_plugins
627
if not opt_no_aliases:
628
alias_argv = get_alias(argv[0])
630
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
631
argv[0] = alias_argv.pop(0)
633
cmd = str(argv.pop(0))
635
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
636
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
637
run = cmd_obj.run_argv
640
run = cmd_obj.run_argv_aliases
641
run_argv = [argv, alias_argv]
1057
args, opts = parse_args(argv[1:])
1065
elif 'version' in opts:
1068
cmd = str(args.pop(0))
1075
canonical_cmd, cmd_class = get_cmd_class(cmd)
1078
if 'profile' in opts:
1084
# check options are reasonable
1085
allowed = cmd_class.takes_options
1087
if oname not in allowed:
1088
raise BzrCommandError("option '--%s' is not allowed for command %r"
1091
# mix arguments and options into one dictionary
1092
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1094
for k, v in opts.items():
1095
cmdopts[k.replace('-', '_')] = v
1098
import hotshot, tempfile
1099
pffileno, pfname = tempfile.mkstemp()
645
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
647
ret = apply_profiled(run, *run_argv)
652
# reset, in case we may do other commands later within the same process
655
def display_command(func):
656
"""Decorator that suppresses pipe/interrupt errors."""
657
def ignore_pipe(*args, **kwargs):
1101
prof = hotshot.Profile(pfname)
1102
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1105
import hotshot.stats
1106
stats = hotshot.stats.load(pfname)
1108
stats.sort_stats('time')
1109
## XXX: Might like to write to stderr or the trace file instead but
1110
## print_stats seems hardcoded to stdout
1111
stats.print_stats(20)
1119
cmdobj = cmd_class(cmdopts, cmdargs).status
1122
def _report_exception(summary, quiet=False):
1124
log_error('bzr: ' + summary)
1125
bzrlib.trace.log_exception()
1128
tb = sys.exc_info()[2]
1129
exinfo = traceback.extract_tb(tb)
1131
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1132
sys.stderr.write(' see ~/.bzr.log for debug information\n')
659
result = func(*args, **kwargs)
663
if not hasattr(e, 'errno'):
665
if e.errno != errno.EPIPE:
668
except KeyboardInterrupt:
1139
bzrlib.open_tracefile(argv)
675
from bzrlib.ui.text import TextUIFactory
676
## bzrlib.trace.enable_default_logging()
677
bzrlib.trace.log_startup(argv)
678
bzrlib.ui.ui_factory = TextUIFactory()
680
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
681
ret = run_bzr_catch_errors(argv)
682
mutter("return code %d", ret)
686
def run_bzr_catch_errors(argv):
1144
return run_bzr(argv)
1146
# do this here inside the exception wrappers to catch EPIPE
1149
quiet = isinstance(e, (BzrCommandError))
1150
_report_exception('error: ' + e.args[0], quiet=quiet)
1153
# some explanation or hints
1156
except AssertionError, e:
1157
msg = 'assertion failed'
1159
msg += ': ' + str(e)
1160
_report_exception(msg)
1162
except KeyboardInterrupt, e:
1163
_report_exception('interrupted', quiet=True)
1165
except Exception, e:
1167
if (isinstance(e, IOError)
1168
and hasattr(e, 'errno')
1169
and e.errno == errno.EPIPE):
1173
msg = str(e).rstrip('\n')
1174
_report_exception(msg, quiet)
1177
bzrlib.trace.close_trace()
691
# do this here inside the exception wrappers to catch EPIPE
694
# used to handle AssertionError and KeyboardInterrupt
695
# specially here, but hopefully they're handled ok by the logger now
697
if (isinstance(e, IOError)
698
and hasattr(e, 'errno')
699
and e.errno == errno.EPIPE):
700
bzrlib.trace.note('broken pipe')
703
bzrlib.trace.log_exception()
704
if os.environ.get('BZR_PDB'):
705
print '**** entering debugger'
707
pdb.post_mortem(sys.exc_traceback)
1180
710
if __name__ == '__main__':
1181
711
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
