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