« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 895
- compare with another revision
- download diff
- download tarball
- view history from revision 895
- Committer: Martin Pool
- Date: 2005-07-11 05:46:55 UTC
- Revision ID: mbp@sourcefrog.net-20050711054655-47ea25e1f75a8813
- ignore tmp dir
- files added:
- plugins/changeset
- files removed:
- HACKING
- bzrlib/util
- contrib/emacs
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/selftest/test_weave.py => tools/testweave.py
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
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
28
29
import sys
30
import os
31
from warnings import warn
32
from inspect import getdoc
18
19
import sys, os
33
20
34
21
import bzrlib
35
import bzrlib.trace
36
from bzrlib.trace import mutter, note, log_error, warning
22
from bzrlib.trace import mutter, note, log_error
37
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
24
from bzrlib.branch import find_branch
39
25
from bzrlib import BZRDIR
40
26
27
41
28
plugin_cmds = {}
42
29
43
30
51
38
k_unsquished = k
52
39
if not plugin_cmds.has_key(k_unsquished):
53
40
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
55
41
else:
56
42
log_error('Two plugins defined the same command: %r' % k)
57
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
65
51
assert cmd.startswith("cmd_")
66
52
return cmd[4:].replace('_','-')
67
53
68
69
54
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
71
72
This always returns a list. The list will have one element for
73
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
76
77
>>> _parse_revision_str('234')
78
[234]
79
>>> _parse_revision_str('234..567')
80
[234, 567]
81
>>> _parse_revision_str('..')
82
[None, None]
83
>>> _parse_revision_str('..234')
84
[None, 234]
85
>>> _parse_revision_str('234..')
86
[234, None]
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
88
[234, 456, 789]
89
>>> _parse_revision_str('234....789') # Error?
90
[234, None, 789]
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
98
['date:2005-04-12']
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
106
[-5, 23]
107
>>> _parse_revision_str('-5')
108
[-5]
109
>>> _parse_revision_str('123a')
110
['123a']
111
>>> _parse_revision_str('abc')
112
['abc']
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' -> ?
113
69
"""
114
import re
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
117
if m:
118
warning('Colon separator for revision numbers is deprecated.'
119
' Use .. instead')
120
revs = []
121
for rev in revstr.split(':'):
122
if rev:
123
revs.append(int(rev))
124
else:
125
revs.append(None)
126
return revs
127
revs = []
128
for x in revstr.split('..'):
129
if not x:
130
revs.append(None)
131
else:
132
try:
133
revs.append(int(x))
134
except ValueError:
135
revs.append(x)
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)
136
86
return revs
137
87
138
88
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
142
try:
143
return merge_types[typestring][0]
144
except KeyError:
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
151
152
153
def _builtin_commands():
154
import bzrlib.builtins
155
r = {}
156
builtins = bzrlib.builtins.__dict__
157
for name in builtins:
158
if name.startswith("cmd_"):
159
real_name = _unsquish_command_name(name)
160
r[real_name] = builtins[name]
161
return r
162
163
164
165
def builtin_command_names():
166
"""Return list of builtin command names."""
167
return _builtin_commands().keys()
168
169
170
def plugin_command_names():
171
return plugin_cmds.keys()
172
173
89
174
90
def _get_cmd_dict(plugins_override=True):
175
"""Return name->class mapping for all commands."""
176
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
177
96
if plugins_override:
178
97
d.update(plugin_cmds)
98
else:
99
d2 = plugin_cmds.copy()
100
d2.update(d)
101
d = d2
179
102
return d
180
103
181
104
185
108
yield k,v
186
109
187
110
188
def get_cmd_object(cmd_name, plugins_override=True):
111
def get_cmd_class(cmd, plugins_override=True):
189
112
"""Return the canonical name and command class for a command.
190
191
plugins_override
192
If true, plugin commands can override builtins.
193
113
"""
194
from bzrlib.externalcommand import ExternalCommand
195
196
cmd_name = str(cmd_name) # not unicode
114
cmd = str(cmd) # not unicode
197
115
198
116
# first look up this command under the specified name
199
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
200
118
try:
201
return cmds[cmd_name]()
119
return cmd, cmds[cmd]
202
120
except KeyError:
203
121
pass
204
122
205
123
# look for any command which claims this as an alias
206
for real_cmd_name, cmd_class in cmds.iteritems():
207
if cmd_name in cmd_class.aliases:
208
return cmd_class()
209
210
cmd_obj = ExternalCommand.find_command(cmd_name)
211
if cmd_obj:
212
return cmd_obj
213
214
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)
215
133
216
134
217
135
class Command(object):
218
136
"""Base class for commands.
219
137
220
Commands are the heart of the command-line bzr interface.
221
222
The command object mostly handles the mapping of command-line
223
parameters into one or more bzrlib operations, and of the results
224
into textual output.
225
226
Commands normally don't have any state. All their arguments are
227
passed in to the run method. (Subclasses may take a different
228
policy if the behaviour of the instance needs to depend on e.g. a
229
shell plugin and not just its Python class.)
230
231
138
The docstring for an actual command should give a single-line
232
139
summary, then a complete description of the command. A grammar
233
140
description will be inserted.
234
141
235
aliases
236
Other accepted names for this command.
237
238
142
takes_args
239
143
List of argument forms, marked with whether they are optional,
240
144
repeated, etc.
243
147
List of options that may be given for this command.
244
148
245
149
hidden
246
If true, this command isn't advertised. This is typically
247
for commands intended for expert users.
150
If true, this command isn't advertised.
248
151
"""
249
152
aliases = []
250
153
253
156
254
157
hidden = False
255
158
256
def __init__(self):
257
"""Construct an instance of this command."""
258
if self.__doc__ == Command.__doc__:
259
warn("No help message set for %r" % self)
260
261
262
def run_argv(self, argv):
263
"""Parse command line and run."""
264
args, opts = parse_args(argv)
265
266
if 'help' in opts: # e.g. bzr add --help
267
from bzrlib.help import help_on_command
268
help_on_command(self.name())
269
return 0
270
271
# check options are reasonable
272
allowed = self.takes_options
273
for oname in opts:
274
if oname not in allowed:
275
raise BzrCommandError("option '--%s' is not allowed for command %r"
276
% (oname, self.name()))
277
278
# mix arguments and options into one dictionary
279
cmdargs = _match_argform(self.name(), self.takes_args, args)
280
cmdopts = {}
281
for k, v in opts.items():
282
cmdopts[k.replace('-', '_')] = v
283
284
all_cmd_args = cmdargs.copy()
285
all_cmd_args.update(cmdopts)
286
287
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)
288
170
289
171
290
172
def run(self):
291
"""Actually run the command.
173
"""Override this in sub-classes.
292
174
293
175
This is invoked with the options and arguments bound to
294
176
keyword parameters.
295
177
296
Return 0 or None if the command was successful, or a non-zero
297
shell error code if not. It's OK for this method to allow
298
an exception to raise up.
178
Return 0 or None if the command was successful, or a shell
179
error code if not.
299
180
"""
300
raise NotImplementedError()
301
302
303
def help(self):
304
"""Return help message for this class."""
305
if self.__doc__ is Command.__doc__:
306
return None
307
return getdoc(self)
308
309
def name(self):
310
return _unsquish_command_name(self.__class__.__name__)
311
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
from bzrlib.diff import compare_trees
774
775
b = find_branch('.')
776
td = compare_trees(b.basis_tree(), b.working_tree())
777
778
for path, id, kind in td.modified:
779
print path
780
781
782
783
class cmd_added(Command):
784
"""List files added in working tree."""
785
hidden = True
786
def run(self):
787
b = find_branch('.')
788
wt = b.working_tree()
789
basis_inv = b.basis_tree().inventory
790
inv = wt.inventory
791
for file_id in inv:
792
if file_id in basis_inv:
793
continue
794
path = inv.id2path(file_id)
795
if not os.access(b.abspath(path), os.F_OK):
796
continue
797
print path
798
799
800
801
class cmd_root(Command):
802
"""Show the tree root directory.
803
804
The root is the nearest enclosing directory with a .bzr control
805
directory."""
806
takes_args = ['filename?']
807
def run(self, filename=None):
808
"""Print the branch root."""
809
b = find_branch(filename)
810
print getattr(b, 'base', None) or getattr(b, 'baseurl')
811
812
813
class cmd_log(Command):
814
"""Show log of this branch.
815
816
To request a range of logs, you can use the command -r begin:end
817
-r revision requests a specific revision, -r :end or -r begin: are
818
also valid.
819
820
TODO: Make --revision support uuid: and hash: [future tag:] notation.
821
822
"""
823
824
takes_args = ['filename?']
825
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
826
827
def run(self, filename=None, timezone='original',
828
verbose=False,
829
show_ids=False,
830
forward=False,
831
revision=None,
832
long=False):
833
from bzrlib.branch import find_branch
834
from bzrlib.log import log_formatter, show_log
835
import codecs
836
837
direction = (forward and 'forward') or 'reverse'
838
839
if filename:
840
b = find_branch(filename)
841
fp = b.relpath(filename)
842
if fp:
843
file_id = b.read_working_inventory().path2id(fp)
844
else:
845
file_id = None # points to branch root
846
else:
847
b = find_branch('.')
848
file_id = None
849
850
if revision == None:
851
revision = [None, None]
852
elif isinstance(revision, int):
853
revision = [revision, revision]
854
else:
855
# pair of revisions?
856
pass
857
858
assert len(revision) == 2
859
860
mutter('encoding log as %r' % bzrlib.user_encoding)
861
862
# use 'replace' so that we don't abort if trying to write out
863
# in e.g. the default C locale.
864
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
865
866
if long:
867
log_format = 'long'
868
else:
869
log_format = 'short'
870
lf = log_formatter(log_format,
871
show_ids=show_ids,
872
to_file=outf,
873
show_timezone=timezone)
874
875
show_log(b,
876
lf,
877
file_id,
878
verbose=verbose,
879
direction=direction,
880
start_revision=revision[0],
881
end_revision=revision[1])
882
883
884
885
class cmd_touching_revisions(Command):
886
"""Return revision-ids which affected a particular file.
887
888
A more user-friendly interface is "bzr log FILE"."""
889
hidden = True
890
takes_args = ["filename"]
891
def run(self, filename):
892
b = find_branch(filename)
893
inv = b.read_working_inventory()
894
file_id = inv.path2id(b.relpath(filename))
895
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
896
print "%6d %s" % (revno, what)
897
898
899
class cmd_ls(Command):
900
"""List files in a tree.
901
902
TODO: Take a revision or remote path and list that tree instead.
903
"""
904
hidden = True
905
def run(self, revision=None, verbose=False):
906
b = find_branch('.')
907
if revision == None:
908
tree = b.working_tree()
909
else:
910
tree = b.revision_tree(b.lookup_revision(revision))
911
912
for fp, fc, kind, fid in tree.list_files():
913
if verbose:
914
if kind == 'directory':
915
kindch = '/'
916
elif kind == 'file':
917
kindch = ''
918
else:
919
kindch = '???'
920
921
print '%-8s %s%s' % (fc, fp, kindch)
922
else:
923
print fp
924
925
926
927
class cmd_unknowns(Command):
928
"""List unknown files."""
929
def run(self):
930
from bzrlib.osutils import quotefn
931
for f in find_branch('.').unknowns():
932
print quotefn(f)
933
934
935
936
class cmd_ignore(Command):
937
"""Ignore a command or pattern.
938
939
To remove patterns from the ignore list, edit the .bzrignore file.
940
941
If the pattern contains a slash, it is compared to the whole path
942
from the branch root. Otherwise, it is comapred to only the last
943
component of the path.
944
945
Ignore patterns are case-insensitive on case-insensitive systems.
946
947
Note: wildcards must be quoted from the shell on Unix.
948
949
examples:
950
bzr ignore ./Makefile
951
bzr ignore '*.class'
952
"""
953
takes_args = ['name_pattern']
954
955
def run(self, name_pattern):
956
from bzrlib.atomicfile import AtomicFile
957
import os.path
958
959
b = find_branch('.')
960
ifn = b.abspath('.bzrignore')
961
962
if os.path.exists(ifn):
963
f = open(ifn, 'rt')
964
try:
965
igns = f.read().decode('utf-8')
966
finally:
967
f.close()
968
else:
969
igns = ''
970
971
# TODO: If the file already uses crlf-style termination, maybe
972
# we should use that for the newly added lines?
973
974
if igns and igns[-1] != '\n':
975
igns += '\n'
976
igns += name_pattern + '\n'
977
978
try:
979
f = AtomicFile(ifn, 'wt')
980
f.write(igns.encode('utf-8'))
981
f.commit()
982
finally:
983
f.close()
984
985
inv = b.working_tree().inventory
986
if inv.path2id('.bzrignore'):
987
mutter('.bzrignore is already versioned')
988
else:
989
mutter('need to make new .bzrignore file versioned')
990
b.add(['.bzrignore'])
991
992
993
994
class cmd_ignored(Command):
995
"""List ignored files and the patterns that matched them.
996
997
See also: bzr ignore"""
998
def run(self):
999
tree = find_branch('.').working_tree()
1000
for path, file_class, kind, file_id in tree.list_files():
1001
if file_class != 'I':
1002
continue
1003
## XXX: Slightly inefficient since this was already calculated
1004
pat = tree.is_ignored(path)
1005
print '%-50s %s' % (path, pat)
1006
1007
1008
class cmd_lookup_revision(Command):
1009
"""Lookup the revision-id from a revision-number
1010
1011
example:
1012
bzr lookup-revision 33
1013
"""
1014
hidden = True
1015
takes_args = ['revno']
1016
1017
def run(self, revno):
1018
try:
1019
revno = int(revno)
1020
except ValueError:
1021
raise BzrCommandError("not a valid revision-number: %r" % revno)
1022
1023
print find_branch('.').lookup_revision(revno)
1024
1025
1026
class cmd_export(Command):
1027
"""Export past revision to destination directory.
1028
1029
If no revision is specified this exports the last committed revision.
1030
1031
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1032
given, try to find the format with the extension. If no extension
1033
is found exports to a directory (equivalent to --format=dir).
1034
1035
Root may be the top directory for tar, tgz and tbz2 formats. If none
1036
is given, the top directory will be the root name of the file."""
1037
# TODO: list known exporters
1038
takes_args = ['dest']
1039
takes_options = ['revision', 'format', 'root']
1040
def run(self, dest, revision=None, format=None, root=None):
1041
import os.path
1042
b = find_branch('.')
1043
if revision == None:
1044
rh = b.revision_history()[-1]
1045
else:
1046
rh = b.lookup_revision(int(revision))
1047
t = b.revision_tree(rh)
1048
root, ext = os.path.splitext(dest)
1049
if not format:
1050
if ext in (".tar",):
1051
format = "tar"
1052
elif ext in (".gz", ".tgz"):
1053
format = "tgz"
1054
elif ext in (".bz2", ".tbz2"):
1055
format = "tbz2"
1056
else:
1057
format = "dir"
1058
t.export(dest, format, root)
1059
1060
1061
class cmd_cat(Command):
1062
"""Write a file's text from a previous revision."""
1063
1064
takes_options = ['revision']
1065
takes_args = ['filename']
1066
1067
def run(self, filename, revision=None):
1068
if revision == None:
1069
raise BzrCommandError("bzr cat requires a revision number")
1070
b = find_branch('.')
1071
b.print_file(b.relpath(filename), int(revision))
1072
1073
1074
class cmd_local_time_offset(Command):
1075
"""Show the offset in seconds from GMT to local time."""
1076
hidden = True
1077
def run(self):
1078
print bzrlib.osutils.local_time_offset()
1079
1080
1081
1082
class cmd_commit(Command):
1083
"""Commit changes into a new revision.
1084
1085
If selected files are specified, only changes to those files are
1086
committed. If a directory is specified then its contents are also
1087
committed.
1088
1089
A selected-file commit may fail in some cases where the committed
1090
tree would be invalid, such as trying to commit a file in a
1091
newly-added directory that is not itself committed.
1092
1093
TODO: Run hooks on tree to-be-committed, and after commit.
1094
1095
TODO: Strict commit that fails if there are unknown or deleted files.
1096
"""
1097
takes_args = ['selected*']
1098
takes_options = ['message', 'file', 'verbose', 'unchanged']
1099
aliases = ['ci', 'checkin']
1100
1101
def run(self, message=None, file=None, verbose=True, selected_list=None,
1102
unchanged=False):
1103
from bzrlib.errors import PointlessCommit
1104
from bzrlib.osutils import get_text_message
1105
1106
## Warning: shadows builtin file()
1107
if not message and not file:
1108
import cStringIO
1109
stdout = sys.stdout
1110
catcher = cStringIO.StringIO()
1111
sys.stdout = catcher
1112
cmd_status({"file_list":selected_list}, {})
1113
info = catcher.getvalue()
1114
sys.stdout = stdout
1115
message = get_text_message(info)
1116
1117
if message is None:
1118
raise BzrCommandError("please specify a commit message",
1119
["use either --message or --file"])
1120
elif message and file:
1121
raise BzrCommandError("please specify either --message or --file")
1122
1123
if file:
1124
import codecs
1125
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1126
1127
b = find_branch('.')
1128
1129
try:
1130
b.commit(message, verbose=verbose,
1131
specific_files=selected_list,
1132
allow_pointless=unchanged)
1133
except PointlessCommit:
1134
# FIXME: This should really happen before the file is read in;
1135
# perhaps prepare the commit; get the message; then actually commit
1136
raise BzrCommandError("no changes to commit",
1137
["use --unchanged to commit anyhow"])
1138
1139
1140
class cmd_check(Command):
1141
"""Validate consistency of branch history.
1142
1143
This command checks various invariants about the branch storage to
1144
detect data corruption or bzr bugs.
1145
1146
If given the --update flag, it will update some optional fields
1147
to help ensure data consistency.
1148
"""
1149
takes_args = ['dir?']
1150
1151
def run(self, dir='.'):
1152
from bzrlib.check import check
1153
check(find_branch(dir))
1154
1155
1156
1157
class cmd_upgrade(Command):
1158
"""Upgrade branch storage to current format.
1159
1160
This should normally be used only after the check command tells
1161
you to run it.
1162
"""
1163
takes_args = ['dir?']
1164
1165
def run(self, dir='.'):
1166
from bzrlib.upgrade import upgrade
1167
upgrade(find_branch(dir))
1168
1169
1170
1171
class cmd_whoami(Command):
1172
"""Show bzr user id."""
1173
takes_options = ['email']
1174
1175
def run(self, email=False):
1176
if email:
1177
print bzrlib.osutils.user_email()
1178
else:
1179
print bzrlib.osutils.username()
1180
1181
1182
class cmd_selftest(Command):
1183
"""Run internal test suite"""
1184
hidden = True
1185
def run(self):
1186
from bzrlib.selftest import selftest
1187
return int(not selftest())
1188
1189
1190
class cmd_version(Command):
1191
"""Show version of bzr."""
1192
def run(self):
1193
show_version()
1194
1195
def show_version():
1196
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1197
# is bzrlib itself in a branch?
1198
bzrrev = bzrlib.get_bzr_revision()
1199
if bzrrev:
1200
print " (bzr checkout, revision %d {%s})" % bzrrev
1201
print bzrlib.__copyright__
1202
print "http://bazaar-ng.org/"
1203
print
1204
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1205
print "you may use, modify and redistribute it under the terms of the GNU"
1206
print "General Public License version 2 or later."
1207
1208
1209
class cmd_rocks(Command):
1210
"""Statement of optimism."""
1211
hidden = True
1212
def run(self):
1213
print "it sure does!"
312
1214
313
1215
def parse_spec(spec):
314
1216
"""
320
1222
['..', -1]
321
1223
>>> parse_spec("../f/@35")
322
1224
['../f', 35]
323
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
324
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
325
1225
"""
326
1226
if spec is None:
327
1227
return [None, None]
331
1231
if parsed[1] == "":
332
1232
parsed[1] = -1
333
1233
else:
334
try:
335
parsed[1] = int(parsed[1])
336
except ValueError:
337
pass # We can allow stuff like ./@revid:blahblahblah
338
else:
339
assert parsed[1] >=0
1234
parsed[1] = int(parsed[1])
1235
assert parsed[1] >=0
340
1236
else:
341
1237
parsed = [spec, None]
342
1238
return parsed
343
1239
344
1240
345
1241
1242
class cmd_merge(Command):
1243
"""Perform a three-way merge of trees.
1244
1245
The SPEC parameters are working tree or revision specifiers. Working trees
1246
are specified using standard paths or urls. No component of a directory
1247
path may begin with '@'.
1248
1249
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1250
1251
Revisions are specified using a dirname/@revno pair, where dirname is the
1252
branch directory and revno is the revision within that branch. If no revno
1253
is specified, the latest revision is used.
1254
1255
Revision examples: './@127', 'foo/@', '../@1'
1256
1257
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1258
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1259
as the BASE.
1260
1261
merge refuses to run if there are any uncommitted changes, unless
1262
--force is given.
1263
"""
1264
takes_args = ['other_spec', 'base_spec?']
1265
takes_options = ['force']
1266
1267
def run(self, other_spec, base_spec=None, force=False):
1268
from bzrlib.merge import merge
1269
merge(parse_spec(other_spec), parse_spec(base_spec),
1270
check_clean=(not force))
1271
1272
1273
1274
class cmd_revert(Command):
1275
"""Restore selected files from a previous revision.
1276
"""
1277
takes_args = ['file+']
1278
def run(self, file_list):
1279
from bzrlib.branch import find_branch
1280
1281
if not file_list:
1282
file_list = ['.']
1283
1284
b = find_branch(file_list[0])
1285
1286
b.revert([b.relpath(f) for f in file_list])
1287
1288
1289
class cmd_merge_revert(Command):
1290
"""Reverse all changes since the last commit.
1291
1292
Only versioned files are affected.
1293
1294
TODO: Store backups of any files that will be reverted, so
1295
that the revert can be undone.
1296
"""
1297
takes_options = ['revision']
1298
1299
def run(self, revision=-1):
1300
from bzrlib.merge import merge
1301
merge(('.', revision), parse_spec('.'),
1302
check_clean=False,
1303
ignore_zero=True)
1304
1305
1306
class cmd_assert_fail(Command):
1307
"""Test reporting of assertion failures"""
1308
hidden = True
1309
def run(self):
1310
assert False, "always fails"
1311
1312
1313
class cmd_help(Command):
1314
"""Show help on a command or other topic.
1315
1316
For a list of all available commands, say 'bzr help commands'."""
1317
takes_args = ['topic?']
1318
aliases = ['?']
1319
1320
def run(self, topic=None):
1321
import help
1322
help.help(topic)
1323
1324
1325
1326
1327
class cmd_plugins(Command):
1328
"""List plugins"""
1329
hidden = True
1330
def run(self):
1331
import bzrlib.plugin
1332
from pprint import pprint
1333
pprint(bzrlib.plugin.all_plugins)
1334
1335
346
1336
347
1337
# list of all available options; the rhs can be either None for an
348
1338
# option that takes no argument, or a constructor function that checks
359
1349
'no-recurse': None,
360
1350
'profile': None,
361
1351
'revision': _parse_revision_str,
362
'short': None,
363
1352
'show-ids': None,
364
1353
'timezone': str,
365
1354
'verbose': None,
369
1358
'update': None,
370
1359
'long': None,
371
1360
'root': str,
372
'no-backup': None,
373
'merge-type': get_merge_type,
374
'pattern': str,
375
1361
}
376
1362
377
1363
SHORT_OPTIONS = {
394
1380
395
1381
>>> parse_args('--help'.split())
396
1382
([], {'help': True})
397
>>> parse_args('help -- --invalidcmd'.split())
398
(['help', '--invalidcmd'], {})
399
1383
>>> parse_args('--version'.split())
400
1384
([], {'version': True})
401
1385
>>> parse_args('status --all'.split())
403
1387
>>> parse_args('commit --message=biter'.split())
404
1388
(['commit'], {'message': u'biter'})
405
1389
>>> parse_args('log -r 500'.split())
406
(['log'], {'revision': [500]})
407
>>> parse_args('log -r500..600'.split())
1390
(['log'], {'revision': 500})
1391
>>> parse_args('log -r500:600'.split())
408
1392
(['log'], {'revision': [500, 600]})
409
>>> parse_args('log -vr500..600'.split())
1393
>>> parse_args('log -vr500:600'.split())
410
1394
(['log'], {'verbose': True, 'revision': [500, 600]})
411
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
412
(['log'], {'revision': ['v500', 600]})
1395
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1396
Traceback (most recent call last):
1397
...
1398
ValueError: invalid literal for int(): v500
413
1399
"""
414
1400
args = []
415
1401
opts = {}
416
1402
417
argsover = False
1403
# TODO: Maybe handle '--' to end options?
1404
418
1405
while argv:
419
1406
a = argv.pop(0)
420
if not argsover and a[0] == '-':
1407
if a[0] == '-':
421
1408
# option names must not be unicode
422
1409
a = str(a)
423
1410
optarg = None
424
1411
if a[1] == '-':
425
if a == '--':
426
# We've received a standalone -- No more flags
427
argsover = True
428
continue
429
1412
mutter(" got option %r" % a)
430
1413
if '=' in a:
431
1414
optname, optarg = a[2:].split('=', 1)
532
1515
return argdict
533
1516
534
1517
535
536
def apply_profiled(the_callable, *args, **kwargs):
537
import hotshot
538
import tempfile
539
pffileno, pfname = tempfile.mkstemp()
540
try:
541
prof = hotshot.Profile(pfname)
542
try:
543
ret = prof.runcall(the_callable, *args, **kwargs) or 0
544
finally:
545
prof.close()
546
547
import hotshot.stats
548
stats = hotshot.stats.load(pfname)
549
#stats.strip_dirs()
550
stats.sort_stats('time')
551
## XXX: Might like to write to stderr or the trace file instead but
552
## print_stats seems hardcoded to stdout
553
stats.print_stats(20)
554
555
return ret
556
finally:
557
os.close(pffileno)
558
os.remove(pfname)
1518
def _parse_master_args(argv):
1519
"""Parse the arguments that always go with the original command.
1520
These are things like bzr --no-plugins, etc.
1521
1522
There are now 2 types of option flags. Ones that come *before* the command,
1523
and ones that come *after* the command.
1524
Ones coming *before* the command are applied against all possible commands.
1525
And are generally applied before plugins are loaded.
1526
1527
The current list are:
1528
--builtin Allow plugins to load, but don't let them override builtin commands,
1529
they will still be allowed if they do not override a builtin.
1530
--no-plugins Don't load any plugins. This lets you get back to official source
1531
behavior.
1532
--profile Enable the hotspot profile before running the command.
1533
For backwards compatibility, this is also a non-master option.
1534
--version Spit out the version of bzr that is running and exit.
1535
This is also a non-master option.
1536
--help Run help and exit, also a non-master option (I think that should stay, though)
1537
1538
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1539
Traceback (most recent call last):
1540
...
1541
BzrCommandError: Invalid master option: 'test'
1542
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1543
>>> print argv
1544
['command']
1545
>>> print opts['version']
1546
True
1547
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1548
>>> print argv
1549
['command', '--more-options']
1550
>>> print opts['profile']
1551
True
1552
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1553
>>> print argv
1554
['command']
1555
>>> print opts['no-plugins']
1556
True
1557
>>> print opts['profile']
1558
False
1559
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1560
>>> print argv
1561
['command', '--profile']
1562
>>> print opts['profile']
1563
False
1564
"""
1565
master_opts = {'builtin':False,
1566
'no-plugins':False,
1567
'version':False,
1568
'profile':False,
1569
'help':False
1570
}
1571
1572
# This is the point where we could hook into argv[0] to determine
1573
# what front-end is supposed to be run
1574
# For now, we are just ignoring it.
1575
cmd_name = argv.pop(0)
1576
for arg in argv[:]:
1577
if arg[:2] != '--': # at the first non-option, we return the rest
1578
break
1579
arg = arg[2:] # Remove '--'
1580
if arg not in master_opts:
1581
# We could say that this is not an error, that we should
1582
# just let it be handled by the main section instead
1583
raise BzrCommandError('Invalid master option: %r' % arg)
1584
argv.pop(0) # We are consuming this entry
1585
master_opts[arg] = True
1586
return argv, master_opts
1587
559
1588
560
1589
561
1590
def run_bzr(argv):
563
1592
564
1593
This is similar to main(), but without all the trappings for
565
1594
logging and error handling.
566
567
argv
568
The command-line arguments, without the program name from argv[0]
569
570
Returns a command status or raises an exception.
571
572
Special master options: these must come before the command because
573
they control how the command is interpreted.
574
575
--no-plugins
576
Do not load plugin modules at all
577
578
--builtin
579
Only use builtin commands. (Plugins are still allowed to change
580
other behaviour.)
581
582
--profile
583
Run under the Python profiler.
584
1595
"""
585
586
1596
argv = [a.decode(bzrlib.user_encoding) for a in argv]
587
588
opt_profile = opt_no_plugins = opt_builtin = False
589
590
# --no-plugins is handled specially at a very early stage. We need
591
# to load plugins before doing other command parsing so that they
592
# can override commands, but this needs to happen first.
593
594
for a in argv:
595
if a == '--profile':
596
opt_profile = True
597
elif a == '--no-plugins':
598
opt_no_plugins = True
599
elif a == '--builtin':
600
opt_builtin = True
601
else:
602
break
603
argv.remove(a)
604
605
if (not argv) or (argv[0] == '--help'):
606
from bzrlib.help import help
607
if len(argv) > 1:
608
help(argv[1])
609
else:
610
help()
611
return 0
612
613
if argv[0] == '--version':
614
from bzrlib.builtins import show_version
615
show_version()
616
return 0
617
618
if not opt_no_plugins:
619
from bzrlib.plugin import load_plugins
620
load_plugins()
621
622
cmd = str(argv.pop(0))
623
624
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
625
626
if opt_profile:
627
ret = apply_profiled(cmd_obj.run_argv, argv)
1597
1598
try:
1599
# some options like --builtin and --no-plugins have special effects
1600
argv, master_opts = _parse_master_args(argv)
1601
if not master_opts['no-plugins']:
1602
from bzrlib.plugin import load_plugins
1603
load_plugins()
1604
1605
args, opts = parse_args(argv)
1606
1607
if master_opts['help']:
1608
from bzrlib.help import help
1609
if argv:
1610
help(argv[0])
1611
else:
1612
help()
1613
return 0
1614
1615
if 'help' in opts:
1616
from bzrlib.help import help
1617
if args:
1618
help(args[0])
1619
else:
1620
help()
1621
return 0
1622
elif 'version' in opts:
1623
show_version()
1624
return 0
1625
elif args and args[0] == 'builtin':
1626
include_plugins=False
1627
args = args[1:]
1628
cmd = str(args.pop(0))
1629
except IndexError:
1630
import help
1631
help.help()
1632
return 1
1633
1634
1635
plugins_override = not (master_opts['builtin'])
1636
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1637
1638
profile = master_opts['profile']
1639
# For backwards compatibility, I would rather stick with --profile being a
1640
# master/global option
1641
if 'profile' in opts:
1642
profile = True
1643
del opts['profile']
1644
1645
# check options are reasonable
1646
allowed = cmd_class.takes_options
1647
for oname in opts:
1648
if oname not in allowed:
1649
raise BzrCommandError("option '--%s' is not allowed for command %r"
1650
% (oname, cmd))
1651
1652
# mix arguments and options into one dictionary
1653
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1654
cmdopts = {}
1655
for k, v in opts.items():
1656
cmdopts[k.replace('-', '_')] = v
1657
1658
if profile:
1659
import hotshot, tempfile
1660
pffileno, pfname = tempfile.mkstemp()
1661
try:
1662
prof = hotshot.Profile(pfname)
1663
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1664
prof.close()
1665
1666
import hotshot.stats
1667
stats = hotshot.stats.load(pfname)
1668
#stats.strip_dirs()
1669
stats.sort_stats('time')
1670
## XXX: Might like to write to stderr or the trace file instead but
1671
## print_stats seems hardcoded to stdout
1672
stats.print_stats(20)
1673
1674
return ret.status
1675
1676
finally:
1677
os.close(pffileno)
1678
os.remove(pfname)
628
1679
else:
629
ret = cmd_obj.run_argv(argv)
630
return ret or 0
1680
return cmd_class(cmdopts, cmdargs).status
1681
1682
1683
def _report_exception(summary, quiet=False):
1684
import traceback
1685
log_error('bzr: ' + summary)
1686
bzrlib.trace.log_exception()
1687
1688
if not quiet:
1689
tb = sys.exc_info()[2]
1690
exinfo = traceback.extract_tb(tb)
1691
if exinfo:
1692
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1693
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1694
631
1695
632
1696
633
1697
def main(argv):
634
import bzrlib.ui
635
bzrlib.trace.log_startup(argv)
636
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1698
1699
bzrlib.trace.open_tracefile(argv)
637
1700
638
1701
try:
639
1702
try:
640
return run_bzr(argv[1:])
641
finally:
642
# do this here inside the exception wrappers to catch EPIPE
643
sys.stdout.flush()
644
except BzrCommandError, e:
645
# command line syntax error, etc
646
log_error(str(e))
647
return 1
648
except BzrError, e:
649
bzrlib.trace.log_exception()
650
return 1
651
except AssertionError, e:
652
bzrlib.trace.log_exception('assertion failed: ' + str(e))
653
return 3
654
except KeyboardInterrupt, e:
655
bzrlib.trace.note('interrupted')
656
return 2
657
except Exception, e:
658
import errno
659
if (isinstance(e, IOError)
660
and hasattr(e, 'errno')
661
and e.errno == errno.EPIPE):
662
bzrlib.trace.note('broken pipe')
663
return 2
664
else:
665
bzrlib.trace.log_exception()
666
return 2
1703
try:
1704
return run_bzr(argv)
1705
finally:
1706
# do this here inside the exception wrappers to catch EPIPE
1707
sys.stdout.flush()
1708
except BzrError, e:
1709
quiet = isinstance(e, (BzrCommandError))
1710
_report_exception('error: ' + e.args[0], quiet=quiet)
1711
if len(e.args) > 1:
1712
for h in e.args[1]:
1713
# some explanation or hints
1714
log_error(' ' + h)
1715
return 1
1716
except AssertionError, e:
1717
msg = 'assertion failed'
1718
if str(e):
1719
msg += ': ' + str(e)
1720
_report_exception(msg)
1721
return 2
1722
except KeyboardInterrupt, e:
1723
_report_exception('interrupted', quiet=True)
1724
return 2
1725
except Exception, e:
1726
import errno
1727
quiet = False
1728
if (isinstance(e, IOError)
1729
and hasattr(e, 'errno')
1730
and e.errno == errno.EPIPE):
1731
quiet = True
1732
msg = 'broken pipe'
1733
else:
1734
msg = str(e).rstrip('\n')
1735
_report_exception(msg, quiet)
1736
return 2
1737
finally:
1738
bzrlib.trace.close_trace()
667
1739
668
1740
669
1741
if __name__ == '__main__':
Loggerhead is a web-based interface for Breezy
Version: 2.0.1