« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1298
- compare with another revision
- download diff
- download tarball
- view history from revision 1298
- Committer: Martin Pool
- Date: 2005-09-16 09:14:54 UTC
- Revision ID: mbp@sourcefrog.net-20050916091454-092fc433a3d9cc31
- cosmetic
- files added:
- .rsyncexclude
- 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 removed:
- bzrlib/tests.py
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
#! /usr/bin/python
2
3
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
6
1
# Copyright (C) 2004, 2005 by Canonical Ltd
7
2
8
3
# This program is free software; you can redistribute it and/or modify
9
4
# it under the terms of the GNU General Public License as published by
19
14
# along with this program; if not, write to the Free Software
20
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
16
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
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
84
33
85
34
import bzrlib
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
122
123
def cmd_status(all=False):
124
"""Display status summary.
125
126
For each file there is a single line giving its file state and name.
127
The name is that in the current revision unless it is deleted or
128
missing, in which case the old name is shown.
129
130
:todo: Don't show unchanged files unless ``--all`` is given?
131
"""
132
Branch('.').show_status(show_all=all)
133
134
135
136
######################################################################
137
# examining history
138
def cmd_get_revision(revision_id):
139
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
141
142
def cmd_get_file_text(text_id):
143
"""Get contents of a file by hash."""
144
sf = Branch('.').text_store[text_id]
145
pumpfile(sf, sys.stdout)
146
147
148
149
######################################################################
150
# commands
151
152
153
def cmd_revno():
154
"""Show number of revisions on this branch"""
155
print Branch('.').revno()
156
157
158
def cmd_add(file_list, verbose=False):
159
"""Add specified files.
160
161
Fails if the files are already added.
162
"""
163
Branch('.').add(file_list, verbose=verbose)
164
165
166
def cmd_inventory(revision=None):
167
"""Show inventory of the current working copy."""
168
## TODO: Also optionally show a previous inventory
169
## TODO: Format options
170
b = Branch('.')
171
if revision == None:
172
inv = b.read_working_inventory()
173
else:
174
inv = b.get_revision_inventory(b.lookup_revision(revision))
175
176
for path, entry in inv.iter_entries():
177
print '%-50s %s' % (entry.file_id, path)
178
179
180
181
def cmd_info():
182
b = Branch('.')
183
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
184
185
def plural(n, base='', pl=None):
186
if n == 1:
187
return base
188
elif pl is not None:
189
return pl
190
else:
191
return 's'
192
193
count_version_dirs = 0
194
195
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
196
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
197
fs = st_tup[0]
198
count_status[fs] += 1
199
if fs not in ['I', '?'] and st_tup[4] == 'directory':
200
count_version_dirs += 1
201
202
print
203
print 'in the working tree:'
204
for name, fs in (('unchanged', '.'),
205
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
206
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
207
):
208
print ' %5d %s' % (count_status[fs], name)
209
print ' %5d versioned subdirector%s' % (count_version_dirs,
210
plural(count_version_dirs, 'y', 'ies'))
211
212
print
213
print 'branch history:'
214
history = b.revision_history()
215
revno = len(history)
216
print ' %5d revision%s' % (revno, plural(revno))
217
committers = Set()
218
for rev in history:
219
committers.add(b.get_revision(rev).committer)
220
print ' %5d committer%s' % (len(committers), plural(len(committers)))
221
if revno > 0:
222
firstrev = b.get_revision(history[0])
223
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
224
print ' %5d day%s old' % (age, plural(age))
225
print ' first revision: %s' % format_date(firstrev.timestamp,
226
firstrev.timezone)
227
228
lastrev = b.get_revision(history[-1])
229
print ' latest revision: %s' % format_date(lastrev.timestamp,
230
lastrev.timezone)
231
232
233
234
235
def cmd_remove(file_list, verbose=False):
236
Branch('.').remove(file_list, verbose=verbose)
237
238
239
240
def cmd_file_id(filename):
241
i = Branch('.').read_working_inventory().path2id(filename)
242
if i is None:
243
bailout("%s is not a versioned file" % filename)
244
else:
245
print i
246
247
248
def cmd_find_filename(fileid):
249
n = find_filename(fileid)
250
if n is None:
251
bailout("%s is not a live file id" % fileid)
252
else:
253
print n
254
255
256
def cmd_revision_history():
257
for patchid in Branch('.').revision_history():
258
print patchid
259
260
261
262
def cmd_init():
263
# TODO: Check we're not already in a working directory? At the
264
# moment you'll get an ugly error.
265
266
# TODO: What if we're in a subdirectory of a branch? Would like
267
# to allow that, but then the parent may need to understand that
268
# the children have disappeared, or should they be versioned in
269
# both?
270
271
# TODO: Take an argument/option for branch name.
272
Branch('.', init=True)
273
274
275
def cmd_diff(revision=None):
276
"""Show diff from basis to working copy.
277
278
:todo: Take one or two revision arguments, look up those trees,
279
and diff them.
280
281
:todo: Allow diff across branches.
282
283
:todo: Mangle filenames in diff to be more relevant.
284
285
:todo: Shouldn't be in the cmd function.
286
"""
287
288
b = Branch('.')
289
290
if revision == None:
291
old_tree = b.basis_tree()
292
else:
293
old_tree = b.revision_tree(b.lookup_revision(revision))
294
295
new_tree = b.working_tree()
296
old_inv = old_tree.inventory
297
new_inv = new_tree.inventory
298
299
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
300
old_label = ''
301
new_label = ''
302
303
DEVNULL = '/dev/null'
304
# Windows users, don't panic about this filename -- it is a
305
# special signal to GNU patch that the file should be created or
306
# deleted respectively.
307
308
# TODO: Generation of pseudo-diffs for added/deleted files could
309
# be usefully made into a much faster special case.
310
311
# TODO: Better to return them in sorted order I think.
312
313
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
314
d = None
315
316
# Don't show this by default; maybe do it if an option is passed
317
# idlabel = ' {%s}' % fid
318
idlabel = ''
319
320
# FIXME: Something about the diff format makes patch unhappy
321
# with newly-added files.
322
323
def diffit(*a, **kw):
324
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
325
print
326
327
if file_state in ['.', '?', 'I']:
328
continue
329
elif file_state == 'A':
330
print '*** added %s %r' % (kind, new_name)
331
if kind == 'file':
332
diffit([],
333
new_tree.get_file(fid).readlines(),
334
fromfile=DEVNULL,
335
tofile=new_label + new_name + idlabel)
336
elif file_state == 'D':
337
assert isinstance(old_name, types.StringTypes)
338
print '*** deleted %s %r' % (kind, old_name)
339
if kind == 'file':
340
diffit(old_tree.get_file(fid).readlines(), [],
341
fromfile=old_label + old_name + idlabel,
342
tofile=DEVNULL)
343
elif file_state in ['M', 'R']:
344
if file_state == 'M':
345
assert kind == 'file'
346
assert old_name == new_name
347
print '*** modified %s %r' % (kind, new_name)
348
elif file_state == 'R':
349
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
350
351
if kind == 'file':
352
diffit(old_tree.get_file(fid).readlines(),
353
new_tree.get_file(fid).readlines(),
354
fromfile=old_label + old_name + idlabel,
355
tofile=new_label + new_name)
356
else:
357
bailout("can't represent state %s {%s}" % (file_state, fid))
358
359
360
361
def cmd_log(timezone='original'):
362
"""Show log of this branch.
363
364
:todo: Options for utc; to show ids; to limit range; etc.
365
"""
366
Branch('.').write_log(show_timezone=timezone)
367
368
369
def cmd_ls(revision=None, verbose=False):
370
"""List files in a tree.
371
372
:todo: Take a revision or remote path and list that tree instead.
373
"""
374
b = Branch('.')
375
if revision == None:
376
tree = b.working_tree()
377
else:
378
tree = b.revision_tree(b.lookup_revision(revision))
379
380
for fp, fc, kind, fid in tree.list_files():
381
if verbose:
382
if kind == 'directory':
383
kindch = '/'
384
elif kind == 'file':
385
kindch = ''
386
else:
387
kindch = '???'
388
389
print '%-8s %s%s' % (fc, fp, kindch)
390
else:
391
print fp
392
393
394
395
def cmd_unknowns():
396
"""List unknown files"""
397
for f in Branch('.').unknowns():
398
print quotefn(f)
399
400
401
def cmd_lookup_revision(revno):
402
try:
403
revno = int(revno)
404
except ValueError:
405
bailout("usage: lookup-revision REVNO",
406
["REVNO is a non-negative revision number for this branch"])
407
408
print Branch('.').lookup_revision(revno) or NONE_STRING
409
410
411
412
def cmd_export(revno, dest):
413
"""Export past revision to destination directory."""
414
b = Branch('.')
415
rh = b.lookup_revision(int(revno))
416
t = b.revision_tree(rh)
417
t.export(dest)
418
419
420
421
######################################################################
422
# internal/test commands
423
424
425
def cmd_uuid():
426
"""Print a newly-generated UUID."""
427
print uuid()
428
429
430
431
def cmd_local_time_offset():
432
print bzrlib.osutils.local_time_offset()
433
434
435
436
def cmd_commit(message, verbose=False):
437
Branch('.').commit(message, verbose=verbose)
438
439
440
def cmd_check():
441
"""Check consistency of the branch."""
442
check()
443
444
445
def cmd_is(pred, *rest):
446
"""Test whether PREDICATE is true."""
447
try:
448
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
449
except KeyError:
450
bailout("unknown predicate: %s" % quotefn(pred))
451
452
try:
453
cmd_handler(*rest)
454
except BzrCheckError:
455
# by default we don't print the message so that this can
456
# be used from shell scripts without producing noise
457
sys.exit(1)
458
459
460
def cmd_username():
461
print bzrlib.osutils.username()
462
463
464
def cmd_user_email():
465
print bzrlib.osutils.user_email()
466
467
468
def cmd_gen_revision_id():
469
import time
470
print bzrlib.branch._gen_revision_id(time.time())
471
472
473
def cmd_doctest():
474
"""Run internal doctest suite"""
475
## -v, if present, is seen by doctest; the argument is just here
476
## so our parser doesn't complain
477
478
## TODO: --verbose option
479
480
import bzr, doctest, bzrlib.store
481
bzrlib.trace.verbose = False
482
doctest.testmod(bzr)
483
doctest.testmod(bzrlib.store)
484
doctest.testmod(bzrlib.inventory)
485
doctest.testmod(bzrlib.branch)
486
doctest.testmod(bzrlib.osutils)
487
doctest.testmod(bzrlib.tree)
488
489
# more strenuous tests;
490
import bzrlib.tests
491
doctest.testmod(bzrlib.tests)
492
493
494
######################################################################
495
# help
496
497
498
def cmd_help():
499
# TODO: Specific help for particular commands
500
print __doc__
501
502
503
def cmd_version():
504
print "bzr (bazaar-ng) %s" % __version__
505
print __copyright__
506
print "http://bazaar-ng.org/"
507
print
508
print \
509
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
510
you may use, modify and redistribute it under the terms of the GNU
511
General Public License version 2 or later."""
512
513
514
def cmd_rocks():
515
"""Statement of optimism."""
516
print "it sure does!"
517
518
519
520
######################################################################
521
# main routine
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
522
345
523
346
524
347
# list of all available options; the rhs can be either None for an
526
349
# the type.
527
350
OPTIONS = {
528
351
'all': None,
352
'diff-options': str,
529
353
'help': None,
354
'file': unicode,
355
'force': None,
356
'format': unicode,
357
'forward': None,
530
358
'message': unicode,
531
'revision': int,
359
'no-recurse': None,
360
'profile': None,
361
'revision': _parse_revision_str,
362
'short': None,
532
363
'show-ids': None,
533
364
'timezone': str,
534
365
'verbose': None,
535
366
'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,
536
375
}
537
376
538
377
SHORT_OPTIONS = {
378
'F': 'file',
379
'h': 'help',
539
380
'm': 'message',
540
381
'r': 'revision',
541
382
'v': 'verbose',
383
'l': 'long',
542
384
}
543
385
544
# List of options that apply to particular commands; commands not
545
# listed take none.
546
cmd_options = {
547
'add': ['verbose'],
548
'commit': ['message', 'verbose'],
549
'diff': ['revision'],
550
'inventory': ['revision'],
551
'log': ['show-ids', 'timezone'],
552
'ls': ['revision', 'verbose'],
553
'remove': ['verbose'],
554
'status': ['all'],
555
}
556
557
558
cmd_args = {
559
'init': [],
560
'add': ['file+'],
561
'commit': [],
562
'diff': [],
563
'file-id': ['filename'],
564
'get-file-text': ['text_id'],
565
'get-inventory': ['inventory_id'],
566
'get-revision': ['revision_id'],
567
'get-revision-inventory': ['revision_id'],
568
'log': [],
569
'lookup-revision': ['revno'],
570
'export': ['revno', 'dest'],
571
'remove': ['file+'],
572
'status': [],
573
}
574
575
386
576
387
def parse_args(argv):
577
388
"""Parse command line.
583
394
584
395
>>> parse_args('--help'.split())
585
396
([], {'help': True})
397
>>> parse_args('help -- --invalidcmd'.split())
398
(['help', '--invalidcmd'], {})
586
399
>>> parse_args('--version'.split())
587
400
([], {'version': True})
588
401
>>> parse_args('status --all'.split())
589
402
(['status'], {'all': True})
590
403
>>> parse_args('commit --message=biter'.split())
591
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]})
592
413
"""
593
414
args = []
594
415
opts = {}
595
416
596
# TODO: Maybe handle '--' to end options?
597
417
argsover = False
598
418
while argv:
599
419
a = argv.pop(0)
600
if a[0] == '-':
420
if not argsover and a[0] == '-':
421
# option names must not be unicode
422
a = str(a)
601
423
optarg = None
602
424
if a[1] == '-':
425
if a == '--':
426
# We've received a standalone -- No more flags
427
argsover = True
428
continue
603
429
mutter(" got option %r" % a)
604
430
if '=' in a:
605
431
optname, optarg = a[2:].split('=', 1)
606
432
else:
607
433
optname = a[2:]
608
434
if optname not in OPTIONS:
609
bailout('unknown long option %r' % a)
435
raise BzrError('unknown long option %r' % a)
610
436
else:
611
437
shortopt = a[1:]
612
if shortopt not in SHORT_OPTIONS:
613
bailout('unknown short option %r' % a)
614
optname = SHORT_OPTIONS[shortopt]
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:]
615
466
616
467
if optname in opts:
617
468
# XXX: Do we ever want to support this, e.g. for -r?
618
bailout('repeated option %r' % a)
469
raise BzrError('repeated option %r' % a)
619
470
620
471
optargfn = OPTIONS[optname]
621
472
if optargfn:
622
473
if optarg == None:
623
474
if not argv:
624
bailout('option %r needs an argument' % a)
475
raise BzrError('option %r needs an argument' % a)
625
476
else:
626
477
optarg = argv.pop(0)
627
478
opts[optname] = optargfn(optarg)
628
mutter(" option argument %r" % opts[optname])
629
479
else:
630
480
if optarg != None:
631
bailout('option %r takes no argument' % optname)
481
raise BzrError('option %r takes no argument' % optname)
632
482
opts[optname] = True
633
483
else:
634
484
args.append(a)
637
487
638
488
639
489
640
def _match_args(cmd, args):
641
"""Check non-option arguments match required pattern.
642
490
643
>>> _match_args('status', ['asdasdsadasd'])
644
Traceback (most recent call last):
645
...
646
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
647
>>> _match_args('add', ['asdasdsadasd'])
648
{'file_list': ['asdasdsadasd']}
649
>>> _match_args('add', 'abc def gj'.split())
650
{'file_list': ['abc', 'def', 'gj']}
651
"""
652
# match argument pattern
653
argform = cmd_args.get(cmd, [])
491
def _match_argform(cmd, takes_args, args):
654
492
argdict = {}
655
# TODO: Need a way to express 'cp SRC... DEST', where it matches
656
# all but one.
657
493
658
for ap in argform:
494
# step through args and takes_args, allowing appropriate 0-many matches
495
for ap in takes_args:
659
496
argname = ap[:-1]
660
497
if ap[-1] == '?':
661
assert 0
662
elif ap[-1] == '*':
663
assert 0
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
664
506
elif ap[-1] == '+':
665
507
if not args:
666
bailout("command %r needs one or more %s"
508
raise BzrCommandError("command %r needs one or more %s"
667
509
% (cmd, argname.upper()))
668
510
else:
669
511
argdict[argname + '_list'] = args[:]
670
512
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] = []
671
519
else:
672
520
# just a plain arg
673
521
argname = ap
674
522
if not args:
675
bailout("command %r requires argument %s"
523
raise BzrCommandError("command %r requires argument %s"
676
524
% (cmd, argname.upper()))
677
525
else:
678
526
argdict[argname] = args.pop(0)
679
527
680
528
if args:
681
bailout("extra arguments to command %s: %r"
682
% (cmd, args))
529
raise BzrCommandError("extra argument to command %s: %s"
530
% (cmd, args[0]))
683
531
684
532
return argdict
685
533
686
534
687
535
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
688
561
def run_bzr(argv):
689
562
"""Execute a command.
690
563
691
564
This is similar to main(), but without all the trappings for
692
logging and error handling.
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.
693
584
"""
694
try:
695
args, opts = parse_args(argv[1:])
696
if 'help' in opts:
697
# TODO: pass down other arguments in case they asked for
698
# help on a command name?
699
cmd_help()
700
return 0
701
elif 'version' in opts:
702
cmd_version()
703
return 0
704
cmd = args.pop(0)
705
except IndexError:
706
log_error('usage: bzr COMMAND\n')
707
log_error(' try "bzr help"\n')
708
return 1
709
710
try:
711
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
712
except KeyError:
713
bailout("unknown command " + `cmd`)
714
715
# TODO: special --profile option to turn on the Python profiler
716
717
# check options are reasonable
718
allowed = cmd_options.get(cmd, [])
719
for oname in opts:
720
if oname not in allowed:
721
bailout("option %r is not allowed for command %r"
722
% (oname, cmd))
723
724
cmdargs = _match_args(cmd, args)
725
cmdargs.update(opts)
726
727
ret = cmd_handler(**cmdargs) or 0
728
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
729
631
730
632
731
633
def main(argv):
732
## TODO: Handle command-line options; probably know what options are valid for
733
## each command
734
735
## TODO: If the arguments are wrong, give a usage message rather
736
## than just a backtrace.
634
import bzrlib.ui
635
bzrlib.trace.log_startup(argv)
636
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
737
637
738
638
try:
739
# TODO: Lift into separate function in trace.py
740
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
741
# Perhaps that should eventually go into the platform library?
742
# TODO: If the file doesn't exist, add a note describing it.
743
t = bzrlib.trace._tracefile
744
t.write('-' * 60 + '\n')
745
t.write('bzr invoked at %s\n' % format_date(time.time()))
746
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
747
t.write(' arguments: %r\n' % argv)
748
749
starttime = os.times()[4]
750
751
import platform
752
t.write(' platform: %s\n' % platform.platform())
753
t.write(' python: %s\n' % platform.python_version())
754
755
ret = run_bzr(argv)
756
757
times = os.times()
758
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
759
% times[:4])
760
mutter(" %.3f elapsed" % (times[4] - starttime))
761
762
return ret
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
763
648
except BzrError, e:
764
log_error('bzr: error: ' + e.args[0] + '\n')
765
if len(e.args) > 1:
766
for h in e.args[1]:
767
log_error(' ' + h + '\n')
649
bzrlib.trace.log_exception()
768
650
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
769
657
except Exception, e:
770
log_error('bzr: exception: %s\n' % e)
771
log_error(' see .bzr.log for details\n')
772
traceback.print_exc(None, bzrlib.trace._tracefile)
773
traceback.print_exc(None, sys.stderr)
774
return 1
775
776
# TODO: Maybe nicer handling of IOError?
777
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
778
667
779
668
780
669
if __name__ == '__main__':
781
670
sys.exit(main(sys.argv))
782
##import profile
783
##profile.run('main(sys.argv)')
784
Loggerhead is a web-based interface for Breezy
Version: 2.0.1