« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 149
- compare with another revision
- download diff
- download tarball
- view history from revision 149
- Committer: mbp at sourcefrog
- Date: 2005-03-30 22:27:17 UTC
- Revision ID: mbp@sourcefrog.net-20050330222717-027b5837127b938d
experiment with new nested inventory file format
not used by default yet
not used by default yet
- files added:
- bzrlib/tests.py
- files removed:
- .rsyncexclude
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- bzrlib/util/elementtree/ => elementtree/
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
2
4
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
18
17
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
20
21
# TODO: Help messages for options.
22
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
26
27
28
29
import sys
30
import os
31
from warnings import warn
32
from inspect import getdoc
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, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
67
from os import path
68
from sets import Set
69
from pprint import pprint
70
from stat import *
71
from glob import glob
33
72
34
73
import bzrlib
35
import bzrlib.trace
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
40
41
plugin_cmds = {}
42
43
44
def register_command(cmd):
45
"Utility function to help register a command"
46
global plugin_cmds
47
k = cmd.__name__
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
50
else:
51
k_unsquished = k
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
55
else:
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
58
59
60
def _squish_command_name(cmd):
61
return 'cmd_' + cmd.replace('-', '_')
62
63
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
66
return cmd[4:].replace('_','-')
67
68
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
71
72
This always returns a list. The list will have one element for
73
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
76
77
>>> _parse_revision_str('234')
78
[234]
79
>>> _parse_revision_str('234..567')
80
[234, 567]
81
>>> _parse_revision_str('..')
82
[None, None]
83
>>> _parse_revision_str('..234')
84
[None, 234]
85
>>> _parse_revision_str('234..')
86
[234, None]
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
88
[234, 456, 789]
89
>>> _parse_revision_str('234....789') # Error?
90
[234, None, 789]
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
98
['date:2005-04-12']
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
106
[-5, 23]
107
>>> _parse_revision_str('-5')
108
[-5]
109
>>> _parse_revision_str('123a')
110
['123a']
111
>>> _parse_revision_str('abc')
112
['abc']
113
"""
114
import re
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
117
if m:
118
warning('Colon separator for revision numbers is deprecated.'
119
' Use .. instead')
120
revs = []
121
for rev in revstr.split(':'):
122
if rev:
123
revs.append(int(rev))
124
else:
125
revs.append(None)
126
return revs
127
revs = []
128
for x in revstr.split('..'):
129
if not x:
130
revs.append(None)
131
else:
132
try:
133
revs.append(int(x))
134
except ValueError:
135
revs.append(x)
136
return revs
137
138
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
142
try:
143
return merge_types[typestring][0]
144
except KeyError:
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
151
152
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
156
try:
157
return merge_types[typestring][0]
158
except KeyError:
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
165
166
167
def _builtin_commands():
168
import bzrlib.builtins
169
r = {}
170
builtins = bzrlib.builtins.__dict__
171
for name in builtins:
172
if name.startswith("cmd_"):
173
real_name = _unsquish_command_name(name)
174
r[real_name] = builtins[name]
175
return r
176
177
178
179
def builtin_command_names():
180
"""Return list of builtin command names."""
181
return _builtin_commands().keys()
182
183
184
def plugin_command_names():
185
return plugin_cmds.keys()
186
187
188
def _get_cmd_dict(plugins_override=True):
189
"""Return name->class mapping for all commands."""
190
d = _builtin_commands()
191
if plugins_override:
192
d.update(plugin_cmds)
193
return d
194
195
196
def get_all_cmds(plugins_override=True):
197
"""Return canonical name and class for all registered commands."""
198
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
199
yield k,v
200
201
202
def get_cmd_object(cmd_name, plugins_override=True):
203
"""Return the canonical name and command class for a command.
204
205
plugins_override
206
If true, plugin commands can override builtins.
207
"""
208
from bzrlib.externalcommand import ExternalCommand
209
210
cmd_name = str(cmd_name) # not unicode
211
212
# first look up this command under the specified name
213
cmds = _get_cmd_dict(plugins_override=plugins_override)
214
try:
215
return cmds[cmd_name]()
216
except KeyError:
217
pass
218
219
# look for any command which claims this as an alias
220
for real_cmd_name, cmd_class in cmds.iteritems():
221
if cmd_name in cmd_class.aliases:
222
return cmd_class()
223
224
cmd_obj = ExternalCommand.find_command(cmd_name)
225
if cmd_obj:
226
return cmd_obj
227
228
raise BzrCommandError("unknown command %r" % cmd_name)
229
230
231
class Command(object):
232
"""Base class for commands.
233
234
Commands are the heart of the command-line bzr interface.
235
236
The command object mostly handles the mapping of command-line
237
parameters into one or more bzrlib operations, and of the results
238
into textual output.
239
240
Commands normally don't have any state. All their arguments are
241
passed in to the run method. (Subclasses may take a different
242
policy if the behaviour of the instance needs to depend on e.g. a
243
shell plugin and not just its Python class.)
244
245
The docstring for an actual command should give a single-line
246
summary, then a complete description of the command. A grammar
247
description will be inserted.
248
249
aliases
250
Other accepted names for this command.
251
252
takes_args
253
List of argument forms, marked with whether they are optional,
254
repeated, etc.
255
256
takes_options
257
List of options that may be given for this command.
258
259
hidden
260
If true, this command isn't advertised. This is typically
261
for commands intended for expert users.
262
"""
263
aliases = []
264
265
takes_args = []
266
takes_options = []
267
268
hidden = False
269
270
def __init__(self):
271
"""Construct an instance of this command."""
272
if self.__doc__ == Command.__doc__:
273
warn("No help message set for %r" % self)
274
275
276
def run_argv(self, argv):
277
"""Parse command line and run."""
278
args, opts = parse_args(argv)
279
280
if 'help' in opts: # e.g. bzr add --help
281
from bzrlib.help import help_on_command
282
help_on_command(self.name())
283
return 0
284
285
# check options are reasonable
286
allowed = self.takes_options
287
for oname in opts:
288
if oname not in allowed:
289
raise BzrCommandError("option '--%s' is not allowed for command %r"
290
% (oname, self.name()))
291
292
# mix arguments and options into one dictionary
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
294
cmdopts = {}
295
for k, v in opts.items():
296
cmdopts[k.replace('-', '_')] = v
297
298
all_cmd_args = cmdargs.copy()
299
all_cmd_args.update(cmdopts)
300
301
return self.run(**all_cmd_args)
302
303
304
def run(self):
305
"""Actually run the command.
306
307
This is invoked with the options and arguments bound to
308
keyword parameters.
309
310
Return 0 or None if the command was successful, or a non-zero
311
shell error code if not. It's OK for this method to allow
312
an exception to raise up.
313
"""
314
raise NotImplementedError()
315
316
317
def help(self):
318
"""Return help message for this class."""
319
if self.__doc__ is Command.__doc__:
320
return None
321
return getdoc(self)
322
323
def name(self):
324
return _unsquish_command_name(self.__class__.__name__)
325
326
327
def parse_spec(spec):
328
"""
329
>>> parse_spec(None)
330
[None, None]
331
>>> parse_spec("./")
332
['./', None]
333
>>> parse_spec("../@")
334
['..', -1]
335
>>> parse_spec("../f/@35")
336
['../f', 35]
337
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
338
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
339
"""
340
if spec is None:
341
return [None, None]
342
if '/@' in spec:
343
parsed = spec.split('/@')
344
assert len(parsed) == 2
345
if parsed[1] == "":
346
parsed[1] = -1
347
else:
348
try:
349
parsed[1] = int(parsed[1])
350
except ValueError:
351
pass # We can allow stuff like ./@revid:blahblahblah
352
else:
353
assert parsed[1] >=0
354
else:
355
parsed = [spec, None]
356
return parsed
357
358
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
format_date
82
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
86
## standard representation
87
NONE_STRING = '(none)'
88
EMPTY = 'empty'
89
90
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
93
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
100
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
103
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
107
## directory.
108
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
112
113
## TODO: move command; check destination is a directory and will not
114
## clash; move it.
115
116
## TODO: command to show renames, one per line, as to->from
117
118
119
120
121
def cmd_status(all=False):
122
"""Display status summary.
123
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
127
128
:todo: Don't show unchanged files unless ``--all`` is given?
129
"""
130
Branch('.').show_status(show_all=all)
131
132
133
134
######################################################################
135
# examining history
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
139
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
144
145
146
147
######################################################################
148
# commands
149
150
151
def cmd_revno():
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
154
155
156
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
159
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
163
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
170
directories.
171
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
174
"""
175
bzrlib.add.smart_add(file_list, verbose)
176
177
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
181
182
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
187
b = Branch('.')
188
if revision == None:
189
inv = b.read_working_inventory()
190
else:
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
192
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
195
196
197
198
def cmd_info():
199
"""info: Show statistical information for this branch
200
201
usage: bzr info"""
202
import info
203
info.show_info(Branch('.'))
204
205
206
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
211
212
213
def cmd_file_id(filename):
214
b = Branch(filename)
215
i = b.inventory.path2id(b.relpath(filename))
216
if i is None:
217
bailout("%s is not a versioned file" % filename)
218
else:
219
print i
220
221
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
224
if n is None:
225
bailout("%s is not a live file id" % fileid)
226
else:
227
print n
228
229
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
232
print patchid
233
234
235
236
def cmd_init():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
239
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
243
# both?
244
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
247
248
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
251
252
usage: bzr diff [-r REV]
253
254
--revision REV
255
Show changes since REV, rather than predecessor.
256
257
TODO: Given two revision arguments, show the difference between them.
258
259
TODO: Allow diff across branches.
260
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
262
or a graphical diff.
263
264
TODO: Diff selected files.
265
"""
266
267
## TODO: Shouldn't be in the cmd function.
268
269
b = Branch('.')
270
271
if revision == None:
272
old_tree = b.basis_tree()
273
else:
274
old_tree = b.revision_tree(b.lookup_revision(revision))
275
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
279
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
281
old_label = ''
282
new_label = ''
283
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
288
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
291
292
# TODO: Better to return them in sorted order I think.
293
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
295
d = None
296
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
299
idlabel = ''
300
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
303
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
306
print
307
308
if file_state in ['.', '?', 'I']:
309
continue
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
312
if kind == 'file':
313
diffit([],
314
new_tree.get_file(fid).readlines(),
315
fromfile=DEVNULL,
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
320
if kind == 'file':
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
323
tofile=DEVNULL)
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
331
332
if kind == 'file':
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
337
else:
338
bailout("can't represent state %s {%s}" % (file_state, fid))
339
340
341
342
def cmd_deleted(show_ids=False):
343
"""List files deleted in the working tree.
344
345
TODO: Show files deleted since a previous revision, or between two revisions.
346
"""
347
b = Branch('.')
348
old = b.basis_tree()
349
new = b.working_tree()
350
351
## TODO: Much more efficient way to do this: read in new
352
## directories with readdir, rather than stating each one. Same
353
## level of effort but possibly much less IO. (Or possibly not,
354
## if the directories are very large...)
355
356
for path, ie in old.inventory.iter_entries():
357
if not new.has_id(ie.file_id):
358
if show_ids:
359
print '%-50s %s' % (path, ie.file_id)
360
else:
361
print path
362
363
364
365
def cmd_parse_inventory():
366
import cElementTree
367
368
cElementTree.ElementTree().parse(file('.bzr/inventory'))
369
370
371
372
def cmd_load_inventory():
373
inv = Branch('.').basis_tree().inventory
374
375
376
377
def cmd_dump_new_inventory():
378
import bzrlib.newinventory
379
inv = Branch('.').basis_tree().inventory
380
bzrlib.newinventory.write_inventory(inv, sys.stdout)
381
382
383
def cmd_dump_slacker_inventory():
384
import bzrlib.newinventory
385
inv = Branch('.').basis_tree().inventory
386
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
387
388
389
390
def cmd_root(filename=None):
391
"""Print the branch root."""
392
print bzrlib.branch.find_branch_root(filename)
393
394
395
def cmd_log(timezone='original'):
396
"""Show log of this branch.
397
398
:todo: Options for utc; to show ids; to limit range; etc.
399
"""
400
Branch('.').write_log(show_timezone=timezone)
401
402
403
def cmd_ls(revision=None, verbose=False):
404
"""List files in a tree.
405
406
:todo: Take a revision or remote path and list that tree instead.
407
"""
408
b = Branch('.')
409
if revision == None:
410
tree = b.working_tree()
411
else:
412
tree = b.revision_tree(b.lookup_revision(revision))
413
414
for fp, fc, kind, fid in tree.list_files():
415
if verbose:
416
if kind == 'directory':
417
kindch = '/'
418
elif kind == 'file':
419
kindch = ''
420
else:
421
kindch = '???'
422
423
print '%-8s %s%s' % (fc, fp, kindch)
424
else:
425
print fp
426
427
428
429
def cmd_unknowns():
430
"""List unknown files"""
431
for f in Branch('.').unknowns():
432
print quotefn(f)
433
434
435
436
def cmd_ignored(verbose=True):
437
"""List ignored files and the patterns that matched them.
438
"""
439
tree = Branch('.').working_tree()
440
for path, file_class, kind, id in tree.list_files():
441
if file_class != 'I':
442
continue
443
## XXX: Slightly inefficient since this was already calculated
444
pat = tree.is_ignored(path)
445
print '%-50s %s' % (path, pat)
446
447
448
def cmd_lookup_revision(revno):
449
try:
450
revno = int(revno)
451
except ValueError:
452
bailout("usage: lookup-revision REVNO",
453
["REVNO is a non-negative revision number for this branch"])
454
455
print Branch('.').lookup_revision(revno) or NONE_STRING
456
457
458
459
def cmd_export(revno, dest):
460
"""Export past revision to destination directory."""
461
b = Branch('.')
462
rh = b.lookup_revision(int(revno))
463
t = b.revision_tree(rh)
464
t.export(dest)
465
466
467
468
######################################################################
469
# internal/test commands
470
471
472
def cmd_uuid():
473
"""Print a newly-generated UUID."""
474
print bzrlib.osutils.uuid()
475
476
477
478
def cmd_local_time_offset():
479
print bzrlib.osutils.local_time_offset()
480
481
482
483
def cmd_commit(message=None, verbose=False):
484
"""Commit changes to a new revision.
485
486
--message MESSAGE
487
Description of changes in this revision; free form text.
488
It is recommended that the first line be a single-sentence
489
summary.
490
--verbose
491
Show status of changed files,
492
493
TODO: Commit only selected files.
494
495
TODO: Run hooks on tree to-be-committed, and after commit.
496
497
TODO: Strict commit that fails if there are unknown or deleted files.
498
"""
499
500
if not message:
501
bailout("please specify a commit message")
502
Branch('.').commit(message, verbose=verbose)
503
504
505
def cmd_check(dir='.'):
506
"""check: Consistency check of branch history.
507
508
usage: bzr check [-v] [BRANCH]
509
510
options:
511
--verbose, -v Show progress of checking.
512
513
This command checks various invariants about the branch storage to
514
detect data corruption or bzr bugs.
515
"""
516
import bzrlib.check
517
bzrlib.check.check(Branch(dir, find_root=False))
518
519
520
def cmd_is(pred, *rest):
521
"""Test whether PREDICATE is true."""
522
try:
523
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
524
except KeyError:
525
bailout("unknown predicate: %s" % quotefn(pred))
526
527
try:
528
cmd_handler(*rest)
529
except BzrCheckError:
530
# by default we don't print the message so that this can
531
# be used from shell scripts without producing noise
532
sys.exit(1)
533
534
535
def cmd_username():
536
print bzrlib.osutils.username()
537
538
539
def cmd_user_email():
540
print bzrlib.osutils.user_email()
541
542
543
def cmd_gen_revision_id():
544
import time
545
print bzrlib.branch._gen_revision_id(time.time())
546
547
548
def cmd_selftest(verbose=False):
549
"""Run internal test suite"""
550
## -v, if present, is seen by doctest; the argument is just here
551
## so our parser doesn't complain
552
553
## TODO: --verbose option
554
555
failures, tests = 0, 0
556
557
import doctest, bzrlib.store, bzrlib.tests
558
bzrlib.trace.verbose = False
559
560
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
561
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
562
mf, mt = doctest.testmod(m)
563
failures += mf
564
tests += mt
565
print '%-40s %3d tests' % (m.__name__, mt),
566
if mf:
567
print '%3d FAILED!' % mf
568
else:
569
print
570
571
print '%-40s %3d tests' % ('total', tests),
572
if failures:
573
print '%3d FAILED!' % failures
574
else:
575
print
576
577
578
579
# deprecated
580
cmd_doctest = cmd_selftest
581
582
583
######################################################################
584
# help
585
586
587
def cmd_help(topic=None):
588
if topic == None:
589
print __doc__
590
return
591
592
# otherwise, maybe the name of a command?
593
try:
594
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
595
except KeyError:
596
bailout("no help for %r" % topic)
597
598
doc = cmdfn.__doc__
599
if doc == None:
600
bailout("sorry, no detailed help yet for %r" % topic)
601
602
print doc
603
604
605
606
607
def cmd_version():
608
print "bzr (bazaar-ng) %s" % bzrlib.__version__
609
print bzrlib.__copyright__
610
print "http://bazaar-ng.org/"
611
print
612
print \
613
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
614
you may use, modify and redistribute it under the terms of the GNU
615
General Public License version 2 or later."""
616
617
618
def cmd_rocks():
619
"""Statement of optimism."""
620
print "it sure does!"
621
622
623
624
######################################################################
625
# main routine
359
626
360
627
361
628
# list of all available options; the rhs can be either None for an
363
630
# the type.
364
631
OPTIONS = {
365
632
'all': None,
366
'diff-options': str,
367
633
'help': None,
368
'file': unicode,
369
'force': None,
370
'format': unicode,
371
'forward': None,
372
634
'message': unicode,
373
'no-recurse': None,
374
635
'profile': None,
375
'revision': _parse_revision_str,
376
'short': None,
636
'revision': int,
377
637
'show-ids': None,
378
638
'timezone': str,
379
639
'verbose': None,
380
640
'version': None,
381
'email': None,
382
'unchanged': None,
383
'update': None,
384
'long': None,
385
'root': str,
386
'no-backup': None,
387
'merge-type': get_merge_type,
388
'pattern': str,
389
641
}
390
642
391
643
SHORT_OPTIONS = {
392
'F': 'file',
393
'h': 'help',
394
644
'm': 'message',
395
645
'r': 'revision',
396
646
'v': 'verbose',
397
'l': 'long',
398
647
}
399
648
649
# List of options that apply to particular commands; commands not
650
# listed take none.
651
cmd_options = {
652
'add': ['verbose'],
653
'commit': ['message', 'verbose'],
654
'deleted': ['show-ids'],
655
'diff': ['revision'],
656
'inventory': ['revision'],
657
'log': ['timezone'],
658
'ls': ['revision', 'verbose'],
659
'remove': ['verbose'],
660
'status': ['all'],
661
}
662
663
664
cmd_args = {
665
'add': ['file+'],
666
'commit': [],
667
'diff': [],
668
'export': ['revno', 'dest'],
669
'file-id': ['filename'],
670
'get-file-text': ['text_id'],
671
'get-inventory': ['inventory_id'],
672
'get-revision': ['revision_id'],
673
'get-revision-inventory': ['revision_id'],
674
'help': ['topic?'],
675
'init': [],
676
'log': [],
677
'lookup-revision': ['revno'],
678
'relpath': ['filename'],
679
'remove': ['file+'],
680
'root': ['filename?'],
681
'status': [],
682
}
683
400
684
401
685
def parse_args(argv):
402
686
"""Parse command line.
408
692
409
693
>>> parse_args('--help'.split())
410
694
([], {'help': True})
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
413
695
>>> parse_args('--version'.split())
414
696
([], {'version': True})
415
697
>>> parse_args('status --all'.split())
416
698
(['status'], {'all': True})
417
699
>>> parse_args('commit --message=biter'.split())
418
700
(['commit'], {'message': u'biter'})
419
>>> parse_args('log -r 500'.split())
420
(['log'], {'revision': [500]})
421
>>> parse_args('log -r500..600'.split())
422
(['log'], {'revision': [500, 600]})
423
>>> parse_args('log -vr500..600'.split())
424
(['log'], {'verbose': True, 'revision': [500, 600]})
425
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
426
(['log'], {'revision': ['v500', 600]})
427
701
"""
428
702
args = []
429
703
opts = {}
430
704
431
argsover = False
705
# TODO: Maybe handle '--' to end options?
706
432
707
while argv:
433
708
a = argv.pop(0)
434
if not argsover and a[0] == '-':
435
# option names must not be unicode
436
a = str(a)
709
if a[0] == '-':
437
710
optarg = None
438
711
if a[1] == '-':
439
if a == '--':
440
# We've received a standalone -- No more flags
441
argsover = True
442
continue
443
712
mutter(" got option %r" % a)
444
713
if '=' in a:
445
714
optname, optarg = a[2:].split('=', 1)
446
715
else:
447
716
optname = a[2:]
448
717
if optname not in OPTIONS:
449
raise BzrError('unknown long option %r' % a)
718
bailout('unknown long option %r' % a)
450
719
else:
451
720
shortopt = a[1:]
452
if shortopt in SHORT_OPTIONS:
453
# Multi-character options must have a space to delimit
454
# their value
455
optname = SHORT_OPTIONS[shortopt]
456
else:
457
# Single character short options, can be chained,
458
# and have their value appended to their name
459
shortopt = a[1:2]
460
if shortopt not in SHORT_OPTIONS:
461
# We didn't find the multi-character name, and we
462
# didn't find the single char name
463
raise BzrError('unknown short option %r' % a)
464
optname = SHORT_OPTIONS[shortopt]
465
466
if a[2:]:
467
# There are extra things on this option
468
# see if it is the value, or if it is another
469
# short option
470
optargfn = OPTIONS[optname]
471
if optargfn is None:
472
# This option does not take an argument, so the
473
# next entry is another short option, pack it back
474
# into the list
475
argv.insert(0, '-' + a[2:])
476
else:
477
# This option takes an argument, so pack it
478
# into the array
479
optarg = a[2:]
721
if shortopt not in SHORT_OPTIONS:
722
bailout('unknown short option %r' % a)
723
optname = SHORT_OPTIONS[shortopt]
480
724
481
725
if optname in opts:
482
726
# XXX: Do we ever want to support this, e.g. for -r?
483
raise BzrError('repeated option %r' % a)
727
bailout('repeated option %r' % a)
484
728
485
729
optargfn = OPTIONS[optname]
486
730
if optargfn:
487
731
if optarg == None:
488
732
if not argv:
489
raise BzrError('option %r needs an argument' % a)
733
bailout('option %r needs an argument' % a)
490
734
else:
491
735
optarg = argv.pop(0)
492
736
opts[optname] = optargfn(optarg)
493
737
else:
494
738
if optarg != None:
495
raise BzrError('option %r takes no argument' % optname)
739
bailout('option %r takes no argument' % optname)
496
740
opts[optname] = True
497
741
else:
498
742
args.append(a)
501
745
502
746
503
747
748
def _match_args(cmd, args):
749
"""Check non-option arguments match required pattern.
504
750
505
def _match_argform(cmd, takes_args, args):
751
>>> _match_args('status', ['asdasdsadasd'])
752
Traceback (most recent call last):
753
...
754
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
755
>>> _match_args('add', ['asdasdsadasd'])
756
{'file_list': ['asdasdsadasd']}
757
>>> _match_args('add', 'abc def gj'.split())
758
{'file_list': ['abc', 'def', 'gj']}
759
"""
760
# match argument pattern
761
argform = cmd_args.get(cmd, [])
506
762
argdict = {}
763
# TODO: Need a way to express 'cp SRC... DEST', where it matches
764
# all but one.
507
765
508
# step through args and takes_args, allowing appropriate 0-many matches
509
for ap in takes_args:
766
# step through args and argform, allowing appropriate 0-many matches
767
for ap in argform:
510
768
argname = ap[:-1]
511
769
if ap[-1] == '?':
512
770
if args:
513
771
argdict[argname] = args.pop(0)
514
elif ap[-1] == '*': # all remaining arguments
515
if args:
516
argdict[argname + '_list'] = args[:]
517
args = []
518
else:
519
argdict[argname + '_list'] = None
772
elif ap[-1] == '*':
773
assert 0
520
774
elif ap[-1] == '+':
521
775
if not args:
522
raise BzrCommandError("command %r needs one or more %s"
776
bailout("command %r needs one or more %s"
523
777
% (cmd, argname.upper()))
524
778
else:
525
779
argdict[argname + '_list'] = args[:]
526
780
args = []
527
elif ap[-1] == '$': # all but one
528
if len(args) < 2:
529
raise BzrCommandError("command %r needs one or more %s"
530
% (cmd, argname.upper()))
531
argdict[argname + '_list'] = args[:-1]
532
args[:-1] = []
533
781
else:
534
782
# just a plain arg
535
783
argname = ap
536
784
if not args:
537
raise BzrCommandError("command %r requires argument %s"
785
bailout("command %r requires argument %s"
538
786
% (cmd, argname.upper()))
539
787
else:
540
788
argdict[argname] = args.pop(0)
541
789
542
790
if args:
543
raise BzrCommandError("extra argument to command %s: %s"
544
% (cmd, args[0]))
791
bailout("extra arguments to command %s: %r"
792
% (cmd, args))
545
793
546
794
return argdict
547
795
548
796
549
797
550
def apply_profiled(the_callable, *args, **kwargs):
551
import hotshot
552
import tempfile
553
pffileno, pfname = tempfile.mkstemp()
554
try:
555
prof = hotshot.Profile(pfname)
556
try:
557
ret = prof.runcall(the_callable, *args, **kwargs) or 0
558
finally:
559
prof.close()
798
def run_bzr(argv):
799
"""Execute a command.
800
801
This is similar to main(), but without all the trappings for
802
logging and error handling.
803
"""
804
try:
805
args, opts = parse_args(argv[1:])
806
if 'help' in opts:
807
# TODO: pass down other arguments in case they asked for
808
# help on a command name?
809
cmd_help()
810
return 0
811
elif 'version' in opts:
812
cmd_version()
813
return 0
814
cmd = args.pop(0)
815
except IndexError:
816
log_error('usage: bzr COMMAND\n')
817
log_error(' try "bzr help"\n')
818
return 1
819
820
try:
821
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
822
except KeyError:
823
bailout("unknown command " + `cmd`)
824
825
# global option
826
if 'profile' in opts:
827
profile = True
828
del opts['profile']
829
else:
830
profile = False
831
832
# check options are reasonable
833
allowed = cmd_options.get(cmd, [])
834
for oname in opts:
835
if oname not in allowed:
836
bailout("option %r is not allowed for command %r"
837
% (oname, cmd))
838
839
# mix arguments and options into one dictionary
840
cmdargs = _match_args(cmd, args)
841
for k, v in opts.items():
842
cmdargs[k.replace('-', '_')] = v
843
844
if profile:
845
import hotshot
846
prof = hotshot.Profile('.bzr.profile')
847
ret = prof.runcall(cmd_handler, **cmdargs) or 0
848
prof.close()
560
849
561
850
import hotshot.stats
562
stats = hotshot.stats.load(pfname)
851
stats = hotshot.stats.load('.bzr.profile')
563
852
#stats.strip_dirs()
564
853
stats.sort_stats('time')
565
## XXX: Might like to write to stderr or the trace file instead but
566
## print_stats seems hardcoded to stdout
567
854
stats.print_stats(20)
568
855
else:
856
return cmd_handler(**cmdargs) or 0
857
858
859
860
def main(argv):
861
## TODO: Handle command-line options; probably know what options are valid for
862
## each command
863
864
## TODO: If the arguments are wrong, give a usage message rather
865
## than just a backtrace.
866
867
bzrlib.trace.create_tracefile(argv)
868
869
try:
870
ret = run_bzr(argv)
569
871
return ret
570
finally:
571
os.close(pffileno)
572
os.remove(pfname)
573
574
575
def run_bzr(argv):
576
"""Execute a command.
577
578
This is similar to main(), but without all the trappings for
579
logging and error handling.
580
581
argv
582
The command-line arguments, without the program name from argv[0]
583
584
Returns a command status or raises an exception.
585
586
Special master options: these must come before the command because
587
they control how the command is interpreted.
588
589
--no-plugins
590
Do not load plugin modules at all
591
592
--builtin
593
Only use builtin commands. (Plugins are still allowed to change
594
other behaviour.)
595
596
--profile
597
Run under the Python profiler.
598
"""
599
600
argv = [a.decode(bzrlib.user_encoding) for a in argv]
601
602
opt_profile = opt_no_plugins = opt_builtin = False
603
604
# --no-plugins is handled specially at a very early stage. We need
605
# to load plugins before doing other command parsing so that they
606
# can override commands, but this needs to happen first.
607
608
for a in argv:
609
if a == '--profile':
610
opt_profile = True
611
elif a == '--no-plugins':
612
opt_no_plugins = True
613
elif a == '--builtin':
614
opt_builtin = True
615
else:
616
break
617
argv.remove(a)
618
619
if (not argv) or (argv[0] == '--help'):
620
from bzrlib.help import help
621
if len(argv) > 1:
622
help(argv[1])
623
else:
624
help()
625
return 0
626
627
if argv[0] == '--version':
628
from bzrlib.builtins import show_version
629
show_version()
630
return 0
631
632
if not opt_no_plugins:
633
from bzrlib.plugin import load_plugins
634
load_plugins()
635
636
cmd = str(argv.pop(0))
637
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
639
640
if opt_profile:
641
ret = apply_profiled(cmd_obj.run_argv, argv)
642
else:
643
ret = cmd_obj.run_argv(argv)
644
return ret or 0
645
646
647
def main(argv):
648
import bzrlib.ui
649
bzrlib.trace.log_startup(argv)
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
651
652
try:
653
try:
654
return run_bzr(argv[1:])
655
finally:
656
# do this here inside the exception wrappers to catch EPIPE
657
sys.stdout.flush()
658
except BzrCommandError, e:
659
# command line syntax error, etc
660
log_error(str(e))
661
return 1
662
872
except BzrError, e:
663
bzrlib.trace.log_exception()
873
log_error('bzr: error: ' + e.args[0] + '\n')
874
if len(e.args) > 1:
875
for h in e.args[1]:
876
log_error(' ' + h + '\n')
664
877
return 1
665
except AssertionError, e:
666
bzrlib.trace.log_exception('assertion failed: ' + str(e))
667
return 3
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
670
return 2
671
878
except Exception, e:
672
import errno
673
if (isinstance(e, IOError)
674
and hasattr(e, 'errno')
675
and e.errno == errno.EPIPE):
676
bzrlib.trace.note('broken pipe')
677
return 2
678
else:
679
bzrlib.trace.log_exception()
680
return 2
879
log_error('bzr: exception: %s\n' % e)
880
log_error(' see .bzr.log for details\n')
881
traceback.print_exc(None, bzrlib.trace._tracefile)
882
traceback.print_exc(None, sys.stderr)
883
return 1
884
885
# TODO: Maybe nicer handling of IOError?
886
681
887
682
888
683
889
if __name__ == '__main__':
684
890
sys.exit(main(sys.argv))
891
##import profile
892
##profile.run('main(sys.argv)')
893
Loggerhead is a web-based interface for Breezy
Version: 2.0.1