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