« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1464.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1464.1.1
- Committer: Robert Collins
- Date: 2005-10-19 10:11:57 UTC
- mfrom: (1185.16.78)
- mto: This revision was merged to the branch mainline in revision 1470.
- Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream
- files added:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- tools
- files removed:
- bzrlib/remotebranch.py
- files renamed:
- bzrlib/selftest.py => bzrlib/selftest/__init__.py
- bzrlib/blackbox.py => bzrlib/selftest/blackbox.py
- bzrlib/whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/newinventory.py => contrib/newinventory.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
19
import sys, os
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
20
34
21
35
import bzrlib
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
26
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
from bzrlib.option import Option
42
43
plugin_cmds = {}
44
45
46
def register_command(cmd):
47
"Utility function to help register a command"
48
global plugin_cmds
49
k = cmd.__name__
50
if k.startswith("cmd_"):
51
k_unsquished = _unsquish_command_name(k)
52
else:
53
k_unsquished = k
54
if not plugin_cmds.has_key(k_unsquished):
55
plugin_cmds[k_unsquished] = cmd
56
mutter('registered plugin command %s', k_unsquished)
57
else:
58
log_error('Two plugins defined the same command: %r' % k)
59
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
27
60
28
61
29
62
def _squish_command_name(cmd):
34
67
assert cmd.startswith("cmd_")
35
68
return cmd[4:].replace('_','-')
36
69
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
39
40
There are several possibilities:
41
42
'234' -> 234
43
'234:345' -> [234, 345]
44
':234' -> [None, 234]
45
'234:' -> [234, None]
46
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
50
potentially:
51
'tag:mytag' -> ?
52
"""
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
55
if len(revs) > 2:
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
57
58
if not revs[0]:
59
revs[0] = None
60
else:
61
revs[0] = int(revs[0])
62
63
if not revs[1]:
64
revs[1] = None
65
else:
66
revs[1] = int(revs[1])
67
else:
68
revs = int(revstr)
69
return revs
70
71
def _find_plugins():
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
74
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
70
71
def _builtin_commands():
72
import bzrlib.builtins
73
r = {}
74
builtins = bzrlib.builtins.__dict__
75
for name in builtins:
76
if name.startswith("cmd_"):
77
real_name = _unsquish_command_name(name)
78
r[real_name] = builtins[name]
79
return r
80
81
82
83
def builtin_command_names():
84
"""Return list of builtin command names."""
85
return _builtin_commands().keys()
79
86
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
82
"""
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
84
85
plugin_cmds = {}
86
if not bzrpath:
87
return plugin_cmds
88
_platform_extensions = {
89
'win32':'.pyd',
90
'cygwin':'.dll',
91
'darwin':'.dylib',
92
'linux2':'.so'
93
}
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
96
else:
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
102
f = f[:-3]
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
104
f = f[:-4]
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
109
else:
110
continue
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
113
114
plugin_names = plugin_names.keys()
115
plugin_names.sort()
116
try:
117
sys.path.insert(0, d)
118
for name in plugin_names:
119
try:
120
old_module = None
121
try:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
131
else:
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
134
finally:
135
if old_module:
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
139
finally:
140
sys.path.pop(0)
141
return plugin_cmds
142
143
def _get_cmd_dict(include_plugins=True):
144
d = {}
145
for k, v in globals().iteritems():
146
if k.startswith("cmd_"):
147
d[_unsquish_command_name(k)] = v
148
if include_plugins:
149
d.update(_find_plugins())
87
88
def plugin_command_names():
89
return plugin_cmds.keys()
90
91
92
def _get_cmd_dict(plugins_override=True):
93
"""Return name->class mapping for all commands."""
94
d = _builtin_commands()
95
if plugins_override:
96
d.update(plugin_cmds)
150
97
return d
98
151
99
152
def get_all_cmds(include_plugins=True):
100
def get_all_cmds(plugins_override=True):
153
101
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
102
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
155
103
yield k,v
156
104
157
105
158
def get_cmd_class(cmd,include_plugins=True):
106
def get_cmd_object(cmd_name, plugins_override=True):
159
107
"""Return the canonical name and command class for a command.
108
109
plugins_override
110
If true, plugin commands can override builtins.
160
111
"""
161
cmd = str(cmd) # not unicode
112
from bzrlib.externalcommand import ExternalCommand
113
114
cmd_name = str(cmd_name) # not unicode
162
115
163
116
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
165
118
try:
166
return cmd, cmds[cmd]
119
return cmds[cmd_name]()
167
120
except KeyError:
168
121
pass
169
122
170
123
# look for any command which claims this as an alias
171
for cmdname, cmdclass in cmds.iteritems():
172
if cmd in cmdclass.aliases:
173
return cmdname, cmdclass
174
175
cmdclass = ExternalCommand.find_command(cmd)
176
if cmdclass:
177
return cmd, cmdclass
178
179
raise BzrCommandError("unknown command %r" % cmd)
124
for real_cmd_name, cmd_class in cmds.iteritems():
125
if cmd_name in cmd_class.aliases:
126
return cmd_class()
127
128
cmd_obj = ExternalCommand.find_command(cmd_name)
129
if cmd_obj:
130
return cmd_obj
131
132
raise BzrCommandError("unknown command %r" % cmd_name)
180
133
181
134
182
135
class Command(object):
183
136
"""Base class for commands.
184
137
138
Commands are the heart of the command-line bzr interface.
139
140
The command object mostly handles the mapping of command-line
141
parameters into one or more bzrlib operations, and of the results
142
into textual output.
143
144
Commands normally don't have any state. All their arguments are
145
passed in to the run method. (Subclasses may take a different
146
policy if the behaviour of the instance needs to depend on e.g. a
147
shell plugin and not just its Python class.)
148
185
149
The docstring for an actual command should give a single-line
186
150
summary, then a complete description of the command. A grammar
187
151
description will be inserted.
188
152
153
aliases
154
Other accepted names for this command.
155
189
156
takes_args
190
157
List of argument forms, marked with whether they are optional,
191
158
repeated, etc.
192
159
193
160
takes_options
194
List of options that may be given for this command.
161
List of options that may be given for this command. These can
162
be either strings, referring to globally-defined options,
163
or option objects. Retrieve through options().
195
164
196
165
hidden
197
If true, this command isn't advertised.
166
If true, this command isn't advertised. This is typically
167
for commands intended for expert users.
198
168
"""
199
169
aliases = []
200
201
170
takes_args = []
202
171
takes_options = []
203
172
204
173
hidden = False
205
174
206
def __init__(self, options, arguments):
207
"""Construct and run the command.
208
209
Sets self.status to the return value of run()."""
210
assert isinstance(options, dict)
211
assert isinstance(arguments, dict)
212
cmdargs = options.copy()
213
cmdargs.update(arguments)
214
assert self.__doc__ != Command.__doc__, \
215
("No help message set for %r" % self)
216
self.status = self.run(**cmdargs)
175
def __init__(self):
176
"""Construct an instance of this command."""
177
if self.__doc__ == Command.__doc__:
178
warn("No help message set for %r" % self)
179
180
def options(self):
181
"""Return dict of valid options for this command.
182
183
Maps from long option name to option object."""
184
r = dict()
185
r['help'] = Option.OPTIONS['help']
186
for o in self.takes_options:
187
if not isinstance(o, Option):
188
o = Option.OPTIONS[o]
189
r[o.name] = o
190
return r
191
192
def run_argv(self, argv):
193
"""Parse command line and run."""
194
args, opts = parse_args(self, argv)
195
if 'help' in opts: # e.g. bzr add --help
196
from bzrlib.help import help_on_command
197
help_on_command(self.name())
198
return 0
199
# XXX: This should be handled by the parser
200
allowed_names = self.options().keys()
201
for oname in opts:
202
if oname not in allowed_names:
203
raise BzrCommandError("option '--%s' is not allowed for command %r"
204
% (oname, self.name()))
205
# mix arguments and options into one dictionary
206
cmdargs = _match_argform(self.name(), self.takes_args, args)
207
cmdopts = {}
208
for k, v in opts.items():
209
cmdopts[k.replace('-', '_')] = v
210
211
all_cmd_args = cmdargs.copy()
212
all_cmd_args.update(cmdopts)
213
214
return self.run(**all_cmd_args)
217
215
218
216
219
217
def run(self):
220
"""Override this in sub-classes.
218
"""Actually run the command.
221
219
222
220
This is invoked with the options and arguments bound to
223
221
keyword parameters.
224
222
225
Return 0 or None if the command was successful, or a shell
226
error code if not.
223
Return 0 or None if the command was successful, or a non-zero
224
shell error code if not. It's OK for this method to allow
225
an exception to raise up.
227
226
"""
228
return 0
229
230
231
class ExternalCommand(Command):
232
"""Class to wrap external commands.
233
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
236
specified command.
237
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
241
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
244
"""
245
246
def find_command(cls, cmd):
247
import os.path
248
bzrpath = os.environ.get('BZRPATH', '')
249
250
for dir in bzrpath.split(os.pathsep):
251
path = os.path.join(dir, cmd)
252
if os.path.isfile(path):
253
return ExternalCommand(path)
254
255
return None
256
257
find_command = classmethod(find_command)
258
259
def __init__(self, path):
260
self.path = path
261
262
pipe = os.popen('%s --bzr-usage' % path, 'r')
263
self.takes_options = pipe.readline().split()
264
265
for opt in self.takes_options:
266
if not opt in OPTIONS:
267
raise BzrError("Unknown option '%s' returned by external command %s"
268
% (opt, path))
269
270
# TODO: Is there any way to check takes_args is valid here?
271
self.takes_args = pipe.readline().split()
272
273
if pipe.close() is not None:
274
raise BzrError("Failed funning '%s --bzr-usage'" % path)
275
276
pipe = os.popen('%s --bzr-help' % path, 'r')
277
self.__doc__ = pipe.read()
278
if pipe.close() is not None:
279
raise BzrError("Failed funning '%s --bzr-help'" % path)
280
281
def __call__(self, options, arguments):
282
Command.__init__(self, options, arguments)
283
return self
284
285
def run(self, **kargs):
286
opts = []
287
args = []
288
289
keys = kargs.keys()
290
keys.sort()
291
for name in keys:
292
optname = name.replace('_','-')
293
value = kargs[name]
294
if OPTIONS.has_key(optname):
295
# it's an option
296
opts.append('--%s' % optname)
297
if value is not None and value is not True:
298
opts.append(str(value))
299
else:
300
# it's an arg, or arg list
301
if type(value) is not list:
302
value = [value]
303
for v in value:
304
if v is not None:
305
args.append(str(v))
306
307
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
308
return self.status
309
310
311
class cmd_status(Command):
312
"""Display status summary.
313
314
This reports on versioned and unknown files, reporting them
315
grouped by state. Possible states are:
316
317
added
318
Versioned in the working copy but not in the previous revision.
319
320
removed
321
Versioned in the previous revision but removed or deleted
322
in the working copy.
323
324
renamed
325
Path of this file changed from the previous revision;
326
the text may also have changed. This includes files whose
327
parent directory was renamed.
328
329
modified
330
Text has changed since the previous revision.
331
332
unchanged
333
Nothing about this file has changed since the previous revision.
334
Only shown with --all.
335
336
unknown
337
Not versioned and not matching an ignore pattern.
338
339
To see ignored files use 'bzr ignored'. For details in the
340
changes to file texts, use 'bzr diff'.
341
342
If no arguments are specified, the status of the entire working
343
directory is shown. Otherwise, only the status of the specified
344
files or directories is reported. If a directory is given, status
345
is reported for everything inside that directory.
346
"""
347
takes_args = ['file*']
348
takes_options = ['all', 'show-ids']
349
aliases = ['st', 'stat']
350
351
def run(self, all=False, show_ids=False, file_list=None):
352
if file_list:
353
b = Branch(file_list[0])
354
file_list = [b.relpath(x) for x in file_list]
355
# special case: only one path was given and it's the root
356
# of the branch
357
if file_list == ['']:
358
file_list = None
359
else:
360
b = Branch('.')
361
import status
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
364
365
366
class cmd_cat_revision(Command):
367
"""Write out metadata for a revision."""
368
369
hidden = True
370
takes_args = ['revision_id']
371
372
def run(self, revision_id):
373
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
374
375
376
class cmd_revno(Command):
377
"""Show current revision number.
378
379
This is equal to the number of revisions on this branch."""
380
def run(self):
381
print Branch('.').revno()
382
383
384
class cmd_add(Command):
385
"""Add specified files or directories.
386
387
In non-recursive mode, all the named items are added, regardless
388
of whether they were previously ignored. A warning is given if
389
any of the named files are already versioned.
390
391
In recursive mode (the default), files are treated the same way
392
but the behaviour for directories is different. Directories that
393
are already versioned do not give a warning. All directories,
394
whether already versioned or not, are searched for files or
395
subdirectories that are neither versioned or ignored, and these
396
are added. This search proceeds recursively into versioned
397
directories.
398
399
Therefore simply saying 'bzr add .' will version all files that
400
are currently unknown.
401
402
TODO: Perhaps adding a file whose directly is not versioned should
403
recursively add that parent, rather than giving an error?
404
"""
405
takes_args = ['file+']
406
takes_options = ['verbose', 'no-recurse']
407
408
def run(self, file_list, verbose=False, no_recurse=False):
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
410
411
412
class cmd_relpath(Command):
413
"""Show path of a file relative to root"""
414
takes_args = ['filename']
415
hidden = True
416
417
def run(self, filename):
418
print Branch(filename).relpath(filename)
419
420
421
422
class cmd_inventory(Command):
423
"""Show inventory of the current working copy or a revision."""
424
takes_options = ['revision', 'show-ids']
425
426
def run(self, revision=None, show_ids=False):
427
b = Branch('.')
428
if revision == None:
429
inv = b.read_working_inventory()
430
else:
431
inv = b.get_revision_inventory(b.lookup_revision(revision))
432
433
for path, entry in inv.entries():
434
if show_ids:
435
print '%-50s %s' % (path, entry.file_id)
436
else:
437
print path
438
439
440
class cmd_move(Command):
441
"""Move files to a different directory.
442
443
examples:
444
bzr move *.txt doc
445
446
The destination must be a versioned directory in the same branch.
447
"""
448
takes_args = ['source$', 'dest']
449
def run(self, source_list, dest):
450
b = Branch('.')
451
452
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
453
454
455
class cmd_rename(Command):
456
"""Change the name of an entry.
457
458
examples:
459
bzr rename frob.c frobber.c
460
bzr rename src/frob.c lib/frob.c
461
462
It is an error if the destination name exists.
463
464
See also the 'move' command, which moves files into a different
465
directory without changing their name.
466
467
TODO: Some way to rename multiple files without invoking bzr for each
468
one?"""
469
takes_args = ['from_name', 'to_name']
470
471
def run(self, from_name, to_name):
472
b = Branch('.')
473
b.rename_one(b.relpath(from_name), b.relpath(to_name))
474
475
476
477
478
479
class cmd_pull(Command):
480
"""Pull any changes from another branch into the current one.
481
482
If the location is omitted, the last-used location will be used.
483
Both the revision history and the working directory will be
484
updated.
485
486
This command only works on branches that have not diverged. Branches are
487
considered diverged if both branches have had commits without first
488
pulling from the other.
489
490
If branches have diverged, you can use 'bzr merge' to pull the text changes
491
from one into the other.
492
"""
493
takes_args = ['location?']
494
495
def run(self, location=None):
496
from bzrlib.merge import merge
497
import errno
498
499
br_to = Branch('.')
500
stored_loc = None
501
try:
502
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
503
except IOError, e:
504
if errno == errno.ENOENT:
505
raise
506
if location is None:
507
location = stored_loc
508
if location is None:
509
raise BzrCommandError("No pull location known or specified.")
510
from branch import find_branch, DivergedBranches
511
br_from = find_branch(location)
512
location = pull_loc(br_from)
513
old_revno = br_to.revno()
514
try:
515
br_to.update_revisions(br_from)
516
except DivergedBranches:
517
raise BzrCommandError("These branches have diverged. Try merge.")
518
519
merge(('.', -1), ('.', old_revno), check_clean=False)
520
if location != stored_loc:
521
br_to.controlfile("x-pull", "wb").write(location + "\n")
522
523
524
525
class cmd_branch(Command):
526
"""Create a new copy of a branch.
527
528
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
529
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
530
531
To retrieve the branch as of a particular revision, supply the --revision
532
parameter, as in "branch foo/bar -r 5".
533
"""
534
takes_args = ['from_location', 'to_location?']
535
takes_options = ['revision']
536
537
def run(self, from_location, to_location=None, revision=None):
538
import errno
539
from bzrlib.merge import merge
540
from branch import find_branch, DivergedBranches, NoSuchRevision
541
from shutil import rmtree
542
try:
543
br_from = find_branch(from_location)
544
except OSError, e:
545
if e.errno == errno.ENOENT:
546
raise BzrCommandError('Source location "%s" does not exist.' %
547
to_location)
548
else:
549
raise
550
551
if to_location is None:
552
to_location = os.path.basename(from_location.rstrip("/\\"))
553
554
try:
555
os.mkdir(to_location)
556
except OSError, e:
557
if e.errno == errno.EEXIST:
558
raise BzrCommandError('Target directory "%s" already exists.' %
559
to_location)
560
if e.errno == errno.ENOENT:
561
raise BzrCommandError('Parent of "%s" does not exist.' %
562
to_location)
563
else:
564
raise
565
br_to = Branch(to_location, init=True)
566
567
try:
568
br_to.update_revisions(br_from, stop_revision=revision)
569
except NoSuchRevision:
570
rmtree(to_location)
571
msg = "The branch %s has no revision %d." % (from_location,
572
revision)
573
raise BzrCommandError(msg)
574
merge((to_location, -1), (to_location, 0), this_dir=to_location,
575
check_clean=False, ignore_zero=True)
576
from_location = pull_loc(br_from)
577
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
578
579
580
def pull_loc(branch):
581
# TODO: Should perhaps just make attribute be 'base' in
582
# RemoteBranch and Branch?
583
if hasattr(branch, "baseurl"):
584
return branch.baseurl
585
else:
586
return branch.base
587
588
589
590
class cmd_renames(Command):
591
"""Show list of renamed files.
592
593
TODO: Option to show renames between two historical versions.
594
595
TODO: Only show renames under dir, rather than in the whole branch.
596
"""
597
takes_args = ['dir?']
598
599
def run(self, dir='.'):
600
b = Branch(dir)
601
old_inv = b.basis_tree().inventory
602
new_inv = b.read_working_inventory()
603
604
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
605
renames.sort()
606
for old_name, new_name in renames:
607
print "%s => %s" % (old_name, new_name)
608
609
610
class cmd_info(Command):
611
"""Show statistical information about a branch."""
612
takes_args = ['branch?']
613
614
def run(self, branch=None):
615
import info
616
617
from branch import find_branch
618
b = find_branch(branch)
619
info.show_info(b)
620
621
622
class cmd_remove(Command):
623
"""Make a file unversioned.
624
625
This makes bzr stop tracking changes to a versioned file. It does
626
not delete the working copy.
627
"""
628
takes_args = ['file+']
629
takes_options = ['verbose']
630
631
def run(self, file_list, verbose=False):
632
b = Branch(file_list[0])
633
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
634
635
636
class cmd_file_id(Command):
637
"""Print file_id of a particular file or directory.
638
639
The file_id is assigned when the file is first added and remains the
640
same through all revisions where the file exists, even when it is
641
moved or renamed.
642
"""
643
hidden = True
644
takes_args = ['filename']
645
def run(self, filename):
646
b = Branch(filename)
647
i = b.inventory.path2id(b.relpath(filename))
648
if i == None:
649
raise BzrError("%r is not a versioned file" % filename)
650
else:
651
print i
652
653
654
class cmd_file_path(Command):
655
"""Print path of file_ids to a file or directory.
656
657
This prints one line for each directory down to the target,
658
starting at the branch root."""
659
hidden = True
660
takes_args = ['filename']
661
def run(self, filename):
662
b = Branch(filename)
663
inv = b.inventory
664
fid = inv.path2id(b.relpath(filename))
665
if fid == None:
666
raise BzrError("%r is not a versioned file" % filename)
667
for fip in inv.get_idpath(fid):
668
print fip
669
670
671
class cmd_revision_history(Command):
672
"""Display list of revision ids on this branch."""
673
hidden = True
674
def run(self):
675
for patchid in Branch('.').revision_history():
676
print patchid
677
678
679
class cmd_directories(Command):
680
"""Display list of versioned directories in this branch."""
681
def run(self):
682
for name, ie in Branch('.').read_working_inventory().directories():
683
if name == '':
684
print '.'
685
else:
686
print name
687
688
689
class cmd_init(Command):
690
"""Make a directory into a versioned branch.
691
692
Use this to create an empty branch, or before importing an
693
existing project.
694
695
Recipe for importing a tree of files:
696
cd ~/project
697
bzr init
698
bzr add -v .
699
bzr status
700
bzr commit -m 'imported project'
701
"""
702
def run(self):
703
Branch('.', init=True)
704
705
706
class cmd_diff(Command):
707
"""Show differences in working tree.
708
709
If files are listed, only the changes in those files are listed.
710
Otherwise, all changes for the tree are listed.
711
712
TODO: Given two revision arguments, show the difference between them.
713
714
TODO: Allow diff across branches.
715
716
TODO: Option to use external diff command; could be GNU diff, wdiff,
717
or a graphical diff.
718
719
TODO: Python difflib is not exactly the same as unidiff; should
720
either fix it up or prefer to use an external diff.
721
722
TODO: If a directory is given, diff everything under that.
723
724
TODO: Selected-file diff is inefficient and doesn't show you
725
deleted files.
726
727
TODO: This probably handles non-Unix newlines poorly.
728
"""
729
730
takes_args = ['file*']
731
takes_options = ['revision', 'diff-options']
732
aliases = ['di', 'dif']
733
734
def run(self, revision=None, file_list=None, diff_options=None):
735
from bzrlib.diff import show_diff
736
from bzrlib import find_branch
737
738
if file_list:
739
b = find_branch(file_list[0])
740
file_list = [b.relpath(f) for f in file_list]
741
if file_list == ['']:
742
# just pointing to top-of-tree
743
file_list = None
744
else:
745
b = Branch('.')
746
747
show_diff(b, revision, specific_files=file_list,
748
external_diff_options=diff_options)
749
750
751
752
753
754
class cmd_deleted(Command):
755
"""List files deleted in the working tree.
756
757
TODO: Show files deleted since a previous revision, or between two revisions.
758
"""
759
def run(self, show_ids=False):
760
b = Branch('.')
761
old = b.basis_tree()
762
new = b.working_tree()
763
764
## TODO: Much more efficient way to do this: read in new
765
## directories with readdir, rather than stating each one. Same
766
## level of effort but possibly much less IO. (Or possibly not,
767
## if the directories are very large...)
768
769
for path, ie in old.inventory.iter_entries():
770
if not new.has_id(ie.file_id):
771
if show_ids:
772
print '%-50s %s' % (path, ie.file_id)
773
else:
774
print path
775
776
777
class cmd_modified(Command):
778
"""List files modified in working tree."""
779
hidden = True
780
def run(self):
781
import statcache
782
b = Branch('.')
783
inv = b.read_working_inventory()
784
sc = statcache.update_cache(b, inv)
785
basis = b.basis_tree()
786
basis_inv = basis.inventory
787
788
# We used to do this through iter_entries(), but that's slow
789
# when most of the files are unmodified, as is usually the
790
# case. So instead we iterate by inventory entry, and only
791
# calculate paths as necessary.
792
793
for file_id in basis_inv:
794
cacheentry = sc.get(file_id)
795
if not cacheentry: # deleted
796
continue
797
ie = basis_inv[file_id]
798
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
799
path = inv.id2path(file_id)
800
print path
801
802
803
804
class cmd_added(Command):
805
"""List files added in working tree."""
806
hidden = True
807
def run(self):
808
b = Branch('.')
809
wt = b.working_tree()
810
basis_inv = b.basis_tree().inventory
811
inv = wt.inventory
812
for file_id in inv:
813
if file_id in basis_inv:
814
continue
815
path = inv.id2path(file_id)
816
if not os.access(b.abspath(path), os.F_OK):
817
continue
818
print path
819
820
821
822
class cmd_root(Command):
823
"""Show the tree root directory.
824
825
The root is the nearest enclosing directory with a .bzr control
826
directory."""
827
takes_args = ['filename?']
828
def run(self, filename=None):
829
"""Print the branch root."""
830
from branch import find_branch
831
b = find_branch(filename)
832
print getattr(b, 'base', None) or getattr(b, 'baseurl')
833
834
835
class cmd_log(Command):
836
"""Show log of this branch.
837
838
To request a range of logs, you can use the command -r begin:end
839
-r revision requests a specific revision, -r :end or -r begin: are
840
also valid.
841
842
TODO: Make --revision support uuid: and hash: [future tag:] notation.
843
844
"""
845
846
takes_args = ['filename?']
847
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
848
849
def run(self, filename=None, timezone='original',
850
verbose=False,
851
show_ids=False,
852
forward=False,
853
revision=None):
854
from bzrlib import show_log, find_branch
855
import codecs
856
857
direction = (forward and 'forward') or 'reverse'
858
859
if filename:
860
b = find_branch(filename)
861
fp = b.relpath(filename)
862
if fp:
863
file_id = b.read_working_inventory().path2id(fp)
864
else:
865
file_id = None # points to branch root
866
else:
867
b = find_branch('.')
868
file_id = None
869
870
if revision == None:
871
revision = [None, None]
872
elif isinstance(revision, int):
873
revision = [revision, revision]
874
else:
875
# pair of revisions?
876
pass
877
878
assert len(revision) == 2
879
880
mutter('encoding log as %r' % bzrlib.user_encoding)
881
882
# use 'replace' so that we don't abort if trying to write out
883
# in e.g. the default C locale.
884
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
885
886
show_log(b, file_id,
887
show_timezone=timezone,
888
verbose=verbose,
889
show_ids=show_ids,
890
to_file=outf,
891
direction=direction,
892
start_revision=revision[0],
893
end_revision=revision[1])
894
895
896
897
class cmd_touching_revisions(Command):
898
"""Return revision-ids which affected a particular file.
899
900
A more user-friendly interface is "bzr log FILE"."""
901
hidden = True
902
takes_args = ["filename"]
903
def run(self, filename):
904
b = Branch(filename)
905
inv = b.read_working_inventory()
906
file_id = inv.path2id(b.relpath(filename))
907
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
908
print "%6d %s" % (revno, what)
909
910
911
class cmd_ls(Command):
912
"""List files in a tree.
913
914
TODO: Take a revision or remote path and list that tree instead.
915
"""
916
hidden = True
917
def run(self, revision=None, verbose=False):
918
b = Branch('.')
919
if revision == None:
920
tree = b.working_tree()
921
else:
922
tree = b.revision_tree(b.lookup_revision(revision))
923
924
for fp, fc, kind, fid in tree.list_files():
925
if verbose:
926
if kind == 'directory':
927
kindch = '/'
928
elif kind == 'file':
929
kindch = ''
930
else:
931
kindch = '???'
932
933
print '%-8s %s%s' % (fc, fp, kindch)
934
else:
935
print fp
936
937
938
939
class cmd_unknowns(Command):
940
"""List unknown files."""
941
def run(self):
942
for f in Branch('.').unknowns():
943
print quotefn(f)
944
945
946
947
class cmd_ignore(Command):
948
"""Ignore a command or pattern.
949
950
To remove patterns from the ignore list, edit the .bzrignore file.
951
952
If the pattern contains a slash, it is compared to the whole path
953
from the branch root. Otherwise, it is comapred to only the last
954
component of the path.
955
956
Ignore patterns are case-insensitive on case-insensitive systems.
957
958
Note: wildcards must be quoted from the shell on Unix.
959
960
examples:
961
bzr ignore ./Makefile
962
bzr ignore '*.class'
963
"""
964
takes_args = ['name_pattern']
965
966
def run(self, name_pattern):
967
from bzrlib.atomicfile import AtomicFile
968
import os.path
969
970
b = Branch('.')
971
ifn = b.abspath('.bzrignore')
972
973
if os.path.exists(ifn):
974
f = open(ifn, 'rt')
975
try:
976
igns = f.read().decode('utf-8')
977
finally:
978
f.close()
979
else:
980
igns = ''
981
982
# TODO: If the file already uses crlf-style termination, maybe
983
# we should use that for the newly added lines?
984
985
if igns and igns[-1] != '\n':
986
igns += '\n'
987
igns += name_pattern + '\n'
988
989
try:
990
f = AtomicFile(ifn, 'wt')
991
f.write(igns.encode('utf-8'))
992
f.commit()
993
finally:
994
f.close()
995
996
inv = b.working_tree().inventory
997
if inv.path2id('.bzrignore'):
998
mutter('.bzrignore is already versioned')
999
else:
1000
mutter('need to make new .bzrignore file versioned')
1001
b.add(['.bzrignore'])
1002
1003
1004
1005
class cmd_ignored(Command):
1006
"""List ignored files and the patterns that matched them.
1007
1008
See also: bzr ignore"""
1009
def run(self):
1010
tree = Branch('.').working_tree()
1011
for path, file_class, kind, file_id in tree.list_files():
1012
if file_class != 'I':
1013
continue
1014
## XXX: Slightly inefficient since this was already calculated
1015
pat = tree.is_ignored(path)
1016
print '%-50s %s' % (path, pat)
1017
1018
1019
class cmd_lookup_revision(Command):
1020
"""Lookup the revision-id from a revision-number
1021
1022
example:
1023
bzr lookup-revision 33
1024
"""
1025
hidden = True
1026
takes_args = ['revno']
1027
1028
def run(self, revno):
1029
try:
1030
revno = int(revno)
1031
except ValueError:
1032
raise BzrCommandError("not a valid revision-number: %r" % revno)
1033
1034
print Branch('.').lookup_revision(revno)
1035
1036
1037
class cmd_export(Command):
1038
"""Export past revision to destination directory.
1039
1040
If no revision is specified this exports the last committed revision.
1041
1042
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1043
given, exports to a directory (equivalent to --format=dir)."""
1044
# TODO: list known exporters
1045
takes_args = ['dest']
1046
takes_options = ['revision', 'format']
1047
def run(self, dest, revision=None, format='dir'):
1048
b = Branch('.')
1049
if revision == None:
1050
rh = b.revision_history()[-1]
1051
else:
1052
rh = b.lookup_revision(int(revision))
1053
t = b.revision_tree(rh)
1054
t.export(dest, format)
1055
1056
1057
class cmd_cat(Command):
1058
"""Write a file's text from a previous revision."""
1059
1060
takes_options = ['revision']
1061
takes_args = ['filename']
1062
1063
def run(self, filename, revision=None):
1064
if revision == None:
1065
raise BzrCommandError("bzr cat requires a revision number")
1066
b = Branch('.')
1067
b.print_file(b.relpath(filename), int(revision))
1068
1069
1070
class cmd_local_time_offset(Command):
1071
"""Show the offset in seconds from GMT to local time."""
1072
hidden = True
1073
def run(self):
1074
print bzrlib.osutils.local_time_offset()
1075
1076
1077
1078
class cmd_commit(Command):
1079
"""Commit changes into a new revision.
1080
1081
If selected files are specified, only changes to those files are
1082
committed. If a directory is specified then its contents are also
1083
committed.
1084
1085
A selected-file commit may fail in some cases where the committed
1086
tree would be invalid, such as trying to commit a file in a
1087
newly-added directory that is not itself committed.
1088
1089
TODO: Run hooks on tree to-be-committed, and after commit.
1090
1091
TODO: Strict commit that fails if there are unknown or deleted files.
1092
"""
1093
takes_args = ['selected*']
1094
takes_options = ['message', 'file', 'verbose']
1095
aliases = ['ci', 'checkin']
1096
1097
def run(self, message=None, file=None, verbose=True, selected_list=None):
1098
from bzrlib.commit import commit
1099
1100
## Warning: shadows builtin file()
1101
if not message and not file:
1102
raise BzrCommandError("please specify a commit message",
1103
["use either --message or --file"])
1104
elif message and file:
1105
raise BzrCommandError("please specify either --message or --file")
1106
1107
if file:
1108
import codecs
1109
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1110
1111
b = Branch('.')
1112
commit(b, message, verbose=verbose, specific_files=selected_list)
1113
1114
1115
class cmd_check(Command):
1116
"""Validate consistency of branch history.
1117
1118
This command checks various invariants about the branch storage to
1119
detect data corruption or bzr bugs.
1120
1121
If given the --update flag, it will update some optional fields
1122
to help ensure data consistency.
1123
"""
1124
takes_args = ['dir?']
1125
1126
def run(self, dir='.'):
1127
import bzrlib.check
1128
bzrlib.check.check(Branch(dir))
1129
1130
1131
1132
class cmd_upgrade(Command):
1133
"""Upgrade branch storage to current format.
1134
1135
This should normally be used only after the check command tells
1136
you to run it.
1137
"""
1138
takes_args = ['dir?']
1139
1140
def run(self, dir='.'):
1141
from bzrlib.upgrade import upgrade
1142
upgrade(Branch(dir))
1143
1144
1145
1146
class cmd_whoami(Command):
1147
"""Show bzr user id."""
1148
takes_options = ['email']
1149
1150
def run(self, email=False):
1151
if email:
1152
print bzrlib.osutils.user_email()
1153
else:
1154
print bzrlib.osutils.username()
1155
1156
1157
class cmd_selftest(Command):
1158
"""Run internal test suite"""
1159
hidden = True
1160
def run(self):
1161
from bzrlib.selftest import selftest
1162
if selftest():
1163
return 0
1164
else:
1165
return 1
1166
1167
1168
1169
class cmd_version(Command):
1170
"""Show version of bzr."""
1171
def run(self):
1172
show_version()
1173
1174
def show_version():
1175
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1176
# is bzrlib itself in a branch?
1177
bzrrev = bzrlib.get_bzr_revision()
1178
if bzrrev:
1179
print " (bzr checkout, revision %d {%s})" % bzrrev
1180
print bzrlib.__copyright__
1181
print "http://bazaar-ng.org/"
1182
print
1183
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1184
print "you may use, modify and redistribute it under the terms of the GNU"
1185
print "General Public License version 2 or later."
1186
1187
1188
class cmd_rocks(Command):
1189
"""Statement of optimism."""
1190
hidden = True
1191
def run(self):
1192
print "it sure does!"
227
raise NotImplementedError()
228
229
230
def help(self):
231
"""Return help message for this class."""
232
if self.__doc__ is Command.__doc__:
233
return None
234
return getdoc(self)
235
236
def name(self):
237
return _unsquish_command_name(self.__class__.__name__)
238
1193
239
1194
240
def parse_spec(spec):
1195
241
"""
1201
247
['..', -1]
1202
248
>>> parse_spec("../f/@35")
1203
249
['../f', 35]
250
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
251
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1204
252
"""
1205
253
if spec is None:
1206
254
return [None, None]
1210
258
if parsed[1] == "":
1211
259
parsed[1] = -1
1212
260
else:
1213
parsed[1] = int(parsed[1])
1214
assert parsed[1] >=0
261
try:
262
parsed[1] = int(parsed[1])
263
except ValueError:
264
pass # We can allow stuff like ./@revid:blahblahblah
265
else:
266
assert parsed[1] >=0
1215
267
else:
1216
268
parsed = [spec, None]
1217
269
return parsed
1218
270
1219
1220
1221
class cmd_merge(Command):
1222
"""Perform a three-way merge of trees.
1223
1224
The SPEC parameters are working tree or revision specifiers. Working trees
1225
are specified using standard paths or urls. No component of a directory
1226
path may begin with '@'.
1227
1228
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1229
1230
Revisions are specified using a dirname/@revno pair, where dirname is the
1231
branch directory and revno is the revision within that branch. If no revno
1232
is specified, the latest revision is used.
1233
1234
Revision examples: './@127', 'foo/@', '../@1'
1235
1236
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1237
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1238
as the BASE.
1239
1240
merge refuses to run if there are any uncommitted changes, unless
1241
--force is given.
1242
"""
1243
takes_args = ['other_spec', 'base_spec?']
1244
takes_options = ['force']
1245
1246
def run(self, other_spec, base_spec=None, force=False):
1247
from bzrlib.merge import merge
1248
merge(parse_spec(other_spec), parse_spec(base_spec),
1249
check_clean=(not force))
1250
1251
1252
class cmd_revert(Command):
1253
"""Reverse all changes since the last commit.
1254
1255
Only versioned files are affected.
1256
1257
TODO: Store backups of any files that will be reverted, so
1258
that the revert can be undone.
1259
"""
1260
takes_options = ['revision']
1261
1262
def run(self, revision=-1):
1263
from bzrlib.merge import merge
1264
merge(('.', revision), parse_spec('.'),
1265
check_clean=False,
1266
ignore_zero=True)
1267
1268
1269
class cmd_assert_fail(Command):
1270
"""Test reporting of assertion failures"""
1271
hidden = True
1272
def run(self):
1273
assert False, "always fails"
1274
1275
1276
class cmd_help(Command):
1277
"""Show help on a command or other topic.
1278
1279
For a list of all available commands, say 'bzr help commands'."""
1280
takes_args = ['topic?']
1281
aliases = ['?']
1282
1283
def run(self, topic=None):
1284
import help
1285
help.help(topic)
1286
1287
1288
class cmd_update_stat_cache(Command):
1289
"""Update stat-cache mapping inodes to SHA-1 hashes.
1290
1291
For testing only."""
1292
hidden = True
1293
def run(self):
1294
import statcache
1295
b = Branch('.')
1296
statcache.update_cache(b.base, b.read_working_inventory())
1297
1298
1299
1300
# list of all available options; the rhs can be either None for an
1301
# option that takes no argument, or a constructor function that checks
1302
# the type.
1303
OPTIONS = {
1304
'all': None,
1305
'diff-options': str,
1306
'help': None,
1307
'file': unicode,
1308
'force': None,
1309
'format': unicode,
1310
'forward': None,
1311
'message': unicode,
1312
'no-recurse': None,
1313
'profile': None,
1314
'revision': _parse_revision_str,
1315
'show-ids': None,
1316
'timezone': str,
1317
'verbose': None,
1318
'version': None,
1319
'email': None,
1320
'update': None,
1321
}
1322
1323
SHORT_OPTIONS = {
1324
'F': 'file',
1325
'h': 'help',
1326
'm': 'message',
1327
'r': 'revision',
1328
'v': 'verbose',
1329
}
1330
1331
1332
def parse_args(argv):
271
def parse_args(command, argv):
1333
272
"""Parse command line.
1334
273
1335
274
Arguments and options are parsed at this level before being passed
1336
275
down to specific command handlers. This routine knows, from a
1337
276
lookup table, something about the available options, what optargs
1338
277
they take, and which commands will accept them.
1339
1340
>>> parse_args('--help'.split())
1341
([], {'help': True})
1342
>>> parse_args('--version'.split())
1343
([], {'version': True})
1344
>>> parse_args('status --all'.split())
1345
(['status'], {'all': True})
1346
>>> parse_args('commit --message=biter'.split())
1347
(['commit'], {'message': u'biter'})
1348
>>> parse_args('log -r 500'.split())
1349
(['log'], {'revision': 500})
1350
>>> parse_args('log -r500:600'.split())
1351
(['log'], {'revision': [500, 600]})
1352
>>> parse_args('log -vr500:600'.split())
1353
(['log'], {'verbose': True, 'revision': [500, 600]})
1354
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1355
Traceback (most recent call last):
1356
...
1357
ValueError: invalid literal for int(): v500
1358
278
"""
279
# TODO: chop up this beast; make it a method of the Command
1359
280
args = []
1360
281
opts = {}
1361
282
1362
# TODO: Maybe handle '--' to end options?
1363
283
cmd_options = command.options()
284
argsover = False
1364
285
while argv:
1365
286
a = argv.pop(0)
287
if argsover:
288
args.append(a)
289
continue
290
elif a == '--':
291
# We've received a standalone -- No more flags
292
argsover = True
293
continue
1366
294
if a[0] == '-':
1367
295
# option names must not be unicode
1368
296
a = str(a)
1373
301
optname, optarg = a[2:].split('=', 1)
1374
302
else:
1375
303
optname = a[2:]
1376
if optname not in OPTIONS:
1377
raise BzrError('unknown long option %r' % a)
304
if optname not in cmd_options:
305
raise BzrCommandError('unknown long option %r for command %s'
306
% (a, command.name))
1378
307
else:
1379
308
shortopt = a[1:]
1380
if shortopt in SHORT_OPTIONS:
309
if shortopt in Option.SHORT_OPTIONS:
1381
310
# Multi-character options must have a space to delimit
1382
311
# their value
1383
optname = SHORT_OPTIONS[shortopt]
312
# ^^^ what does this mean? mbp 20051014
313
optname = Option.SHORT_OPTIONS[shortopt].name
1384
314
else:
1385
315
# Single character short options, can be chained,
1386
316
# and have their value appended to their name
1387
317
shortopt = a[1:2]
1388
if shortopt not in SHORT_OPTIONS:
318
if shortopt not in Option.SHORT_OPTIONS:
1389
319
# We didn't find the multi-character name, and we
1390
320
# didn't find the single char name
1391
321
raise BzrError('unknown short option %r' % a)
1392
optname = SHORT_OPTIONS[shortopt]
322
optname = Option.SHORT_OPTIONS[shortopt].name
1393
323
1394
324
if a[2:]:
1395
325
# There are extra things on this option
1396
326
# see if it is the value, or if it is another
1397
327
# short option
1398
optargfn = OPTIONS[optname]
328
optargfn = Option.OPTIONS[optname].type
1399
329
if optargfn is None:
1400
330
# This option does not take an argument, so the
1401
331
# next entry is another short option, pack it back
1410
340
# XXX: Do we ever want to support this, e.g. for -r?
1411
341
raise BzrError('repeated option %r' % a)
1412
342
1413
optargfn = OPTIONS[optname]
343
option_obj = cmd_options[optname]
344
optargfn = option_obj.type
1414
345
if optargfn:
1415
346
if optarg == None:
1416
347
if not argv:
1424
355
opts[optname] = True
1425
356
else:
1426
357
args.append(a)
1427
1428
358
return args, opts
1429
359
1430
360
1431
1432
1433
361
def _match_argform(cmd, takes_args, args):
1434
362
argdict = {}
1435
363
1475
403
1476
404
1477
405
406
def apply_profiled(the_callable, *args, **kwargs):
407
import hotshot
408
import tempfile
409
import hotshot.stats
410
pffileno, pfname = tempfile.mkstemp()
411
try:
412
prof = hotshot.Profile(pfname)
413
try:
414
ret = prof.runcall(the_callable, *args, **kwargs) or 0
415
finally:
416
prof.close()
417
stats = hotshot.stats.load(pfname)
418
stats.strip_dirs()
419
stats.sort_stats('cum') # 'time'
420
## XXX: Might like to write to stderr or the trace file instead but
421
## print_stats seems hardcoded to stdout
422
stats.print_stats(20)
423
return ret
424
finally:
425
os.close(pffileno)
426
os.remove(pfname)
427
428
1478
429
def run_bzr(argv):
1479
430
"""Execute a command.
1480
431
1481
432
This is similar to main(), but without all the trappings for
1482
433
logging and error handling.
434
435
argv
436
The command-line arguments, without the program name from argv[0]
437
438
Returns a command status or raises an exception.
439
440
Special master options: these must come before the command because
441
they control how the command is interpreted.
442
443
--no-plugins
444
Do not load plugin modules at all
445
446
--builtin
447
Only use builtin commands. (Plugins are still allowed to change
448
other behaviour.)
449
450
--profile
451
Run under the Python profiler.
1483
452
"""
453
import bzrlib.transport
454
bzrlib.transport.register_builtin_transports()
455
1484
456
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1485
1486
include_plugins=True
1487
try:
1488
args, opts = parse_args(argv[1:])
1489
if 'help' in opts:
1490
import help
1491
if args:
1492
help.help(args[0])
1493
else:
1494
help.help()
1495
return 0
1496
elif 'version' in opts:
1497
show_version()
1498
return 0
1499
elif args and args[0] == 'builtin':
1500
include_plugins=False
1501
args = args[1:]
1502
cmd = str(args.pop(0))
1503
except IndexError:
1504
import help
1505
help.help()
1506
return 1
1507
1508
1509
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1510
1511
# global option
1512
if 'profile' in opts:
1513
profile = True
1514
del opts['profile']
1515
else:
1516
profile = False
1517
1518
# check options are reasonable
1519
allowed = cmd_class.takes_options
1520
for oname in opts:
1521
if oname not in allowed:
1522
raise BzrCommandError("option '--%s' is not allowed for command %r"
1523
% (oname, cmd))
1524
1525
# mix arguments and options into one dictionary
1526
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1527
cmdopts = {}
1528
for k, v in opts.items():
1529
cmdopts[k.replace('-', '_')] = v
1530
1531
if profile:
1532
import hotshot, tempfile
1533
pffileno, pfname = tempfile.mkstemp()
1534
try:
1535
prof = hotshot.Profile(pfname)
1536
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1537
prof.close()
1538
1539
import hotshot.stats
1540
stats = hotshot.stats.load(pfname)
1541
#stats.strip_dirs()
1542
stats.sort_stats('time')
1543
## XXX: Might like to write to stderr or the trace file instead but
1544
## print_stats seems hardcoded to stdout
1545
stats.print_stats(20)
1546
1547
return ret.status
1548
1549
finally:
1550
os.close(pffileno)
1551
os.remove(pfname)
1552
else:
1553
return cmd_class(cmdopts, cmdargs).status
1554
1555
1556
def _report_exception(summary, quiet=False):
1557
import traceback
1558
log_error('bzr: ' + summary)
1559
bzrlib.trace.log_exception()
1560
1561
if not quiet:
1562
tb = sys.exc_info()[2]
1563
exinfo = traceback.extract_tb(tb)
1564
if exinfo:
1565
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1566
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1567
457
458
opt_profile = opt_no_plugins = opt_builtin = False
459
460
# --no-plugins is handled specially at a very early stage. We need
461
# to load plugins before doing other command parsing so that they
462
# can override commands, but this needs to happen first.
463
464
for a in argv:
465
if a == '--profile':
466
opt_profile = True
467
elif a == '--no-plugins':
468
opt_no_plugins = True
469
elif a == '--builtin':
470
opt_builtin = True
471
else:
472
break
473
argv.remove(a)
474
475
if (not argv) or (argv[0] == '--help'):
476
from bzrlib.help import help
477
if len(argv) > 1:
478
help(argv[1])
479
else:
480
help()
481
return 0
482
483
if argv[0] == '--version':
484
from bzrlib.builtins import show_version
485
show_version()
486
return 0
487
488
if not opt_no_plugins:
489
from bzrlib.plugin import load_plugins
490
load_plugins()
491
492
cmd = str(argv.pop(0))
493
494
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
495
496
if opt_profile:
497
ret = apply_profiled(cmd_obj.run_argv, argv)
498
else:
499
ret = cmd_obj.run_argv(argv)
500
return ret or 0
1568
501
1569
502
1570
503
def main(argv):
1571
import errno
1572
1573
bzrlib.open_tracefile(argv)
1574
504
import bzrlib.ui
505
bzrlib.trace.log_startup(argv)
506
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
507
508
return run_bzr_catch_errors(argv[1:])
509
510
511
def run_bzr_catch_errors(argv):
1575
512
try:
1576
513
try:
1577
try:
1578
return run_bzr(argv)
1579
finally:
1580
# do this here inside the exception wrappers to catch EPIPE
1581
sys.stdout.flush()
1582
except BzrError, e:
1583
quiet = isinstance(e, (BzrCommandError))
1584
_report_exception('error: ' + e.args[0], quiet=quiet)
1585
if len(e.args) > 1:
1586
for h in e.args[1]:
1587
# some explanation or hints
1588
log_error(' ' + h)
1589
return 1
1590
except AssertionError, e:
1591
msg = 'assertion failed'
1592
if str(e):
1593
msg += ': ' + str(e)
1594
_report_exception(msg)
1595
return 2
1596
except KeyboardInterrupt, e:
1597
_report_exception('interrupted', quiet=True)
1598
return 2
1599
except Exception, e:
1600
quiet = False
1601
if (isinstance(e, IOError)
1602
and hasattr(e, 'errno')
1603
and e.errno == errno.EPIPE):
1604
quiet = True
1605
msg = 'broken pipe'
1606
else:
1607
msg = str(e).rstrip('\n')
1608
_report_exception(msg, quiet)
1609
return 2
1610
finally:
1611
bzrlib.trace.close_trace()
1612
514
return run_bzr(argv)
515
finally:
516
# do this here inside the exception wrappers to catch EPIPE
517
sys.stdout.flush()
518
except BzrCommandError, e:
519
# command line syntax error, etc
520
log_error(str(e))
521
return 1
522
except BzrError, e:
523
bzrlib.trace.log_exception()
524
return 1
525
except AssertionError, e:
526
bzrlib.trace.log_exception('assertion failed: ' + str(e))
527
return 3
528
except KeyboardInterrupt, e:
529
bzrlib.trace.log_exception('interrupted')
530
return 2
531
except Exception, e:
532
import errno
533
if (isinstance(e, IOError)
534
and hasattr(e, 'errno')
535
and e.errno == errno.EPIPE):
536
bzrlib.trace.note('broken pipe')
537
return 2
538
else:
539
## import pdb
540
## pdb.pm()
541
bzrlib.trace.log_exception()
542
return 2
1613
543
1614
544
if __name__ == '__main__':
1615
545
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1