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