« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1185.50.72
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.50.72
- Committer: John Arbash Meinel
- Date: 2006-02-06 14:02:09 UTC
- mfrom: (1185.76.8 Erik Bågfors' pull --revision branch)
- mto: (1534.1.20 integration) (1553.4.1 revision-ranges) (1185.79.1 bzr-jam-pending)
- mto: This revision was merged to the branch mainline in revision 1554.
- Revision ID: john@arbash-meinel.com-20060206140209-793eeeb7f3f3d069
[merge] Erik Bågfors: add --revision to bzr pull
- files added:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- tools
- tools/doc_generate
- files removed:
- bzrlib/mdiff.py
- files renamed:
- bzrlib/changeset.py => bzrlib/_changeset.py
- bzrlib/merge_core.py => bzrlib/_merge_core.py
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- contrib/bash/bzr => contrib/bash/bzr.simple
- 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, time, os.path
20
from sets import Set
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
20
21
# TODO: Help messages for options.
22
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
26
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
29
30
import sys
31
import os
32
from warnings import warn
33
from inspect import getdoc
34
import errno
21
35
22
36
import bzrlib
23
from bzrlib.trace import mutter, note, log_error
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
from bzrlib.tree import RevisionTree, EmptyTree, Tree
27
from bzrlib.revision import Revision
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
format_date
30
from bzrlib import merge
37
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
40
BzrCheckError,
41
BzrCommandError,
42
BzrOptionError,
43
NotBranchError)
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
46
from bzrlib.option import Option
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd, decorate=False):
52
"Utility function to help register a command"
53
global plugin_cmds
54
k = cmd.__name__
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
57
else:
58
k_unsquished = k
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
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
68
else:
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
31
71
32
72
33
73
def _squish_command_name(cmd):
38
78
assert cmd.startswith("cmd_")
39
79
return cmd[4:].replace('_','-')
40
80
41
def get_all_cmds():
81
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()
101
102
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
106
if plugins_override:
107
d.update(plugin_cmds)
108
return d
109
110
111
def get_all_cmds(plugins_override=True):
42
112
"""Return canonical name and class for all registered commands."""
43
for k, v in globals().iteritems():
44
if k.startswith("cmd_"):
45
yield _unsquish_command_name(k), v
46
47
def get_cmd_class(cmd):
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
114
yield k,v
115
116
117
def get_cmd_object(cmd_name, plugins_override=True):
48
118
"""Return the canonical name and command class for a command.
119
120
plugins_override
121
If true, plugin commands can override builtins.
49
122
"""
50
cmd = str(cmd) # not unicode
123
from bzrlib.externalcommand import ExternalCommand
124
125
cmd_name = str(cmd_name) # not unicode
51
126
52
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
53
129
try:
54
return cmd, globals()[_squish_command_name(cmd)]
130
return cmds[cmd_name]()
55
131
except KeyError:
56
132
pass
57
133
58
134
# look for any command which claims this as an alias
59
for cmdname, cmdclass in get_all_cmds():
60
if cmd in cmdclass.aliases:
61
return cmdname, cmdclass
62
63
cmdclass = ExternalCommand.find_command(cmd)
64
if cmdclass:
65
return cmd, cmdclass
66
67
raise BzrCommandError("unknown command %r" % cmd)
68
69
70
class Command:
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)
144
145
146
class Command(object):
71
147
"""Base class for commands.
72
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
73
160
The docstring for an actual command should give a single-line
74
161
summary, then a complete description of the command. A grammar
75
162
description will be inserted.
76
163
164
aliases
165
Other accepted names for this command.
166
77
167
takes_args
78
168
List of argument forms, marked with whether they are optional,
79
169
repeated, etc.
80
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
81
179
takes_options
82
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().
83
183
84
184
hidden
85
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.
86
187
"""
87
188
aliases = []
88
89
189
takes_args = []
90
190
takes_options = []
91
191
92
192
hidden = False
93
193
94
def __init__(self, options, arguments):
95
"""Construct and run the command.
96
97
Sets self.status to the return value of run()."""
98
assert isinstance(options, dict)
99
assert isinstance(arguments, dict)
100
cmdargs = options.copy()
101
cmdargs.update(arguments)
102
assert self.__doc__ != Command.__doc__, \
103
("No help message set for %r" % self)
104
self.status = self.run(**cmdargs)
105
194
def __init__(self):
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
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
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
217
return 0
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
220
for oname in opts:
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
226
cmdopts = {}
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
229
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
232
233
return self.run(**all_cmd_args)
106
234
107
235
def run(self):
108
"""Override this in sub-classes.
236
"""Actually run the command.
109
237
110
238
This is invoked with the options and arguments bound to
111
239
keyword parameters.
112
240
113
Return 0 or None if the command was successful, or a shell
114
error code if not.
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
115
244
"""
116
return 0
117
118
119
class ExternalCommand(Command):
120
"""Class to wrap external commands.
121
122
We cheat a little here, when get_cmd_class() calls us we actually give it back
123
an object we construct that has the appropriate path, help, options etc for the
124
specified command.
125
126
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
127
method, which we override to call the Command.__init__ method. That then calls
128
our run method which is pretty straight forward.
129
130
The only wrinkle is that we have to map bzr's dictionary of options and arguments
131
back into command line options and arguments for the script.
132
"""
133
134
def find_command(cls, cmd):
135
bzrpath = os.environ.get('BZRPATH', '')
136
137
for dir in bzrpath.split(':'):
138
path = os.path.join(dir, cmd)
139
if os.path.isfile(path):
140
return ExternalCommand(path)
141
142
return None
143
144
find_command = classmethod(find_command)
145
146
def __init__(self, path):
147
self.path = path
148
149
# TODO: If either of these fail, we should detect that and
150
# assume that path is not really a bzr plugin after all.
151
152
pipe = os.popen('%s --bzr-usage' % path, 'r')
153
self.takes_options = pipe.readline().split()
154
self.takes_args = pipe.readline().split()
155
pipe.close()
156
157
pipe = os.popen('%s --bzr-help' % path, 'r')
158
self.__doc__ = pipe.read()
159
pipe.close()
160
161
def __call__(self, options, arguments):
162
Command.__init__(self, options, arguments)
163
return self
164
165
def run(self, **kargs):
166
opts = []
167
args = []
168
169
keys = kargs.keys()
170
keys.sort()
171
for name in keys:
172
value = kargs[name]
173
if OPTIONS.has_key(name):
174
# it's an option
175
opts.append('--%s' % name)
176
if value is not None and value is not True:
177
opts.append(str(value))
178
else:
179
# it's an arg, or arg list
180
if type(value) is not list:
181
value = [value]
182
for v in value:
183
if v is not None:
184
args.append(str(v))
185
186
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
187
return self.status
188
189
190
class cmd_status(Command):
191
"""Display status summary.
192
193
This reports on versioned and unknown files, reporting them
194
grouped by state. Possible states are:
195
196
added
197
Versioned in the working copy but not in the previous revision.
198
199
removed
200
Versioned in the previous revision but removed or deleted
201
in the working copy.
202
203
renamed
204
Path of this file changed from the previous revision;
205
the text may also have changed. This includes files whose
206
parent directory was renamed.
207
208
modified
209
Text has changed since the previous revision.
210
211
unchanged
212
Nothing about this file has changed since the previous revision.
213
Only shown with --all.
214
215
unknown
216
Not versioned and not matching an ignore pattern.
217
218
To see ignored files use 'bzr ignored'. For details in the
219
changes to file texts, use 'bzr diff'.
220
221
If no arguments are specified, the status of the entire working
222
directory is shown. Otherwise, only the status of the specified
223
files or directories is reported. If a directory is given, status
224
is reported for everything inside that directory.
225
"""
226
takes_args = ['file*']
227
takes_options = ['all', 'show-ids']
228
aliases = ['st', 'stat']
229
230
def run(self, all=False, show_ids=False, file_list=None):
231
if file_list:
232
b = Branch(file_list[0], lock_mode='r')
233
file_list = [b.relpath(x) for x in file_list]
234
# special case: only one path was given and it's the root
235
# of the branch
236
if file_list == ['']:
237
file_list = None
238
else:
239
b = Branch('.', lock_mode='r')
240
import status
241
status.show_status(b, show_unchanged=all, show_ids=show_ids,
242
specific_files=file_list)
243
244
245
class cmd_cat_revision(Command):
246
"""Write out metadata for a revision."""
247
248
hidden = True
249
takes_args = ['revision_id']
250
251
def run(self, revision_id):
252
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
253
254
255
class cmd_revno(Command):
256
"""Show current revision number.
257
258
This is equal to the number of revisions on this branch."""
259
def run(self):
260
print Branch('.').revno()
261
262
263
class cmd_add(Command):
264
"""Add specified files or directories.
265
266
In non-recursive mode, all the named items are added, regardless
267
of whether they were previously ignored. A warning is given if
268
any of the named files are already versioned.
269
270
In recursive mode (the default), files are treated the same way
271
but the behaviour for directories is different. Directories that
272
are already versioned do not give a warning. All directories,
273
whether already versioned or not, are searched for files or
274
subdirectories that are neither versioned or ignored, and these
275
are added. This search proceeds recursively into versioned
276
directories.
277
278
Therefore simply saying 'bzr add .' will version all files that
279
are currently unknown.
280
281
TODO: Perhaps adding a file whose directly is not versioned should
282
recursively add that parent, rather than giving an error?
283
"""
284
takes_args = ['file+']
285
takes_options = ['verbose']
286
287
def run(self, file_list, verbose=False):
288
bzrlib.add.smart_add(file_list, verbose)
289
290
291
class cmd_relpath(Command):
292
"""Show path of a file relative to root"""
293
takes_args = ['filename']
294
295
def run(self, filename):
296
print Branch(filename).relpath(filename)
297
298
299
300
class cmd_inventory(Command):
301
"""Show inventory of the current working copy or a revision."""
302
takes_options = ['revision']
303
304
def run(self, revision=None):
305
b = Branch('.')
306
if revision == None:
307
inv = b.read_working_inventory()
308
else:
309
inv = b.get_revision_inventory(b.lookup_revision(revision))
310
311
for path, entry in inv.iter_entries():
312
print '%-50s %s' % (entry.file_id, path)
313
314
315
class cmd_move(Command):
316
"""Move files to a different directory.
317
318
examples:
319
bzr move *.txt doc
320
321
The destination must be a versioned directory in the same branch.
322
"""
323
takes_args = ['source$', 'dest']
324
def run(self, source_list, dest):
325
b = Branch('.')
326
327
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
328
329
330
class cmd_rename(Command):
331
"""Change the name of an entry.
332
333
examples:
334
bzr rename frob.c frobber.c
335
bzr rename src/frob.c lib/frob.c
336
337
It is an error if the destination name exists.
338
339
See also the 'move' command, which moves files into a different
340
directory without changing their name.
341
342
TODO: Some way to rename multiple files without invoking bzr for each
343
one?"""
344
takes_args = ['from_name', 'to_name']
345
346
def run(self, from_name, to_name):
347
b = Branch('.')
348
b.rename_one(b.relpath(from_name), b.relpath(to_name))
349
350
351
352
class cmd_renames(Command):
353
"""Show list of renamed files.
354
355
TODO: Option to show renames between two historical versions.
356
357
TODO: Only show renames under dir, rather than in the whole branch.
358
"""
359
takes_args = ['dir?']
360
361
def run(self, dir='.'):
362
b = Branch(dir)
363
old_inv = b.basis_tree().inventory
364
new_inv = b.read_working_inventory()
365
366
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
367
renames.sort()
368
for old_name, new_name in renames:
369
print "%s => %s" % (old_name, new_name)
370
371
372
class cmd_info(Command):
373
"""Show statistical information about a branch."""
374
takes_args = ['branch?']
375
376
def run(self, branch=None):
377
import info
378
379
from branch import find_branch
380
b = find_branch(branch)
381
info.show_info(b)
382
383
384
class cmd_remove(Command):
385
"""Make a file unversioned.
386
387
This makes bzr stop tracking changes to a versioned file. It does
388
not delete the working copy.
389
"""
390
takes_args = ['file+']
391
takes_options = ['verbose']
392
393
def run(self, file_list, verbose=False):
394
b = Branch(file_list[0])
395
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
396
397
398
class cmd_file_id(Command):
399
"""Print file_id of a particular file or directory.
400
401
The file_id is assigned when the file is first added and remains the
402
same through all revisions where the file exists, even when it is
403
moved or renamed.
404
"""
405
hidden = True
406
takes_args = ['filename']
407
def run(self, filename):
408
b = Branch(filename)
409
i = b.inventory.path2id(b.relpath(filename))
410
if i == None:
411
bailout("%r is not a versioned file" % filename)
412
else:
413
print i
414
415
416
class cmd_file_path(Command):
417
"""Print path of file_ids to a file or directory.
418
419
This prints one line for each directory down to the target,
420
starting at the branch root."""
421
hidden = True
422
takes_args = ['filename']
423
def run(self, filename):
424
b = Branch(filename)
425
inv = b.inventory
426
fid = inv.path2id(b.relpath(filename))
427
if fid == None:
428
bailout("%r is not a versioned file" % filename)
429
for fip in inv.get_idpath(fid):
430
print fip
431
432
433
class cmd_revision_history(Command):
434
"""Display list of revision ids on this branch."""
435
def run(self):
436
for patchid in Branch('.').revision_history():
437
print patchid
438
439
440
class cmd_directories(Command):
441
"""Display list of versioned directories in this branch."""
442
def run(self):
443
for name, ie in Branch('.').read_working_inventory().directories():
444
if name == '':
445
print '.'
446
else:
447
print name
448
449
450
class cmd_init(Command):
451
"""Make a directory into a versioned branch.
452
453
Use this to create an empty branch, or before importing an
454
existing project.
455
456
Recipe for importing a tree of files:
457
cd ~/project
458
bzr init
459
bzr add -v .
460
bzr status
461
bzr commit -m 'imported project'
462
"""
463
def run(self):
464
Branch('.', init=True)
465
466
467
class cmd_diff(Command):
468
"""Show differences in working tree.
469
470
If files are listed, only the changes in those files are listed.
471
Otherwise, all changes for the tree are listed.
472
473
TODO: Given two revision arguments, show the difference between them.
474
475
TODO: Allow diff across branches.
476
477
TODO: Option to use external diff command; could be GNU diff, wdiff,
478
or a graphical diff.
479
480
TODO: Python difflib is not exactly the same as unidiff; should
481
either fix it up or prefer to use an external diff.
482
483
TODO: If a directory is given, diff everything under that.
484
485
TODO: Selected-file diff is inefficient and doesn't show you
486
deleted files.
487
488
TODO: This probably handles non-Unix newlines poorly.
489
"""
490
491
takes_args = ['file*']
492
takes_options = ['revision']
493
aliases = ['di']
494
495
def run(self, revision=None, file_list=None):
496
from bzrlib.diff import show_diff
497
498
show_diff(Branch('.'), revision, specific_files=file_list)
499
500
501
502
503
504
class cmd_deleted(Command):
505
"""List files deleted in the working tree.
506
507
TODO: Show files deleted since a previous revision, or between two revisions.
508
"""
509
def run(self, show_ids=False):
510
b = Branch('.')
511
old = b.basis_tree()
512
new = b.working_tree()
513
514
## TODO: Much more efficient way to do this: read in new
515
## directories with readdir, rather than stating each one. Same
516
## level of effort but possibly much less IO. (Or possibly not,
517
## if the directories are very large...)
518
519
for path, ie in old.inventory.iter_entries():
520
if not new.has_id(ie.file_id):
521
if show_ids:
522
print '%-50s %s' % (path, ie.file_id)
523
else:
524
print path
525
526
527
class cmd_modified(Command):
528
"""List files modified in working tree."""
529
hidden = True
530
def run(self):
531
import statcache
532
b = Branch('.')
533
inv = b.read_working_inventory()
534
sc = statcache.update_cache(b, inv)
535
basis = b.basis_tree()
536
basis_inv = basis.inventory
537
538
# We used to do this through iter_entries(), but that's slow
539
# when most of the files are unmodified, as is usually the
540
# case. So instead we iterate by inventory entry, and only
541
# calculate paths as necessary.
542
543
for file_id in basis_inv:
544
cacheentry = sc.get(file_id)
545
if not cacheentry: # deleted
546
continue
547
ie = basis_inv[file_id]
548
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
549
path = inv.id2path(file_id)
550
print path
551
552
553
554
class cmd_added(Command):
555
"""List files added in working tree."""
556
hidden = True
557
def run(self):
558
b = Branch('.')
559
wt = b.working_tree()
560
basis_inv = b.basis_tree().inventory
561
inv = wt.inventory
562
for file_id in inv:
563
if file_id in basis_inv:
564
continue
565
path = inv.id2path(file_id)
566
if not os.access(b.abspath(path), os.F_OK):
567
continue
568
print path
569
570
571
572
class cmd_root(Command):
573
"""Show the tree root directory.
574
575
The root is the nearest enclosing directory with a .bzr control
576
directory."""
577
takes_args = ['filename?']
578
def run(self, filename=None):
579
"""Print the branch root."""
580
from branch import find_branch
581
b = find_branch(filename)
582
print getattr(b, 'base', None) or getattr(b, 'baseurl')
583
584
585
class cmd_log(Command):
586
"""Show log of this branch.
587
588
TODO: Option to limit range.
589
590
TODO: Perhaps show most-recent first with an option for last.
591
"""
592
takes_args = ['filename?']
593
takes_options = ['timezone', 'verbose', 'show-ids']
594
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
595
from branch import find_branch
596
b = find_branch((filename or '.'), lock_mode='r')
597
if filename:
598
filename = b.relpath(filename)
599
bzrlib.show_log(b, filename,
600
show_timezone=timezone,
601
verbose=verbose,
602
show_ids=show_ids)
603
604
605
606
class cmd_touching_revisions(Command):
607
"""Return revision-ids which affected a particular file."""
608
hidden = True
609
takes_args = ["filename"]
610
def run(self, filename):
611
b = Branch(filename, lock_mode='r')
612
inv = b.read_working_inventory()
613
file_id = inv.path2id(b.relpath(filename))
614
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
615
print "%6d %s" % (revno, what)
616
617
618
class cmd_ls(Command):
619
"""List files in a tree.
620
621
TODO: Take a revision or remote path and list that tree instead.
622
"""
623
hidden = True
624
def run(self, revision=None, verbose=False):
625
b = Branch('.')
626
if revision == None:
627
tree = b.working_tree()
628
else:
629
tree = b.revision_tree(b.lookup_revision(revision))
630
631
for fp, fc, kind, fid in tree.list_files():
632
if verbose:
633
if kind == 'directory':
634
kindch = '/'
635
elif kind == 'file':
636
kindch = ''
637
else:
638
kindch = '???'
639
640
print '%-8s %s%s' % (fc, fp, kindch)
641
else:
642
print fp
643
644
645
646
class cmd_unknowns(Command):
647
"""List unknown files"""
648
def run(self):
649
for f in Branch('.').unknowns():
650
print quotefn(f)
651
652
653
654
class cmd_ignore(Command):
655
"""Ignore a command or pattern
656
657
To remove patterns from the ignore list, edit the .bzrignore file.
658
659
If the pattern contains a slash, it is compared to the whole path
660
from the branch root. Otherwise, it is comapred to only the last
661
component of the path.
662
663
Ignore patterns are case-insensitive on case-insensitive systems.
664
665
Note: wildcards must be quoted from the shell on Unix.
666
667
examples:
668
bzr ignore ./Makefile
669
bzr ignore '*.class'
670
"""
671
takes_args = ['name_pattern']
672
673
def run(self, name_pattern):
674
from bzrlib.atomicfile import AtomicFile
675
import codecs
676
677
b = Branch('.')
678
ifn = b.abspath('.bzrignore')
679
680
if os.path.exists(ifn):
681
f = open(ifn, 'rt')
682
try:
683
igns = f.read().decode('utf-8')
684
finally:
685
f.close()
686
else:
687
igns = ''
688
689
if igns and igns[-1] != '\n':
690
igns += '\n'
691
igns += name_pattern + '\n'
692
693
try:
694
f = AtomicFile(ifn, 'wt')
695
f.write(igns.encode('utf-8'))
696
f.commit()
697
finally:
698
f.close()
699
700
inv = b.working_tree().inventory
701
if inv.path2id('.bzrignore'):
702
mutter('.bzrignore is already versioned')
703
else:
704
mutter('need to make new .bzrignore file versioned')
705
b.add(['.bzrignore'])
706
707
708
709
class cmd_ignored(Command):
710
"""List ignored files and the patterns that matched them.
711
712
See also: bzr ignore"""
713
def run(self):
714
tree = Branch('.').working_tree()
715
for path, file_class, kind, file_id in tree.list_files():
716
if file_class != 'I':
717
continue
718
## XXX: Slightly inefficient since this was already calculated
719
pat = tree.is_ignored(path)
720
print '%-50s %s' % (path, pat)
721
722
723
class cmd_lookup_revision(Command):
724
"""Lookup the revision-id from a revision-number
725
726
example:
727
bzr lookup-revision 33
728
"""
729
hidden = True
730
takes_args = ['revno']
731
732
def run(self, revno):
733
try:
734
revno = int(revno)
735
except ValueError:
736
raise BzrCommandError("not a valid revision-number: %r" % revno)
737
738
print Branch('.').lookup_revision(revno)
739
740
741
class cmd_export(Command):
742
"""Export past revision to destination directory.
743
744
If no revision is specified this exports the last committed revision."""
745
takes_args = ['dest']
746
takes_options = ['revision']
747
def run(self, dest, revision=None):
748
b = Branch('.')
749
if revision == None:
750
rh = b.revision_history()[-1]
751
else:
752
rh = b.lookup_revision(int(revision))
753
t = b.revision_tree(rh)
754
t.export(dest)
755
756
757
class cmd_cat(Command):
758
"""Write a file's text from a previous revision."""
759
760
takes_options = ['revision']
761
takes_args = ['filename']
762
763
def run(self, filename, revision=None):
764
if revision == None:
765
raise BzrCommandError("bzr cat requires a revision number")
766
b = Branch('.')
767
b.print_file(b.relpath(filename), int(revision))
768
769
770
class cmd_local_time_offset(Command):
771
"""Show the offset in seconds from GMT to local time."""
772
hidden = True
773
def run(self):
774
print bzrlib.osutils.local_time_offset()
775
776
777
778
class cmd_commit(Command):
779
"""Commit changes into a new revision.
780
781
If selected files are specified, only changes to those files are
782
committed. If a directory is specified then its contents are also
783
committed.
784
785
A selected-file commit may fail in some cases where the committed
786
tree would be invalid, such as trying to commit a file in a
787
newly-added directory that is not itself committed.
788
789
TODO: Run hooks on tree to-be-committed, and after commit.
790
791
TODO: Strict commit that fails if there are unknown or deleted files.
792
"""
793
takes_args = ['selected*']
794
takes_options = ['message', 'file', 'verbose']
795
aliases = ['ci', 'checkin']
796
797
def run(self, message=None, file=None, verbose=True, selected_list=None):
798
from bzrlib.commit import commit
799
800
## Warning: shadows builtin file()
801
if not message and not file:
802
raise BzrCommandError("please specify a commit message",
803
["use either --message or --file"])
804
elif message and file:
805
raise BzrCommandError("please specify either --message or --file")
806
807
if file:
808
import codecs
809
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
810
811
b = Branch('.')
812
commit(b, message, verbose=verbose, specific_files=selected_list)
813
814
815
class cmd_check(Command):
816
"""Validate consistency of branch history.
817
818
This command checks various invariants about the branch storage to
819
detect data corruption or bzr bugs.
820
"""
821
takes_args = ['dir?']
822
def run(self, dir='.'):
823
import bzrlib.check
824
bzrlib.check.check(Branch(dir))
825
826
827
828
class cmd_whoami(Command):
829
"""Show bzr user id."""
830
takes_options = ['email']
831
832
def run(self, email=False):
833
if email:
834
print bzrlib.osutils.user_email()
835
else:
836
print bzrlib.osutils.username()
837
838
839
class cmd_selftest(Command):
840
"""Run internal test suite"""
841
hidden = True
842
def run(self):
843
failures, tests = 0, 0
844
845
import doctest, bzrlib.store, bzrlib.tests
846
bzrlib.trace.verbose = False
847
848
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
849
bzrlib.tree, bzrlib.commands, bzrlib.add:
850
mf, mt = doctest.testmod(m)
851
failures += mf
852
tests += mt
853
print '%-40s %3d tests' % (m.__name__, mt),
854
if mf:
855
print '%3d FAILED!' % mf
856
else:
857
print
858
859
print '%-40s %3d tests' % ('total', tests),
860
if failures:
861
print '%3d FAILED!' % failures
862
return 1
863
else:
864
print
865
return 0
866
867
868
869
class cmd_version(Command):
870
"""Show version of bzr"""
871
def run(self):
872
show_version()
873
874
def show_version():
875
print "bzr (bazaar-ng) %s" % bzrlib.__version__
876
print bzrlib.__copyright__
877
print "http://bazaar-ng.org/"
878
print
879
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
880
print "you may use, modify and redistribute it under the terms of the GNU"
881
print "General Public License version 2 or later."
882
883
884
class cmd_rocks(Command):
885
"""Statement of optimism."""
886
hidden = True
887
def run(self):
888
print "it sure does!"
245
raise NotImplementedError()
246
247
248
def help(self):
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
251
return None
252
return getdoc(self)
253
254
def name(self):
255
return _unsquish_command_name(self.__class__.__name__)
256
889
257
890
258
def parse_spec(spec):
259
"""
260
>>> parse_spec(None)
261
[None, None]
262
>>> parse_spec("./")
263
['./', None]
264
>>> parse_spec("../@")
265
['..', -1]
266
>>> parse_spec("../f/@35")
267
['../f', 35]
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
270
"""
271
if spec is None:
272
return [None, None]
891
273
if '/@' in spec:
892
274
parsed = spec.split('/@')
893
275
assert len(parsed) == 2
894
276
if parsed[1] == "":
895
277
parsed[1] = -1
896
278
else:
897
parsed[1] = int(parsed[1])
898
assert parsed[1] >=0
279
try:
280
parsed[1] = int(parsed[1])
281
except ValueError:
282
pass # We can allow stuff like ./@revid:blahblahblah
283
else:
284
assert parsed[1] >=0
899
285
else:
900
286
parsed = [spec, None]
901
287
return parsed
902
288
903
class cmd_merge(Command):
904
"""Perform a three-way merge of trees."""
905
takes_args = ['other_spec', 'base_spec']
906
907
def run(self, other_spec, base_spec):
908
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
909
910
class cmd_assert_fail(Command):
911
"""Test reporting of assertion failures"""
912
hidden = True
913
def run(self):
914
assert False, "always fails"
915
916
917
class cmd_help(Command):
918
"""Show help on a command or other topic.
919
920
For a list of all available commands, say 'bzr help commands'."""
921
takes_args = ['topic?']
922
aliases = ['?']
923
924
def run(self, topic=None):
925
import help
926
help.help(topic)
927
928
929
class cmd_update_stat_cache(Command):
930
"""Update stat-cache mapping inodes to SHA-1 hashes.
931
932
For testing only."""
933
hidden = True
934
def run(self):
935
import statcache
936
b = Branch('.')
937
statcache.update_cache(b.base, b.read_working_inventory())
938
939
940
######################################################################
941
# main routine
942
943
944
# list of all available options; the rhs can be either None for an
945
# option that takes no argument, or a constructor function that checks
946
# the type.
947
OPTIONS = {
948
'all': None,
949
'help': None,
950
'file': unicode,
951
'message': unicode,
952
'profile': None,
953
'revision': int,
954
'show-ids': None,
955
'timezone': str,
956
'verbose': None,
957
'version': None,
958
'email': None,
959
}
960
961
SHORT_OPTIONS = {
962
'm': 'message',
963
'F': 'file',
964
'r': 'revision',
965
'v': 'verbose',
966
}
967
968
969
def parse_args(argv):
289
def parse_args(command, argv):
970
290
"""Parse command line.
971
291
972
292
Arguments and options are parsed at this level before being passed
973
293
down to specific command handlers. This routine knows, from a
974
294
lookup table, something about the available options, what optargs
975
295
they take, and which commands will accept them.
976
977
>>> parse_args('--help'.split())
978
([], {'help': True})
979
>>> parse_args('--version'.split())
980
([], {'version': True})
981
>>> parse_args('status --all'.split())
982
(['status'], {'all': True})
983
>>> parse_args('commit --message=biter'.split())
984
(['commit'], {'message': u'biter'})
985
296
"""
297
# TODO: chop up this beast; make it a method of the Command
986
298
args = []
987
299
opts = {}
988
300
989
# TODO: Maybe handle '--' to end options?
990
301
cmd_options = command.options()
302
argsover = False
991
303
while argv:
992
304
a = argv.pop(0)
305
if argsover:
306
args.append(a)
307
continue
308
elif a == '--':
309
# We've received a standalone -- No more flags
310
argsover = True
311
continue
993
312
if a[0] == '-':
994
313
# option names must not be unicode
995
314
a = str(a)
996
315
optarg = None
997
316
if a[1] == '-':
998
mutter(" got option %r" % a)
317
mutter(" got option %r", a)
999
318
if '=' in a:
1000
319
optname, optarg = a[2:].split('=', 1)
1001
320
else:
1002
321
optname = a[2:]
1003
if optname not in OPTIONS:
1004
bailout('unknown long option %r' % a)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
1005
325
else:
1006
326
shortopt = a[1:]
1007
if shortopt not in SHORT_OPTIONS:
1008
bailout('unknown short option %r' % a)
1009
optname = SHORT_OPTIONS[shortopt]
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
329
# their value
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
332
else:
333
# Single character short options, can be chained,
334
# and have their value appended to their name
335
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
341
342
if a[2:]:
343
# There are extra things on this option
344
# see if it is the value, or if it is another
345
# short option
346
optargfn = Option.OPTIONS[optname].type
347
if optargfn is None:
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
350
# into the list
351
argv.insert(0, '-' + a[2:])
352
else:
353
# This option takes an argument, so pack it
354
# into the array
355
optarg = a[2:]
1010
356
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
1011
360
if optname in opts:
1012
361
# XXX: Do we ever want to support this, e.g. for -r?
1013
bailout('repeated option %r' % a)
362
raise BzrError('repeated option %r' % a)
1014
363
1015
optargfn = OPTIONS[optname]
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
1016
366
if optargfn:
1017
367
if optarg == None:
1018
368
if not argv:
1019
bailout('option %r needs an argument' % a)
369
raise BzrError('option %r needs an argument' % a)
1020
370
else:
1021
371
optarg = argv.pop(0)
1022
372
opts[optname] = optargfn(optarg)
1023
373
else:
1024
374
if optarg != None:
1025
bailout('option %r takes no argument' % optname)
375
raise BzrError('option %r takes no argument' % optname)
1026
376
opts[optname] = True
1027
377
else:
1028
378
args.append(a)
1029
1030
379
return args, opts
1031
380
1032
381
1033
1034
1035
382
def _match_argform(cmd, takes_args, args):
1036
383
argdict = {}
1037
384
1077
424
1078
425
1079
426
427
def apply_profiled(the_callable, *args, **kwargs):
428
import hotshot
429
import tempfile
430
import hotshot.stats
431
pffileno, pfname = tempfile.mkstemp()
432
try:
433
prof = hotshot.Profile(pfname)
434
try:
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
436
finally:
437
prof.close()
438
stats = hotshot.stats.load(pfname)
439
stats.strip_dirs()
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
444
return ret
445
finally:
446
os.close(pffileno)
447
os.remove(pfname)
448
449
450
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
451
from bzrlib.lsprof import profile
452
import cPickle
453
ret, stats = profile(the_callable, *args, **kwargs)
454
stats.sort()
455
if filename is None:
456
stats.pprint()
457
else:
458
stats.freeze()
459
cPickle.dump(stats, open(filename, 'w'), 2)
460
print 'Profile data written to %r.' % filename
461
return ret
462
1080
463
def run_bzr(argv):
1081
464
"""Execute a command.
1082
465
1083
466
This is similar to main(), but without all the trappings for
1084
467
logging and error handling.
468
469
argv
470
The command-line arguments, without the program name from argv[0]
471
472
Returns a command status or raises an exception.
473
474
Special master options: these must come before the command because
475
they control how the command is interpreted.
476
477
--no-plugins
478
Do not load plugin modules at all
479
480
--builtin
481
Only use builtin commands. (Plugins are still allowed to change
482
other behaviour.)
483
484
--profile
485
Run under the Python hotshot profiler.
486
487
--lsprof
488
Run under the Python lsprof profiler.
1085
489
"""
1086
490
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1087
491
492
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
493
opt_lsprof_file = None
494
495
# --no-plugins is handled specially at a very early stage. We need
496
# to load plugins before doing other command parsing so that they
497
# can override commands, but this needs to happen first.
498
499
argv_copy = []
500
i = 0
501
while i < len(argv):
502
a = argv[i]
503
if a == '--profile':
504
opt_profile = True
505
elif a == '--lsprof':
506
opt_lsprof = True
507
elif a == '--lsprof-file':
508
opt_lsprof_file = argv[i + 1]
509
i += 1
510
elif a == '--no-plugins':
511
opt_no_plugins = True
512
elif a == '--builtin':
513
opt_builtin = True
514
elif a in ('--quiet', '-q'):
515
be_quiet()
516
else:
517
argv_copy.append(a)
518
i += 1
519
520
argv = argv_copy
521
if (not argv) or (argv[0] == '--help'):
522
from bzrlib.help import help
523
if len(argv) > 1:
524
help(argv[1])
525
else:
526
help()
527
return 0
528
529
if argv[0] == '--version':
530
from bzrlib.builtins import show_version
531
show_version()
532
return 0
533
534
if not opt_no_plugins:
535
from bzrlib.plugin import load_plugins
536
load_plugins()
537
else:
538
from bzrlib.plugin import disable_plugins
539
disable_plugins()
540
541
cmd = str(argv.pop(0))
542
543
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
544
1088
545
try:
1089
args, opts = parse_args(argv[1:])
1090
if 'help' in opts:
1091
import help
1092
if args:
1093
help.help(args[0])
1094
else:
1095
help.help()
1096
return 0
1097
elif 'version' in opts:
1098
show_version()
1099
return 0
1100
cmd = str(args.pop(0))
1101
except IndexError:
1102
import help
1103
help.help()
1104
return 1
1105
1106
1107
canonical_cmd, cmd_class = get_cmd_class(cmd)
1108
1109
# global option
1110
if 'profile' in opts:
1111
profile = True
1112
del opts['profile']
1113
else:
1114
profile = False
1115
1116
# check options are reasonable
1117
allowed = cmd_class.takes_options
1118
for oname in opts:
1119
if oname not in allowed:
1120
raise BzrCommandError("option '--%s' is not allowed for command %r"
1121
% (oname, cmd))
1122
1123
# mix arguments and options into one dictionary
1124
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1125
cmdopts = {}
1126
for k, v in opts.items():
1127
cmdopts[k.replace('-', '_')] = v
1128
1129
if profile:
1130
import hotshot, tempfile
1131
pffileno, pfname = tempfile.mkstemp()
546
if opt_lsprof:
547
ret = apply_lsprofiled(opt_lsprof_file, cmd_obj.run_argv, argv)
548
elif opt_profile:
549
ret = apply_profiled(cmd_obj.run_argv, argv)
550
else:
551
ret = cmd_obj.run_argv(argv)
552
return ret or 0
553
finally:
554
# reset, in case we may do other commands later within the same process
555
be_quiet(False)
556
557
def display_command(func):
558
"""Decorator that suppresses pipe/interrupt errors."""
559
def ignore_pipe(*args, **kwargs):
1132
560
try:
1133
prof = hotshot.Profile(pfname)
1134
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1135
prof.close()
1136
1137
import hotshot.stats
1138
stats = hotshot.stats.load(pfname)
1139
#stats.strip_dirs()
1140
stats.sort_stats('time')
1141
## XXX: Might like to write to stderr or the trace file instead but
1142
## print_stats seems hardcoded to stdout
1143
stats.print_stats(20)
1144
1145
return ret.status
1146
1147
finally:
1148
os.close(pffileno)
1149
os.remove(pfname)
1150
else:
1151
return cmd_class(cmdopts, cmdargs).status
1152
1153
1154
def _report_exception(summary, quiet=False):
1155
import traceback
1156
log_error('bzr: ' + summary)
1157
bzrlib.trace.log_exception()
1158
1159
if not quiet:
1160
tb = sys.exc_info()[2]
1161
exinfo = traceback.extract_tb(tb)
1162
if exinfo:
1163
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1164
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1165
561
result = func(*args, **kwargs)
562
sys.stdout.flush()
563
return result
564
except IOError, e:
565
if not hasattr(e, 'errno'):
566
raise
567
if e.errno != errno.EPIPE:
568
raise
569
pass
570
except KeyboardInterrupt:
571
pass
572
return ignore_pipe
1166
573
1167
574
1168
575
def main(argv):
1169
import errno
1170
1171
bzrlib.open_tracefile(argv)
1172
576
import bzrlib.ui
577
from bzrlib.ui.text import TextUIFactory
578
## bzrlib.trace.enable_default_logging()
579
bzrlib.trace.log_startup(argv)
580
bzrlib.ui.ui_factory = TextUIFactory()
581
ret = run_bzr_catch_errors(argv[1:])
582
mutter("return code %d", ret)
583
return ret
584
585
586
def run_bzr_catch_errors(argv):
1173
587
try:
1174
588
try:
1175
try:
1176
return run_bzr(argv)
1177
finally:
1178
# do this here inside the exception wrappers to catch EPIPE
1179
sys.stdout.flush()
1180
except BzrError, e:
1181
quiet = isinstance(e, (BzrCommandError))
1182
_report_exception('error: ' + e.args[0], quiet=quiet)
1183
if len(e.args) > 1:
1184
for h in e.args[1]:
1185
# some explanation or hints
1186
log_error(' ' + h)
1187
return 1
1188
except AssertionError, e:
1189
msg = 'assertion failed'
1190
if str(e):
1191
msg += ': ' + str(e)
1192
_report_exception(msg)
1193
return 2
1194
except KeyboardInterrupt, e:
1195
_report_exception('interrupted', quiet=True)
1196
return 2
1197
except Exception, e:
1198
quiet = False
1199
if (isinstance(e, IOError)
1200
and hasattr(e, 'errno')
1201
and e.errno == errno.EPIPE):
1202
quiet = True
1203
msg = 'broken pipe'
1204
else:
1205
msg = str(e).rstrip('\n')
1206
_report_exception(msg, quiet)
1207
return 2
1208
finally:
1209
bzrlib.trace.close_trace()
1210
589
return run_bzr(argv)
590
finally:
591
# do this here inside the exception wrappers to catch EPIPE
592
sys.stdout.flush()
593
except Exception, e:
594
# used to handle AssertionError and KeyboardInterrupt
595
# specially here, but hopefully they're handled ok by the logger now
596
import errno
597
if (isinstance(e, IOError)
598
and hasattr(e, 'errno')
599
and e.errno == errno.EPIPE):
600
bzrlib.trace.note('broken pipe')
601
return 3
602
else:
603
bzrlib.trace.log_exception()
604
if os.environ.get('BZR_PDB'):
605
print '**** entering debugger'
606
import pdb
607
pdb.post_mortem(sys.exc_traceback)
608
return 3
1211
609
1212
610
if __name__ == '__main__':
1213
611
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1