« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 805
- compare with another revision
- download diff
- download tarball
- view history from revision 805
- Committer: Martin Pool
- Date: 2005-06-29 04:11:40 UTC
- Revision ID: mbp@sourcefrog.net-20050629041140-6b17e65a23ffdf47
Merge John's log patch:
implements bzr log --forward --verbose
optimizes so that only logs to be printed are read (rather than reading
all and filtering out unwanted).
implements bzr log --forward --verbose
optimizes so that only logs to be printed are read (rather than reading
all and filtering out unwanted).
- files added:
- bzrlib/mdiff.py
- plugins/changeset
- plugins/rsync
- files removed:
- BRANCH.TODO
- bzrlib/export
- bzrlib/store
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- contrib/emacs
- tools
- files renamed:
- bzr_man.py => bzr-man.py
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/tests/ => bzrlib/selftest/
- bzrlib/tests/blackbox/test_too_much.py => bzrlib/selftest/blackbox.py
- bzrlib/tests/test_plugins.py => bzrlib/selftest/plugins.py
- bzrlib/tests/blackbox/test_versioning.py => bzrlib/selftest/versioning.py
- bzrlib/tests/test_whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/commands.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
20
21
# TODO: Help messages for options.
22
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
26
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
29
30
import sys
31
import os
32
from warnings import warn
33
from inspect import getdoc
34
import errno
18
19
import sys, os
35
20
36
21
import bzrlib
37
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
40
BzrCheckError,
41
BzrCommandError,
42
BzrOptionError,
43
NotBranchError)
44
from bzrlib.revisionspec import RevisionSpec
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
45
25
from bzrlib import BZRDIR
46
from bzrlib.option import Option
26
47
27
48
28
plugin_cmds = {}
49
29
50
30
51
def register_command(cmd, decorate=False):
31
def register_command(cmd):
52
32
"Utility function to help register a command"
53
33
global plugin_cmds
54
34
k = cmd.__name__
58
38
k_unsquished = k
59
39
if not plugin_cmds.has_key(k_unsquished):
60
40
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
64
elif decorate:
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
67
return result
68
41
else:
69
42
log_error('Two plugins defined the same command: %r' % k)
70
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
78
51
assert cmd.startswith("cmd_")
79
52
return cmd[4:].replace('_','-')
80
53
81
82
def _builtin_commands():
83
import bzrlib.builtins
84
r = {}
85
builtins = bzrlib.builtins.__dict__
86
for name in builtins:
87
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
90
return r
91
92
93
94
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
97
98
99
def plugin_command_names():
100
return plugin_cmds.keys()
54
def _parse_revision_str(revstr):
55
"""This handles a revision string -> revno.
56
57
There are several possibilities:
58
59
'234' -> 234
60
'234:345' -> [234, 345]
61
':234' -> [None, 234]
62
'234:' -> [234, None]
63
64
In the future we will also support:
65
'uuid:blah-blah-blah' -> ?
66
'hash:blahblahblah' -> ?
67
potentially:
68
'tag:mytag' -> ?
69
"""
70
if revstr.find(':') != -1:
71
revs = revstr.split(':')
72
if len(revs) > 2:
73
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
74
75
if not revs[0]:
76
revs[0] = None
77
else:
78
revs[0] = int(revs[0])
79
80
if not revs[1]:
81
revs[1] = None
82
else:
83
revs[1] = int(revs[1])
84
else:
85
revs = int(revstr)
86
return revs
87
101
88
102
89
103
90
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
91
d = {}
92
for k, v in globals().iteritems():
93
if k.startswith("cmd_"):
94
d[_unsquish_command_name(k)] = v
95
# If we didn't load plugins, the plugin_cmds dict will be empty
106
96
if plugins_override:
107
97
d.update(plugin_cmds)
98
else:
99
d2 = plugin_cmds.copy()
100
d2.update(d)
101
d = d2
108
102
return d
109
103
110
104
114
108
yield k,v
115
109
116
110
117
def get_cmd_object(cmd_name, plugins_override=True):
111
def get_cmd_class(cmd, plugins_override=True):
118
112
"""Return the canonical name and command class for a command.
119
120
plugins_override
121
If true, plugin commands can override builtins.
122
113
"""
123
from bzrlib.externalcommand import ExternalCommand
124
125
cmd_name = str(cmd_name) # not unicode
114
cmd = str(cmd) # not unicode
126
115
127
116
# first look up this command under the specified name
128
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
129
118
try:
130
return cmds[cmd_name]()
119
return cmd, cmds[cmd]
131
120
except KeyError:
132
121
pass
133
122
134
123
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
137
return cmd_class()
138
139
cmd_obj = ExternalCommand.find_command(cmd_name)
140
if cmd_obj:
141
return cmd_obj
142
143
raise BzrCommandError("unknown command %r" % cmd_name)
124
for cmdname, cmdclass in cmds.iteritems():
125
if cmd in cmdclass.aliases:
126
return cmdname, cmdclass
127
128
cmdclass = ExternalCommand.find_command(cmd)
129
if cmdclass:
130
return cmd, cmdclass
131
132
raise BzrCommandError("unknown command %r" % cmd)
144
133
145
134
146
135
class Command(object):
147
136
"""Base class for commands.
148
137
149
Commands are the heart of the command-line bzr interface.
150
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
153
into textual output.
154
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
159
160
138
The docstring for an actual command should give a single-line
161
139
summary, then a complete description of the command. A grammar
162
140
description will be inserted.
163
141
164
aliases
165
Other accepted names for this command.
166
167
142
takes_args
168
143
List of argument forms, marked with whether they are optional,
169
144
repeated, etc.
170
145
171
Examples:
172
173
['to_location', 'from_branch?', 'file*']
174
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
178
179
146
takes_options
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
147
List of options that may be given for this command.
183
148
184
149
hidden
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
150
If true, this command isn't advertised.
187
151
"""
188
152
aliases = []
153
189
154
takes_args = []
190
155
takes_options = []
191
156
192
157
hidden = False
193
158
194
def __init__(self):
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
198
199
def options(self):
200
"""Return dict of valid options for this command.
201
202
Maps from long option name to option object."""
203
r = dict()
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
208
r[o.name] = o
209
return r
210
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
217
return 0
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
220
for oname in opts:
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
226
cmdopts = {}
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
229
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
232
233
return self.run(**all_cmd_args)
159
def __init__(self, options, arguments):
160
"""Construct and run the command.
161
162
Sets self.status to the return value of run()."""
163
assert isinstance(options, dict)
164
assert isinstance(arguments, dict)
165
cmdargs = options.copy()
166
cmdargs.update(arguments)
167
assert self.__doc__ != Command.__doc__, \
168
("No help message set for %r" % self)
169
self.status = self.run(**cmdargs)
170
234
171
235
172
def run(self):
236
"""Actually run the command.
173
"""Override this in sub-classes.
237
174
238
175
This is invoked with the options and arguments bound to
239
176
keyword parameters.
240
177
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
178
Return 0 or None if the command was successful, or a shell
179
error code if not.
244
180
"""
245
raise NotImplementedError()
246
247
248
def help(self):
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
251
return None
252
return getdoc(self)
253
254
def name(self):
255
return _unsquish_command_name(self.__class__.__name__)
256
181
return 0
182
183
184
class ExternalCommand(Command):
185
"""Class to wrap external commands.
186
187
We cheat a little here, when get_cmd_class() calls us we actually give it back
188
an object we construct that has the appropriate path, help, options etc for the
189
specified command.
190
191
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
192
method, which we override to call the Command.__init__ method. That then calls
193
our run method which is pretty straight forward.
194
195
The only wrinkle is that we have to map bzr's dictionary of options and arguments
196
back into command line options and arguments for the script.
197
"""
198
199
def find_command(cls, cmd):
200
import os.path
201
bzrpath = os.environ.get('BZRPATH', '')
202
203
for dir in bzrpath.split(os.pathsep):
204
path = os.path.join(dir, cmd)
205
if os.path.isfile(path):
206
return ExternalCommand(path)
207
208
return None
209
210
find_command = classmethod(find_command)
211
212
def __init__(self, path):
213
self.path = path
214
215
pipe = os.popen('%s --bzr-usage' % path, 'r')
216
self.takes_options = pipe.readline().split()
217
218
for opt in self.takes_options:
219
if not opt in OPTIONS:
220
raise BzrError("Unknown option '%s' returned by external command %s"
221
% (opt, path))
222
223
# TODO: Is there any way to check takes_args is valid here?
224
self.takes_args = pipe.readline().split()
225
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
228
229
pipe = os.popen('%s --bzr-help' % path, 'r')
230
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
233
234
def __call__(self, options, arguments):
235
Command.__init__(self, options, arguments)
236
return self
237
238
def run(self, **kargs):
239
opts = []
240
args = []
241
242
keys = kargs.keys()
243
keys.sort()
244
for name in keys:
245
optname = name.replace('_','-')
246
value = kargs[name]
247
if OPTIONS.has_key(optname):
248
# it's an option
249
opts.append('--%s' % optname)
250
if value is not None and value is not True:
251
opts.append(str(value))
252
else:
253
# it's an arg, or arg list
254
if type(value) is not list:
255
value = [value]
256
for v in value:
257
if v is not None:
258
args.append(str(v))
259
260
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
261
return self.status
262
263
264
class cmd_status(Command):
265
"""Display status summary.
266
267
This reports on versioned and unknown files, reporting them
268
grouped by state. Possible states are:
269
270
added
271
Versioned in the working copy but not in the previous revision.
272
273
removed
274
Versioned in the previous revision but removed or deleted
275
in the working copy.
276
277
renamed
278
Path of this file changed from the previous revision;
279
the text may also have changed. This includes files whose
280
parent directory was renamed.
281
282
modified
283
Text has changed since the previous revision.
284
285
unchanged
286
Nothing about this file has changed since the previous revision.
287
Only shown with --all.
288
289
unknown
290
Not versioned and not matching an ignore pattern.
291
292
To see ignored files use 'bzr ignored'. For details in the
293
changes to file texts, use 'bzr diff'.
294
295
If no arguments are specified, the status of the entire working
296
directory is shown. Otherwise, only the status of the specified
297
files or directories is reported. If a directory is given, status
298
is reported for everything inside that directory.
299
"""
300
takes_args = ['file*']
301
takes_options = ['all', 'show-ids']
302
aliases = ['st', 'stat']
303
304
def run(self, all=False, show_ids=False, file_list=None):
305
if file_list:
306
b = find_branch(file_list[0])
307
file_list = [b.relpath(x) for x in file_list]
308
# special case: only one path was given and it's the root
309
# of the branch
310
if file_list == ['']:
311
file_list = None
312
else:
313
b = find_branch('.')
314
import status
315
status.show_status(b, show_unchanged=all, show_ids=show_ids,
316
specific_files=file_list)
317
318
319
class cmd_cat_revision(Command):
320
"""Write out metadata for a revision."""
321
322
hidden = True
323
takes_args = ['revision_id']
324
325
def run(self, revision_id):
326
from bzrlib.xml import pack_xml
327
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
328
329
330
class cmd_revno(Command):
331
"""Show current revision number.
332
333
This is equal to the number of revisions on this branch."""
334
def run(self):
335
print find_branch('.').revno()
336
337
338
class cmd_add(Command):
339
"""Add specified files or directories.
340
341
In non-recursive mode, all the named items are added, regardless
342
of whether they were previously ignored. A warning is given if
343
any of the named files are already versioned.
344
345
In recursive mode (the default), files are treated the same way
346
but the behaviour for directories is different. Directories that
347
are already versioned do not give a warning. All directories,
348
whether already versioned or not, are searched for files or
349
subdirectories that are neither versioned or ignored, and these
350
are added. This search proceeds recursively into versioned
351
directories.
352
353
Therefore simply saying 'bzr add .' will version all files that
354
are currently unknown.
355
356
TODO: Perhaps adding a file whose directly is not versioned should
357
recursively add that parent, rather than giving an error?
358
"""
359
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
361
362
def run(self, file_list, verbose=False, no_recurse=False):
363
from bzrlib.add import smart_add
364
smart_add(file_list, verbose, not no_recurse)
365
366
367
368
class cmd_mkdir(Command):
369
"""Create a new versioned directory.
370
371
This is equivalent to creating the directory and then adding it.
372
"""
373
takes_args = ['dir+']
374
375
def run(self, dir_list):
376
b = None
377
378
for d in dir_list:
379
os.mkdir(d)
380
if not b:
381
b = find_branch(d)
382
b.add([d], verbose=True)
383
384
385
class cmd_relpath(Command):
386
"""Show path of a file relative to root"""
387
takes_args = ['filename']
388
hidden = True
389
390
def run(self, filename):
391
print find_branch(filename).relpath(filename)
392
393
394
395
class cmd_inventory(Command):
396
"""Show inventory of the current working copy or a revision."""
397
takes_options = ['revision', 'show-ids']
398
399
def run(self, revision=None, show_ids=False):
400
b = find_branch('.')
401
if revision == None:
402
inv = b.read_working_inventory()
403
else:
404
inv = b.get_revision_inventory(b.lookup_revision(revision))
405
406
for path, entry in inv.entries():
407
if show_ids:
408
print '%-50s %s' % (path, entry.file_id)
409
else:
410
print path
411
412
413
class cmd_move(Command):
414
"""Move files to a different directory.
415
416
examples:
417
bzr move *.txt doc
418
419
The destination must be a versioned directory in the same branch.
420
"""
421
takes_args = ['source$', 'dest']
422
def run(self, source_list, dest):
423
b = find_branch('.')
424
425
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
426
427
428
class cmd_rename(Command):
429
"""Change the name of an entry.
430
431
examples:
432
bzr rename frob.c frobber.c
433
bzr rename src/frob.c lib/frob.c
434
435
It is an error if the destination name exists.
436
437
See also the 'move' command, which moves files into a different
438
directory without changing their name.
439
440
TODO: Some way to rename multiple files without invoking bzr for each
441
one?"""
442
takes_args = ['from_name', 'to_name']
443
444
def run(self, from_name, to_name):
445
b = find_branch('.')
446
b.rename_one(b.relpath(from_name), b.relpath(to_name))
447
448
449
450
451
452
class cmd_pull(Command):
453
"""Pull any changes from another branch into the current one.
454
455
If the location is omitted, the last-used location will be used.
456
Both the revision history and the working directory will be
457
updated.
458
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if both branches have had commits without first
461
pulling from the other.
462
463
If branches have diverged, you can use 'bzr merge' to pull the text changes
464
from one into the other.
465
"""
466
takes_args = ['location?']
467
468
def run(self, location=None):
469
from bzrlib.merge import merge
470
import tempfile
471
from shutil import rmtree
472
import errno
473
474
br_to = find_branch('.')
475
stored_loc = None
476
try:
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
478
except IOError, e:
479
if e.errno != errno.ENOENT:
480
raise
481
if location is None:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
484
else:
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
cache_root = tempfile.mkdtemp()
488
from bzrlib.branch import DivergedBranches
489
br_from = find_branch(location)
490
location = pull_loc(br_from)
491
old_revno = br_to.revno()
492
try:
493
from branch import find_cached_branch, DivergedBranches
494
br_from = find_cached_branch(location, cache_root)
495
location = pull_loc(br_from)
496
old_revno = br_to.revno()
497
try:
498
br_to.update_revisions(br_from)
499
except DivergedBranches:
500
raise BzrCommandError("These branches have diverged."
501
" Try merge.")
502
503
merge(('.', -1), ('.', old_revno), check_clean=False)
504
if location != stored_loc:
505
br_to.controlfile("x-pull", "wb").write(location + "\n")
506
finally:
507
rmtree(cache_root)
508
509
510
511
class cmd_branch(Command):
512
"""Create a new copy of a branch.
513
514
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
515
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
516
517
To retrieve the branch as of a particular revision, supply the --revision
518
parameter, as in "branch foo/bar -r 5".
519
"""
520
takes_args = ['from_location', 'to_location?']
521
takes_options = ['revision']
522
523
def run(self, from_location, to_location=None, revision=None):
524
import errno
525
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
527
find_cached_branch, Branch
528
from shutil import rmtree
529
from meta_store import CachedStore
530
import tempfile
531
cache_root = tempfile.mkdtemp()
532
try:
533
try:
534
br_from = find_cached_branch(from_location, cache_root)
535
except OSError, e:
536
if e.errno == errno.ENOENT:
537
raise BzrCommandError('Source location "%s" does not'
538
' exist.' % to_location)
539
else:
540
raise
541
542
if to_location is None:
543
to_location = os.path.basename(from_location.rstrip("/\\"))
544
545
try:
546
os.mkdir(to_location)
547
except OSError, e:
548
if e.errno == errno.EEXIST:
549
raise BzrCommandError('Target directory "%s" already'
550
' exists.' % to_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Parent of "%s" does not exist.' %
553
to_location)
554
else:
555
raise
556
br_to = Branch(to_location, init=True)
557
558
try:
559
br_to.update_revisions(br_from, stop_revision=revision)
560
except NoSuchRevision:
561
rmtree(to_location)
562
msg = "The branch %s has no revision %d." % (from_location,
563
revision)
564
raise BzrCommandError(msg)
565
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
check_clean=False, ignore_zero=True)
567
from_location = pull_loc(br_from)
568
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
569
finally:
570
rmtree(cache_root)
571
572
573
def pull_loc(branch):
574
# TODO: Should perhaps just make attribute be 'base' in
575
# RemoteBranch and Branch?
576
if hasattr(branch, "baseurl"):
577
return branch.baseurl
578
else:
579
return branch.base
580
581
582
583
class cmd_renames(Command):
584
"""Show list of renamed files.
585
586
TODO: Option to show renames between two historical versions.
587
588
TODO: Only show renames under dir, rather than in the whole branch.
589
"""
590
takes_args = ['dir?']
591
592
def run(self, dir='.'):
593
b = find_branch(dir)
594
old_inv = b.basis_tree().inventory
595
new_inv = b.read_working_inventory()
596
597
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
598
renames.sort()
599
for old_name, new_name in renames:
600
print "%s => %s" % (old_name, new_name)
601
602
603
class cmd_info(Command):
604
"""Show statistical information about a branch."""
605
takes_args = ['branch?']
606
607
def run(self, branch=None):
608
import info
609
610
b = find_branch(branch)
611
info.show_info(b)
612
613
614
class cmd_remove(Command):
615
"""Make a file unversioned.
616
617
This makes bzr stop tracking changes to a versioned file. It does
618
not delete the working copy.
619
"""
620
takes_args = ['file+']
621
takes_options = ['verbose']
622
623
def run(self, file_list, verbose=False):
624
b = find_branch(file_list[0])
625
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
626
627
628
class cmd_file_id(Command):
629
"""Print file_id of a particular file or directory.
630
631
The file_id is assigned when the file is first added and remains the
632
same through all revisions where the file exists, even when it is
633
moved or renamed.
634
"""
635
hidden = True
636
takes_args = ['filename']
637
def run(self, filename):
638
b = find_branch(filename)
639
i = b.inventory.path2id(b.relpath(filename))
640
if i == None:
641
raise BzrError("%r is not a versioned file" % filename)
642
else:
643
print i
644
645
646
class cmd_file_path(Command):
647
"""Print path of file_ids to a file or directory.
648
649
This prints one line for each directory down to the target,
650
starting at the branch root."""
651
hidden = True
652
takes_args = ['filename']
653
def run(self, filename):
654
b = find_branch(filename)
655
inv = b.inventory
656
fid = inv.path2id(b.relpath(filename))
657
if fid == None:
658
raise BzrError("%r is not a versioned file" % filename)
659
for fip in inv.get_idpath(fid):
660
print fip
661
662
663
class cmd_revision_history(Command):
664
"""Display list of revision ids on this branch."""
665
hidden = True
666
def run(self):
667
for patchid in find_branch('.').revision_history():
668
print patchid
669
670
671
class cmd_directories(Command):
672
"""Display list of versioned directories in this branch."""
673
def run(self):
674
for name, ie in find_branch('.').read_working_inventory().directories():
675
if name == '':
676
print '.'
677
else:
678
print name
679
680
681
class cmd_init(Command):
682
"""Make a directory into a versioned branch.
683
684
Use this to create an empty branch, or before importing an
685
existing project.
686
687
Recipe for importing a tree of files:
688
cd ~/project
689
bzr init
690
bzr add -v .
691
bzr status
692
bzr commit -m 'imported project'
693
"""
694
def run(self):
695
from bzrlib.branch import Branch
696
Branch('.', init=True)
697
698
699
class cmd_diff(Command):
700
"""Show differences in working tree.
701
702
If files are listed, only the changes in those files are listed.
703
Otherwise, all changes for the tree are listed.
704
705
TODO: Given two revision arguments, show the difference between them.
706
707
TODO: Allow diff across branches.
708
709
TODO: Option to use external diff command; could be GNU diff, wdiff,
710
or a graphical diff.
711
712
TODO: Python difflib is not exactly the same as unidiff; should
713
either fix it up or prefer to use an external diff.
714
715
TODO: If a directory is given, diff everything under that.
716
717
TODO: Selected-file diff is inefficient and doesn't show you
718
deleted files.
719
720
TODO: This probably handles non-Unix newlines poorly.
721
"""
722
723
takes_args = ['file*']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
726
727
def run(self, revision=None, file_list=None, diff_options=None):
728
from bzrlib.diff import show_diff
729
730
if file_list:
731
b = find_branch(file_list[0])
732
file_list = [b.relpath(f) for f in file_list]
733
if file_list == ['']:
734
# just pointing to top-of-tree
735
file_list = None
736
else:
737
b = find_branch('.')
738
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
741
742
743
744
745
746
class cmd_deleted(Command):
747
"""List files deleted in the working tree.
748
749
TODO: Show files deleted since a previous revision, or between two revisions.
750
"""
751
def run(self, show_ids=False):
752
b = find_branch('.')
753
old = b.basis_tree()
754
new = b.working_tree()
755
756
## TODO: Much more efficient way to do this: read in new
757
## directories with readdir, rather than stating each one. Same
758
## level of effort but possibly much less IO. (Or possibly not,
759
## if the directories are very large...)
760
761
for path, ie in old.inventory.iter_entries():
762
if not new.has_id(ie.file_id):
763
if show_ids:
764
print '%-50s %s' % (path, ie.file_id)
765
else:
766
print path
767
768
769
class cmd_modified(Command):
770
"""List files modified in working tree."""
771
hidden = True
772
def run(self):
773
import statcache
774
b = find_branch('.')
775
inv = b.read_working_inventory()
776
sc = statcache.update_cache(b, inv)
777
basis = b.basis_tree()
778
basis_inv = basis.inventory
779
780
# We used to do this through iter_entries(), but that's slow
781
# when most of the files are unmodified, as is usually the
782
# case. So instead we iterate by inventory entry, and only
783
# calculate paths as necessary.
784
785
for file_id in basis_inv:
786
cacheentry = sc.get(file_id)
787
if not cacheentry: # deleted
788
continue
789
ie = basis_inv[file_id]
790
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
791
path = inv.id2path(file_id)
792
print path
793
794
795
796
class cmd_added(Command):
797
"""List files added in working tree."""
798
hidden = True
799
def run(self):
800
b = find_branch('.')
801
wt = b.working_tree()
802
basis_inv = b.basis_tree().inventory
803
inv = wt.inventory
804
for file_id in inv:
805
if file_id in basis_inv:
806
continue
807
path = inv.id2path(file_id)
808
if not os.access(b.abspath(path), os.F_OK):
809
continue
810
print path
811
812
813
814
class cmd_root(Command):
815
"""Show the tree root directory.
816
817
The root is the nearest enclosing directory with a .bzr control
818
directory."""
819
takes_args = ['filename?']
820
def run(self, filename=None):
821
"""Print the branch root."""
822
b = find_branch(filename)
823
print getattr(b, 'base', None) or getattr(b, 'baseurl')
824
825
826
class cmd_log(Command):
827
"""Show log of this branch.
828
829
To request a range of logs, you can use the command -r begin:end
830
-r revision requests a specific revision, -r :end or -r begin: are
831
also valid.
832
833
TODO: Make --revision support uuid: and hash: [future tag:] notation.
834
835
"""
836
837
takes_args = ['filename?']
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
839
840
def run(self, filename=None, timezone='original',
841
verbose=False,
842
show_ids=False,
843
forward=False,
844
revision=None):
845
from bzrlib.branch import find_branch
846
from bzrlib.log import log_formatter, show_log
847
import codecs
848
849
direction = (forward and 'forward') or 'reverse'
850
851
if filename:
852
b = find_branch(filename)
853
fp = b.relpath(filename)
854
if fp:
855
file_id = b.read_working_inventory().path2id(fp)
856
else:
857
file_id = None # points to branch root
858
else:
859
b = find_branch('.')
860
file_id = None
861
862
if revision == None:
863
revision = [None, None]
864
elif isinstance(revision, int):
865
revision = [revision, revision]
866
else:
867
# pair of revisions?
868
pass
869
870
assert len(revision) == 2
871
872
mutter('encoding log as %r' % bzrlib.user_encoding)
873
874
# use 'replace' so that we don't abort if trying to write out
875
# in e.g. the default C locale.
876
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
877
878
lf = log_formatter('short',
879
show_ids=show_ids,
880
to_file=outf,
881
show_timezone=timezone)
882
883
show_log(b,
884
lf,
885
file_id,
886
verbose=verbose,
887
direction=direction,
888
start_revision=revision[0],
889
end_revision=revision[1])
890
891
892
893
class cmd_touching_revisions(Command):
894
"""Return revision-ids which affected a particular file.
895
896
A more user-friendly interface is "bzr log FILE"."""
897
hidden = True
898
takes_args = ["filename"]
899
def run(self, filename):
900
b = find_branch(filename)
901
inv = b.read_working_inventory()
902
file_id = inv.path2id(b.relpath(filename))
903
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
904
print "%6d %s" % (revno, what)
905
906
907
class cmd_ls(Command):
908
"""List files in a tree.
909
910
TODO: Take a revision or remote path and list that tree instead.
911
"""
912
hidden = True
913
def run(self, revision=None, verbose=False):
914
b = find_branch('.')
915
if revision == None:
916
tree = b.working_tree()
917
else:
918
tree = b.revision_tree(b.lookup_revision(revision))
919
920
for fp, fc, kind, fid in tree.list_files():
921
if verbose:
922
if kind == 'directory':
923
kindch = '/'
924
elif kind == 'file':
925
kindch = ''
926
else:
927
kindch = '???'
928
929
print '%-8s %s%s' % (fc, fp, kindch)
930
else:
931
print fp
932
933
934
935
class cmd_unknowns(Command):
936
"""List unknown files."""
937
def run(self):
938
from bzrlib.osutils import quotefn
939
for f in find_branch('.').unknowns():
940
print quotefn(f)
941
942
943
944
class cmd_ignore(Command):
945
"""Ignore a command or pattern.
946
947
To remove patterns from the ignore list, edit the .bzrignore file.
948
949
If the pattern contains a slash, it is compared to the whole path
950
from the branch root. Otherwise, it is comapred to only the last
951
component of the path.
952
953
Ignore patterns are case-insensitive on case-insensitive systems.
954
955
Note: wildcards must be quoted from the shell on Unix.
956
957
examples:
958
bzr ignore ./Makefile
959
bzr ignore '*.class'
960
"""
961
takes_args = ['name_pattern']
962
963
def run(self, name_pattern):
964
from bzrlib.atomicfile import AtomicFile
965
import os.path
966
967
b = find_branch('.')
968
ifn = b.abspath('.bzrignore')
969
970
if os.path.exists(ifn):
971
f = open(ifn, 'rt')
972
try:
973
igns = f.read().decode('utf-8')
974
finally:
975
f.close()
976
else:
977
igns = ''
978
979
# TODO: If the file already uses crlf-style termination, maybe
980
# we should use that for the newly added lines?
981
982
if igns and igns[-1] != '\n':
983
igns += '\n'
984
igns += name_pattern + '\n'
985
986
try:
987
f = AtomicFile(ifn, 'wt')
988
f.write(igns.encode('utf-8'))
989
f.commit()
990
finally:
991
f.close()
992
993
inv = b.working_tree().inventory
994
if inv.path2id('.bzrignore'):
995
mutter('.bzrignore is already versioned')
996
else:
997
mutter('need to make new .bzrignore file versioned')
998
b.add(['.bzrignore'])
999
1000
1001
1002
class cmd_ignored(Command):
1003
"""List ignored files and the patterns that matched them.
1004
1005
See also: bzr ignore"""
1006
def run(self):
1007
tree = find_branch('.').working_tree()
1008
for path, file_class, kind, file_id in tree.list_files():
1009
if file_class != 'I':
1010
continue
1011
## XXX: Slightly inefficient since this was already calculated
1012
pat = tree.is_ignored(path)
1013
print '%-50s %s' % (path, pat)
1014
1015
1016
class cmd_lookup_revision(Command):
1017
"""Lookup the revision-id from a revision-number
1018
1019
example:
1020
bzr lookup-revision 33
1021
"""
1022
hidden = True
1023
takes_args = ['revno']
1024
1025
def run(self, revno):
1026
try:
1027
revno = int(revno)
1028
except ValueError:
1029
raise BzrCommandError("not a valid revision-number: %r" % revno)
1030
1031
print find_branch('.').lookup_revision(revno)
1032
1033
1034
class cmd_export(Command):
1035
"""Export past revision to destination directory.
1036
1037
If no revision is specified this exports the last committed revision.
1038
1039
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1040
given, exports to a directory (equivalent to --format=dir)."""
1041
# TODO: list known exporters
1042
takes_args = ['dest']
1043
takes_options = ['revision', 'format']
1044
def run(self, dest, revision=None, format='dir'):
1045
b = find_branch('.')
1046
if revision == None:
1047
rh = b.revision_history()[-1]
1048
else:
1049
rh = b.lookup_revision(int(revision))
1050
t = b.revision_tree(rh)
1051
t.export(dest, format)
1052
1053
1054
class cmd_cat(Command):
1055
"""Write a file's text from a previous revision."""
1056
1057
takes_options = ['revision']
1058
takes_args = ['filename']
1059
1060
def run(self, filename, revision=None):
1061
if revision == None:
1062
raise BzrCommandError("bzr cat requires a revision number")
1063
b = find_branch('.')
1064
b.print_file(b.relpath(filename), int(revision))
1065
1066
1067
class cmd_local_time_offset(Command):
1068
"""Show the offset in seconds from GMT to local time."""
1069
hidden = True
1070
def run(self):
1071
print bzrlib.osutils.local_time_offset()
1072
1073
1074
1075
class cmd_commit(Command):
1076
"""Commit changes into a new revision.
1077
1078
If selected files are specified, only changes to those files are
1079
committed. If a directory is specified then its contents are also
1080
committed.
1081
1082
A selected-file commit may fail in some cases where the committed
1083
tree would be invalid, such as trying to commit a file in a
1084
newly-added directory that is not itself committed.
1085
1086
TODO: Run hooks on tree to-be-committed, and after commit.
1087
1088
TODO: Strict commit that fails if there are unknown or deleted files.
1089
"""
1090
takes_args = ['selected*']
1091
takes_options = ['message', 'file', 'verbose']
1092
aliases = ['ci', 'checkin']
1093
1094
def run(self, message=None, file=None, verbose=True, selected_list=None):
1095
from bzrlib.commit import commit
1096
from bzrlib.osutils import get_text_message
1097
1098
## Warning: shadows builtin file()
1099
if not message and not file:
1100
import cStringIO
1101
stdout = sys.stdout
1102
catcher = cStringIO.StringIO()
1103
sys.stdout = catcher
1104
cmd_status({"file_list":selected_list}, {})
1105
info = catcher.getvalue()
1106
sys.stdout = stdout
1107
message = get_text_message(info)
1108
1109
if message is None:
1110
raise BzrCommandError("please specify a commit message",
1111
["use either --message or --file"])
1112
elif message and file:
1113
raise BzrCommandError("please specify either --message or --file")
1114
1115
if file:
1116
import codecs
1117
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1118
1119
b = find_branch('.')
1120
commit(b, message, verbose=verbose, specific_files=selected_list)
1121
1122
1123
class cmd_check(Command):
1124
"""Validate consistency of branch history.
1125
1126
This command checks various invariants about the branch storage to
1127
detect data corruption or bzr bugs.
1128
1129
If given the --update flag, it will update some optional fields
1130
to help ensure data consistency.
1131
"""
1132
takes_args = ['dir?']
1133
1134
def run(self, dir='.'):
1135
from bzrlib.check import check
1136
check(find_branch(dir))
1137
1138
1139
1140
class cmd_upgrade(Command):
1141
"""Upgrade branch storage to current format.
1142
1143
This should normally be used only after the check command tells
1144
you to run it.
1145
"""
1146
takes_args = ['dir?']
1147
1148
def run(self, dir='.'):
1149
from bzrlib.upgrade import upgrade
1150
upgrade(find_branch(dir))
1151
1152
1153
1154
class cmd_whoami(Command):
1155
"""Show bzr user id."""
1156
takes_options = ['email']
1157
1158
def run(self, email=False):
1159
if email:
1160
print bzrlib.osutils.user_email()
1161
else:
1162
print bzrlib.osutils.username()
1163
1164
1165
class cmd_selftest(Command):
1166
"""Run internal test suite"""
1167
hidden = True
1168
def run(self):
1169
from bzrlib.selftest import selftest
1170
return int(not selftest())
1171
1172
1173
class cmd_version(Command):
1174
"""Show version of bzr."""
1175
def run(self):
1176
show_version()
1177
1178
def show_version():
1179
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1180
# is bzrlib itself in a branch?
1181
bzrrev = bzrlib.get_bzr_revision()
1182
if bzrrev:
1183
print " (bzr checkout, revision %d {%s})" % bzrrev
1184
print bzrlib.__copyright__
1185
print "http://bazaar-ng.org/"
1186
print
1187
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1188
print "you may use, modify and redistribute it under the terms of the GNU"
1189
print "General Public License version 2 or later."
1190
1191
1192
class cmd_rocks(Command):
1193
"""Statement of optimism."""
1194
hidden = True
1195
def run(self):
1196
print "it sure does!"
257
1197
258
1198
def parse_spec(spec):
259
1199
"""
265
1205
['..', -1]
266
1206
>>> parse_spec("../f/@35")
267
1207
['../f', 35]
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
270
1208
"""
271
1209
if spec is None:
272
1210
return [None, None]
276
1214
if parsed[1] == "":
277
1215
parsed[1] = -1
278
1216
else:
279
try:
280
parsed[1] = int(parsed[1])
281
except ValueError:
282
pass # We can allow stuff like ./@revid:blahblahblah
283
else:
284
assert parsed[1] >=0
1217
parsed[1] = int(parsed[1])
1218
assert parsed[1] >=0
285
1219
else:
286
1220
parsed = [spec, None]
287
1221
return parsed
288
1222
289
def parse_args(command, argv):
1223
1224
1225
class cmd_merge(Command):
1226
"""Perform a three-way merge of trees.
1227
1228
The SPEC parameters are working tree or revision specifiers. Working trees
1229
are specified using standard paths or urls. No component of a directory
1230
path may begin with '@'.
1231
1232
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1233
1234
Revisions are specified using a dirname/@revno pair, where dirname is the
1235
branch directory and revno is the revision within that branch. If no revno
1236
is specified, the latest revision is used.
1237
1238
Revision examples: './@127', 'foo/@', '../@1'
1239
1240
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1241
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1242
as the BASE.
1243
1244
merge refuses to run if there are any uncommitted changes, unless
1245
--force is given.
1246
"""
1247
takes_args = ['other_spec', 'base_spec?']
1248
takes_options = ['force']
1249
1250
def run(self, other_spec, base_spec=None, force=False):
1251
from bzrlib.merge import merge
1252
merge(parse_spec(other_spec), parse_spec(base_spec),
1253
check_clean=(not force))
1254
1255
1256
1257
class cmd_revert(Command):
1258
"""Restore selected files from a previous revision.
1259
"""
1260
takes_args = ['file+']
1261
def run(self, file_list):
1262
from bzrlib.branch import find_branch
1263
1264
if not file_list:
1265
file_list = ['.']
1266
1267
b = find_branch(file_list[0])
1268
1269
b.revert([b.relpath(f) for f in file_list])
1270
1271
1272
class cmd_merge_revert(Command):
1273
"""Reverse all changes since the last commit.
1274
1275
Only versioned files are affected.
1276
1277
TODO: Store backups of any files that will be reverted, so
1278
that the revert can be undone.
1279
"""
1280
takes_options = ['revision']
1281
1282
def run(self, revision=-1):
1283
from bzrlib.merge import merge
1284
merge(('.', revision), parse_spec('.'),
1285
check_clean=False,
1286
ignore_zero=True)
1287
1288
1289
class cmd_assert_fail(Command):
1290
"""Test reporting of assertion failures"""
1291
hidden = True
1292
def run(self):
1293
assert False, "always fails"
1294
1295
1296
class cmd_help(Command):
1297
"""Show help on a command or other topic.
1298
1299
For a list of all available commands, say 'bzr help commands'."""
1300
takes_args = ['topic?']
1301
aliases = ['?']
1302
1303
def run(self, topic=None):
1304
import help
1305
help.help(topic)
1306
1307
1308
class cmd_update_stat_cache(Command):
1309
"""Update stat-cache mapping inodes to SHA-1 hashes.
1310
1311
For testing only."""
1312
hidden = True
1313
def run(self):
1314
import statcache
1315
b = find_branch('.')
1316
statcache.update_cache(b.base, b.read_working_inventory())
1317
1318
1319
1320
class cmd_plugins(Command):
1321
"""List plugins"""
1322
hidden = True
1323
def run(self):
1324
import bzrlib.plugin
1325
from pprint import pprint
1326
pprint(bzrlib.plugin.all_plugins)
1327
1328
1329
1330
# list of all available options; the rhs can be either None for an
1331
# option that takes no argument, or a constructor function that checks
1332
# the type.
1333
OPTIONS = {
1334
'all': None,
1335
'diff-options': str,
1336
'help': None,
1337
'file': unicode,
1338
'force': None,
1339
'format': unicode,
1340
'forward': None,
1341
'message': unicode,
1342
'no-recurse': None,
1343
'profile': None,
1344
'revision': _parse_revision_str,
1345
'show-ids': None,
1346
'timezone': str,
1347
'verbose': None,
1348
'version': None,
1349
'email': None,
1350
'update': None,
1351
}
1352
1353
SHORT_OPTIONS = {
1354
'F': 'file',
1355
'h': 'help',
1356
'm': 'message',
1357
'r': 'revision',
1358
'v': 'verbose',
1359
}
1360
1361
1362
def parse_args(argv):
290
1363
"""Parse command line.
291
1364
292
1365
Arguments and options are parsed at this level before being passed
293
1366
down to specific command handlers. This routine knows, from a
294
1367
lookup table, something about the available options, what optargs
295
1368
they take, and which commands will accept them.
1369
1370
>>> parse_args('--help'.split())
1371
([], {'help': True})
1372
>>> parse_args('--version'.split())
1373
([], {'version': True})
1374
>>> parse_args('status --all'.split())
1375
(['status'], {'all': True})
1376
>>> parse_args('commit --message=biter'.split())
1377
(['commit'], {'message': u'biter'})
1378
>>> parse_args('log -r 500'.split())
1379
(['log'], {'revision': 500})
1380
>>> parse_args('log -r500:600'.split())
1381
(['log'], {'revision': [500, 600]})
1382
>>> parse_args('log -vr500:600'.split())
1383
(['log'], {'verbose': True, 'revision': [500, 600]})
1384
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1385
Traceback (most recent call last):
1386
...
1387
ValueError: invalid literal for int(): v500
296
1388
"""
297
# TODO: chop up this beast; make it a method of the Command
298
1389
args = []
299
1390
opts = {}
300
1391
301
cmd_options = command.options()
302
argsover = False
1392
# TODO: Maybe handle '--' to end options?
1393
303
1394
while argv:
304
1395
a = argv.pop(0)
305
if argsover:
306
args.append(a)
307
continue
308
elif a == '--':
309
# We've received a standalone -- No more flags
310
argsover = True
311
continue
312
1396
if a[0] == '-':
313
1397
# option names must not be unicode
314
1398
a = str(a)
315
1399
optarg = None
316
1400
if a[1] == '-':
317
mutter(" got option %r", a)
1401
mutter(" got option %r" % a)
318
1402
if '=' in a:
319
1403
optname, optarg = a[2:].split('=', 1)
320
1404
else:
321
1405
optname = a[2:]
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
1406
if optname not in OPTIONS:
1407
raise BzrError('unknown long option %r' % a)
325
1408
else:
326
1409
shortopt = a[1:]
327
if shortopt in Option.SHORT_OPTIONS:
1410
if shortopt in SHORT_OPTIONS:
328
1411
# Multi-character options must have a space to delimit
329
1412
# their value
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
1413
optname = SHORT_OPTIONS[shortopt]
332
1414
else:
333
1415
# Single character short options, can be chained,
334
1416
# and have their value appended to their name
335
1417
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
1418
if shortopt not in SHORT_OPTIONS:
337
1419
# We didn't find the multi-character name, and we
338
1420
# didn't find the single char name
339
1421
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
1422
optname = SHORT_OPTIONS[shortopt]
341
1423
342
1424
if a[2:]:
343
1425
# There are extra things on this option
344
1426
# see if it is the value, or if it is another
345
1427
# short option
346
optargfn = Option.OPTIONS[optname].type
1428
optargfn = OPTIONS[optname]
347
1429
if optargfn is None:
348
1430
# This option does not take an argument, so the
349
1431
# next entry is another short option, pack it back
354
1436
# into the array
355
1437
optarg = a[2:]
356
1438
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
360
1439
if optname in opts:
361
1440
# XXX: Do we ever want to support this, e.g. for -r?
362
1441
raise BzrError('repeated option %r' % a)
363
1442
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
1443
optargfn = OPTIONS[optname]
366
1444
if optargfn:
367
1445
if optarg == None:
368
1446
if not argv:
376
1454
opts[optname] = True
377
1455
else:
378
1456
args.append(a)
1457
379
1458
return args, opts
380
1459
381
1460
1461
1462
382
1463
def _match_argform(cmd, takes_args, args):
383
1464
argdict = {}
384
1465
423
1504
return argdict
424
1505
425
1506
426
427
def apply_profiled(the_callable, *args, **kwargs):
428
import hotshot
429
import tempfile
430
import hotshot.stats
431
pffileno, pfname = tempfile.mkstemp()
432
try:
433
prof = hotshot.Profile(pfname)
434
try:
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
436
finally:
437
prof.close()
438
stats = hotshot.stats.load(pfname)
439
stats.strip_dirs()
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
444
return ret
445
finally:
446
os.close(pffileno)
447
os.remove(pfname)
448
449
450
def apply_lsprofiled(the_callable, *args, **kwargs):
451
from bzrlib.lsprof import profile
452
ret,stats = profile(the_callable,*args,**kwargs)
453
stats.sort()
454
stats.pprint()
455
return ret
1507
def _parse_master_args(argv):
1508
"""Parse the arguments that always go with the original command.
1509
These are things like bzr --no-plugins, etc.
1510
1511
There are now 2 types of option flags. Ones that come *before* the command,
1512
and ones that come *after* the command.
1513
Ones coming *before* the command are applied against all possible commands.
1514
And are generally applied before plugins are loaded.
1515
1516
The current list are:
1517
--builtin Allow plugins to load, but don't let them override builtin commands,
1518
they will still be allowed if they do not override a builtin.
1519
--no-plugins Don't load any plugins. This lets you get back to official source
1520
behavior.
1521
--profile Enable the hotspot profile before running the command.
1522
For backwards compatibility, this is also a non-master option.
1523
--version Spit out the version of bzr that is running and exit.
1524
This is also a non-master option.
1525
--help Run help and exit, also a non-master option (I think that should stay, though)
1526
1527
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1528
Traceback (most recent call last):
1529
...
1530
BzrCommandError: Invalid master option: 'test'
1531
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1532
>>> print argv
1533
['command']
1534
>>> print opts['version']
1535
True
1536
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1537
>>> print argv
1538
['command', '--more-options']
1539
>>> print opts['profile']
1540
True
1541
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1542
>>> print argv
1543
['command']
1544
>>> print opts['no-plugins']
1545
True
1546
>>> print opts['profile']
1547
False
1548
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1549
>>> print argv
1550
['command', '--profile']
1551
>>> print opts['profile']
1552
False
1553
"""
1554
master_opts = {'builtin':False,
1555
'no-plugins':False,
1556
'version':False,
1557
'profile':False,
1558
'help':False
1559
}
1560
1561
# This is the point where we could hook into argv[0] to determine
1562
# what front-end is supposed to be run
1563
# For now, we are just ignoring it.
1564
cmd_name = argv.pop(0)
1565
for arg in argv[:]:
1566
if arg[:2] != '--': # at the first non-option, we return the rest
1567
break
1568
arg = arg[2:] # Remove '--'
1569
if arg not in master_opts:
1570
# We could say that this is not an error, that we should
1571
# just let it be handled by the main section instead
1572
raise BzrCommandError('Invalid master option: %r' % arg)
1573
argv.pop(0) # We are consuming this entry
1574
master_opts[arg] = True
1575
return argv, master_opts
1576
1577
456
1578
457
1579
def run_bzr(argv):
458
1580
"""Execute a command.
459
1581
460
1582
This is similar to main(), but without all the trappings for
461
1583
logging and error handling.
462
463
argv
464
The command-line arguments, without the program name from argv[0]
465
466
Returns a command status or raises an exception.
467
468
Special master options: these must come before the command because
469
they control how the command is interpreted.
470
471
--no-plugins
472
Do not load plugin modules at all
473
474
--builtin
475
Only use builtin commands. (Plugins are still allowed to change
476
other behaviour.)
477
478
--profile
479
Run under the Python hotshot profiler.
480
481
--lsprof
482
Run under the Python lsprof profiler.
483
1584
"""
484
1585
argv = [a.decode(bzrlib.user_encoding) for a in argv]
485
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
487
488
# --no-plugins is handled specially at a very early stage. We need
489
# to load plugins before doing other command parsing so that they
490
# can override commands, but this needs to happen first.
491
492
for a in argv:
493
if a == '--profile':
494
opt_profile = True
495
elif a == '--lsprof':
496
opt_lsprof = True
497
elif a == '--no-plugins':
498
opt_no_plugins = True
499
elif a == '--builtin':
500
opt_builtin = True
501
elif a in ('--quiet', '-q'):
502
be_quiet()
503
else:
504
continue
505
argv.remove(a)
506
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
509
if len(argv) > 1:
510
help(argv[1])
511
else:
512
help()
513
return 0
514
515
if argv[0] == '--version':
516
from bzrlib.builtins import show_version
517
show_version()
518
return 0
519
520
if not opt_no_plugins:
521
from bzrlib.plugin import load_plugins
522
load_plugins()
523
524
cmd = str(argv.pop(0))
525
526
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
527
1586
528
1587
try:
529
if opt_lsprof:
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
531
elif opt_profile:
532
ret = apply_profiled(cmd_obj.run_argv, argv)
533
else:
534
ret = cmd_obj.run_argv(argv)
535
return ret or 0
536
finally:
537
# reset, in case we may do other commands later within the same process
538
be_quiet(False)
539
540
def display_command(func):
541
"""Decorator that suppresses pipe/interrupt errors."""
542
def ignore_pipe(*args, **kwargs):
1588
# some options like --builtin and --no-plugins have special effects
1589
argv, master_opts = _parse_master_args(argv)
1590
if not master_opts['no-plugins']:
1591
from bzrlib.plugin import load_plugins
1592
load_plugins()
1593
1594
args, opts = parse_args(argv)
1595
1596
if master_opts['help']:
1597
from bzrlib.help import help
1598
if argv:
1599
help(argv[0])
1600
else:
1601
help()
1602
return 0
1603
1604
if 'help' in opts:
1605
from bzrlib.help import help
1606
if args:
1607
help(args[0])
1608
else:
1609
help()
1610
return 0
1611
elif 'version' in opts:
1612
show_version()
1613
return 0
1614
elif args and args[0] == 'builtin':
1615
include_plugins=False
1616
args = args[1:]
1617
cmd = str(args.pop(0))
1618
except IndexError:
1619
import help
1620
help.help()
1621
return 1
1622
1623
1624
plugins_override = not (master_opts['builtin'])
1625
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1626
1627
profile = master_opts['profile']
1628
# For backwards compatibility, I would rather stick with --profile being a
1629
# master/global option
1630
if 'profile' in opts:
1631
profile = True
1632
del opts['profile']
1633
1634
# check options are reasonable
1635
allowed = cmd_class.takes_options
1636
for oname in opts:
1637
if oname not in allowed:
1638
raise BzrCommandError("option '--%s' is not allowed for command %r"
1639
% (oname, cmd))
1640
1641
# mix arguments and options into one dictionary
1642
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1643
cmdopts = {}
1644
for k, v in opts.items():
1645
cmdopts[k.replace('-', '_')] = v
1646
1647
if profile:
1648
import hotshot, tempfile
1649
pffileno, pfname = tempfile.mkstemp()
543
1650
try:
544
result = func(*args, **kwargs)
545
sys.stdout.flush()
546
return result
547
except IOError, e:
548
if not hasattr(e, 'errno'):
549
raise
550
if e.errno != errno.EPIPE:
551
raise
552
pass
553
except KeyboardInterrupt:
554
pass
555
return ignore_pipe
1651
prof = hotshot.Profile(pfname)
1652
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1653
prof.close()
1654
1655
import hotshot.stats
1656
stats = hotshot.stats.load(pfname)
1657
#stats.strip_dirs()
1658
stats.sort_stats('time')
1659
## XXX: Might like to write to stderr or the trace file instead but
1660
## print_stats seems hardcoded to stdout
1661
stats.print_stats(20)
1662
1663
return ret.status
1664
1665
finally:
1666
os.close(pffileno)
1667
os.remove(pfname)
1668
else:
1669
return cmd_class(cmdopts, cmdargs).status
1670
1671
1672
def _report_exception(summary, quiet=False):
1673
import traceback
1674
log_error('bzr: ' + summary)
1675
bzrlib.trace.log_exception()
1676
1677
if not quiet:
1678
tb = sys.exc_info()[2]
1679
exinfo = traceback.extract_tb(tb)
1680
if exinfo:
1681
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1682
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1683
556
1684
557
1685
558
1686
def main(argv):
559
import bzrlib.ui
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
563
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
566
return ret
567
568
569
def run_bzr_catch_errors(argv):
1687
1688
bzrlib.trace.open_tracefile(argv)
1689
570
1690
try:
571
1691
try:
572
return run_bzr(argv)
573
finally:
574
# do this here inside the exception wrappers to catch EPIPE
575
sys.stdout.flush()
576
except Exception, e:
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
579
import errno
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
584
return 3
585
else:
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
589
import pdb
590
pdb.post_mortem(sys.exc_traceback)
591
return 3
1692
try:
1693
return run_bzr(argv)
1694
finally:
1695
# do this here inside the exception wrappers to catch EPIPE
1696
sys.stdout.flush()
1697
except BzrError, e:
1698
quiet = isinstance(e, (BzrCommandError))
1699
_report_exception('error: ' + e.args[0], quiet=quiet)
1700
if len(e.args) > 1:
1701
for h in e.args[1]:
1702
# some explanation or hints
1703
log_error(' ' + h)
1704
return 1
1705
except AssertionError, e:
1706
msg = 'assertion failed'
1707
if str(e):
1708
msg += ': ' + str(e)
1709
_report_exception(msg)
1710
return 2
1711
except KeyboardInterrupt, e:
1712
_report_exception('interrupted', quiet=True)
1713
return 2
1714
except Exception, e:
1715
import errno
1716
quiet = False
1717
if (isinstance(e, IOError)
1718
and hasattr(e, 'errno')
1719
and e.errno == errno.EPIPE):
1720
quiet = True
1721
msg = 'broken pipe'
1722
else:
1723
msg = str(e).rstrip('\n')
1724
_report_exception(msg, quiet)
1725
return 2
1726
finally:
1727
bzrlib.trace.close_trace()
1728
592
1729
593
1730
if __name__ == '__main__':
594
1731
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1