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