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