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