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