« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 854
- compare with another revision
- download diff
- download tarball
- view history from revision 854
- Committer: Martin Pool
- Date: 2005-07-07 10:22:02 UTC
- Revision ID: mbp@sourcefrog.net-20050707102201-2d2a13a25098b101
- rearrange and clear up merged weave
- files added:
- bzrlib/meta_store.py
- plugins/changeset
- files removed:
- HACKING
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- contrib/emacs
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/selftest/testplugins.py => bzrlib/selftest/plugins.py
- bzrlib/store/__init__.py => bzrlib/store.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
- 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
39
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
40
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
41
25
from bzrlib import BZRDIR
42
from bzrlib.option import Option
26
43
27
44
28
plugin_cmds = {}
45
29
54
38
k_unsquished = k
55
39
if not plugin_cmds.has_key(k_unsquished):
56
40
plugin_cmds[k_unsquished] = cmd
57
mutter('registered plugin command %s', k_unsquished)
58
41
else:
59
42
log_error('Two plugins defined the same command: %r' % k)
60
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
68
51
assert cmd.startswith("cmd_")
69
52
return cmd[4:].replace('_','-')
70
53
71
72
def _builtin_commands():
73
import bzrlib.builtins
74
r = {}
75
builtins = bzrlib.builtins.__dict__
76
for name in builtins:
77
if name.startswith("cmd_"):
78
real_name = _unsquish_command_name(name)
79
r[real_name] = builtins[name]
80
return r
81
82
83
84
def builtin_command_names():
85
"""Return list of builtin command names."""
86
return _builtin_commands().keys()
87
88
89
def plugin_command_names():
90
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
91
88
92
89
93
90
def _get_cmd_dict(plugins_override=True):
94
"""Return name->class mapping for all commands."""
95
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
96
96
if plugins_override:
97
97
d.update(plugin_cmds)
98
else:
99
d2 = plugin_cmds.copy()
100
d2.update(d)
101
d = d2
98
102
return d
99
103
100
104
104
108
yield k,v
105
109
106
110
107
def get_cmd_object(cmd_name, plugins_override=True):
111
def get_cmd_class(cmd, plugins_override=True):
108
112
"""Return the canonical name and command class for a command.
109
110
plugins_override
111
If true, plugin commands can override builtins.
112
113
"""
113
from bzrlib.externalcommand import ExternalCommand
114
115
cmd_name = str(cmd_name) # not unicode
114
cmd = str(cmd) # not unicode
116
115
117
116
# first look up this command under the specified name
118
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
118
try:
120
return cmds[cmd_name]()
119
return cmd, cmds[cmd]
121
120
except KeyError:
122
121
pass
123
122
124
123
# look for any command which claims this as an alias
125
for real_cmd_name, cmd_class in cmds.iteritems():
126
if cmd_name in cmd_class.aliases:
127
return cmd_class()
128
129
cmd_obj = ExternalCommand.find_command(cmd_name)
130
if cmd_obj:
131
return cmd_obj
132
133
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)
134
133
135
134
136
135
class Command(object):
137
136
"""Base class for commands.
138
137
139
Commands are the heart of the command-line bzr interface.
140
141
The command object mostly handles the mapping of command-line
142
parameters into one or more bzrlib operations, and of the results
143
into textual output.
144
145
Commands normally don't have any state. All their arguments are
146
passed in to the run method. (Subclasses may take a different
147
policy if the behaviour of the instance needs to depend on e.g. a
148
shell plugin and not just its Python class.)
149
150
138
The docstring for an actual command should give a single-line
151
139
summary, then a complete description of the command. A grammar
152
140
description will be inserted.
153
141
154
aliases
155
Other accepted names for this command.
156
157
142
takes_args
158
143
List of argument forms, marked with whether they are optional,
159
144
repeated, etc.
160
145
161
146
takes_options
162
List of options that may be given for this command. These can
163
be either strings, referring to globally-defined options,
164
or option objects. Retrieve through options().
147
List of options that may be given for this command.
165
148
166
149
hidden
167
If true, this command isn't advertised. This is typically
168
for commands intended for expert users.
150
If true, this command isn't advertised.
169
151
"""
170
152
aliases = []
153
171
154
takes_args = []
172
155
takes_options = []
173
156
174
157
hidden = False
175
158
176
def __init__(self):
177
"""Construct an instance of this command."""
178
if self.__doc__ == Command.__doc__:
179
warn("No help message set for %r" % self)
180
181
def options(self):
182
"""Return dict of valid options for this command.
183
184
Maps from long option name to option object."""
185
r = dict()
186
r['help'] = Option.OPTIONS['help']
187
for o in self.takes_options:
188
if not isinstance(o, Option):
189
o = Option.OPTIONS[o]
190
r[o.name] = o
191
return r
192
193
def run_argv(self, argv):
194
"""Parse command line and run."""
195
args, opts = parse_args(self, argv)
196
if 'help' in opts: # e.g. bzr add --help
197
from bzrlib.help import help_on_command
198
help_on_command(self.name())
199
return 0
200
# XXX: This should be handled by the parser
201
allowed_names = self.options().keys()
202
for oname in opts:
203
if oname not in allowed_names:
204
raise BzrCommandError("option '--%s' is not allowed for command %r"
205
% (oname, self.name()))
206
# mix arguments and options into one dictionary
207
cmdargs = _match_argform(self.name(), self.takes_args, args)
208
cmdopts = {}
209
for k, v in opts.items():
210
cmdopts[k.replace('-', '_')] = v
211
212
all_cmd_args = cmdargs.copy()
213
all_cmd_args.update(cmdopts)
214
215
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)
216
170
217
171
218
172
def run(self):
219
"""Actually run the command.
173
"""Override this in sub-classes.
220
174
221
175
This is invoked with the options and arguments bound to
222
176
keyword parameters.
223
177
224
Return 0 or None if the command was successful, or a non-zero
225
shell error code if not. It's OK for this method to allow
226
an exception to raise up.
178
Return 0 or None if the command was successful, or a shell
179
error code if not.
227
180
"""
228
raise NotImplementedError()
229
230
231
def help(self):
232
"""Return help message for this class."""
233
if self.__doc__ is Command.__doc__:
234
return None
235
return getdoc(self)
236
237
def name(self):
238
return _unsquish_command_name(self.__class__.__name__)
239
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.statcache import update_cache, SC_SHA1
774
b = find_branch('.')
775
inv = b.read_working_inventory()
776
sc = 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[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','long']
839
840
def run(self, filename=None, timezone='original',
841
verbose=False,
842
show_ids=False,
843
forward=False,
844
revision=None,
845
long=False):
846
from bzrlib.branch import find_branch
847
from bzrlib.log import log_formatter, show_log
848
import codecs
849
850
direction = (forward and 'forward') or 'reverse'
851
852
if filename:
853
b = find_branch(filename)
854
fp = b.relpath(filename)
855
if fp:
856
file_id = b.read_working_inventory().path2id(fp)
857
else:
858
file_id = None # points to branch root
859
else:
860
b = find_branch('.')
861
file_id = None
862
863
if revision == None:
864
revision = [None, None]
865
elif isinstance(revision, int):
866
revision = [revision, revision]
867
else:
868
# pair of revisions?
869
pass
870
871
assert len(revision) == 2
872
873
mutter('encoding log as %r' % bzrlib.user_encoding)
874
875
# use 'replace' so that we don't abort if trying to write out
876
# in e.g. the default C locale.
877
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
878
879
if long:
880
log_format = 'long'
881
else:
882
log_format = 'short'
883
lf = log_formatter(log_format,
884
show_ids=show_ids,
885
to_file=outf,
886
show_timezone=timezone)
887
888
show_log(b,
889
lf,
890
file_id,
891
verbose=verbose,
892
direction=direction,
893
start_revision=revision[0],
894
end_revision=revision[1])
895
896
897
898
class cmd_touching_revisions(Command):
899
"""Return revision-ids which affected a particular file.
900
901
A more user-friendly interface is "bzr log FILE"."""
902
hidden = True
903
takes_args = ["filename"]
904
def run(self, filename):
905
b = find_branch(filename)
906
inv = b.read_working_inventory()
907
file_id = inv.path2id(b.relpath(filename))
908
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
909
print "%6d %s" % (revno, what)
910
911
912
class cmd_ls(Command):
913
"""List files in a tree.
914
915
TODO: Take a revision or remote path and list that tree instead.
916
"""
917
hidden = True
918
def run(self, revision=None, verbose=False):
919
b = find_branch('.')
920
if revision == None:
921
tree = b.working_tree()
922
else:
923
tree = b.revision_tree(b.lookup_revision(revision))
924
925
for fp, fc, kind, fid in tree.list_files():
926
if verbose:
927
if kind == 'directory':
928
kindch = '/'
929
elif kind == 'file':
930
kindch = ''
931
else:
932
kindch = '???'
933
934
print '%-8s %s%s' % (fc, fp, kindch)
935
else:
936
print fp
937
938
939
940
class cmd_unknowns(Command):
941
"""List unknown files."""
942
def run(self):
943
from bzrlib.osutils import quotefn
944
for f in find_branch('.').unknowns():
945
print quotefn(f)
946
947
948
949
class cmd_ignore(Command):
950
"""Ignore a command or pattern.
951
952
To remove patterns from the ignore list, edit the .bzrignore file.
953
954
If the pattern contains a slash, it is compared to the whole path
955
from the branch root. Otherwise, it is comapred to only the last
956
component of the path.
957
958
Ignore patterns are case-insensitive on case-insensitive systems.
959
960
Note: wildcards must be quoted from the shell on Unix.
961
962
examples:
963
bzr ignore ./Makefile
964
bzr ignore '*.class'
965
"""
966
takes_args = ['name_pattern']
967
968
def run(self, name_pattern):
969
from bzrlib.atomicfile import AtomicFile
970
import os.path
971
972
b = find_branch('.')
973
ifn = b.abspath('.bzrignore')
974
975
if os.path.exists(ifn):
976
f = open(ifn, 'rt')
977
try:
978
igns = f.read().decode('utf-8')
979
finally:
980
f.close()
981
else:
982
igns = ''
983
984
# TODO: If the file already uses crlf-style termination, maybe
985
# we should use that for the newly added lines?
986
987
if igns and igns[-1] != '\n':
988
igns += '\n'
989
igns += name_pattern + '\n'
990
991
try:
992
f = AtomicFile(ifn, 'wt')
993
f.write(igns.encode('utf-8'))
994
f.commit()
995
finally:
996
f.close()
997
998
inv = b.working_tree().inventory
999
if inv.path2id('.bzrignore'):
1000
mutter('.bzrignore is already versioned')
1001
else:
1002
mutter('need to make new .bzrignore file versioned')
1003
b.add(['.bzrignore'])
1004
1005
1006
1007
class cmd_ignored(Command):
1008
"""List ignored files and the patterns that matched them.
1009
1010
See also: bzr ignore"""
1011
def run(self):
1012
tree = find_branch('.').working_tree()
1013
for path, file_class, kind, file_id in tree.list_files():
1014
if file_class != 'I':
1015
continue
1016
## XXX: Slightly inefficient since this was already calculated
1017
pat = tree.is_ignored(path)
1018
print '%-50s %s' % (path, pat)
1019
1020
1021
class cmd_lookup_revision(Command):
1022
"""Lookup the revision-id from a revision-number
1023
1024
example:
1025
bzr lookup-revision 33
1026
"""
1027
hidden = True
1028
takes_args = ['revno']
1029
1030
def run(self, revno):
1031
try:
1032
revno = int(revno)
1033
except ValueError:
1034
raise BzrCommandError("not a valid revision-number: %r" % revno)
1035
1036
print find_branch('.').lookup_revision(revno)
1037
1038
1039
class cmd_export(Command):
1040
"""Export past revision to destination directory.
1041
1042
If no revision is specified this exports the last committed revision.
1043
1044
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1045
given, exports to a directory (equivalent to --format=dir).
1046
1047
Root may be the top directory for tar, tgz and tbz2 formats."""
1048
# TODO: list known exporters
1049
takes_args = ['dest']
1050
takes_options = ['revision', 'format', 'root']
1051
def run(self, dest, revision=None, format='dir', root=None):
1052
b = find_branch('.')
1053
if revision == None:
1054
rh = b.revision_history()[-1]
1055
else:
1056
rh = b.lookup_revision(int(revision))
1057
t = b.revision_tree(rh)
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']
1099
aliases = ['ci', 'checkin']
1100
1101
def run(self, message=None, file=None, verbose=True, selected_list=None):
1102
from bzrlib.commit import commit
1103
from bzrlib.osutils import get_text_message
1104
1105
## Warning: shadows builtin file()
1106
if not message and not file:
1107
import cStringIO
1108
stdout = sys.stdout
1109
catcher = cStringIO.StringIO()
1110
sys.stdout = catcher
1111
cmd_status({"file_list":selected_list}, {})
1112
info = catcher.getvalue()
1113
sys.stdout = stdout
1114
message = get_text_message(info)
1115
1116
if message is None:
1117
raise BzrCommandError("please specify a commit message",
1118
["use either --message or --file"])
1119
elif message and file:
1120
raise BzrCommandError("please specify either --message or --file")
1121
1122
if file:
1123
import codecs
1124
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1125
1126
b = find_branch('.')
1127
commit(b, message, verbose=verbose, specific_files=selected_list)
1128
1129
1130
class cmd_check(Command):
1131
"""Validate consistency of branch history.
1132
1133
This command checks various invariants about the branch storage to
1134
detect data corruption or bzr bugs.
1135
1136
If given the --update flag, it will update some optional fields
1137
to help ensure data consistency.
1138
"""
1139
takes_args = ['dir?']
1140
1141
def run(self, dir='.'):
1142
from bzrlib.check import check
1143
check(find_branch(dir))
1144
1145
1146
1147
class cmd_upgrade(Command):
1148
"""Upgrade branch storage to current format.
1149
1150
This should normally be used only after the check command tells
1151
you to run it.
1152
"""
1153
takes_args = ['dir?']
1154
1155
def run(self, dir='.'):
1156
from bzrlib.upgrade import upgrade
1157
upgrade(find_branch(dir))
1158
1159
1160
1161
class cmd_whoami(Command):
1162
"""Show bzr user id."""
1163
takes_options = ['email']
1164
1165
def run(self, email=False):
1166
if email:
1167
print bzrlib.osutils.user_email()
1168
else:
1169
print bzrlib.osutils.username()
1170
1171
1172
class cmd_selftest(Command):
1173
"""Run internal test suite"""
1174
hidden = True
1175
def run(self):
1176
from bzrlib.selftest import selftest
1177
return int(not selftest())
1178
1179
1180
class cmd_version(Command):
1181
"""Show version of bzr."""
1182
def run(self):
1183
show_version()
1184
1185
def show_version():
1186
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1187
# is bzrlib itself in a branch?
1188
bzrrev = bzrlib.get_bzr_revision()
1189
if bzrrev:
1190
print " (bzr checkout, revision %d {%s})" % bzrrev
1191
print bzrlib.__copyright__
1192
print "http://bazaar-ng.org/"
1193
print
1194
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1195
print "you may use, modify and redistribute it under the terms of the GNU"
1196
print "General Public License version 2 or later."
1197
1198
1199
class cmd_rocks(Command):
1200
"""Statement of optimism."""
1201
hidden = True
1202
def run(self):
1203
print "it sure does!"
240
1204
241
1205
def parse_spec(spec):
242
1206
"""
248
1212
['..', -1]
249
1213
>>> parse_spec("../f/@35")
250
1214
['../f', 35]
251
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
252
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
253
1215
"""
254
1216
if spec is None:
255
1217
return [None, None]
259
1221
if parsed[1] == "":
260
1222
parsed[1] = -1
261
1223
else:
262
try:
263
parsed[1] = int(parsed[1])
264
except ValueError:
265
pass # We can allow stuff like ./@revid:blahblahblah
266
else:
267
assert parsed[1] >=0
1224
parsed[1] = int(parsed[1])
1225
assert parsed[1] >=0
268
1226
else:
269
1227
parsed = [spec, None]
270
1228
return parsed
271
1229
272
def parse_args(command, argv):
1230
1231
1232
class cmd_merge(Command):
1233
"""Perform a three-way merge of trees.
1234
1235
The SPEC parameters are working tree or revision specifiers. Working trees
1236
are specified using standard paths or urls. No component of a directory
1237
path may begin with '@'.
1238
1239
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1240
1241
Revisions are specified using a dirname/@revno pair, where dirname is the
1242
branch directory and revno is the revision within that branch. If no revno
1243
is specified, the latest revision is used.
1244
1245
Revision examples: './@127', 'foo/@', '../@1'
1246
1247
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1248
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1249
as the BASE.
1250
1251
merge refuses to run if there are any uncommitted changes, unless
1252
--force is given.
1253
"""
1254
takes_args = ['other_spec', 'base_spec?']
1255
takes_options = ['force']
1256
1257
def run(self, other_spec, base_spec=None, force=False):
1258
from bzrlib.merge import merge
1259
merge(parse_spec(other_spec), parse_spec(base_spec),
1260
check_clean=(not force))
1261
1262
1263
1264
class cmd_revert(Command):
1265
"""Restore selected files from a previous revision.
1266
"""
1267
takes_args = ['file+']
1268
def run(self, file_list):
1269
from bzrlib.branch import find_branch
1270
1271
if not file_list:
1272
file_list = ['.']
1273
1274
b = find_branch(file_list[0])
1275
1276
b.revert([b.relpath(f) for f in file_list])
1277
1278
1279
class cmd_merge_revert(Command):
1280
"""Reverse all changes since the last commit.
1281
1282
Only versioned files are affected.
1283
1284
TODO: Store backups of any files that will be reverted, so
1285
that the revert can be undone.
1286
"""
1287
takes_options = ['revision']
1288
1289
def run(self, revision=-1):
1290
from bzrlib.merge import merge
1291
merge(('.', revision), parse_spec('.'),
1292
check_clean=False,
1293
ignore_zero=True)
1294
1295
1296
class cmd_assert_fail(Command):
1297
"""Test reporting of assertion failures"""
1298
hidden = True
1299
def run(self):
1300
assert False, "always fails"
1301
1302
1303
class cmd_help(Command):
1304
"""Show help on a command or other topic.
1305
1306
For a list of all available commands, say 'bzr help commands'."""
1307
takes_args = ['topic?']
1308
aliases = ['?']
1309
1310
def run(self, topic=None):
1311
import help
1312
help.help(topic)
1313
1314
1315
class cmd_update_stat_cache(Command):
1316
"""Update stat-cache mapping inodes to SHA-1 hashes.
1317
1318
For testing only."""
1319
hidden = True
1320
def run(self):
1321
from bzrlib.statcache import update_cache
1322
b = find_branch('.')
1323
update_cache(b.base, b.read_working_inventory())
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
1336
1337
# list of all available options; the rhs can be either None for an
1338
# option that takes no argument, or a constructor function that checks
1339
# the type.
1340
OPTIONS = {
1341
'all': None,
1342
'diff-options': str,
1343
'help': None,
1344
'file': unicode,
1345
'force': None,
1346
'format': unicode,
1347
'forward': None,
1348
'message': unicode,
1349
'no-recurse': None,
1350
'profile': None,
1351
'revision': _parse_revision_str,
1352
'show-ids': None,
1353
'timezone': str,
1354
'verbose': None,
1355
'version': None,
1356
'email': None,
1357
'update': None,
1358
'long': None,
1359
'root': str,
1360
}
1361
1362
SHORT_OPTIONS = {
1363
'F': 'file',
1364
'h': 'help',
1365
'm': 'message',
1366
'r': 'revision',
1367
'v': 'verbose',
1368
'l': 'long',
1369
}
1370
1371
1372
def parse_args(argv):
273
1373
"""Parse command line.
274
1374
275
1375
Arguments and options are parsed at this level before being passed
276
1376
down to specific command handlers. This routine knows, from a
277
1377
lookup table, something about the available options, what optargs
278
1378
they take, and which commands will accept them.
1379
1380
>>> parse_args('--help'.split())
1381
([], {'help': True})
1382
>>> parse_args('--version'.split())
1383
([], {'version': True})
1384
>>> parse_args('status --all'.split())
1385
(['status'], {'all': True})
1386
>>> parse_args('commit --message=biter'.split())
1387
(['commit'], {'message': u'biter'})
1388
>>> parse_args('log -r 500'.split())
1389
(['log'], {'revision': 500})
1390
>>> parse_args('log -r500:600'.split())
1391
(['log'], {'revision': [500, 600]})
1392
>>> parse_args('log -vr500:600'.split())
1393
(['log'], {'verbose': True, 'revision': [500, 600]})
1394
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1395
Traceback (most recent call last):
1396
...
1397
ValueError: invalid literal for int(): v500
279
1398
"""
280
# TODO: chop up this beast; make it a method of the Command
281
1399
args = []
282
1400
opts = {}
283
1401
284
cmd_options = command.options()
285
argsover = False
1402
# TODO: Maybe handle '--' to end options?
1403
286
1404
while argv:
287
1405
a = argv.pop(0)
288
if argsover:
289
args.append(a)
290
continue
291
elif a == '--':
292
# We've received a standalone -- No more flags
293
argsover = True
294
continue
295
1406
if a[0] == '-':
296
1407
# option names must not be unicode
297
1408
a = str(a)
302
1413
optname, optarg = a[2:].split('=', 1)
303
1414
else:
304
1415
optname = a[2:]
305
if optname not in cmd_options:
306
raise BzrCommandError('unknown long option %r for command %s'
307
% (a, command.name()))
1416
if optname not in OPTIONS:
1417
raise BzrError('unknown long option %r' % a)
308
1418
else:
309
1419
shortopt = a[1:]
310
if shortopt in Option.SHORT_OPTIONS:
1420
if shortopt in SHORT_OPTIONS:
311
1421
# Multi-character options must have a space to delimit
312
1422
# their value
313
# ^^^ what does this mean? mbp 20051014
314
optname = Option.SHORT_OPTIONS[shortopt].name
1423
optname = SHORT_OPTIONS[shortopt]
315
1424
else:
316
1425
# Single character short options, can be chained,
317
1426
# and have their value appended to their name
318
1427
shortopt = a[1:2]
319
if shortopt not in Option.SHORT_OPTIONS:
1428
if shortopt not in SHORT_OPTIONS:
320
1429
# We didn't find the multi-character name, and we
321
1430
# didn't find the single char name
322
1431
raise BzrError('unknown short option %r' % a)
323
optname = Option.SHORT_OPTIONS[shortopt].name
1432
optname = SHORT_OPTIONS[shortopt]
324
1433
325
1434
if a[2:]:
326
1435
# There are extra things on this option
327
1436
# see if it is the value, or if it is another
328
1437
# short option
329
optargfn = Option.OPTIONS[optname].type
1438
optargfn = OPTIONS[optname]
330
1439
if optargfn is None:
331
1440
# This option does not take an argument, so the
332
1441
# next entry is another short option, pack it back
341
1450
# XXX: Do we ever want to support this, e.g. for -r?
342
1451
raise BzrError('repeated option %r' % a)
343
1452
344
option_obj = cmd_options[optname]
345
optargfn = option_obj.type
1453
optargfn = OPTIONS[optname]
346
1454
if optargfn:
347
1455
if optarg == None:
348
1456
if not argv:
356
1464
opts[optname] = True
357
1465
else:
358
1466
args.append(a)
1467
359
1468
return args, opts
360
1469
361
1470
1471
1472
362
1473
def _match_argform(cmd, takes_args, args):
363
1474
argdict = {}
364
1475
403
1514
return argdict
404
1515
405
1516
406
407
def apply_profiled(the_callable, *args, **kwargs):
408
import hotshot
409
import tempfile
410
import hotshot.stats
411
pffileno, pfname = tempfile.mkstemp()
412
try:
413
prof = hotshot.Profile(pfname)
414
try:
415
ret = prof.runcall(the_callable, *args, **kwargs) or 0
416
finally:
417
prof.close()
418
stats = hotshot.stats.load(pfname)
419
stats.strip_dirs()
420
stats.sort_stats('cum') # 'time'
421
## XXX: Might like to write to stderr or the trace file instead but
422
## print_stats seems hardcoded to stdout
423
stats.print_stats(20)
424
return ret
425
finally:
426
os.close(pffileno)
427
os.remove(pfname)
1517
def _parse_master_args(argv):
1518
"""Parse the arguments that always go with the original command.
1519
These are things like bzr --no-plugins, etc.
1520
1521
There are now 2 types of option flags. Ones that come *before* the command,
1522
and ones that come *after* the command.
1523
Ones coming *before* the command are applied against all possible commands.
1524
And are generally applied before plugins are loaded.
1525
1526
The current list are:
1527
--builtin Allow plugins to load, but don't let them override builtin commands,
1528
they will still be allowed if they do not override a builtin.
1529
--no-plugins Don't load any plugins. This lets you get back to official source
1530
behavior.
1531
--profile Enable the hotspot profile before running the command.
1532
For backwards compatibility, this is also a non-master option.
1533
--version Spit out the version of bzr that is running and exit.
1534
This is also a non-master option.
1535
--help Run help and exit, also a non-master option (I think that should stay, though)
1536
1537
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1538
Traceback (most recent call last):
1539
...
1540
BzrCommandError: Invalid master option: 'test'
1541
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1542
>>> print argv
1543
['command']
1544
>>> print opts['version']
1545
True
1546
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1547
>>> print argv
1548
['command', '--more-options']
1549
>>> print opts['profile']
1550
True
1551
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1552
>>> print argv
1553
['command']
1554
>>> print opts['no-plugins']
1555
True
1556
>>> print opts['profile']
1557
False
1558
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1559
>>> print argv
1560
['command', '--profile']
1561
>>> print opts['profile']
1562
False
1563
"""
1564
master_opts = {'builtin':False,
1565
'no-plugins':False,
1566
'version':False,
1567
'profile':False,
1568
'help':False
1569
}
1570
1571
# This is the point where we could hook into argv[0] to determine
1572
# what front-end is supposed to be run
1573
# For now, we are just ignoring it.
1574
cmd_name = argv.pop(0)
1575
for arg in argv[:]:
1576
if arg[:2] != '--': # at the first non-option, we return the rest
1577
break
1578
arg = arg[2:] # Remove '--'
1579
if arg not in master_opts:
1580
# We could say that this is not an error, that we should
1581
# just let it be handled by the main section instead
1582
raise BzrCommandError('Invalid master option: %r' % arg)
1583
argv.pop(0) # We are consuming this entry
1584
master_opts[arg] = True
1585
return argv, master_opts
1586
428
1587
429
1588
430
1589
def run_bzr(argv):
432
1591
433
1592
This is similar to main(), but without all the trappings for
434
1593
logging and error handling.
435
436
argv
437
The command-line arguments, without the program name from argv[0]
438
439
Returns a command status or raises an exception.
440
441
Special master options: these must come before the command because
442
they control how the command is interpreted.
443
444
--no-plugins
445
Do not load plugin modules at all
446
447
--builtin
448
Only use builtin commands. (Plugins are still allowed to change
449
other behaviour.)
450
451
--profile
452
Run under the Python profiler.
453
1594
"""
454
1595
argv = [a.decode(bzrlib.user_encoding) for a in argv]
455
456
opt_profile = opt_no_plugins = opt_builtin = False
457
458
# --no-plugins is handled specially at a very early stage. We need
459
# to load plugins before doing other command parsing so that they
460
# can override commands, but this needs to happen first.
461
462
for a in argv:
463
if a == '--profile':
464
opt_profile = True
465
elif a == '--no-plugins':
466
opt_no_plugins = True
467
elif a == '--builtin':
468
opt_builtin = True
469
else:
470
break
471
argv.remove(a)
472
473
if (not argv) or (argv[0] == '--help'):
474
from bzrlib.help import help
475
if len(argv) > 1:
476
help(argv[1])
477
else:
478
help()
479
return 0
480
481
if argv[0] == '--version':
482
from bzrlib.builtins import show_version
483
show_version()
484
return 0
485
486
if not opt_no_plugins:
487
from bzrlib.plugin import load_plugins
488
load_plugins()
489
490
cmd = str(argv.pop(0))
491
492
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
493
494
if opt_profile:
495
ret = apply_profiled(cmd_obj.run_argv, argv)
1596
1597
try:
1598
# some options like --builtin and --no-plugins have special effects
1599
argv, master_opts = _parse_master_args(argv)
1600
if not master_opts['no-plugins']:
1601
from bzrlib.plugin import load_plugins
1602
load_plugins()
1603
1604
args, opts = parse_args(argv)
1605
1606
if master_opts['help']:
1607
from bzrlib.help import help
1608
if argv:
1609
help(argv[0])
1610
else:
1611
help()
1612
return 0
1613
1614
if 'help' in opts:
1615
from bzrlib.help import help
1616
if args:
1617
help(args[0])
1618
else:
1619
help()
1620
return 0
1621
elif 'version' in opts:
1622
show_version()
1623
return 0
1624
elif args and args[0] == 'builtin':
1625
include_plugins=False
1626
args = args[1:]
1627
cmd = str(args.pop(0))
1628
except IndexError:
1629
import help
1630
help.help()
1631
return 1
1632
1633
1634
plugins_override = not (master_opts['builtin'])
1635
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1636
1637
profile = master_opts['profile']
1638
# For backwards compatibility, I would rather stick with --profile being a
1639
# master/global option
1640
if 'profile' in opts:
1641
profile = True
1642
del opts['profile']
1643
1644
# check options are reasonable
1645
allowed = cmd_class.takes_options
1646
for oname in opts:
1647
if oname not in allowed:
1648
raise BzrCommandError("option '--%s' is not allowed for command %r"
1649
% (oname, cmd))
1650
1651
# mix arguments and options into one dictionary
1652
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1653
cmdopts = {}
1654
for k, v in opts.items():
1655
cmdopts[k.replace('-', '_')] = v
1656
1657
if profile:
1658
import hotshot, tempfile
1659
pffileno, pfname = tempfile.mkstemp()
1660
try:
1661
prof = hotshot.Profile(pfname)
1662
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1663
prof.close()
1664
1665
import hotshot.stats
1666
stats = hotshot.stats.load(pfname)
1667
#stats.strip_dirs()
1668
stats.sort_stats('time')
1669
## XXX: Might like to write to stderr or the trace file instead but
1670
## print_stats seems hardcoded to stdout
1671
stats.print_stats(20)
1672
1673
return ret.status
1674
1675
finally:
1676
os.close(pffileno)
1677
os.remove(pfname)
496
1678
else:
497
ret = cmd_obj.run_argv(argv)
498
return ret or 0
499
500
def display_command(func):
501
def ignore_pipe(*args, **kwargs):
502
try:
503
func(*args, **kwargs)
504
except IOError, e:
505
if e.errno != errno.EPIPE:
506
raise
507
except KeyboardInterrupt:
508
pass
509
return ignore_pipe
1679
return cmd_class(cmdopts, cmdargs).status
1680
1681
1682
def _report_exception(summary, quiet=False):
1683
import traceback
1684
log_error('bzr: ' + summary)
1685
bzrlib.trace.log_exception()
1686
1687
if not quiet:
1688
tb = sys.exc_info()[2]
1689
exinfo = traceback.extract_tb(tb)
1690
if exinfo:
1691
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1692
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1693
1694
510
1695
511
1696
def main(argv):
512
import bzrlib.ui
513
bzrlib.trace.log_startup(argv)
514
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
515
516
return run_bzr_catch_errors(argv[1:])
517
518
519
def run_bzr_catch_errors(argv):
1697
1698
bzrlib.trace.open_tracefile(argv)
1699
520
1700
try:
521
1701
try:
522
return run_bzr(argv)
523
finally:
524
# do this here inside the exception wrappers to catch EPIPE
525
sys.stdout.flush()
526
except BzrCommandError, e:
527
# command line syntax error, etc
528
log_error(str(e))
529
return 1
530
except BzrError, e:
531
bzrlib.trace.log_exception()
532
return 1
533
except AssertionError, e:
534
bzrlib.trace.log_exception('assertion failed: ' + str(e))
535
return 3
536
except KeyboardInterrupt, e:
537
bzrlib.trace.log_exception('interrupted')
538
return 2
539
except Exception, e:
540
import errno
541
if (isinstance(e, IOError)
542
and hasattr(e, 'errno')
543
and e.errno == errno.EPIPE):
544
bzrlib.trace.note('broken pipe')
545
return 2
546
else:
547
## import pdb
548
## pdb.pm()
549
bzrlib.trace.log_exception()
550
return 2
1702
try:
1703
return run_bzr(argv)
1704
finally:
1705
# do this here inside the exception wrappers to catch EPIPE
1706
sys.stdout.flush()
1707
except BzrError, e:
1708
quiet = isinstance(e, (BzrCommandError))
1709
_report_exception('error: ' + e.args[0], quiet=quiet)
1710
if len(e.args) > 1:
1711
for h in e.args[1]:
1712
# some explanation or hints
1713
log_error(' ' + h)
1714
return 1
1715
except AssertionError, e:
1716
msg = 'assertion failed'
1717
if str(e):
1718
msg += ': ' + str(e)
1719
_report_exception(msg)
1720
return 2
1721
except KeyboardInterrupt, e:
1722
_report_exception('interrupted', quiet=True)
1723
return 2
1724
except Exception, e:
1725
import errno
1726
quiet = False
1727
if (isinstance(e, IOError)
1728
and hasattr(e, 'errno')
1729
and e.errno == errno.EPIPE):
1730
quiet = True
1731
msg = 'broken pipe'
1732
else:
1733
msg = str(e).rstrip('\n')
1734
_report_exception(msg, quiet)
1735
return 2
1736
finally:
1737
bzrlib.trace.close_trace()
1738
551
1739
552
1740
if __name__ == '__main__':
553
1741
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1