« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 254
- compare with another revision
- download diff
- download tarball
- view history from revision 254
- Committer: Martin Pool
- Date: 2005-04-15 01:31:21 UTC
- Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning
- files added:
- bzrlib/tests.py
- files removed:
- TODO
- bzrlib/selftest
- contrib
- contrib/bash
- contrib/zsh
- effbot
- effbot/org
- patches
- plugins
- plugins/changeset
- plugins/rsync
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
2
4
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
18
17
18
19
import sys, os
19
"""Bazaar-NG -- a free distributed version-control tool
20
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
23
Current limitation include:
24
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
27
28
* Insufficient error handling.
29
30
* Many commands unimplemented or partially implemented.
31
32
* Space-inefficient storage.
33
34
* No merge operators yet.
35
36
Interesting commands::
37
38
bzr help [COMMAND]
39
Show help screen
40
bzr version
41
Show software version/licence/non-warranty.
42
bzr init
43
Start versioning the current directory
44
bzr add FILE...
45
Make files versioned.
46
bzr log
47
Show revision history.
48
bzr diff [FILE...]
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
54
bzr status
55
Show summary of pending changes.
56
bzr remove FILE...
57
Make a file not versioned.
58
bzr info
59
Show statistics about this branch.
60
"""
61
62
63
64
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
66
from sets import Set
67
from pprint import pprint
68
from stat import *
69
from glob import glob
70
from inspect import getdoc
20
71
21
72
import bzrlib
73
from bzrlib.store import ImmutableStore
22
74
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
25
from bzrlib import BZRDIR
26
27
28
plugin_cmds = {}
29
30
31
def register_command(cmd):
32
"Utility function to help register a command"
33
global plugin_cmds
34
k = cmd.__name__
35
if k.startswith("cmd_"):
36
k_unsquished = _unsquish_command_name(k)
37
else:
38
k_unsquished = k
39
if not plugin_cmds.has_key(k_unsquished):
40
plugin_cmds[k_unsquished] = cmd
41
else:
42
log_error('Two plugins defined the same command: %r' % k)
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
44
45
46
def _squish_command_name(cmd):
47
return 'cmd_' + cmd.replace('-', '_')
48
49
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
return cmd[4:].replace('_','-')
53
54
def _parse_revision_str(revstr):
55
"""This handles a revision string -> revno.
56
57
There are several possibilities:
58
59
'234' -> 234
60
'234:345' -> [234, 345]
61
':234' -> [None, 234]
62
'234:' -> [234, None]
63
64
In the future we will also support:
65
'uuid:blah-blah-blah' -> ?
66
'hash:blahblahblah' -> ?
67
potentially:
68
'tag:mytag' -> ?
69
"""
70
if revstr.find(':') != -1:
71
revs = revstr.split(':')
72
if len(revs) > 2:
73
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
74
75
if not revs[0]:
76
revs[0] = None
77
else:
78
revs[0] = int(revs[0])
79
80
if not revs[1]:
81
revs[1] = None
82
else:
83
revs[1] = int(revs[1])
84
else:
85
revs = int(revstr)
86
return revs
87
88
89
90
def _get_cmd_dict(plugins_override=True):
91
d = {}
92
for k, v in globals().iteritems():
93
if k.startswith("cmd_"):
94
d[_unsquish_command_name(k)] = v
95
# If we didn't load plugins, the plugin_cmds dict will be empty
96
if plugins_override:
97
d.update(plugin_cmds)
98
else:
99
d2 = plugin_cmds.copy()
100
d2.update(d)
101
d = d2
102
return d
103
104
105
def get_all_cmds(plugins_override=True):
106
"""Return canonical name and class for all registered commands."""
107
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
108
yield k,v
109
110
111
def get_cmd_class(cmd, plugins_override=True):
112
"""Return the canonical name and command class for a command.
113
"""
114
cmd = str(cmd) # not unicode
115
116
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
118
try:
119
return cmd, cmds[cmd]
120
except KeyError:
121
pass
122
123
# look for any command which claims this as an alias
124
for cmdname, cmdclass in cmds.iteritems():
125
if cmd in cmdclass.aliases:
126
return cmdname, cmdclass
127
128
cmdclass = ExternalCommand.find_command(cmd)
129
if cmdclass:
130
return cmd, cmdclass
131
132
raise BzrCommandError("unknown command %r" % cmd)
133
134
135
class Command(object):
136
"""Base class for commands.
137
138
The docstring for an actual command should give a single-line
139
summary, then a complete description of the command. A grammar
140
description will be inserted.
141
142
takes_args
143
List of argument forms, marked with whether they are optional,
144
repeated, etc.
145
146
takes_options
147
List of options that may be given for this command.
148
149
hidden
150
If true, this command isn't advertised.
151
"""
152
aliases = []
153
154
takes_args = []
155
takes_options = []
156
157
hidden = False
158
159
def __init__(self, options, arguments):
160
"""Construct and run the command.
161
162
Sets self.status to the return value of run()."""
163
assert isinstance(options, dict)
164
assert isinstance(arguments, dict)
165
cmdargs = options.copy()
166
cmdargs.update(arguments)
167
assert self.__doc__ != Command.__doc__, \
168
("No help message set for %r" % self)
169
self.status = self.run(**cmdargs)
170
171
172
def run(self):
173
"""Override this in sub-classes.
174
175
This is invoked with the options and arguments bound to
176
keyword parameters.
177
178
Return 0 or None if the command was successful, or a shell
179
error code if not.
180
"""
181
return 0
182
183
184
class ExternalCommand(Command):
185
"""Class to wrap external commands.
186
187
We cheat a little here, when get_cmd_class() calls us we actually give it back
188
an object we construct that has the appropriate path, help, options etc for the
189
specified command.
190
191
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
192
method, which we override to call the Command.__init__ method. That then calls
193
our run method which is pretty straight forward.
194
195
The only wrinkle is that we have to map bzr's dictionary of options and arguments
196
back into command line options and arguments for the script.
197
"""
198
199
def find_command(cls, cmd):
200
import os.path
201
bzrpath = os.environ.get('BZRPATH', '')
202
203
for dir in bzrpath.split(os.pathsep):
204
path = os.path.join(dir, cmd)
205
if os.path.isfile(path):
206
return ExternalCommand(path)
207
208
return None
209
210
find_command = classmethod(find_command)
211
212
def __init__(self, path):
213
self.path = path
214
215
pipe = os.popen('%s --bzr-usage' % path, 'r')
216
self.takes_options = pipe.readline().split()
217
218
for opt in self.takes_options:
219
if not opt in OPTIONS:
220
raise BzrError("Unknown option '%s' returned by external command %s"
221
% (opt, path))
222
223
# TODO: Is there any way to check takes_args is valid here?
224
self.takes_args = pipe.readline().split()
225
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
228
229
pipe = os.popen('%s --bzr-help' % path, 'r')
230
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
233
234
def __call__(self, options, arguments):
235
Command.__init__(self, options, arguments)
236
return self
237
238
def run(self, **kargs):
239
opts = []
240
args = []
241
242
keys = kargs.keys()
243
keys.sort()
244
for name in keys:
245
optname = name.replace('_','-')
246
value = kargs[name]
247
if OPTIONS.has_key(optname):
248
# it's an option
249
opts.append('--%s' % optname)
250
if value is not None and value is not True:
251
opts.append(str(value))
252
else:
253
# it's an arg, or arg list
254
if type(value) is not list:
255
value = [value]
256
for v in value:
257
if v is not None:
258
args.append(str(v))
259
260
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
261
return self.status
262
263
264
class cmd_status(Command):
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
80
format_date
81
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
84
85
## standard representation
86
NONE_STRING = '(none)'
87
EMPTY = 'empty'
88
89
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
92
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
94
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
99
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
102
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
106
## directory.
107
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
111
112
## TODO: move command; check destination is a directory and will not
113
## clash; move it.
114
115
## TODO: command to show renames, one per line, as to->from
116
117
118
119
120
def cmd_status(all=False):
265
121
"""Display status summary.
266
122
267
This reports on versioned and unknown files, reporting them
268
grouped by state. Possible states are:
269
270
added
271
Versioned in the working copy but not in the previous revision.
272
273
removed
274
Versioned in the previous revision but removed or deleted
275
in the working copy.
276
277
renamed
278
Path of this file changed from the previous revision;
279
the text may also have changed. This includes files whose
280
parent directory was renamed.
281
282
modified
283
Text has changed since the previous revision.
284
285
unchanged
286
Nothing about this file has changed since the previous revision.
287
Only shown with --all.
288
289
unknown
290
Not versioned and not matching an ignore pattern.
291
292
To see ignored files use 'bzr ignored'. For details in the
293
changes to file texts, use 'bzr diff'.
294
295
If no arguments are specified, the status of the entire working
296
directory is shown. Otherwise, only the status of the specified
297
files or directories is reported. If a directory is given, status
298
is reported for everything inside that directory.
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
299
126
"""
300
takes_args = ['file*']
301
takes_options = ['all', 'show-ids']
302
aliases = ['st', 'stat']
303
304
def run(self, all=False, show_ids=False, file_list=None):
305
if file_list:
306
b = find_branch(file_list[0])
307
file_list = [b.relpath(x) for x in file_list]
308
# special case: only one path was given and it's the root
309
# of the branch
310
if file_list == ['']:
311
file_list = None
312
else:
313
b = find_branch('.')
314
import status
315
status.show_status(b, show_unchanged=all, show_ids=show_ids,
316
specific_files=file_list)
317
318
319
class cmd_cat_revision(Command):
320
"""Write out metadata for a revision."""
321
322
hidden = True
323
takes_args = ['revision_id']
324
325
def run(self, revision_id):
326
from bzrlib.xml import pack_xml
327
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
328
329
330
class cmd_revno(Command):
331
"""Show current revision number.
332
333
This is equal to the number of revisions on this branch."""
334
def run(self):
335
print find_branch('.').revno()
336
337
338
class cmd_add(Command):
127
#import bzrlib.status
128
#bzrlib.status.tree_status(Branch('.'))
129
Branch('.').show_status(show_all=all)
130
131
132
133
######################################################################
134
# examining history
135
def cmd_get_revision(revision_id):
136
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
137
138
139
def cmd_get_file_text(text_id):
140
"""Get contents of a file by hash."""
141
sf = Branch('.').text_store[text_id]
142
pumpfile(sf, sys.stdout)
143
144
145
146
######################################################################
147
# commands
148
149
150
def cmd_revno():
151
"""Show number of revisions on this branch"""
152
print Branch('.').revno()
153
154
155
156
def cmd_add(file_list, verbose=False):
339
157
"""Add specified files or directories.
340
158
341
159
In non-recursive mode, all the named items are added, regardless
352
170
353
171
Therefore simply saying 'bzr add .' will version all files that
354
172
are currently unknown.
355
356
TODO: Perhaps adding a file whose directly is not versioned should
357
recursively add that parent, rather than giving an error?
358
173
"""
359
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
174
bzrlib.add.smart_add(file_list, verbose)
361
175
362
def run(self, file_list, verbose=False, no_recurse=False):
363
from bzrlib.add import smart_add
364
smart_add(file_list, verbose, not no_recurse)
365
366
367
368
class cmd_mkdir(Command):
369
"""Create a new versioned directory.
370
371
This is equivalent to creating the directory and then adding it.
372
"""
373
takes_args = ['dir+']
374
375
def run(self, dir_list):
376
b = None
176
177
def cmd_relpath(filename):
178
"""Show path of file relative to root"""
179
print Branch(filename).relpath(filename)
180
181
182
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
187
b = Branch('.')
188
if revision == None:
189
inv = b.read_working_inventory()
190
else:
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
377
192
378
for d in dir_list:
379
os.mkdir(d)
380
if not b:
381
b = find_branch(d)
382
b.add([d], verbose=True)
383
384
385
class cmd_relpath(Command):
386
"""Show path of a file relative to root"""
387
takes_args = ['filename']
388
hidden = True
389
390
def run(self, filename):
391
print find_branch(filename).relpath(filename)
392
393
394
395
class cmd_inventory(Command):
396
"""Show inventory of the current working copy or a revision."""
397
takes_options = ['revision', 'show-ids']
398
399
def run(self, revision=None, show_ids=False):
400
b = find_branch('.')
401
if revision == None:
402
inv = b.read_working_inventory()
403
else:
404
inv = b.get_revision_inventory(b.lookup_revision(revision))
405
406
for path, entry in inv.entries():
407
if show_ids:
408
print '%-50s %s' % (path, entry.file_id)
409
else:
410
print path
411
412
413
class cmd_move(Command):
414
"""Move files to a different directory.
415
416
examples:
417
bzr move *.txt doc
418
419
The destination must be a versioned directory in the same branch.
420
"""
421
takes_args = ['source$', 'dest']
422
def run(self, source_list, dest):
423
b = find_branch('.')
424
425
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
426
427
428
class cmd_rename(Command):
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
195
196
197
198
# TODO: Maybe a 'mv' command that has the combined move/rename
199
# special behaviour of Unix?
200
201
def cmd_move(source_list, dest):
202
b = Branch('.')
203
204
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
205
206
207
208
def cmd_rename(from_name, to_name):
429
209
"""Change the name of an entry.
430
210
211
usage: bzr rename FROM_NAME TO_NAME
212
431
213
examples:
432
214
bzr rename frob.c frobber.c
433
215
bzr rename src/frob.c lib/frob.c
439
221
440
222
TODO: Some way to rename multiple files without invoking bzr for each
441
223
one?"""
442
takes_args = ['from_name', 'to_name']
224
b = Branch('.')
225
b.rename_one(b.relpath(from_name), b.relpath(to_name))
443
226
444
def run(self, from_name, to_name):
445
b = find_branch('.')
446
b.rename_one(b.relpath(from_name), b.relpath(to_name))
447
448
449
450
451
452
class cmd_pull(Command):
453
"""Pull any changes from another branch into the current one.
454
455
If the location is omitted, the last-used location will be used.
456
Both the revision history and the working directory will be
457
updated.
458
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if both branches have had commits without first
461
pulling from the other.
462
463
If branches have diverged, you can use 'bzr merge' to pull the text changes
464
from one into the other.
465
"""
466
takes_args = ['location?']
467
468
def run(self, location=None):
469
from bzrlib.merge import merge
470
import tempfile
471
from shutil import rmtree
472
import errno
473
474
br_to = find_branch('.')
475
stored_loc = None
476
try:
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
478
except IOError, e:
479
if e.errno != errno.ENOENT:
480
raise
481
if location is None:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
484
else:
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
cache_root = tempfile.mkdtemp()
488
from bzrlib.branch import DivergedBranches
489
br_from = find_branch(location)
490
location = pull_loc(br_from)
491
old_revno = br_to.revno()
492
try:
493
from branch import find_cached_branch, DivergedBranches
494
br_from = find_cached_branch(location, cache_root)
495
location = pull_loc(br_from)
496
old_revno = br_to.revno()
497
try:
498
br_to.update_revisions(br_from)
499
except DivergedBranches:
500
raise BzrCommandError("These branches have diverged."
501
" Try merge.")
502
503
merge(('.', -1), ('.', old_revno), check_clean=False)
504
if location != stored_loc:
505
br_to.controlfile("x-pull", "wb").write(location + "\n")
506
finally:
507
rmtree(cache_root)
508
509
510
511
class cmd_branch(Command):
512
"""Create a new copy of a branch.
513
514
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
515
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
516
517
To retrieve the branch as of a particular revision, supply the --revision
518
parameter, as in "branch foo/bar -r 5".
519
"""
520
takes_args = ['from_location', 'to_location?']
521
takes_options = ['revision']
522
523
def run(self, from_location, to_location=None, revision=None):
524
import errno
525
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
527
find_cached_branch, Branch
528
from shutil import rmtree
529
from meta_store import CachedStore
530
import tempfile
531
cache_root = tempfile.mkdtemp()
532
try:
533
try:
534
br_from = find_cached_branch(from_location, cache_root)
535
except OSError, e:
536
if e.errno == errno.ENOENT:
537
raise BzrCommandError('Source location "%s" does not'
538
' exist.' % to_location)
539
else:
540
raise
541
542
if to_location is None:
543
to_location = os.path.basename(from_location.rstrip("/\\"))
544
545
try:
546
os.mkdir(to_location)
547
except OSError, e:
548
if e.errno == errno.EEXIST:
549
raise BzrCommandError('Target directory "%s" already'
550
' exists.' % to_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Parent of "%s" does not exist.' %
553
to_location)
554
else:
555
raise
556
br_to = Branch(to_location, init=True)
557
558
try:
559
br_to.update_revisions(br_from, stop_revision=revision)
560
except NoSuchRevision:
561
rmtree(to_location)
562
msg = "The branch %s has no revision %d." % (from_location,
563
revision)
564
raise BzrCommandError(msg)
565
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
check_clean=False, ignore_zero=True)
567
from_location = pull_loc(br_from)
568
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
569
finally:
570
rmtree(cache_root)
571
572
573
def pull_loc(branch):
574
# TODO: Should perhaps just make attribute be 'base' in
575
# RemoteBranch and Branch?
576
if hasattr(branch, "baseurl"):
577
return branch.baseurl
578
else:
579
return branch.base
580
581
582
583
class cmd_renames(Command):
227
228
229
230
def cmd_renames(dir='.'):
584
231
"""Show list of renamed files.
585
232
233
usage: bzr renames [BRANCH]
234
586
235
TODO: Option to show renames between two historical versions.
587
236
588
237
TODO: Only show renames under dir, rather than in the whole branch.
589
238
"""
590
takes_args = ['dir?']
591
592
def run(self, dir='.'):
593
b = find_branch(dir)
594
old_inv = b.basis_tree().inventory
595
new_inv = b.read_working_inventory()
596
597
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
598
renames.sort()
599
for old_name, new_name in renames:
600
print "%s => %s" % (old_name, new_name)
601
602
603
class cmd_info(Command):
604
"""Show statistical information about a branch."""
605
takes_args = ['branch?']
606
607
def run(self, branch=None):
608
import info
609
610
b = find_branch(branch)
611
info.show_info(b)
612
613
614
class cmd_remove(Command):
615
"""Make a file unversioned.
616
617
This makes bzr stop tracking changes to a versioned file. It does
618
not delete the working copy.
619
"""
620
takes_args = ['file+']
621
takes_options = ['verbose']
622
623
def run(self, file_list, verbose=False):
624
b = find_branch(file_list[0])
625
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
626
627
628
class cmd_file_id(Command):
239
b = Branch(dir)
240
old_inv = b.basis_tree().inventory
241
new_inv = b.read_working_inventory()
242
243
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
244
renames.sort()
245
for old_name, new_name in renames:
246
print "%s => %s" % (old_name, new_name)
247
248
249
250
def cmd_info():
251
"""info: Show statistical information for this branch
252
253
usage: bzr info"""
254
import info
255
info.show_info(Branch('.'))
256
257
258
259
def cmd_remove(file_list, verbose=False):
260
b = Branch(file_list[0])
261
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
262
263
264
265
def cmd_file_id(filename):
629
266
"""Print file_id of a particular file or directory.
630
267
268
usage: bzr file-id FILE
269
631
270
The file_id is assigned when the file is first added and remains the
632
271
same through all revisions where the file exists, even when it is
633
272
moved or renamed.
634
273
"""
635
hidden = True
636
takes_args = ['filename']
637
def run(self, filename):
638
b = find_branch(filename)
639
i = b.inventory.path2id(b.relpath(filename))
640
if i == None:
641
raise BzrError("%r is not a versioned file" % filename)
642
else:
643
print i
644
645
646
class cmd_file_path(Command):
274
b = Branch(filename)
275
i = b.inventory.path2id(b.relpath(filename))
276
if i == None:
277
bailout("%r is not a versioned file" % filename)
278
else:
279
print i
280
281
282
def cmd_file_id_path(filename):
647
283
"""Print path of file_ids to a file or directory.
648
284
285
usage: bzr file-id-path FILE
286
649
287
This prints one line for each directory down to the target,
650
288
starting at the branch root."""
651
hidden = True
652
takes_args = ['filename']
653
def run(self, filename):
654
b = find_branch(filename)
655
inv = b.inventory
656
fid = inv.path2id(b.relpath(filename))
657
if fid == None:
658
raise BzrError("%r is not a versioned file" % filename)
659
for fip in inv.get_idpath(fid):
660
print fip
661
662
663
class cmd_revision_history(Command):
664
"""Display list of revision ids on this branch."""
665
hidden = True
666
def run(self):
667
for patchid in find_branch('.').revision_history():
668
print patchid
669
670
671
class cmd_directories(Command):
672
"""Display list of versioned directories in this branch."""
673
def run(self):
674
for name, ie in find_branch('.').read_working_inventory().directories():
675
if name == '':
676
print '.'
677
else:
678
print name
679
680
681
class cmd_init(Command):
682
"""Make a directory into a versioned branch.
683
684
Use this to create an empty branch, or before importing an
685
existing project.
686
687
Recipe for importing a tree of files:
688
cd ~/project
689
bzr init
690
bzr add -v .
691
bzr status
692
bzr commit -m 'imported project'
693
"""
694
def run(self):
695
from bzrlib.branch import Branch
696
Branch('.', init=True)
697
698
699
class cmd_diff(Command):
700
"""Show differences in working tree.
701
289
b = Branch(filename)
290
inv = b.inventory
291
fid = inv.path2id(b.relpath(filename))
292
if fid == None:
293
bailout("%r is not a versioned file" % filename)
294
for fip in inv.get_idpath(fid):
295
print fip
296
297
298
def cmd_revision_history():
299
for patchid in Branch('.').revision_history():
300
print patchid
301
302
303
def cmd_directories():
304
for name, ie in Branch('.').read_working_inventory().directories():
305
if name == '':
306
print '.'
307
else:
308
print name
309
310
311
def cmd_missing():
312
for name, ie in Branch('.').working_tree().missing():
313
print name
314
315
316
def cmd_init():
317
# TODO: Check we're not already in a working directory? At the
318
# moment you'll get an ugly error.
319
320
# TODO: What if we're in a subdirectory of a branch? Would like
321
# to allow that, but then the parent may need to understand that
322
# the children have disappeared, or should they be versioned in
323
# both?
324
325
# TODO: Take an argument/option for branch name.
326
Branch('.', init=True)
327
328
329
def cmd_diff(revision=None, file_list=None):
330
"""bzr diff: Show differences in working tree.
331
332
usage: bzr diff [-r REV] [FILE...]
333
334
--revision REV
335
Show changes since REV, rather than predecessor.
336
702
337
If files are listed, only the changes in those files are listed.
703
338
Otherwise, all changes for the tree are listed.
704
339
709
344
TODO: Option to use external diff command; could be GNU diff, wdiff,
710
345
or a graphical diff.
711
346
712
TODO: Python difflib is not exactly the same as unidiff; should
713
either fix it up or prefer to use an external diff.
714
715
347
TODO: If a directory is given, diff everything under that.
716
348
717
TODO: Selected-file diff is inefficient and doesn't show you
718
deleted files.
719
720
TODO: This probably handles non-Unix newlines poorly.
721
"""
349
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
350
"""
351
352
## TODO: Shouldn't be in the cmd function.
353
354
b = Branch('.')
355
356
if revision == None:
357
old_tree = b.basis_tree()
358
else:
359
old_tree = b.revision_tree(b.lookup_revision(revision))
360
361
new_tree = b.working_tree()
362
363
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
364
old_label = ''
365
new_label = ''
366
367
DEVNULL = '/dev/null'
368
# Windows users, don't panic about this filename -- it is a
369
# special signal to GNU patch that the file should be created or
370
# deleted respectively.
371
372
# TODO: Generation of pseudo-diffs for added/deleted files could
373
# be usefully made into a much faster special case.
374
375
# TODO: Better to return them in sorted order I think.
376
377
# FIXME: If given a file list, compare only those files rather
378
# than comparing everything and then throwing stuff away.
722
379
723
takes_args = ['file*']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
726
727
def run(self, revision=None, file_list=None, diff_options=None):
728
from bzrlib.diff import show_diff
729
730
if file_list:
731
b = find_branch(file_list[0])
732
file_list = [b.relpath(f) for f in file_list]
733
if file_list == ['']:
734
# just pointing to top-of-tree
735
file_list = None
380
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
381
382
if file_list and new_name not in file_list:
383
continue
384
385
# Don't show this by default; maybe do it if an option is passed
386
# idlabel = ' {%s}' % fid
387
idlabel = ''
388
389
# FIXME: Something about the diff format makes patch unhappy
390
# with newly-added files.
391
392
def diffit(oldlines, newlines, **kw):
393
# FIXME: difflib is wrong if there is no trailing newline.
394
395
# Special workaround for Python2.3, where difflib fails if
396
# both sequences are empty.
397
if oldlines or newlines:
398
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
399
print
400
401
if file_state in ['.', '?', 'I']:
402
continue
403
elif file_state == 'A':
404
print '*** added %s %r' % (kind, new_name)
405
if kind == 'file':
406
diffit([],
407
new_tree.get_file(fid).readlines(),
408
fromfile=DEVNULL,
409
tofile=new_label + new_name + idlabel)
410
elif file_state == 'D':
411
assert isinstance(old_name, types.StringTypes)
412
print '*** deleted %s %r' % (kind, old_name)
413
if kind == 'file':
414
diffit(old_tree.get_file(fid).readlines(), [],
415
fromfile=old_label + old_name + idlabel,
416
tofile=DEVNULL)
417
elif file_state in ['M', 'R']:
418
if file_state == 'M':
419
assert kind == 'file'
420
assert old_name == new_name
421
print '*** modified %s %r' % (kind, new_name)
422
elif file_state == 'R':
423
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
424
425
if kind == 'file':
426
diffit(old_tree.get_file(fid).readlines(),
427
new_tree.get_file(fid).readlines(),
428
fromfile=old_label + old_name + idlabel,
429
tofile=new_label + new_name)
736
430
else:
737
b = find_branch('.')
738
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
741
742
743
744
745
746
class cmd_deleted(Command):
431
bailout("can't represent state %s {%s}" % (file_state, fid))
432
433
434
435
def cmd_deleted(show_ids=False):
747
436
"""List files deleted in the working tree.
748
437
749
438
TODO: Show files deleted since a previous revision, or between two revisions.
750
439
"""
751
def run(self, show_ids=False):
752
b = find_branch('.')
753
old = b.basis_tree()
754
new = b.working_tree()
755
756
## TODO: Much more efficient way to do this: read in new
757
## directories with readdir, rather than stating each one. Same
758
## level of effort but possibly much less IO. (Or possibly not,
759
## if the directories are very large...)
760
761
for path, ie in old.inventory.iter_entries():
762
if not new.has_id(ie.file_id):
763
if show_ids:
764
print '%-50s %s' % (path, ie.file_id)
765
else:
766
print path
767
768
769
class cmd_modified(Command):
770
"""List files modified in working tree."""
771
hidden = True
772
def run(self):
773
import statcache
774
b = find_branch('.')
775
inv = b.read_working_inventory()
776
sc = statcache.update_cache(b, inv)
777
basis = b.basis_tree()
778
basis_inv = basis.inventory
779
780
# We used to do this through iter_entries(), but that's slow
781
# when most of the files are unmodified, as is usually the
782
# case. So instead we iterate by inventory entry, and only
783
# calculate paths as necessary.
784
785
for file_id in basis_inv:
786
cacheentry = sc.get(file_id)
787
if not cacheentry: # deleted
788
continue
789
ie = basis_inv[file_id]
790
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
791
path = inv.id2path(file_id)
440
b = Branch('.')
441
old = b.basis_tree()
442
new = b.working_tree()
443
444
## TODO: Much more efficient way to do this: read in new
445
## directories with readdir, rather than stating each one. Same
446
## level of effort but possibly much less IO. (Or possibly not,
447
## if the directories are very large...)
448
449
for path, ie in old.inventory.iter_entries():
450
if not new.has_id(ie.file_id):
451
if show_ids:
452
print '%-50s %s' % (path, ie.file_id)
453
else:
792
454
print path
793
455
794
456
795
457
796
class cmd_added(Command):
797
"""List files added in working tree."""
798
hidden = True
799
def run(self):
800
b = find_branch('.')
801
wt = b.working_tree()
802
basis_inv = b.basis_tree().inventory
803
inv = wt.inventory
804
for file_id in inv:
805
if file_id in basis_inv:
806
continue
807
path = inv.id2path(file_id)
808
if not os.access(b.abspath(path), os.F_OK):
809
continue
810
print path
458
def cmd_parse_inventory():
459
import cElementTree
460
461
cElementTree.ElementTree().parse(file('.bzr/inventory'))
462
463
464
465
def cmd_load_inventory():
466
"""Load inventory for timing purposes"""
467
Branch('.').basis_tree().inventory
468
469
470
def cmd_dump_inventory():
471
Branch('.').read_working_inventory().write_xml(sys.stdout)
472
473
474
def cmd_dump_new_inventory():
475
import bzrlib.newinventory
476
inv = Branch('.').basis_tree().inventory
477
bzrlib.newinventory.write_inventory(inv, sys.stdout)
478
479
480
def cmd_load_new_inventory():
481
import bzrlib.newinventory
482
bzrlib.newinventory.read_new_inventory(sys.stdin)
811
483
812
813
814
class cmd_root(Command):
815
"""Show the tree root directory.
816
817
The root is the nearest enclosing directory with a .bzr control
818
directory."""
819
takes_args = ['filename?']
820
def run(self, filename=None):
821
"""Print the branch root."""
822
b = find_branch(filename)
823
print getattr(b, 'base', None) or getattr(b, 'baseurl')
824
825
826
class cmd_log(Command):
484
485
def cmd_dump_slacker_inventory():
486
import bzrlib.newinventory
487
inv = Branch('.').basis_tree().inventory
488
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
489
490
491
492
def cmd_dump_text_inventory():
493
import bzrlib.textinv
494
inv = Branch('.').basis_tree().inventory
495
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
496
497
498
def cmd_load_text_inventory():
499
import bzrlib.textinv
500
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
501
print 'loaded %d entries' % len(inv)
502
503
504
505
def cmd_root(filename=None):
506
"""Print the branch root."""
507
print bzrlib.branch.find_branch_root(filename)
508
509
510
def cmd_log(timezone='original', verbose=False):
827
511
"""Show log of this branch.
828
512
829
To request a range of logs, you can use the command -r begin:end
830
-r revision requests a specific revision, -r :end or -r begin: are
831
also valid.
832
833
TODO: Make --revision support uuid: and hash: [future tag:] notation.
834
513
TODO: Options for utc; to show ids; to limit range; etc.
835
514
"""
836
837
takes_args = ['filename?']
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
839
840
def run(self, filename=None, timezone='original',
841
verbose=False,
842
show_ids=False,
843
forward=False,
844
revision=None):
845
from bzrlib.branch import find_branch
846
from bzrlib.log import log_formatter, show_log
847
import codecs
848
849
direction = (forward and 'forward') or 'reverse'
850
851
if filename:
852
b = find_branch(filename)
853
fp = b.relpath(filename)
854
if fp:
855
file_id = b.read_working_inventory().path2id(fp)
856
else:
857
file_id = None # points to branch root
858
else:
859
b = find_branch('.')
860
file_id = None
861
862
if revision == None:
863
revision = [None, None]
864
elif isinstance(revision, int):
865
revision = [revision, revision]
866
else:
867
# pair of revisions?
868
pass
869
870
assert len(revision) == 2
871
872
mutter('encoding log as %r' % bzrlib.user_encoding)
873
874
# use 'replace' so that we don't abort if trying to write out
875
# in e.g. the default C locale.
876
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
877
878
lf = log_formatter('short',
879
show_ids=show_ids,
880
to_file=outf,
881
show_timezone=timezone)
882
883
show_log(b,
884
lf,
885
file_id,
886
verbose=verbose,
887
direction=direction,
888
start_revision=revision[0],
889
end_revision=revision[1])
890
891
892
893
class cmd_touching_revisions(Command):
894
"""Return revision-ids which affected a particular file.
895
896
A more user-friendly interface is "bzr log FILE"."""
897
hidden = True
898
takes_args = ["filename"]
899
def run(self, filename):
900
b = find_branch(filename)
901
inv = b.read_working_inventory()
902
file_id = inv.path2id(b.relpath(filename))
903
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
904
print "%6d %s" % (revno, what)
905
906
907
class cmd_ls(Command):
515
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
516
517
518
def cmd_ls(revision=None, verbose=False):
908
519
"""List files in a tree.
909
520
910
521
TODO: Take a revision or remote path and list that tree instead.
911
522
"""
912
hidden = True
913
def run(self, revision=None, verbose=False):
914
b = find_branch('.')
915
if revision == None:
916
tree = b.working_tree()
917
else:
918
tree = b.revision_tree(b.lookup_revision(revision))
919
920
for fp, fc, kind, fid in tree.list_files():
921
if verbose:
922
if kind == 'directory':
923
kindch = '/'
924
elif kind == 'file':
925
kindch = ''
926
else:
927
kindch = '???'
928
929
print '%-8s %s%s' % (fc, fp, kindch)
523
b = Branch('.')
524
if revision == None:
525
tree = b.working_tree()
526
else:
527
tree = b.revision_tree(b.lookup_revision(revision))
528
529
for fp, fc, kind, fid in tree.list_files():
530
if verbose:
531
if kind == 'directory':
532
kindch = '/'
533
elif kind == 'file':
534
kindch = ''
930
535
else:
931
print fp
932
933
934
935
class cmd_unknowns(Command):
936
"""List unknown files."""
937
def run(self):
938
from bzrlib.osutils import quotefn
939
for f in find_branch('.').unknowns():
940
print quotefn(f)
941
942
943
944
class cmd_ignore(Command):
945
"""Ignore a command or pattern.
946
947
To remove patterns from the ignore list, edit the .bzrignore file.
948
949
If the pattern contains a slash, it is compared to the whole path
950
from the branch root. Otherwise, it is comapred to only the last
951
component of the path.
952
953
Ignore patterns are case-insensitive on case-insensitive systems.
954
955
Note: wildcards must be quoted from the shell on Unix.
956
957
examples:
958
bzr ignore ./Makefile
959
bzr ignore '*.class'
960
"""
961
takes_args = ['name_pattern']
962
963
def run(self, name_pattern):
964
from bzrlib.atomicfile import AtomicFile
965
import os.path
966
967
b = find_branch('.')
968
ifn = b.abspath('.bzrignore')
969
970
if os.path.exists(ifn):
971
f = open(ifn, 'rt')
972
try:
973
igns = f.read().decode('utf-8')
974
finally:
975
f.close()
976
else:
977
igns = ''
978
979
# TODO: If the file already uses crlf-style termination, maybe
980
# we should use that for the newly added lines?
981
982
if igns and igns[-1] != '\n':
983
igns += '\n'
984
igns += name_pattern + '\n'
985
986
try:
987
f = AtomicFile(ifn, 'wt')
988
f.write(igns.encode('utf-8'))
989
f.commit()
990
finally:
991
f.close()
992
993
inv = b.working_tree().inventory
994
if inv.path2id('.bzrignore'):
995
mutter('.bzrignore is already versioned')
996
else:
997
mutter('need to make new .bzrignore file versioned')
998
b.add(['.bzrignore'])
999
1000
1001
1002
class cmd_ignored(Command):
536
kindch = '???'
537
538
print '%-8s %s%s' % (fc, fp, kindch)
539
else:
540
print fp
541
542
543
544
def cmd_unknowns():
545
"""List unknown files"""
546
for f in Branch('.').unknowns():
547
print quotefn(f)
548
549
550
551
def cmd_ignored():
1003
552
"""List ignored files and the patterns that matched them.
1004
1005
See also: bzr ignore"""
1006
def run(self):
1007
tree = find_branch('.').working_tree()
1008
for path, file_class, kind, file_id in tree.list_files():
1009
if file_class != 'I':
1010
continue
1011
## XXX: Slightly inefficient since this was already calculated
1012
pat = tree.is_ignored(path)
1013
print '%-50s %s' % (path, pat)
1014
1015
1016
class cmd_lookup_revision(Command):
1017
"""Lookup the revision-id from a revision-number
1018
1019
example:
1020
bzr lookup-revision 33
1021
"""
1022
hidden = True
1023
takes_args = ['revno']
1024
1025
def run(self, revno):
1026
try:
1027
revno = int(revno)
1028
except ValueError:
1029
raise BzrCommandError("not a valid revision-number: %r" % revno)
1030
1031
print find_branch('.').lookup_revision(revno)
1032
1033
1034
class cmd_export(Command):
1035
"""Export past revision to destination directory.
1036
1037
If no revision is specified this exports the last committed revision.
1038
1039
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1040
given, exports to a directory (equivalent to --format=dir)."""
1041
# TODO: list known exporters
1042
takes_args = ['dest']
1043
takes_options = ['revision', 'format']
1044
def run(self, dest, revision=None, format='dir'):
1045
b = find_branch('.')
1046
if revision == None:
1047
rh = b.revision_history()[-1]
1048
else:
1049
rh = b.lookup_revision(int(revision))
1050
t = b.revision_tree(rh)
1051
t.export(dest, format)
1052
1053
1054
class cmd_cat(Command):
1055
"""Write a file's text from a previous revision."""
1056
1057
takes_options = ['revision']
1058
takes_args = ['filename']
1059
1060
def run(self, filename, revision=None):
1061
if revision == None:
1062
raise BzrCommandError("bzr cat requires a revision number")
1063
b = find_branch('.')
1064
b.print_file(b.relpath(filename), int(revision))
1065
1066
1067
class cmd_local_time_offset(Command):
1068
"""Show the offset in seconds from GMT to local time."""
1069
hidden = True
1070
def run(self):
1071
print bzrlib.osutils.local_time_offset()
1072
1073
1074
1075
class cmd_commit(Command):
1076
"""Commit changes into a new revision.
1077
1078
If selected files are specified, only changes to those files are
1079
committed. If a directory is specified then its contents are also
1080
committed.
1081
1082
A selected-file commit may fail in some cases where the committed
1083
tree would be invalid, such as trying to commit a file in a
1084
newly-added directory that is not itself committed.
553
"""
554
tree = Branch('.').working_tree()
555
for path, file_class, kind, file_id in tree.list_files():
556
if file_class != 'I':
557
continue
558
## XXX: Slightly inefficient since this was already calculated
559
pat = tree.is_ignored(path)
560
print '%-50s %s' % (path, pat)
561
562
563
def cmd_lookup_revision(revno):
564
try:
565
revno = int(revno)
566
except ValueError:
567
bailout("usage: lookup-revision REVNO",
568
["REVNO is a non-negative revision number for this branch"])
569
570
print Branch('.').lookup_revision(revno) or NONE_STRING
571
572
573
574
def cmd_export(revno, dest):
575
"""Export past revision to destination directory."""
576
b = Branch('.')
577
rh = b.lookup_revision(int(revno))
578
t = b.revision_tree(rh)
579
t.export(dest)
580
581
def cmd_cat(revision, filename):
582
"""Print file to stdout."""
583
b = Branch('.')
584
b.print_file(b.relpath(filename), int(revision))
585
586
587
######################################################################
588
# internal/test commands
589
590
591
def cmd_uuid():
592
"""Print a newly-generated UUID."""
593
print bzrlib.osutils.uuid()
594
595
596
597
def cmd_local_time_offset():
598
print bzrlib.osutils.local_time_offset()
599
600
601
602
def cmd_commit(message=None, verbose=False):
603
"""Commit changes to a new revision.
604
605
--message MESSAGE
606
Description of changes in this revision; free form text.
607
It is recommended that the first line be a single-sentence
608
summary.
609
--verbose
610
Show status of changed files,
611
612
TODO: Commit only selected files.
1085
613
1086
614
TODO: Run hooks on tree to-be-committed, and after commit.
1087
615
1088
616
TODO: Strict commit that fails if there are unknown or deleted files.
1089
617
"""
1090
takes_args = ['selected*']
1091
takes_options = ['message', 'file', 'verbose']
1092
aliases = ['ci', 'checkin']
1093
1094
def run(self, message=None, file=None, verbose=True, selected_list=None):
1095
from bzrlib.commit import commit
1096
from bzrlib.osutils import get_text_message
1097
1098
## Warning: shadows builtin file()
1099
if not message and not file:
1100
import cStringIO
1101
stdout = sys.stdout
1102
catcher = cStringIO.StringIO()
1103
sys.stdout = catcher
1104
cmd_status({"file_list":selected_list}, {})
1105
info = catcher.getvalue()
1106
sys.stdout = stdout
1107
message = get_text_message(info)
1108
1109
if message is None:
1110
raise BzrCommandError("please specify a commit message",
1111
["use either --message or --file"])
1112
elif message and file:
1113
raise BzrCommandError("please specify either --message or --file")
1114
1115
if file:
1116
import codecs
1117
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1118
1119
b = find_branch('.')
1120
commit(b, message, verbose=verbose, specific_files=selected_list)
1121
1122
1123
class cmd_check(Command):
1124
"""Validate consistency of branch history.
618
619
if not message:
620
bailout("please specify a commit message")
621
Branch('.').commit(message, verbose=verbose)
622
623
624
def cmd_check(dir='.'):
625
"""check: Consistency check of branch history.
626
627
usage: bzr check [-v] [BRANCH]
628
629
options:
630
--verbose, -v Show progress of checking.
1125
631
1126
632
This command checks various invariants about the branch storage to
1127
633
detect data corruption or bzr bugs.
1128
1129
If given the --update flag, it will update some optional fields
1130
to help ensure data consistency.
1131
"""
1132
takes_args = ['dir?']
1133
1134
def run(self, dir='.'):
1135
from bzrlib.check import check
1136
check(find_branch(dir))
1137
1138
1139
1140
class cmd_upgrade(Command):
1141
"""Upgrade branch storage to current format.
1142
1143
This should normally be used only after the check command tells
1144
you to run it.
1145
"""
1146
takes_args = ['dir?']
1147
1148
def run(self, dir='.'):
1149
from bzrlib.upgrade import upgrade
1150
upgrade(find_branch(dir))
1151
1152
1153
1154
class cmd_whoami(Command):
1155
"""Show bzr user id."""
1156
takes_options = ['email']
1157
1158
def run(self, email=False):
1159
if email:
1160
print bzrlib.osutils.user_email()
1161
else:
1162
print bzrlib.osutils.username()
1163
1164
1165
class cmd_selftest(Command):
634
"""
635
import bzrlib.check
636
bzrlib.check.check(Branch(dir, find_root=False))
637
638
639
def cmd_is(pred, *rest):
640
"""Test whether PREDICATE is true."""
641
try:
642
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
643
except KeyError:
644
bailout("unknown predicate: %s" % quotefn(pred))
645
646
try:
647
cmd_handler(*rest)
648
except BzrCheckError:
649
# by default we don't print the message so that this can
650
# be used from shell scripts without producing noise
651
sys.exit(1)
652
653
654
def cmd_username():
655
print bzrlib.osutils.username()
656
657
658
def cmd_user_email():
659
print bzrlib.osutils.user_email()
660
661
662
def cmd_gen_revision_id():
663
print bzrlib.branch._gen_revision_id(time.time())
664
665
666
def cmd_selftest():
1166
667
"""Run internal test suite"""
1167
hidden = True
1168
def run(self):
1169
from bzrlib.selftest import selftest
1170
return int(not selftest())
1171
1172
1173
class cmd_version(Command):
1174
"""Show version of bzr."""
1175
def run(self):
1176
show_version()
1177
1178
def show_version():
668
## -v, if present, is seen by doctest; the argument is just here
669
## so our parser doesn't complain
670
671
## TODO: --verbose option
672
673
failures, tests = 0, 0
674
675
import doctest, bzrlib.store, bzrlib.tests
676
bzrlib.trace.verbose = False
677
678
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
679
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
680
mf, mt = doctest.testmod(m)
681
failures += mf
682
tests += mt
683
print '%-40s %3d tests' % (m.__name__, mt),
684
if mf:
685
print '%3d FAILED!' % mf
686
else:
687
print
688
689
print '%-40s %3d tests' % ('total', tests),
690
if failures:
691
print '%3d FAILED!' % failures
692
else:
693
print
694
695
696
697
# deprecated
698
cmd_doctest = cmd_selftest
699
700
701
######################################################################
702
# help
703
704
705
def cmd_help(topic=None):
706
if topic == None:
707
print __doc__
708
return
709
710
# otherwise, maybe the name of a command?
711
try:
712
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
713
except KeyError:
714
bailout("no help for %r" % topic)
715
716
doc = getdoc(cmdfn)
717
if doc == None:
718
bailout("sorry, no detailed help yet for %r" % topic)
719
720
print doc
721
722
723
724
725
def cmd_version():
1179
726
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1180
# is bzrlib itself in a branch?
1181
bzrrev = bzrlib.get_bzr_revision()
1182
if bzrrev:
1183
print " (bzr checkout, revision %d {%s})" % bzrrev
1184
727
print bzrlib.__copyright__
1185
728
print "http://bazaar-ng.org/"
1186
729
print
1187
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1188
print "you may use, modify and redistribute it under the terms of the GNU"
1189
print "General Public License version 2 or later."
1190
1191
1192
class cmd_rocks(Command):
730
print \
731
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
732
you may use, modify and redistribute it under the terms of the GNU
733
General Public License version 2 or later."""
734
735
736
def cmd_rocks():
1193
737
"""Statement of optimism."""
1194
hidden = True
1195
def run(self):
1196
print "it sure does!"
1197
1198
def parse_spec(spec):
1199
"""
1200
>>> parse_spec(None)
1201
[None, None]
1202
>>> parse_spec("./")
1203
['./', None]
1204
>>> parse_spec("../@")
1205
['..', -1]
1206
>>> parse_spec("../f/@35")
1207
['../f', 35]
1208
"""
1209
if spec is None:
1210
return [None, None]
1211
if '/@' in spec:
1212
parsed = spec.split('/@')
1213
assert len(parsed) == 2
1214
if parsed[1] == "":
1215
parsed[1] = -1
1216
else:
1217
parsed[1] = int(parsed[1])
1218
assert parsed[1] >=0
1219
else:
1220
parsed = [spec, None]
1221
return parsed
1222
1223
1224
1225
class cmd_merge(Command):
1226
"""Perform a three-way merge of trees.
1227
1228
The SPEC parameters are working tree or revision specifiers. Working trees
1229
are specified using standard paths or urls. No component of a directory
1230
path may begin with '@'.
1231
1232
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1233
1234
Revisions are specified using a dirname/@revno pair, where dirname is the
1235
branch directory and revno is the revision within that branch. If no revno
1236
is specified, the latest revision is used.
1237
1238
Revision examples: './@127', 'foo/@', '../@1'
1239
1240
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1241
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1242
as the BASE.
1243
1244
merge refuses to run if there are any uncommitted changes, unless
1245
--force is given.
1246
"""
1247
takes_args = ['other_spec', 'base_spec?']
1248
takes_options = ['force']
1249
1250
def run(self, other_spec, base_spec=None, force=False):
1251
from bzrlib.merge import merge
1252
merge(parse_spec(other_spec), parse_spec(base_spec),
1253
check_clean=(not force))
1254
1255
1256
1257
class cmd_revert(Command):
1258
"""Restore selected files from a previous revision.
1259
"""
1260
takes_args = ['file+']
1261
def run(self, file_list):
1262
from bzrlib.branch import find_branch
1263
1264
if not file_list:
1265
file_list = ['.']
1266
1267
b = find_branch(file_list[0])
1268
1269
b.revert([b.relpath(f) for f in file_list])
1270
1271
1272
class cmd_merge_revert(Command):
1273
"""Reverse all changes since the last commit.
1274
1275
Only versioned files are affected.
1276
1277
TODO: Store backups of any files that will be reverted, so
1278
that the revert can be undone.
1279
"""
1280
takes_options = ['revision']
1281
1282
def run(self, revision=-1):
1283
from bzrlib.merge import merge
1284
merge(('.', revision), parse_spec('.'),
1285
check_clean=False,
1286
ignore_zero=True)
1287
1288
1289
class cmd_assert_fail(Command):
1290
"""Test reporting of assertion failures"""
1291
hidden = True
1292
def run(self):
1293
assert False, "always fails"
1294
1295
1296
class cmd_help(Command):
1297
"""Show help on a command or other topic.
1298
1299
For a list of all available commands, say 'bzr help commands'."""
1300
takes_args = ['topic?']
1301
aliases = ['?']
1302
1303
def run(self, topic=None):
1304
import help
1305
help.help(topic)
1306
1307
1308
class cmd_update_stat_cache(Command):
1309
"""Update stat-cache mapping inodes to SHA-1 hashes.
1310
1311
For testing only."""
1312
hidden = True
1313
def run(self):
1314
import statcache
1315
b = find_branch('.')
1316
statcache.update_cache(b.base, b.read_working_inventory())
1317
1318
1319
1320
class cmd_plugins(Command):
1321
"""List plugins"""
1322
hidden = True
1323
def run(self):
1324
import bzrlib.plugin
1325
from pprint import pprint
1326
pprint(bzrlib.plugin.all_plugins)
1327
738
print "it sure does!"
739
740
741
742
######################################################################
743
# main routine
1328
744
1329
745
1330
746
# list of all available options; the rhs can be either None for an
1332
748
# the type.
1333
749
OPTIONS = {
1334
750
'all': None,
1335
'diff-options': str,
1336
751
'help': None,
1337
'file': unicode,
1338
'force': None,
1339
'format': unicode,
1340
'forward': None,
1341
752
'message': unicode,
1342
'no-recurse': None,
1343
753
'profile': None,
1344
'revision': _parse_revision_str,
754
'revision': int,
1345
755
'show-ids': None,
1346
756
'timezone': str,
1347
757
'verbose': None,
1348
758
'version': None,
1349
'email': None,
1350
'update': None,
1351
759
}
1352
760
1353
761
SHORT_OPTIONS = {
1354
'F': 'file',
1355
'h': 'help',
1356
762
'm': 'message',
1357
763
'r': 'revision',
1358
764
'v': 'verbose',
1359
765
}
1360
766
767
# List of options that apply to particular commands; commands not
768
# listed take none.
769
cmd_options = {
770
'add': ['verbose'],
771
'cat': ['revision'],
772
'commit': ['message', 'verbose'],
773
'deleted': ['show-ids'],
774
'diff': ['revision'],
775
'inventory': ['revision'],
776
'log': ['timezone', 'verbose'],
777
'ls': ['revision', 'verbose'],
778
'remove': ['verbose'],
779
'status': ['all'],
780
}
781
782
783
cmd_args = {
784
'add': ['file+'],
785
'cat': ['filename'],
786
'commit': [],
787
'diff': ['file*'],
788
'export': ['revno', 'dest'],
789
'file-id': ['filename'],
790
'file-id-path': ['filename'],
791
'get-file-text': ['text_id'],
792
'get-inventory': ['inventory_id'],
793
'get-revision': ['revision_id'],
794
'get-revision-inventory': ['revision_id'],
795
'help': ['topic?'],
796
'init': [],
797
'log': [],
798
'lookup-revision': ['revno'],
799
'move': ['source$', 'dest'],
800
'relpath': ['filename'],
801
'remove': ['file+'],
802
'rename': ['from_name', 'to_name'],
803
'renames': ['dir?'],
804
'root': ['filename?'],
805
'status': [],
806
}
807
1361
808
1362
809
def parse_args(argv):
1363
810
"""Parse command line.
1375
822
(['status'], {'all': True})
1376
823
>>> parse_args('commit --message=biter'.split())
1377
824
(['commit'], {'message': u'biter'})
1378
>>> parse_args('log -r 500'.split())
1379
(['log'], {'revision': 500})
1380
>>> parse_args('log -r500:600'.split())
1381
(['log'], {'revision': [500, 600]})
1382
>>> parse_args('log -vr500:600'.split())
1383
(['log'], {'verbose': True, 'revision': [500, 600]})
1384
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1385
Traceback (most recent call last):
1386
...
1387
ValueError: invalid literal for int(): v500
1388
825
"""
1389
826
args = []
1390
827
opts = {}
1394
831
while argv:
1395
832
a = argv.pop(0)
1396
833
if a[0] == '-':
1397
# option names must not be unicode
1398
a = str(a)
1399
834
optarg = None
1400
835
if a[1] == '-':
1401
836
mutter(" got option %r" % a)
1404
839
else:
1405
840
optname = a[2:]
1406
841
if optname not in OPTIONS:
1407
raise BzrError('unknown long option %r' % a)
842
bailout('unknown long option %r' % a)
1408
843
else:
1409
844
shortopt = a[1:]
1410
if shortopt in SHORT_OPTIONS:
1411
# Multi-character options must have a space to delimit
1412
# their value
1413
optname = SHORT_OPTIONS[shortopt]
1414
else:
1415
# Single character short options, can be chained,
1416
# and have their value appended to their name
1417
shortopt = a[1:2]
1418
if shortopt not in SHORT_OPTIONS:
1419
# We didn't find the multi-character name, and we
1420
# didn't find the single char name
1421
raise BzrError('unknown short option %r' % a)
1422
optname = SHORT_OPTIONS[shortopt]
1423
1424
if a[2:]:
1425
# There are extra things on this option
1426
# see if it is the value, or if it is another
1427
# short option
1428
optargfn = OPTIONS[optname]
1429
if optargfn is None:
1430
# This option does not take an argument, so the
1431
# next entry is another short option, pack it back
1432
# into the list
1433
argv.insert(0, '-' + a[2:])
1434
else:
1435
# This option takes an argument, so pack it
1436
# into the array
1437
optarg = a[2:]
845
if shortopt not in SHORT_OPTIONS:
846
bailout('unknown short option %r' % a)
847
optname = SHORT_OPTIONS[shortopt]
1438
848
1439
849
if optname in opts:
1440
850
# XXX: Do we ever want to support this, e.g. for -r?
1441
raise BzrError('repeated option %r' % a)
851
bailout('repeated option %r' % a)
1442
852
1443
853
optargfn = OPTIONS[optname]
1444
854
if optargfn:
1445
855
if optarg == None:
1446
856
if not argv:
1447
raise BzrError('option %r needs an argument' % a)
857
bailout('option %r needs an argument' % a)
1448
858
else:
1449
859
optarg = argv.pop(0)
1450
860
opts[optname] = optargfn(optarg)
1451
861
else:
1452
862
if optarg != None:
1453
raise BzrError('option %r takes no argument' % optname)
863
bailout('option %r takes no argument' % optname)
1454
864
opts[optname] = True
1455
865
else:
1456
866
args.append(a)
1459
869
1460
870
1461
871
872
def _match_args(cmd, args):
873
"""Check non-option arguments match required pattern.
1462
874
1463
def _match_argform(cmd, takes_args, args):
875
>>> _match_args('status', ['asdasdsadasd'])
876
Traceback (most recent call last):
877
...
878
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
879
>>> _match_args('add', ['asdasdsadasd'])
880
{'file_list': ['asdasdsadasd']}
881
>>> _match_args('add', 'abc def gj'.split())
882
{'file_list': ['abc', 'def', 'gj']}
883
"""
884
# match argument pattern
885
argform = cmd_args.get(cmd, [])
1464
886
argdict = {}
887
# TODO: Need a way to express 'cp SRC... DEST', where it matches
888
# all but one.
1465
889
1466
# step through args and takes_args, allowing appropriate 0-many matches
1467
for ap in takes_args:
890
# step through args and argform, allowing appropriate 0-many matches
891
for ap in argform:
1468
892
argname = ap[:-1]
1469
893
if ap[-1] == '?':
1470
894
if args:
1477
901
argdict[argname + '_list'] = None
1478
902
elif ap[-1] == '+':
1479
903
if not args:
1480
raise BzrCommandError("command %r needs one or more %s"
904
bailout("command %r needs one or more %s"
1481
905
% (cmd, argname.upper()))
1482
906
else:
1483
907
argdict[argname + '_list'] = args[:]
1484
908
args = []
1485
909
elif ap[-1] == '$': # all but one
1486
910
if len(args) < 2:
1487
raise BzrCommandError("command %r needs one or more %s"
911
bailout("command %r needs one or more %s"
1488
912
% (cmd, argname.upper()))
1489
913
argdict[argname + '_list'] = args[:-1]
1490
914
args[:-1] = []
1492
916
# just a plain arg
1493
917
argname = ap
1494
918
if not args:
1495
raise BzrCommandError("command %r requires argument %s"
919
bailout("command %r requires argument %s"
1496
920
% (cmd, argname.upper()))
1497
921
else:
1498
922
argdict[argname] = args.pop(0)
1499
923
1500
924
if args:
1501
raise BzrCommandError("extra argument to command %s: %s"
1502
% (cmd, args[0]))
925
bailout("extra arguments to command %s: %r"
926
% (cmd, args))
1503
927
1504
928
return argdict
1505
929
1506
930
1507
def _parse_master_args(argv):
1508
"""Parse the arguments that always go with the original command.
1509
These are things like bzr --no-plugins, etc.
1510
1511
There are now 2 types of option flags. Ones that come *before* the command,
1512
and ones that come *after* the command.
1513
Ones coming *before* the command are applied against all possible commands.
1514
And are generally applied before plugins are loaded.
1515
1516
The current list are:
1517
--builtin Allow plugins to load, but don't let them override builtin commands,
1518
they will still be allowed if they do not override a builtin.
1519
--no-plugins Don't load any plugins. This lets you get back to official source
1520
behavior.
1521
--profile Enable the hotspot profile before running the command.
1522
For backwards compatibility, this is also a non-master option.
1523
--version Spit out the version of bzr that is running and exit.
1524
This is also a non-master option.
1525
--help Run help and exit, also a non-master option (I think that should stay, though)
1526
1527
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1528
Traceback (most recent call last):
1529
...
1530
BzrCommandError: Invalid master option: 'test'
1531
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1532
>>> print argv
1533
['command']
1534
>>> print opts['version']
1535
True
1536
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1537
>>> print argv
1538
['command', '--more-options']
1539
>>> print opts['profile']
1540
True
1541
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1542
>>> print argv
1543
['command']
1544
>>> print opts['no-plugins']
1545
True
1546
>>> print opts['profile']
1547
False
1548
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1549
>>> print argv
1550
['command', '--profile']
1551
>>> print opts['profile']
1552
False
1553
"""
1554
master_opts = {'builtin':False,
1555
'no-plugins':False,
1556
'version':False,
1557
'profile':False,
1558
'help':False
1559
}
1560
1561
# This is the point where we could hook into argv[0] to determine
1562
# what front-end is supposed to be run
1563
# For now, we are just ignoring it.
1564
cmd_name = argv.pop(0)
1565
for arg in argv[:]:
1566
if arg[:2] != '--': # at the first non-option, we return the rest
1567
break
1568
arg = arg[2:] # Remove '--'
1569
if arg not in master_opts:
1570
# We could say that this is not an error, that we should
1571
# just let it be handled by the main section instead
1572
raise BzrCommandError('Invalid master option: %r' % arg)
1573
argv.pop(0) # We are consuming this entry
1574
master_opts[arg] = True
1575
return argv, master_opts
1576
1577
1578
931
1579
932
def run_bzr(argv):
1580
933
"""Execute a command.
1582
935
This is similar to main(), but without all the trappings for
1583
936
logging and error handling.
1584
937
"""
938
1585
939
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1586
940
1587
941
try:
1588
# some options like --builtin and --no-plugins have special effects
1589
argv, master_opts = _parse_master_args(argv)
1590
if not master_opts['no-plugins']:
1591
from bzrlib.plugin import load_plugins
1592
load_plugins()
1593
1594
args, opts = parse_args(argv)
1595
1596
if master_opts['help']:
1597
from bzrlib.help import help
1598
if argv:
1599
help(argv[0])
1600
else:
1601
help()
1602
return 0
1603
942
args, opts = parse_args(argv[1:])
1604
943
if 'help' in opts:
1605
from bzrlib.help import help
944
# TODO: pass down other arguments in case they asked for
945
# help on a command name?
1606
946
if args:
1607
help(args[0])
947
cmd_help(args[0])
1608
948
else:
1609
help()
949
cmd_help()
1610
950
return 0
1611
951
elif 'version' in opts:
1612
show_version()
952
cmd_version()
1613
953
return 0
1614
elif args and args[0] == 'builtin':
1615
include_plugins=False
1616
args = args[1:]
1617
cmd = str(args.pop(0))
954
cmd = args.pop(0)
1618
955
except IndexError:
1619
import help
1620
help.help()
956
log_error('usage: bzr COMMAND\n')
957
log_error(' try "bzr help"\n')
1621
958
return 1
1622
1623
1624
plugins_override = not (master_opts['builtin'])
1625
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1626
1627
profile = master_opts['profile']
1628
# For backwards compatibility, I would rather stick with --profile being a
1629
# master/global option
959
960
try:
961
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
962
except KeyError:
963
bailout("unknown command " + `cmd`)
964
965
# global option
1630
966
if 'profile' in opts:
1631
967
profile = True
1632
968
del opts['profile']
969
else:
970
profile = False
1633
971
1634
972
# check options are reasonable
1635
allowed = cmd_class.takes_options
973
allowed = cmd_options.get(cmd, [])
1636
974
for oname in opts:
1637
975
if oname not in allowed:
1638
raise BzrCommandError("option '--%s' is not allowed for command %r"
1639
% (oname, cmd))
976
bailout("option %r is not allowed for command %r"
977
% (oname, cmd))
978
979
# TODO: give an error if there are any mandatory options which are
980
# not specified? Or maybe there shouldn't be any "mandatory
981
# options" (it is an oxymoron)
1640
982
1641
983
# mix arguments and options into one dictionary
1642
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1643
cmdopts = {}
984
cmdargs = _match_args(cmd, args)
1644
985
for k, v in opts.items():
1645
cmdopts[k.replace('-', '_')] = v
986
cmdargs[str(k.replace('-', '_'))] = v
1646
987
1647
988
if profile:
1648
import hotshot, tempfile
989
import hotshot
1649
990
pffileno, pfname = tempfile.mkstemp()
1650
991
try:
1651
992
prof = hotshot.Profile(pfname)
1652
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
993
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1653
994
prof.close()
1654
995
1655
996
import hotshot.stats
1660
1001
## print_stats seems hardcoded to stdout
1661
1002
stats.print_stats(20)
1662
1003
1663
return ret.status
1004
return ret
1664
1005
1665
1006
finally:
1666
1007
os.close(pffileno)
1667
1008
os.remove(pfname)
1668
1009
else:
1669
return cmd_class(cmdopts, cmdargs).status
1670
1671
1672
def _report_exception(summary, quiet=False):
1673
import traceback
1674
log_error('bzr: ' + summary)
1675
bzrlib.trace.log_exception()
1676
1677
if not quiet:
1678
tb = sys.exc_info()[2]
1679
exinfo = traceback.extract_tb(tb)
1680
if exinfo:
1681
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1682
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1010
return cmd_handler(**cmdargs) or 0
1683
1011
1684
1012
1685
1013
1686
1014
def main(argv):
1015
## TODO: Handle command-line options; probably know what options are valid for
1016
## each command
1017
1018
## TODO: If the arguments are wrong, give a usage message rather
1019
## than just a backtrace.
1020
1021
bzrlib.trace.create_tracefile(argv)
1687
1022
1688
bzrlib.trace.open_tracefile(argv)
1689
1690
1023
try:
1691
try:
1692
try:
1693
return run_bzr(argv)
1694
finally:
1695
# do this here inside the exception wrappers to catch EPIPE
1696
sys.stdout.flush()
1697
except BzrError, e:
1698
quiet = isinstance(e, (BzrCommandError))
1699
_report_exception('error: ' + e.args[0], quiet=quiet)
1700
if len(e.args) > 1:
1701
for h in e.args[1]:
1702
# some explanation or hints
1703
log_error(' ' + h)
1704
return 1
1705
except AssertionError, e:
1706
msg = 'assertion failed'
1707
if str(e):
1708
msg += ': ' + str(e)
1709
_report_exception(msg)
1710
return 2
1711
except KeyboardInterrupt, e:
1712
_report_exception('interrupted', quiet=True)
1713
return 2
1714
except Exception, e:
1715
import errno
1716
quiet = False
1717
if (isinstance(e, IOError)
1718
and hasattr(e, 'errno')
1719
and e.errno == errno.EPIPE):
1720
quiet = True
1721
msg = 'broken pipe'
1722
else:
1723
msg = str(e).rstrip('\n')
1724
_report_exception(msg, quiet)
1725
return 2
1726
finally:
1727
bzrlib.trace.close_trace()
1024
ret = run_bzr(argv)
1025
return ret
1026
except BzrError, e:
1027
log_error('bzr: error: ' + e.args[0] + '\n')
1028
if len(e.args) > 1:
1029
for h in e.args[1]:
1030
log_error(' ' + h + '\n')
1031
traceback.print_exc(None, bzrlib.trace._tracefile)
1032
log_error('(see $HOME/.bzr.log for debug information)\n')
1033
return 1
1034
except Exception, e:
1035
log_error('bzr: exception: %s\n' % e)
1036
log_error('(see $HOME/.bzr.log for debug information)\n')
1037
traceback.print_exc(None, bzrlib.trace._tracefile)
1038
## traceback.print_exc(None, sys.stderr)
1039
return 1
1040
1041
## TODO: Trap AssertionError
1042
1043
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1044
1728
1045
1729
1046
1730
1047
if __name__ == '__main__':
1731
1048
sys.exit(main(sys.argv))
1049
##import profile
1050
##profile.run('main(sys.argv)')
Loggerhead is a web-based interface for Breezy
Version: 2.0.1