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