87
37
assert cmd.startswith("cmd_")
88
38
return cmd[4:].replace('_','-')
91
def _builtin_commands():
92
import bzrlib.builtins
94
builtins = bzrlib.builtins.__dict__
96
if name.startswith("cmd_"):
97
real_name = _unsquish_command_name(name)
98
r[real_name] = builtins[name]
102
def builtin_command_names():
103
"""Return list of builtin command names."""
104
return _builtin_commands().keys()
107
def plugin_command_names():
108
return plugin_cmds.keys()
111
def _get_cmd_dict(plugins_override=True):
112
"""Return name->class mapping for all commands."""
113
d = _builtin_commands()
115
d.update(plugin_cmds)
119
def get_all_cmds(plugins_override=True):
40
def _parse_revision_str(revstr):
41
"""This handles a revision string -> revno.
43
There are several possibilities:
46
'234:345' -> [234, 345]
50
In the future we will also support:
51
'uuid:blah-blah-blah' -> ?
52
'hash:blahblahblah' -> ?
56
if revstr.find(':') != -1:
57
revs = revstr.split(':')
59
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
64
revs[0] = int(revs[0])
69
revs[1] = int(revs[1])
120
75
"""Return canonical name and class for all registered commands."""
121
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
125
def get_cmd_object(cmd_name, plugins_override=True):
76
for k, v in globals().iteritems():
77
if k.startswith("cmd_"):
78
yield _unsquish_command_name(k), v
80
def get_cmd_class(cmd):
126
81
"""Return the canonical name and command class for a command.
129
If true, plugin commands can override builtins.
131
from bzrlib.externalcommand import ExternalCommand
133
cmd_name = str(cmd_name) # not unicode
83
cmd = str(cmd) # not unicode
135
85
# first look up this command under the specified name
136
cmds = _get_cmd_dict(plugins_override=plugins_override)
138
return cmds[cmd_name]()
87
return cmd, globals()[_squish_command_name(cmd)]
142
91
# look for any command which claims this as an alias
143
for real_cmd_name, cmd_class in cmds.iteritems():
144
if cmd_name in cmd_class.aliases:
147
cmd_obj = ExternalCommand.find_command(cmd_name)
151
raise BzrCommandError('unknown command "%s"' % cmd_name)
92
for cmdname, cmdclass in get_all_cmds():
93
if cmd in cmdclass.aliases:
94
return cmdname, cmdclass
96
cmdclass = ExternalCommand.find_command(cmd)
100
raise BzrCommandError("unknown command %r" % cmd)
154
103
class Command(object):
155
104
"""Base class for commands.
157
Commands are the heart of the command-line bzr interface.
159
The command object mostly handles the mapping of command-line
160
parameters into one or more bzrlib operations, and of the results
163
Commands normally don't have any state. All their arguments are
164
passed in to the run method. (Subclasses may take a different
165
policy if the behaviour of the instance needs to depend on e.g. a
166
shell plugin and not just its Python class.)
168
106
The docstring for an actual command should give a single-line
169
107
summary, then a complete description of the command. A grammar
170
108
description will be inserted.
173
Other accepted names for this command.
176
111
List of argument forms, marked with whether they are optional,
181
['to_location', 'from_branch?', 'file*']
183
'to_location' is required
184
'from_branch' is optional
185
'file' can be specified 0 or more times
188
List of options that may be given for this command. These can
189
be either strings, referring to globally-defined options,
190
or option objects. Retrieve through options().
115
List of options that may be given for this command.
193
If true, this command isn't advertised. This is typically
194
for commands intended for expert users.
197
Command objects will get a 'outf' attribute, which has been
198
setup to properly handle encoding of unicode strings.
199
encoding_type determines what will happen when characters cannot
201
strict - abort if we cannot decode
202
replace - put in a bogus character (typically '?')
203
exact - do not encode sys.stdout
118
If true, this command isn't advertised.
208
123
takes_options = []
209
encoding_type = 'strict'
214
"""Construct an instance of this command."""
215
if self.__doc__ == Command.__doc__:
216
warn("No help message set for %r" % self)
219
"""Return dict of valid options for this command.
221
Maps from long option name to option object."""
223
r['help'] = Option.OPTIONS['help']
224
for o in self.takes_options:
225
if isinstance(o, basestring):
226
o = Option.OPTIONS[o]
230
def _setup_outf(self):
231
"""Return a file linked to stdout, which has proper encoding."""
232
assert self.encoding_type in ['strict', 'exact', 'replace']
234
# Originally I was using self.stdout, but that looks
235
# *way* too much like sys.stdout
236
if self.encoding_type == 'exact':
237
self.outf = sys.stdout
240
output_encoding = bzrlib.osutils.get_terminal_encoding()
242
# use 'replace' so that we don't abort if trying to write out
243
# in e.g. the default C locale.
244
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
245
# For whatever reason codecs.getwriter() does not advertise its encoding
246
# it just returns the encoding of the wrapped file, which is completely
247
# bogus. So set the attribute, so we can find the correct encoding later.
248
self.outf.encoding = output_encoding
250
@deprecated_method(zero_eight)
251
def run_argv(self, argv):
252
"""Parse command line and run.
254
See run_argv_aliases for the 0.8 and beyond api.
256
return self.run_argv_aliases(argv)
258
def run_argv_aliases(self, argv, alias_argv=None):
259
"""Parse the command line and run with extra aliases in alias_argv."""
261
warn("Passing None for [] is deprecated from bzrlib 0.10",
262
DeprecationWarning, stacklevel=2)
264
args, opts = parse_args(self, argv, alias_argv)
265
if 'help' in opts: # e.g. bzr add --help
266
from bzrlib.help import help_on_command
267
help_on_command(self.name())
269
# mix arguments and options into one dictionary
270
cmdargs = _match_argform(self.name(), self.takes_args, args)
272
for k, v in opts.items():
273
cmdopts[k.replace('-', '_')] = v
275
all_cmd_args = cmdargs.copy()
276
all_cmd_args.update(cmdopts)
280
return self.run(**all_cmd_args)
127
def __init__(self, options, arguments):
128
"""Construct and run the command.
130
Sets self.status to the return value of run()."""
131
assert isinstance(options, dict)
132
assert isinstance(arguments, dict)
133
cmdargs = options.copy()
134
cmdargs.update(arguments)
135
assert self.__doc__ != Command.__doc__, \
136
("No help message set for %r" % self)
137
self.status = self.run(**cmdargs)
283
"""Actually run the command.
141
"""Override this in sub-classes.
285
143
This is invoked with the options and arguments bound to
286
144
keyword parameters.
288
Return 0 or None if the command was successful, or a non-zero
289
shell error code if not. It's OK for this method to allow
290
an exception to raise up.
292
raise NotImplementedError('no implementation of command %r'
296
"""Return help message for this class."""
297
from inspect import getdoc
298
if self.__doc__ is Command.__doc__:
303
return _unsquish_command_name(self.__class__.__name__)
305
def plugin_name(self):
306
"""Get the name of the plugin that provides this command.
308
:return: The name of the plugin or None if the command is builtin.
310
mod_parts = self.__module__.split('.')
311
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
146
Return 0 or None if the command was successful, or a shell
152
class ExternalCommand(Command):
153
"""Class to wrap external commands.
155
We cheat a little here, when get_cmd_class() calls us we actually give it back
156
an object we construct that has the appropriate path, help, options etc for the
159
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
160
method, which we override to call the Command.__init__ method. That then calls
161
our run method which is pretty straight forward.
163
The only wrinkle is that we have to map bzr's dictionary of options and arguments
164
back into command line options and arguments for the script.
167
def find_command(cls, cmd):
169
bzrpath = os.environ.get('BZRPATH', '')
171
for dir in bzrpath.split(':'):
172
path = os.path.join(dir, cmd)
173
if os.path.isfile(path):
174
return ExternalCommand(path)
178
find_command = classmethod(find_command)
180
def __init__(self, path):
183
# TODO: If either of these fail, we should detect that and
184
# assume that path is not really a bzr plugin after all.
186
pipe = os.popen('%s --bzr-usage' % path, 'r')
187
self.takes_options = pipe.readline().split()
188
self.takes_args = pipe.readline().split()
191
pipe = os.popen('%s --bzr-help' % path, 'r')
192
self.__doc__ = pipe.read()
195
def __call__(self, options, arguments):
196
Command.__init__(self, options, arguments)
199
def run(self, **kargs):
207
if OPTIONS.has_key(name):
209
opts.append('--%s' % name)
210
if value is not None and value is not True:
211
opts.append(str(value))
213
# it's an arg, or arg list
214
if type(value) is not list:
220
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
224
class cmd_status(Command):
225
"""Display status summary.
227
This reports on versioned and unknown files, reporting them
228
grouped by state. Possible states are:
231
Versioned in the working copy but not in the previous revision.
234
Versioned in the previous revision but removed or deleted
238
Path of this file changed from the previous revision;
239
the text may also have changed. This includes files whose
240
parent directory was renamed.
243
Text has changed since the previous revision.
246
Nothing about this file has changed since the previous revision.
247
Only shown with --all.
250
Not versioned and not matching an ignore pattern.
252
To see ignored files use 'bzr ignored'. For details in the
253
changes to file texts, use 'bzr diff'.
255
If no arguments are specified, the status of the entire working
256
directory is shown. Otherwise, only the status of the specified
257
files or directories is reported. If a directory is given, status
258
is reported for everything inside that directory.
260
takes_args = ['file*']
261
takes_options = ['all', 'show-ids']
262
aliases = ['st', 'stat']
264
def run(self, all=False, show_ids=False, file_list=None):
266
b = Branch(file_list[0])
267
file_list = [b.relpath(x) for x in file_list]
268
# special case: only one path was given and it's the root
270
if file_list == ['']:
275
status.show_status(b, show_unchanged=all, show_ids=show_ids,
276
specific_files=file_list)
279
class cmd_cat_revision(Command):
280
"""Write out metadata for a revision."""
283
takes_args = ['revision_id']
285
def run(self, revision_id):
286
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
289
class cmd_revno(Command):
290
"""Show current revision number.
292
This is equal to the number of revisions on this branch."""
294
print Branch('.').revno()
297
class cmd_add(Command):
298
"""Add specified files or directories.
300
In non-recursive mode, all the named items are added, regardless
301
of whether they were previously ignored. A warning is given if
302
any of the named files are already versioned.
304
In recursive mode (the default), files are treated the same way
305
but the behaviour for directories is different. Directories that
306
are already versioned do not give a warning. All directories,
307
whether already versioned or not, are searched for files or
308
subdirectories that are neither versioned or ignored, and these
309
are added. This search proceeds recursively into versioned
312
Therefore simply saying 'bzr add .' will version all files that
313
are currently unknown.
315
TODO: Perhaps adding a file whose directly is not versioned should
316
recursively add that parent, rather than giving an error?
318
takes_args = ['file+']
319
takes_options = ['verbose']
321
def run(self, file_list, verbose=False):
322
bzrlib.add.smart_add(file_list, verbose)
325
class cmd_relpath(Command):
326
"""Show path of a file relative to root"""
327
takes_args = ['filename']
329
def run(self, filename):
330
print Branch(filename).relpath(filename)
334
class cmd_inventory(Command):
335
"""Show inventory of the current working copy or a revision."""
336
takes_options = ['revision']
338
def run(self, revision=None):
341
inv = b.read_working_inventory()
343
inv = b.get_revision_inventory(b.lookup_revision(revision))
345
for path, entry in inv.entries():
346
print '%-50s %s' % (entry.file_id, path)
349
class cmd_move(Command):
350
"""Move files to a different directory.
355
The destination must be a versioned directory in the same branch.
357
takes_args = ['source$', 'dest']
358
def run(self, source_list, dest):
361
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
364
class cmd_rename(Command):
365
"""Change the name of an entry.
368
bzr rename frob.c frobber.c
369
bzr rename src/frob.c lib/frob.c
371
It is an error if the destination name exists.
373
See also the 'move' command, which moves files into a different
374
directory without changing their name.
376
TODO: Some way to rename multiple files without invoking bzr for each
378
takes_args = ['from_name', 'to_name']
380
def run(self, from_name, to_name):
382
b.rename_one(b.relpath(from_name), b.relpath(to_name))
386
class cmd_renames(Command):
387
"""Show list of renamed files.
389
TODO: Option to show renames between two historical versions.
391
TODO: Only show renames under dir, rather than in the whole branch.
393
takes_args = ['dir?']
395
def run(self, dir='.'):
397
old_inv = b.basis_tree().inventory
398
new_inv = b.read_working_inventory()
400
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
402
for old_name, new_name in renames:
403
print "%s => %s" % (old_name, new_name)
406
class cmd_info(Command):
407
"""Show statistical information about a branch."""
408
takes_args = ['branch?']
410
def run(self, branch=None):
413
from branch import find_branch
414
b = find_branch(branch)
418
class cmd_remove(Command):
419
"""Make a file unversioned.
421
This makes bzr stop tracking changes to a versioned file. It does
422
not delete the working copy.
424
takes_args = ['file+']
425
takes_options = ['verbose']
427
def run(self, file_list, verbose=False):
428
b = Branch(file_list[0])
429
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
432
class cmd_file_id(Command):
433
"""Print file_id of a particular file or directory.
435
The file_id is assigned when the file is first added and remains the
436
same through all revisions where the file exists, even when it is
440
takes_args = ['filename']
441
def run(self, filename):
443
i = b.inventory.path2id(b.relpath(filename))
445
bailout("%r is not a versioned file" % filename)
450
class cmd_file_path(Command):
451
"""Print path of file_ids to a file or directory.
453
This prints one line for each directory down to the target,
454
starting at the branch root."""
456
takes_args = ['filename']
457
def run(self, filename):
460
fid = inv.path2id(b.relpath(filename))
462
bailout("%r is not a versioned file" % filename)
463
for fip in inv.get_idpath(fid):
467
class cmd_revision_history(Command):
468
"""Display list of revision ids on this branch."""
470
for patchid in Branch('.').revision_history():
474
class cmd_directories(Command):
475
"""Display list of versioned directories in this branch."""
477
for name, ie in Branch('.').read_working_inventory().directories():
484
class cmd_init(Command):
485
"""Make a directory into a versioned branch.
487
Use this to create an empty branch, or before importing an
490
Recipe for importing a tree of files:
495
bzr commit -m 'imported project'
498
Branch('.', init=True)
501
class cmd_diff(Command):
502
"""Show differences in working tree.
504
If files are listed, only the changes in those files are listed.
505
Otherwise, all changes for the tree are listed.
507
TODO: Given two revision arguments, show the difference between them.
509
TODO: Allow diff across branches.
511
TODO: Option to use external diff command; could be GNU diff, wdiff,
514
TODO: Python difflib is not exactly the same as unidiff; should
515
either fix it up or prefer to use an external diff.
517
TODO: If a directory is given, diff everything under that.
519
TODO: Selected-file diff is inefficient and doesn't show you
522
TODO: This probably handles non-Unix newlines poorly.
525
takes_args = ['file*']
526
takes_options = ['revision', 'diff-options']
529
def run(self, revision=None, file_list=None, diff_options=None):
530
from bzrlib.diff import show_diff
531
from bzrlib import find_branch
534
b = find_branch(file_list[0])
535
file_list = [b.relpath(f) for f in file_list]
536
if file_list == ['']:
537
# just pointing to top-of-tree
542
show_diff(b, revision, specific_files=file_list,
543
external_diff_options=diff_options)
549
class cmd_deleted(Command):
550
"""List files deleted in the working tree.
552
TODO: Show files deleted since a previous revision, or between two revisions.
554
def run(self, show_ids=False):
557
new = b.working_tree()
559
## TODO: Much more efficient way to do this: read in new
560
## directories with readdir, rather than stating each one. Same
561
## level of effort but possibly much less IO. (Or possibly not,
562
## if the directories are very large...)
564
for path, ie in old.inventory.iter_entries():
565
if not new.has_id(ie.file_id):
567
print '%-50s %s' % (path, ie.file_id)
572
class cmd_modified(Command):
573
"""List files modified in working tree."""
578
inv = b.read_working_inventory()
579
sc = statcache.update_cache(b, inv)
580
basis = b.basis_tree()
581
basis_inv = basis.inventory
583
# We used to do this through iter_entries(), but that's slow
584
# when most of the files are unmodified, as is usually the
585
# case. So instead we iterate by inventory entry, and only
586
# calculate paths as necessary.
588
for file_id in basis_inv:
589
cacheentry = sc.get(file_id)
590
if not cacheentry: # deleted
592
ie = basis_inv[file_id]
593
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
594
path = inv.id2path(file_id)
599
class cmd_added(Command):
600
"""List files added in working tree."""
604
wt = b.working_tree()
605
basis_inv = b.basis_tree().inventory
608
if file_id in basis_inv:
610
path = inv.id2path(file_id)
611
if not os.access(b.abspath(path), os.F_OK):
617
class cmd_root(Command):
618
"""Show the tree root directory.
620
The root is the nearest enclosing directory with a .bzr control
622
takes_args = ['filename?']
623
def run(self, filename=None):
624
"""Print the branch root."""
625
from branch import find_branch
626
b = find_branch(filename)
627
print getattr(b, 'base', None) or getattr(b, 'baseurl')
630
class cmd_log(Command):
631
"""Show log of this branch.
633
To request a range of logs, you can use the command -r begin:end
634
-r revision requests a specific revision, -r :end or -r begin: are
637
TODO: Make --revision support uuid: and hash: [future tag:] notation.
641
takes_args = ['filename?']
642
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
644
def run(self, filename=None, timezone='original',
649
from bzrlib import show_log, find_branch
652
direction = (forward and 'forward') or 'reverse'
655
b = find_branch(filename)
656
fp = b.relpath(filename)
658
file_id = b.read_working_inventory().path2id(fp)
660
file_id = None # points to branch root
666
revision = [None, None]
667
elif isinstance(revision, int):
668
revision = [revision, revision]
673
assert len(revision) == 2
675
mutter('encoding log as %r' % bzrlib.user_encoding)
676
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
679
show_timezone=timezone,
684
start_revision=revision[0],
685
end_revision=revision[1])
689
class cmd_touching_revisions(Command):
690
"""Return revision-ids which affected a particular file.
692
A more user-friendly interface is "bzr log FILE"."""
694
takes_args = ["filename"]
695
def run(self, filename):
697
inv = b.read_working_inventory()
698
file_id = inv.path2id(b.relpath(filename))
699
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
700
print "%6d %s" % (revno, what)
703
class cmd_ls(Command):
704
"""List files in a tree.
706
TODO: Take a revision or remote path and list that tree instead.
709
def run(self, revision=None, verbose=False):
712
tree = b.working_tree()
714
tree = b.revision_tree(b.lookup_revision(revision))
716
for fp, fc, kind, fid in tree.list_files():
718
if kind == 'directory':
725
print '%-8s %s%s' % (fc, fp, kindch)
731
class cmd_unknowns(Command):
732
"""List unknown files"""
734
for f in Branch('.').unknowns():
739
class cmd_ignore(Command):
740
"""Ignore a command or pattern
742
To remove patterns from the ignore list, edit the .bzrignore file.
744
If the pattern contains a slash, it is compared to the whole path
745
from the branch root. Otherwise, it is comapred to only the last
746
component of the path.
748
Ignore patterns are case-insensitive on case-insensitive systems.
750
Note: wildcards must be quoted from the shell on Unix.
753
bzr ignore ./Makefile
756
takes_args = ['name_pattern']
758
def run(self, name_pattern):
759
from bzrlib.atomicfile import AtomicFile
763
ifn = b.abspath('.bzrignore')
765
if os.path.exists(ifn):
768
igns = f.read().decode('utf-8')
774
# TODO: If the file already uses crlf-style termination, maybe
775
# we should use that for the newly added lines?
777
if igns and igns[-1] != '\n':
779
igns += name_pattern + '\n'
782
f = AtomicFile(ifn, 'wt')
783
f.write(igns.encode('utf-8'))
788
inv = b.working_tree().inventory
789
if inv.path2id('.bzrignore'):
790
mutter('.bzrignore is already versioned')
792
mutter('need to make new .bzrignore file versioned')
793
b.add(['.bzrignore'])
797
class cmd_ignored(Command):
798
"""List ignored files and the patterns that matched them.
800
See also: bzr ignore"""
802
tree = Branch('.').working_tree()
803
for path, file_class, kind, file_id in tree.list_files():
804
if file_class != 'I':
806
## XXX: Slightly inefficient since this was already calculated
807
pat = tree.is_ignored(path)
808
print '%-50s %s' % (path, pat)
811
class cmd_lookup_revision(Command):
812
"""Lookup the revision-id from a revision-number
815
bzr lookup-revision 33
818
takes_args = ['revno']
820
def run(self, revno):
824
raise BzrCommandError("not a valid revision-number: %r" % revno)
826
print Branch('.').lookup_revision(revno)
829
class cmd_export(Command):
830
"""Export past revision to destination directory.
832
If no revision is specified this exports the last committed revision."""
833
takes_args = ['dest']
834
takes_options = ['revision']
835
def run(self, dest, revision=None):
838
rh = b.revision_history()[-1]
840
rh = b.lookup_revision(int(revision))
841
t = b.revision_tree(rh)
845
class cmd_cat(Command):
846
"""Write a file's text from a previous revision."""
848
takes_options = ['revision']
849
takes_args = ['filename']
851
def run(self, filename, revision=None):
853
raise BzrCommandError("bzr cat requires a revision number")
855
b.print_file(b.relpath(filename), int(revision))
858
class cmd_local_time_offset(Command):
859
"""Show the offset in seconds from GMT to local time."""
862
print bzrlib.osutils.local_time_offset()
866
class cmd_commit(Command):
867
"""Commit changes into a new revision.
869
If selected files are specified, only changes to those files are
870
committed. If a directory is specified then its contents are also
873
A selected-file commit may fail in some cases where the committed
874
tree would be invalid, such as trying to commit a file in a
875
newly-added directory that is not itself committed.
877
TODO: Run hooks on tree to-be-committed, and after commit.
879
TODO: Strict commit that fails if there are unknown or deleted files.
881
takes_args = ['selected*']
882
takes_options = ['message', 'file', 'verbose']
883
aliases = ['ci', 'checkin']
885
def run(self, message=None, file=None, verbose=True, selected_list=None):
886
from bzrlib.commit import commit
888
## Warning: shadows builtin file()
889
if not message and not file:
890
raise BzrCommandError("please specify a commit message",
891
["use either --message or --file"])
892
elif message and file:
893
raise BzrCommandError("please specify either --message or --file")
897
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
900
commit(b, message, verbose=verbose, specific_files=selected_list)
903
class cmd_check(Command):
904
"""Validate consistency of branch history.
906
This command checks various invariants about the branch storage to
907
detect data corruption or bzr bugs.
909
takes_args = ['dir?']
910
def run(self, dir='.'):
912
bzrlib.check.check(Branch(dir))
916
class cmd_whoami(Command):
917
"""Show bzr user id."""
918
takes_options = ['email']
920
def run(self, email=False):
922
print bzrlib.osutils.user_email()
924
print bzrlib.osutils.username()
927
class cmd_selftest(Command):
928
"""Run internal test suite"""
931
failures, tests = 0, 0
933
import doctest, bzrlib.store
934
bzrlib.trace.verbose = False
936
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
937
bzrlib.tree, bzrlib.commands, bzrlib.add:
938
mf, mt = doctest.testmod(m)
941
print '%-40s %3d tests' % (m.__name__, mt),
943
print '%3d FAILED!' % mf
947
print '%-40s %3d tests' % ('total', tests),
949
print '%3d FAILED!' % failures
957
class cmd_version(Command):
958
"""Show version of bzr"""
963
print "bzr (bazaar-ng) %s" % bzrlib.__version__
964
print bzrlib.__copyright__
965
print "http://bazaar-ng.org/"
967
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
968
print "you may use, modify and redistribute it under the terms of the GNU"
969
print "General Public License version 2 or later."
972
class cmd_rocks(Command):
973
"""Statement of optimism."""
976
print "it sure does!"
317
978
def parse_spec(spec):
323
>>> parse_spec("../@")
325
>>> parse_spec("../f/@35")
327
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
328
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
333
980
parsed = spec.split('/@')
334
981
assert len(parsed) == 2
335
982
if parsed[1] == "":
339
parsed[1] = int(parsed[1])
341
pass # We can allow stuff like ./@revid:blahblahblah
985
parsed[1] = int(parsed[1])
345
988
parsed = [spec, None]
348
def parse_args(command, argv, alias_argv=None):
991
class cmd_merge(Command):
992
"""Perform a three-way merge of trees."""
993
takes_args = ['other_spec', 'base_spec']
995
def run(self, other_spec, base_spec):
996
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
998
class cmd_assert_fail(Command):
999
"""Test reporting of assertion failures"""
1002
assert False, "always fails"
1005
class cmd_help(Command):
1006
"""Show help on a command or other topic.
1008
For a list of all available commands, say 'bzr help commands'."""
1009
takes_args = ['topic?']
1012
def run(self, topic=None):
1017
class cmd_update_stat_cache(Command):
1018
"""Update stat-cache mapping inodes to SHA-1 hashes.
1020
For testing only."""
1025
statcache.update_cache(b.base, b.read_working_inventory())
1028
######################################################################
1032
# list of all available options; the rhs can be either None for an
1033
# option that takes no argument, or a constructor function that checks
1037
'diff-options': str,
1043
'revision': _parse_revision_str,
1059
def parse_args(argv):
349
1060
"""Parse command line.
351
1062
Arguments and options are parsed at this level before being passed
352
1063
down to specific command handlers. This routine knows, from a
353
1064
lookup table, something about the available options, what optargs
354
1065
they take, and which commands will accept them.
1067
>>> parse_args('--help'.split())
1068
([], {'help': True})
1069
>>> parse_args('--version'.split())
1070
([], {'version': True})
1071
>>> parse_args('status --all'.split())
1072
(['status'], {'all': True})
1073
>>> parse_args('commit --message=biter'.split())
1074
(['commit'], {'message': u'biter'})
356
# TODO: make it a method of the Command?
357
parser = option.get_optparser(command.options())
358
if alias_argv is not None:
359
args = alias_argv + argv
363
options, args = parser.parse_args(args)
364
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
365
v is not option.OptionParser.DEFAULT_VALUE])
1079
# TODO: Maybe handle '--' to end options?
1084
# option names must not be unicode
1088
mutter(" got option %r" % a)
1090
optname, optarg = a[2:].split('=', 1)
1093
if optname not in OPTIONS:
1094
bailout('unknown long option %r' % a)
1097
if shortopt not in SHORT_OPTIONS:
1098
bailout('unknown short option %r' % a)
1099
optname = SHORT_OPTIONS[shortopt]
1102
# XXX: Do we ever want to support this, e.g. for -r?
1103
bailout('repeated option %r' % a)
1105
optargfn = OPTIONS[optname]
1109
bailout('option %r needs an argument' % a)
1111
optarg = argv.pop(0)
1112
opts[optname] = optargfn(optarg)
1115
bailout('option %r takes no argument' % optname)
1116
opts[optname] = True
366
1120
return args, opts
369
1125
def _match_argform(cmd, takes_args, args):
414
def apply_profiled(the_callable, *args, **kwargs):
418
pffileno, pfname = tempfile.mkstemp()
420
prof = hotshot.Profile(pfname)
422
ret = prof.runcall(the_callable, *args, **kwargs) or 0
425
stats = hotshot.stats.load(pfname)
427
stats.sort_stats('cum') # 'time'
428
## XXX: Might like to write to stderr or the trace file instead but
429
## print_stats seems hardcoded to stdout
430
stats.print_stats(20)
437
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
438
from bzrlib.lsprof import profile
440
ret, stats = profile(the_callable, *args, **kwargs)
446
cPickle.dump(stats, open(filename, 'w'), 2)
447
print 'Profile data written to %r.' % filename
452
"""Return an expanded alias, or None if no alias exists"""
454
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
456
return alias.split(' ')
460
1170
def run_bzr(argv):
461
1171
"""Execute a command.
463
1173
This is similar to main(), but without all the trappings for
464
1174
logging and error handling.
467
The command-line arguments, without the program name from argv[0]
468
These should already be decoded. All library/test code calling
469
run_bzr should be passing valid strings (don't need decoding).
471
Returns a command status or raises an exception.
473
Special master options: these must come before the command because
474
they control how the command is interpreted.
477
Do not load plugin modules at all
483
Only use builtin commands. (Plugins are still allowed to change
487
Run under the Python hotshot profiler.
490
Run under the Python lsprof profiler.
494
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
495
opt_no_aliases = False
496
opt_lsprof_file = None
498
# --no-plugins is handled specially at a very early stage. We need
499
# to load plugins before doing other command parsing so that they
500
# can override commands, but this needs to happen first.
508
elif a == '--lsprof':
510
elif a == '--lsprof-file':
512
opt_lsprof_file = argv[i + 1]
514
elif a == '--no-plugins':
515
opt_no_plugins = True
516
elif a == '--no-aliases':
517
opt_no_aliases = True
518
elif a == '--builtin':
520
elif a in ('--quiet', '-q'):
528
from bzrlib.builtins import cmd_help
529
cmd_help().run_argv_aliases([])
532
if argv[0] == '--version':
533
from bzrlib.version import show_version
537
if not opt_no_plugins:
538
from bzrlib.plugin import load_plugins
541
from bzrlib.plugin import disable_plugins
546
if not opt_no_aliases:
547
alias_argv = get_alias(argv[0])
549
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
550
argv[0] = alias_argv.pop(0)
552
cmd = str(argv.pop(0))
554
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
555
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
556
run = cmd_obj.run_argv
559
run = cmd_obj.run_argv_aliases
560
run_argv = [argv, alias_argv]
1176
argv = [a.decode(bzrlib.user_encoding) for a in argv]
564
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
566
ret = apply_profiled(run, *run_argv)
571
# reset, in case we may do other commands later within the same process
574
def display_command(func):
575
"""Decorator that suppresses pipe/interrupt errors."""
576
def ignore_pipe(*args, **kwargs):
1179
args, opts = parse_args(argv[1:])
1187
elif 'version' in opts:
1190
cmd = str(args.pop(0))
1197
canonical_cmd, cmd_class = get_cmd_class(cmd)
1200
if 'profile' in opts:
1206
# check options are reasonable
1207
allowed = cmd_class.takes_options
1209
if oname not in allowed:
1210
raise BzrCommandError("option '--%s' is not allowed for command %r"
1213
# mix arguments and options into one dictionary
1214
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1216
for k, v in opts.items():
1217
cmdopts[k.replace('-', '_')] = v
1220
import hotshot, tempfile
1221
pffileno, pfname = tempfile.mkstemp()
578
result = func(*args, **kwargs)
582
if not hasattr(e, 'errno'):
584
if e.errno != errno.EPIPE:
585
# Win32 raises IOError with errno=0 on a broken pipe
586
if sys.platform != 'win32' or e.errno != 0:
589
except KeyboardInterrupt:
1223
prof = hotshot.Profile(pfname)
1224
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1227
import hotshot.stats
1228
stats = hotshot.stats.load(pfname)
1230
stats.sort_stats('time')
1231
## XXX: Might like to write to stderr or the trace file instead but
1232
## print_stats seems hardcoded to stdout
1233
stats.print_stats(20)
1241
return cmd_class(cmdopts, cmdargs).status
1244
def _report_exception(summary, quiet=False):
1246
log_error('bzr: ' + summary)
1247
bzrlib.trace.log_exception()
1250
tb = sys.exc_info()[2]
1251
exinfo = traceback.extract_tb(tb)
1253
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1254
sys.stderr.write(' see ~/.bzr.log for debug information\n')
596
from bzrlib.ui.text import TextUIFactory
597
bzrlib.ui.ui_factory = TextUIFactory()
598
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
599
ret = run_bzr_catch_errors(argv)
600
mutter("return code %d", ret)
604
def run_bzr_catch_errors(argv):
1261
bzrlib.open_tracefile(argv)
607
# do this here inside the exception wrappers to catch EPIPE
610
# used to handle AssertionError and KeyboardInterrupt
611
# specially here, but hopefully they're handled ok by the logger now
612
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
613
if os.environ.get('BZR_PDB'):
614
print '**** entering debugger'
616
pdb.post_mortem(sys.exc_traceback)
1266
return run_bzr(argv)
1268
# do this here inside the exception wrappers to catch EPIPE
1271
quiet = isinstance(e, (BzrCommandError))
1272
_report_exception('error: ' + e.args[0], quiet=quiet)
1275
# some explanation or hints
1278
except AssertionError, e:
1279
msg = 'assertion failed'
1281
msg += ': ' + str(e)
1282
_report_exception(msg)
1284
except KeyboardInterrupt, e:
1285
_report_exception('interrupted', quiet=True)
1287
except Exception, e:
1289
if (isinstance(e, IOError)
1290
and hasattr(e, 'errno')
1291
and e.errno == errno.EPIPE):
1295
msg = str(e).rstrip('\n')
1296
_report_exception(msg, quiet)
1299
bzrlib.trace.close_trace()
619
1302
if __name__ == '__main__':
620
1303
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
