86
38
assert cmd.startswith("cmd_")
87
39
return cmd[4:].replace('_','-')
90
def _builtin_commands():
91
import bzrlib.builtins
93
builtins = bzrlib.builtins.__dict__
95
if name.startswith("cmd_"):
96
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
101
def builtin_command_names():
102
"""Return list of builtin command names."""
103
return _builtin_commands().keys()
106
def plugin_command_names():
107
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
112
d = _builtin_commands()
114
d.update(plugin_cmds)
118
def get_all_cmds(plugins_override=True):
119
42
"""Return canonical name and class for all registered commands."""
120
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
124
def get_cmd_object(cmd_name, plugins_override=True):
43
for k, v in globals().iteritems():
44
if k.startswith("cmd_"):
45
yield _unsquish_command_name(k), v
47
def get_cmd_class(cmd):
125
48
"""Return the canonical name and command class for a command.
128
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
132
# We want only 'ascii' command names, but the user may have typed
133
# in a Unicode name. In that case, they should just get a
134
# 'command not found' error later.
135
# In the future, we may actually support Unicode command names.
50
cmd = str(cmd) # not unicode
137
52
# first look up this command under the specified name
138
cmds = _get_cmd_dict(plugins_override=plugins_override)
140
return cmds[cmd_name]()
54
return cmd, globals()[_squish_command_name(cmd)]
144
58
# look for any command which claims this as an alias
145
for real_cmd_name, cmd_class in cmds.iteritems():
146
if cmd_name in cmd_class.aliases:
149
cmd_obj = ExternalCommand.find_command(cmd_name)
153
raise BzrCommandError('unknown command "%s"' % cmd_name)
156
class Command(object):
59
for cmdname, cmdclass in get_all_cmds():
60
if cmd in cmdclass.aliases:
61
return cmdname, cmdclass
63
cmdclass = ExternalCommand.find_command(cmd)
67
raise BzrCommandError("unknown command %r" % cmd)
157
71
"""Base class for commands.
159
Commands are the heart of the command-line bzr interface.
161
The command object mostly handles the mapping of command-line
162
parameters into one or more bzrlib operations, and of the results
165
Commands normally don't have any state. All their arguments are
166
passed in to the run method. (Subclasses may take a different
167
policy if the behaviour of the instance needs to depend on e.g. a
168
shell plugin and not just its Python class.)
170
73
The docstring for an actual command should give a single-line
171
74
summary, then a complete description of the command. A grammar
172
75
description will be inserted.
175
Other accepted names for this command.
178
78
List of argument forms, marked with whether they are optional,
183
['to_location', 'from_branch?', 'file*']
185
'to_location' is required
186
'from_branch' is optional
187
'file' can be specified 0 or more times
190
List of options that may be given for this command. These can
191
be either strings, referring to globally-defined options,
192
or option objects. Retrieve through options().
82
List of options that may be given for this command.
195
If true, this command isn't advertised. This is typically
196
for commands intended for expert users.
199
Command objects will get a 'outf' attribute, which has been
200
setup to properly handle encoding of unicode strings.
201
encoding_type determines what will happen when characters cannot
203
strict - abort if we cannot decode
204
replace - put in a bogus character (typically '?')
205
exact - do not encode sys.stdout
85
If true, this command isn't advertised.
210
90
takes_options = []
211
encoding_type = 'strict'
216
"""Construct an instance of this command."""
217
if self.__doc__ == Command.__doc__:
218
warn("No help message set for %r" % self)
221
"""Return dict of valid options for this command.
223
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
226
for o in self.takes_options:
227
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
232
def _setup_outf(self):
233
"""Return a file linked to stdout, which has proper encoding."""
234
assert self.encoding_type in ['strict', 'exact', 'replace']
236
# Originally I was using self.stdout, but that looks
237
# *way* too much like sys.stdout
238
if self.encoding_type == 'exact':
239
self.outf = sys.stdout
242
output_encoding = bzrlib.osutils.get_terminal_encoding()
244
# use 'replace' so that we don't abort if trying to write out
245
# in e.g. the default C locale.
246
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
247
# For whatever reason codecs.getwriter() does not advertise its encoding
248
# it just returns the encoding of the wrapped file, which is completely
249
# bogus. So set the attribute, so we can find the correct encoding later.
250
self.outf.encoding = output_encoding
252
@deprecated_method(zero_eight)
253
def run_argv(self, argv):
254
"""Parse command line and run.
256
See run_argv_aliases for the 0.8 and beyond api.
258
return self.run_argv_aliases(argv)
260
def run_argv_aliases(self, argv, alias_argv=None):
261
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
DeprecationWarning, stacklevel=2)
266
args, opts = parse_args(self, argv, alias_argv)
267
if 'help' in opts: # e.g. bzr add --help
268
from bzrlib.help import help_on_command
269
help_on_command(self.name())
271
# mix arguments and options into one dictionary
272
cmdargs = _match_argform(self.name(), self.takes_args, args)
274
for k, v in opts.items():
275
cmdopts[k.replace('-', '_')] = v
277
all_cmd_args = cmdargs.copy()
278
all_cmd_args.update(cmdopts)
282
return self.run(**all_cmd_args)
94
def __init__(self, options, arguments):
95
"""Construct and run the command.
97
Sets self.status to the return value of run()."""
98
assert isinstance(options, dict)
99
assert isinstance(arguments, dict)
100
cmdargs = options.copy()
101
cmdargs.update(arguments)
102
assert self.__doc__ != Command.__doc__, \
103
("No help message set for %r" % self)
104
self.status = self.run(**cmdargs)
285
"""Actually run the command.
108
"""Override this in sub-classes.
287
110
This is invoked with the options and arguments bound to
288
111
keyword parameters.
290
Return 0 or None if the command was successful, or a non-zero
291
shell error code if not. It's OK for this method to allow
292
an exception to raise up.
294
raise NotImplementedError('no implementation of command %r'
298
"""Return help message for this class."""
299
from inspect import getdoc
300
if self.__doc__ is Command.__doc__:
305
return _unsquish_command_name(self.__class__.__name__)
307
def plugin_name(self):
308
"""Get the name of the plugin that provides this command.
310
:return: The name of the plugin or None if the command is builtin.
312
mod_parts = self.__module__.split('.')
313
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
113
Return 0 or None if the command was successful, or a shell
119
class ExternalCommand(Command):
120
"""Class to wrap external commands.
122
We cheat a little here, when get_cmd_class() calls us we actually give it back
123
an object we construct that has the appropriate path, help, options etc for the
126
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
127
method, which we override to call the Command.__init__ method. That then calls
128
our run method which is pretty straight forward.
130
The only wrinkle is that we have to map bzr's dictionary of options and arguments
131
back into command line options and arguments for the script.
134
def find_command(cls, cmd):
135
bzrpath = os.environ.get('BZRPATH', '')
137
for dir in bzrpath.split(':'):
138
path = os.path.join(dir, cmd)
139
if os.path.isfile(path):
140
return ExternalCommand(path)
144
find_command = classmethod(find_command)
146
def __init__(self, path):
149
# TODO: If either of these fail, we should detect that and
150
# assume that path is not really a bzr plugin after all.
152
pipe = os.popen('%s --bzr-usage' % path, 'r')
153
self.takes_options = pipe.readline().split()
154
self.takes_args = pipe.readline().split()
157
pipe = os.popen('%s --bzr-help' % path, 'r')
158
self.__doc__ = pipe.read()
161
def __call__(self, options, arguments):
162
Command.__init__(self, options, arguments)
165
def run(self, **kargs):
173
if OPTIONS.has_key(name):
175
opts.append('--%s' % name)
176
if value is not None and value is not True:
177
opts.append(str(value))
179
# it's an arg, or arg list
180
if type(value) is not list:
186
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
190
class cmd_status(Command):
191
"""Display status summary.
193
This reports on versioned and unknown files, reporting them
194
grouped by state. Possible states are:
197
Versioned in the working copy but not in the previous revision.
200
Versioned in the previous revision but removed or deleted
204
Path of this file changed from the previous revision;
205
the text may also have changed. This includes files whose
206
parent directory was renamed.
209
Text has changed since the previous revision.
212
Nothing about this file has changed since the previous revision.
213
Only shown with --all.
216
Not versioned and not matching an ignore pattern.
218
To see ignored files use 'bzr ignored'. For details in the
219
changes to file texts, use 'bzr diff'.
221
If no arguments are specified, the status of the entire working
222
directory is shown. Otherwise, only the status of the specified
223
files or directories is reported. If a directory is given, status
224
is reported for everything inside that directory.
226
takes_args = ['file*']
227
takes_options = ['all', 'show-ids']
228
aliases = ['st', 'stat']
230
def run(self, all=False, show_ids=False, file_list=None):
232
b = Branch(file_list[0], lock_mode='r')
233
file_list = [b.relpath(x) for x in file_list]
234
# special case: only one path was given and it's the root
236
if file_list == ['']:
239
b = Branch('.', lock_mode='r')
241
status.show_status(b, show_unchanged=all, show_ids=show_ids,
242
specific_files=file_list)
245
class cmd_cat_revision(Command):
246
"""Write out metadata for a revision."""
249
takes_args = ['revision_id']
251
def run(self, revision_id):
252
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
255
class cmd_revno(Command):
256
"""Show current revision number.
258
This is equal to the number of revisions on this branch."""
260
print Branch('.').revno()
263
class cmd_add(Command):
264
"""Add specified files or directories.
266
In non-recursive mode, all the named items are added, regardless
267
of whether they were previously ignored. A warning is given if
268
any of the named files are already versioned.
270
In recursive mode (the default), files are treated the same way
271
but the behaviour for directories is different. Directories that
272
are already versioned do not give a warning. All directories,
273
whether already versioned or not, are searched for files or
274
subdirectories that are neither versioned or ignored, and these
275
are added. This search proceeds recursively into versioned
278
Therefore simply saying 'bzr add .' will version all files that
279
are currently unknown.
281
TODO: Perhaps adding a file whose directly is not versioned should
282
recursively add that parent, rather than giving an error?
284
takes_args = ['file+']
285
takes_options = ['verbose']
287
def run(self, file_list, verbose=False):
288
bzrlib.add.smart_add(file_list, verbose)
291
class cmd_relpath(Command):
292
"""Show path of a file relative to root"""
293
takes_args = ['filename']
295
def run(self, filename):
296
print Branch(filename).relpath(filename)
300
class cmd_inventory(Command):
301
"""Show inventory of the current working copy or a revision."""
302
takes_options = ['revision']
304
def run(self, revision=None):
307
inv = b.read_working_inventory()
309
inv = b.get_revision_inventory(b.lookup_revision(revision))
311
for path, entry in inv.iter_entries():
312
print '%-50s %s' % (entry.file_id, path)
315
class cmd_move(Command):
316
"""Move files to a different directory.
321
The destination must be a versioned directory in the same branch.
323
takes_args = ['source$', 'dest']
324
def run(self, source_list, dest):
327
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
330
class cmd_rename(Command):
331
"""Change the name of an entry.
334
bzr rename frob.c frobber.c
335
bzr rename src/frob.c lib/frob.c
337
It is an error if the destination name exists.
339
See also the 'move' command, which moves files into a different
340
directory without changing their name.
342
TODO: Some way to rename multiple files without invoking bzr for each
344
takes_args = ['from_name', 'to_name']
346
def run(self, from_name, to_name):
348
b.rename_one(b.relpath(from_name), b.relpath(to_name))
352
class cmd_renames(Command):
353
"""Show list of renamed files.
355
TODO: Option to show renames between two historical versions.
357
TODO: Only show renames under dir, rather than in the whole branch.
359
takes_args = ['dir?']
361
def run(self, dir='.'):
363
old_inv = b.basis_tree().inventory
364
new_inv = b.read_working_inventory()
366
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
368
for old_name, new_name in renames:
369
print "%s => %s" % (old_name, new_name)
372
class cmd_info(Command):
373
"""Show statistical information about a branch."""
374
takes_args = ['branch?']
376
def run(self, branch=None):
379
from branch import find_branch
380
b = find_branch(branch)
384
class cmd_remove(Command):
385
"""Make a file unversioned.
387
This makes bzr stop tracking changes to a versioned file. It does
388
not delete the working copy.
390
takes_args = ['file+']
391
takes_options = ['verbose']
393
def run(self, file_list, verbose=False):
394
b = Branch(file_list[0])
395
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
398
class cmd_file_id(Command):
399
"""Print file_id of a particular file or directory.
401
The file_id is assigned when the file is first added and remains the
402
same through all revisions where the file exists, even when it is
406
takes_args = ['filename']
407
def run(self, filename):
409
i = b.inventory.path2id(b.relpath(filename))
411
bailout("%r is not a versioned file" % filename)
416
class cmd_file_path(Command):
417
"""Print path of file_ids to a file or directory.
419
This prints one line for each directory down to the target,
420
starting at the branch root."""
422
takes_args = ['filename']
423
def run(self, filename):
426
fid = inv.path2id(b.relpath(filename))
428
bailout("%r is not a versioned file" % filename)
429
for fip in inv.get_idpath(fid):
433
class cmd_revision_history(Command):
434
"""Display list of revision ids on this branch."""
436
for patchid in Branch('.').revision_history():
440
class cmd_directories(Command):
441
"""Display list of versioned directories in this branch."""
443
for name, ie in Branch('.').read_working_inventory().directories():
450
class cmd_init(Command):
451
"""Make a directory into a versioned branch.
453
Use this to create an empty branch, or before importing an
456
Recipe for importing a tree of files:
461
bzr commit -m 'imported project'
464
Branch('.', init=True)
467
class cmd_diff(Command):
468
"""Show differences in working tree.
470
If files are listed, only the changes in those files are listed.
471
Otherwise, all changes for the tree are listed.
473
TODO: Given two revision arguments, show the difference between them.
475
TODO: Allow diff across branches.
477
TODO: Option to use external diff command; could be GNU diff, wdiff,
480
TODO: Python difflib is not exactly the same as unidiff; should
481
either fix it up or prefer to use an external diff.
483
TODO: If a directory is given, diff everything under that.
485
TODO: Selected-file diff is inefficient and doesn't show you
488
TODO: This probably handles non-Unix newlines poorly.
491
takes_args = ['file*']
492
takes_options = ['revision']
495
def run(self, revision=None, file_list=None):
496
from bzrlib.diff import show_diff
498
show_diff(Branch('.'), revision, specific_files=file_list)
504
class cmd_deleted(Command):
505
"""List files deleted in the working tree.
507
TODO: Show files deleted since a previous revision, or between two revisions.
509
def run(self, show_ids=False):
512
new = b.working_tree()
514
## TODO: Much more efficient way to do this: read in new
515
## directories with readdir, rather than stating each one. Same
516
## level of effort but possibly much less IO. (Or possibly not,
517
## if the directories are very large...)
519
for path, ie in old.inventory.iter_entries():
520
if not new.has_id(ie.file_id):
522
print '%-50s %s' % (path, ie.file_id)
527
class cmd_modified(Command):
528
"""List files modified in working tree."""
533
inv = b.read_working_inventory()
534
sc = statcache.update_cache(b, inv)
535
basis = b.basis_tree()
536
basis_inv = basis.inventory
538
# We used to do this through iter_entries(), but that's slow
539
# when most of the files are unmodified, as is usually the
540
# case. So instead we iterate by inventory entry, and only
541
# calculate paths as necessary.
543
for file_id in basis_inv:
544
cacheentry = sc.get(file_id)
545
if not cacheentry: # deleted
547
ie = basis_inv[file_id]
548
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
549
path = inv.id2path(file_id)
554
class cmd_added(Command):
555
"""List files added in working tree."""
559
wt = b.working_tree()
560
basis_inv = b.basis_tree().inventory
563
if file_id in basis_inv:
565
path = inv.id2path(file_id)
566
if not os.access(b.abspath(path), os.F_OK):
572
class cmd_root(Command):
573
"""Show the tree root directory.
575
The root is the nearest enclosing directory with a .bzr control
577
takes_args = ['filename?']
578
def run(self, filename=None):
579
"""Print the branch root."""
580
from branch import find_branch
581
b = find_branch(filename)
582
print getattr(b, 'base', None) or getattr(b, 'baseurl')
585
class cmd_log(Command):
586
"""Show log of this branch.
588
TODO: Option to limit range.
590
TODO: Perhaps show most-recent first with an option for last.
592
takes_args = ['filename?']
593
takes_options = ['timezone', 'verbose', 'show-ids']
594
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
595
from branch import find_branch
596
b = find_branch((filename or '.'), lock_mode='r')
598
filename = b.relpath(filename)
599
bzrlib.show_log(b, filename,
600
show_timezone=timezone,
606
class cmd_touching_revisions(Command):
607
"""Return revision-ids which affected a particular file."""
609
takes_args = ["filename"]
610
def run(self, filename):
611
b = Branch(filename, lock_mode='r')
612
inv = b.read_working_inventory()
613
file_id = inv.path2id(b.relpath(filename))
614
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
615
print "%6d %s" % (revno, what)
618
class cmd_ls(Command):
619
"""List files in a tree.
621
TODO: Take a revision or remote path and list that tree instead.
624
def run(self, revision=None, verbose=False):
627
tree = b.working_tree()
629
tree = b.revision_tree(b.lookup_revision(revision))
631
for fp, fc, kind, fid in tree.list_files():
633
if kind == 'directory':
640
print '%-8s %s%s' % (fc, fp, kindch)
646
class cmd_unknowns(Command):
647
"""List unknown files"""
649
for f in Branch('.').unknowns():
654
class cmd_ignore(Command):
655
"""Ignore a command or pattern
657
To remove patterns from the ignore list, edit the .bzrignore file.
659
If the pattern contains a slash, it is compared to the whole path
660
from the branch root. Otherwise, it is comapred to only the last
661
component of the path.
663
Ignore patterns are case-insensitive on case-insensitive systems.
665
Note: wildcards must be quoted from the shell on Unix.
668
bzr ignore ./Makefile
671
takes_args = ['name_pattern']
673
def run(self, name_pattern):
674
from bzrlib.atomicfile import AtomicFile
678
ifn = b.abspath('.bzrignore')
680
# FIXME: probably doesn't handle non-ascii patterns
682
if os.path.exists(ifn):
683
f = b.controlfile(ifn, 'rt')
689
if igns and igns[-1] != '\n':
691
igns += name_pattern + '\n'
693
f = AtomicFile(ifn, 'wt')
697
inv = b.working_tree().inventory
698
if inv.path2id('.bzrignore'):
699
mutter('.bzrignore is already versioned')
701
mutter('need to make new .bzrignore file versioned')
702
b.add(['.bzrignore'])
706
class cmd_ignored(Command):
707
"""List ignored files and the patterns that matched them.
709
See also: bzr ignore"""
711
tree = Branch('.').working_tree()
712
for path, file_class, kind, file_id in tree.list_files():
713
if file_class != 'I':
715
## XXX: Slightly inefficient since this was already calculated
716
pat = tree.is_ignored(path)
717
print '%-50s %s' % (path, pat)
720
class cmd_lookup_revision(Command):
721
"""Lookup the revision-id from a revision-number
724
bzr lookup-revision 33
727
takes_args = ['revno']
729
def run(self, revno):
733
raise BzrCommandError("not a valid revision-number: %r" % revno)
735
print Branch('.').lookup_revision(revno)
738
class cmd_export(Command):
739
"""Export past revision to destination directory.
741
If no revision is specified this exports the last committed revision."""
742
takes_args = ['dest']
743
takes_options = ['revision']
744
def run(self, dest, revision=None):
747
rh = b.revision_history()[-1]
749
rh = b.lookup_revision(int(revision))
750
t = b.revision_tree(rh)
754
class cmd_cat(Command):
755
"""Write a file's text from a previous revision."""
757
takes_options = ['revision']
758
takes_args = ['filename']
760
def run(self, filename, revision=None):
762
raise BzrCommandError("bzr cat requires a revision number")
764
b.print_file(b.relpath(filename), int(revision))
767
class cmd_local_time_offset(Command):
768
"""Show the offset in seconds from GMT to local time."""
771
print bzrlib.osutils.local_time_offset()
775
class cmd_commit(Command):
776
"""Commit changes into a new revision.
778
If selected files are specified, only changes to those files are
779
committed. If a directory is specified then its contents are also
782
A selected-file commit may fail in some cases where the committed
783
tree would be invalid, such as trying to commit a file in a
784
newly-added directory that is not itself committed.
786
TODO: Run hooks on tree to-be-committed, and after commit.
788
TODO: Strict commit that fails if there are unknown or deleted files.
790
takes_args = ['selected*']
791
takes_options = ['message', 'file', 'verbose']
792
aliases = ['ci', 'checkin']
794
def run(self, message=None, file=None, verbose=False, selected_list=None):
795
from bzrlib.commit import commit
797
## Warning: shadows builtin file()
798
if not message and not file:
799
raise BzrCommandError("please specify a commit message",
800
["use either --message or --file"])
801
elif message and file:
802
raise BzrCommandError("please specify either --message or --file")
806
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
809
commit(b, message, verbose=verbose, specific_files=selected_list)
812
class cmd_check(Command):
813
"""Validate consistency of branch history.
815
This command checks various invariants about the branch storage to
816
detect data corruption or bzr bugs.
818
takes_args = ['dir?']
819
def run(self, dir='.'):
821
bzrlib.check.check(Branch(dir, find_root=False))
825
class cmd_whoami(Command):
826
"""Show bzr user id."""
827
takes_options = ['email']
829
def run(self, email=False):
831
print bzrlib.osutils.user_email()
833
print bzrlib.osutils.username()
836
class cmd_selftest(Command):
837
"""Run internal test suite"""
840
failures, tests = 0, 0
842
import doctest, bzrlib.store, bzrlib.tests
843
bzrlib.trace.verbose = False
845
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
846
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
847
mf, mt = doctest.testmod(m)
850
print '%-40s %3d tests' % (m.__name__, mt),
852
print '%3d FAILED!' % mf
856
print '%-40s %3d tests' % ('total', tests),
858
print '%3d FAILED!' % failures
864
class cmd_version(Command):
865
"""Show version of bzr"""
870
print "bzr (bazaar-ng) %s" % bzrlib.__version__
871
print bzrlib.__copyright__
872
print "http://bazaar-ng.org/"
874
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
875
print "you may use, modify and redistribute it under the terms of the GNU"
876
print "General Public License version 2 or later."
879
class cmd_rocks(Command):
880
"""Statement of optimism."""
883
print "it sure does!"
319
885
def parse_spec(spec):
325
>>> parse_spec("../@")
327
>>> parse_spec("../f/@35")
329
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
330
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
335
887
parsed = spec.split('/@')
336
888
assert len(parsed) == 2
337
889
if parsed[1] == "":
341
parsed[1] = int(parsed[1])
343
pass # We can allow stuff like ./@revid:blahblahblah
892
parsed[1] = int(parsed[1])
347
895
parsed = [spec, None]
350
def parse_args(command, argv, alias_argv=None):
898
class cmd_merge(Command):
899
"""Perform a three-way merge of trees."""
900
takes_args = ['other_spec', 'base_spec']
902
def run(self, other_spec, base_spec):
903
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
905
class cmd_assert_fail(Command):
906
"""Test reporting of assertion failures"""
909
assert False, "always fails"
912
class cmd_help(Command):
913
"""Show help on a command or other topic.
915
For a list of all available commands, say 'bzr help commands'."""
916
takes_args = ['topic?']
919
def run(self, topic=None):
924
class cmd_update_stat_cache(Command):
925
"""Update stat-cache mapping inodes to SHA-1 hashes.
932
statcache.update_cache(b.base, b.read_working_inventory())
935
######################################################################
939
# list of all available options; the rhs can be either None for an
940
# option that takes no argument, or a constructor function that checks
964
def parse_args(argv):
351
965
"""Parse command line.
353
967
Arguments and options are parsed at this level before being passed
354
968
down to specific command handlers. This routine knows, from a
355
969
lookup table, something about the available options, what optargs
356
970
they take, and which commands will accept them.
972
>>> parse_args('--help'.split())
974
>>> parse_args('--version'.split())
975
([], {'version': True})
976
>>> parse_args('status --all'.split())
977
(['status'], {'all': True})
978
>>> parse_args('commit --message=biter'.split())
979
(['commit'], {'message': u'biter'})
358
# TODO: make it a method of the Command?
359
parser = option.get_optparser(command.options())
360
if alias_argv is not None:
361
args = alias_argv + argv
365
options, args = parser.parse_args(args)
366
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
367
v is not option.OptionParser.DEFAULT_VALUE])
984
# TODO: Maybe handle '--' to end options?
989
# option names must not be unicode
993
mutter(" got option %r" % a)
995
optname, optarg = a[2:].split('=', 1)
998
if optname not in OPTIONS:
999
bailout('unknown long option %r' % a)
1002
if shortopt not in SHORT_OPTIONS:
1003
bailout('unknown short option %r' % a)
1004
optname = SHORT_OPTIONS[shortopt]
1007
# XXX: Do we ever want to support this, e.g. for -r?
1008
bailout('repeated option %r' % a)
1010
optargfn = OPTIONS[optname]
1014
bailout('option %r needs an argument' % a)
1016
optarg = argv.pop(0)
1017
opts[optname] = optargfn(optarg)
1020
bailout('option %r takes no argument' % optname)
1021
opts[optname] = True
368
1025
return args, opts
371
1030
def _match_argform(cmd, takes_args, args):
416
def apply_profiled(the_callable, *args, **kwargs):
420
pffileno, pfname = tempfile.mkstemp()
422
prof = hotshot.Profile(pfname)
424
ret = prof.runcall(the_callable, *args, **kwargs) or 0
427
stats = hotshot.stats.load(pfname)
429
stats.sort_stats('cum') # 'time'
430
## XXX: Might like to write to stderr or the trace file instead but
431
## print_stats seems hardcoded to stdout
432
stats.print_stats(20)
439
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
440
from bzrlib.lsprof import profile
442
ret, stats = profile(the_callable, *args, **kwargs)
448
cPickle.dump(stats, open(filename, 'w'), 2)
449
print 'Profile data written to %r.' % filename
454
"""Return an expanded alias, or None if no alias exists"""
456
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
458
return alias.split(' ')
462
1075
def run_bzr(argv):
463
1076
"""Execute a command.
465
1078
This is similar to main(), but without all the trappings for
466
1079
logging and error handling.
469
The command-line arguments, without the program name from argv[0]
470
These should already be decoded. All library/test code calling
471
run_bzr should be passing valid strings (don't need decoding).
473
Returns a command status or raises an exception.
475
Special master options: these must come before the command because
476
they control how the command is interpreted.
479
Do not load plugin modules at all
485
Only use builtin commands. (Plugins are still allowed to change
489
Run under the Python hotshot profiler.
492
Run under the Python lsprof profiler.
496
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
497
opt_no_aliases = False
498
opt_lsprof_file = None
500
# --no-plugins is handled specially at a very early stage. We need
501
# to load plugins before doing other command parsing so that they
502
# can override commands, but this needs to happen first.
510
elif a == '--lsprof':
512
elif a == '--lsprof-file':
514
opt_lsprof_file = argv[i + 1]
516
elif a == '--no-plugins':
517
opt_no_plugins = True
518
elif a == '--no-aliases':
519
opt_no_aliases = True
520
elif a == '--builtin':
522
elif a in ('--quiet', '-q'):
530
from bzrlib.builtins import cmd_help
531
cmd_help().run_argv_aliases([])
534
if argv[0] == '--version':
535
from bzrlib.version import show_version
539
if not opt_no_plugins:
540
from bzrlib.plugin import load_plugins
543
from bzrlib.plugin import disable_plugins
548
if not opt_no_aliases:
549
alias_argv = get_alias(argv[0])
551
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
552
argv[0] = alias_argv.pop(0)
555
# We want only 'ascii' command names, but the user may have typed
556
# in a Unicode name. In that case, they should just get a
557
# 'command not found' error later.
559
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
560
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
561
run = cmd_obj.run_argv
564
run = cmd_obj.run_argv_aliases
565
run_argv = [argv, alias_argv]
1081
argv = [a.decode(bzrlib.user_encoding) for a in argv]
569
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
571
ret = apply_profiled(run, *run_argv)
576
# reset, in case we may do other commands later within the same process
579
def display_command(func):
580
"""Decorator that suppresses pipe/interrupt errors."""
581
def ignore_pipe(*args, **kwargs):
1084
args, opts = parse_args(argv[1:])
1092
elif 'version' in opts:
1095
cmd = str(args.pop(0))
1102
canonical_cmd, cmd_class = get_cmd_class(cmd)
1105
if 'profile' in opts:
1111
# check options are reasonable
1112
allowed = cmd_class.takes_options
1114
if oname not in allowed:
1115
raise BzrCommandError("option '--%s' is not allowed for command %r"
1118
# mix arguments and options into one dictionary
1119
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1121
for k, v in opts.items():
1122
cmdopts[k.replace('-', '_')] = v
1125
import hotshot, tempfile
1126
pffileno, pfname = tempfile.mkstemp()
583
result = func(*args, **kwargs)
587
if getattr(e, 'errno', None) is None:
589
if e.errno != errno.EPIPE:
590
# Win32 raises IOError with errno=0 on a broken pipe
591
if sys.platform != 'win32' or e.errno != 0:
594
except KeyboardInterrupt:
1128
prof = hotshot.Profile(pfname)
1129
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1132
import hotshot.stats
1133
stats = hotshot.stats.load(pfname)
1135
stats.sort_stats('time')
1136
## XXX: Might like to write to stderr or the trace file instead but
1137
## print_stats seems hardcoded to stdout
1138
stats.print_stats(20)
1146
cmdobj = cmd_class(cmdopts, cmdargs).status
1149
def _report_exception(summary, quiet=False):
1151
log_error('bzr: ' + summary)
1152
bzrlib.trace.log_exception()
1155
tb = sys.exc_info()[2]
1156
exinfo = traceback.extract_tb(tb)
1158
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1159
sys.stderr.write(' see ~/.bzr.log for debug information\n')
601
from bzrlib.ui.text import TextUIFactory
602
bzrlib.ui.ui_factory = TextUIFactory()
603
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
604
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
609
def run_bzr_catch_errors(argv):
1166
bzrlib.open_tracefile(argv)
612
# do this here inside the exception wrappers to catch EPIPE
615
# used to handle AssertionError and KeyboardInterrupt
616
# specially here, but hopefully they're handled ok by the logger now
617
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
618
if os.environ.get('BZR_PDB'):
619
print '**** entering debugger'
621
pdb.post_mortem(sys.exc_traceback)
1171
return run_bzr(argv)
1173
# do this here inside the exception wrappers to catch EPIPE
1176
quiet = isinstance(e, (BzrCommandError))
1177
_report_exception('error: ' + e.args[0], quiet=quiet)
1180
# some explanation or hints
1183
except AssertionError, e:
1184
msg = 'assertion failed'
1186
msg += ': ' + str(e)
1187
_report_exception(msg)
1189
except KeyboardInterrupt, e:
1190
_report_exception('interrupted', quiet=True)
1192
except Exception, e:
1194
if (isinstance(e, IOError)
1195
and hasattr(e, 'errno')
1196
and e.errno == errno.EPIPE):
1200
msg = str(e).rstrip('\n')
1201
_report_exception(msg, quiet)
1204
bzrlib.trace.close_trace()
624
1207
if __name__ == '__main__':
625
1208
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
