84
34
assert cmd.startswith("cmd_")
85
35
return cmd[4:].replace('_','-')
88
def _builtin_commands():
89
import bzrlib.builtins
91
builtins = bzrlib.builtins.__dict__
93
if name.startswith("cmd_"):
94
real_name = _unsquish_command_name(name)
95
r[real_name] = builtins[name]
99
def builtin_command_names():
100
"""Return list of builtin command names."""
101
return _builtin_commands().keys()
104
def plugin_command_names():
105
return plugin_cmds.keys()
108
def _get_cmd_dict(plugins_override=True):
109
"""Return name->class mapping for all commands."""
110
d = _builtin_commands()
112
d.update(plugin_cmds)
116
def get_all_cmds(plugins_override=True):
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
117
72
"""Return canonical name and class for all registered commands."""
118
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
122
def get_cmd_object(cmd_name, plugins_override=True):
73
for k, v in globals().iteritems():
74
if k.startswith("cmd_"):
75
yield _unsquish_command_name(k), v
77
def get_cmd_class(cmd):
123
78
"""Return the canonical name and command class for a command.
126
If true, plugin commands can override builtins.
128
from bzrlib.externalcommand import ExternalCommand
130
cmd_name = str(cmd_name) # not unicode
80
cmd = str(cmd) # not unicode
132
82
# first look up this command under the specified name
133
cmds = _get_cmd_dict(plugins_override=plugins_override)
135
return cmds[cmd_name]()
84
return cmd, globals()[_squish_command_name(cmd)]
139
88
# look for any command which claims this as an alias
140
for real_cmd_name, cmd_class in cmds.iteritems():
141
if cmd_name in cmd_class.aliases:
144
cmd_obj = ExternalCommand.find_command(cmd_name)
148
raise BzrCommandError("unknown command %r" % cmd_name)
89
for cmdname, cmdclass in get_all_cmds():
90
if cmd in cmdclass.aliases:
91
return cmdname, cmdclass
93
cmdclass = ExternalCommand.find_command(cmd)
97
raise BzrCommandError("unknown command %r" % cmd)
151
100
class Command(object):
152
101
"""Base class for commands.
154
Commands are the heart of the command-line bzr interface.
156
The command object mostly handles the mapping of command-line
157
parameters into one or more bzrlib operations, and of the results
160
Commands normally don't have any state. All their arguments are
161
passed in to the run method. (Subclasses may take a different
162
policy if the behaviour of the instance needs to depend on e.g. a
163
shell plugin and not just its Python class.)
165
103
The docstring for an actual command should give a single-line
166
104
summary, then a complete description of the command. A grammar
167
105
description will be inserted.
170
Other accepted names for this command.
173
108
List of argument forms, marked with whether they are optional,
178
['to_location', 'from_branch?', 'file*']
180
'to_location' is required
181
'from_branch' is optional
182
'file' can be specified 0 or more times
185
List of options that may be given for this command. These can
186
be either strings, referring to globally-defined options,
187
or option objects. Retrieve through options().
112
List of options that may be given for this command.
190
If true, this command isn't advertised. This is typically
191
for commands intended for expert users.
115
If true, this command isn't advertised.
195
120
takes_options = []
200
"""Construct an instance of this command."""
201
if self.__doc__ == Command.__doc__:
202
warn("No help message set for %r" % self)
205
"""Return dict of valid options for this command.
207
Maps from long option name to option object."""
209
r['help'] = Option.OPTIONS['help']
210
for o in self.takes_options:
211
if not isinstance(o, Option):
212
o = Option.OPTIONS[o]
216
@deprecated_method(zero_eight)
217
def run_argv(self, argv):
218
"""Parse command line and run.
220
See run_argv_aliases for the 0.8 and beyond api.
222
return self.run_argv_aliases(argv)
224
def run_argv_aliases(self, argv, alias_argv=None):
225
"""Parse the command line and run with extra aliases in alias_argv."""
226
args, opts = parse_args(self, argv, alias_argv)
227
if 'help' in opts: # e.g. bzr add --help
228
from bzrlib.help import help_on_command
229
help_on_command(self.name())
231
# XXX: This should be handled by the parser
232
allowed_names = self.options().keys()
234
if oname not in allowed_names:
235
raise BzrCommandError("option '--%s' is not allowed for"
236
" command %r" % (oname, self.name()))
237
# mix arguments and options into one dictionary
238
cmdargs = _match_argform(self.name(), self.takes_args, args)
240
for k, v in opts.items():
241
cmdopts[k.replace('-', '_')] = v
243
all_cmd_args = cmdargs.copy()
244
all_cmd_args.update(cmdopts)
246
return self.run(**all_cmd_args)
124
def __init__(self, options, arguments):
125
"""Construct and run the command.
127
Sets self.status to the return value of run()."""
128
assert isinstance(options, dict)
129
assert isinstance(arguments, dict)
130
cmdargs = options.copy()
131
cmdargs.update(arguments)
132
assert self.__doc__ != Command.__doc__, \
133
("No help message set for %r" % self)
134
self.status = self.run(**cmdargs)
249
"""Actually run the command.
138
"""Override this in sub-classes.
251
140
This is invoked with the options and arguments bound to
252
141
keyword parameters.
254
Return 0 or None if the command was successful, or a non-zero
255
shell error code if not. It's OK for this method to allow
256
an exception to raise up.
143
Return 0 or None if the command was successful, or a shell
258
raise NotImplementedError('no implementation of command %r'
262
"""Return help message for this class."""
263
from inspect import getdoc
264
if self.__doc__ is Command.__doc__:
269
return _unsquish_command_name(self.__class__.__name__)
149
class ExternalCommand(Command):
150
"""Class to wrap external commands.
152
We cheat a little here, when get_cmd_class() calls us we actually give it back
153
an object we construct that has the appropriate path, help, options etc for the
156
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
157
method, which we override to call the Command.__init__ method. That then calls
158
our run method which is pretty straight forward.
160
The only wrinkle is that we have to map bzr's dictionary of options and arguments
161
back into command line options and arguments for the script.
164
def find_command(cls, cmd):
166
bzrpath = os.environ.get('BZRPATH', '')
168
for dir in bzrpath.split(':'):
169
path = os.path.join(dir, cmd)
170
if os.path.isfile(path):
171
return ExternalCommand(path)
175
find_command = classmethod(find_command)
177
def __init__(self, path):
180
# TODO: If either of these fail, we should detect that and
181
# assume that path is not really a bzr plugin after all.
183
pipe = os.popen('%s --bzr-usage' % path, 'r')
184
self.takes_options = pipe.readline().split()
185
self.takes_args = pipe.readline().split()
188
pipe = os.popen('%s --bzr-help' % path, 'r')
189
self.__doc__ = pipe.read()
192
def __call__(self, options, arguments):
193
Command.__init__(self, options, arguments)
196
def run(self, **kargs):
204
if OPTIONS.has_key(name):
206
opts.append('--%s' % name)
207
if value is not None and value is not True:
208
opts.append(str(value))
210
# it's an arg, or arg list
211
if type(value) is not list:
217
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
221
class cmd_status(Command):
222
"""Display status summary.
224
This reports on versioned and unknown files, reporting them
225
grouped by state. Possible states are:
228
Versioned in the working copy but not in the previous revision.
231
Versioned in the previous revision but removed or deleted
235
Path of this file changed from the previous revision;
236
the text may also have changed. This includes files whose
237
parent directory was renamed.
240
Text has changed since the previous revision.
243
Nothing about this file has changed since the previous revision.
244
Only shown with --all.
247
Not versioned and not matching an ignore pattern.
249
To see ignored files use 'bzr ignored'. For details in the
250
changes to file texts, use 'bzr diff'.
252
If no arguments are specified, the status of the entire working
253
directory is shown. Otherwise, only the status of the specified
254
files or directories is reported. If a directory is given, status
255
is reported for everything inside that directory.
257
takes_args = ['file*']
258
takes_options = ['all', 'show-ids']
259
aliases = ['st', 'stat']
261
def run(self, all=False, show_ids=False, file_list=None):
263
b = Branch(file_list[0])
264
file_list = [b.relpath(x) for x in file_list]
265
# special case: only one path was given and it's the root
267
if file_list == ['']:
272
status.show_status(b, show_unchanged=all, show_ids=show_ids,
273
specific_files=file_list)
276
class cmd_cat_revision(Command):
277
"""Write out metadata for a revision."""
280
takes_args = ['revision_id']
282
def run(self, revision_id):
283
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
286
class cmd_revno(Command):
287
"""Show current revision number.
289
This is equal to the number of revisions on this branch."""
291
print Branch('.').revno()
294
class cmd_add(Command):
295
"""Add specified files or directories.
297
In non-recursive mode, all the named items are added, regardless
298
of whether they were previously ignored. A warning is given if
299
any of the named files are already versioned.
301
In recursive mode (the default), files are treated the same way
302
but the behaviour for directories is different. Directories that
303
are already versioned do not give a warning. All directories,
304
whether already versioned or not, are searched for files or
305
subdirectories that are neither versioned or ignored, and these
306
are added. This search proceeds recursively into versioned
309
Therefore simply saying 'bzr add .' will version all files that
310
are currently unknown.
312
TODO: Perhaps adding a file whose directly is not versioned should
313
recursively add that parent, rather than giving an error?
315
takes_args = ['file+']
316
takes_options = ['verbose', 'no-recurse']
318
def run(self, file_list, verbose=False, no_recurse=False):
319
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
322
class cmd_relpath(Command):
323
"""Show path of a file relative to root"""
324
takes_args = ['filename']
327
def run(self, filename):
328
print Branch(filename).relpath(filename)
332
class cmd_inventory(Command):
333
"""Show inventory of the current working copy or a revision."""
334
takes_options = ['revision', 'show-ids']
336
def run(self, revision=None, show_ids=False):
339
inv = b.read_working_inventory()
341
inv = b.get_revision_inventory(b.lookup_revision(revision))
343
for path, entry in inv.entries():
345
print '%-50s %s' % (path, entry.file_id)
350
class cmd_move(Command):
351
"""Move files to a different directory.
356
The destination must be a versioned directory in the same branch.
358
takes_args = ['source$', 'dest']
359
def run(self, source_list, dest):
362
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
365
class cmd_rename(Command):
366
"""Change the name of an entry.
369
bzr rename frob.c frobber.c
370
bzr rename src/frob.c lib/frob.c
372
It is an error if the destination name exists.
374
See also the 'move' command, which moves files into a different
375
directory without changing their name.
377
TODO: Some way to rename multiple files without invoking bzr for each
379
takes_args = ['from_name', 'to_name']
381
def run(self, from_name, to_name):
383
b.rename_one(b.relpath(from_name), b.relpath(to_name))
387
class cmd_renames(Command):
388
"""Show list of renamed files.
390
TODO: Option to show renames between two historical versions.
392
TODO: Only show renames under dir, rather than in the whole branch.
394
takes_args = ['dir?']
396
def run(self, dir='.'):
398
old_inv = b.basis_tree().inventory
399
new_inv = b.read_working_inventory()
401
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
403
for old_name, new_name in renames:
404
print "%s => %s" % (old_name, new_name)
407
class cmd_info(Command):
408
"""Show statistical information about a branch."""
409
takes_args = ['branch?']
411
def run(self, branch=None):
414
from branch import find_branch
415
b = find_branch(branch)
419
class cmd_remove(Command):
420
"""Make a file unversioned.
422
This makes bzr stop tracking changes to a versioned file. It does
423
not delete the working copy.
425
takes_args = ['file+']
426
takes_options = ['verbose']
428
def run(self, file_list, verbose=False):
429
b = Branch(file_list[0])
430
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
433
class cmd_file_id(Command):
434
"""Print file_id of a particular file or directory.
436
The file_id is assigned when the file is first added and remains the
437
same through all revisions where the file exists, even when it is
441
takes_args = ['filename']
442
def run(self, filename):
444
i = b.inventory.path2id(b.relpath(filename))
446
bailout("%r is not a versioned file" % filename)
451
class cmd_file_path(Command):
452
"""Print path of file_ids to a file or directory.
454
This prints one line for each directory down to the target,
455
starting at the branch root."""
457
takes_args = ['filename']
458
def run(self, filename):
461
fid = inv.path2id(b.relpath(filename))
463
bailout("%r is not a versioned file" % filename)
464
for fip in inv.get_idpath(fid):
468
class cmd_revision_history(Command):
469
"""Display list of revision ids on this branch."""
472
for patchid in Branch('.').revision_history():
476
class cmd_directories(Command):
477
"""Display list of versioned directories in this branch."""
479
for name, ie in Branch('.').read_working_inventory().directories():
486
class cmd_init(Command):
487
"""Make a directory into a versioned branch.
489
Use this to create an empty branch, or before importing an
492
Recipe for importing a tree of files:
497
bzr commit -m 'imported project'
500
Branch('.', init=True)
503
class cmd_diff(Command):
504
"""Show differences in working tree.
506
If files are listed, only the changes in those files are listed.
507
Otherwise, all changes for the tree are listed.
509
TODO: Given two revision arguments, show the difference between them.
511
TODO: Allow diff across branches.
513
TODO: Option to use external diff command; could be GNU diff, wdiff,
516
TODO: Python difflib is not exactly the same as unidiff; should
517
either fix it up or prefer to use an external diff.
519
TODO: If a directory is given, diff everything under that.
521
TODO: Selected-file diff is inefficient and doesn't show you
524
TODO: This probably handles non-Unix newlines poorly.
527
takes_args = ['file*']
528
takes_options = ['revision', 'diff-options']
531
def run(self, revision=None, file_list=None, diff_options=None):
532
from bzrlib.diff import show_diff
533
from bzrlib import find_branch
536
b = find_branch(file_list[0])
537
file_list = [b.relpath(f) for f in file_list]
538
if file_list == ['']:
539
# just pointing to top-of-tree
544
show_diff(b, revision, specific_files=file_list,
545
external_diff_options=diff_options)
551
class cmd_deleted(Command):
552
"""List files deleted in the working tree.
554
TODO: Show files deleted since a previous revision, or between two revisions.
556
def run(self, show_ids=False):
559
new = b.working_tree()
561
## TODO: Much more efficient way to do this: read in new
562
## directories with readdir, rather than stating each one. Same
563
## level of effort but possibly much less IO. (Or possibly not,
564
## if the directories are very large...)
566
for path, ie in old.inventory.iter_entries():
567
if not new.has_id(ie.file_id):
569
print '%-50s %s' % (path, ie.file_id)
574
class cmd_modified(Command):
575
"""List files modified in working tree."""
580
inv = b.read_working_inventory()
581
sc = statcache.update_cache(b, inv)
582
basis = b.basis_tree()
583
basis_inv = basis.inventory
585
# We used to do this through iter_entries(), but that's slow
586
# when most of the files are unmodified, as is usually the
587
# case. So instead we iterate by inventory entry, and only
588
# calculate paths as necessary.
590
for file_id in basis_inv:
591
cacheentry = sc.get(file_id)
592
if not cacheentry: # deleted
594
ie = basis_inv[file_id]
595
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
596
path = inv.id2path(file_id)
601
class cmd_added(Command):
602
"""List files added in working tree."""
606
wt = b.working_tree()
607
basis_inv = b.basis_tree().inventory
610
if file_id in basis_inv:
612
path = inv.id2path(file_id)
613
if not os.access(b.abspath(path), os.F_OK):
619
class cmd_root(Command):
620
"""Show the tree root directory.
622
The root is the nearest enclosing directory with a .bzr control
624
takes_args = ['filename?']
625
def run(self, filename=None):
626
"""Print the branch root."""
627
from branch import find_branch
628
b = find_branch(filename)
629
print getattr(b, 'base', None) or getattr(b, 'baseurl')
632
class cmd_log(Command):
633
"""Show log of this branch.
635
To request a range of logs, you can use the command -r begin:end
636
-r revision requests a specific revision, -r :end or -r begin: are
639
TODO: Make --revision support uuid: and hash: [future tag:] notation.
643
takes_args = ['filename?']
644
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
646
def run(self, filename=None, timezone='original',
651
from bzrlib import show_log, find_branch
654
direction = (forward and 'forward') or 'reverse'
657
b = find_branch(filename)
658
fp = b.relpath(filename)
660
file_id = b.read_working_inventory().path2id(fp)
662
file_id = None # points to branch root
668
revision = [None, None]
669
elif isinstance(revision, int):
670
revision = [revision, revision]
675
assert len(revision) == 2
677
mutter('encoding log as %r' % bzrlib.user_encoding)
678
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
681
show_timezone=timezone,
686
start_revision=revision[0],
687
end_revision=revision[1])
691
class cmd_touching_revisions(Command):
692
"""Return revision-ids which affected a particular file.
694
A more user-friendly interface is "bzr log FILE"."""
696
takes_args = ["filename"]
697
def run(self, filename):
699
inv = b.read_working_inventory()
700
file_id = inv.path2id(b.relpath(filename))
701
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
702
print "%6d %s" % (revno, what)
705
class cmd_ls(Command):
706
"""List files in a tree.
708
TODO: Take a revision or remote path and list that tree instead.
711
def run(self, revision=None, verbose=False):
714
tree = b.working_tree()
716
tree = b.revision_tree(b.lookup_revision(revision))
718
for fp, fc, kind, fid in tree.list_files():
720
if kind == 'directory':
727
print '%-8s %s%s' % (fc, fp, kindch)
733
class cmd_unknowns(Command):
734
"""List unknown files"""
736
for f in Branch('.').unknowns():
741
class cmd_ignore(Command):
742
"""Ignore a command or pattern
744
To remove patterns from the ignore list, edit the .bzrignore file.
746
If the pattern contains a slash, it is compared to the whole path
747
from the branch root. Otherwise, it is comapred to only the last
748
component of the path.
750
Ignore patterns are case-insensitive on case-insensitive systems.
752
Note: wildcards must be quoted from the shell on Unix.
755
bzr ignore ./Makefile
758
takes_args = ['name_pattern']
760
def run(self, name_pattern):
761
from bzrlib.atomicfile import AtomicFile
765
ifn = b.abspath('.bzrignore')
767
if os.path.exists(ifn):
770
igns = f.read().decode('utf-8')
776
# TODO: If the file already uses crlf-style termination, maybe
777
# we should use that for the newly added lines?
779
if igns and igns[-1] != '\n':
781
igns += name_pattern + '\n'
784
f = AtomicFile(ifn, 'wt')
785
f.write(igns.encode('utf-8'))
790
inv = b.working_tree().inventory
791
if inv.path2id('.bzrignore'):
792
mutter('.bzrignore is already versioned')
794
mutter('need to make new .bzrignore file versioned')
795
b.add(['.bzrignore'])
799
class cmd_ignored(Command):
800
"""List ignored files and the patterns that matched them.
802
See also: bzr ignore"""
804
tree = Branch('.').working_tree()
805
for path, file_class, kind, file_id in tree.list_files():
806
if file_class != 'I':
808
## XXX: Slightly inefficient since this was already calculated
809
pat = tree.is_ignored(path)
810
print '%-50s %s' % (path, pat)
813
class cmd_lookup_revision(Command):
814
"""Lookup the revision-id from a revision-number
817
bzr lookup-revision 33
820
takes_args = ['revno']
822
def run(self, revno):
826
raise BzrCommandError("not a valid revision-number: %r" % revno)
828
print Branch('.').lookup_revision(revno)
831
class cmd_export(Command):
832
"""Export past revision to destination directory.
834
If no revision is specified this exports the last committed revision."""
835
takes_args = ['dest']
836
takes_options = ['revision']
837
def run(self, dest, revision=None):
840
rh = b.revision_history()[-1]
842
rh = b.lookup_revision(int(revision))
843
t = b.revision_tree(rh)
847
class cmd_cat(Command):
848
"""Write a file's text from a previous revision."""
850
takes_options = ['revision']
851
takes_args = ['filename']
853
def run(self, filename, revision=None):
855
raise BzrCommandError("bzr cat requires a revision number")
857
b.print_file(b.relpath(filename), int(revision))
860
class cmd_local_time_offset(Command):
861
"""Show the offset in seconds from GMT to local time."""
864
print bzrlib.osutils.local_time_offset()
868
class cmd_commit(Command):
869
"""Commit changes into a new revision.
871
If selected files are specified, only changes to those files are
872
committed. If a directory is specified then its contents are also
875
A selected-file commit may fail in some cases where the committed
876
tree would be invalid, such as trying to commit a file in a
877
newly-added directory that is not itself committed.
879
TODO: Run hooks on tree to-be-committed, and after commit.
881
TODO: Strict commit that fails if there are unknown or deleted files.
883
takes_args = ['selected*']
884
takes_options = ['message', 'file', 'verbose']
885
aliases = ['ci', 'checkin']
887
def run(self, message=None, file=None, verbose=True, selected_list=None):
888
from bzrlib.commit import commit
890
## Warning: shadows builtin file()
891
if not message and not file:
892
raise BzrCommandError("please specify a commit message",
893
["use either --message or --file"])
894
elif message and file:
895
raise BzrCommandError("please specify either --message or --file")
899
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
902
commit(b, message, verbose=verbose, specific_files=selected_list)
905
class cmd_check(Command):
906
"""Validate consistency of branch history.
908
This command checks various invariants about the branch storage to
909
detect data corruption or bzr bugs.
911
takes_args = ['dir?']
912
def run(self, dir='.'):
914
bzrlib.check.check(Branch(dir))
918
class cmd_whoami(Command):
919
"""Show bzr user id."""
920
takes_options = ['email']
922
def run(self, email=False):
924
print bzrlib.osutils.user_email()
926
print bzrlib.osutils.username()
929
class cmd_selftest(Command):
930
"""Run internal test suite"""
933
failures, tests = 0, 0
935
import doctest, bzrlib.store
936
bzrlib.trace.verbose = False
938
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
939
bzrlib.tree, bzrlib.commands, bzrlib.add:
940
mf, mt = doctest.testmod(m)
943
print '%-40s %3d tests' % (m.__name__, mt),
945
print '%3d FAILED!' % mf
949
print '%-40s %3d tests' % ('total', tests),
951
print '%3d FAILED!' % failures
959
class cmd_version(Command):
960
"""Show version of bzr"""
965
print "bzr (bazaar-ng) %s" % bzrlib.__version__
966
# is bzrlib itself in a branch?
967
bzrrev = bzrlib.get_bzr_revision()
969
print " (bzr checkout, revision %d {%s})" % bzrrev
970
print bzrlib.__copyright__
971
print "http://bazaar-ng.org/"
973
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
974
print "you may use, modify and redistribute it under the terms of the GNU"
975
print "General Public License version 2 or later."
978
class cmd_rocks(Command):
979
"""Statement of optimism."""
982
print "it sure does!"
272
984
def parse_spec(spec):
278
>>> parse_spec("../@")
280
>>> parse_spec("../f/@35")
282
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
283
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
288
986
parsed = spec.split('/@')
289
987
assert len(parsed) == 2
290
988
if parsed[1] == "":
294
parsed[1] = int(parsed[1])
296
pass # We can allow stuff like ./@revid:blahblahblah
991
parsed[1] = int(parsed[1])
300
994
parsed = [spec, None]
303
def parse_args(command, argv, alias_argv=None):
997
class cmd_merge(Command):
998
"""Perform a three-way merge of trees."""
999
takes_args = ['other_spec', 'base_spec']
1001
def run(self, other_spec, base_spec):
1002
from bzrlib.merge import merge
1003
merge(parse_spec(other_spec), parse_spec(base_spec))
1005
class cmd_assert_fail(Command):
1006
"""Test reporting of assertion failures"""
1009
assert False, "always fails"
1012
class cmd_help(Command):
1013
"""Show help on a command or other topic.
1015
For a list of all available commands, say 'bzr help commands'."""
1016
takes_args = ['topic?']
1019
def run(self, topic=None):
1024
class cmd_update_stat_cache(Command):
1025
"""Update stat-cache mapping inodes to SHA-1 hashes.
1027
For testing only."""
1032
statcache.update_cache(b.base, b.read_working_inventory())
1036
# list of all available options; the rhs can be either None for an
1037
# option that takes no argument, or a constructor function that checks
1041
'diff-options': str,
1048
'revision': _parse_revision_str,
1065
def parse_args(argv):
304
1066
"""Parse command line.
306
1068
Arguments and options are parsed at this level before being passed
307
1069
down to specific command handlers. This routine knows, from a
308
1070
lookup table, something about the available options, what optargs
309
1071
they take, and which commands will accept them.
1073
>>> parse_args('--help'.split())
1074
([], {'help': True})
1075
>>> parse_args('--version'.split())
1076
([], {'version': True})
1077
>>> parse_args('status --all'.split())
1078
(['status'], {'all': True})
1079
>>> parse_args('commit --message=biter'.split())
1080
(['commit'], {'message': u'biter'})
311
# TODO: chop up this beast; make it a method of the Command
316
cmd_options = command.options()
318
proc_aliasarg = True # Are we processing alias_argv now?
319
for proc_argv in alias_argv, argv:
326
# We've received a standalone -- No more flags
330
# option names must not be unicode
334
mutter(" got option %r", a)
336
optname, optarg = a[2:].split('=', 1)
339
if optname not in cmd_options:
340
raise BzrOptionError('unknown long option %r for'
1085
# TODO: Maybe handle '--' to end options?
1090
# option names must not be unicode
1094
mutter(" got option %r" % a)
1096
optname, optarg = a[2:].split('=', 1)
345
if shortopt in Option.SHORT_OPTIONS:
346
# Multi-character options must have a space to delimit
348
# ^^^ what does this mean? mbp 20051014
349
optname = Option.SHORT_OPTIONS[shortopt].name
351
# Single character short options, can be chained,
352
# and have their value appended to their name
354
if shortopt not in Option.SHORT_OPTIONS:
355
# We didn't find the multi-character name, and we
356
# didn't find the single char name
357
raise BzrError('unknown short option %r' % a)
358
optname = Option.SHORT_OPTIONS[shortopt].name
361
# There are extra things on this option
362
# see if it is the value, or if it is another
364
optargfn = Option.OPTIONS[optname].type
366
# This option does not take an argument, so the
367
# next entry is another short option, pack it
369
proc_argv.insert(0, '-' + a[2:])
371
# This option takes an argument, so pack it
1099
if optname not in OPTIONS:
1100
bailout('unknown long option %r' % a)
1103
if shortopt not in SHORT_OPTIONS:
1104
bailout('unknown short option %r' % a)
1105
optname = SHORT_OPTIONS[shortopt]
1108
# XXX: Do we ever want to support this, e.g. for -r?
1109
bailout('repeated option %r' % a)
375
if optname not in cmd_options:
376
raise BzrOptionError('unknown short option %r for'
378
(shortopt, command.name()))
380
# XXX: Do we ever want to support this, e.g. for -r?
382
raise BzrError('repeated option %r' % a)
383
elif optname in alias_opts:
384
# Replace what's in the alias with what's in the real
386
del alias_opts[optname]
388
proc_argv.insert(0, a)
1111
optargfn = OPTIONS[optname]
1115
bailout('option %r needs an argument' % a)
391
raise BzrError('repeated option %r' % a)
393
option_obj = cmd_options[optname]
394
optargfn = option_obj.type
398
raise BzrError('option %r needs an argument' % a)
400
optarg = proc_argv.pop(0)
401
opts[optname] = optargfn(optarg)
403
alias_opts[optname] = optargfn(optarg)
406
raise BzrError('option %r takes no argument' % optname)
409
alias_opts[optname] = True
1117
optarg = argv.pop(0)
1118
opts[optname] = optargfn(optarg)
412
proc_aliasarg = False # Done with alias argv
1121
bailout('option %r takes no argument' % optname)
1122
opts[optname] = True
413
1126
return args, opts
416
1131
def _match_argform(cmd, takes_args, args):
461
def apply_profiled(the_callable, *args, **kwargs):
465
pffileno, pfname = tempfile.mkstemp()
467
prof = hotshot.Profile(pfname)
469
ret = prof.runcall(the_callable, *args, **kwargs) or 0
472
stats = hotshot.stats.load(pfname)
474
stats.sort_stats('cum') # 'time'
475
## XXX: Might like to write to stderr or the trace file instead but
476
## print_stats seems hardcoded to stdout
477
stats.print_stats(20)
484
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
485
from bzrlib.lsprof import profile
487
ret, stats = profile(the_callable, *args, **kwargs)
493
cPickle.dump(stats, open(filename, 'w'), 2)
494
print 'Profile data written to %r.' % filename
499
"""Return an expanded alias, or None if no alias exists"""
501
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
503
return alias.split(' ')
507
1176
def run_bzr(argv):
508
1177
"""Execute a command.
510
1179
This is similar to main(), but without all the trappings for
511
1180
logging and error handling.
514
The command-line arguments, without the program name from argv[0]
516
Returns a command status or raises an exception.
518
Special master options: these must come before the command because
519
they control how the command is interpreted.
522
Do not load plugin modules at all
528
Only use builtin commands. (Plugins are still allowed to change
532
Run under the Python hotshot profiler.
535
Run under the Python lsprof profiler.
537
1182
argv = [a.decode(bzrlib.user_encoding) for a in argv]
539
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
540
opt_no_aliases = False
541
opt_lsprof_file = None
543
# --no-plugins is handled specially at a very early stage. We need
544
# to load plugins before doing other command parsing so that they
545
# can override commands, but this needs to happen first.
553
elif a == '--lsprof':
555
elif a == '--lsprof-file':
556
opt_lsprof_file = argv[i + 1]
558
elif a == '--no-plugins':
559
opt_no_plugins = True
560
elif a == '--no-aliases':
561
opt_no_aliases = True
562
elif a == '--builtin':
564
elif a in ('--quiet', '-q'):
572
from bzrlib.builtins import cmd_help
573
cmd_help().run_argv([])
576
if argv[0] == '--version':
577
from bzrlib.builtins import show_version
581
if not opt_no_plugins:
582
from bzrlib.plugin import load_plugins
585
from bzrlib.plugin import disable_plugins
590
if not opt_no_aliases:
591
alias_argv = get_alias(argv[0])
593
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
594
argv[0] = alias_argv.pop(0)
596
cmd = str(argv.pop(0))
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
610
ret = apply_profiled(run, *run_argv)
615
# reset, in case we may do other commands later within the same process
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
1185
args, opts = parse_args(argv[1:])
1193
elif 'version' in opts:
1196
cmd = str(args.pop(0))
1203
canonical_cmd, cmd_class = get_cmd_class(cmd)
1206
if 'profile' in opts:
1212
# check options are reasonable
1213
allowed = cmd_class.takes_options
1215
if oname not in allowed:
1216
raise BzrCommandError("option '--%s' is not allowed for command %r"
1219
# mix arguments and options into one dictionary
1220
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1222
for k, v in opts.items():
1223
cmdopts[k.replace('-', '_')] = v
1226
import hotshot, tempfile
1227
pffileno, pfname = tempfile.mkstemp()
622
result = func(*args, **kwargs)
626
if not hasattr(e, 'errno'):
628
if e.errno != errno.EPIPE:
631
except KeyboardInterrupt:
1229
prof = hotshot.Profile(pfname)
1230
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1233
import hotshot.stats
1234
stats = hotshot.stats.load(pfname)
1236
stats.sort_stats('time')
1237
## XXX: Might like to write to stderr or the trace file instead but
1238
## print_stats seems hardcoded to stdout
1239
stats.print_stats(20)
1247
return cmd_class(cmdopts, cmdargs).status
1250
def _report_exception(summary, quiet=False):
1252
log_error('bzr: ' + summary)
1253
bzrlib.trace.log_exception()
1256
tb = sys.exc_info()[2]
1257
exinfo = traceback.extract_tb(tb)
1259
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1260
sys.stderr.write(' see ~/.bzr.log for debug information\n')
638
from bzrlib.ui.text import TextUIFactory
639
## bzrlib.trace.enable_default_logging()
640
bzrlib.trace.log_startup(argv)
641
bzrlib.ui.ui_factory = TextUIFactory()
642
ret = run_bzr_catch_errors(argv[1:])
643
mutter("return code %d", ret)
647
def run_bzr_catch_errors(argv):
1267
bzrlib.open_tracefile(argv)
652
# do this here inside the exception wrappers to catch EPIPE
655
# used to handle AssertionError and KeyboardInterrupt
656
# specially here, but hopefully they're handled ok by the logger now
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
664
bzrlib.trace.log_exception()
665
if os.environ.get('BZR_PDB'):
666
print '**** entering debugger'
668
pdb.post_mortem(sys.exc_traceback)
1272
return run_bzr(argv)
1274
# do this here inside the exception wrappers to catch EPIPE
1277
quiet = isinstance(e, (BzrCommandError))
1278
_report_exception('error: ' + e.args[0], quiet=quiet)
1281
# some explanation or hints
1284
except AssertionError, e:
1285
msg = 'assertion failed'
1287
msg += ': ' + str(e)
1288
_report_exception(msg)
1290
except KeyboardInterrupt, e:
1291
_report_exception('interrupted', quiet=True)
1293
except Exception, e:
1295
if (isinstance(e, IOError)
1296
and hasattr(e, 'errno')
1297
and e.errno == errno.EPIPE):
1301
msg = str(e).rstrip('\n')
1302
_report_exception(msg, quiet)
1305
bzrlib.trace.close_trace()
671
1308
if __name__ == '__main__':
672
1309
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
