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