« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 329
- compare with another revision
- compare with revision 974.1.35
- download diff
- download tarball
- view history from revision 329
- Committer: Martin Pool
- Date: 2005-05-03 07:48:16 UTC
- Revision ID: mbp@sourcefrog.net-20050503074816-f404dfcae6acf6fe
- refactor command functions into command classes
- much more help
- better system for generating help from command descriptions
- split diff code into bzrlib.diff
- much more help
- better system for generating help from command descriptions
- split diff code into bzrlib.diff
- files modified:
- NEWS
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
50
48
Show changes from last revision to working copy.
51
49
bzr commit -m 'MESSAGE'
52
50
Store current state as new revision.
53
bzr export REVNO DESTINATION
51
bzr export [-r REVNO] DESTINATION
54
52
Export the branch state at a previous version.
55
53
bzr status
56
54
Show summary of pending changes.
71
69
from pprint import pprint
72
70
from stat import *
73
71
from glob import glob
74
from inspect import getdoc
75
72
76
73
import bzrlib
77
74
from bzrlib.store import ImmutableStore
78
75
from bzrlib.trace import mutter, note, log_error
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
80
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
79
from bzrlib.revision import Revision
91
88
EMPTY = 'empty'
92
89
93
90
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 = {
91
CMD_ALIASES = {
115
92
'?': 'help',
116
93
'ci': 'commit',
117
94
'checkin': 'commit',
121
98
}
122
99
123
100
124
def get_cmd_handler(cmd):
101
def get_cmd_class(cmd):
125
102
cmd = str(cmd)
126
103
127
cmd = cmd_aliases.get(cmd, cmd)
104
cmd = CMD_ALIASES.get(cmd, cmd)
128
105
129
106
try:
130
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
131
108
except KeyError:
132
109
raise BzrError("unknown command %r" % cmd)
133
110
134
return cmd, cmd_handler
135
136
137
138
def cmd_status(all=False):
111
return cmd, cmd_class
112
113
114
115
class Command:
116
"""Base class for commands.
117
118
The docstring for an actual command should give a single-line
119
summary, then a complete description of the command. A grammar
120
description will be inserted.
121
122
takes_args
123
List of argument forms, marked with whether they are optional,
124
repeated, etc.
125
126
takes_options
127
List of options that may be given for this command.
128
129
hidden
130
If true, this command isn't advertised.
131
"""
132
aliases = []
133
134
takes_args = []
135
takes_options = []
136
137
hidden = False
138
139
def __init__(self, options, arguments):
140
"""Construct and run the command.
141
142
Sets self.status to the return value of run()."""
143
assert isinstance(options, dict)
144
assert isinstance(arguments, dict)
145
cmdargs = options.copy()
146
cmdargs.update(arguments)
147
assert self.__doc__ != Command.__doc__, \
148
("No help message set for %r" % self)
149
self.status = self.run(**cmdargs)
150
151
152
def run(self):
153
"""Override this in sub-classes.
154
155
This is invoked with the options and arguments bound to
156
keyword parameters.
157
158
Return True if the command was successful, False if not.
159
"""
160
return True
161
162
163
164
class cmd_status(Command):
139
165
"""Display status summary.
140
166
141
167
For each file there is a single line giving its file state and name.
142
168
The name is that in the current revision unless it is deleted or
143
169
missing, in which case the old name is shown.
144
170
"""
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):
171
takes_options = ['all']
172
173
def run(self, all=False):
174
#import bzrlib.status
175
#bzrlib.status.tree_status(Branch('.'))
176
Branch('.').show_status(show_all=all)
177
178
179
class cmd_cat_revision(Command):
180
"""Write out metadata for a revision."""
181
182
hidden = True
183
takes_args = ['revision_id']
184
185
def run(self, revision_id):
186
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
187
188
189
class cmd_revno(Command):
190
"""Show current revision number.
191
192
This is equal to the number of revisions on this branch."""
193
def run(self):
194
print Branch('.').revno()
195
196
197
class cmd_add(Command):
175
198
"""Add specified files or directories.
176
199
177
200
In non-recursive mode, all the named items are added, regardless
192
215
TODO: Perhaps adding a file whose directly is not versioned should
193
216
recursively add that parent, rather than giving an error?
194
217
"""
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):
218
takes_args = ['file+']
219
takes_options = ['verbose']
220
221
def run(self, file_list, verbose=False):
222
bzrlib.add.smart_add(file_list, verbose)
223
224
225
def Relpath(Command):
226
"""Show path of a file relative to root"""
227
takes_args = ('filename')
228
229
def run(self):
230
print Branch(self.args['filename']).relpath(filename)
231
232
233
234
class cmd_inventory(Command):
235
"""Show inventory of the current working copy or a revision."""
236
takes_options = ['revision']
237
238
def run(self, revision=None):
239
b = Branch('.')
240
if revision == None:
241
inv = b.read_working_inventory()
242
else:
243
inv = b.get_revision_inventory(b.lookup_revision(revision))
244
245
for path, entry in inv.iter_entries():
246
print '%-50s %s' % (entry.file_id, path)
247
248
249
class cmd_move(Command):
250
"""Move files to a different directory.
251
252
examples:
253
bzr move *.txt doc
254
255
The destination must be a versioned directory in the same branch.
256
"""
257
takes_args = ['source$', 'dest']
258
def run(self, source_list, dest):
259
b = Branch('.')
260
261
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
262
263
264
class cmd_rename(Command):
230
265
"""Change the name of an entry.
231
266
232
usage: bzr rename FROM_NAME TO_NAME
233
234
267
examples:
235
268
bzr rename frob.c frobber.c
236
269
bzr rename src/frob.c lib/frob.c
242
275
243
276
TODO: Some way to rename multiple files without invoking bzr for each
244
277
one?"""
245
b = Branch('.')
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
278
takes_args = ['from_name', 'to_name']
247
279
248
249
250
251
def cmd_renames(dir='.'):
280
def run(self, from_name, to_name):
281
b = Branch('.')
282
b.rename_one(b.relpath(from_name), b.relpath(to_name))
283
284
285
286
class cmd_renames(Command):
252
287
"""Show list of renamed files.
253
288
254
usage: bzr renames [BRANCH]
255
256
289
TODO: Option to show renames between two historical versions.
257
290
258
291
TODO: Only show renames under dir, rather than in the whole branch.
259
292
"""
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):
293
takes_args = ['dir?']
294
295
def run(self, dir='.'):
296
b = Branch(dir)
297
old_inv = b.basis_tree().inventory
298
new_inv = b.read_working_inventory()
299
300
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
301
renames.sort()
302
for old_name, new_name in renames:
303
print "%s => %s" % (old_name, new_name)
304
305
306
class cmd_info(Command):
307
"""Show statistical information for this branch"""
308
def run(self):
309
import info
310
info.show_info(Branch('.'))
311
312
313
class cmd_remove(Command):
314
"""Make a file unversioned.
315
316
This makes bzr stop tracking changes to a versioned file. It does
317
not delete the working copy.
318
"""
319
takes_args = ['file+']
320
takes_options = ['verbose']
321
322
def run(self, file_list, verbose=False):
323
b = Branch(file_list[0])
324
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
325
326
327
class cmd_file_id(Command):
287
328
"""Print file_id of a particular file or directory.
288
329
289
usage: bzr file-id FILE
290
291
330
The file_id is assigned when the file is first added and remains the
292
331
same through all revisions where the file exists, even when it is
293
332
moved or renamed.
294
333
"""
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):
334
hidden = True
335
takes_args = ['filename']
336
def run(self, filename):
337
b = Branch(filename)
338
i = b.inventory.path2id(b.relpath(filename))
339
if i == None:
340
bailout("%r is not a versioned file" % filename)
341
else:
342
print i
343
344
345
class cmd_file_path(Command):
304
346
"""Print path of file_ids to a file or directory.
305
347
306
usage: bzr file-id-path FILE
307
308
348
This prints one line for each directory down to the target,
309
349
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
350
hidden = True
351
takes_args = ['filename']
352
def run(self, filename):
353
b = Branch(filename)
354
inv = b.inventory
355
fid = inv.path2id(b.relpath(filename))
356
if fid == None:
357
bailout("%r is not a versioned file" % filename)
358
for fip in inv.get_idpath(fid):
359
print fip
360
361
362
class cmd_revision_history(Command):
363
"""Display list of revision ids on this branch."""
364
def run(self):
365
for patchid in Branch('.').revision_history():
366
print patchid
367
368
369
class cmd_directories(Command):
370
"""Display list of versioned directories in this branch."""
371
def run(self):
372
for name, ie in Branch('.').read_working_inventory().directories():
373
if name == '':
374
print '.'
375
else:
376
print name
377
378
379
class cmd_init(Command):
380
"""Make a directory into a versioned branch.
381
382
Use this to create an empty branch, or before importing an
383
existing project.
384
385
Recipe for importing a tree of files:
386
cd ~/project
387
bzr init
388
bzr add -v .
389
bzr status
390
bzr commit -m 'imported project'
391
"""
392
def run(self):
393
Branch('.', init=True)
394
395
396
class cmd_diff(Command):
397
"""Show differences in working tree.
398
358
399
If files are listed, only the changes in those files are listed.
359
400
Otherwise, all changes for the tree are listed.
360
401
374
415
deleted files.
375
416
376
417
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):
418
"""
419
420
takes_args = ['file*']
421
takes_options = ['revision']
422
423
def run(self, revision=None, file_list=None):
424
from bzrlib.diff import show_diff
425
426
show_diff(Branch('.'), revision, file_list)
427
428
429
class cmd_deleted(Command):
490
430
"""List files deleted in the working tree.
491
431
492
432
TODO: Show files deleted since a previous revision, or between two revisions.
493
433
"""
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):
434
def run(self, show_ids=False):
435
b = Branch('.')
436
old = b.basis_tree()
437
new = b.working_tree()
438
439
## TODO: Much more efficient way to do this: read in new
440
## directories with readdir, rather than stating each one. Same
441
## level of effort but possibly much less IO. (Or possibly not,
442
## if the directories are very large...)
443
444
for path, ie in old.inventory.iter_entries():
445
if not new.has_id(ie.file_id):
446
if show_ids:
447
print '%-50s %s' % (path, ie.file_id)
448
else:
449
print path
450
451
class cmd_root(Command):
452
"""Show the tree root directory.
453
454
The root is the nearest enclosing directory with a .bzr control
455
directory."""
456
takes_args = ['filename?']
457
def run(self, filename=None):
458
"""Print the branch root."""
459
print bzrlib.branch.find_branch_root(filename)
460
461
462
463
class cmd_log(Command):
565
464
"""Show log of this branch.
566
465
567
TODO: Options for utc; to show ids; to limit range; etc.
466
TODO: Options to show ids; to limit range; etc.
568
467
"""
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
570
571
572
def cmd_ls(revision=None, verbose=False):
468
takes_options = ['timezone', 'verbose']
469
def run(self, timezone='original', verbose=False):
470
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
471
472
473
class cmd_ls(Command):
573
474
"""List files in a tree.
574
475
575
476
TODO: Take a revision or remote path and list that tree instead.
576
477
"""
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 = ''
478
hidden = True
479
def run(self, revision=None, verbose=False):
480
b = Branch('.')
481
if revision == None:
482
tree = b.working_tree()
483
else:
484
tree = b.revision_tree(b.lookup_revision(revision))
485
486
for fp, fc, kind, fid in tree.list_files():
487
if verbose:
488
if kind == 'directory':
489
kindch = '/'
490
elif kind == 'file':
491
kindch = ''
492
else:
493
kindch = '???'
494
495
print '%-8s %s%s' % (fc, fp, kindch)
589
496
else:
590
kindch = '???'
591
592
print '%-8s %s%s' % (fc, fp, kindch)
593
else:
594
print fp
595
596
597
598
def cmd_unknowns():
497
print fp
498
499
500
501
class cmd_unknowns(Command):
599
502
"""List unknown files"""
600
for f in Branch('.').unknowns():
601
print quotefn(f)
602
603
604
605
def cmd_ignore(name_pattern):
503
def run(self):
504
for f in Branch('.').unknowns():
505
print quotefn(f)
506
507
508
509
class cmd_ignore(Command):
606
510
"""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()
511
takes_args = ['name_pattern']
614
512
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,
513
def run(self, name_pattern):
514
b = Branch('.')
515
516
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
517
f = open(b.abspath('.bzrignore'), 'at')
518
f.write(name_pattern + '\n')
519
f.close()
520
521
inv = b.working_tree().inventory
522
if inv.path2id('.bzrignore'):
523
mutter('.bzrignore is already versioned')
524
else:
525
mutter('need to make new .bzrignore file versioned')
526
b.add(['.bzrignore'])
527
528
529
530
class cmd_ignored(Command):
531
"""List ignored files and the patterns that matched them."""
532
def run(self):
533
tree = Branch('.').working_tree()
534
for path, file_class, kind, file_id in tree.list_files():
535
if file_class != 'I':
536
continue
537
## XXX: Slightly inefficient since this was already calculated
538
pat = tree.is_ignored(path)
539
print '%-50s %s' % (path, pat)
540
541
542
class cmd_lookup_revision(Command):
543
"""Lookup the revision-id from a revision-number
544
545
example:
546
bzr lookup-revision 33
547
"""
548
hidden = True
549
def run(self, revno):
550
try:
551
revno = int(revno)
552
except ValueError:
553
raise BzrError("not a valid revision-number: %r" % revno)
554
555
print Branch('.').lookup_revision(revno) or NONE_STRING
556
557
558
559
class cmd_export(Command):
560
"""Export past revision to destination directory.
561
562
If no revision is specified this exports the last committed revision."""
563
takes_args = ['dest']
564
takes_options = ['revision']
565
def run(self, dest, revno=None):
566
b = Branch('.')
567
if revno == None:
568
rh = b.revision_history[-1]
569
else:
570
rh = b.lookup_revision(int(revno))
571
t = b.revision_tree(rh)
572
t.export(dest)
573
574
575
class cmd_cat(Command):
576
"""Write a file's text from a previous revision."""
577
578
takes_options = ['revision']
579
takes_args = ['filename']
580
581
def run(self, filename, revision=None):
582
if revision == None:
583
raise BzrCommandError("bzr cat requires a revision number")
584
b = Branch('.')
585
b.print_file(b.relpath(filename), int(revision))
586
587
588
class cmd_local_time_offset(Command):
589
"""Show the offset in seconds from GMT to local time."""
590
hidden = True
591
def run(self):
592
print bzrlib.osutils.local_time_offset()
593
594
595
596
class cmd_commit(Command):
597
"""Commit changes into a new revision.
684
598
685
599
TODO: Commit only selected files.
686
600
688
602
689
603
TODO: Strict commit that fails if there are unknown or deleted files.
690
604
"""
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.
605
takes_options = ['message', 'verbose']
606
607
def run(self, message=None, verbose=False):
608
if not message:
609
raise BzrCommandError("please specify a commit message")
610
Branch('.').commit(message, verbose=verbose)
611
612
613
class cmd_check(Command):
614
"""Validate consistency of branch history.
704
615
705
616
This command checks various invariants about the branch storage to
706
617
detect data corruption or bzr bugs.
707
618
"""
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.
619
takes_args = ['dir?']
620
def run(self, dir='.'):
621
import bzrlib.check
622
bzrlib.check.check(Branch(dir, find_root=False))
623
624
625
626
class cmd_whoami(Command):
627
"""Show bzr user id."""
628
takes_options = ['email']
734
629
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():
630
def run(self, email=False):
631
if email:
632
print bzrlib.osutils.user_email()
633
else:
634
print bzrlib.osutils.username()
635
636
637
class cmd_selftest(Command):
747
638
"""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
639
hidden = True
640
def run(self):
641
failures, tests = 0, 0
642
643
import doctest, bzrlib.store, bzrlib.tests
644
bzrlib.trace.verbose = False
645
646
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
647
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
648
mf, mt = doctest.testmod(m)
649
failures += mf
650
tests += mt
651
print '%-40s %3d tests' % (m.__name__, mt),
652
if mf:
653
print '%3d FAILED!' % mf
654
else:
655
print
656
657
print '%-40s %3d tests' % ('total', tests),
658
if failures:
659
print '%3d FAILED!' % failures
766
660
else:
767
661
print
768
662
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):
663
664
665
class cmd_version(Command):
666
"""Show version of bzr"""
667
def run(self):
668
show_version()
669
670
def show_version():
671
print "bzr (bazaar-ng) %s" % bzrlib.__version__
672
print bzrlib.__copyright__
673
print "http://bazaar-ng.org/"
674
print
675
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
676
print "you may use, modify and redistribute it under the terms of the GNU"
677
print "General Public License version 2 or later."
678
679
680
class cmd_rocks(Command):
681
"""Statement of optimism."""
682
hidden = True
683
def run(self):
684
print "it sure does!"
685
686
687
class cmd_assert_fail(Command):
688
"""Test reporting of assertion failures"""
689
hidden = True
690
def run(self):
691
assert False, "always fails"
692
693
694
class cmd_help(Command):
695
"""Show help on a command or other topic.
696
697
For a list of all available commands, say 'bzr help commands'."""
698
takes_args = ['topic?']
699
700
def run(self, topic=None):
701
help(topic)
702
703
704
def help(topic=None):
786
705
if topic == None:
787
706
print __doc__
788
707
elif topic == 'commands':
789
708
help_commands()
790
709
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
710
help_on_command(topic)
711
712
713
def help_on_command(cmdname):
714
cmdname = str(cmdname)
715
716
from inspect import getdoc
717
topic, cmdclass = get_cmd_class(cmdname)
718
719
doc = getdoc(cmdclass)
720
if doc == None:
721
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
722
723
if '\n' in doc:
724
short, rest = doc.split('\n', 1)
725
else:
726
short = doc
727
rest = ''
728
729
print 'usage: bzr ' + topic,
730
for aname in cmdclass.takes_args:
731
aname = aname.upper()
732
if aname[-1] in ['$', '+']:
733
aname = aname[:-1] + '...'
734
elif aname[-1] == '?':
735
aname = '[' + aname[:-1] + ']'
736
elif aname[-1] == '*':
737
aname = '[' + aname[:-1] + '...]'
738
print aname,
739
print
740
print short
741
if rest:
742
print rest
743
744
if cmdclass.takes_options:
745
print
746
print 'options:'
747
for on in cmdclass.takes_options:
748
print ' --%s' % on
799
749
800
750
801
751
def help_commands():
802
752
"""List all commands"""
753
import inspect
754
803
755
accu = []
804
for k in globals().keys():
756
for k, v in globals().items():
805
757
if k.startswith('cmd_'):
806
accu.append(k[4:].replace('_','-'))
758
accu.append((k[4:].replace('_','-'), v))
807
759
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():
819
print "bzr (bazaar-ng) %s" % bzrlib.__version__
820
print bzrlib.__copyright__
821
print "http://bazaar-ng.org/"
822
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():
830
"""Statement of optimism."""
831
print "it sure does!"
832
760
for cmdname, cmdclass in accu:
761
if cmdclass.hidden:
762
continue
763
print cmdname
764
help = inspect.getdoc(cmdclass)
765
if help:
766
print " " + help.split('\n', 1)[0]
833
767
834
768
835
769
######################################################################
858
792
'v': 'verbose',
859
793
}
860
794
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
795
905
796
def parse_args(argv):
906
797
"""Parse command line.
967
858
968
859
969
860
970
def _match_args(cmd, args):
971
"""Check non-option arguments match required pattern.
972
861
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, [])
862
def _match_argform(cmd, takes_args, args):
984
863
argdict = {}
985
# TODO: Need a way to express 'cp SRC... DEST', where it matches
986
# all but one.
987
864
988
# step through args and argform, allowing appropriate 0-many matches
989
for ap in argform:
865
# step through args and takes_args, allowing appropriate 0-many matches
866
for ap in takes_args:
990
867
argname = ap[:-1]
991
868
if ap[-1] == '?':
992
869
if args:
999
876
argdict[argname + '_list'] = None
1000
877
elif ap[-1] == '+':
1001
878
if not args:
1002
bailout("command %r needs one or more %s"
879
raise BzrCommandError("command %r needs one or more %s"
1003
880
% (cmd, argname.upper()))
1004
881
else:
1005
882
argdict[argname + '_list'] = args[:]
1006
883
args = []
1007
884
elif ap[-1] == '$': # all but one
1008
885
if len(args) < 2:
1009
bailout("command %r needs one or more %s"
886
raise BzrCommandError("command %r needs one or more %s"
1010
887
% (cmd, argname.upper()))
1011
888
argdict[argname + '_list'] = args[:-1]
1012
889
args[:-1] = []
1014
891
# just a plain arg
1015
892
argname = ap
1016
893
if not args:
1017
bailout("command %r requires argument %s"
894
raise BzrCommandError("command %r requires argument %s"
1018
895
% (cmd, argname.upper()))
1019
896
else:
1020
897
argdict[argname] = args.pop(0)
1021
898
1022
899
if args:
1023
bailout("extra arguments to command %s: %r"
1024
% (cmd, args))
900
raise BzrCommandError("extra argument to command %s: %s"
901
% (cmd, args[0]))
1025
902
1026
903
return argdict
1027
904
1039
916
try:
1040
917
args, opts = parse_args(argv[1:])
1041
918
if 'help' in opts:
1042
# TODO: pass down other arguments in case they asked for
1043
# help on a command name?
1044
919
if args:
1045
cmd_help(args[0])
920
help(args[0])
1046
921
else:
1047
cmd_help()
922
help()
1048
923
return 0
1049
924
elif 'version' in opts:
1050
cmd_version()
925
cmd_version([], [])
1051
926
return 0
1052
927
cmd = str(args.pop(0))
1053
928
except IndexError:
1055
930
log_error(' try "bzr help"')
1056
931
return 1
1057
932
1058
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
933
canonical_cmd, cmd_class = get_cmd_class(cmd)
1059
934
1060
935
# global option
1061
936
if 'profile' in opts:
1065
940
profile = False
1066
941
1067
942
# check options are reasonable
1068
allowed = cmd_options.get(canonical_cmd, [])
943
allowed = cmd_class.takes_options
1069
944
for oname in opts:
1070
945
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)
946
raise BzrCommandError("option %r is not allowed for command %r"
947
% (oname, cmd))
1077
948
1078
949
# mix arguments and options into one dictionary
1079
cmdargs = _match_args(canonical_cmd, args)
950
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
951
cmdopts = {}
1080
952
for k, v in opts.items():
1081
cmdargs[k.replace('-', '_')] = v
953
cmdopts[k.replace('-', '_')] = v
1082
954
1083
955
if profile:
1084
956
import hotshot
1085
957
pffileno, pfname = tempfile.mkstemp()
1086
958
try:
1087
959
prof = hotshot.Profile(pfname)
1088
ret = prof.runcall(cmd_handler, **cmdargs) or 0
960
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1089
961
prof.close()
1090
962
1091
963
import hotshot.stats
1102
974
os.close(pffileno)
1103
975
os.remove(pfname)
1104
976
else:
1105
return cmd_handler(**cmdargs) or 0
977
cmdobj = cmd_class(cmdopts, cmdargs) or 0
1106
978
1107
979
1108
980
1119
991
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1120
992
1121
993
1122
def cmd_assert_fail():
1123
assert False, "always fails"
1124
1125
994
1126
995
def main(argv):
1127
996
import errno
1135
1004
sys.stdout.flush()
1136
1005
return ret
1137
1006
except BzrError, e:
1138
_report_exception(e, 'error: ' + e.args[0])
1007
quiet = isinstance(e, (BzrCommandError))
1008
_report_exception(e, 'error: ' + e.args[0], quiet=quiet)
1139
1009
if len(e.args) > 1:
1140
1010
for h in e.args[1]:
1141
1011
# some explanation or hints
Loggerhead is a web-based interface for Breezy
Version: 2.0.1