« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1563.2.13
- compare with another revision
- download diff
- download tarball
- view history from revision 1563.2.13
- Committer: Robert Collins
- Date: 2006-03-02 03:12:34 UTC
- mto: (1594.2.4 integration)
- mto: This revision was merged to the branch mainline in revision 1596.
- Revision ID: robertc@robertcollins.net-20060302031234-cf6b75961f27c5df
InterVersionedFile implemented.
- files added:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/store
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/ui
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files removed:
- bzrlib/changeset.py
- patches
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testlog.py => bzrlib/tests/test_log.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevision.py => bzrlib/tests/test_revision.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- tools/history2weaves.py => bzrlib/upgrade.py
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/commands.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
# TODO: Split the command framework away from the actual commands.
19
20
18
# TODO: probably should say which arguments are candidates for glob
21
19
# expansion on windows and do that at the command level.
22
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
23
30
import sys
24
31
import os
32
from warnings import warn
33
from inspect import getdoc
34
import errno
25
35
26
36
import bzrlib
27
from bzrlib.trace import mutter, note, log_error, warning
28
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
from bzrlib.branch import find_branch
30
from bzrlib import BZRDIR
31
37
from bzrlib.errors import (BzrError,
38
BzrCheckError,
39
BzrCommandError,
40
BzrOptionError,
41
NotBranchError)
42
from bzrlib.option import Option
43
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.symbol_versioning import *
45
import bzrlib.trace
46
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
32
47
33
48
plugin_cmds = {}
34
49
35
50
36
def register_command(cmd):
51
def register_command(cmd, decorate=False):
37
52
"Utility function to help register a command"
38
53
global plugin_cmds
39
54
k = cmd.__name__
43
58
k_unsquished = k
44
59
if not plugin_cmds.has_key(k_unsquished):
45
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
64
elif decorate:
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
67
return result
46
68
else:
47
69
log_error('Two plugins defined the same command: %r' % k)
48
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
57
79
return cmd[4:].replace('_','-')
58
80
59
81
60
def _parse_revision_str(revstr):
61
"""This handles a revision string -> revno.
62
63
This always returns a list. The list will have one element for
64
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
67
68
>>> _parse_revision_str('234')
69
[234]
70
>>> _parse_revision_str('234..567')
71
[234, 567]
72
>>> _parse_revision_str('..')
73
[None, None]
74
>>> _parse_revision_str('..234')
75
[None, 234]
76
>>> _parse_revision_str('234..')
77
[234, None]
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
79
[234, 456, 789]
80
>>> _parse_revision_str('234....789') # Error?
81
[234, None, 789]
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
89
['date:2005-04-12']
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
97
[-5, 23]
98
>>> _parse_revision_str('-5')
99
[-5]
100
>>> _parse_revision_str('123a')
101
['123a']
102
>>> _parse_revision_str('abc')
103
['abc']
104
"""
105
import re
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
108
if m:
109
warning('Colon separator for revision numbers is deprecated.'
110
' Use .. instead')
111
revs = []
112
for rev in revstr.split(':'):
113
if rev:
114
revs.append(int(rev))
115
else:
116
revs.append(None)
117
return revs
118
revs = []
119
for x in revstr.split('..'):
120
if not x:
121
revs.append(None)
122
else:
123
try:
124
revs.append(int(x))
125
except ValueError:
126
revs.append(x)
127
return revs
128
129
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
133
try:
134
return merge_types[typestring][0]
135
except KeyError:
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
142
143
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
147
try:
148
return merge_types[typestring][0]
149
except KeyError:
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
156
82
def _builtin_commands():
83
import bzrlib.builtins
84
r = {}
85
builtins = bzrlib.builtins.__dict__
86
for name in builtins:
87
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
90
return r
91
92
93
94
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
97
98
99
def plugin_command_names():
100
return plugin_cmds.keys()
157
101
158
102
159
103
def _get_cmd_dict(plugins_override=True):
160
d = {}
161
for k, v in globals().iteritems():
162
if k.startswith("cmd_"):
163
d[_unsquish_command_name(k)] = v
164
# If we didn't load plugins, the plugin_cmds dict will be empty
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
165
106
if plugins_override:
166
107
d.update(plugin_cmds)
167
else:
168
d2 = plugin_cmds.copy()
169
d2.update(d)
170
d = d2
171
108
return d
172
109
173
110
177
114
yield k,v
178
115
179
116
180
def get_cmd_class(cmd, plugins_override=True):
117
def get_cmd_object(cmd_name, plugins_override=True):
181
118
"""Return the canonical name and command class for a command.
119
120
plugins_override
121
If true, plugin commands can override builtins.
182
122
"""
183
cmd = str(cmd) # not unicode
123
from bzrlib.externalcommand import ExternalCommand
124
125
cmd_name = str(cmd_name) # not unicode
184
126
185
127
# first look up this command under the specified name
186
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
187
129
try:
188
return cmd, cmds[cmd]
130
return cmds[cmd_name]()
189
131
except KeyError:
190
132
pass
191
133
192
134
# look for any command which claims this as an alias
193
for cmdname, cmdclass in cmds.iteritems():
194
if cmd in cmdclass.aliases:
195
return cmdname, cmdclass
196
197
cmdclass = ExternalCommand.find_command(cmd)
198
if cmdclass:
199
return cmd, cmdclass
200
201
raise BzrCommandError("unknown command %r" % cmd)
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
137
return cmd_class()
138
139
cmd_obj = ExternalCommand.find_command(cmd_name)
140
if cmd_obj:
141
return cmd_obj
142
143
raise BzrCommandError("unknown command %r" % cmd_name)
202
144
203
145
204
146
class Command(object):
205
147
"""Base class for commands.
206
148
149
Commands are the heart of the command-line bzr interface.
150
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
153
into textual output.
154
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
159
207
160
The docstring for an actual command should give a single-line
208
161
summary, then a complete description of the command. A grammar
209
162
description will be inserted.
210
163
164
aliases
165
Other accepted names for this command.
166
211
167
takes_args
212
168
List of argument forms, marked with whether they are optional,
213
169
repeated, etc.
214
170
171
Examples:
172
173
['to_location', 'from_branch?', 'file*']
174
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
178
215
179
takes_options
216
List of options that may be given for this command.
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
217
183
218
184
hidden
219
If true, this command isn't advertised.
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
220
187
"""
221
188
aliases = []
222
223
189
takes_args = []
224
190
takes_options = []
225
191
226
192
hidden = False
227
193
228
def __init__(self, options, arguments):
229
"""Construct and run the command.
230
231
Sets self.status to the return value of run()."""
232
assert isinstance(options, dict)
233
assert isinstance(arguments, dict)
234
cmdargs = options.copy()
235
cmdargs.update(arguments)
194
def __init__(self):
195
"""Construct an instance of this command."""
236
196
if self.__doc__ == Command.__doc__:
237
from warnings import warn
238
197
warn("No help message set for %r" % self)
239
self.status = self.run(**cmdargs)
240
if self.status is None:
241
self.status = 0
242
198
199
def options(self):
200
"""Return dict of valid options for this command.
201
202
Maps from long option name to option object."""
203
r = dict()
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
208
r[o.name] = o
209
return r
210
211
@deprecated_method(zero_eight)
212
def run_argv(self, argv):
213
"""Parse command line and run.
214
215
See run_argv_aliases for the 0.8 and beyond api.
216
"""
217
return self.run_argv_aliases(argv)
218
219
def run_argv_aliases(self, argv, alias_argv=None):
220
"""Parse the command line and run with extra aliases in alias_argv."""
221
args, opts = parse_args(self, argv, alias_argv)
222
if 'help' in opts: # e.g. bzr add --help
223
from bzrlib.help import help_on_command
224
help_on_command(self.name())
225
return 0
226
# XXX: This should be handled by the parser
227
allowed_names = self.options().keys()
228
for oname in opts:
229
if oname not in allowed_names:
230
raise BzrCommandError("option '--%s' is not allowed for"
231
" command %r" % (oname, self.name()))
232
# mix arguments and options into one dictionary
233
cmdargs = _match_argform(self.name(), self.takes_args, args)
234
cmdopts = {}
235
for k, v in opts.items():
236
cmdopts[k.replace('-', '_')] = v
237
238
all_cmd_args = cmdargs.copy()
239
all_cmd_args.update(cmdopts)
240
241
return self.run(**all_cmd_args)
243
242
244
243
def run(self):
245
"""Override this in sub-classes.
244
"""Actually run the command.
246
245
247
246
This is invoked with the options and arguments bound to
248
247
keyword parameters.
249
248
250
Return 0 or None if the command was successful, or a shell
251
error code if not.
249
Return 0 or None if the command was successful, or a non-zero
250
shell error code if not. It's OK for this method to allow
251
an exception to raise up.
252
252
"""
253
return 0
254
255
256
class ExternalCommand(Command):
257
"""Class to wrap external commands.
258
259
We cheat a little here, when get_cmd_class() calls us we actually
260
give it back an object we construct that has the appropriate path,
261
help, options etc for the specified command.
262
263
When run_bzr() tries to instantiate that 'class' it gets caught by
264
the __call__ method, which we override to call the Command.__init__
265
method. That then calls our run method which is pretty straight
266
forward.
267
268
The only wrinkle is that we have to map bzr's dictionary of options
269
and arguments back into command line options and arguments for the
270
script.
271
"""
272
273
def find_command(cls, cmd):
274
import os.path
275
bzrpath = os.environ.get('BZRPATH', '')
276
277
for dir in bzrpath.split(os.pathsep):
278
path = os.path.join(dir, cmd)
279
if os.path.isfile(path):
280
return ExternalCommand(path)
281
282
return None
283
284
find_command = classmethod(find_command)
285
286
def __init__(self, path):
287
self.path = path
288
289
pipe = os.popen('%s --bzr-usage' % path, 'r')
290
self.takes_options = pipe.readline().split()
291
292
for opt in self.takes_options:
293
if not opt in OPTIONS:
294
raise BzrError("Unknown option '%s' returned by external command %s"
295
% (opt, path))
296
297
# TODO: Is there any way to check takes_args is valid here?
298
self.takes_args = pipe.readline().split()
299
300
if pipe.close() is not None:
301
raise BzrError("Failed funning '%s --bzr-usage'" % path)
302
303
pipe = os.popen('%s --bzr-help' % path, 'r')
304
self.__doc__ = pipe.read()
305
if pipe.close() is not None:
306
raise BzrError("Failed funning '%s --bzr-help'" % path)
307
308
def __call__(self, options, arguments):
309
Command.__init__(self, options, arguments)
310
return self
311
312
def run(self, **kargs):
313
opts = []
314
args = []
315
316
keys = kargs.keys()
317
keys.sort()
318
for name in keys:
319
optname = name.replace('_','-')
320
value = kargs[name]
321
if OPTIONS.has_key(optname):
322
# it's an option
323
opts.append('--%s' % optname)
324
if value is not None and value is not True:
325
opts.append(str(value))
326
else:
327
# it's an arg, or arg list
328
if type(value) is not list:
329
value = [value]
330
for v in value:
331
if v is not None:
332
args.append(str(v))
333
334
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
335
return self.status
336
337
338
class cmd_status(Command):
339
"""Display status summary.
340
341
This reports on versioned and unknown files, reporting them
342
grouped by state. Possible states are:
343
344
added
345
Versioned in the working copy but not in the previous revision.
346
347
removed
348
Versioned in the previous revision but removed or deleted
349
in the working copy.
350
351
renamed
352
Path of this file changed from the previous revision;
353
the text may also have changed. This includes files whose
354
parent directory was renamed.
355
356
modified
357
Text has changed since the previous revision.
358
359
unchanged
360
Nothing about this file has changed since the previous revision.
361
Only shown with --all.
362
363
unknown
364
Not versioned and not matching an ignore pattern.
365
366
To see ignored files use 'bzr ignored'. For details in the
367
changes to file texts, use 'bzr diff'.
368
369
If no arguments are specified, the status of the entire working
370
directory is shown. Otherwise, only the status of the specified
371
files or directories is reported. If a directory is given, status
372
is reported for everything inside that directory.
373
374
If a revision is specified, the changes since that revision are shown.
375
"""
376
takes_args = ['file*']
377
takes_options = ['all', 'show-ids', 'revision']
378
aliases = ['st', 'stat']
379
380
def run(self, all=False, show_ids=False, file_list=None):
381
if file_list:
382
b = find_branch(file_list[0])
383
file_list = [b.relpath(x) for x in file_list]
384
# special case: only one path was given and it's the root
385
# of the branch
386
if file_list == ['']:
387
file_list = None
388
else:
389
b = find_branch('.')
390
391
from bzrlib.status import show_status
392
show_status(b, show_unchanged=all, show_ids=show_ids,
393
specific_files=file_list)
394
395
396
class cmd_cat_revision(Command):
397
"""Write out metadata for a revision."""
398
399
hidden = True
400
takes_args = ['revision_id']
401
402
def run(self, revision_id):
403
from bzrlib.xml import pack_xml
404
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
405
406
407
class cmd_revno(Command):
408
"""Show current revision number.
409
410
This is equal to the number of revisions on this branch."""
411
def run(self):
412
print find_branch('.').revno()
413
414
class cmd_revision_info(Command):
415
"""Show revision number and revision id for a given revision identifier.
416
"""
417
hidden = True
418
takes_args = ['revision_info*']
419
takes_options = ['revision']
420
def run(self, revision=None, revision_info_list=None):
421
from bzrlib.branch import find_branch
422
423
revs = []
424
if revision is not None:
425
revs.extend(revision)
426
if revision_info_list is not None:
427
revs.extend(revision_info_list)
428
if len(revs) == 0:
429
raise BzrCommandError('You must supply a revision identifier')
430
431
b = find_branch('.')
432
433
for rev in revs:
434
print '%4d %s' % b.get_revision_info(rev)
435
436
437
class cmd_add(Command):
438
"""Add specified files or directories.
439
440
In non-recursive mode, all the named items are added, regardless
441
of whether they were previously ignored. A warning is given if
442
any of the named files are already versioned.
443
444
In recursive mode (the default), files are treated the same way
445
but the behaviour for directories is different. Directories that
446
are already versioned do not give a warning. All directories,
447
whether already versioned or not, are searched for files or
448
subdirectories that are neither versioned or ignored, and these
449
are added. This search proceeds recursively into versioned
450
directories. If no names are given '.' is assumed.
451
452
Therefore simply saying 'bzr add' will version all files that
453
are currently unknown.
454
455
TODO: Perhaps adding a file whose directly is not versioned should
456
recursively add that parent, rather than giving an error?
457
"""
458
takes_args = ['file*']
459
takes_options = ['verbose', 'no-recurse']
460
461
def run(self, file_list, verbose=False, no_recurse=False):
462
from bzrlib.add import smart_add
463
smart_add(file_list, verbose, not no_recurse)
464
465
466
467
class cmd_mkdir(Command):
468
"""Create a new versioned directory.
469
470
This is equivalent to creating the directory and then adding it.
471
"""
472
takes_args = ['dir+']
473
474
def run(self, dir_list):
475
b = None
476
477
for d in dir_list:
478
os.mkdir(d)
479
if not b:
480
b = find_branch(d)
481
b.add([d], verbose=True)
482
483
484
class cmd_relpath(Command):
485
"""Show path of a file relative to root"""
486
takes_args = ['filename']
487
hidden = True
488
489
def run(self, filename):
490
print find_branch(filename).relpath(filename)
491
492
493
494
class cmd_inventory(Command):
495
"""Show inventory of the current working copy or a revision."""
496
takes_options = ['revision', 'show-ids']
497
498
def run(self, revision=None, show_ids=False):
499
b = find_branch('.')
500
if revision == None:
501
inv = b.read_working_inventory()
502
else:
503
if len(revision) > 1:
504
raise BzrCommandError('bzr inventory --revision takes'
505
' exactly one revision identifier')
506
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
507
508
for path, entry in inv.entries():
509
if show_ids:
510
print '%-50s %s' % (path, entry.file_id)
511
else:
512
print path
513
514
515
class cmd_move(Command):
516
"""Move files to a different directory.
517
518
examples:
519
bzr move *.txt doc
520
521
The destination must be a versioned directory in the same branch.
522
"""
523
takes_args = ['source$', 'dest']
524
def run(self, source_list, dest):
525
b = find_branch('.')
526
527
# TODO: glob expansion on windows?
528
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
529
530
531
class cmd_rename(Command):
532
"""Change the name of an entry.
533
534
examples:
535
bzr rename frob.c frobber.c
536
bzr rename src/frob.c lib/frob.c
537
538
It is an error if the destination name exists.
539
540
See also the 'move' command, which moves files into a different
541
directory without changing their name.
542
543
TODO: Some way to rename multiple files without invoking bzr for each
544
one?"""
545
takes_args = ['from_name', 'to_name']
546
547
def run(self, from_name, to_name):
548
b = find_branch('.')
549
b.rename_one(b.relpath(from_name), b.relpath(to_name))
550
551
552
553
class cmd_mv(Command):
554
"""Move or rename a file.
555
556
usage:
557
bzr mv OLDNAME NEWNAME
558
bzr mv SOURCE... DESTINATION
559
560
If the last argument is a versioned directory, all the other names
561
are moved into it. Otherwise, there must be exactly two arguments
562
and the file is changed to a new name, which must not already exist.
563
564
Files cannot be moved between branches.
565
"""
566
takes_args = ['names*']
567
def run(self, names_list):
568
if len(names_list) < 2:
569
raise BzrCommandError("missing file argument")
570
b = find_branch(names_list[0])
571
572
rel_names = [b.relpath(x) for x in names_list]
573
574
if os.path.isdir(names_list[-1]):
575
# move into existing directory
576
b.move(rel_names[:-1], rel_names[-1])
577
else:
578
if len(names_list) != 2:
579
raise BzrCommandError('to mv multiple files the destination '
580
'must be a versioned directory')
581
b.move(rel_names[0], rel_names[1])
582
583
584
585
586
class cmd_pull(Command):
587
"""Pull any changes from another branch into the current one.
588
589
If the location is omitted, the last-used location will be used.
590
Both the revision history and the working directory will be
591
updated.
592
593
This command only works on branches that have not diverged. Branches are
594
considered diverged if both branches have had commits without first
595
pulling from the other.
596
597
If branches have diverged, you can use 'bzr merge' to pull the text changes
598
from one into the other.
599
"""
600
takes_args = ['location?']
601
602
def run(self, location=None):
603
from bzrlib.merge import merge
604
import tempfile
605
from shutil import rmtree
606
import errno
607
608
br_to = find_branch('.')
609
stored_loc = None
610
try:
611
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
612
except IOError, e:
613
if e.errno != errno.ENOENT:
614
raise
615
if location is None:
616
if stored_loc is None:
617
raise BzrCommandError("No pull location known or specified.")
618
else:
619
print "Using last location: %s" % stored_loc
620
location = stored_loc
621
cache_root = tempfile.mkdtemp()
622
from bzrlib.branch import DivergedBranches
623
br_from = find_branch(location)
624
location = pull_loc(br_from)
625
old_revno = br_to.revno()
626
try:
627
from branch import find_cached_branch, DivergedBranches
628
br_from = find_cached_branch(location, cache_root)
629
location = pull_loc(br_from)
630
old_revno = br_to.revno()
631
try:
632
br_to.update_revisions(br_from)
633
except DivergedBranches:
634
raise BzrCommandError("These branches have diverged."
635
" Try merge.")
636
637
merge(('.', -1), ('.', old_revno), check_clean=False)
638
if location != stored_loc:
639
br_to.controlfile("x-pull", "wb").write(location + "\n")
640
finally:
641
rmtree(cache_root)
642
643
644
645
class cmd_branch(Command):
646
"""Create a new copy of a branch.
647
648
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
649
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
650
651
To retrieve the branch as of a particular revision, supply the --revision
652
parameter, as in "branch foo/bar -r 5".
653
"""
654
takes_args = ['from_location', 'to_location?']
655
takes_options = ['revision']
656
aliases = ['get', 'clone']
657
658
def run(self, from_location, to_location=None, revision=None):
659
import errno
660
from bzrlib.merge import merge
661
from bzrlib.branch import DivergedBranches, \
662
find_cached_branch, Branch
663
from shutil import rmtree
664
from meta_store import CachedStore
665
import tempfile
666
cache_root = tempfile.mkdtemp()
667
668
if revision is None:
669
revision = [None]
670
elif len(revision) > 1:
671
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
672
673
try:
674
try:
675
br_from = find_cached_branch(from_location, cache_root)
676
except OSError, e:
677
if e.errno == errno.ENOENT:
678
raise BzrCommandError('Source location "%s" does not'
679
' exist.' % to_location)
680
else:
681
raise
682
683
if to_location is None:
684
to_location = os.path.basename(from_location.rstrip("/\\"))
685
686
try:
687
os.mkdir(to_location)
688
except OSError, e:
689
if e.errno == errno.EEXIST:
690
raise BzrCommandError('Target directory "%s" already'
691
' exists.' % to_location)
692
if e.errno == errno.ENOENT:
693
raise BzrCommandError('Parent of "%s" does not exist.' %
694
to_location)
695
else:
696
raise
697
br_to = Branch(to_location, init=True)
698
699
br_to.set_root_id(br_from.get_root_id())
700
701
if revision:
702
if revision[0] is None:
703
revno = br_from.revno()
704
else:
705
revno, rev_id = br_from.get_revision_info(revision[0])
706
try:
707
br_to.update_revisions(br_from, stop_revision=revno)
708
except bzrlib.errors.NoSuchRevision:
709
rmtree(to_location)
710
msg = "The branch %s has no revision %d." % (from_location,
711
revno)
712
raise BzrCommandError(msg)
713
714
merge((to_location, -1), (to_location, 0), this_dir=to_location,
715
check_clean=False, ignore_zero=True)
716
from_location = pull_loc(br_from)
717
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
718
finally:
719
rmtree(cache_root)
720
721
722
def pull_loc(branch):
723
# TODO: Should perhaps just make attribute be 'base' in
724
# RemoteBranch and Branch?
725
if hasattr(branch, "baseurl"):
726
return branch.baseurl
727
else:
728
return branch.base
729
730
731
732
class cmd_renames(Command):
733
"""Show list of renamed files.
734
735
TODO: Option to show renames between two historical versions.
736
737
TODO: Only show renames under dir, rather than in the whole branch.
738
"""
739
takes_args = ['dir?']
740
741
def run(self, dir='.'):
742
b = find_branch(dir)
743
old_inv = b.basis_tree().inventory
744
new_inv = b.read_working_inventory()
745
746
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
747
renames.sort()
748
for old_name, new_name in renames:
749
print "%s => %s" % (old_name, new_name)
750
751
752
class cmd_info(Command):
753
"""Show statistical information about a branch."""
754
takes_args = ['branch?']
755
756
def run(self, branch=None):
757
import info
758
759
b = find_branch(branch)
760
info.show_info(b)
761
762
763
class cmd_remove(Command):
764
"""Make a file unversioned.
765
766
This makes bzr stop tracking changes to a versioned file. It does
767
not delete the working copy.
768
"""
769
takes_args = ['file+']
770
takes_options = ['verbose']
771
772
def run(self, file_list, verbose=False):
773
b = find_branch(file_list[0])
774
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
775
776
777
class cmd_file_id(Command):
778
"""Print file_id of a particular file or directory.
779
780
The file_id is assigned when the file is first added and remains the
781
same through all revisions where the file exists, even when it is
782
moved or renamed.
783
"""
784
hidden = True
785
takes_args = ['filename']
786
def run(self, filename):
787
b = find_branch(filename)
788
i = b.inventory.path2id(b.relpath(filename))
789
if i == None:
790
raise BzrError("%r is not a versioned file" % filename)
791
else:
792
print i
793
794
795
class cmd_file_path(Command):
796
"""Print path of file_ids to a file or directory.
797
798
This prints one line for each directory down to the target,
799
starting at the branch root."""
800
hidden = True
801
takes_args = ['filename']
802
def run(self, filename):
803
b = find_branch(filename)
804
inv = b.inventory
805
fid = inv.path2id(b.relpath(filename))
806
if fid == None:
807
raise BzrError("%r is not a versioned file" % filename)
808
for fip in inv.get_idpath(fid):
809
print fip
810
811
812
class cmd_revision_history(Command):
813
"""Display list of revision ids on this branch."""
814
hidden = True
815
def run(self):
816
for patchid in find_branch('.').revision_history():
817
print patchid
818
819
820
class cmd_directories(Command):
821
"""Display list of versioned directories in this branch."""
822
def run(self):
823
for name, ie in find_branch('.').read_working_inventory().directories():
824
if name == '':
825
print '.'
826
else:
827
print name
828
829
830
class cmd_init(Command):
831
"""Make a directory into a versioned branch.
832
833
Use this to create an empty branch, or before importing an
834
existing project.
835
836
Recipe for importing a tree of files:
837
cd ~/project
838
bzr init
839
bzr add -v .
840
bzr status
841
bzr commit -m 'imported project'
842
"""
843
def run(self):
844
from bzrlib.branch import Branch
845
Branch('.', init=True)
846
847
848
class cmd_diff(Command):
849
"""Show differences in working tree.
850
851
If files are listed, only the changes in those files are listed.
852
Otherwise, all changes for the tree are listed.
853
854
TODO: Allow diff across branches.
855
856
TODO: Option to use external diff command; could be GNU diff, wdiff,
857
or a graphical diff.
858
859
TODO: Python difflib is not exactly the same as unidiff; should
860
either fix it up or prefer to use an external diff.
861
862
TODO: If a directory is given, diff everything under that.
863
864
TODO: Selected-file diff is inefficient and doesn't show you
865
deleted files.
866
867
TODO: This probably handles non-Unix newlines poorly.
868
869
examples:
870
bzr diff
871
bzr diff -r1
872
bzr diff -r1:2
873
"""
874
875
takes_args = ['file*']
876
takes_options = ['revision', 'diff-options']
877
aliases = ['di', 'dif']
878
879
def run(self, revision=None, file_list=None, diff_options=None):
880
from bzrlib.diff import show_diff
881
882
if file_list:
883
b = find_branch(file_list[0])
884
file_list = [b.relpath(f) for f in file_list]
885
if file_list == ['']:
886
# just pointing to top-of-tree
887
file_list = None
888
else:
889
b = find_branch('.')
890
891
if revision is not None:
892
if len(revision) == 1:
893
show_diff(b, revision[0], specific_files=file_list,
894
external_diff_options=diff_options)
895
elif len(revision) == 2:
896
show_diff(b, revision[0], specific_files=file_list,
897
external_diff_options=diff_options,
898
revision2=revision[1])
899
else:
900
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
901
else:
902
show_diff(b, None, specific_files=file_list,
903
external_diff_options=diff_options)
904
905
906
907
908
class cmd_deleted(Command):
909
"""List files deleted in the working tree.
910
911
TODO: Show files deleted since a previous revision, or between two revisions.
912
"""
913
def run(self, show_ids=False):
914
b = find_branch('.')
915
old = b.basis_tree()
916
new = b.working_tree()
917
918
## TODO: Much more efficient way to do this: read in new
919
## directories with readdir, rather than stating each one. Same
920
## level of effort but possibly much less IO. (Or possibly not,
921
## if the directories are very large...)
922
923
for path, ie in old.inventory.iter_entries():
924
if not new.has_id(ie.file_id):
925
if show_ids:
926
print '%-50s %s' % (path, ie.file_id)
927
else:
928
print path
929
930
931
class cmd_modified(Command):
932
"""List files modified in working tree."""
933
hidden = True
934
def run(self):
935
from bzrlib.delta import compare_trees
936
937
b = find_branch('.')
938
td = compare_trees(b.basis_tree(), b.working_tree())
939
940
for path, id, kind in td.modified:
941
print path
942
943
944
945
class cmd_added(Command):
946
"""List files added in working tree."""
947
hidden = True
948
def run(self):
949
b = find_branch('.')
950
wt = b.working_tree()
951
basis_inv = b.basis_tree().inventory
952
inv = wt.inventory
953
for file_id in inv:
954
if file_id in basis_inv:
955
continue
956
path = inv.id2path(file_id)
957
if not os.access(b.abspath(path), os.F_OK):
958
continue
959
print path
960
961
962
963
class cmd_root(Command):
964
"""Show the tree root directory.
965
966
The root is the nearest enclosing directory with a .bzr control
967
directory."""
968
takes_args = ['filename?']
969
def run(self, filename=None):
970
"""Print the branch root."""
971
b = find_branch(filename)
972
print getattr(b, 'base', None) or getattr(b, 'baseurl')
973
974
975
class cmd_log(Command):
976
"""Show log of this branch.
977
978
To request a range of logs, you can use the command -r begin:end
979
-r revision requests a specific revision, -r :end or -r begin: are
980
also valid.
981
982
--message allows you to give a regular expression, which will be evaluated
983
so that only matching entries will be displayed.
984
985
TODO: Make --revision support uuid: and hash: [future tag:] notation.
986
987
"""
988
989
takes_args = ['filename?']
990
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
'long', 'message', 'short',]
992
993
def run(self, filename=None, timezone='original',
994
verbose=False,
995
show_ids=False,
996
forward=False,
997
revision=None,
998
message=None,
999
long=False,
1000
short=False):
1001
from bzrlib.branch import find_branch
1002
from bzrlib.log import log_formatter, show_log
1003
import codecs
1004
1005
direction = (forward and 'forward') or 'reverse'
1006
1007
if filename:
1008
b = find_branch(filename)
1009
fp = b.relpath(filename)
1010
if fp:
1011
file_id = b.read_working_inventory().path2id(fp)
1012
else:
1013
file_id = None # points to branch root
1014
else:
1015
b = find_branch('.')
1016
file_id = None
1017
1018
if revision is None:
1019
rev1 = None
1020
rev2 = None
1021
elif len(revision) == 1:
1022
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1023
elif len(revision) == 2:
1024
rev1 = b.get_revision_info(revision[0])[0]
1025
rev2 = b.get_revision_info(revision[1])[0]
1026
else:
1027
raise BzrCommandError('bzr log --revision takes one or two values.')
1028
1029
if rev1 == 0:
1030
rev1 = None
1031
if rev2 == 0:
1032
rev2 = None
1033
1034
mutter('encoding log as %r' % bzrlib.user_encoding)
1035
1036
# use 'replace' so that we don't abort if trying to write out
1037
# in e.g. the default C locale.
1038
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1039
1040
if not short:
1041
log_format = 'long'
1042
else:
1043
log_format = 'short'
1044
lf = log_formatter(log_format,
1045
show_ids=show_ids,
1046
to_file=outf,
1047
show_timezone=timezone)
1048
1049
show_log(b,
1050
lf,
1051
file_id,
1052
verbose=verbose,
1053
direction=direction,
1054
start_revision=rev1,
1055
end_revision=rev2,
1056
search=message)
1057
1058
1059
1060
class cmd_touching_revisions(Command):
1061
"""Return revision-ids which affected a particular file.
1062
1063
A more user-friendly interface is "bzr log FILE"."""
1064
hidden = True
1065
takes_args = ["filename"]
1066
def run(self, filename):
1067
b = find_branch(filename)
1068
inv = b.read_working_inventory()
1069
file_id = inv.path2id(b.relpath(filename))
1070
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1071
print "%6d %s" % (revno, what)
1072
1073
1074
class cmd_ls(Command):
1075
"""List files in a tree.
1076
1077
TODO: Take a revision or remote path and list that tree instead.
1078
"""
1079
hidden = True
1080
def run(self, revision=None, verbose=False):
1081
b = find_branch('.')
1082
if revision == None:
1083
tree = b.working_tree()
1084
else:
1085
tree = b.revision_tree(b.lookup_revision(revision))
1086
1087
for fp, fc, kind, fid in tree.list_files():
1088
if verbose:
1089
if kind == 'directory':
1090
kindch = '/'
1091
elif kind == 'file':
1092
kindch = ''
1093
else:
1094
kindch = '???'
1095
1096
print '%-8s %s%s' % (fc, fp, kindch)
1097
else:
1098
print fp
1099
1100
1101
1102
class cmd_unknowns(Command):
1103
"""List unknown files."""
1104
def run(self):
1105
from bzrlib.osutils import quotefn
1106
for f in find_branch('.').unknowns():
1107
print quotefn(f)
1108
1109
1110
1111
class cmd_ignore(Command):
1112
"""Ignore a command or pattern.
1113
1114
To remove patterns from the ignore list, edit the .bzrignore file.
1115
1116
If the pattern contains a slash, it is compared to the whole path
1117
from the branch root. Otherwise, it is comapred to only the last
1118
component of the path.
1119
1120
Ignore patterns are case-insensitive on case-insensitive systems.
1121
1122
Note: wildcards must be quoted from the shell on Unix.
1123
1124
examples:
1125
bzr ignore ./Makefile
1126
bzr ignore '*.class'
1127
"""
1128
takes_args = ['name_pattern']
1129
1130
def run(self, name_pattern):
1131
from bzrlib.atomicfile import AtomicFile
1132
import os.path
1133
1134
b = find_branch('.')
1135
ifn = b.abspath('.bzrignore')
1136
1137
if os.path.exists(ifn):
1138
f = open(ifn, 'rt')
1139
try:
1140
igns = f.read().decode('utf-8')
1141
finally:
1142
f.close()
1143
else:
1144
igns = ''
1145
1146
# TODO: If the file already uses crlf-style termination, maybe
1147
# we should use that for the newly added lines?
1148
1149
if igns and igns[-1] != '\n':
1150
igns += '\n'
1151
igns += name_pattern + '\n'
1152
1153
try:
1154
f = AtomicFile(ifn, 'wt')
1155
f.write(igns.encode('utf-8'))
1156
f.commit()
1157
finally:
1158
f.close()
1159
1160
inv = b.working_tree().inventory
1161
if inv.path2id('.bzrignore'):
1162
mutter('.bzrignore is already versioned')
1163
else:
1164
mutter('need to make new .bzrignore file versioned')
1165
b.add(['.bzrignore'])
1166
1167
1168
1169
class cmd_ignored(Command):
1170
"""List ignored files and the patterns that matched them.
1171
1172
See also: bzr ignore"""
1173
def run(self):
1174
tree = find_branch('.').working_tree()
1175
for path, file_class, kind, file_id in tree.list_files():
1176
if file_class != 'I':
1177
continue
1178
## XXX: Slightly inefficient since this was already calculated
1179
pat = tree.is_ignored(path)
1180
print '%-50s %s' % (path, pat)
1181
1182
1183
class cmd_lookup_revision(Command):
1184
"""Lookup the revision-id from a revision-number
1185
1186
example:
1187
bzr lookup-revision 33
1188
"""
1189
hidden = True
1190
takes_args = ['revno']
1191
1192
def run(self, revno):
1193
try:
1194
revno = int(revno)
1195
except ValueError:
1196
raise BzrCommandError("not a valid revision-number: %r" % revno)
1197
1198
print find_branch('.').lookup_revision(revno)
1199
1200
1201
class cmd_export(Command):
1202
"""Export past revision to destination directory.
1203
1204
If no revision is specified this exports the last committed revision.
1205
1206
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1207
given, try to find the format with the extension. If no extension
1208
is found exports to a directory (equivalent to --format=dir).
1209
1210
Root may be the top directory for tar, tgz and tbz2 formats. If none
1211
is given, the top directory will be the root name of the file."""
1212
# TODO: list known exporters
1213
takes_args = ['dest']
1214
takes_options = ['revision', 'format', 'root']
1215
def run(self, dest, revision=None, format=None, root=None):
1216
import os.path
1217
b = find_branch('.')
1218
if revision is None:
1219
rev_id = b.last_patch()
1220
else:
1221
if len(revision) != 1:
1222
raise BzrError('bzr export --revision takes exactly 1 argument')
1223
revno, rev_id = b.get_revision_info(revision[0])
1224
t = b.revision_tree(rev_id)
1225
root, ext = os.path.splitext(dest)
1226
if not format:
1227
if ext in (".tar",):
1228
format = "tar"
1229
elif ext in (".gz", ".tgz"):
1230
format = "tgz"
1231
elif ext in (".bz2", ".tbz2"):
1232
format = "tbz2"
1233
else:
1234
format = "dir"
1235
t.export(dest, format, root)
1236
1237
1238
class cmd_cat(Command):
1239
"""Write a file's text from a previous revision."""
1240
1241
takes_options = ['revision']
1242
takes_args = ['filename']
1243
1244
def run(self, filename, revision=None):
1245
if revision == None:
1246
raise BzrCommandError("bzr cat requires a revision number")
1247
elif len(revision) != 1:
1248
raise BzrCommandError("bzr cat --revision takes exactly one number")
1249
b = find_branch('.')
1250
b.print_file(b.relpath(filename), revision[0])
1251
1252
1253
class cmd_local_time_offset(Command):
1254
"""Show the offset in seconds from GMT to local time."""
1255
hidden = True
1256
def run(self):
1257
print bzrlib.osutils.local_time_offset()
1258
1259
1260
1261
class cmd_commit(Command):
1262
"""Commit changes into a new revision.
1263
1264
If no arguments are given, the entire tree is committed.
1265
1266
If selected files are specified, only changes to those files are
1267
committed. If a directory is specified then the directory and everything
1268
within it is committed.
1269
1270
A selected-file commit may fail in some cases where the committed
1271
tree would be invalid, such as trying to commit a file in a
1272
newly-added directory that is not itself committed.
1273
1274
TODO: Run hooks on tree to-be-committed, and after commit.
1275
1276
TODO: Strict commit that fails if there are unknown or deleted files.
1277
"""
1278
takes_args = ['selected*']
1279
takes_options = ['message', 'file', 'verbose', 'unchanged']
1280
aliases = ['ci', 'checkin']
1281
1282
# TODO: Give better message for -s, --summary, used by tla people
1283
1284
def run(self, message=None, file=None, verbose=True, selected_list=None,
1285
unchanged=False):
1286
from bzrlib.errors import PointlessCommit
1287
from bzrlib.osutils import get_text_message
1288
1289
## Warning: shadows builtin file()
1290
if not message and not file:
1291
# FIXME: Ugly; change status code to send to a provided function?
1292
1293
import cStringIO
1294
stdout = sys.stdout
1295
catcher = cStringIO.StringIO()
1296
sys.stdout = catcher
1297
cmd_status({"file_list":selected_list}, {})
1298
info = catcher.getvalue()
1299
sys.stdout = stdout
1300
message = get_text_message(info)
1301
1302
if message is None:
1303
raise BzrCommandError("please specify a commit message",
1304
["use either --message or --file"])
1305
elif message and file:
1306
raise BzrCommandError("please specify either --message or --file")
1307
1308
if file:
1309
import codecs
1310
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1311
1312
b = find_branch('.')
1313
if selected_list:
1314
selected_list = [b.relpath(s) for s in selected_list]
1315
1316
try:
1317
b.commit(message, verbose=verbose,
1318
specific_files=selected_list,
1319
allow_pointless=unchanged)
1320
except PointlessCommit:
1321
# FIXME: This should really happen before the file is read in;
1322
# perhaps prepare the commit; get the message; then actually commit
1323
raise BzrCommandError("no changes to commit",
1324
["use --unchanged to commit anyhow"])
1325
1326
1327
class cmd_check(Command):
1328
"""Validate consistency of branch history.
1329
1330
This command checks various invariants about the branch storage to
1331
detect data corruption or bzr bugs.
1332
1333
If given the --update flag, it will update some optional fields
1334
to help ensure data consistency.
1335
"""
1336
takes_args = ['dir?']
1337
1338
def run(self, dir='.'):
1339
from bzrlib.check import check
1340
check(find_branch(dir))
1341
1342
1343
1344
class cmd_scan_cache(Command):
1345
hidden = True
1346
def run(self):
1347
from bzrlib.hashcache import HashCache
1348
import os
1349
1350
c = HashCache('.')
1351
c.read()
1352
c.scan()
1353
1354
print '%6d stats' % c.stat_count
1355
print '%6d in hashcache' % len(c._cache)
1356
print '%6d files removed from cache' % c.removed_count
1357
print '%6d hashes updated' % c.update_count
1358
print '%6d files changed too recently to cache' % c.danger_count
1359
1360
if c.needs_write:
1361
c.write()
1362
1363
1364
1365
class cmd_upgrade(Command):
1366
"""Upgrade branch storage to current format.
1367
1368
This should normally be used only after the check command tells
1369
you to run it.
1370
"""
1371
takes_args = ['dir?']
1372
1373
def run(self, dir='.'):
1374
from bzrlib.upgrade import upgrade
1375
upgrade(find_branch(dir))
1376
1377
1378
1379
class cmd_whoami(Command):
1380
"""Show bzr user id."""
1381
takes_options = ['email']
1382
1383
def run(self, email=False):
1384
try:
1385
b = bzrlib.branch.find_branch('.')
1386
except:
1387
b = None
1388
1389
if email:
1390
print bzrlib.osutils.user_email(b)
1391
else:
1392
print bzrlib.osutils.username(b)
1393
1394
1395
class cmd_selftest(Command):
1396
"""Run internal test suite"""
1397
hidden = True
1398
takes_options = ['verbose']
1399
def run(self, verbose=False):
1400
from bzrlib.selftest import selftest
1401
return int(not selftest(verbose=verbose))
1402
1403
1404
class cmd_version(Command):
1405
"""Show version of bzr."""
1406
def run(self):
1407
show_version()
1408
1409
def show_version():
1410
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1411
# is bzrlib itself in a branch?
1412
bzrrev = bzrlib.get_bzr_revision()
1413
if bzrrev:
1414
print " (bzr checkout, revision %d {%s})" % bzrrev
1415
print bzrlib.__copyright__
1416
print "http://bazaar-ng.org/"
1417
print
1418
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1419
print "you may use, modify and redistribute it under the terms of the GNU"
1420
print "General Public License version 2 or later."
1421
1422
1423
class cmd_rocks(Command):
1424
"""Statement of optimism."""
1425
hidden = True
1426
def run(self):
1427
print "it sure does!"
253
raise NotImplementedError()
254
255
256
def help(self):
257
"""Return help message for this class."""
258
if self.__doc__ is Command.__doc__:
259
return None
260
return getdoc(self)
261
262
def name(self):
263
return _unsquish_command_name(self.__class__.__name__)
264
1428
265
1429
266
def parse_spec(spec):
1430
267
"""
1457
294
parsed = [spec, None]
1458
295
return parsed
1459
296
1460
1461
1462
class cmd_merge(Command):
1463
"""Perform a three-way merge.
1464
1465
The branch is the branch you will merge from. By default, it will merge
1466
the latest revision. If you specify a revision, that revision will be
1467
merged. If you specify two revisions, the first will be used as a BASE,
1468
and the second one as OTHER. Revision numbers are always relative to the
1469
specified branch.
1470
1471
Examples:
1472
1473
To merge the latest revision from bzr.dev
1474
bzr merge ../bzr.dev
1475
1476
To merge changes up to and including revision 82 from bzr.dev
1477
bzr merge -r 82 ../bzr.dev
1478
1479
To merge the changes introduced by 82, without previous changes:
1480
bzr merge -r 81..82 ../bzr.dev
1481
1482
merge refuses to run if there are any uncommitted changes, unless
1483
--force is given.
1484
"""
1485
takes_args = ['branch?']
1486
takes_options = ['revision', 'force', 'merge-type']
1487
1488
def run(self, branch='.', revision=None, force=False,
1489
merge_type=None):
1490
from bzrlib.merge import merge
1491
from bzrlib.merge_core import ApplyMerge3
1492
if merge_type is None:
1493
merge_type = ApplyMerge3
1494
1495
if revision is None or len(revision) < 1:
1496
base = (None, None)
1497
other = (branch, -1)
1498
else:
1499
if len(revision) == 1:
1500
other = (branch, revision[0])
1501
base = (None, None)
1502
else:
1503
assert len(revision) == 2
1504
if None in revision:
1505
raise BzrCommandError(
1506
"Merge doesn't permit that revision specifier.")
1507
base = (branch, revision[0])
1508
other = (branch, revision[1])
1509
1510
merge(other, base, check_clean=(not force), merge_type=merge_type)
1511
1512
1513
class cmd_revert(Command):
1514
"""Reverse all changes since the last commit.
1515
1516
Only versioned files are affected. Specify filenames to revert only
1517
those files. By default, any files that are changed will be backed up
1518
first. Backup files have a '~' appended to their name.
1519
"""
1520
takes_options = ['revision', 'no-backup']
1521
takes_args = ['file*']
1522
aliases = ['merge-revert']
1523
1524
def run(self, revision=None, no_backup=False, file_list=None):
1525
from bzrlib.merge import merge
1526
if file_list is not None:
1527
if len(file_list) == 0:
1528
raise BzrCommandError("No files specified")
1529
if revision is None:
1530
revision = [-1]
1531
elif len(revision) != 1:
1532
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1533
merge(('.', revision[0]), parse_spec('.'),
1534
check_clean=False,
1535
ignore_zero=True,
1536
backup_files=not no_backup,
1537
file_list=file_list)
1538
1539
1540
class cmd_assert_fail(Command):
1541
"""Test reporting of assertion failures"""
1542
hidden = True
1543
def run(self):
1544
assert False, "always fails"
1545
1546
1547
class cmd_help(Command):
1548
"""Show help on a command or other topic.
1549
1550
For a list of all available commands, say 'bzr help commands'."""
1551
takes_args = ['topic?']
1552
aliases = ['?']
1553
1554
def run(self, topic=None):
1555
import help
1556
help.help(topic)
1557
1558
1559
class cmd_shell_complete(Command):
1560
"""Show appropriate completions for context.
1561
1562
For a list of all available commands, say 'bzr shell-complete'."""
1563
takes_args = ['context?']
1564
aliases = ['s-c']
1565
hidden = True
1566
1567
def run(self, context=None):
1568
import shellcomplete
1569
shellcomplete.shellcomplete(context)
1570
1571
1572
class cmd_missing(Command):
1573
"""What is missing in this branch relative to other branch.
1574
"""
1575
takes_args = ['remote?']
1576
aliases = ['mis', 'miss']
1577
# We don't have to add quiet to the list, because
1578
# unknown options are parsed as booleans
1579
takes_options = ['verbose', 'quiet']
1580
1581
def run(self, remote=None, verbose=False, quiet=False):
1582
from bzrlib.branch import find_branch, DivergedBranches
1583
from bzrlib.errors import BzrCommandError
1584
from bzrlib.missing import get_parent, show_missing
1585
1586
if verbose and quiet:
1587
raise BzrCommandError('Cannot pass both quiet and verbose')
1588
1589
b = find_branch('.')
1590
parent = get_parent(b)
1591
if remote is None:
1592
if parent is None:
1593
raise BzrCommandError("No missing location known or specified.")
1594
else:
1595
if not quiet:
1596
print "Using last location: %s" % parent
1597
remote = parent
1598
elif parent is None:
1599
# We only update x-pull if it did not exist, missing should not change the parent
1600
b.controlfile('x-pull', 'wb').write(remote + '\n')
1601
br_remote = find_branch(remote)
1602
1603
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1604
1605
1606
class cmd_plugins(Command):
1607
"""List plugins"""
1608
hidden = True
1609
def run(self):
1610
import bzrlib.plugin
1611
from inspect import getdoc
1612
from pprint import pprint
1613
for plugin in bzrlib.plugin.all_plugins:
1614
print plugin.__path__[0]
1615
d = getdoc(plugin)
1616
if d:
1617
print '\t', d.split('\n')[0]
1618
1619
#pprint(bzrlib.plugin.all_plugins)
1620
1621
1622
1623
# list of all available options; the rhs can be either None for an
1624
# option that takes no argument, or a constructor function that checks
1625
# the type.
1626
OPTIONS = {
1627
'all': None,
1628
'diff-options': str,
1629
'help': None,
1630
'file': unicode,
1631
'force': None,
1632
'format': unicode,
1633
'forward': None,
1634
'message': unicode,
1635
'no-recurse': None,
1636
'profile': None,
1637
'revision': _parse_revision_str,
1638
'short': None,
1639
'show-ids': None,
1640
'timezone': str,
1641
'verbose': None,
1642
'version': None,
1643
'email': None,
1644
'unchanged': None,
1645
'update': None,
1646
'long': None,
1647
'root': str,
1648
'no-backup': None,
1649
'merge-type': get_merge_type,
1650
}
1651
1652
SHORT_OPTIONS = {
1653
'F': 'file',
1654
'h': 'help',
1655
'm': 'message',
1656
'r': 'revision',
1657
'v': 'verbose',
1658
'l': 'long',
1659
}
1660
1661
1662
def parse_args(argv):
297
def parse_args(command, argv, alias_argv=None):
1663
298
"""Parse command line.
1664
299
1665
300
Arguments and options are parsed at this level before being passed
1666
301
down to specific command handlers. This routine knows, from a
1667
302
lookup table, something about the available options, what optargs
1668
303
they take, and which commands will accept them.
1669
1670
>>> parse_args('--help'.split())
1671
([], {'help': True})
1672
>>> parse_args('--version'.split())
1673
([], {'version': True})
1674
>>> parse_args('status --all'.split())
1675
(['status'], {'all': True})
1676
>>> parse_args('commit --message=biter'.split())
1677
(['commit'], {'message': u'biter'})
1678
>>> parse_args('log -r 500'.split())
1679
(['log'], {'revision': [500]})
1680
>>> parse_args('log -r500..600'.split())
1681
(['log'], {'revision': [500, 600]})
1682
>>> parse_args('log -vr500..600'.split())
1683
(['log'], {'verbose': True, 'revision': [500, 600]})
1684
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1685
(['log'], {'revision': ['v500', 600]})
1686
304
"""
305
# TODO: chop up this beast; make it a method of the Command
1687
306
args = []
1688
307
opts = {}
1689
1690
# TODO: Maybe handle '--' to end options?
1691
1692
while argv:
1693
a = argv.pop(0)
1694
if a[0] == '-':
1695
# option names must not be unicode
1696
a = str(a)
1697
optarg = None
1698
if a[1] == '-':
1699
mutter(" got option %r" % a)
1700
if '=' in a:
1701
optname, optarg = a[2:].split('=', 1)
1702
else:
1703
optname = a[2:]
1704
if optname not in OPTIONS:
1705
raise BzrError('unknown long option %r' % a)
1706
else:
1707
shortopt = a[1:]
1708
if shortopt in SHORT_OPTIONS:
1709
# Multi-character options must have a space to delimit
1710
# their value
1711
optname = SHORT_OPTIONS[shortopt]
1712
else:
1713
# Single character short options, can be chained,
1714
# and have their value appended to their name
1715
shortopt = a[1:2]
1716
if shortopt not in SHORT_OPTIONS:
1717
# We didn't find the multi-character name, and we
1718
# didn't find the single char name
1719
raise BzrError('unknown short option %r' % a)
1720
optname = SHORT_OPTIONS[shortopt]
1721
1722
if a[2:]:
1723
# There are extra things on this option
1724
# see if it is the value, or if it is another
1725
# short option
1726
optargfn = OPTIONS[optname]
1727
if optargfn is None:
1728
# This option does not take an argument, so the
1729
# next entry is another short option, pack it back
1730
# into the list
1731
argv.insert(0, '-' + a[2:])
308
alias_opts = {}
309
310
cmd_options = command.options()
311
argsover = False
312
proc_aliasarg = True # Are we processing alias_argv now?
313
for proc_argv in alias_argv, argv:
314
while proc_argv:
315
a = proc_argv.pop(0)
316
if argsover:
317
args.append(a)
318
continue
319
elif a == '--':
320
# We've received a standalone -- No more flags
321
argsover = True
322
continue
323
if a[0] == '-':
324
# option names must not be unicode
325
a = str(a)
326
optarg = None
327
if a[1] == '-':
328
mutter(" got option %r", a)
329
if '=' in a:
330
optname, optarg = a[2:].split('=', 1)
331
else:
332
optname = a[2:]
333
if optname not in cmd_options:
334
raise BzrOptionError('unknown long option %r for'
335
' command %s' %
336
(a, command.name()))
337
else:
338
shortopt = a[1:]
339
if shortopt in Option.SHORT_OPTIONS:
340
# Multi-character options must have a space to delimit
341
# their value
342
# ^^^ what does this mean? mbp 20051014
343
optname = Option.SHORT_OPTIONS[shortopt].name
344
else:
345
# Single character short options, can be chained,
346
# and have their value appended to their name
347
shortopt = a[1:2]
348
if shortopt not in Option.SHORT_OPTIONS:
349
# We didn't find the multi-character name, and we
350
# didn't find the single char name
351
raise BzrError('unknown short option %r' % a)
352
optname = Option.SHORT_OPTIONS[shortopt].name
353
354
if a[2:]:
355
# There are extra things on this option
356
# see if it is the value, or if it is another
357
# short option
358
optargfn = Option.OPTIONS[optname].type
359
if optargfn is None:
360
# This option does not take an argument, so the
361
# next entry is another short option, pack it
362
# back into the list
363
proc_argv.insert(0, '-' + a[2:])
364
else:
365
# This option takes an argument, so pack it
366
# into the array
367
optarg = a[2:]
368
369
if optname not in cmd_options:
370
raise BzrOptionError('unknown short option %r for'
371
' command %s' %
372
(shortopt, command.name()))
373
if optname in opts:
374
# XXX: Do we ever want to support this, e.g. for -r?
375
if proc_aliasarg:
376
raise BzrError('repeated option %r' % a)
377
elif optname in alias_opts:
378
# Replace what's in the alias with what's in the real
379
# argument
380
del alias_opts[optname]
381
del opts[optname]
382
proc_argv.insert(0, a)
383
continue
384
else:
385
raise BzrError('repeated option %r' % a)
386
387
option_obj = cmd_options[optname]
388
optargfn = option_obj.type
389
if optargfn:
390
if optarg == None:
391
if not proc_argv:
392
raise BzrError('option %r needs an argument' % a)
1732
393
else:
1733
# This option takes an argument, so pack it
1734
# into the array
1735
optarg = a[2:]
1736
1737
if optname in opts:
1738
# XXX: Do we ever want to support this, e.g. for -r?
1739
raise BzrError('repeated option %r' % a)
1740
1741
optargfn = OPTIONS[optname]
1742
if optargfn:
1743
if optarg == None:
1744
if not argv:
1745
raise BzrError('option %r needs an argument' % a)
1746
else:
1747
optarg = argv.pop(0)
1748
opts[optname] = optargfn(optarg)
394
optarg = proc_argv.pop(0)
395
opts[optname] = optargfn(optarg)
396
if proc_aliasarg:
397
alias_opts[optname] = optargfn(optarg)
398
else:
399
if optarg != None:
400
raise BzrError('option %r takes no argument' % optname)
401
opts[optname] = True
402
if proc_aliasarg:
403
alias_opts[optname] = True
1749
404
else:
1750
if optarg != None:
1751
raise BzrError('option %r takes no argument' % optname)
1752
opts[optname] = True
1753
else:
1754
args.append(a)
1755
405
args.append(a)
406
proc_aliasarg = False # Done with alias argv
1756
407
return args, opts
1757
408
1758
409
1759
1760
1761
410
def _match_argform(cmd, takes_args, args):
1762
411
argdict = {}
1763
412
1803
452
1804
453
1805
454
455
def apply_profiled(the_callable, *args, **kwargs):
456
import hotshot
457
import tempfile
458
import hotshot.stats
459
pffileno, pfname = tempfile.mkstemp()
460
try:
461
prof = hotshot.Profile(pfname)
462
try:
463
ret = prof.runcall(the_callable, *args, **kwargs) or 0
464
finally:
465
prof.close()
466
stats = hotshot.stats.load(pfname)
467
stats.strip_dirs()
468
stats.sort_stats('cum') # 'time'
469
## XXX: Might like to write to stderr or the trace file instead but
470
## print_stats seems hardcoded to stdout
471
stats.print_stats(20)
472
return ret
473
finally:
474
os.close(pffileno)
475
os.remove(pfname)
476
477
478
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
479
from bzrlib.lsprof import profile
480
import cPickle
481
ret, stats = profile(the_callable, *args, **kwargs)
482
stats.sort()
483
if filename is None:
484
stats.pprint()
485
else:
486
stats.freeze()
487
cPickle.dump(stats, open(filename, 'w'), 2)
488
print 'Profile data written to %r.' % filename
489
return ret
490
491
492
def get_alias(cmd):
493
"""Return an expanded alias, or None if no alias exists"""
494
import bzrlib.config
495
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
496
if (alias):
497
return alias.split(' ')
498
return None
499
500
1806
501
def run_bzr(argv):
1807
502
"""Execute a command.
1808
503
1820
515
--no-plugins
1821
516
Do not load plugin modules at all
1822
517
518
--no-aliases
519
Do not allow aliases
520
1823
521
--builtin
1824
522
Only use builtin commands. (Plugins are still allowed to change
1825
523
other behaviour.)
1826
524
1827
525
--profile
1828
Run under the Python profiler.
526
Run under the Python hotshot profiler.
527
528
--lsprof
529
Run under the Python lsprof profiler.
1829
530
"""
1830
1831
531
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1832
532
1833
opt_profile = opt_no_plugins = opt_builtin = False
533
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
534
opt_no_aliases = False
535
opt_lsprof_file = None
1834
536
1835
537
# --no-plugins is handled specially at a very early stage. We need
1836
538
# to load plugins before doing other command parsing so that they
1837
539
# can override commands, but this needs to happen first.
1838
540
1839
for a in argv[:]:
541
argv_copy = []
542
i = 0
543
while i < len(argv):
544
a = argv[i]
1840
545
if a == '--profile':
1841
546
opt_profile = True
547
elif a == '--lsprof':
548
opt_lsprof = True
549
elif a == '--lsprof-file':
550
opt_lsprof_file = argv[i + 1]
551
i += 1
1842
552
elif a == '--no-plugins':
1843
553
opt_no_plugins = True
554
elif a == '--no-aliases':
555
opt_no_aliases = True
1844
556
elif a == '--builtin':
1845
557
opt_builtin = True
1846
else:
1847
break
1848
argv.remove(a)
1849
558
elif a in ('--quiet', '-q'):
559
be_quiet()
560
else:
561
argv_copy.append(a)
562
i += 1
563
564
argv = argv_copy
565
if (not argv) or (argv[0] == '--help'):
566
from bzrlib.help import help
567
if len(argv) > 1:
568
help(argv[1])
569
else:
570
help()
571
return 0
572
573
if argv[0] == '--version':
574
from bzrlib.builtins import show_version
575
show_version()
576
return 0
577
1850
578
if not opt_no_plugins:
1851
579
from bzrlib.plugin import load_plugins
1852
580
load_plugins()
1853
1854
args, opts = parse_args(argv)
1855
1856
if 'help' in opts:
1857
from bzrlib.help import help
1858
if args:
1859
help(args[0])
581
else:
582
from bzrlib.plugin import disable_plugins
583
disable_plugins()
584
585
alias_argv = None
586
587
if not opt_no_aliases:
588
alias_argv = get_alias(argv[0])
589
if alias_argv:
590
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
591
argv[0] = alias_argv.pop(0)
592
593
cmd = str(argv.pop(0))
594
595
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
596
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
597
run = cmd_obj.run_argv
598
run_argv = [argv]
599
else:
600
run = cmd_obj.run_argv_aliases
601
run_argv = [argv, alias_argv]
602
603
try:
604
if opt_lsprof:
605
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
606
elif opt_profile:
607
ret = apply_profiled(run, *run_argv)
1860
608
else:
1861
help()
1862
return 0
1863
1864
if 'version' in opts:
1865
show_version()
1866
return 0
1867
1868
if not args:
1869
print >>sys.stderr, "please try 'bzr help' for help"
1870
return 1
1871
1872
cmd = str(args.pop(0))
1873
1874
canonical_cmd, cmd_class = \
1875
get_cmd_class(cmd, plugins_override=not opt_builtin)
1876
1877
# check options are reasonable
1878
allowed = cmd_class.takes_options
1879
for oname in opts:
1880
if oname not in allowed:
1881
raise BzrCommandError("option '--%s' is not allowed for command %r"
1882
% (oname, cmd))
1883
1884
# mix arguments and options into one dictionary
1885
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1886
cmdopts = {}
1887
for k, v in opts.items():
1888
cmdopts[k.replace('-', '_')] = v
1889
1890
if opt_profile:
1891
import hotshot, tempfile
1892
pffileno, pfname = tempfile.mkstemp()
609
ret = run(*run_argv)
610
return ret or 0
611
finally:
612
# reset, in case we may do other commands later within the same process
613
be_quiet(False)
614
615
def display_command(func):
616
"""Decorator that suppresses pipe/interrupt errors."""
617
def ignore_pipe(*args, **kwargs):
1893
618
try:
1894
prof = hotshot.Profile(pfname)
1895
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1896
prof.close()
1897
1898
import hotshot.stats
1899
stats = hotshot.stats.load(pfname)
1900
#stats.strip_dirs()
1901
stats.sort_stats('time')
1902
## XXX: Might like to write to stderr or the trace file instead but
1903
## print_stats seems hardcoded to stdout
1904
stats.print_stats(20)
1905
1906
return ret.status
1907
1908
finally:
1909
os.close(pffileno)
1910
os.remove(pfname)
1911
else:
1912
return cmd_class(cmdopts, cmdargs).status
1913
1914
1915
def _report_exception(summary, quiet=False):
1916
import traceback
1917
1918
log_error('bzr: ' + summary)
1919
bzrlib.trace.log_exception()
1920
1921
if os.environ.get('BZR_DEBUG'):
1922
traceback.print_exc()
1923
1924
if not quiet:
1925
sys.stderr.write('\n')
1926
tb = sys.exc_info()[2]
1927
exinfo = traceback.extract_tb(tb)
1928
if exinfo:
1929
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1930
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1931
619
result = func(*args, **kwargs)
620
sys.stdout.flush()
621
return result
622
except IOError, e:
623
if not hasattr(e, 'errno'):
624
raise
625
if e.errno != errno.EPIPE:
626
raise
627
pass
628
except KeyboardInterrupt:
629
pass
630
return ignore_pipe
1932
631
1933
632
1934
633
def main(argv):
1935
1936
bzrlib.trace.open_tracefile(argv)
1937
634
import bzrlib.ui
635
from bzrlib.ui.text import TextUIFactory
636
## bzrlib.trace.enable_default_logging()
637
bzrlib.trace.log_startup(argv)
638
bzrlib.ui.ui_factory = TextUIFactory()
639
ret = run_bzr_catch_errors(argv[1:])
640
mutter("return code %d", ret)
641
return ret
642
643
644
def run_bzr_catch_errors(argv):
1938
645
try:
1939
646
try:
1940
try:
1941
return run_bzr(argv[1:])
1942
finally:
1943
# do this here inside the exception wrappers to catch EPIPE
1944
sys.stdout.flush()
1945
except BzrError, e:
1946
quiet = isinstance(e, (BzrCommandError))
1947
_report_exception('error: ' + str(e), quiet=quiet)
1948
if len(e.args) > 1:
1949
for h in e.args[1]:
1950
# some explanation or hints
1951
log_error(' ' + h)
1952
return 1
1953
except AssertionError, e:
1954
msg = 'assertion failed'
1955
if str(e):
1956
msg += ': ' + str(e)
1957
_report_exception(msg)
1958
return 2
1959
except KeyboardInterrupt, e:
1960
_report_exception('interrupted', quiet=True)
1961
return 2
1962
except Exception, e:
1963
import errno
1964
quiet = False
1965
if (isinstance(e, IOError)
1966
and hasattr(e, 'errno')
1967
and e.errno == errno.EPIPE):
1968
quiet = True
1969
msg = 'broken pipe'
1970
else:
1971
msg = str(e).rstrip('\n')
1972
_report_exception(msg, quiet)
1973
return 2
1974
finally:
1975
bzrlib.trace.close_trace()
1976
647
return run_bzr(argv)
648
finally:
649
# do this here inside the exception wrappers to catch EPIPE
650
sys.stdout.flush()
651
except Exception, e:
652
# used to handle AssertionError and KeyboardInterrupt
653
# specially here, but hopefully they're handled ok by the logger now
654
import errno
655
if (isinstance(e, IOError)
656
and hasattr(e, 'errno')
657
and e.errno == errno.EPIPE):
658
bzrlib.trace.note('broken pipe')
659
return 3
660
else:
661
bzrlib.trace.log_exception()
662
if os.environ.get('BZR_PDB'):
663
print '**** entering debugger'
664
import pdb
665
pdb.post_mortem(sys.exc_traceback)
666
return 3
1977
667
1978
668
if __name__ == '__main__':
1979
669
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1