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