« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 195
- compare with another revision
- download diff
- download tarball
- view history from revision 195
- Committer: mbp at sourcefrog
- Date: 2005-04-08 05:39:46 UTC
- Revision ID: mbp@sourcefrog.net-20050408053946-1cb3415e1f8f58493034a5cf
- import lovely urlgrabber library
- files added:
- doc/faq.txt
- files removed:
- TODO
- contrib
- contrib/bash
- contrib/zsh
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
2
4
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
18
17
18
19
import sys, os, time, os.path
19
"""Bazaar-NG -- a free distributed version-control tool
20
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
23
Current limitation include:
24
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
27
28
* Insufficient error handling.
29
30
* Many commands unimplemented or partially implemented.
31
32
* Space-inefficient storage.
33
34
* No merge operators yet.
35
36
Interesting commands::
37
38
bzr help [COMMAND]
39
Show help screen
40
bzr version
41
Show software version/licence/non-warranty.
42
bzr init
43
Start versioning the current directory
44
bzr add FILE...
45
Make files versioned.
46
bzr log
47
Show revision history.
48
bzr diff
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
54
bzr status
55
Show summary of pending changes.
56
bzr remove FILE...
57
Make a file not versioned.
58
bzr info
59
Show statistics about this branch.
60
"""
61
62
63
64
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
20
66
from sets import Set
67
from pprint import pprint
68
from stat import *
69
from glob import glob
21
70
22
71
import bzrlib
72
from bzrlib.store import ImmutableStore
23
73
from bzrlib.trace import mutter, note, log_error
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
74
from bzrlib.errors import bailout, BzrError, BzrCheckError
25
75
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
76
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
27
77
from bzrlib.revision import Revision
28
78
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
79
format_date
30
80
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
else:
62
raise BzrCommandError("unknown command %r" % cmd)
63
64
65
class Command:
66
"""Base class for commands.
67
68
The docstring for an actual command should give a single-line
69
summary, then a complete description of the command. A grammar
70
description will be inserted.
71
72
takes_args
73
List of argument forms, marked with whether they are optional,
74
repeated, etc.
75
76
takes_options
77
List of options that may be given for this command.
78
79
hidden
80
If true, this command isn't advertised.
81
"""
82
aliases = []
83
84
takes_args = []
85
takes_options = []
86
87
hidden = False
88
89
def __init__(self, options, arguments):
90
"""Construct and run the command.
91
92
Sets self.status to the return value of run()."""
93
assert isinstance(options, dict)
94
assert isinstance(arguments, dict)
95
cmdargs = options.copy()
96
cmdargs.update(arguments)
97
assert self.__doc__ != Command.__doc__, \
98
("No help message set for %r" % self)
99
self.status = self.run(**cmdargs)
100
101
102
def run(self):
103
"""Override this in sub-classes.
104
105
This is invoked with the options and arguments bound to
106
keyword parameters.
107
108
Return 0 or None if the command was successful, or a shell
109
error code if not.
110
"""
111
return 0
112
113
114
115
class cmd_status(Command):
81
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
82
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
83
84
## standard representation
85
NONE_STRING = '(none)'
86
EMPTY = 'empty'
87
88
89
## TODO: Perhaps a different version of inventory commands that
90
## returns iterators...
91
92
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
93
94
## TODO: Some kind of locking on branches. Perhaps there should be a
95
## parameter to the branch object saying whether we want a read or
96
## write lock; release it from destructor. Perhaps don't even need a
97
## read lock to look at immutable objects?
98
99
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
100
## to compare output?
101
102
## TODO: Some kind of global code to generate the right Branch object
103
## to work on. Almost, but not quite all, commands need one, and it
104
## can be taken either from their parameters or their working
105
## directory.
106
107
## TODO: rename command, needed soon: check destination doesn't exist
108
## either in working copy or tree; move working copy; update
109
## inventory; write out
110
111
## TODO: move command; check destination is a directory and will not
112
## clash; move it.
113
114
## TODO: command to show renames, one per line, as to->from
115
116
117
118
119
def cmd_status(all=False):
116
120
"""Display status summary.
117
121
118
122
For each file there is a single line giving its file state and name.
119
123
The name is that in the current revision unless it is deleted or
120
124
missing, in which case the old name is shown.
125
126
:todo: Don't show unchanged files unless ``--all`` is given?
121
127
"""
122
takes_options = ['all']
123
aliases = ['st', 'stat']
124
125
def run(self, all=False):
126
#import bzrlib.status
127
#bzrlib.status.tree_status(Branch('.'))
128
Branch('.').show_status(show_all=all)
129
130
131
class cmd_cat_revision(Command):
132
"""Write out metadata for a revision."""
133
134
hidden = True
135
takes_args = ['revision_id']
136
137
def run(self, revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
139
140
141
class cmd_revno(Command):
142
"""Show current revision number.
143
144
This is equal to the number of revisions on this branch."""
145
def run(self):
146
print Branch('.').revno()
147
148
149
class cmd_add(Command):
128
Branch('.').show_status(show_all=all)
129
130
131
132
######################################################################
133
# examining history
134
def cmd_get_revision(revision_id):
135
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
136
137
138
def cmd_get_file_text(text_id):
139
"""Get contents of a file by hash."""
140
sf = Branch('.').text_store[text_id]
141
pumpfile(sf, sys.stdout)
142
143
144
145
######################################################################
146
# commands
147
148
149
def cmd_revno():
150
"""Show number of revisions on this branch"""
151
print Branch('.').revno()
152
153
154
155
def cmd_add(file_list, verbose=False):
150
156
"""Add specified files or directories.
151
157
152
158
In non-recursive mode, all the named items are added, regardless
163
169
164
170
Therefore simply saying 'bzr add .' will version all files that
165
171
are currently unknown.
166
167
TODO: Perhaps adding a file whose directly is not versioned should
168
recursively add that parent, rather than giving an error?
169
"""
170
takes_args = ['file+']
171
takes_options = ['verbose']
172
173
def run(self, file_list, verbose=False):
174
bzrlib.add.smart_add(file_list, verbose)
175
176
177
class cmd_relpath(Command):
178
"""Show path of a file relative to root"""
179
takes_args = ['filename']
180
181
def run(self, filename):
182
print Branch(filename).relpath(filename)
183
184
185
186
class cmd_inventory(Command):
187
"""Show inventory of the current working copy or a revision."""
188
takes_options = ['revision']
189
190
def run(self, revision=None):
191
b = Branch('.')
192
if revision == None:
193
inv = b.read_working_inventory()
194
else:
195
inv = b.get_revision_inventory(b.lookup_revision(revision))
196
197
for path, entry in inv.iter_entries():
198
print '%-50s %s' % (entry.file_id, path)
199
200
201
class cmd_move(Command):
202
"""Move files to a different directory.
203
204
examples:
205
bzr move *.txt doc
206
207
The destination must be a versioned directory in the same branch.
208
"""
209
takes_args = ['source$', 'dest']
210
def run(self, source_list, dest):
211
b = Branch('.')
212
213
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
214
215
216
class cmd_rename(Command):
172
"""
173
bzrlib.add.smart_add(file_list, verbose)
174
175
176
def cmd_relpath(filename):
177
"""Show path of file relative to root"""
178
print Branch(filename).relpath(filename)
179
180
181
182
def cmd_inventory(revision=None):
183
"""Show inventory of the current working copy."""
184
## TODO: Also optionally show a previous inventory
185
## TODO: Format options
186
b = Branch('.')
187
if revision == None:
188
inv = b.read_working_inventory()
189
else:
190
inv = b.get_revision_inventory(b.lookup_revision(revision))
191
192
for path, entry in inv.iter_entries():
193
print '%-50s %s' % (entry.file_id, path)
194
195
196
197
# TODO: Maybe a 'mv' command that has the combined move/rename
198
# special behaviour of Unix?
199
200
def cmd_move(source_list, dest):
201
b = Branch('.')
202
203
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
204
205
206
207
def cmd_rename(from_name, to_name):
217
208
"""Change the name of an entry.
218
209
219
examples:
220
bzr rename frob.c frobber.c
221
bzr rename src/frob.c lib/frob.c
222
223
It is an error if the destination name exists.
224
225
See also the 'move' command, which moves files into a different
226
directory without changing their name.
227
228
TODO: Some way to rename multiple files without invoking bzr for each
229
one?"""
230
takes_args = ['from_name', 'to_name']
210
usage: bzr rename FROM_NAME TO_NAME
211
212
examples:
213
bzr rename frob.c frobber.c
214
bzr rename src/frob.c lib/frob.c
215
216
It is an error if the destination name exists.
217
218
See also the 'move' command, which moves files into a different
219
directory without changing their name.
220
221
TODO: Some way to rename multiple files without invoking bzr for each
222
one?"""
223
b = Branch('.')
224
b.rename_one(b.relpath(from_name), b.relpath(to_name))
231
225
232
def run(self, from_name, to_name):
233
b = Branch('.')
234
b.rename_one(b.relpath(from_name), b.relpath(to_name))
235
236
237
238
class cmd_renames(Command):
226
227
228
229
def cmd_renames(dir='.'):
239
230
"""Show list of renamed files.
240
231
241
TODO: Option to show renames between two historical versions.
242
243
TODO: Only show renames under dir, rather than in the whole branch.
244
"""
245
takes_args = ['dir?']
246
247
def run(self, dir='.'):
248
b = Branch(dir)
249
old_inv = b.basis_tree().inventory
250
new_inv = b.read_working_inventory()
251
252
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
253
renames.sort()
254
for old_name, new_name in renames:
255
print "%s => %s" % (old_name, new_name)
256
257
258
class cmd_info(Command):
259
"""Show statistical information for this branch"""
260
def run(self):
261
import info
262
info.show_info(Branch('.'))
263
264
265
class cmd_remove(Command):
266
"""Make a file unversioned.
267
268
This makes bzr stop tracking changes to a versioned file. It does
269
not delete the working copy.
270
"""
271
takes_args = ['file+']
272
takes_options = ['verbose']
273
274
def run(self, file_list, verbose=False):
275
b = Branch(file_list[0])
276
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
277
278
279
class cmd_file_id(Command):
232
usage: bzr renames [BRANCH]
233
234
TODO: Option to show renames between two historical versions.
235
236
TODO: Only show renames under dir, rather than in the whole branch.
237
"""
238
b = Branch(dir)
239
old_inv = b.basis_tree().inventory
240
new_inv = b.read_working_inventory()
241
242
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
243
renames.sort()
244
for old_name, new_name in renames:
245
print "%s => %s" % (old_name, new_name)
246
247
248
249
def cmd_info():
250
"""info: Show statistical information for this branch
251
252
usage: bzr info"""
253
import info
254
info.show_info(Branch('.'))
255
256
257
258
def cmd_remove(file_list, verbose=False):
259
b = Branch(file_list[0])
260
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
261
262
263
264
def cmd_file_id(filename):
280
265
"""Print file_id of a particular file or directory.
281
266
282
The file_id is assigned when the file is first added and remains the
283
same through all revisions where the file exists, even when it is
284
moved or renamed.
285
"""
286
hidden = True
287
takes_args = ['filename']
288
def run(self, filename):
289
b = Branch(filename)
290
i = b.inventory.path2id(b.relpath(filename))
291
if i == None:
292
bailout("%r is not a versioned file" % filename)
293
else:
294
print i
295
296
297
class cmd_file_path(Command):
267
usage: bzr file-id FILE
268
269
The file_id is assigned when the file is first added and remains the
270
same through all revisions where the file exists, even when it is
271
moved or renamed.
272
"""
273
b = Branch(filename)
274
i = b.inventory.path2id(b.relpath(filename))
275
if i == None:
276
bailout("%r is not a versioned file" % filename)
277
else:
278
print i
279
280
281
def cmd_file_id_path(filename):
298
282
"""Print path of file_ids to a file or directory.
299
283
300
This prints one line for each directory down to the target,
301
starting at the branch root."""
302
hidden = True
303
takes_args = ['filename']
304
def run(self, filename):
305
b = Branch(filename)
306
inv = b.inventory
307
fid = inv.path2id(b.relpath(filename))
308
if fid == None:
309
bailout("%r is not a versioned file" % filename)
310
for fip in inv.get_idpath(fid):
311
print fip
312
313
314
class cmd_revision_history(Command):
315
"""Display list of revision ids on this branch."""
316
def run(self):
317
for patchid in Branch('.').revision_history():
318
print patchid
319
320
321
class cmd_directories(Command):
322
"""Display list of versioned directories in this branch."""
323
def run(self):
324
for name, ie in Branch('.').read_working_inventory().directories():
325
if name == '':
326
print '.'
327
else:
328
print name
329
330
331
class cmd_init(Command):
332
"""Make a directory into a versioned branch.
333
334
Use this to create an empty branch, or before importing an
335
existing project.
336
337
Recipe for importing a tree of files:
338
cd ~/project
339
bzr init
340
bzr add -v .
341
bzr status
342
bzr commit -m 'imported project'
343
"""
344
def run(self):
345
Branch('.', init=True)
346
347
348
class cmd_diff(Command):
349
"""Show differences in working tree.
350
351
If files are listed, only the changes in those files are listed.
352
Otherwise, all changes for the tree are listed.
353
354
TODO: Given two revision arguments, show the difference between them.
355
356
TODO: Allow diff across branches.
357
358
TODO: Option to use external diff command; could be GNU diff, wdiff,
359
or a graphical diff.
360
361
TODO: Python difflib is not exactly the same as unidiff; should
362
either fix it up or prefer to use an external diff.
363
364
TODO: If a directory is given, diff everything under that.
365
366
TODO: Selected-file diff is inefficient and doesn't show you
367
deleted files.
368
369
TODO: This probably handles non-Unix newlines poorly.
370
"""
371
372
takes_args = ['file*']
373
takes_options = ['revision']
374
aliases = ['di']
375
376
def run(self, revision=None, file_list=None):
377
from bzrlib.diff import show_diff
378
379
show_diff(Branch('.'), revision, file_list)
380
381
382
class cmd_deleted(Command):
284
usage: bzr file-id-path FILE
285
286
This prints one line for each directory down to the target,
287
starting at the branch root."""
288
b = Branch(filename)
289
inv = b.inventory
290
fid = inv.path2id(b.relpath(filename))
291
if fid == None:
292
bailout("%r is not a versioned file" % filename)
293
for fip in inv.get_idpath(fid):
294
print fip
295
296
297
def cmd_revision_history():
298
for patchid in Branch('.').revision_history():
299
print patchid
300
301
302
def cmd_directories():
303
for name, ie in Branch('.').read_working_inventory().directories():
304
if name == '':
305
print '.'
306
else:
307
print name
308
309
310
def cmd_missing():
311
for name, ie in Branch('.').working_tree().missing():
312
print name
313
314
315
def cmd_init():
316
# TODO: Check we're not already in a working directory? At the
317
# moment you'll get an ugly error.
318
319
# TODO: What if we're in a subdirectory of a branch? Would like
320
# to allow that, but then the parent may need to understand that
321
# the children have disappeared, or should they be versioned in
322
# both?
323
324
# TODO: Take an argument/option for branch name.
325
Branch('.', init=True)
326
327
328
def cmd_diff(revision=None):
329
"""bzr diff: Show differences in working tree.
330
331
usage: bzr diff [-r REV]
332
333
--revision REV
334
Show changes since REV, rather than predecessor.
335
336
TODO: Given two revision arguments, show the difference between them.
337
338
TODO: Allow diff across branches.
339
340
TODO: Option to use external diff command; could be GNU diff, wdiff,
341
or a graphical diff.
342
343
TODO: Diff selected files.
344
"""
345
346
## TODO: Shouldn't be in the cmd function.
347
348
b = Branch('.')
349
350
if revision == None:
351
old_tree = b.basis_tree()
352
else:
353
old_tree = b.revision_tree(b.lookup_revision(revision))
354
355
new_tree = b.working_tree()
356
357
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
358
old_label = ''
359
new_label = ''
360
361
DEVNULL = '/dev/null'
362
# Windows users, don't panic about this filename -- it is a
363
# special signal to GNU patch that the file should be created or
364
# deleted respectively.
365
366
# TODO: Generation of pseudo-diffs for added/deleted files could
367
# be usefully made into a much faster special case.
368
369
# TODO: Better to return them in sorted order I think.
370
371
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
372
# Don't show this by default; maybe do it if an option is passed
373
# idlabel = ' {%s}' % fid
374
idlabel = ''
375
376
# FIXME: Something about the diff format makes patch unhappy
377
# with newly-added files.
378
379
def diffit(oldlines, newlines, **kw):
380
# FIXME: difflib is wrong if there is no trailing newline.
381
382
# Special workaround for Python2.3, where difflib fails if
383
# both sequences are empty.
384
if oldlines or newlines:
385
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
386
print
387
388
if file_state in ['.', '?', 'I']:
389
continue
390
elif file_state == 'A':
391
print '*** added %s %r' % (kind, new_name)
392
if kind == 'file':
393
diffit([],
394
new_tree.get_file(fid).readlines(),
395
fromfile=DEVNULL,
396
tofile=new_label + new_name + idlabel)
397
elif file_state == 'D':
398
assert isinstance(old_name, types.StringTypes)
399
print '*** deleted %s %r' % (kind, old_name)
400
if kind == 'file':
401
diffit(old_tree.get_file(fid).readlines(), [],
402
fromfile=old_label + old_name + idlabel,
403
tofile=DEVNULL)
404
elif file_state in ['M', 'R']:
405
if file_state == 'M':
406
assert kind == 'file'
407
assert old_name == new_name
408
print '*** modified %s %r' % (kind, new_name)
409
elif file_state == 'R':
410
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
411
412
if kind == 'file':
413
diffit(old_tree.get_file(fid).readlines(),
414
new_tree.get_file(fid).readlines(),
415
fromfile=old_label + old_name + idlabel,
416
tofile=new_label + new_name)
417
else:
418
bailout("can't represent state %s {%s}" % (file_state, fid))
419
420
421
422
def cmd_deleted(show_ids=False):
383
423
"""List files deleted in the working tree.
384
424
385
TODO: Show files deleted since a previous revision, or between two revisions.
425
TODO: Show files deleted since a previous revision, or between two revisions.
386
426
"""
387
def run(self, show_ids=False):
388
b = Branch('.')
389
old = b.basis_tree()
390
new = b.working_tree()
391
392
## TODO: Much more efficient way to do this: read in new
393
## directories with readdir, rather than stating each one. Same
394
## level of effort but possibly much less IO. (Or possibly not,
395
## if the directories are very large...)
396
397
for path, ie in old.inventory.iter_entries():
398
if not new.has_id(ie.file_id):
399
if show_ids:
400
print '%-50s %s' % (path, ie.file_id)
401
else:
402
print path
403
404
class cmd_root(Command):
405
"""Show the tree root directory.
406
407
The root is the nearest enclosing directory with a .bzr control
408
directory."""
409
takes_args = ['filename?']
410
def run(self, filename=None):
411
"""Print the branch root."""
412
print bzrlib.branch.find_branch_root(filename)
413
414
415
416
class cmd_log(Command):
427
b = Branch('.')
428
old = b.basis_tree()
429
new = b.working_tree()
430
431
## TODO: Much more efficient way to do this: read in new
432
## directories with readdir, rather than stating each one. Same
433
## level of effort but possibly much less IO. (Or possibly not,
434
## if the directories are very large...)
435
436
for path, ie in old.inventory.iter_entries():
437
if not new.has_id(ie.file_id):
438
if show_ids:
439
print '%-50s %s' % (path, ie.file_id)
440
else:
441
print path
442
443
444
445
def cmd_parse_inventory():
446
import cElementTree
447
448
cElementTree.ElementTree().parse(file('.bzr/inventory'))
449
450
451
452
def cmd_load_inventory():
453
"""Load inventory for timing purposes"""
454
Branch('.').basis_tree().inventory
455
456
457
def cmd_dump_inventory():
458
Branch('.').read_working_inventory().write_xml(sys.stdout)
459
460
461
def cmd_dump_new_inventory():
462
import bzrlib.newinventory
463
inv = Branch('.').basis_tree().inventory
464
bzrlib.newinventory.write_inventory(inv, sys.stdout)
465
466
467
def cmd_load_new_inventory():
468
import bzrlib.newinventory
469
bzrlib.newinventory.read_new_inventory(sys.stdin)
470
471
472
def cmd_dump_slacker_inventory():
473
import bzrlib.newinventory
474
inv = Branch('.').basis_tree().inventory
475
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
476
477
478
479
def cmd_root(filename=None):
480
"""Print the branch root."""
481
print bzrlib.branch.find_branch_root(filename)
482
483
484
def cmd_log(timezone='original'):
417
485
"""Show log of this branch.
418
486
419
TODO: Option to limit range.
420
421
TODO: Perhaps show most-recent first with an option for last.
487
:todo: Options for utc; to show ids; to limit range; etc.
422
488
"""
423
takes_args = ['filename?']
424
takes_options = ['timezone', 'verbose', 'show-ids']
425
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
426
b = Branch((filename or '.'), lock_mode='r')
427
if filename:
428
filename = b.relpath(filename)
429
bzrlib.show_log(b, filename,
430
show_timezone=timezone,
431
verbose=verbose,
432
show_ids=show_ids)
433
434
435
436
class cmd_touching_revisions(Command):
437
"""Return revision-ids which affected a particular file."""
438
hidden = True
439
takes_args = ["filename"]
440
def run(self, filename):
441
b = Branch(filename, lock_mode='r')
442
inv = b.read_working_inventory()
443
file_id = inv.path2id(b.relpath(filename))
444
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
445
print "%6d %s" % (revno, what)
446
447
448
class cmd_ls(Command):
489
Branch('.').write_log(show_timezone=timezone)
490
491
492
def cmd_ls(revision=None, verbose=False):
449
493
"""List files in a tree.
450
494
451
TODO: Take a revision or remote path and list that tree instead.
495
:todo: Take a revision or remote path and list that tree instead.
452
496
"""
453
hidden = True
454
def run(self, revision=None, verbose=False):
455
b = Branch('.')
456
if revision == None:
457
tree = b.working_tree()
497
b = Branch('.')
498
if revision == None:
499
tree = b.working_tree()
500
else:
501
tree = b.revision_tree(b.lookup_revision(revision))
502
503
for fp, fc, kind, fid in tree.list_files():
504
if verbose:
505
if kind == 'directory':
506
kindch = '/'
507
elif kind == 'file':
508
kindch = ''
509
else:
510
kindch = '???'
511
512
print '%-8s %s%s' % (fc, fp, kindch)
458
513
else:
459
tree = b.revision_tree(b.lookup_revision(revision))
460
461
for fp, fc, kind, fid in tree.list_files():
462
if verbose:
463
if kind == 'directory':
464
kindch = '/'
465
elif kind == 'file':
466
kindch = ''
467
else:
468
kindch = '???'
469
470
print '%-8s %s%s' % (fc, fp, kindch)
471
else:
472
print fp
473
474
475
476
class cmd_unknowns(Command):
514
print fp
515
516
517
518
def cmd_unknowns():
477
519
"""List unknown files"""
478
def run(self):
479
for f in Branch('.').unknowns():
480
print quotefn(f)
481
482
483
484
class cmd_ignore(Command):
485
"""Ignore a command or pattern"""
486
takes_args = ['name_pattern']
487
488
def run(self, name_pattern):
489
b = Branch('.')
490
491
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
492
f = open(b.abspath('.bzrignore'), 'at')
493
f.write(name_pattern + '\n')
494
f.close()
495
496
inv = b.working_tree().inventory
497
if inv.path2id('.bzrignore'):
498
mutter('.bzrignore is already versioned')
499
else:
500
mutter('need to make new .bzrignore file versioned')
501
b.add(['.bzrignore'])
502
503
504
505
class cmd_ignored(Command):
506
"""List ignored files and the patterns that matched them."""
507
def run(self):
508
tree = Branch('.').working_tree()
509
for path, file_class, kind, file_id in tree.list_files():
510
if file_class != 'I':
511
continue
512
## XXX: Slightly inefficient since this was already calculated
513
pat = tree.is_ignored(path)
514
print '%-50s %s' % (path, pat)
515
516
517
class cmd_lookup_revision(Command):
518
"""Lookup the revision-id from a revision-number
519
520
example:
521
bzr lookup-revision 33
522
"""
523
hidden = True
524
takes_args = ['revno']
525
526
def run(self, revno):
527
try:
528
revno = int(revno)
529
except ValueError:
530
raise BzrCommandError("not a valid revision-number: %r" % revno)
531
532
print Branch('.').lookup_revision(revno)
533
534
535
class cmd_export(Command):
536
"""Export past revision to destination directory.
537
538
If no revision is specified this exports the last committed revision."""
539
takes_args = ['dest']
540
takes_options = ['revision']
541
def run(self, dest, revision=None):
542
b = Branch('.')
543
if revision == None:
544
rh = b.revision_history()[-1]
545
else:
546
rh = b.lookup_revision(int(revision))
547
t = b.revision_tree(rh)
548
t.export(dest)
549
550
551
class cmd_cat(Command):
552
"""Write a file's text from a previous revision."""
553
554
takes_options = ['revision']
555
takes_args = ['filename']
556
557
def run(self, filename, revision=None):
558
if revision == None:
559
raise BzrCommandError("bzr cat requires a revision number")
560
b = Branch('.')
561
b.print_file(b.relpath(filename), int(revision))
562
563
564
class cmd_local_time_offset(Command):
565
"""Show the offset in seconds from GMT to local time."""
566
hidden = True
567
def run(self):
568
print bzrlib.osutils.local_time_offset()
569
570
571
572
class cmd_commit(Command):
573
"""Commit changes into a new revision.
574
575
TODO: Commit only selected files.
576
577
TODO: Run hooks on tree to-be-committed, and after commit.
578
579
TODO: Strict commit that fails if there are unknown or deleted files.
580
"""
581
takes_options = ['message', 'file', 'verbose']
582
aliases = ['ci', 'checkin']
583
584
def run(self, message=None, file=None, verbose=False):
585
## Warning: shadows builtin file()
586
if not message and not file:
587
raise BzrCommandError("please specify a commit message",
588
["use either --message or --file"])
589
elif message and file:
590
raise BzrCommandError("please specify either --message or --file")
520
for f in Branch('.').unknowns():
521
print quotefn(f)
522
523
524
525
def cmd_ignored():
526
"""List ignored files and the patterns that matched them.
527
"""
528
tree = Branch('.').working_tree()
529
for path, file_class, kind, file_id in tree.list_files():
530
if file_class != 'I':
531
continue
532
## XXX: Slightly inefficient since this was already calculated
533
pat = tree.is_ignored(path)
534
print '%-50s %s' % (path, pat)
535
536
537
def cmd_lookup_revision(revno):
538
try:
539
revno = int(revno)
540
except ValueError:
541
bailout("usage: lookup-revision REVNO",
542
["REVNO is a non-negative revision number for this branch"])
543
544
print Branch('.').lookup_revision(revno) or NONE_STRING
545
546
547
548
def cmd_export(revno, dest):
549
"""Export past revision to destination directory."""
550
b = Branch('.')
551
rh = b.lookup_revision(int(revno))
552
t = b.revision_tree(rh)
553
t.export(dest)
554
555
def cmd_cat(revision, filename):
556
"""Print file to stdout."""
557
b = Branch('.')
558
b.print_file(b.relpath(filename), int(revision))
559
560
561
######################################################################
562
# internal/test commands
563
564
565
def cmd_uuid():
566
"""Print a newly-generated UUID."""
567
print bzrlib.osutils.uuid()
568
569
570
571
def cmd_local_time_offset():
572
print bzrlib.osutils.local_time_offset()
573
574
575
576
def cmd_commit(message=None, verbose=False):
577
"""Commit changes to a new revision.
578
579
--message MESSAGE
580
Description of changes in this revision; free form text.
581
It is recommended that the first line be a single-sentence
582
summary.
583
--verbose
584
Show status of changed files,
585
586
TODO: Commit only selected files.
587
588
TODO: Run hooks on tree to-be-committed, and after commit.
589
590
TODO: Strict commit that fails if there are unknown or deleted files.
591
"""
592
593
if not message:
594
bailout("please specify a commit message")
595
Branch('.').commit(message, verbose=verbose)
596
597
598
def cmd_check(dir='.'):
599
"""check: Consistency check of branch history.
600
601
usage: bzr check [-v] [BRANCH]
602
603
options:
604
--verbose, -v Show progress of checking.
605
606
This command checks various invariants about the branch storage to
607
detect data corruption or bzr bugs.
608
"""
609
import bzrlib.check
610
bzrlib.check.check(Branch(dir, find_root=False))
611
612
613
def cmd_is(pred, *rest):
614
"""Test whether PREDICATE is true."""
615
try:
616
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
617
except KeyError:
618
bailout("unknown predicate: %s" % quotefn(pred))
591
619
592
if file:
593
import codecs
594
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
595
596
Branch('.').commit(message, verbose=verbose)
597
598
599
class cmd_check(Command):
600
"""Validate consistency of branch history.
601
602
This command checks various invariants about the branch storage to
603
detect data corruption or bzr bugs.
604
"""
605
takes_args = ['dir?']
606
def run(self, dir='.'):
607
import bzrlib.check
608
bzrlib.check.check(Branch(dir, find_root=False))
609
610
611
612
class cmd_whoami(Command):
613
"""Show bzr user id."""
614
takes_options = ['email']
615
616
def run(self, email=False):
617
if email:
618
print bzrlib.osutils.user_email()
619
else:
620
print bzrlib.osutils.username()
621
622
623
class cmd_selftest(Command):
620
try:
621
cmd_handler(*rest)
622
except BzrCheckError:
623
# by default we don't print the message so that this can
624
# be used from shell scripts without producing noise
625
sys.exit(1)
626
627
628
def cmd_username():
629
print bzrlib.osutils.username()
630
631
632
def cmd_user_email():
633
print bzrlib.osutils.user_email()
634
635
636
def cmd_gen_revision_id():
637
print bzrlib.branch._gen_revision_id(time.time())
638
639
640
def cmd_selftest():
624
641
"""Run internal test suite"""
625
hidden = True
626
def run(self):
627
failures, tests = 0, 0
628
629
import doctest, bzrlib.store, bzrlib.tests
630
bzrlib.trace.verbose = False
631
632
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
633
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
634
mf, mt = doctest.testmod(m)
635
failures += mf
636
tests += mt
637
print '%-40s %3d tests' % (m.__name__, mt),
638
if mf:
639
print '%3d FAILED!' % mf
640
else:
641
print
642
643
print '%-40s %3d tests' % ('total', tests),
644
if failures:
645
print '%3d FAILED!' % failures
642
## -v, if present, is seen by doctest; the argument is just here
643
## so our parser doesn't complain
644
645
## TODO: --verbose option
646
647
failures, tests = 0, 0
648
649
import doctest, bzrlib.store, bzrlib.tests
650
bzrlib.trace.verbose = False
651
652
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
653
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
654
mf, mt = doctest.testmod(m)
655
failures += mf
656
tests += mt
657
print '%-40s %3d tests' % (m.__name__, mt),
658
if mf:
659
print '%3d FAILED!' % mf
646
660
else:
647
661
print
648
662
649
650
651
class cmd_version(Command):
652
"""Show version of bzr"""
653
def run(self):
654
show_version()
655
656
def show_version():
663
print '%-40s %3d tests' % ('total', tests),
664
if failures:
665
print '%3d FAILED!' % failures
666
else:
667
print
668
669
670
671
# deprecated
672
cmd_doctest = cmd_selftest
673
674
675
######################################################################
676
# help
677
678
679
def cmd_help(topic=None):
680
if topic == None:
681
print __doc__
682
return
683
684
# otherwise, maybe the name of a command?
685
try:
686
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
687
except KeyError:
688
bailout("no help for %r" % topic)
689
690
doc = cmdfn.__doc__
691
if doc == None:
692
bailout("sorry, no detailed help yet for %r" % topic)
693
694
print doc
695
696
697
698
699
def cmd_version():
657
700
print "bzr (bazaar-ng) %s" % bzrlib.__version__
658
701
print bzrlib.__copyright__
659
702
print "http://bazaar-ng.org/"
660
703
print
661
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
662
print "you may use, modify and redistribute it under the terms of the GNU"
663
print "General Public License version 2 or later."
664
665
666
class cmd_rocks(Command):
704
print \
705
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
706
you may use, modify and redistribute it under the terms of the GNU
707
General Public License version 2 or later."""
708
709
710
def cmd_rocks():
667
711
"""Statement of optimism."""
668
hidden = True
669
def run(self):
670
print "it sure does!"
671
672
673
class cmd_assert_fail(Command):
674
"""Test reporting of assertion failures"""
675
hidden = True
676
def run(self):
677
assert False, "always fails"
678
679
680
class cmd_help(Command):
681
"""Show help on a command or other topic.
682
683
For a list of all available commands, say 'bzr help commands'."""
684
takes_args = ['topic?']
685
aliases = ['?']
686
687
def run(self, topic=None):
688
import help
689
help.help(topic)
712
print "it sure does!"
713
690
714
691
715
692
716
######################################################################
699
723
OPTIONS = {
700
724
'all': None,
701
725
'help': None,
702
'file': unicode,
703
726
'message': unicode,
704
727
'profile': None,
705
728
'revision': int,
707
730
'timezone': str,
708
731
'verbose': None,
709
732
'version': None,
710
'email': None,
711
733
}
712
734
713
735
SHORT_OPTIONS = {
714
736
'm': 'message',
715
'F': 'file',
716
737
'r': 'revision',
717
738
'v': 'verbose',
718
739
}
719
740
741
# List of options that apply to particular commands; commands not
742
# listed take none.
743
cmd_options = {
744
'add': ['verbose'],
745
'cat': ['revision'],
746
'commit': ['message', 'verbose'],
747
'deleted': ['show-ids'],
748
'diff': ['revision'],
749
'inventory': ['revision'],
750
'log': ['timezone'],
751
'ls': ['revision', 'verbose'],
752
'remove': ['verbose'],
753
'status': ['all'],
754
}
755
756
757
cmd_args = {
758
'add': ['file+'],
759
'cat': ['filename'],
760
'commit': [],
761
'diff': [],
762
'export': ['revno', 'dest'],
763
'file-id': ['filename'],
764
'file-id-path': ['filename'],
765
'get-file-text': ['text_id'],
766
'get-inventory': ['inventory_id'],
767
'get-revision': ['revision_id'],
768
'get-revision-inventory': ['revision_id'],
769
'help': ['topic?'],
770
'init': [],
771
'log': [],
772
'lookup-revision': ['revno'],
773
'move': ['source$', 'dest'],
774
'relpath': ['filename'],
775
'remove': ['file+'],
776
'rename': ['from_name', 'to_name'],
777
'renames': ['dir?'],
778
'root': ['filename?'],
779
'status': [],
780
}
781
720
782
721
783
def parse_args(argv):
722
784
"""Parse command line.
743
805
while argv:
744
806
a = argv.pop(0)
745
807
if a[0] == '-':
746
# option names must not be unicode
747
a = str(a)
748
808
optarg = None
749
809
if a[1] == '-':
750
810
mutter(" got option %r" % a)
783
843
784
844
785
845
846
def _match_args(cmd, args):
847
"""Check non-option arguments match required pattern.
786
848
787
def _match_argform(cmd, takes_args, args):
849
>>> _match_args('status', ['asdasdsadasd'])
850
Traceback (most recent call last):
851
...
852
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
853
>>> _match_args('add', ['asdasdsadasd'])
854
{'file_list': ['asdasdsadasd']}
855
>>> _match_args('add', 'abc def gj'.split())
856
{'file_list': ['abc', 'def', 'gj']}
857
"""
858
# match argument pattern
859
argform = cmd_args.get(cmd, [])
788
860
argdict = {}
861
# TODO: Need a way to express 'cp SRC... DEST', where it matches
862
# all but one.
789
863
790
# step through args and takes_args, allowing appropriate 0-many matches
791
for ap in takes_args:
864
# step through args and argform, allowing appropriate 0-many matches
865
for ap in argform:
792
866
argname = ap[:-1]
793
867
if ap[-1] == '?':
794
868
if args:
795
869
argdict[argname] = args.pop(0)
796
elif ap[-1] == '*': # all remaining arguments
797
if args:
798
argdict[argname + '_list'] = args[:]
799
args = []
800
else:
801
argdict[argname + '_list'] = None
870
elif ap[-1] == '*':
871
raise BzrError("arg form %r not implemented yet" % ap)
802
872
elif ap[-1] == '+':
803
873
if not args:
804
raise BzrCommandError("command %r needs one or more %s"
874
bailout("command %r needs one or more %s"
805
875
% (cmd, argname.upper()))
806
876
else:
807
877
argdict[argname + '_list'] = args[:]
808
878
args = []
809
879
elif ap[-1] == '$': # all but one
810
880
if len(args) < 2:
811
raise BzrCommandError("command %r needs one or more %s"
881
bailout("command %r needs one or more %s"
812
882
% (cmd, argname.upper()))
813
883
argdict[argname + '_list'] = args[:-1]
814
884
args[:-1] = []
816
886
# just a plain arg
817
887
argname = ap
818
888
if not args:
819
raise BzrCommandError("command %r requires argument %s"
889
bailout("command %r requires argument %s"
820
890
% (cmd, argname.upper()))
821
891
else:
822
892
argdict[argname] = args.pop(0)
823
893
824
894
if args:
825
raise BzrCommandError("extra argument to command %s: %s"
826
% (cmd, args[0]))
895
bailout("extra arguments to command %s: %r"
896
% (cmd, args))
827
897
828
898
return argdict
829
899
833
903
"""Execute a command.
834
904
835
905
This is similar to main(), but without all the trappings for
836
logging and error handling.
906
logging and error handling.
837
907
"""
838
argv = [a.decode(bzrlib.user_encoding) for a in argv]
839
840
908
try:
841
909
args, opts = parse_args(argv[1:])
842
910
if 'help' in opts:
843
import help
911
# TODO: pass down other arguments in case they asked for
912
# help on a command name?
844
913
if args:
845
help.help(args[0])
914
cmd_help(args[0])
846
915
else:
847
help.help()
916
cmd_help()
848
917
return 0
849
918
elif 'version' in opts:
850
show_version()
919
cmd_version()
851
920
return 0
852
cmd = str(args.pop(0))
921
cmd = args.pop(0)
853
922
except IndexError:
854
log_error('usage: bzr COMMAND')
855
log_error(' try "bzr help"')
923
log_error('usage: bzr COMMAND\n')
924
log_error(' try "bzr help"\n')
856
925
return 1
857
926
858
canonical_cmd, cmd_class = get_cmd_class(cmd)
927
try:
928
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
929
except KeyError:
930
bailout("unknown command " + `cmd`)
859
931
860
932
# global option
861
933
if 'profile' in opts:
865
937
profile = False
866
938
867
939
# check options are reasonable
868
allowed = cmd_class.takes_options
940
allowed = cmd_options.get(cmd, [])
869
941
for oname in opts:
870
942
if oname not in allowed:
871
raise BzrCommandError("option '--%s' is not allowed for command %r"
872
% (oname, cmd))
943
bailout("option %r is not allowed for command %r"
944
% (oname, cmd))
945
946
# TODO: give an error if there are any mandatory options which are
947
# not specified? Or maybe there shouldn't be any "mandatory
948
# options" (it is an oxymoron)
873
949
874
950
# mix arguments and options into one dictionary
875
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
876
cmdopts = {}
951
cmdargs = _match_args(cmd, args)
877
952
for k, v in opts.items():
878
cmdopts[k.replace('-', '_')] = v
953
cmdargs[k.replace('-', '_')] = v
879
954
880
955
if profile:
881
import hotshot, tempfile
882
pffileno, pfname = tempfile.mkstemp()
883
try:
884
prof = hotshot.Profile(pfname)
885
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
886
prof.close()
887
888
import hotshot.stats
889
stats = hotshot.stats.load(pfname)
890
#stats.strip_dirs()
891
stats.sort_stats('time')
892
## XXX: Might like to write to stderr or the trace file instead but
893
## print_stats seems hardcoded to stdout
894
stats.print_stats(20)
895
896
return ret.status
897
898
finally:
899
os.close(pffileno)
900
os.remove(pfname)
956
import hotshot
957
prof = hotshot.Profile('.bzr.profile')
958
ret = prof.runcall(cmd_handler, **cmdargs) or 0
959
prof.close()
960
961
import hotshot.stats
962
stats = hotshot.stats.load('.bzr.profile')
963
#stats.strip_dirs()
964
stats.sort_stats('time')
965
stats.print_stats(20)
966
967
return ret
901
968
else:
902
cmdobj = cmd_class(cmdopts, cmdargs).status
903
904
905
def _report_exception(summary, quiet=False):
906
import traceback
907
log_error('bzr: ' + summary)
908
bzrlib.trace.log_exception()
909
910
if not quiet:
911
tb = sys.exc_info()[2]
912
exinfo = traceback.extract_tb(tb)
913
if exinfo:
914
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
915
sys.stderr.write(' see ~/.bzr.log for debug information\n')
969
return cmd_handler(**cmdargs) or 0
916
970
917
971
918
972
919
973
def main(argv):
920
import errno
974
## TODO: Handle command-line options; probably know what options are valid for
975
## each command
976
977
## TODO: If the arguments are wrong, give a usage message rather
978
## than just a backtrace.
979
980
bzrlib.trace.create_tracefile(argv)
921
981
922
bzrlib.open_tracefile(argv)
923
924
982
try:
925
try:
926
try:
927
return run_bzr(argv)
928
finally:
929
# do this here inside the exception wrappers to catch EPIPE
930
sys.stdout.flush()
931
except BzrError, e:
932
quiet = isinstance(e, (BzrCommandError))
933
_report_exception('error: ' + e.args[0], quiet=quiet)
934
if len(e.args) > 1:
935
for h in e.args[1]:
936
# some explanation or hints
937
log_error(' ' + h)
938
return 1
939
except AssertionError, e:
940
msg = 'assertion failed'
941
if str(e):
942
msg += ': ' + str(e)
943
_report_exception(msg)
944
return 2
945
except KeyboardInterrupt, e:
946
_report_exception('interrupted', quiet=True)
947
return 2
948
except Exception, e:
949
quiet = False
950
if isinstance(e, IOError) and e.errno == errno.EPIPE:
951
quiet = True
952
msg = 'broken pipe'
953
else:
954
msg = str(e).rstrip('\n')
955
_report_exception(msg, quiet)
956
return 2
957
finally:
958
bzrlib.trace.close_trace()
983
ret = run_bzr(argv)
984
return ret
985
except BzrError, e:
986
log_error('bzr: error: ' + e.args[0] + '\n')
987
if len(e.args) > 1:
988
for h in e.args[1]:
989
log_error(' ' + h + '\n')
990
traceback.print_exc(None, bzrlib.trace._tracefile)
991
log_error('(see $HOME/.bzr.log for debug information)\n')
992
return 1
993
except Exception, e:
994
log_error('bzr: exception: %s\n' % e)
995
log_error('(see $HOME/.bzr.log for debug information)\n')
996
traceback.print_exc(None, bzrlib.trace._tracefile)
997
## traceback.print_exc(None, sys.stderr)
998
return 1
999
1000
# TODO: Maybe nicer handling of IOError?
1001
959
1002
960
1003
961
1004
if __name__ == '__main__':
962
1005
sys.exit(main(sys.argv))
1006
##import profile
1007
##profile.run('main(sys.argv)')
1008
Loggerhead is a web-based interface for Breezy
Version: 2.0.1