« 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:
- .rsyncexclude
- contrib
- contrib/bash
- contrib/zsh
- elementtree
- urlgrabber
- files removed:
- doc/faq.txt
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
#! /usr/bin/python
2
3
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
6
1
# Copyright (C) 2004, 2005 by Canonical Ltd
7
2
8
3
# This program is free software; you can redistribute it and/or modify
9
4
# it under the terms of the GNU General Public License as published by
19
14
# along with this program; if not, write to the Free Software
20
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
16
22
"""Bazaar-NG -- a free distributed version-control tool
23
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
25
26
Current limitation include:
27
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
30
31
* No handling of subdirectories, symlinks or any non-text files.
32
33
* Insufficient error handling.
34
35
* Many commands unimplemented or partially implemented.
36
37
* Space-inefficient storage.
38
39
* No merge operators yet.
40
41
Interesting commands::
42
43
bzr help
44
Show summary help screen
45
bzr version
46
Show software version/licence/non-warranty.
47
bzr init
48
Start versioning the current directory
49
bzr add FILE...
50
Make files versioned.
51
bzr log
52
Show revision history.
53
bzr diff
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
59
bzr status
60
Show summary of pending changes.
61
bzr remove FILE...
62
Make a file not versioned.
63
"""
64
65
# not currently working:
66
# bzr info
67
# Show some information about this branch.
68
69
70
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
74
__version__ = '0.0.0'
75
76
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
79
from os import path
17
18
19
import sys, os, time, os.path
80
20
from sets import Set
81
from pprint import pprint
82
from stat import *
83
from glob import glob
84
21
85
22
import bzrlib
86
from bzrlib.store import ImmutableStore
87
23
from bzrlib.trace import mutter, note, log_error
88
from bzrlib.errors import bailout, BzrError
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
89
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
27
from bzrlib.revision import Revision
92
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
93
29
format_date
94
30
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
97
98
## standard representation
99
NONE_STRING = '(none)'
100
EMPTY = 'empty'
101
102
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
105
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
107
108
## TODO: Some kind of locking on branches. Perhaps there should be a
109
## parameter to the branch object saying whether we want a read or
110
## write lock; release it from destructor. Perhaps don't even need a
111
## read lock to look at immutable objects?
112
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
115
116
## TODO: Some kind of global code to generate the right Branch object
117
## to work on. Almost, but not quite all, commands need one, and it
118
## can be taken either from their parameters or their working
119
## directory.
120
121
## TODO: rename command, needed soon: check destination doesn't exist
122
## either in working copy or tree; move working copy; update
123
## inventory; write out
124
125
## TODO: move command; check destination is a directory and will not
126
## clash; move it.
127
128
## TODO: command to show renames, one per line, as to->from
129
130
131
132
133
def cmd_status(all=False):
31
32
def _squish_command_name(cmd):
33
return 'cmd_' + cmd.replace('-', '_')
34
35
36
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
38
return cmd[4:].replace('_','-')
39
40
def get_all_cmds():
41
"""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):
47
"""Return the canonical name and command class for a command.
48
"""
49
cmd = str(cmd) # not unicode
50
51
# first look up this command under the specified name
52
try:
53
return cmd, globals()[_squish_command_name(cmd)]
54
except KeyError:
55
pass
56
57
# 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
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:
70
"""Base class for commands.
71
72
The docstring for an actual command should give a single-line
73
summary, then a complete description of the command. A grammar
74
description will be inserted.
75
76
takes_args
77
List of argument forms, marked with whether they are optional,
78
repeated, etc.
79
80
takes_options
81
List of options that may be given for this command.
82
83
hidden
84
If true, this command isn't advertised.
85
"""
86
aliases = []
87
88
takes_args = []
89
takes_options = []
90
91
hidden = False
92
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)
104
105
106
def run(self):
107
"""Override this in sub-classes.
108
109
This is invoked with the options and arguments bound to
110
keyword parameters.
111
112
Return 0 or None if the command was successful, or a shell
113
error code if not.
114
"""
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):
134
187
"""Display status summary.
135
188
136
189
For each file there is a single line giving its file state and name.
137
190
The name is that in the current revision unless it is deleted or
138
191
missing, in which case the old name is shown.
139
140
:todo: Don't show unchanged files unless ``--all`` is given?
141
"""
142
Branch('.').show_status(show_all=all)
143
144
145
146
######################################################################
147
# examining history
148
def cmd_get_revision(revision_id):
149
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
150
151
152
def cmd_get_file_text(text_id):
153
"""Get contents of a file by hash."""
154
sf = Branch('.').text_store[text_id]
155
pumpfile(sf, sys.stdout)
156
157
158
159
######################################################################
160
# commands
161
162
163
def cmd_revno():
164
"""Show number of revisions on this branch"""
165
print Branch('.').revno()
166
167
168
def cmd_add(file_list, verbose=False):
169
"""Add specified files.
170
171
Fails if the files are already added.
172
"""
173
Branch('.').add(file_list, verbose=verbose)
174
175
176
def cmd_inventory(revision=None):
177
"""Show inventory of the current working copy."""
178
## TODO: Also optionally show a previous inventory
179
## TODO: Format options
180
b = Branch('.')
181
if revision == None:
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')
182
515
inv = b.read_working_inventory()
183
else:
184
inv = b.get_revision_inventory(b.lookup_revision(revision))
185
186
for path, entry in inv.iter_entries():
187
print '%-50s %s' % (entry.file_id, path)
188
189
190
191
def cmd_info():
192
b = Branch('.')
193
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
194
195
def plural(n, base='', pl=None):
196
if n == 1:
197
return base
198
elif pl is not None:
199
return pl
200
else:
201
return 's'
202
203
count_version_dirs = 0
204
205
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
206
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
207
fs = st_tup[0]
208
count_status[fs] += 1
209
if fs not in ['I', '?'] and st_tup[4] == 'directory':
210
count_version_dirs += 1
211
212
print
213
print 'in the working tree:'
214
for name, fs in (('unchanged', '.'),
215
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
216
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
217
):
218
print ' %5d %s' % (count_status[fs], name)
219
print ' %5d versioned subdirector%s' % (count_version_dirs,
220
plural(count_version_dirs, 'y', 'ies'))
221
222
print
223
print 'branch history:'
224
history = b.revision_history()
225
revno = len(history)
226
print ' %5d revision%s' % (revno, plural(revno))
227
committers = Set()
228
for rev in history:
229
committers.add(b.get_revision(rev).committer)
230
print ' %5d committer%s' % (len(committers), plural(len(committers)))
231
if revno > 0:
232
firstrev = b.get_revision(history[0])
233
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
234
print ' %5d day%s old' % (age, plural(age))
235
print ' first revision: %s' % format_date(firstrev.timestamp,
236
firstrev.timezone)
237
238
lastrev = b.get_revision(history[-1])
239
print ' latest revision: %s' % format_date(lastrev.timestamp,
240
lastrev.timezone)
241
242
243
244
245
def cmd_remove(file_list, verbose=False):
246
Branch('.').remove(file_list, verbose=verbose)
247
248
249
250
def cmd_file_id(filename):
251
i = Branch('.').read_working_inventory().path2id(filename)
252
if i is None:
253
bailout("%s is not a versioned file" % filename)
254
else:
255
print i
256
257
258
def cmd_find_filename(fileid):
259
n = find_filename(fileid)
260
if n is None:
261
bailout("%s is not a live file id" % fileid)
262
else:
263
print n
264
265
266
def cmd_revision_history():
267
for patchid in Branch('.').revision_history():
268
print patchid
269
270
271
272
def cmd_init():
273
# TODO: Check we're not already in a working directory? At the
274
# moment you'll get an ugly error.
275
276
# TODO: What if we're in a subdirectory of a branch? Would like
277
# to allow that, but then the parent may need to understand that
278
# the children have disappeared, or should they be versioned in
279
# both?
280
281
# TODO: Take an argument/option for branch name.
282
Branch('.', init=True)
283
284
285
def cmd_diff(revision=None):
286
"""Show diff from basis to working copy.
287
288
:todo: Take one or two revision arguments, look up those trees,
289
and diff them.
290
291
:todo: Allow diff across branches.
292
293
:todo: Mangle filenames in diff to be more relevant.
294
295
:todo: Shouldn't be in the cmd function.
296
"""
297
298
b = Branch('.')
299
300
if revision == None:
301
old_tree = b.basis_tree()
302
else:
303
old_tree = b.revision_tree(b.lookup_revision(revision))
304
305
new_tree = b.working_tree()
306
old_inv = old_tree.inventory
307
new_inv = new_tree.inventory
308
309
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
310
old_label = ''
311
new_label = ''
312
313
DEVNULL = '/dev/null'
314
# Windows users, don't panic about this filename -- it is a
315
# special signal to GNU patch that the file should be created or
316
# deleted respectively.
317
318
# TODO: Generation of pseudo-diffs for added/deleted files could
319
# be usefully made into a much faster special case.
320
321
# TODO: Better to return them in sorted order I think.
322
323
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
324
d = None
325
326
# Don't show this by default; maybe do it if an option is passed
327
# idlabel = ' {%s}' % fid
328
idlabel = ''
329
330
# FIXME: Something about the diff format makes patch unhappy
331
# with newly-added files.
332
333
def diffit(*a, **kw):
334
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
335
print
336
337
if file_state in ['.', '?', 'I']:
338
continue
339
elif file_state == 'A':
340
print '*** added %s %r' % (kind, new_name)
341
if kind == 'file':
342
diffit([],
343
new_tree.get_file(fid).readlines(),
344
fromfile=DEVNULL,
345
tofile=new_label + new_name + idlabel)
346
elif file_state == 'D':
347
assert isinstance(old_name, types.StringTypes)
348
print '*** deleted %s %r' % (kind, old_name)
349
if kind == 'file':
350
diffit(old_tree.get_file(fid).readlines(), [],
351
fromfile=old_label + old_name + idlabel,
352
tofile=DEVNULL)
353
elif file_state in ['M', 'R']:
354
if file_state == 'M':
355
assert kind == 'file'
356
assert old_name == new_name
357
print '*** modified %s %r' % (kind, new_name)
358
elif file_state == 'R':
359
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
360
361
if kind == 'file':
362
diffit(old_tree.get_file(fid).readlines(),
363
new_tree.get_file(fid).readlines(),
364
fromfile=old_label + old_name + idlabel,
365
tofile=new_label + new_name)
366
else:
367
bailout("can't represent state %s {%s}" % (file_state, fid))
368
369
370
371
def cmd_log(timezone='original'):
372
"""Show log of this branch.
373
374
:todo: Options for utc; to show ids; to limit range; etc.
375
"""
376
Branch('.').write_log(show_timezone=timezone)
377
378
379
def cmd_ls(revision=None, verbose=False):
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):
380
522
"""List files in a tree.
381
523
382
:todo: Take a revision or remote path and list that tree instead.
524
TODO: Take a revision or remote path and list that tree instead.
383
525
"""
384
b = Branch('.')
385
if revision == None:
386
tree = b.working_tree()
387
else:
388
tree = b.revision_tree(b.lookup_revision(revision))
389
390
for fp, fc, kind, fid in tree.list_files():
391
if verbose:
392
if kind == 'directory':
393
kindch = '/'
394
elif kind == 'file':
395
kindch = ''
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)
396
544
else:
397
kindch = '???'
398
399
print '%-8s %s%s' % (fc, fp, kindch)
400
else:
401
print fp
402
403
404
405
def cmd_unknowns():
545
print fp
546
547
548
549
class cmd_unknowns(Command):
406
550
"""List unknown files"""
407
for f in Branch('.').unknowns():
408
print quotefn(f)
409
410
411
def cmd_lookup_revision(revno):
412
try:
413
revno = int(revno)
414
except ValueError:
415
bailout("usage: lookup-revision REVNO",
416
["REVNO is a non-negative revision number for this branch"])
417
418
print Branch('.').lookup_revision(revno) or NONE_STRING
419
420
421
422
def cmd_export(revno, dest):
423
"""Export past revision to destination directory."""
424
b = Branch('.')
425
rh = b.lookup_revision(int(revno))
426
t = b.revision_tree(rh)
427
t.export(dest)
428
429
430
431
######################################################################
432
# internal/test commands
433
434
435
def cmd_uuid():
436
"""Print a newly-generated UUID."""
437
print uuid()
438
439
440
441
def cmd_local_time_offset():
442
print bzrlib.osutils.local_time_offset()
443
444
445
446
def cmd_commit(message=None, verbose=False):
447
if not message:
448
bailout("please specify a commit message")
449
Branch('.').commit(message, verbose=verbose)
450
451
452
def cmd_check():
453
"""Check consistency of the branch."""
454
check()
455
456
457
def cmd_is(pred, *rest):
458
"""Test whether PREDICATE is true."""
459
try:
460
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
461
except KeyError:
462
bailout("unknown predicate: %s" % quotefn(pred))
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")
463
697
464
try:
465
cmd_handler(*rest)
466
except BzrCheckError:
467
# by default we don't print the message so that this can
468
# be used from shell scripts without producing noise
469
sys.exit(1)
470
471
472
def cmd_username():
473
print bzrlib.osutils.username()
474
475
476
def cmd_user_email():
477
print bzrlib.osutils.user_email()
478
479
480
def cmd_gen_revision_id():
481
import time
482
print bzrlib.branch._gen_revision_id(time.time())
483
484
485
def cmd_selftest(verbose=False):
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):
486
730
"""Run internal test suite"""
487
## -v, if present, is seen by doctest; the argument is just here
488
## so our parser doesn't complain
489
490
## TODO: --verbose option
491
492
failures, tests = 0, 0
493
494
import doctest, bzrlib.store, bzrlib.tests
495
bzrlib.trace.verbose = False
496
497
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
498
bzrlib.tree, bzrlib.tests, bzrlib.commands:
499
mf, mt = doctest.testmod(m)
500
failures += mf
501
tests += mt
502
print '%-40s %3d tests' % (m.__name__, mt),
503
if mf:
504
print '%3d FAILED!' % mf
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
505
752
else:
506
753
print
507
754
508
print '%-40s %3d tests' % ('total', tests),
509
if failures:
510
print '%3d FAILED!' % failures
511
else:
512
print
513
514
515
516
# deprecated
517
cmd_doctest = cmd_selftest
518
519
520
######################################################################
521
# help
522
523
524
def cmd_help():
525
# TODO: Specific help for particular commands
526
print __doc__
527
528
529
def cmd_version():
530
print "bzr (bazaar-ng) %s" % __version__
531
print __copyright__
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__
532
765
print "http://bazaar-ng.org/"
533
766
print
534
print \
535
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
536
you may use, modify and redistribute it under the terms of the GNU
537
General Public License version 2 or later."""
538
539
540
def cmd_rocks():
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):
541
773
"""Statement of optimism."""
542
print "it sure does!"
543
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)
544
796
545
797
546
798
######################################################################
553
805
OPTIONS = {
554
806
'all': None,
555
807
'help': None,
808
'file': unicode,
556
809
'message': unicode,
810
'profile': None,
557
811
'revision': int,
558
812
'show-ids': None,
559
813
'timezone': str,
560
814
'verbose': None,
561
815
'version': None,
816
'email': None,
562
817
}
563
818
564
819
SHORT_OPTIONS = {
565
820
'm': 'message',
821
'F': 'file',
566
822
'r': 'revision',
567
823
'v': 'verbose',
568
824
}
569
825
570
# List of options that apply to particular commands; commands not
571
# listed take none.
572
cmd_options = {
573
'add': ['verbose'],
574
'commit': ['message', 'verbose'],
575
'diff': ['revision'],
576
'inventory': ['revision'],
577
'log': ['show-ids', 'timezone'],
578
'ls': ['revision', 'verbose'],
579
'remove': ['verbose'],
580
'status': ['all'],
581
}
582
583
584
cmd_args = {
585
'init': [],
586
'add': ['file+'],
587
'commit': [],
588
'diff': [],
589
'file-id': ['filename'],
590
'get-file-text': ['text_id'],
591
'get-inventory': ['inventory_id'],
592
'get-revision': ['revision_id'],
593
'get-revision-inventory': ['revision_id'],
594
'log': [],
595
'lookup-revision': ['revno'],
596
'export': ['revno', 'dest'],
597
'remove': ['file+'],
598
'status': [],
599
}
600
601
826
602
827
def parse_args(argv):
603
828
"""Parse command line.
624
849
while argv:
625
850
a = argv.pop(0)
626
851
if a[0] == '-':
852
# option names must not be unicode
853
a = str(a)
627
854
optarg = None
628
855
if a[1] == '-':
629
856
mutter(" got option %r" % a)
651
878
else:
652
879
optarg = argv.pop(0)
653
880
opts[optname] = optargfn(optarg)
654
mutter(" option argument %r" % opts[optname])
655
881
else:
656
882
if optarg != None:
657
883
bailout('option %r takes no argument' % optname)
663
889
664
890
665
891
666
def _match_args(cmd, args):
667
"""Check non-option arguments match required pattern.
668
892
669
>>> _match_args('status', ['asdasdsadasd'])
670
Traceback (most recent call last):
671
...
672
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
673
>>> _match_args('add', ['asdasdsadasd'])
674
{'file_list': ['asdasdsadasd']}
675
>>> _match_args('add', 'abc def gj'.split())
676
{'file_list': ['abc', 'def', 'gj']}
677
"""
678
# match argument pattern
679
argform = cmd_args.get(cmd, [])
893
def _match_argform(cmd, takes_args, args):
680
894
argdict = {}
681
# TODO: Need a way to express 'cp SRC... DEST', where it matches
682
# all but one.
683
895
684
for ap in argform:
896
# step through args and takes_args, allowing appropriate 0-many matches
897
for ap in takes_args:
685
898
argname = ap[:-1]
686
899
if ap[-1] == '?':
687
assert 0
688
elif ap[-1] == '*':
689
assert 0
900
if args:
901
argdict[argname] = args.pop(0)
902
elif ap[-1] == '*': # all remaining arguments
903
if args:
904
argdict[argname + '_list'] = args[:]
905
args = []
906
else:
907
argdict[argname + '_list'] = None
690
908
elif ap[-1] == '+':
691
909
if not args:
692
bailout("command %r needs one or more %s"
910
raise BzrCommandError("command %r needs one or more %s"
693
911
% (cmd, argname.upper()))
694
912
else:
695
913
argdict[argname + '_list'] = args[:]
696
914
args = []
915
elif ap[-1] == '$': # all but one
916
if len(args) < 2:
917
raise BzrCommandError("command %r needs one or more %s"
918
% (cmd, argname.upper()))
919
argdict[argname + '_list'] = args[:-1]
920
args[:-1] = []
697
921
else:
698
922
# just a plain arg
699
923
argname = ap
700
924
if not args:
701
bailout("command %r requires argument %s"
925
raise BzrCommandError("command %r requires argument %s"
702
926
% (cmd, argname.upper()))
703
927
else:
704
928
argdict[argname] = args.pop(0)
705
929
706
930
if args:
707
bailout("extra arguments to command %s: %r"
708
% (cmd, args))
931
raise BzrCommandError("extra argument to command %s: %s"
932
% (cmd, args[0]))
709
933
710
934
return argdict
711
935
715
939
"""Execute a command.
716
940
717
941
This is similar to main(), but without all the trappings for
718
logging and error handling.
942
logging and error handling.
719
943
"""
944
argv = [a.decode(bzrlib.user_encoding) for a in argv]
945
720
946
try:
721
947
args, opts = parse_args(argv[1:])
722
948
if 'help' in opts:
723
# TODO: pass down other arguments in case they asked for
724
# help on a command name?
725
cmd_help()
949
import help
950
if args:
951
help.help(args[0])
952
else:
953
help.help()
726
954
return 0
727
955
elif 'version' in opts:
728
cmd_version()
956
show_version()
729
957
return 0
730
cmd = args.pop(0)
958
cmd = str(args.pop(0))
731
959
except IndexError:
732
log_error('usage: bzr COMMAND\n')
733
log_error(' try "bzr help"\n')
960
log_error('usage: bzr COMMAND')
961
log_error(' try "bzr help"')
734
962
return 1
735
736
try:
737
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
738
except KeyError:
739
bailout("unknown command " + `cmd`)
740
741
# TODO: special --profile option to turn on the Python profiler
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
742
972
743
973
# check options are reasonable
744
allowed = cmd_options.get(cmd, [])
974
allowed = cmd_class.takes_options
745
975
for oname in opts:
746
976
if oname not in allowed:
747
bailout("option %r is not allowed for command %r"
748
% (oname, cmd))
749
750
cmdargs = _match_args(cmd, args)
751
cmdargs.update(opts)
752
753
ret = cmd_handler(**cmdargs) or 0
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')
754
1022
755
1023
756
1024
757
1025
def main(argv):
758
## TODO: Handle command-line options; probably know what options are valid for
759
## each command
760
761
## TODO: If the arguments are wrong, give a usage message rather
762
## than just a backtrace.
763
764
bzrlib.trace.create_tracefile(argv)
1026
import errno
765
1027
1028
bzrlib.open_tracefile(argv)
1029
766
1030
try:
767
ret = run_bzr(argv)
768
return ret
769
except BzrError, e:
770
log_error('bzr: error: ' + e.args[0] + '\n')
771
if len(e.args) > 1:
772
for h in e.args[1]:
773
log_error(' ' + h + '\n')
774
return 1
775
except Exception, e:
776
log_error('bzr: exception: %s\n' % e)
777
log_error(' see .bzr.log for details\n')
778
traceback.print_exc(None, bzrlib.trace._tracefile)
779
traceback.print_exc(None, sys.stderr)
780
return 1
781
782
# TODO: Maybe nicer handling of IOError?
783
1031
try:
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()
784
1067
785
1068
786
1069
if __name__ == '__main__':
787
1070
sys.exit(main(sys.argv))
788
##import profile
789
##profile.run('main(sys.argv)')
790
Loggerhead is a web-based interface for Breezy
Version: 2.0.1