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