« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1393.1.16
- compare with another revision
- download diff
- download tarball
- view history from revision 1393.1.16
- Committer: Martin Pool
- Date: 2005-09-30 05:15:03 UTC
- mto: (1185.14.2)
- mto: This revision was merged to the branch mainline in revision 1396.
- Revision ID: mbp@sourcefrog.net-20050930051503-9c049325215ddd1c
- fix up Branch.open_downlevel for Transport
- files added:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- patches
- tools
- files removed:
- bzrlib/remotebranch.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- contrib/bash/bzr => contrib/bash/bzr.simple
- bzrlib/newinventory.py => contrib/newinventory.py
- 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
# TODO: Help messages for options.
29
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
33
34
35
36
import sys
37
import os
38
from warnings import warn
39
from inspect import getdoc
72
40
73
41
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
42
import bzrlib.trace
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib import BZRDIR
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd):
52
"Utility function to help register a command"
53
global plugin_cmds
54
k = cmd.__name__
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
57
else:
58
k_unsquished = k
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
else:
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
65
66
67
def _squish_command_name(cmd):
68
return 'cmd_' + cmd.replace('-', '_')
69
70
71
def _unsquish_command_name(cmd):
72
assert cmd.startswith("cmd_")
73
return cmd[4:].replace('_','-')
74
75
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
78
79
This always returns a list. The list will have one element for
80
each revision.
81
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
116
...
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
120
...
121
BzrError: No namespace registered for string: 'abc'
122
"""
123
import re
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
126
revs = []
127
if m:
128
warning('Colon separator for revision numbers is deprecated.'
129
' Use .. instead')
130
for rev in revstr.split(':'):
131
if rev:
132
revs.append(RevisionSpec(int(rev)))
133
else:
134
revs.append(RevisionSpec(None))
135
else:
136
for x in revstr.split('..'):
137
if not x:
138
revs.append(RevisionSpec(None))
139
else:
140
revs.append(RevisionSpec(x))
141
return revs
142
143
144
def _builtin_commands():
145
import bzrlib.builtins
146
r = {}
147
builtins = bzrlib.builtins.__dict__
148
for name in builtins:
149
if name.startswith("cmd_"):
150
real_name = _unsquish_command_name(name)
151
r[real_name] = builtins[name]
152
return r
153
154
155
156
def builtin_command_names():
157
"""Return list of builtin command names."""
158
return _builtin_commands().keys()
159
160
161
def plugin_command_names():
162
return plugin_cmds.keys()
163
164
165
def _get_cmd_dict(plugins_override=True):
166
"""Return name->class mapping for all commands."""
167
d = _builtin_commands()
168
if plugins_override:
169
d.update(plugin_cmds)
170
return d
171
172
173
def get_all_cmds(plugins_override=True):
174
"""Return canonical name and class for all registered commands."""
175
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
176
yield k,v
177
178
179
def get_cmd_object(cmd_name, plugins_override=True):
180
"""Return the canonical name and command class for a command.
181
182
plugins_override
183
If true, plugin commands can override builtins.
184
"""
185
from bzrlib.externalcommand import ExternalCommand
186
187
cmd_name = str(cmd_name) # not unicode
188
189
# first look up this command under the specified name
190
cmds = _get_cmd_dict(plugins_override=plugins_override)
106
191
try:
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
192
return cmds[cmd_name]()
108
193
except KeyError:
109
raise BzrError("unknown command %r" % cmd)
110
111
return cmd, cmd_class
112
113
114
115
class Command:
194
pass
195
196
# look for any command which claims this as an alias
197
for real_cmd_name, cmd_class in cmds.iteritems():
198
if cmd_name in cmd_class.aliases:
199
return cmd_class()
200
201
cmd_obj = ExternalCommand.find_command(cmd_name)
202
if cmd_obj:
203
return cmd_obj
204
205
raise BzrCommandError("unknown command %r" % cmd_name)
206
207
208
class Command(object):
116
209
"""Base class for commands.
117
210
211
Commands are the heart of the command-line bzr interface.
212
213
The command object mostly handles the mapping of command-line
214
parameters into one or more bzrlib operations, and of the results
215
into textual output.
216
217
Commands normally don't have any state. All their arguments are
218
passed in to the run method. (Subclasses may take a different
219
policy if the behaviour of the instance needs to depend on e.g. a
220
shell plugin and not just its Python class.)
221
118
222
The docstring for an actual command should give a single-line
119
223
summary, then a complete description of the command. A grammar
120
224
description will be inserted.
121
225
226
aliases
227
Other accepted names for this command.
228
122
229
takes_args
123
230
List of argument forms, marked with whether they are optional,
124
231
repeated, etc.
127
234
List of options that may be given for this command.
128
235
129
236
hidden
130
If true, this command isn't advertised.
237
If true, this command isn't advertised. This is typically
238
for commands intended for expert users.
131
239
"""
132
240
aliases = []
133
241
136
244
137
245
hidden = False
138
246
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)
247
def __init__(self):
248
"""Construct an instance of this command."""
249
if self.__doc__ == Command.__doc__:
250
warn("No help message set for %r" % self)
251
252
253
def run_argv(self, argv):
254
"""Parse command line and run."""
255
args, opts = parse_args(argv)
256
257
if 'help' in opts: # e.g. bzr add --help
258
from bzrlib.help import help_on_command
259
help_on_command(self.name())
260
return 0
261
262
# check options are reasonable
263
allowed = self.takes_options
264
for oname in opts:
265
if oname not in allowed:
266
raise BzrCommandError("option '--%s' is not allowed for command %r"
267
% (oname, self.name()))
268
269
# mix arguments and options into one dictionary
270
cmdargs = _match_argform(self.name(), self.takes_args, args)
271
cmdopts = {}
272
for k, v in opts.items():
273
cmdopts[k.replace('-', '_')] = v
274
275
all_cmd_args = cmdargs.copy()
276
all_cmd_args.update(cmdopts)
277
278
return self.run(**all_cmd_args)
150
279
151
280
152
281
def run(self):
153
"""Override this in sub-classes.
282
"""Actually run the command.
154
283
155
284
This is invoked with the options and arguments bound to
156
285
keyword parameters.
157
286
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
help_on_option(cmdclass.takes_options)
745
746
747
def help_on_option(options):
748
if not options:
749
return
750
751
print
752
print 'options:'
753
for on in options:
754
l = ' --' + on
755
for shortname, longname in SHORT_OPTIONS.items():
756
if longname == on:
757
l += ', -' + shortname
758
break
759
print l
760
761
762
def help_commands():
763
"""List all commands"""
764
import inspect
765
766
accu = []
767
for k, v in globals().items():
768
if k.startswith('cmd_'):
769
accu.append((k[4:].replace('_','-'), v))
770
accu.sort()
771
for cmdname, cmdclass in accu:
772
if cmdclass.hidden:
773
continue
774
print cmdname
775
help = inspect.getdoc(cmdclass)
776
if help:
777
print " " + help.split('\n', 1)[0]
778
779
780
######################################################################
781
# main routine
287
Return 0 or None if the command was successful, or a non-zero
288
shell error code if not. It's OK for this method to allow
289
an exception to raise up.
290
"""
291
raise NotImplementedError()
292
293
294
def help(self):
295
"""Return help message for this class."""
296
if self.__doc__ is Command.__doc__:
297
return None
298
return getdoc(self)
299
300
def name(self):
301
return _unsquish_command_name(self.__class__.__name__)
302
303
304
def parse_spec(spec):
305
"""
306
>>> parse_spec(None)
307
[None, None]
308
>>> parse_spec("./")
309
['./', None]
310
>>> parse_spec("../@")
311
['..', -1]
312
>>> parse_spec("../f/@35")
313
['../f', 35]
314
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
315
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
316
"""
317
if spec is None:
318
return [None, None]
319
if '/@' in spec:
320
parsed = spec.split('/@')
321
assert len(parsed) == 2
322
if parsed[1] == "":
323
parsed[1] = -1
324
else:
325
try:
326
parsed[1] = int(parsed[1])
327
except ValueError:
328
pass # We can allow stuff like ./@revid:blahblahblah
329
else:
330
assert parsed[1] >=0
331
else:
332
parsed = [spec, None]
333
return parsed
782
334
783
335
784
336
# list of all available options; the rhs can be either None for an
786
338
# the type.
787
339
OPTIONS = {
788
340
'all': None,
341
'basis': str,
342
'diff-options': str,
789
343
'help': None,
344
'file': unicode,
345
'force': None,
346
'format': unicode,
347
'forward': None,
790
348
'message': unicode,
349
'no-recurse': None,
791
350
'profile': None,
792
'revision': int,
351
'revision': _parse_revision_str,
352
'short': None,
793
353
'show-ids': None,
794
354
'timezone': str,
795
355
'verbose': None,
796
356
'version': None,
797
357
'email': None,
358
'unchanged': None,
359
'update': None,
360
'long': None,
361
'root': str,
362
'no-backup': None,
363
'pattern': str,
798
364
}
799
365
800
366
SHORT_OPTIONS = {
367
'F': 'file',
368
'h': 'help',
801
369
'm': 'message',
802
370
'r': 'revision',
803
371
'v': 'verbose',
372
'l': 'long',
804
373
}
805
374
806
375
814
383
815
384
>>> parse_args('--help'.split())
816
385
([], {'help': True})
386
>>> parse_args('help -- --invalidcmd'.split())
387
(['help', '--invalidcmd'], {})
817
388
>>> parse_args('--version'.split())
818
389
([], {'version': True})
819
390
>>> parse_args('status --all'.split())
820
391
(['status'], {'all': True})
821
392
>>> parse_args('commit --message=biter'.split())
822
393
(['commit'], {'message': u'biter'})
394
>>> parse_args('log -r 500'.split())
395
(['log'], {'revision': [<RevisionSpec_int 500>]})
396
>>> parse_args('log -r500..600'.split())
397
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
398
>>> parse_args('log -vr500..600'.split())
399
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
400
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
401
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
823
402
"""
824
403
args = []
825
404
opts = {}
826
405
827
# TODO: Maybe handle '--' to end options?
828
406
argsover = False
829
407
while argv:
830
408
a = argv.pop(0)
831
if a[0] == '-':
409
if not argsover and a[0] == '-':
832
410
# option names must not be unicode
833
411
a = str(a)
834
412
optarg = None
835
413
if a[1] == '-':
414
if a == '--':
415
# We've received a standalone -- No more flags
416
argsover = True
417
continue
836
418
mutter(" got option %r" % a)
837
419
if '=' in a:
838
420
optname, optarg = a[2:].split('=', 1)
839
421
else:
840
422
optname = a[2:]
841
423
if optname not in OPTIONS:
842
bailout('unknown long option %r' % a)
424
raise BzrError('unknown long option %r' % a)
843
425
else:
844
426
shortopt = a[1:]
845
if shortopt not in SHORT_OPTIONS:
846
bailout('unknown short option %r' % a)
847
optname = SHORT_OPTIONS[shortopt]
427
if shortopt in SHORT_OPTIONS:
428
# Multi-character options must have a space to delimit
429
# their value
430
optname = SHORT_OPTIONS[shortopt]
431
else:
432
# Single character short options, can be chained,
433
# and have their value appended to their name
434
shortopt = a[1:2]
435
if shortopt not in SHORT_OPTIONS:
436
# We didn't find the multi-character name, and we
437
# didn't find the single char name
438
raise BzrError('unknown short option %r' % a)
439
optname = SHORT_OPTIONS[shortopt]
440
441
if a[2:]:
442
# There are extra things on this option
443
# see if it is the value, or if it is another
444
# short option
445
optargfn = OPTIONS[optname]
446
if optargfn is None:
447
# This option does not take an argument, so the
448
# next entry is another short option, pack it back
449
# into the list
450
argv.insert(0, '-' + a[2:])
451
else:
452
# This option takes an argument, so pack it
453
# into the array
454
optarg = a[2:]
848
455
849
456
if optname in opts:
850
457
# XXX: Do we ever want to support this, e.g. for -r?
851
bailout('repeated option %r' % a)
458
raise BzrError('repeated option %r' % a)
852
459
853
460
optargfn = OPTIONS[optname]
854
461
if optargfn:
855
462
if optarg == None:
856
463
if not argv:
857
bailout('option %r needs an argument' % a)
464
raise BzrError('option %r needs an argument' % a)
858
465
else:
859
466
optarg = argv.pop(0)
860
467
opts[optname] = optargfn(optarg)
861
468
else:
862
469
if optarg != None:
863
bailout('option %r takes no argument' % optname)
470
raise BzrError('option %r takes no argument' % optname)
864
471
opts[optname] = True
865
472
else:
866
473
args.append(a)
915
522
916
523
917
524
525
def apply_profiled(the_callable, *args, **kwargs):
526
import hotshot
527
import tempfile
528
pffileno, pfname = tempfile.mkstemp()
529
try:
530
prof = hotshot.Profile(pfname)
531
try:
532
ret = prof.runcall(the_callable, *args, **kwargs) or 0
533
finally:
534
prof.close()
535
536
import hotshot.stats
537
stats = hotshot.stats.load(pfname)
538
#stats.strip_dirs()
539
stats.sort_stats('time')
540
## XXX: Might like to write to stderr or the trace file instead but
541
## print_stats seems hardcoded to stdout
542
stats.print_stats(20)
543
544
return ret
545
finally:
546
os.close(pffileno)
547
os.remove(pfname)
548
549
918
550
def run_bzr(argv):
919
551
"""Execute a command.
920
552
921
553
This is similar to main(), but without all the trappings for
922
554
logging and error handling.
555
556
argv
557
The command-line arguments, without the program name from argv[0]
558
559
Returns a command status or raises an exception.
560
561
Special master options: these must come before the command because
562
they control how the command is interpreted.
563
564
--no-plugins
565
Do not load plugin modules at all
566
567
--builtin
568
Only use builtin commands. (Plugins are still allowed to change
569
other behaviour.)
570
571
--profile
572
Run under the Python profiler.
923
573
"""
924
574
# Load all of the transport methods
575
import bzrlib.transport.local, bzrlib.transport.http
576
925
577
argv = [a.decode(bzrlib.user_encoding) for a in argv]
926
927
try:
928
args, opts = parse_args(argv[1:])
929
if 'help' in opts:
930
if args:
931
help(args[0])
932
else:
933
help()
934
return 0
935
elif 'version' in opts:
936
cmd_version([], [])
937
return 0
938
cmd = str(args.pop(0))
939
except IndexError:
940
log_error('usage: bzr COMMAND')
941
log_error(' try "bzr help"')
942
return 1
943
944
canonical_cmd, cmd_class = get_cmd_class(cmd)
945
946
# global option
947
if 'profile' in opts:
948
profile = True
949
del opts['profile']
950
else:
951
profile = False
952
953
# check options are reasonable
954
allowed = cmd_class.takes_options
955
for oname in opts:
956
if oname not in allowed:
957
raise BzrCommandError("option %r is not allowed for command %r"
958
% (oname, cmd))
959
960
# mix arguments and options into one dictionary
961
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
962
cmdopts = {}
963
for k, v in opts.items():
964
cmdopts[k.replace('-', '_')] = v
965
966
if profile:
967
import hotshot
968
pffileno, pfname = tempfile.mkstemp()
969
try:
970
prof = hotshot.Profile(pfname)
971
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
972
prof.close()
973
974
import hotshot.stats
975
stats = hotshot.stats.load(pfname)
976
#stats.strip_dirs()
977
stats.sort_stats('time')
978
## XXX: Might like to write to stderr or the trace file instead but
979
## print_stats seems hardcoded to stdout
980
stats.print_stats(20)
981
982
return ret
983
984
finally:
985
os.close(pffileno)
986
os.remove(pfname)
987
else:
988
cmdobj = cmd_class(cmdopts, cmdargs) or 0
989
990
991
992
def _report_exception(e, summary, quiet=False):
993
import traceback
994
log_error('bzr: ' + summary)
995
bzrlib.trace.log_exception(e)
996
997
if not quiet:
998
tb = sys.exc_info()[2]
999
exinfo = traceback.extract_tb(tb)
1000
if exinfo:
1001
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1002
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1003
578
579
opt_profile = opt_no_plugins = opt_builtin = False
580
581
# --no-plugins is handled specially at a very early stage. We need
582
# to load plugins before doing other command parsing so that they
583
# can override commands, but this needs to happen first.
584
585
for a in argv:
586
if a == '--profile':
587
opt_profile = True
588
elif a == '--no-plugins':
589
opt_no_plugins = True
590
elif a == '--builtin':
591
opt_builtin = True
592
else:
593
break
594
argv.remove(a)
595
596
if (not argv) or (argv[0] == '--help'):
597
from bzrlib.help import help
598
if len(argv) > 1:
599
help(argv[1])
600
else:
601
help()
602
return 0
603
604
if argv[0] == '--version':
605
from bzrlib.builtins import show_version
606
show_version()
607
return 0
608
609
if not opt_no_plugins:
610
from bzrlib.plugin import load_plugins
611
load_plugins()
612
613
cmd = str(argv.pop(0))
614
615
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
616
617
if opt_profile:
618
ret = apply_profiled(cmd_obj.run_argv, argv)
619
else:
620
ret = cmd_obj.run_argv(argv)
621
return ret or 0
1004
622
1005
623
1006
624
def main(argv):
1007
import errno
1008
1009
bzrlib.trace.create_tracefile(argv)
1010
625
import bzrlib.ui
626
bzrlib.trace.log_startup(argv)
627
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
628
629
return run_bzr_catch_errors(argv[1:])
630
631
632
def run_bzr_catch_errors(argv):
1011
633
try:
1012
634
try:
1013
ret = run_bzr(argv)
1014
# do this here to catch EPIPE
1015
sys.stdout.flush()
1016
return ret
1017
except BzrError, e:
1018
quiet = isinstance(e, (BzrCommandError))
1019
_report_exception(e, 'error: ' + e.args[0], quiet=quiet)
1020
if len(e.args) > 1:
1021
for h in e.args[1]:
1022
# some explanation or hints
1023
log_error(' ' + h)
1024
return 1
1025
except AssertionError, e:
1026
msg = 'assertion failed'
1027
if str(e):
1028
msg += ': ' + str(e)
1029
_report_exception(e, msg)
1030
return 2
1031
except KeyboardInterrupt, e:
1032
_report_exception(e, 'interrupted', quiet=True)
1033
return 2
1034
except Exception, e:
1035
quiet = False
1036
if isinstance(e, IOError) and e.errno == errno.EPIPE:
1037
quiet = True
1038
msg = 'broken pipe'
1039
else:
1040
msg = str(e).rstrip('\n')
1041
_report_exception(e, msg, quiet)
1042
return 2
1043
finally:
1044
bzrlib.trace.close_trace()
1045
635
try:
636
return run_bzr(argv)
637
finally:
638
# do this here inside the exception wrappers to catch EPIPE
639
sys.stdout.flush()
640
#wrap common errors as CommandErrors.
641
except (NotBranchError,), e:
642
raise BzrCommandError(str(e))
643
except BzrCommandError, e:
644
# command line syntax error, etc
645
log_error(str(e))
646
return 1
647
except BzrError, e:
648
bzrlib.trace.log_exception()
649
return 1
650
except AssertionError, e:
651
bzrlib.trace.log_exception('assertion failed: ' + str(e))
652
return 3
653
except KeyboardInterrupt, e:
654
bzrlib.trace.log_exception('interrupted')
655
return 2
656
except Exception, e:
657
import errno
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
662
return 2
663
else:
664
bzrlib.trace.log_exception()
665
return 2
1046
666
1047
667
if __name__ == '__main__':
1048
668
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1