« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1530.2.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1530.2.1
- Committer: Robert Collins
- Date: 2005-12-24 02:20:45 UTC
- mto: (1185.50.57 bzr-jam-integration)
- mto: This revision was merged to the branch mainline in revision 1550.
- Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.
- files added:
- HACKING
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- patches
- tools
- files removed:
- bzrlib/cache.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- contrib/bash/bzr => contrib/bash/bzr.simple
- bzrlib/newinventory.py => contrib/newinventory.py
- 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
19
import sys, os, time, os.path
20
from sets import Set
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
21
35
22
36
import bzrlib
23
from bzrlib.trace import mutter, note, log_error
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
27
from bzrlib.revision import Revision
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
format_date
37
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
40
BzrCheckError,
41
BzrCommandError,
42
BzrOptionError,
43
NotBranchError)
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
46
from bzrlib.option import Option
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd, decorate=False):
52
"Utility function to help register a command"
53
global plugin_cmds
54
k = cmd.__name__
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
57
else:
58
k_unsquished = k
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
64
elif decorate:
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
67
return result
68
else:
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
30
71
31
72
32
73
def _squish_command_name(cmd):
37
78
assert cmd.startswith("cmd_")
38
79
return cmd[4:].replace('_','-')
39
80
40
def get_all_cmds():
81
82
def _builtin_commands():
83
import bzrlib.builtins
84
r = {}
85
builtins = bzrlib.builtins.__dict__
86
for name in builtins:
87
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
90
return r
91
92
93
94
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
97
98
99
def plugin_command_names():
100
return plugin_cmds.keys()
101
102
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
106
if plugins_override:
107
d.update(plugin_cmds)
108
return d
109
110
111
def get_all_cmds(plugins_override=True):
41
112
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
45
46
def get_cmd_class(cmd):
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
114
yield k,v
115
116
117
def get_cmd_object(cmd_name, plugins_override=True):
47
118
"""Return the canonical name and command class for a command.
119
120
plugins_override
121
If true, plugin commands can override builtins.
48
122
"""
49
cmd = str(cmd) # not unicode
123
from bzrlib.externalcommand import ExternalCommand
124
125
cmd_name = str(cmd_name) # not unicode
50
126
51
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
52
129
try:
53
return cmd, globals()[_squish_command_name(cmd)]
130
return cmds[cmd_name]()
54
131
except KeyError:
55
132
pass
56
133
57
134
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
61
else:
62
raise BzrCommandError("unknown command %r" % cmd)
63
64
65
class Command:
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
137
return cmd_class()
138
139
cmd_obj = ExternalCommand.find_command(cmd_name)
140
if cmd_obj:
141
return cmd_obj
142
143
raise BzrCommandError("unknown command %r" % cmd_name)
144
145
146
class Command(object):
66
147
"""Base class for commands.
67
148
149
Commands are the heart of the command-line bzr interface.
150
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
153
into textual output.
154
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
159
68
160
The docstring for an actual command should give a single-line
69
161
summary, then a complete description of the command. A grammar
70
162
description will be inserted.
71
163
164
aliases
165
Other accepted names for this command.
166
72
167
takes_args
73
168
List of argument forms, marked with whether they are optional,
74
169
repeated, etc.
75
170
171
Examples:
172
173
['to_location', 'from_branch?', 'file*']
174
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
178
76
179
takes_options
77
List of options that may be given for this command.
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
78
183
79
184
hidden
80
If true, this command isn't advertised.
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
81
187
"""
82
188
aliases = []
83
84
189
takes_args = []
85
190
takes_options = []
86
191
87
192
hidden = False
88
193
89
def __init__(self, options, arguments):
90
"""Construct and run the command.
91
92
Sets self.status to the return value of run()."""
93
assert isinstance(options, dict)
94
assert isinstance(arguments, dict)
95
cmdargs = options.copy()
96
cmdargs.update(arguments)
97
assert self.__doc__ != Command.__doc__, \
98
("No help message set for %r" % self)
99
self.status = self.run(**cmdargs)
100
194
def __init__(self):
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
198
199
def options(self):
200
"""Return dict of valid options for this command.
201
202
Maps from long option name to option object."""
203
r = dict()
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
208
r[o.name] = o
209
return r
210
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
217
return 0
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
220
for oname in opts:
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
226
cmdopts = {}
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
229
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
232
233
return self.run(**all_cmd_args)
101
234
102
235
def run(self):
103
"""Override this in sub-classes.
236
"""Actually run the command.
104
237
105
238
This is invoked with the options and arguments bound to
106
239
keyword parameters.
107
240
108
Return 0 or None if the command was successful, or a shell
109
error code if not.
110
"""
111
return 0
112
113
114
115
class cmd_status(Command):
116
"""Display status summary.
117
118
For each file there is a single line giving its file state and name.
119
The name is that in the current revision unless it is deleted or
120
missing, in which case the old name is shown.
121
"""
122
takes_options = ['all']
123
aliases = ['st', 'stat']
124
125
def run(self, all=False):
126
#import bzrlib.status
127
#bzrlib.status.tree_status(Branch('.'))
128
Branch('.').show_status(show_all=all)
129
130
131
class cmd_cat_revision(Command):
132
"""Write out metadata for a revision."""
133
134
hidden = True
135
takes_args = ['revision_id']
136
137
def run(self, revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
139
140
141
class cmd_revno(Command):
142
"""Show current revision number.
143
144
This is equal to the number of revisions on this branch."""
145
def run(self):
146
print Branch('.').revno()
147
148
149
class cmd_add(Command):
150
"""Add specified files or directories.
151
152
In non-recursive mode, all the named items are added, regardless
153
of whether they were previously ignored. A warning is given if
154
any of the named files are already versioned.
155
156
In recursive mode (the default), files are treated the same way
157
but the behaviour for directories is different. Directories that
158
are already versioned do not give a warning. All directories,
159
whether already versioned or not, are searched for files or
160
subdirectories that are neither versioned or ignored, and these
161
are added. This search proceeds recursively into versioned
162
directories.
163
164
Therefore simply saying 'bzr add .' will version all files that
165
are currently unknown.
166
167
TODO: Perhaps adding a file whose directly is not versioned should
168
recursively add that parent, rather than giving an error?
169
"""
170
takes_args = ['file+']
171
takes_options = ['verbose']
172
173
def run(self, file_list, verbose=False):
174
bzrlib.add.smart_add(file_list, verbose)
175
176
177
class cmd_relpath(Command):
178
"""Show path of a file relative to root"""
179
takes_args = ('filename')
180
181
def run(self):
182
print Branch(self.args['filename']).relpath(filename)
183
184
185
186
class cmd_inventory(Command):
187
"""Show inventory of the current working copy or a revision."""
188
takes_options = ['revision']
189
190
def run(self, revision=None):
191
b = Branch('.')
192
if revision == None:
193
inv = b.read_working_inventory()
194
else:
195
inv = b.get_revision_inventory(b.lookup_revision(revision))
196
197
for path, entry in inv.iter_entries():
198
print '%-50s %s' % (entry.file_id, path)
199
200
201
class cmd_move(Command):
202
"""Move files to a different directory.
203
204
examples:
205
bzr move *.txt doc
206
207
The destination must be a versioned directory in the same branch.
208
"""
209
takes_args = ['source$', 'dest']
210
def run(self, source_list, dest):
211
b = Branch('.')
212
213
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
214
215
216
class cmd_rename(Command):
217
"""Change the name of an entry.
218
219
examples:
220
bzr rename frob.c frobber.c
221
bzr rename src/frob.c lib/frob.c
222
223
It is an error if the destination name exists.
224
225
See also the 'move' command, which moves files into a different
226
directory without changing their name.
227
228
TODO: Some way to rename multiple files without invoking bzr for each
229
one?"""
230
takes_args = ['from_name', 'to_name']
231
232
def run(self, from_name, to_name):
233
b = Branch('.')
234
b.rename_one(b.relpath(from_name), b.relpath(to_name))
235
236
237
238
class cmd_renames(Command):
239
"""Show list of renamed files.
240
241
TODO: Option to show renames between two historical versions.
242
243
TODO: Only show renames under dir, rather than in the whole branch.
244
"""
245
takes_args = ['dir?']
246
247
def run(self, dir='.'):
248
b = Branch(dir)
249
old_inv = b.basis_tree().inventory
250
new_inv = b.read_working_inventory()
251
252
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
253
renames.sort()
254
for old_name, new_name in renames:
255
print "%s => %s" % (old_name, new_name)
256
257
258
class cmd_info(Command):
259
"""Show statistical information for this branch"""
260
def run(self):
261
import info
262
info.show_info(Branch('.'))
263
264
265
class cmd_remove(Command):
266
"""Make a file unversioned.
267
268
This makes bzr stop tracking changes to a versioned file. It does
269
not delete the working copy.
270
"""
271
takes_args = ['file+']
272
takes_options = ['verbose']
273
274
def run(self, file_list, verbose=False):
275
b = Branch(file_list[0])
276
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
277
278
279
class cmd_file_id(Command):
280
"""Print file_id of a particular file or directory.
281
282
The file_id is assigned when the file is first added and remains the
283
same through all revisions where the file exists, even when it is
284
moved or renamed.
285
"""
286
hidden = True
287
takes_args = ['filename']
288
def run(self, filename):
289
b = Branch(filename)
290
i = b.inventory.path2id(b.relpath(filename))
291
if i == None:
292
bailout("%r is not a versioned file" % filename)
293
else:
294
print i
295
296
297
class cmd_file_path(Command):
298
"""Print path of file_ids to a file or directory.
299
300
This prints one line for each directory down to the target,
301
starting at the branch root."""
302
hidden = True
303
takes_args = ['filename']
304
def run(self, filename):
305
b = Branch(filename)
306
inv = b.inventory
307
fid = inv.path2id(b.relpath(filename))
308
if fid == None:
309
bailout("%r is not a versioned file" % filename)
310
for fip in inv.get_idpath(fid):
311
print fip
312
313
314
class cmd_revision_history(Command):
315
"""Display list of revision ids on this branch."""
316
def run(self):
317
for patchid in Branch('.').revision_history():
318
print patchid
319
320
321
class cmd_directories(Command):
322
"""Display list of versioned directories in this branch."""
323
def run(self):
324
for name, ie in Branch('.').read_working_inventory().directories():
325
if name == '':
326
print '.'
327
else:
328
print name
329
330
331
class cmd_init(Command):
332
"""Make a directory into a versioned branch.
333
334
Use this to create an empty branch, or before importing an
335
existing project.
336
337
Recipe for importing a tree of files:
338
cd ~/project
339
bzr init
340
bzr add -v .
341
bzr status
342
bzr commit -m 'imported project'
343
"""
344
def run(self):
345
Branch('.', init=True)
346
347
348
class cmd_diff(Command):
349
"""Show differences in working tree.
350
351
If files are listed, only the changes in those files are listed.
352
Otherwise, all changes for the tree are listed.
353
354
TODO: Given two revision arguments, show the difference between them.
355
356
TODO: Allow diff across branches.
357
358
TODO: Option to use external diff command; could be GNU diff, wdiff,
359
or a graphical diff.
360
361
TODO: Python difflib is not exactly the same as unidiff; should
362
either fix it up or prefer to use an external diff.
363
364
TODO: If a directory is given, diff everything under that.
365
366
TODO: Selected-file diff is inefficient and doesn't show you
367
deleted files.
368
369
TODO: This probably handles non-Unix newlines poorly.
370
"""
371
372
takes_args = ['file*']
373
takes_options = ['revision']
374
aliases = ['di']
375
376
def run(self, revision=None, file_list=None):
377
from bzrlib.diff import show_diff
378
379
show_diff(Branch('.'), revision, file_list)
380
381
382
class cmd_deleted(Command):
383
"""List files deleted in the working tree.
384
385
TODO: Show files deleted since a previous revision, or between two revisions.
386
"""
387
def run(self, show_ids=False):
388
b = Branch('.')
389
old = b.basis_tree()
390
new = b.working_tree()
391
392
## TODO: Much more efficient way to do this: read in new
393
## directories with readdir, rather than stating each one. Same
394
## level of effort but possibly much less IO. (Or possibly not,
395
## if the directories are very large...)
396
397
for path, ie in old.inventory.iter_entries():
398
if not new.has_id(ie.file_id):
399
if show_ids:
400
print '%-50s %s' % (path, ie.file_id)
401
else:
402
print path
403
404
class cmd_root(Command):
405
"""Show the tree root directory.
406
407
The root is the nearest enclosing directory with a .bzr control
408
directory."""
409
takes_args = ['filename?']
410
def run(self, filename=None):
411
"""Print the branch root."""
412
print bzrlib.branch.find_branch_root(filename)
413
414
415
416
class cmd_log(Command):
417
"""Show log of this branch.
418
419
TODO: Option to limit range.
420
421
TODO: Perhaps show most-recent first with an option for last.
422
"""
423
takes_args = ['filename?']
424
takes_options = ['timezone', 'verbose', 'show-ids']
425
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
426
b = Branch((filename or '.'), lock_mode='r')
427
if filename:
428
filename = b.relpath(filename)
429
bzrlib.show_log(b, filename,
430
show_timezone=timezone,
431
verbose=verbose,
432
show_ids=show_ids)
433
434
435
436
class cmd_touching_revisions(Command):
437
"""Return revision-ids which affected a particular file."""
438
hidden = True
439
takes_args = ["filename"]
440
def run(self, filename):
441
b = Branch(filename, lock_mode='r')
442
inv = b.read_working_inventory()
443
file_id = inv.path2id(b.relpath(filename))
444
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
445
print "%6d %s" % (revno, what)
446
447
448
class cmd_ls(Command):
449
"""List files in a tree.
450
451
TODO: Take a revision or remote path and list that tree instead.
452
"""
453
hidden = True
454
def run(self, revision=None, verbose=False):
455
b = Branch('.')
456
if revision == None:
457
tree = b.working_tree()
458
else:
459
tree = b.revision_tree(b.lookup_revision(revision))
460
461
for fp, fc, kind, fid in tree.list_files():
462
if verbose:
463
if kind == 'directory':
464
kindch = '/'
465
elif kind == 'file':
466
kindch = ''
467
else:
468
kindch = '???'
469
470
print '%-8s %s%s' % (fc, fp, kindch)
471
else:
472
print fp
473
474
475
476
class cmd_unknowns(Command):
477
"""List unknown files"""
478
def run(self):
479
for f in Branch('.').unknowns():
480
print quotefn(f)
481
482
483
484
class cmd_ignore(Command):
485
"""Ignore a command or pattern"""
486
takes_args = ['name_pattern']
487
488
def run(self, name_pattern):
489
b = Branch('.')
490
491
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
492
f = open(b.abspath('.bzrignore'), 'at')
493
f.write(name_pattern + '\n')
494
f.close()
495
496
inv = b.working_tree().inventory
497
if inv.path2id('.bzrignore'):
498
mutter('.bzrignore is already versioned')
499
else:
500
mutter('need to make new .bzrignore file versioned')
501
b.add(['.bzrignore'])
502
503
504
505
class cmd_ignored(Command):
506
"""List ignored files and the patterns that matched them."""
507
def run(self):
508
tree = Branch('.').working_tree()
509
for path, file_class, kind, file_id in tree.list_files():
510
if file_class != 'I':
511
continue
512
## XXX: Slightly inefficient since this was already calculated
513
pat = tree.is_ignored(path)
514
print '%-50s %s' % (path, pat)
515
516
517
class cmd_lookup_revision(Command):
518
"""Lookup the revision-id from a revision-number
519
520
example:
521
bzr lookup-revision 33
522
"""
523
hidden = True
524
takes_args = ['revno']
525
526
def run(self, revno):
527
try:
528
revno = int(revno)
529
except ValueError:
530
raise BzrCommandError("not a valid revision-number: %r" % revno)
531
532
print Branch('.').lookup_revision(revno)
533
534
535
class cmd_export(Command):
536
"""Export past revision to destination directory.
537
538
If no revision is specified this exports the last committed revision."""
539
takes_args = ['dest']
540
takes_options = ['revision']
541
def run(self, dest, revno=None):
542
b = Branch('.')
543
if revno == None:
544
rh = b.revision_history[-1]
545
else:
546
rh = b.lookup_revision(int(revno))
547
t = b.revision_tree(rh)
548
t.export(dest)
549
550
551
class cmd_cat(Command):
552
"""Write a file's text from a previous revision."""
553
554
takes_options = ['revision']
555
takes_args = ['filename']
556
557
def run(self, filename, revision=None):
558
if revision == None:
559
raise BzrCommandError("bzr cat requires a revision number")
560
b = Branch('.')
561
b.print_file(b.relpath(filename), int(revision))
562
563
564
class cmd_local_time_offset(Command):
565
"""Show the offset in seconds from GMT to local time."""
566
hidden = True
567
def run(self):
568
print bzrlib.osutils.local_time_offset()
569
570
571
572
class cmd_commit(Command):
573
"""Commit changes into a new revision.
574
575
TODO: Commit only selected files.
576
577
TODO: Run hooks on tree to-be-committed, and after commit.
578
579
TODO: Strict commit that fails if there are unknown or deleted files.
580
"""
581
takes_options = ['message', 'file', 'verbose']
582
aliases = ['ci', 'checkin']
583
584
def run(self, message=None, file=None, verbose=False):
585
## Warning: shadows builtin file()
586
if not message and not file:
587
raise BzrCommandError("please specify a commit message",
588
["use either --message or --file"])
589
elif message and file:
590
raise BzrCommandError("please specify either --message or --file")
591
592
if file:
593
import codecs
594
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
595
596
Branch('.').commit(message, verbose=verbose)
597
598
599
class cmd_check(Command):
600
"""Validate consistency of branch history.
601
602
This command checks various invariants about the branch storage to
603
detect data corruption or bzr bugs.
604
"""
605
takes_args = ['dir?']
606
def run(self, dir='.'):
607
import bzrlib.check
608
bzrlib.check.check(Branch(dir, find_root=False))
609
610
611
612
class cmd_whoami(Command):
613
"""Show bzr user id."""
614
takes_options = ['email']
615
616
def run(self, email=False):
617
if email:
618
print bzrlib.osutils.user_email()
619
else:
620
print bzrlib.osutils.username()
621
622
623
class cmd_selftest(Command):
624
"""Run internal test suite"""
625
hidden = True
626
def run(self):
627
failures, tests = 0, 0
628
629
import doctest, bzrlib.store, bzrlib.tests
630
bzrlib.trace.verbose = False
631
632
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
633
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
634
mf, mt = doctest.testmod(m)
635
failures += mf
636
tests += mt
637
print '%-40s %3d tests' % (m.__name__, mt),
638
if mf:
639
print '%3d FAILED!' % mf
640
else:
641
print
642
643
print '%-40s %3d tests' % ('total', tests),
644
if failures:
645
print '%3d FAILED!' % failures
646
else:
647
print
648
649
650
651
class cmd_version(Command):
652
"""Show version of bzr"""
653
def run(self):
654
show_version()
655
656
def show_version():
657
print "bzr (bazaar-ng) %s" % bzrlib.__version__
658
print bzrlib.__copyright__
659
print "http://bazaar-ng.org/"
660
print
661
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
662
print "you may use, modify and redistribute it under the terms of the GNU"
663
print "General Public License version 2 or later."
664
665
666
class cmd_rocks(Command):
667
"""Statement of optimism."""
668
hidden = True
669
def run(self):
670
print "it sure does!"
671
672
673
class cmd_assert_fail(Command):
674
"""Test reporting of assertion failures"""
675
hidden = True
676
def run(self):
677
assert False, "always fails"
678
679
680
class cmd_help(Command):
681
"""Show help on a command or other topic.
682
683
For a list of all available commands, say 'bzr help commands'."""
684
takes_args = ['topic?']
685
aliases = ['?']
686
687
def run(self, topic=None):
688
import help
689
help.help(topic)
690
691
692
######################################################################
693
# main routine
694
695
696
# list of all available options; the rhs can be either None for an
697
# option that takes no argument, or a constructor function that checks
698
# the type.
699
OPTIONS = {
700
'all': None,
701
'help': None,
702
'file': unicode,
703
'message': unicode,
704
'profile': None,
705
'revision': int,
706
'show-ids': None,
707
'timezone': str,
708
'verbose': None,
709
'version': None,
710
'email': None,
711
}
712
713
SHORT_OPTIONS = {
714
'm': 'message',
715
'F': 'file',
716
'r': 'revision',
717
'v': 'verbose',
718
}
719
720
721
def parse_args(argv):
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
244
"""
245
raise NotImplementedError()
246
247
248
def help(self):
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
251
return None
252
return getdoc(self)
253
254
def name(self):
255
return _unsquish_command_name(self.__class__.__name__)
256
257
258
def parse_spec(spec):
259
"""
260
>>> parse_spec(None)
261
[None, None]
262
>>> parse_spec("./")
263
['./', None]
264
>>> parse_spec("../@")
265
['..', -1]
266
>>> parse_spec("../f/@35")
267
['../f', 35]
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
270
"""
271
if spec is None:
272
return [None, None]
273
if '/@' in spec:
274
parsed = spec.split('/@')
275
assert len(parsed) == 2
276
if parsed[1] == "":
277
parsed[1] = -1
278
else:
279
try:
280
parsed[1] = int(parsed[1])
281
except ValueError:
282
pass # We can allow stuff like ./@revid:blahblahblah
283
else:
284
assert parsed[1] >=0
285
else:
286
parsed = [spec, None]
287
return parsed
288
289
def parse_args(command, argv):
722
290
"""Parse command line.
723
291
724
292
Arguments and options are parsed at this level before being passed
725
293
down to specific command handlers. This routine knows, from a
726
294
lookup table, something about the available options, what optargs
727
295
they take, and which commands will accept them.
728
729
>>> parse_args('--help'.split())
730
([], {'help': True})
731
>>> parse_args('--version'.split())
732
([], {'version': True})
733
>>> parse_args('status --all'.split())
734
(['status'], {'all': True})
735
>>> parse_args('commit --message=biter'.split())
736
(['commit'], {'message': u'biter'})
737
296
"""
297
# TODO: chop up this beast; make it a method of the Command
738
298
args = []
739
299
opts = {}
740
300
741
# TODO: Maybe handle '--' to end options?
742
301
cmd_options = command.options()
302
argsover = False
743
303
while argv:
744
304
a = argv.pop(0)
305
if argsover:
306
args.append(a)
307
continue
308
elif a == '--':
309
# We've received a standalone -- No more flags
310
argsover = True
311
continue
745
312
if a[0] == '-':
746
313
# option names must not be unicode
747
314
a = str(a)
748
315
optarg = None
749
316
if a[1] == '-':
750
mutter(" got option %r" % a)
317
mutter(" got option %r", a)
751
318
if '=' in a:
752
319
optname, optarg = a[2:].split('=', 1)
753
320
else:
754
321
optname = a[2:]
755
if optname not in OPTIONS:
756
bailout('unknown long option %r' % a)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
757
325
else:
758
326
shortopt = a[1:]
759
if shortopt not in SHORT_OPTIONS:
760
bailout('unknown short option %r' % a)
761
optname = SHORT_OPTIONS[shortopt]
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
329
# their value
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
332
else:
333
# Single character short options, can be chained,
334
# and have their value appended to their name
335
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
341
342
if a[2:]:
343
# There are extra things on this option
344
# see if it is the value, or if it is another
345
# short option
346
optargfn = Option.OPTIONS[optname].type
347
if optargfn is None:
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
350
# into the list
351
argv.insert(0, '-' + a[2:])
352
else:
353
# This option takes an argument, so pack it
354
# into the array
355
optarg = a[2:]
762
356
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
763
360
if optname in opts:
764
361
# XXX: Do we ever want to support this, e.g. for -r?
765
bailout('repeated option %r' % a)
362
raise BzrError('repeated option %r' % a)
766
363
767
optargfn = OPTIONS[optname]
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
768
366
if optargfn:
769
367
if optarg == None:
770
368
if not argv:
771
bailout('option %r needs an argument' % a)
369
raise BzrError('option %r needs an argument' % a)
772
370
else:
773
371
optarg = argv.pop(0)
774
372
opts[optname] = optargfn(optarg)
775
373
else:
776
374
if optarg != None:
777
bailout('option %r takes no argument' % optname)
375
raise BzrError('option %r takes no argument' % optname)
778
376
opts[optname] = True
779
377
else:
780
378
args.append(a)
781
782
379
return args, opts
783
380
784
381
785
786
787
382
def _match_argform(cmd, takes_args, args):
788
383
argdict = {}
789
384
829
424
830
425
831
426
427
def apply_profiled(the_callable, *args, **kwargs):
428
import hotshot
429
import tempfile
430
import hotshot.stats
431
pffileno, pfname = tempfile.mkstemp()
432
try:
433
prof = hotshot.Profile(pfname)
434
try:
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
436
finally:
437
prof.close()
438
stats = hotshot.stats.load(pfname)
439
stats.strip_dirs()
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
444
return ret
445
finally:
446
os.close(pffileno)
447
os.remove(pfname)
448
449
450
def apply_lsprofiled(the_callable, *args, **kwargs):
451
from bzrlib.lsprof import profile
452
ret,stats = profile(the_callable,*args,**kwargs)
453
stats.sort()
454
stats.pprint()
455
return ret
456
832
457
def run_bzr(argv):
833
458
"""Execute a command.
834
459
835
460
This is similar to main(), but without all the trappings for
836
461
logging and error handling.
462
463
argv
464
The command-line arguments, without the program name from argv[0]
465
466
Returns a command status or raises an exception.
467
468
Special master options: these must come before the command because
469
they control how the command is interpreted.
470
471
--no-plugins
472
Do not load plugin modules at all
473
474
--builtin
475
Only use builtin commands. (Plugins are still allowed to change
476
other behaviour.)
477
478
--profile
479
Run under the Python hotshot profiler.
480
481
--lsprof
482
Run under the Python lsprof profiler.
837
483
"""
838
484
argv = [a.decode(bzrlib.user_encoding) for a in argv]
839
485
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
487
488
# --no-plugins is handled specially at a very early stage. We need
489
# to load plugins before doing other command parsing so that they
490
# can override commands, but this needs to happen first.
491
492
for a in argv:
493
if a == '--profile':
494
opt_profile = True
495
elif a == '--lsprof':
496
opt_lsprof = True
497
elif a == '--no-plugins':
498
opt_no_plugins = True
499
elif a == '--builtin':
500
opt_builtin = True
501
elif a in ('--quiet', '-q'):
502
be_quiet()
503
else:
504
continue
505
argv.remove(a)
506
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
509
if len(argv) > 1:
510
help(argv[1])
511
else:
512
help()
513
return 0
514
515
if argv[0] == '--version':
516
from bzrlib.builtins import show_version
517
show_version()
518
return 0
519
520
if not opt_no_plugins:
521
from bzrlib.plugin import load_plugins
522
load_plugins()
523
524
cmd = str(argv.pop(0))
525
526
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
527
840
528
try:
841
args, opts = parse_args(argv[1:])
842
if 'help' in opts:
843
import help
844
if args:
845
help.help(args[0])
846
else:
847
help.help()
848
return 0
849
elif 'version' in opts:
850
show_version()
851
return 0
852
cmd = str(args.pop(0))
853
except IndexError:
854
log_error('usage: bzr COMMAND')
855
log_error(' try "bzr help"')
856
return 1
857
858
canonical_cmd, cmd_class = get_cmd_class(cmd)
859
860
# global option
861
if 'profile' in opts:
862
profile = True
863
del opts['profile']
864
else:
865
profile = False
866
867
# check options are reasonable
868
allowed = cmd_class.takes_options
869
for oname in opts:
870
if oname not in allowed:
871
raise BzrCommandError("option '--%s' is not allowed for command %r"
872
% (oname, cmd))
873
874
# mix arguments and options into one dictionary
875
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
876
cmdopts = {}
877
for k, v in opts.items():
878
cmdopts[k.replace('-', '_')] = v
879
880
if profile:
881
import hotshot, tempfile
882
pffileno, pfname = tempfile.mkstemp()
529
if opt_lsprof:
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
531
elif opt_profile:
532
ret = apply_profiled(cmd_obj.run_argv, argv)
533
else:
534
ret = cmd_obj.run_argv(argv)
535
return ret or 0
536
finally:
537
# reset, in case we may do other commands later within the same process
538
be_quiet(False)
539
540
def display_command(func):
541
"""Decorator that suppresses pipe/interrupt errors."""
542
def ignore_pipe(*args, **kwargs):
883
543
try:
884
prof = hotshot.Profile(pfname)
885
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
886
prof.close()
887
888
import hotshot.stats
889
stats = hotshot.stats.load(pfname)
890
#stats.strip_dirs()
891
stats.sort_stats('time')
892
## XXX: Might like to write to stderr or the trace file instead but
893
## print_stats seems hardcoded to stdout
894
stats.print_stats(20)
895
896
return ret.status
897
898
finally:
899
os.close(pffileno)
900
os.remove(pfname)
901
else:
902
cmdobj = cmd_class(cmdopts, cmdargs).status
903
904
905
def _report_exception(summary, quiet=False):
906
import traceback
907
log_error('bzr: ' + summary)
908
bzrlib.trace.log_exception()
909
910
if not quiet:
911
tb = sys.exc_info()[2]
912
exinfo = traceback.extract_tb(tb)
913
if exinfo:
914
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
915
sys.stderr.write(' see ~/.bzr.log for debug information\n')
916
544
result = func(*args, **kwargs)
545
sys.stdout.flush()
546
return result
547
except IOError, e:
548
if not hasattr(e, 'errno'):
549
raise
550
if e.errno != errno.EPIPE:
551
raise
552
pass
553
except KeyboardInterrupt:
554
pass
555
return ignore_pipe
917
556
918
557
919
558
def main(argv):
920
import errno
921
922
bzrlib.open_tracefile(argv)
923
559
import bzrlib.ui
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
563
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
566
return ret
567
568
569
def run_bzr_catch_errors(argv):
924
570
try:
925
571
try:
926
try:
927
return run_bzr(argv)
928
finally:
929
# do this here inside the exception wrappers to catch EPIPE
930
sys.stdout.flush()
931
except BzrError, e:
932
quiet = isinstance(e, (BzrCommandError))
933
_report_exception('error: ' + e.args[0], quiet=quiet)
934
if len(e.args) > 1:
935
for h in e.args[1]:
936
# some explanation or hints
937
log_error(' ' + h)
938
return 1
939
except AssertionError, e:
940
msg = 'assertion failed'
941
if str(e):
942
msg += ': ' + str(e)
943
_report_exception(msg)
944
return 2
945
except KeyboardInterrupt, e:
946
_report_exception('interrupted', quiet=True)
947
return 2
948
except Exception, e:
949
quiet = False
950
if isinstance(e, IOError) and e.errno == errno.EPIPE:
951
quiet = True
952
msg = 'broken pipe'
953
else:
954
msg = str(e).rstrip('\n')
955
_report_exception(msg, quiet)
956
return 2
957
finally:
958
bzrlib.trace.close_trace()
959
572
return run_bzr(argv)
573
finally:
574
# do this here inside the exception wrappers to catch EPIPE
575
sys.stdout.flush()
576
except Exception, e:
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
579
import errno
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
584
return 3
585
else:
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
589
import pdb
590
pdb.post_mortem(sys.exc_traceback)
591
return 3
960
592
961
593
if __name__ == '__main__':
962
594
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1