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