« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1173
- compare with another revision
- download diff
- download tarball
- view history from revision 1173
- Committer: Martin Pool
- Date: 2005-09-02 01:56:05 UTC
- Revision ID: mbp@sourcefrog.net-20050902015604-3e3003f71665950b
- message typo
- files added:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- patches
- tools
- files removed:
- bzrlib/tests.py
- files renamed:
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- contrib/bash/bzr => contrib/bash/bzr.simple
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
"""Bazaar-NG -- a free distributed version-control tool
18
http://bazaar-ng.org/
19
20
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
21
22
* Metadata format is not stable yet -- you may need to
23
discard history in the future.
24
25
* Many commands unimplemented or partially implemented.
26
27
* Space-inefficient storage.
28
29
* No merge operators yet.
30
31
Interesting commands:
32
33
bzr help [COMMAND]
34
Show help screen
35
bzr version
36
Show software version/licence/non-warranty.
37
bzr init
38
Start versioning the current directory
39
bzr add FILE...
40
Make files versioned.
41
bzr log
42
Show revision history.
43
bzr rename FROM TO
44
Rename one file.
45
bzr move FROM... DESTDIR
46
Move one or more files to a different directory.
47
bzr diff [FILE...]
48
Show changes from last revision to working copy.
49
bzr commit -m 'MESSAGE'
50
Store current state as new revision.
51
bzr export [-r REVNO] DESTINATION
52
Export the branch state at a previous version.
53
bzr status
54
Show summary of pending changes.
55
bzr remove FILE...
56
Make a file not versioned.
57
bzr info
58
Show statistics about this branch.
59
bzr check
60
Verify history is stored safely.
61
(for more type 'bzr help commands')
62
"""
63
64
65
66
67
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
68
from sets import Set
69
from pprint import pprint
70
from stat import *
71
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
72
33
73
34
import bzrlib
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
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
CMD_ALIASES = {
92
'?': 'help',
93
'ci': 'commit',
94
'checkin': 'commit',
95
'di': 'diff',
96
'st': 'status',
97
'stat': 'status',
98
}
99
100
101
def get_cmd_class(cmd):
102
cmd = str(cmd)
103
104
cmd = CMD_ALIASES.get(cmd, cmd)
105
106
try:
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
108
except KeyError:
109
raise BzrError("unknown command %r" % cmd)
110
111
return cmd, cmd_class
112
113
114
115
class Command:
35
import bzrlib.trace
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
40
41
plugin_cmds = {}
42
43
44
def register_command(cmd):
45
"Utility function to help register a command"
46
global plugin_cmds
47
k = cmd.__name__
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
50
else:
51
k_unsquished = k
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
55
else:
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
58
59
60
def _squish_command_name(cmd):
61
return 'cmd_' + cmd.replace('-', '_')
62
63
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
66
return cmd[4:].replace('_','-')
67
68
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
71
72
This always returns a list. The list will have one element for
73
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
76
77
>>> _parse_revision_str('234')
78
[234]
79
>>> _parse_revision_str('234..567')
80
[234, 567]
81
>>> _parse_revision_str('..')
82
[None, None]
83
>>> _parse_revision_str('..234')
84
[None, 234]
85
>>> _parse_revision_str('234..')
86
[234, None]
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
88
[234, 456, 789]
89
>>> _parse_revision_str('234....789') # Error?
90
[234, None, 789]
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
98
['date:2005-04-12']
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
106
[-5, 23]
107
>>> _parse_revision_str('-5')
108
[-5]
109
>>> _parse_revision_str('123a')
110
['123a']
111
>>> _parse_revision_str('abc')
112
['abc']
113
"""
114
import re
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
117
if m:
118
warning('Colon separator for revision numbers is deprecated.'
119
' Use .. instead')
120
revs = []
121
for rev in revstr.split(':'):
122
if rev:
123
revs.append(int(rev))
124
else:
125
revs.append(None)
126
return revs
127
revs = []
128
for x in revstr.split('..'):
129
if not x:
130
revs.append(None)
131
else:
132
try:
133
revs.append(int(x))
134
except ValueError:
135
revs.append(x)
136
return revs
137
138
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
142
try:
143
return merge_types[typestring][0]
144
except KeyError:
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
151
152
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
156
try:
157
return merge_types[typestring][0]
158
except KeyError:
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
165
166
167
def _builtin_commands():
168
import bzrlib.builtins
169
r = {}
170
builtins = bzrlib.builtins.__dict__
171
for name in builtins:
172
if name.startswith("cmd_"):
173
real_name = _unsquish_command_name(name)
174
r[real_name] = builtins[name]
175
return r
176
177
178
179
def builtin_command_names():
180
"""Return list of builtin command names."""
181
return _builtin_commands().keys()
182
183
184
def plugin_command_names():
185
return plugin_cmds.keys()
186
187
188
def _get_cmd_dict(plugins_override=True):
189
"""Return name->class mapping for all commands."""
190
d = _builtin_commands()
191
if plugins_override:
192
d.update(plugin_cmds)
193
return d
194
195
196
def get_all_cmds(plugins_override=True):
197
"""Return canonical name and class for all registered commands."""
198
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
199
yield k,v
200
201
202
def get_cmd_object(cmd_name, plugins_override=True):
203
"""Return the canonical name and command class for a command.
204
205
plugins_override
206
If true, plugin commands can override builtins.
207
"""
208
from bzrlib.externalcommand import ExternalCommand
209
210
cmd_name = str(cmd_name) # not unicode
211
212
# first look up this command under the specified name
213
cmds = _get_cmd_dict(plugins_override=plugins_override)
214
try:
215
return cmds[cmd_name]()
216
except KeyError:
217
pass
218
219
# look for any command which claims this as an alias
220
for real_cmd_name, cmd_class in cmds.iteritems():
221
if cmd_name in cmd_class.aliases:
222
return cmd_class()
223
224
cmd_obj = ExternalCommand.find_command(cmd_name)
225
if cmd_obj:
226
return cmd_obj
227
228
raise BzrCommandError("unknown command %r" % cmd_name)
229
230
231
class Command(object):
116
232
"""Base class for commands.
117
233
234
Commands are the heart of the command-line bzr interface.
235
236
The command object mostly handles the mapping of command-line
237
parameters into one or more bzrlib operations, and of the results
238
into textual output.
239
240
Commands normally don't have any state. All their arguments are
241
passed in to the run method. (Subclasses may take a different
242
policy if the behaviour of the instance needs to depend on e.g. a
243
shell plugin and not just its Python class.)
244
118
245
The docstring for an actual command should give a single-line
119
246
summary, then a complete description of the command. A grammar
120
247
description will be inserted.
121
248
249
aliases
250
Other accepted names for this command.
251
122
252
takes_args
123
253
List of argument forms, marked with whether they are optional,
124
254
repeated, etc.
127
257
List of options that may be given for this command.
128
258
129
259
hidden
130
If true, this command isn't advertised.
260
If true, this command isn't advertised. This is typically
261
for commands intended for expert users.
131
262
"""
132
263
aliases = []
133
264
136
267
137
268
hidden = False
138
269
139
def __init__(self, options, arguments):
140
"""Construct and run the command.
141
142
Sets self.status to the return value of run()."""
143
assert isinstance(options, dict)
144
assert isinstance(arguments, dict)
145
cmdargs = options.copy()
146
cmdargs.update(arguments)
147
assert self.__doc__ != Command.__doc__, \
148
("No help message set for %r" % self)
149
self.status = self.run(**cmdargs)
270
def __init__(self):
271
"""Construct an instance of this command."""
272
if self.__doc__ == Command.__doc__:
273
warn("No help message set for %r" % self)
274
275
276
def run_argv(self, argv):
277
"""Parse command line and run."""
278
args, opts = parse_args(argv)
279
280
if 'help' in opts: # e.g. bzr add --help
281
from bzrlib.help import help_on_command
282
help_on_command(self.name())
283
return 0
284
285
# check options are reasonable
286
allowed = self.takes_options
287
for oname in opts:
288
if oname not in allowed:
289
raise BzrCommandError("option '--%s' is not allowed for command %r"
290
% (oname, self.name()))
291
292
# mix arguments and options into one dictionary
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
294
cmdopts = {}
295
for k, v in opts.items():
296
cmdopts[k.replace('-', '_')] = v
297
298
all_cmd_args = cmdargs.copy()
299
all_cmd_args.update(cmdopts)
300
301
return self.run(**all_cmd_args)
150
302
151
303
152
304
def run(self):
153
"""Override this in sub-classes.
305
"""Actually run the command.
154
306
155
307
This is invoked with the options and arguments bound to
156
308
keyword parameters.
157
309
158
Return True if the command was successful, False if not.
159
"""
160
return True
161
162
163
164
class cmd_status(Command):
165
"""Display status summary.
166
167
For each file there is a single line giving its file state and name.
168
The name is that in the current revision unless it is deleted or
169
missing, in which case the old name is shown.
170
"""
171
takes_options = ['all']
172
173
def run(self, all=False):
174
#import bzrlib.status
175
#bzrlib.status.tree_status(Branch('.'))
176
Branch('.').show_status(show_all=all)
177
178
179
class cmd_cat_revision(Command):
180
"""Write out metadata for a revision."""
181
182
hidden = True
183
takes_args = ['revision_id']
184
185
def run(self, revision_id):
186
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
187
188
189
class cmd_revno(Command):
190
"""Show current revision number.
191
192
This is equal to the number of revisions on this branch."""
193
def run(self):
194
print Branch('.').revno()
195
196
197
class cmd_add(Command):
198
"""Add specified files or directories.
199
200
In non-recursive mode, all the named items are added, regardless
201
of whether they were previously ignored. A warning is given if
202
any of the named files are already versioned.
203
204
In recursive mode (the default), files are treated the same way
205
but the behaviour for directories is different. Directories that
206
are already versioned do not give a warning. All directories,
207
whether already versioned or not, are searched for files or
208
subdirectories that are neither versioned or ignored, and these
209
are added. This search proceeds recursively into versioned
210
directories.
211
212
Therefore simply saying 'bzr add .' will version all files that
213
are currently unknown.
214
215
TODO: Perhaps adding a file whose directly is not versioned should
216
recursively add that parent, rather than giving an error?
217
"""
218
takes_args = ['file+']
219
takes_options = ['verbose']
220
221
def run(self, file_list, verbose=False):
222
bzrlib.add.smart_add(file_list, verbose)
223
224
225
def Relpath(Command):
226
"""Show path of a file relative to root"""
227
takes_args = ('filename')
228
229
def run(self):
230
print Branch(self.args['filename']).relpath(filename)
231
232
233
234
class cmd_inventory(Command):
235
"""Show inventory of the current working copy or a revision."""
236
takes_options = ['revision']
237
238
def run(self, revision=None):
239
b = Branch('.')
240
if revision == None:
241
inv = b.read_working_inventory()
242
else:
243
inv = b.get_revision_inventory(b.lookup_revision(revision))
244
245
for path, entry in inv.iter_entries():
246
print '%-50s %s' % (entry.file_id, path)
247
248
249
class cmd_move(Command):
250
"""Move files to a different directory.
251
252
examples:
253
bzr move *.txt doc
254
255
The destination must be a versioned directory in the same branch.
256
"""
257
takes_args = ['source$', 'dest']
258
def run(self, source_list, dest):
259
b = Branch('.')
260
261
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
262
263
264
class cmd_rename(Command):
265
"""Change the name of an entry.
266
267
examples:
268
bzr rename frob.c frobber.c
269
bzr rename src/frob.c lib/frob.c
270
271
It is an error if the destination name exists.
272
273
See also the 'move' command, which moves files into a different
274
directory without changing their name.
275
276
TODO: Some way to rename multiple files without invoking bzr for each
277
one?"""
278
takes_args = ['from_name', 'to_name']
279
280
def run(self, from_name, to_name):
281
b = Branch('.')
282
b.rename_one(b.relpath(from_name), b.relpath(to_name))
283
284
285
286
class cmd_renames(Command):
287
"""Show list of renamed files.
288
289
TODO: Option to show renames between two historical versions.
290
291
TODO: Only show renames under dir, rather than in the whole branch.
292
"""
293
takes_args = ['dir?']
294
295
def run(self, dir='.'):
296
b = Branch(dir)
297
old_inv = b.basis_tree().inventory
298
new_inv = b.read_working_inventory()
299
300
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
301
renames.sort()
302
for old_name, new_name in renames:
303
print "%s => %s" % (old_name, new_name)
304
305
306
class cmd_info(Command):
307
"""Show statistical information for this branch"""
308
def run(self):
309
import info
310
info.show_info(Branch('.'))
311
312
313
class cmd_remove(Command):
314
"""Make a file unversioned.
315
316
This makes bzr stop tracking changes to a versioned file. It does
317
not delete the working copy.
318
"""
319
takes_args = ['file+']
320
takes_options = ['verbose']
321
322
def run(self, file_list, verbose=False):
323
b = Branch(file_list[0])
324
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
325
326
327
class cmd_file_id(Command):
328
"""Print file_id of a particular file or directory.
329
330
The file_id is assigned when the file is first added and remains the
331
same through all revisions where the file exists, even when it is
332
moved or renamed.
333
"""
334
hidden = True
335
takes_args = ['filename']
336
def run(self, filename):
337
b = Branch(filename)
338
i = b.inventory.path2id(b.relpath(filename))
339
if i == None:
340
bailout("%r is not a versioned file" % filename)
341
else:
342
print i
343
344
345
class cmd_file_path(Command):
346
"""Print path of file_ids to a file or directory.
347
348
This prints one line for each directory down to the target,
349
starting at the branch root."""
350
hidden = True
351
takes_args = ['filename']
352
def run(self, filename):
353
b = Branch(filename)
354
inv = b.inventory
355
fid = inv.path2id(b.relpath(filename))
356
if fid == None:
357
bailout("%r is not a versioned file" % filename)
358
for fip in inv.get_idpath(fid):
359
print fip
360
361
362
class cmd_revision_history(Command):
363
"""Display list of revision ids on this branch."""
364
def run(self):
365
for patchid in Branch('.').revision_history():
366
print patchid
367
368
369
class cmd_directories(Command):
370
"""Display list of versioned directories in this branch."""
371
def run(self):
372
for name, ie in Branch('.').read_working_inventory().directories():
373
if name == '':
374
print '.'
375
else:
376
print name
377
378
379
class cmd_init(Command):
380
"""Make a directory into a versioned branch.
381
382
Use this to create an empty branch, or before importing an
383
existing project.
384
385
Recipe for importing a tree of files:
386
cd ~/project
387
bzr init
388
bzr add -v .
389
bzr status
390
bzr commit -m 'imported project'
391
"""
392
def run(self):
393
Branch('.', init=True)
394
395
396
class cmd_diff(Command):
397
"""Show differences in working tree.
398
399
If files are listed, only the changes in those files are listed.
400
Otherwise, all changes for the tree are listed.
401
402
TODO: Given two revision arguments, show the difference between them.
403
404
TODO: Allow diff across branches.
405
406
TODO: Option to use external diff command; could be GNU diff, wdiff,
407
or a graphical diff.
408
409
TODO: Python difflib is not exactly the same as unidiff; should
410
either fix it up or prefer to use an external diff.
411
412
TODO: If a directory is given, diff everything under that.
413
414
TODO: Selected-file diff is inefficient and doesn't show you
415
deleted files.
416
417
TODO: This probably handles non-Unix newlines poorly.
418
"""
419
420
takes_args = ['file*']
421
takes_options = ['revision']
422
423
def run(self, revision=None, file_list=None):
424
from bzrlib.diff import show_diff
425
426
show_diff(Branch('.'), revision, file_list)
427
428
429
class cmd_deleted(Command):
430
"""List files deleted in the working tree.
431
432
TODO: Show files deleted since a previous revision, or between two revisions.
433
"""
434
def run(self, show_ids=False):
435
b = Branch('.')
436
old = b.basis_tree()
437
new = b.working_tree()
438
439
## TODO: Much more efficient way to do this: read in new
440
## directories with readdir, rather than stating each one. Same
441
## level of effort but possibly much less IO. (Or possibly not,
442
## if the directories are very large...)
443
444
for path, ie in old.inventory.iter_entries():
445
if not new.has_id(ie.file_id):
446
if show_ids:
447
print '%-50s %s' % (path, ie.file_id)
448
else:
449
print path
450
451
class cmd_root(Command):
452
"""Show the tree root directory.
453
454
The root is the nearest enclosing directory with a .bzr control
455
directory."""
456
takes_args = ['filename?']
457
def run(self, filename=None):
458
"""Print the branch root."""
459
print bzrlib.branch.find_branch_root(filename)
460
461
462
463
class cmd_log(Command):
464
"""Show log of this branch.
465
466
TODO: Options to show ids; to limit range; etc.
467
"""
468
takes_options = ['timezone', 'verbose']
469
def run(self, timezone='original', verbose=False):
470
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
471
472
473
class cmd_ls(Command):
474
"""List files in a tree.
475
476
TODO: Take a revision or remote path and list that tree instead.
477
"""
478
hidden = True
479
def run(self, revision=None, verbose=False):
480
b = Branch('.')
481
if revision == None:
482
tree = b.working_tree()
483
else:
484
tree = b.revision_tree(b.lookup_revision(revision))
485
486
for fp, fc, kind, fid in tree.list_files():
487
if verbose:
488
if kind == 'directory':
489
kindch = '/'
490
elif kind == 'file':
491
kindch = ''
492
else:
493
kindch = '???'
494
495
print '%-8s %s%s' % (fc, fp, kindch)
496
else:
497
print fp
498
499
500
501
class cmd_unknowns(Command):
502
"""List unknown files"""
503
def run(self):
504
for f in Branch('.').unknowns():
505
print quotefn(f)
506
507
508
509
class cmd_ignore(Command):
510
"""Ignore a command or pattern"""
511
takes_args = ['name_pattern']
512
513
def run(self, name_pattern):
514
b = Branch('.')
515
516
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
517
f = open(b.abspath('.bzrignore'), 'at')
518
f.write(name_pattern + '\n')
519
f.close()
520
521
inv = b.working_tree().inventory
522
if inv.path2id('.bzrignore'):
523
mutter('.bzrignore is already versioned')
524
else:
525
mutter('need to make new .bzrignore file versioned')
526
b.add(['.bzrignore'])
527
528
529
530
class cmd_ignored(Command):
531
"""List ignored files and the patterns that matched them."""
532
def run(self):
533
tree = Branch('.').working_tree()
534
for path, file_class, kind, file_id in tree.list_files():
535
if file_class != 'I':
536
continue
537
## XXX: Slightly inefficient since this was already calculated
538
pat = tree.is_ignored(path)
539
print '%-50s %s' % (path, pat)
540
541
542
class cmd_lookup_revision(Command):
543
"""Lookup the revision-id from a revision-number
544
545
example:
546
bzr lookup-revision 33
547
"""
548
hidden = True
549
def run(self, revno):
550
try:
551
revno = int(revno)
552
except ValueError:
553
raise BzrError("not a valid revision-number: %r" % revno)
554
555
print Branch('.').lookup_revision(revno) or NONE_STRING
556
557
558
559
class cmd_export(Command):
560
"""Export past revision to destination directory.
561
562
If no revision is specified this exports the last committed revision."""
563
takes_args = ['dest']
564
takes_options = ['revision']
565
def run(self, dest, revno=None):
566
b = Branch('.')
567
if revno == None:
568
rh = b.revision_history[-1]
569
else:
570
rh = b.lookup_revision(int(revno))
571
t = b.revision_tree(rh)
572
t.export(dest)
573
574
575
class cmd_cat(Command):
576
"""Write a file's text from a previous revision."""
577
578
takes_options = ['revision']
579
takes_args = ['filename']
580
581
def run(self, filename, revision=None):
582
if revision == None:
583
raise BzrCommandError("bzr cat requires a revision number")
584
b = Branch('.')
585
b.print_file(b.relpath(filename), int(revision))
586
587
588
class cmd_local_time_offset(Command):
589
"""Show the offset in seconds from GMT to local time."""
590
hidden = True
591
def run(self):
592
print bzrlib.osutils.local_time_offset()
593
594
595
596
class cmd_commit(Command):
597
"""Commit changes into a new revision.
598
599
TODO: Commit only selected files.
600
601
TODO: Run hooks on tree to-be-committed, and after commit.
602
603
TODO: Strict commit that fails if there are unknown or deleted files.
604
"""
605
takes_options = ['message', 'verbose']
606
607
def run(self, message=None, verbose=False):
608
if not message:
609
raise BzrCommandError("please specify a commit message")
610
Branch('.').commit(message, verbose=verbose)
611
612
613
class cmd_check(Command):
614
"""Validate consistency of branch history.
615
616
This command checks various invariants about the branch storage to
617
detect data corruption or bzr bugs.
618
"""
619
takes_args = ['dir?']
620
def run(self, dir='.'):
621
import bzrlib.check
622
bzrlib.check.check(Branch(dir, find_root=False))
623
624
625
626
class cmd_whoami(Command):
627
"""Show bzr user id."""
628
takes_options = ['email']
629
630
def run(self, email=False):
631
if email:
632
print bzrlib.osutils.user_email()
633
else:
634
print bzrlib.osutils.username()
635
636
637
class cmd_selftest(Command):
638
"""Run internal test suite"""
639
hidden = True
640
def run(self):
641
failures, tests = 0, 0
642
643
import doctest, bzrlib.store, bzrlib.tests
644
bzrlib.trace.verbose = False
645
646
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
647
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
648
mf, mt = doctest.testmod(m)
649
failures += mf
650
tests += mt
651
print '%-40s %3d tests' % (m.__name__, mt),
652
if mf:
653
print '%3d FAILED!' % mf
654
else:
655
print
656
657
print '%-40s %3d tests' % ('total', tests),
658
if failures:
659
print '%3d FAILED!' % failures
660
else:
661
print
662
663
664
665
class cmd_version(Command):
666
"""Show version of bzr"""
667
def run(self):
668
show_version()
669
670
def show_version():
671
print "bzr (bazaar-ng) %s" % bzrlib.__version__
672
print bzrlib.__copyright__
673
print "http://bazaar-ng.org/"
674
print
675
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
676
print "you may use, modify and redistribute it under the terms of the GNU"
677
print "General Public License version 2 or later."
678
679
680
class cmd_rocks(Command):
681
"""Statement of optimism."""
682
hidden = True
683
def run(self):
684
print "it sure does!"
685
686
687
class cmd_assert_fail(Command):
688
"""Test reporting of assertion failures"""
689
hidden = True
690
def run(self):
691
assert False, "always fails"
692
693
694
class cmd_help(Command):
695
"""Show help on a command or other topic.
696
697
For a list of all available commands, say 'bzr help commands'."""
698
takes_args = ['topic?']
699
700
def run(self, topic=None):
701
help(topic)
702
703
704
def help(topic=None):
705
if topic == None:
706
print __doc__
707
elif topic == 'commands':
708
help_commands()
709
else:
710
help_on_command(topic)
711
712
713
def help_on_command(cmdname):
714
cmdname = str(cmdname)
715
716
from inspect import getdoc
717
topic, cmdclass = get_cmd_class(cmdname)
718
719
doc = getdoc(cmdclass)
720
if doc == None:
721
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
722
723
if '\n' in doc:
724
short, rest = doc.split('\n', 1)
725
else:
726
short = doc
727
rest = ''
728
729
print 'usage: bzr ' + topic,
730
for aname in cmdclass.takes_args:
731
aname = aname.upper()
732
if aname[-1] in ['$', '+']:
733
aname = aname[:-1] + '...'
734
elif aname[-1] == '?':
735
aname = '[' + aname[:-1] + ']'
736
elif aname[-1] == '*':
737
aname = '[' + aname[:-1] + '...]'
738
print aname,
739
print
740
print short
741
if rest:
742
print rest
743
744
if cmdclass.takes_options:
745
print
746
print 'options:'
747
for on in cmdclass.takes_options:
748
print ' --%s' % on
749
750
751
def help_commands():
752
"""List all commands"""
753
import inspect
754
755
accu = []
756
for k, v in globals().items():
757
if k.startswith('cmd_'):
758
accu.append((k[4:].replace('_','-'), v))
759
accu.sort()
760
for cmdname, cmdclass in accu:
761
if cmdclass.hidden:
762
continue
763
print cmdname
764
help = inspect.getdoc(cmdclass)
765
if help:
766
print " " + help.split('\n', 1)[0]
767
768
769
######################################################################
770
# main routine
310
Return 0 or None if the command was successful, or a non-zero
311
shell error code if not. It's OK for this method to allow
312
an exception to raise up.
313
"""
314
raise NotImplementedError()
315
316
317
def help(self):
318
"""Return help message for this class."""
319
if self.__doc__ is Command.__doc__:
320
return None
321
return getdoc(self)
322
323
def name(self):
324
return _unsquish_command_name(self.__class__.__name__)
325
326
327
def parse_spec(spec):
328
"""
329
>>> parse_spec(None)
330
[None, None]
331
>>> parse_spec("./")
332
['./', None]
333
>>> parse_spec("../@")
334
['..', -1]
335
>>> parse_spec("../f/@35")
336
['../f', 35]
337
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
338
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
339
"""
340
if spec is None:
341
return [None, None]
342
if '/@' in spec:
343
parsed = spec.split('/@')
344
assert len(parsed) == 2
345
if parsed[1] == "":
346
parsed[1] = -1
347
else:
348
try:
349
parsed[1] = int(parsed[1])
350
except ValueError:
351
pass # We can allow stuff like ./@revid:blahblahblah
352
else:
353
assert parsed[1] >=0
354
else:
355
parsed = [spec, None]
356
return parsed
357
358
771
359
772
360
773
361
# list of all available options; the rhs can be either None for an
775
363
# the type.
776
364
OPTIONS = {
777
365
'all': None,
366
'diff-options': str,
778
367
'help': None,
368
'file': unicode,
369
'force': None,
370
'format': unicode,
371
'forward': None,
779
372
'message': unicode,
373
'no-recurse': None,
780
374
'profile': None,
781
'revision': int,
375
'revision': _parse_revision_str,
376
'short': None,
782
377
'show-ids': None,
783
378
'timezone': str,
784
379
'verbose': None,
785
380
'version': None,
786
381
'email': None,
382
'unchanged': None,
383
'update': None,
384
'long': None,
385
'root': str,
386
'no-backup': None,
387
'merge-type': get_merge_type,
388
'pattern': str,
787
389
}
788
390
789
391
SHORT_OPTIONS = {
392
'F': 'file',
393
'h': 'help',
790
394
'm': 'message',
791
395
'r': 'revision',
792
396
'v': 'verbose',
397
'l': 'long',
793
398
}
794
399
795
400
803
408
804
409
>>> parse_args('--help'.split())
805
410
([], {'help': True})
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
806
413
>>> parse_args('--version'.split())
807
414
([], {'version': True})
808
415
>>> parse_args('status --all'.split())
809
416
(['status'], {'all': True})
810
417
>>> parse_args('commit --message=biter'.split())
811
418
(['commit'], {'message': u'biter'})
419
>>> parse_args('log -r 500'.split())
420
(['log'], {'revision': [500]})
421
>>> parse_args('log -r500..600'.split())
422
(['log'], {'revision': [500, 600]})
423
>>> parse_args('log -vr500..600'.split())
424
(['log'], {'verbose': True, 'revision': [500, 600]})
425
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
426
(['log'], {'revision': ['v500', 600]})
812
427
"""
813
428
args = []
814
429
opts = {}
815
430
816
# TODO: Maybe handle '--' to end options?
817
431
argsover = False
818
432
while argv:
819
433
a = argv.pop(0)
820
if a[0] == '-':
434
if not argsover and a[0] == '-':
821
435
# option names must not be unicode
822
436
a = str(a)
823
437
optarg = None
824
438
if a[1] == '-':
439
if a == '--':
440
# We've received a standalone -- No more flags
441
argsover = True
442
continue
825
443
mutter(" got option %r" % a)
826
444
if '=' in a:
827
445
optname, optarg = a[2:].split('=', 1)
828
446
else:
829
447
optname = a[2:]
830
448
if optname not in OPTIONS:
831
bailout('unknown long option %r' % a)
449
raise BzrError('unknown long option %r' % a)
832
450
else:
833
451
shortopt = a[1:]
834
if shortopt not in SHORT_OPTIONS:
835
bailout('unknown short option %r' % a)
836
optname = SHORT_OPTIONS[shortopt]
452
if shortopt in SHORT_OPTIONS:
453
# Multi-character options must have a space to delimit
454
# their value
455
optname = SHORT_OPTIONS[shortopt]
456
else:
457
# Single character short options, can be chained,
458
# and have their value appended to their name
459
shortopt = a[1:2]
460
if shortopt not in SHORT_OPTIONS:
461
# We didn't find the multi-character name, and we
462
# didn't find the single char name
463
raise BzrError('unknown short option %r' % a)
464
optname = SHORT_OPTIONS[shortopt]
465
466
if a[2:]:
467
# There are extra things on this option
468
# see if it is the value, or if it is another
469
# short option
470
optargfn = OPTIONS[optname]
471
if optargfn is None:
472
# This option does not take an argument, so the
473
# next entry is another short option, pack it back
474
# into the list
475
argv.insert(0, '-' + a[2:])
476
else:
477
# This option takes an argument, so pack it
478
# into the array
479
optarg = a[2:]
837
480
838
481
if optname in opts:
839
482
# XXX: Do we ever want to support this, e.g. for -r?
840
bailout('repeated option %r' % a)
483
raise BzrError('repeated option %r' % a)
841
484
842
485
optargfn = OPTIONS[optname]
843
486
if optargfn:
844
487
if optarg == None:
845
488
if not argv:
846
bailout('option %r needs an argument' % a)
489
raise BzrError('option %r needs an argument' % a)
847
490
else:
848
491
optarg = argv.pop(0)
849
492
opts[optname] = optargfn(optarg)
850
493
else:
851
494
if optarg != None:
852
bailout('option %r takes no argument' % optname)
495
raise BzrError('option %r takes no argument' % optname)
853
496
opts[optname] = True
854
497
else:
855
498
args.append(a)
904
547
905
548
906
549
550
def apply_profiled(the_callable, *args, **kwargs):
551
import hotshot
552
import tempfile
553
pffileno, pfname = tempfile.mkstemp()
554
try:
555
prof = hotshot.Profile(pfname)
556
try:
557
ret = prof.runcall(the_callable, *args, **kwargs) or 0
558
finally:
559
prof.close()
560
561
import hotshot.stats
562
stats = hotshot.stats.load(pfname)
563
#stats.strip_dirs()
564
stats.sort_stats('time')
565
## XXX: Might like to write to stderr or the trace file instead but
566
## print_stats seems hardcoded to stdout
567
stats.print_stats(20)
568
569
return ret
570
finally:
571
os.close(pffileno)
572
os.remove(pfname)
573
574
907
575
def run_bzr(argv):
908
576
"""Execute a command.
909
577
910
578
This is similar to main(), but without all the trappings for
911
579
logging and error handling.
580
581
argv
582
The command-line arguments, without the program name from argv[0]
583
584
Returns a command status or raises an exception.
585
586
Special master options: these must come before the command because
587
they control how the command is interpreted.
588
589
--no-plugins
590
Do not load plugin modules at all
591
592
--builtin
593
Only use builtin commands. (Plugins are still allowed to change
594
other behaviour.)
595
596
--profile
597
Run under the Python profiler.
912
598
"""
913
599
914
600
argv = [a.decode(bzrlib.user_encoding) for a in argv]
915
916
try:
917
args, opts = parse_args(argv[1:])
918
if 'help' in opts:
919
if args:
920
help(args[0])
921
else:
922
help()
923
return 0
924
elif 'version' in opts:
925
cmd_version([], [])
926
return 0
927
cmd = str(args.pop(0))
928
except IndexError:
929
log_error('usage: bzr COMMAND')
930
log_error(' try "bzr help"')
931
return 1
932
933
canonical_cmd, cmd_class = get_cmd_class(cmd)
934
935
# global option
936
if 'profile' in opts:
937
profile = True
938
del opts['profile']
939
else:
940
profile = False
941
942
# check options are reasonable
943
allowed = cmd_class.takes_options
944
for oname in opts:
945
if oname not in allowed:
946
raise BzrCommandError("option %r is not allowed for command %r"
947
% (oname, cmd))
948
949
# mix arguments and options into one dictionary
950
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
951
cmdopts = {}
952
for k, v in opts.items():
953
cmdopts[k.replace('-', '_')] = v
954
955
if profile:
956
import hotshot
957
pffileno, pfname = tempfile.mkstemp()
958
try:
959
prof = hotshot.Profile(pfname)
960
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
961
prof.close()
962
963
import hotshot.stats
964
stats = hotshot.stats.load(pfname)
965
#stats.strip_dirs()
966
stats.sort_stats('time')
967
## XXX: Might like to write to stderr or the trace file instead but
968
## print_stats seems hardcoded to stdout
969
stats.print_stats(20)
970
971
return ret
972
973
finally:
974
os.close(pffileno)
975
os.remove(pfname)
976
else:
977
cmdobj = cmd_class(cmdopts, cmdargs) or 0
978
979
980
981
def _report_exception(e, summary, quiet=False):
982
import traceback
983
log_error('bzr: ' + summary)
984
bzrlib.trace.log_exception(e)
985
986
if not quiet:
987
tb = sys.exc_info()[2]
988
exinfo = traceback.extract_tb(tb)
989
if exinfo:
990
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
991
sys.stderr.write(' see ~/.bzr.log for debug information\n')
992
601
602
opt_profile = opt_no_plugins = opt_builtin = False
603
604
# --no-plugins is handled specially at a very early stage. We need
605
# to load plugins before doing other command parsing so that they
606
# can override commands, but this needs to happen first.
607
608
for a in argv:
609
if a == '--profile':
610
opt_profile = True
611
elif a == '--no-plugins':
612
opt_no_plugins = True
613
elif a == '--builtin':
614
opt_builtin = True
615
else:
616
break
617
argv.remove(a)
618
619
if (not argv) or (argv[0] == '--help'):
620
from bzrlib.help import help
621
if len(argv) > 1:
622
help(argv[1])
623
else:
624
help()
625
return 0
626
627
if argv[0] == '--version':
628
from bzrlib.builtins import show_version
629
show_version()
630
return 0
631
632
if not opt_no_plugins:
633
from bzrlib.plugin import load_plugins
634
load_plugins()
635
636
cmd = str(argv.pop(0))
637
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
639
640
if opt_profile:
641
ret = apply_profiled(cmd_obj.run_argv, argv)
642
else:
643
ret = cmd_obj.run_argv(argv)
644
return ret or 0
993
645
994
646
995
647
def main(argv):
996
import errno
997
998
bzrlib.trace.create_tracefile(argv)
648
import bzrlib.ui
649
bzrlib.trace.log_startup(argv)
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
999
651
1000
652
try:
1001
653
try:
1002
ret = run_bzr(argv)
1003
# do this here to catch EPIPE
654
return run_bzr(argv[1:])
655
finally:
656
# do this here inside the exception wrappers to catch EPIPE
1004
657
sys.stdout.flush()
1005
return ret
1006
except BzrError, e:
1007
quiet = isinstance(e, (BzrCommandError))
1008
_report_exception(e, 'error: ' + e.args[0], quiet=quiet)
1009
if len(e.args) > 1:
1010
for h in e.args[1]:
1011
# some explanation or hints
1012
log_error(' ' + h)
1013
return 1
1014
except AssertionError, e:
1015
msg = 'assertion failed'
1016
if str(e):
1017
msg += ': ' + str(e)
1018
_report_exception(e, msg)
1019
return 2
1020
except KeyboardInterrupt, e:
1021
_report_exception(e, 'interrupted', quiet=True)
1022
return 2
1023
except Exception, e:
1024
quiet = False
1025
if isinstance(e, IOError) and e.errno == errno.EPIPE:
1026
quiet = True
1027
msg = 'broken pipe'
1028
else:
1029
msg = str(e).rstrip('\n')
1030
_report_exception(e, msg, quiet)
1031
return 2
1032
finally:
1033
bzrlib.trace.close_trace()
658
except BzrCommandError, e:
659
# command line syntax error, etc
660
log_error(str(e))
661
return 1
662
except BzrError, e:
663
bzrlib.trace.log_exception()
664
return 1
665
except AssertionError, e:
666
bzrlib.trace.log_exception('assertion failed: ' + str(e))
667
return 3
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
670
return 2
671
except Exception, e:
672
import errno
673
if (isinstance(e, IOError)
674
and hasattr(e, 'errno')
675
and e.errno == errno.EPIPE):
676
bzrlib.trace.note('broken pipe')
677
return 2
678
else:
679
bzrlib.trace.log_exception()
680
return 2
1034
681
1035
682
1036
683
if __name__ == '__main__':
Loggerhead is a web-based interface for Breezy
Version: 2.0.1