« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 1092.1.37
- compare with another revision
- download diff
- download tarball
- view history from revision 1092.1.37
- Committer: Robert Collins
- Date: 2005-08-25 07:48:27 UTC
- mto: (974.1.50) (1185.1.10) (1092.3.1)
- mto: This revision was merged to the branch mainline in revision 1139.
- Revision ID: robertc@robertcollins.net-20050825074826-dfdf6cecb8020b93
unbreak weavebench
- files added:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files removed:
- bzrlib/tests.py
- files renamed:
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
1
# Copyright (C) 2004, 2005 by Canonical Ltd
4
2
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
16
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
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
# TODO: Help messages for options.
24
25
# TODO: Define arguments by objects, rather than just using names.
26
# Those objects can specify the expected type of the argument, which
27
# would help with validation and shell completion.
28
29
30
import sys
31
import os
75
32
76
33
import bzrlib
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):
34
from bzrlib.trace import mutter, note, log_error, warning
35
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
36
from bzrlib.branch import find_branch
37
from bzrlib import BZRDIR
38
39
40
plugin_cmds = {}
41
42
43
def register_command(cmd):
44
"Utility function to help register a command"
45
global plugin_cmds
46
k = cmd.__name__
47
if k.startswith("cmd_"):
48
k_unsquished = _unsquish_command_name(k)
49
else:
50
k_unsquished = k
51
if not plugin_cmds.has_key(k_unsquished):
52
plugin_cmds[k_unsquished] = cmd
53
else:
54
log_error('Two plugins defined the same command: %r' % k)
55
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
56
57
58
def _squish_command_name(cmd):
59
return 'cmd_' + cmd.replace('-', '_')
60
61
62
def _unsquish_command_name(cmd):
63
assert cmd.startswith("cmd_")
64
return cmd[4:].replace('_','-')
65
66
67
def _parse_revision_str(revstr):
68
"""This handles a revision string -> revno.
69
70
This always returns a list. The list will have one element for
71
72
It supports integers directly, but everything else it
73
defers for passing to Branch.get_revision_info()
74
75
>>> _parse_revision_str('234')
76
[234]
77
>>> _parse_revision_str('234..567')
78
[234, 567]
79
>>> _parse_revision_str('..')
80
[None, None]
81
>>> _parse_revision_str('..234')
82
[None, 234]
83
>>> _parse_revision_str('234..')
84
[234, None]
85
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
86
[234, 456, 789]
87
>>> _parse_revision_str('234....789') # Error?
88
[234, None, 789]
89
>>> _parse_revision_str('revid:test@other.com-234234')
90
['revid:test@other.com-234234']
91
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
92
['revid:test@other.com-234234', 'revid:test@other.com-234235']
93
>>> _parse_revision_str('revid:test@other.com-234234..23')
94
['revid:test@other.com-234234', 23]
95
>>> _parse_revision_str('date:2005-04-12')
96
['date:2005-04-12']
97
>>> _parse_revision_str('date:2005-04-12 12:24:33')
98
['date:2005-04-12 12:24:33']
99
>>> _parse_revision_str('date:2005-04-12T12:24:33')
100
['date:2005-04-12T12:24:33']
101
>>> _parse_revision_str('date:2005-04-12,12:24:33')
102
['date:2005-04-12,12:24:33']
103
>>> _parse_revision_str('-5..23')
104
[-5, 23]
105
>>> _parse_revision_str('-5')
106
[-5]
107
>>> _parse_revision_str('123a')
108
['123a']
109
>>> _parse_revision_str('abc')
110
['abc']
111
"""
112
import re
113
old_format_re = re.compile('\d*:\d*')
114
m = old_format_re.match(revstr)
115
if m:
116
warning('Colon separator for revision numbers is deprecated.'
117
' Use .. instead')
118
revs = []
119
for rev in revstr.split(':'):
120
if rev:
121
revs.append(int(rev))
122
else:
123
revs.append(None)
124
return revs
125
revs = []
126
for x in revstr.split('..'):
127
if not x:
128
revs.append(None)
129
else:
130
try:
131
revs.append(int(x))
132
except ValueError:
133
revs.append(x)
134
return revs
135
136
137
def get_merge_type(typestring):
138
"""Attempt to find the merge class/factory associated with a string."""
139
from merge import merge_types
140
try:
141
return merge_types[typestring][0]
142
except KeyError:
143
templ = '%s%%7s: %%s' % (' '*12)
144
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
145
type_list = '\n'.join(lines)
146
msg = "No known merge type %s. Supported types are:\n%s" %\
147
(typestring, type_list)
148
raise BzrCommandError(msg)
149
150
151
def get_merge_type(typestring):
152
"""Attempt to find the merge class/factory associated with a string."""
153
from merge import merge_types
154
try:
155
return merge_types[typestring][0]
156
except KeyError:
157
templ = '%s%%7s: %%s' % (' '*12)
158
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
159
type_list = '\n'.join(lines)
160
msg = "No known merge type %s. Supported types are:\n%s" %\
161
(typestring, type_list)
162
raise BzrCommandError(msg)
163
164
165
166
def _get_cmd_dict(plugins_override=True):
167
d = {}
168
for k, v in globals().iteritems():
169
if k.startswith("cmd_"):
170
d[_unsquish_command_name(k)] = v
171
# If we didn't load plugins, the plugin_cmds dict will be empty
172
if plugins_override:
173
d.update(plugin_cmds)
174
else:
175
d2 = plugin_cmds.copy()
176
d2.update(d)
177
d = d2
178
return d
179
180
181
def get_all_cmds(plugins_override=True):
182
"""Return canonical name and class for all registered commands."""
183
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
184
yield k,v
185
186
187
def get_cmd_class(cmd, plugins_override=True):
188
"""Return the canonical name and command class for a command.
189
"""
190
cmd = str(cmd) # not unicode
191
192
# first look up this command under the specified name
193
cmds = _get_cmd_dict(plugins_override=plugins_override)
194
try:
195
return cmd, cmds[cmd]
196
except KeyError:
197
pass
198
199
# look for any command which claims this as an alias
200
for cmdname, cmdclass in cmds.iteritems():
201
if cmd in cmdclass.aliases:
202
return cmdname, cmdclass
203
204
cmdclass = ExternalCommand.find_command(cmd)
205
if cmdclass:
206
return cmd, cmdclass
207
208
raise BzrCommandError("unknown command %r" % cmd)
209
210
211
class Command(object):
212
"""Base class for commands.
213
214
The docstring for an actual command should give a single-line
215
summary, then a complete description of the command. A grammar
216
description will be inserted.
217
218
takes_args
219
List of argument forms, marked with whether they are optional,
220
repeated, etc.
221
222
takes_options
223
List of options that may be given for this command.
224
225
hidden
226
If true, this command isn't advertised.
227
"""
228
aliases = []
229
230
takes_args = []
231
takes_options = []
232
233
hidden = False
234
235
def __init__(self, options, arguments):
236
"""Construct and run the command.
237
238
Sets self.status to the return value of run()."""
239
assert isinstance(options, dict)
240
assert isinstance(arguments, dict)
241
cmdargs = options.copy()
242
cmdargs.update(arguments)
243
if self.__doc__ == Command.__doc__:
244
from warnings import warn
245
warn("No help message set for %r" % self)
246
self.status = self.run(**cmdargs)
247
if self.status is None:
248
self.status = 0
249
250
251
def run(self):
252
"""Override this in sub-classes.
253
254
This is invoked with the options and arguments bound to
255
keyword parameters.
256
257
Return 0 or None if the command was successful, or a shell
258
error code if not.
259
"""
260
return 0
261
262
263
class ExternalCommand(Command):
264
"""Class to wrap external commands.
265
266
We cheat a little here, when get_cmd_class() calls us we actually
267
give it back an object we construct that has the appropriate path,
268
help, options etc for the specified command.
269
270
When run_bzr() tries to instantiate that 'class' it gets caught by
271
the __call__ method, which we override to call the Command.__init__
272
method. That then calls our run method which is pretty straight
273
forward.
274
275
The only wrinkle is that we have to map bzr's dictionary of options
276
and arguments back into command line options and arguments for the
277
script.
278
"""
279
280
def find_command(cls, cmd):
281
import os.path
282
bzrpath = os.environ.get('BZRPATH', '')
283
284
for dir in bzrpath.split(os.pathsep):
285
path = os.path.join(dir, cmd)
286
if os.path.isfile(path):
287
return ExternalCommand(path)
288
289
return None
290
291
find_command = classmethod(find_command)
292
293
def __init__(self, path):
294
self.path = path
295
296
pipe = os.popen('%s --bzr-usage' % path, 'r')
297
self.takes_options = pipe.readline().split()
298
299
for opt in self.takes_options:
300
if not opt in OPTIONS:
301
raise BzrError("Unknown option '%s' returned by external command %s"
302
% (opt, path))
303
304
# TODO: Is there any way to check takes_args is valid here?
305
self.takes_args = pipe.readline().split()
306
307
if pipe.close() is not None:
308
raise BzrError("Failed funning '%s --bzr-usage'" % path)
309
310
pipe = os.popen('%s --bzr-help' % path, 'r')
311
self.__doc__ = pipe.read()
312
if pipe.close() is not None:
313
raise BzrError("Failed funning '%s --bzr-help'" % path)
314
315
def __call__(self, options, arguments):
316
Command.__init__(self, options, arguments)
317
return self
318
319
def run(self, **kargs):
320
opts = []
321
args = []
322
323
keys = kargs.keys()
324
keys.sort()
325
for name in keys:
326
optname = name.replace('_','-')
327
value = kargs[name]
328
if OPTIONS.has_key(optname):
329
# it's an option
330
opts.append('--%s' % optname)
331
if value is not None and value is not True:
332
opts.append(str(value))
333
else:
334
# it's an arg, or arg list
335
if type(value) is not list:
336
value = [value]
337
for v in value:
338
if v is not None:
339
args.append(str(v))
340
341
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
342
return self.status
343
344
345
class cmd_status(Command):
139
346
"""Display status summary.
140
347
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):
348
This reports on versioned and unknown files, reporting them
349
grouped by state. Possible states are:
350
351
added
352
Versioned in the working copy but not in the previous revision.
353
354
removed
355
Versioned in the previous revision but removed or deleted
356
in the working copy.
357
358
renamed
359
Path of this file changed from the previous revision;
360
the text may also have changed. This includes files whose
361
parent directory was renamed.
362
363
modified
364
Text has changed since the previous revision.
365
366
unchanged
367
Nothing about this file has changed since the previous revision.
368
Only shown with --all.
369
370
unknown
371
Not versioned and not matching an ignore pattern.
372
373
To see ignored files use 'bzr ignored'. For details in the
374
changes to file texts, use 'bzr diff'.
375
376
If no arguments are specified, the status of the entire working
377
directory is shown. Otherwise, only the status of the specified
378
files or directories is reported. If a directory is given, status
379
is reported for everything inside that directory.
380
381
If a revision is specified, the changes since that revision are shown.
382
"""
383
takes_args = ['file*']
384
takes_options = ['all', 'show-ids', 'revision']
385
aliases = ['st', 'stat']
386
387
def run(self, all=False, show_ids=False, file_list=None):
388
if file_list:
389
b = find_branch(file_list[0])
390
file_list = [b.relpath(x) for x in file_list]
391
# special case: only one path was given and it's the root
392
# of the branch
393
if file_list == ['']:
394
file_list = None
395
else:
396
b = find_branch('.')
397
398
from bzrlib.status import show_status
399
show_status(b, show_unchanged=all, show_ids=show_ids,
400
specific_files=file_list)
401
402
403
class cmd_cat_revision(Command):
404
"""Write out metadata for a revision."""
405
406
hidden = True
407
takes_args = ['revision_id']
408
409
def run(self, revision_id):
410
from bzrlib.xml import pack_xml
411
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
412
413
414
class cmd_revno(Command):
415
"""Show current revision number.
416
417
This is equal to the number of revisions on this branch."""
418
def run(self):
419
print find_branch('.').revno()
420
421
class cmd_revision_info(Command):
422
"""Show revision number and revision id for a given revision identifier.
423
"""
424
hidden = True
425
takes_args = ['revision_info*']
426
takes_options = ['revision']
427
def run(self, revision=None, revision_info_list=None):
428
from bzrlib.branch import find_branch
429
430
revs = []
431
if revision is not None:
432
revs.extend(revision)
433
if revision_info_list is not None:
434
revs.extend(revision_info_list)
435
if len(revs) == 0:
436
raise BzrCommandError('You must supply a revision identifier')
437
438
b = find_branch('.')
439
440
for rev in revs:
441
print '%4d %s' % b.get_revision_info(rev)
442
443
444
class cmd_add(Command):
175
445
"""Add specified files or directories.
176
446
177
447
In non-recursive mode, all the named items are added, regardless
184
454
whether already versioned or not, are searched for files or
185
455
subdirectories that are neither versioned or ignored, and these
186
456
are added. This search proceeds recursively into versioned
187
directories.
457
directories. If no names are given '.' is assumed.
188
458
189
Therefore simply saying 'bzr add .' will version all files that
459
Therefore simply saying 'bzr add' will version all files that
190
460
are currently unknown.
191
461
192
462
TODO: Perhaps adding a file whose directly is not versioned should
193
463
recursively add that parent, rather than giving an error?
194
464
"""
195
bzrlib.add.smart_add(file_list, verbose)
465
takes_args = ['file*']
466
takes_options = ['verbose', 'no-recurse']
196
467
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))
468
def run(self, file_list, verbose=False, no_recurse=False):
469
from bzrlib.add import smart_add, _PrintAddCallback
470
smart_add(file_list, verbose, not no_recurse,
471
callback=_PrintAddCallback)
472
473
474
475
class cmd_mkdir(Command):
476
"""Create a new versioned directory.
477
478
This is equivalent to creating the directory and then adding it.
479
"""
480
takes_args = ['dir+']
481
482
def run(self, dir_list):
483
b = None
213
484
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):
485
for d in dir_list:
486
os.mkdir(d)
487
if not b:
488
b = find_branch(d)
489
b.add([d], verbose=True)
490
491
492
class cmd_relpath(Command):
493
"""Show path of a file relative to root"""
494
takes_args = ['filename']
495
hidden = True
496
497
def run(self, filename):
498
print find_branch(filename).relpath(filename)
499
500
501
502
class cmd_inventory(Command):
503
"""Show inventory of the current working copy or a revision."""
504
takes_options = ['revision', 'show-ids']
505
506
def run(self, revision=None, show_ids=False):
507
b = find_branch('.')
508
if revision == None:
509
inv = b.read_working_inventory()
510
else:
511
if len(revision) > 1:
512
raise BzrCommandError('bzr inventory --revision takes'
513
' exactly one revision identifier')
514
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
515
516
for path, entry in inv.entries():
517
if show_ids:
518
print '%-50s %s' % (path, entry.file_id)
519
else:
520
print path
521
522
523
class cmd_move(Command):
524
"""Move files to a different directory.
525
526
examples:
527
bzr move *.txt doc
528
529
The destination must be a versioned directory in the same branch.
530
"""
531
takes_args = ['source$', 'dest']
532
def run(self, source_list, dest):
533
b = find_branch('.')
534
535
# TODO: glob expansion on windows?
536
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
537
538
539
class cmd_rename(Command):
230
540
"""Change the name of an entry.
231
541
232
usage: bzr rename FROM_NAME TO_NAME
233
234
542
examples:
235
543
bzr rename frob.c frobber.c
236
544
bzr rename src/frob.c lib/frob.c
242
550
243
551
TODO: Some way to rename multiple files without invoking bzr for each
244
552
one?"""
245
b = Branch('.')
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
247
248
249
250
251
def cmd_renames(dir='.'):
553
takes_args = ['from_name', 'to_name']
554
555
def run(self, from_name, to_name):
556
b = find_branch('.')
557
b.rename_one(b.relpath(from_name), b.relpath(to_name))
558
559
560
561
class cmd_mv(Command):
562
"""Move or rename a file.
563
564
usage:
565
bzr mv OLDNAME NEWNAME
566
bzr mv SOURCE... DESTINATION
567
568
If the last argument is a versioned directory, all the other names
569
are moved into it. Otherwise, there must be exactly two arguments
570
and the file is changed to a new name, which must not already exist.
571
572
Files cannot be moved between branches.
573
"""
574
takes_args = ['names*']
575
def run(self, names_list):
576
if len(names_list) < 2:
577
raise BzrCommandError("missing file argument")
578
b = find_branch(names_list[0])
579
580
rel_names = [b.relpath(x) for x in names_list]
581
582
if os.path.isdir(names_list[-1]):
583
# move into existing directory
584
b.move(rel_names[:-1], rel_names[-1])
585
else:
586
if len(names_list) != 2:
587
raise BzrCommandError('to mv multiple files the destination '
588
'must be a versioned directory')
589
b.move(rel_names[0], rel_names[1])
590
591
592
593
594
class cmd_pull(Command):
595
"""Pull any changes from another branch into the current one.
596
597
If the location is omitted, the last-used location will be used.
598
Both the revision history and the working directory will be
599
updated.
600
601
This command only works on branches that have not diverged. Branches are
602
considered diverged if both branches have had commits without first
603
pulling from the other.
604
605
If branches have diverged, you can use 'bzr merge' to pull the text changes
606
from one into the other.
607
"""
608
takes_args = ['location?']
609
610
def run(self, location=None):
611
from bzrlib.merge import merge
612
import tempfile
613
from shutil import rmtree
614
import errno
615
from bzrlib.branch import pull_loc
616
617
br_to = find_branch('.')
618
stored_loc = None
619
try:
620
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
621
except IOError, e:
622
if e.errno != errno.ENOENT:
623
raise
624
if location is None:
625
if stored_loc is None:
626
raise BzrCommandError("No pull location known or specified.")
627
else:
628
print "Using last location: %s" % stored_loc
629
location = stored_loc
630
cache_root = tempfile.mkdtemp()
631
from bzrlib.branch import DivergedBranches
632
br_from = find_branch(location)
633
location = pull_loc(br_from)
634
old_revno = br_to.revno()
635
try:
636
from branch import find_cached_branch, DivergedBranches
637
br_from = find_cached_branch(location, cache_root)
638
location = pull_loc(br_from)
639
old_revno = br_to.revno()
640
try:
641
br_to.update_revisions(br_from)
642
except DivergedBranches:
643
raise BzrCommandError("These branches have diverged."
644
" Try merge.")
645
646
merge(('.', -1), ('.', old_revno), check_clean=False)
647
if location != stored_loc:
648
br_to.controlfile("x-pull", "wb").write(location + "\n")
649
finally:
650
rmtree(cache_root)
651
652
653
654
class cmd_branch(Command):
655
"""Create a new copy of a branch.
656
657
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
658
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
659
660
To retrieve the branch as of a particular revision, supply the --revision
661
parameter, as in "branch foo/bar -r 5".
662
"""
663
takes_args = ['from_location', 'to_location?']
664
takes_options = ['revision']
665
aliases = ['get', 'clone']
666
667
def run(self, from_location, to_location=None, revision=None):
668
from bzrlib.branch import copy_branch, find_cached_branch
669
import tempfile
670
import errno
671
from shutil import rmtree
672
cache_root = tempfile.mkdtemp()
673
try:
674
if revision is None:
675
revision = [None]
676
elif len(revision) > 1:
677
raise BzrCommandError(
678
'bzr branch --revision takes exactly 1 revision value')
679
try:
680
br_from = find_cached_branch(from_location, cache_root)
681
except OSError, e:
682
if e.errno == errno.ENOENT:
683
raise BzrCommandError('Source location "%s" does not'
684
' exist.' % to_location)
685
else:
686
raise
687
if to_location is None:
688
to_location = os.path.basename(from_location.rstrip("/\\"))
689
try:
690
os.mkdir(to_location)
691
except OSError, e:
692
if e.errno == errno.EEXIST:
693
raise BzrCommandError('Target directory "%s" already'
694
' exists.' % to_location)
695
if e.errno == errno.ENOENT:
696
raise BzrCommandError('Parent of "%s" does not exist.' %
697
to_location)
698
else:
699
raise
700
try:
701
copy_branch(br_from, to_location, revision[0])
702
except bzrlib.errors.NoSuchRevision:
703
rmtree(to_location)
704
msg = "The branch %s has no revision %d." % (from_location, revision[0])
705
raise BzrCommandError(msg)
706
finally:
707
rmtree(cache_root)
708
709
710
class cmd_renames(Command):
252
711
"""Show list of renamed files.
253
712
254
usage: bzr renames [BRANCH]
255
256
713
TODO: Option to show renames between two historical versions.
257
714
258
715
TODO: Only show renames under dir, rather than in the whole branch.
259
716
"""
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):
717
takes_args = ['dir?']
718
719
def run(self, dir='.'):
720
b = find_branch(dir)
721
old_inv = b.basis_tree().inventory
722
new_inv = b.read_working_inventory()
723
724
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
725
renames.sort()
726
for old_name, new_name in renames:
727
print "%s => %s" % (old_name, new_name)
728
729
730
class cmd_info(Command):
731
"""Show statistical information about a branch."""
732
takes_args = ['branch?']
733
734
def run(self, branch=None):
735
import info
736
737
b = find_branch(branch)
738
info.show_info(b)
739
740
741
class cmd_remove(Command):
742
"""Make a file unversioned.
743
744
This makes bzr stop tracking changes to a versioned file. It does
745
not delete the working copy.
746
"""
747
takes_args = ['file+']
748
takes_options = ['verbose']
749
750
def run(self, file_list, verbose=False):
751
b = find_branch(file_list[0])
752
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
753
754
755
class cmd_file_id(Command):
287
756
"""Print file_id of a particular file or directory.
288
757
289
usage: bzr file-id FILE
290
291
758
The file_id is assigned when the file is first added and remains the
292
759
same through all revisions where the file exists, even when it is
293
760
moved or renamed.
294
761
"""
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):
762
hidden = True
763
takes_args = ['filename']
764
def run(self, filename):
765
b = find_branch(filename)
766
i = b.inventory.path2id(b.relpath(filename))
767
if i == None:
768
raise BzrError("%r is not a versioned file" % filename)
769
else:
770
print i
771
772
773
class cmd_file_path(Command):
304
774
"""Print path of file_ids to a file or directory.
305
775
306
usage: bzr file-id-path FILE
307
308
776
This prints one line for each directory down to the target,
309
777
starting at the branch root."""
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
778
hidden = True
779
takes_args = ['filename']
780
def run(self, filename):
781
b = find_branch(filename)
782
inv = b.inventory
783
fid = inv.path2id(b.relpath(filename))
784
if fid == None:
785
raise BzrError("%r is not a versioned file" % filename)
786
for fip in inv.get_idpath(fid):
787
print fip
788
789
790
class cmd_revision_history(Command):
791
"""Display list of revision ids on this branch."""
792
hidden = True
793
def run(self):
794
for patchid in find_branch('.').revision_history():
795
print patchid
796
797
798
class cmd_directories(Command):
799
"""Display list of versioned directories in this branch."""
800
def run(self):
801
for name, ie in find_branch('.').read_working_inventory().directories():
802
if name == '':
803
print '.'
804
else:
805
print name
806
807
808
class cmd_init(Command):
809
"""Make a directory into a versioned branch.
810
811
Use this to create an empty branch, or before importing an
812
existing project.
813
814
Recipe for importing a tree of files:
815
cd ~/project
816
bzr init
817
bzr add -v .
818
bzr status
819
bzr commit -m 'imported project'
820
"""
821
def run(self):
822
from bzrlib.branch import Branch
823
Branch('.', init=True)
824
825
826
class cmd_diff(Command):
827
"""Show differences in working tree.
828
358
829
If files are listed, only the changes in those files are listed.
359
830
Otherwise, all changes for the tree are listed.
360
831
361
TODO: Given two revision arguments, show the difference between them.
362
363
832
TODO: Allow diff across branches.
364
833
365
834
TODO: Option to use external diff command; could be GNU diff, wdiff,
374
843
deleted files.
375
844
376
845
TODO: This probably handles non-Unix newlines poorly.
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.
846
847
examples:
848
bzr diff
849
bzr diff -r1
850
bzr diff -r1:2
851
"""
409
852
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)
484
else:
485
bailout("can't represent state %s {%s}" % (file_state, fid))
486
487
488
489
def cmd_deleted(show_ids=False):
853
takes_args = ['file*']
854
takes_options = ['revision', 'diff-options']
855
aliases = ['di', 'dif']
856
857
def run(self, revision=None, file_list=None, diff_options=None):
858
from bzrlib.diff import show_diff
859
860
if file_list:
861
b = find_branch(file_list[0])
862
file_list = [b.relpath(f) for f in file_list]
863
if file_list == ['']:
864
# just pointing to top-of-tree
865
file_list = None
866
else:
867
b = find_branch('.')
868
869
if revision is not None:
870
if len(revision) == 1:
871
show_diff(b, revision[0], specific_files=file_list,
872
external_diff_options=diff_options)
873
elif len(revision) == 2:
874
show_diff(b, revision[0], specific_files=file_list,
875
external_diff_options=diff_options,
876
revision2=revision[1])
877
else:
878
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
879
else:
880
show_diff(b, None, specific_files=file_list,
881
external_diff_options=diff_options)
882
883
884
885
886
class cmd_deleted(Command):
490
887
"""List files deleted in the working tree.
491
888
492
889
TODO: Show files deleted since a previous revision, or between two revisions.
493
890
"""
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)
891
def run(self, show_ids=False):
892
b = find_branch('.')
893
old = b.basis_tree()
894
new = b.working_tree()
895
896
## TODO: Much more efficient way to do this: read in new
897
## directories with readdir, rather than stating each one. Same
898
## level of effort but possibly much less IO. (Or possibly not,
899
## if the directories are very large...)
900
901
for path, ie in old.inventory.iter_entries():
902
if not new.has_id(ie.file_id):
903
if show_ids:
904
print '%-50s %s' % (path, ie.file_id)
905
else:
906
print path
907
908
909
class cmd_modified(Command):
910
"""List files modified in working tree."""
911
hidden = True
912
def run(self):
913
from bzrlib.delta import compare_trees
914
915
b = find_branch('.')
916
td = compare_trees(b.basis_tree(), b.working_tree())
917
918
for path, id, kind in td.modified:
919
print path
920
921
922
923
class cmd_added(Command):
924
"""List files added in working tree."""
925
hidden = True
926
def run(self):
927
b = find_branch('.')
928
wt = b.working_tree()
929
basis_inv = b.basis_tree().inventory
930
inv = wt.inventory
931
for file_id in inv:
932
if file_id in basis_inv:
933
continue
934
path = inv.id2path(file_id)
935
if not os.access(b.abspath(path), os.F_OK):
936
continue
937
print path
537
938
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):
939
940
941
class cmd_root(Command):
942
"""Show the tree root directory.
943
944
The root is the nearest enclosing directory with a .bzr control
945
directory."""
946
takes_args = ['filename?']
947
def run(self, filename=None):
948
"""Print the branch root."""
949
b = find_branch(filename)
950
print getattr(b, 'base', None) or getattr(b, 'baseurl')
951
952
953
class cmd_log(Command):
565
954
"""Show log of this branch.
566
955
567
TODO: Options for utc; to show ids; to limit range; etc.
956
To request a range of logs, you can use the command -r begin:end
957
-r revision requests a specific revision, -r :end or -r begin: are
958
also valid.
959
960
--message allows you to give a regular expression, which will be evaluated
961
so that only matching entries will be displayed.
962
963
TODO: Make --revision support uuid: and hash: [future tag:] notation.
964
568
965
"""
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
570
571
572
def cmd_ls(revision=None, verbose=False):
966
967
takes_args = ['filename?']
968
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
969
'long', 'message', 'short',]
970
971
def run(self, filename=None, timezone='original',
972
verbose=False,
973
show_ids=False,
974
forward=False,
975
revision=None,
976
message=None,
977
long=False,
978
short=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 not short:
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):
573
1053
"""List files in a tree.
574
1054
575
1055
TODO: Take a revision or remote path and list that tree instead.
576
1056
"""
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 = ''
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)
589
1075
else:
590
kindch = '???'
591
592
print '%-8s %s%s' % (fc, fp, kindch)
593
else:
594
print fp
595
596
597
598
def cmd_unknowns():
599
"""List unknown files"""
600
for f in Branch('.').unknowns():
601
print quotefn(f)
602
603
604
605
def cmd_ignored():
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):
606
1148
"""List ignored files and the patterns that matched them.
607
"""
608
tree = Branch('.').working_tree()
609
for path, file_class, kind, file_id in tree.list_files():
610
if file_class != 'I':
611
continue
612
## XXX: Slightly inefficient since this was already calculated
613
pat = tree.is_ignored(path)
614
print '%-50s %s' % (path, pat)
615
616
617
def cmd_lookup_revision(revno):
618
try:
619
revno = int(revno)
620
except ValueError:
621
bailout("usage: lookup-revision REVNO",
622
["REVNO is a non-negative revision number for this branch"])
623
624
print Branch('.').lookup_revision(revno) or NONE_STRING
625
626
627
628
def cmd_export(revno, dest):
629
"""Export past revision to destination directory."""
630
b = Branch('.')
631
rh = b.lookup_revision(int(revno))
632
t = b.revision_tree(rh)
633
t.export(dest)
634
635
def cmd_cat(revision, filename):
636
"""Print file to stdout."""
637
b = Branch('.')
638
b.print_file(b.relpath(filename), int(revision))
639
640
641
######################################################################
642
# internal/test commands
643
644
645
def cmd_uuid():
646
"""Print a newly-generated UUID."""
647
print bzrlib.osutils.uuid()
648
649
650
651
def cmd_local_time_offset():
652
print bzrlib.osutils.local_time_offset()
653
654
655
656
def cmd_commit(message=None, verbose=False):
657
"""Commit changes to a new revision.
658
659
--message MESSAGE
660
Description of changes in this revision; free form text.
661
It is recommended that the first line be a single-sentence
662
summary.
663
--verbose
664
Show status of changed files,
665
666
TODO: Commit only selected files.
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.
667
1251
668
1252
TODO: Run hooks on tree to-be-committed, and after commit.
669
1253
670
1254
TODO: Strict commit that fails if there are unknown or deleted files.
671
1255
"""
672
673
if not message:
674
bailout("please specify a commit message")
675
Branch('.').commit(message, verbose=verbose)
676
677
678
def cmd_check(dir='.'):
679
"""check: Consistency check of branch history.
680
681
usage: bzr check [-v] [BRANCH]
682
683
options:
684
--verbose, -v Show progress of checking.
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.
685
1307
686
1308
This command checks various invariants about the branch storage to
687
1309
detect data corruption or bzr bugs.
688
"""
689
import bzrlib.check
690
bzrlib.check.check(Branch(dir, find_root=False))
691
692
693
def cmd_is(pred, *rest):
694
"""Test whether PREDICATE is true."""
695
try:
696
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
697
except KeyError:
698
bailout("unknown predicate: %s" % quotefn(pred))
699
700
try:
701
cmd_handler(*rest)
702
except BzrCheckError:
703
# by default we don't print the message so that this can
704
# be used from shell scripts without producing noise
705
sys.exit(1)
706
707
708
def cmd_whoami(email=False):
709
"""Show bzr user id.
710
711
usage: bzr whoami
712
713
options:
714
--email Show only the email address.
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
1319
check(find_branch(dir))
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']
715
1360
716
"""
717
if email:
718
print bzrlib.osutils.user_email()
719
else:
720
print bzrlib.osutils.username()
721
722
723
def cmd_gen_revision_id():
724
print bzrlib.branch._gen_revision_id(time.time())
725
726
727
def cmd_selftest():
1361
def run(self, email=False):
1362
try:
1363
b = bzrlib.branch.find_branch('.')
1364
except:
1365
b = None
1366
1367
if email:
1368
print bzrlib.osutils.user_email(b)
1369
else:
1370
print bzrlib.osutils.username(b)
1371
1372
1373
class cmd_selftest(Command):
728
1374
"""Run internal test suite"""
729
## -v, if present, is seen by doctest; the argument is just here
730
## so our parser doesn't complain
731
732
## TODO: --verbose option
733
734
failures, tests = 0, 0
735
736
import doctest, bzrlib.store, bzrlib.tests
737
bzrlib.trace.verbose = False
738
739
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
740
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
741
mf, mt = doctest.testmod(m)
742
failures += mf
743
tests += mt
744
print '%-40s %3d tests' % (m.__name__, mt),
745
if mf:
746
print '%3d FAILED!' % mf
747
else:
748
print
749
750
print '%-40s %3d tests' % ('total', tests),
751
if failures:
752
print '%3d FAILED!' % failures
753
else:
754
print
755
756
757
758
# deprecated
759
cmd_doctest = cmd_selftest
760
761
762
######################################################################
763
# help
764
765
766
def cmd_help(topic=None):
767
if topic == None:
768
print __doc__
769
elif topic == 'commands':
770
help_commands()
771
else:
772
# otherwise, maybe the name of a command?
773
topic, cmdfn = get_cmd_handler(topic)
774
775
doc = getdoc(cmdfn)
776
if doc == None:
777
bailout("sorry, no detailed help yet for %r" % topic)
778
779
print doc
780
781
782
def help_commands():
783
"""List all commands"""
784
accu = []
785
for k in globals().keys():
786
if k.startswith('cmd_'):
787
accu.append(k[4:].replace('_','-'))
788
accu.sort()
789
print "bzr commands: "
790
for x in accu:
791
print " " + x
792
print "note: some of these commands are internal-use or obsolete"
793
# TODO: Some kind of marker for internal-use commands?
794
# TODO: Show aliases?
795
796
797
798
799
def cmd_version():
1375
hidden = True
1376
takes_options = ['verbose', 'pattern']
1377
def run(self, verbose=False, pattern=".*"):
1378
import bzrlib.ui
1379
from bzrlib.selftest import selftest
1380
# we don't want progress meters from the tests to go to the
1381
# real output.
1382
save_ui = bzrlib.ui.ui_factory
1383
try:
1384
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1385
return int(not selftest(verbose=verbose, pattern=pattern))
1386
finally:
1387
bzrlib.ui.ui_factory = save_ui
1388
1389
1390
class cmd_version(Command):
1391
"""Show version of bzr."""
1392
def run(self):
1393
show_version()
1394
1395
def show_version():
800
1396
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1397
# is bzrlib itself in a branch?
1398
bzrrev = bzrlib.get_bzr_revision()
1399
if bzrrev:
1400
print " (bzr checkout, revision %d {%s})" % bzrrev
801
1401
print bzrlib.__copyright__
802
1402
print "http://bazaar-ng.org/"
803
1403
print
804
print \
805
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
806
you may use, modify and redistribute it under the terms of the GNU
807
General Public License version 2 or later."""
808
809
810
def cmd_rocks():
1404
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1405
print "you may use, modify and redistribute it under the terms of the GNU"
1406
print "General Public License version 2 or later."
1407
1408
1409
class cmd_rocks(Command):
811
1410
"""Statement of optimism."""
812
print "it sure does!"
813
814
815
816
######################################################################
817
# main routine
1411
hidden = True
1412
def run(self):
1413
print "it sure does!"
1414
1415
def parse_spec(spec):
1416
"""
1417
>>> parse_spec(None)
1418
[None, None]
1419
>>> parse_spec("./")
1420
['./', None]
1421
>>> parse_spec("../@")
1422
['..', -1]
1423
>>> parse_spec("../f/@35")
1424
['../f', 35]
1425
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1426
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1427
"""
1428
if spec is None:
1429
return [None, None]
1430
if '/@' in spec:
1431
parsed = spec.split('/@')
1432
assert len(parsed) == 2
1433
if parsed[1] == "":
1434
parsed[1] = -1
1435
else:
1436
try:
1437
parsed[1] = int(parsed[1])
1438
except ValueError:
1439
pass # We can allow stuff like ./@revid:blahblahblah
1440
else:
1441
assert parsed[1] >=0
1442
else:
1443
parsed = [spec, None]
1444
return parsed
1445
1446
1447
1448
class cmd_find_merge_base(Command):
1449
"""Find and print a base revision for merging two branches.
1450
1451
TODO: Options to specify revisions on either side, as if
1452
merging only part of the history.
1453
"""
1454
takes_args = ['branch', 'other']
1455
hidden = True
1456
1457
def run(self, branch, other):
1458
branch1 = find_branch(branch)
1459
branch2 = find_branch(other)
1460
1461
base_revno, base_revid = branch1.common_ancestor(branch2)
1462
1463
if base_revno is None:
1464
raise bzrlib.errors.UnrelatedBranches()
1465
1466
print 'merge base is revision %s' % base_revid
1467
print ' r%-6d in %s' % (base_revno, branch)
1468
1469
other_revno = branch2.revision_id_to_revno(base_revid)
1470
1471
print ' r%-6d in %s' % (other_revno, other)
1472
1473
1474
1475
class cmd_merge(Command):
1476
"""Perform a three-way merge.
1477
1478
The branch is the branch you will merge from. By default, it will merge
1479
the latest revision. If you specify a revision, that revision will be
1480
merged. If you specify two revisions, the first will be used as a BASE,
1481
and the second one as OTHER. Revision numbers are always relative to the
1482
specified branch.
1483
1484
Examples:
1485
1486
To merge the latest revision from bzr.dev
1487
bzr merge ../bzr.dev
1488
1489
To merge changes up to and including revision 82 from bzr.dev
1490
bzr merge -r 82 ../bzr.dev
1491
1492
To merge the changes introduced by 82, without previous changes:
1493
bzr merge -r 81..82 ../bzr.dev
1494
1495
merge refuses to run if there are any uncommitted changes, unless
1496
--force is given.
1497
"""
1498
takes_args = ['branch?']
1499
takes_options = ['revision', 'force', 'merge-type']
1500
1501
def run(self, branch='.', revision=None, force=False,
1502
merge_type=None):
1503
from bzrlib.merge import merge
1504
from bzrlib.merge_core import ApplyMerge3
1505
if merge_type is None:
1506
merge_type = ApplyMerge3
1507
1508
if revision is None or len(revision) < 1:
1509
base = (None, None)
1510
other = (branch, -1)
1511
else:
1512
if len(revision) == 1:
1513
other = (branch, revision[0])
1514
base = (None, None)
1515
else:
1516
assert len(revision) == 2
1517
if None in revision:
1518
raise BzrCommandError(
1519
"Merge doesn't permit that revision specifier.")
1520
base = (branch, revision[0])
1521
other = (branch, revision[1])
1522
1523
merge(other, base, check_clean=(not force), merge_type=merge_type)
1524
1525
1526
class cmd_revert(Command):
1527
"""Reverse all changes since the last commit.
1528
1529
Only versioned files are affected. Specify filenames to revert only
1530
those files. By default, any files that are changed will be backed up
1531
first. Backup files have a '~' appended to their name.
1532
"""
1533
takes_options = ['revision', 'no-backup']
1534
takes_args = ['file*']
1535
aliases = ['merge-revert']
1536
1537
def run(self, revision=None, no_backup=False, file_list=None):
1538
from bzrlib.merge import merge
1539
if file_list is not None:
1540
if len(file_list) == 0:
1541
raise BzrCommandError("No files specified")
1542
if revision is None:
1543
revision = [-1]
1544
elif len(revision) != 1:
1545
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1546
merge(('.', revision[0]), parse_spec('.'),
1547
check_clean=False,
1548
ignore_zero=True,
1549
backup_files=not no_backup,
1550
file_list=file_list)
1551
1552
1553
class cmd_assert_fail(Command):
1554
"""Test reporting of assertion failures"""
1555
hidden = True
1556
def run(self):
1557
assert False, "always fails"
1558
1559
1560
class cmd_help(Command):
1561
"""Show help on a command or other topic.
1562
1563
For a list of all available commands, say 'bzr help commands'."""
1564
takes_options = ['long']
1565
takes_args = ['topic?']
1566
aliases = ['?']
1567
1568
def run(self, topic=None, long=False):
1569
import help
1570
if topic is None and long:
1571
topic = "commands"
1572
help.help(topic)
1573
1574
1575
class cmd_shell_complete(Command):
1576
"""Show appropriate completions for context.
1577
1578
For a list of all available commands, say 'bzr shell-complete'."""
1579
takes_args = ['context?']
1580
aliases = ['s-c']
1581
hidden = True
1582
1583
def run(self, context=None):
1584
import shellcomplete
1585
shellcomplete.shellcomplete(context)
1586
1587
1588
class cmd_missing(Command):
1589
"""What is missing in this branch relative to other branch.
1590
"""
1591
takes_args = ['remote?']
1592
aliases = ['mis', 'miss']
1593
# We don't have to add quiet to the list, because
1594
# unknown options are parsed as booleans
1595
takes_options = ['verbose', 'quiet']
1596
1597
def run(self, remote=None, verbose=False, quiet=False):
1598
from bzrlib.branch import find_branch, DivergedBranches
1599
from bzrlib.errors import BzrCommandError
1600
from bzrlib.missing import get_parent, show_missing
1601
1602
if verbose and quiet:
1603
raise BzrCommandError('Cannot pass both quiet and verbose')
1604
1605
b = find_branch('.')
1606
parent = get_parent(b)
1607
if remote is None:
1608
if parent is None:
1609
raise BzrCommandError("No missing location known or specified.")
1610
else:
1611
if not quiet:
1612
print "Using last location: %s" % parent
1613
remote = parent
1614
elif parent is None:
1615
# We only update x-pull if it did not exist, missing should not change the parent
1616
b.controlfile('x-pull', 'wb').write(remote + '\n')
1617
br_remote = find_branch(remote)
1618
1619
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1620
1621
1622
1623
class cmd_plugins(Command):
1624
"""List plugins"""
1625
hidden = True
1626
def run(self):
1627
import bzrlib.plugin
1628
from inspect import getdoc
1629
from pprint import pprint
1630
for plugin in bzrlib.plugin.all_plugins:
1631
print plugin.__path__[0]
1632
d = getdoc(plugin)
1633
if d:
1634
print '\t', d.split('\n')[0]
1635
1636
#pprint(bzrlib.plugin.all_plugins)
1637
818
1638
819
1639
820
1640
# list of all available options; the rhs can be either None for an
822
1642
# the type.
823
1643
OPTIONS = {
824
1644
'all': None,
1645
'diff-options': str,
825
1646
'help': None,
1647
'file': unicode,
1648
'force': None,
1649
'format': unicode,
1650
'forward': None,
826
1651
'message': unicode,
1652
'no-recurse': None,
827
1653
'profile': None,
828
'revision': int,
1654
'revision': _parse_revision_str,
1655
'short': None,
829
1656
'show-ids': None,
830
1657
'timezone': str,
831
1658
'verbose': None,
832
1659
'version': None,
833
1660
'email': None,
1661
'unchanged': None,
1662
'update': None,
1663
'long': None,
1664
'root': str,
1665
'no-backup': None,
1666
'merge-type': get_merge_type,
1667
'pattern': str,
834
1668
}
835
1669
836
1670
SHORT_OPTIONS = {
1671
'F': 'file',
1672
'h': 'help',
837
1673
'm': 'message',
838
1674
'r': 'revision',
839
1675
'v': 'verbose',
1676
'l': 'long',
840
1677
}
841
1678
842
# List of options that apply to particular commands; commands not
843
# listed take none.
844
cmd_options = {
845
'add': ['verbose'],
846
'cat': ['revision'],
847
'commit': ['message', 'verbose'],
848
'deleted': ['show-ids'],
849
'diff': ['revision'],
850
'inventory': ['revision'],
851
'log': ['timezone', 'verbose'],
852
'ls': ['revision', 'verbose'],
853
'remove': ['verbose'],
854
'status': ['all'],
855
'whoami': ['email'],
856
}
857
858
859
cmd_args = {
860
'add': ['file+'],
861
'cat': ['filename'],
862
'commit': [],
863
'diff': ['file*'],
864
'export': ['revno', 'dest'],
865
'file-id': ['filename'],
866
'file-id-path': ['filename'],
867
'get-file-text': ['text_id'],
868
'get-inventory': ['inventory_id'],
869
'get-revision': ['revision_id'],
870
'get-revision-inventory': ['revision_id'],
871
'help': ['topic?'],
872
'init': [],
873
'log': [],
874
'lookup-revision': ['revno'],
875
'move': ['source$', 'dest'],
876
'relpath': ['filename'],
877
'remove': ['file+'],
878
'rename': ['from_name', 'to_name'],
879
'renames': ['dir?'],
880
'root': ['filename?'],
881
'status': [],
882
}
883
884
1679
885
1680
def parse_args(argv):
886
1681
"""Parse command line.
898
1693
(['status'], {'all': True})
899
1694
>>> parse_args('commit --message=biter'.split())
900
1695
(['commit'], {'message': u'biter'})
1696
>>> parse_args('log -r 500'.split())
1697
(['log'], {'revision': [500]})
1698
>>> parse_args('log -r500..600'.split())
1699
(['log'], {'revision': [500, 600]})
1700
>>> parse_args('log -vr500..600'.split())
1701
(['log'], {'verbose': True, 'revision': [500, 600]})
1702
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1703
(['log'], {'revision': ['v500', 600]})
901
1704
"""
902
1705
args = []
903
1706
opts = {}
917
1720
else:
918
1721
optname = a[2:]
919
1722
if optname not in OPTIONS:
920
bailout('unknown long option %r' % a)
1723
raise BzrError('unknown long option %r' % a)
921
1724
else:
922
1725
shortopt = a[1:]
923
if shortopt not in SHORT_OPTIONS:
924
bailout('unknown short option %r' % a)
925
optname = SHORT_OPTIONS[shortopt]
1726
if shortopt in SHORT_OPTIONS:
1727
# Multi-character options must have a space to delimit
1728
# their value
1729
optname = SHORT_OPTIONS[shortopt]
1730
else:
1731
# Single character short options, can be chained,
1732
# and have their value appended to their name
1733
shortopt = a[1:2]
1734
if shortopt not in SHORT_OPTIONS:
1735
# We didn't find the multi-character name, and we
1736
# didn't find the single char name
1737
raise BzrError('unknown short option %r' % a)
1738
optname = SHORT_OPTIONS[shortopt]
1739
1740
if a[2:]:
1741
# There are extra things on this option
1742
# see if it is the value, or if it is another
1743
# short option
1744
optargfn = OPTIONS[optname]
1745
if optargfn is None:
1746
# This option does not take an argument, so the
1747
# next entry is another short option, pack it back
1748
# into the list
1749
argv.insert(0, '-' + a[2:])
1750
else:
1751
# This option takes an argument, so pack it
1752
# into the array
1753
optarg = a[2:]
926
1754
927
1755
if optname in opts:
928
1756
# XXX: Do we ever want to support this, e.g. for -r?
929
bailout('repeated option %r' % a)
1757
raise BzrError('repeated option %r' % a)
930
1758
931
1759
optargfn = OPTIONS[optname]
932
1760
if optargfn:
933
1761
if optarg == None:
934
1762
if not argv:
935
bailout('option %r needs an argument' % a)
1763
raise BzrError('option %r needs an argument' % a)
936
1764
else:
937
1765
optarg = argv.pop(0)
938
1766
opts[optname] = optargfn(optarg)
939
1767
else:
940
1768
if optarg != None:
941
bailout('option %r takes no argument' % optname)
1769
raise BzrError('option %r takes no argument' % optname)
942
1770
opts[optname] = True
943
1771
else:
944
1772
args.append(a)
947
1775
948
1776
949
1777
950
def _match_args(cmd, args):
951
"""Check non-option arguments match required pattern.
952
1778
953
>>> _match_args('status', ['asdasdsadasd'])
954
Traceback (most recent call last):
955
...
956
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
957
>>> _match_args('add', ['asdasdsadasd'])
958
{'file_list': ['asdasdsadasd']}
959
>>> _match_args('add', 'abc def gj'.split())
960
{'file_list': ['abc', 'def', 'gj']}
961
"""
962
# match argument pattern
963
argform = cmd_args.get(cmd, [])
1779
def _match_argform(cmd, takes_args, args):
964
1780
argdict = {}
965
# TODO: Need a way to express 'cp SRC... DEST', where it matches
966
# all but one.
967
1781
968
# step through args and argform, allowing appropriate 0-many matches
969
for ap in argform:
1782
# step through args and takes_args, allowing appropriate 0-many matches
1783
for ap in takes_args:
970
1784
argname = ap[:-1]
971
1785
if ap[-1] == '?':
972
1786
if args:
979
1793
argdict[argname + '_list'] = None
980
1794
elif ap[-1] == '+':
981
1795
if not args:
982
bailout("command %r needs one or more %s"
1796
raise BzrCommandError("command %r needs one or more %s"
983
1797
% (cmd, argname.upper()))
984
1798
else:
985
1799
argdict[argname + '_list'] = args[:]
986
1800
args = []
987
1801
elif ap[-1] == '$': # all but one
988
1802
if len(args) < 2:
989
bailout("command %r needs one or more %s"
1803
raise BzrCommandError("command %r needs one or more %s"
990
1804
% (cmd, argname.upper()))
991
1805
argdict[argname + '_list'] = args[:-1]
992
1806
args[:-1] = []
994
1808
# just a plain arg
995
1809
argname = ap
996
1810
if not args:
997
bailout("command %r requires argument %s"
1811
raise BzrCommandError("command %r requires argument %s"
998
1812
% (cmd, argname.upper()))
999
1813
else:
1000
1814
argdict[argname] = args.pop(0)
1001
1815
1002
1816
if args:
1003
bailout("extra arguments to command %s: %r"
1004
% (cmd, args))
1817
raise BzrCommandError("extra argument to command %s: %s"
1818
% (cmd, args[0]))
1005
1819
1006
1820
return argdict
1007
1821
1012
1826
1013
1827
This is similar to main(), but without all the trappings for
1014
1828
logging and error handling.
1829
1830
argv
1831
The command-line arguments, without the program name from argv[0]
1832
1833
Returns a command status or raises an exception.
1834
1835
Special master options: these must come before the command because
1836
they control how the command is interpreted.
1837
1838
--no-plugins
1839
Do not load plugin modules at all
1840
1841
--builtin
1842
Only use builtin commands. (Plugins are still allowed to change
1843
other behaviour.)
1844
1845
--profile
1846
Run under the Python profiler.
1015
1847
"""
1016
1848
1017
1849
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1018
1019
try:
1020
args, opts = parse_args(argv[1:])
1021
if 'help' in opts:
1022
# TODO: pass down other arguments in case they asked for
1023
# help on a command name?
1024
if args:
1025
cmd_help(args[0])
1026
else:
1027
cmd_help()
1028
return 0
1029
elif 'version' in opts:
1030
cmd_version()
1031
return 0
1032
cmd = str(args.pop(0))
1033
except IndexError:
1034
log_error('usage: bzr COMMAND')
1035
log_error(' try "bzr help"')
1036
return 1
1037
1038
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1039
1040
# global option
1041
if 'profile' in opts:
1042
profile = True
1043
del opts['profile']
1044
else:
1045
profile = False
1850
1851
opt_profile = opt_no_plugins = opt_builtin = False
1852
1853
# --no-plugins is handled specially at a very early stage. We need
1854
# to load plugins before doing other command parsing so that they
1855
# can override commands, but this needs to happen first.
1856
1857
for a in argv[:]:
1858
if a == '--profile':
1859
opt_profile = True
1860
elif a == '--no-plugins':
1861
opt_no_plugins = True
1862
elif a == '--builtin':
1863
opt_builtin = True
1864
else:
1865
break
1866
argv.remove(a)
1867
1868
if not opt_no_plugins:
1869
from bzrlib.plugin import load_plugins
1870
load_plugins()
1871
1872
args, opts = parse_args(argv)
1873
1874
if 'help' in opts:
1875
from bzrlib.help import help
1876
if args:
1877
help(args[0])
1878
else:
1879
help()
1880
return 0
1881
1882
if 'version' in opts:
1883
show_version()
1884
return 0
1885
1886
if not args:
1887
from bzrlib.help import help
1888
help(None)
1889
return 0
1890
1891
cmd = str(args.pop(0))
1892
1893
canonical_cmd, cmd_class = \
1894
get_cmd_class(cmd, plugins_override=not opt_builtin)
1046
1895
1047
1896
# check options are reasonable
1048
allowed = cmd_options.get(canonical_cmd, [])
1897
allowed = cmd_class.takes_options
1049
1898
for oname in opts:
1050
1899
if oname not in allowed:
1051
bailout("option %r is not allowed for command %r"
1052
% (oname, cmd))
1053
1054
# TODO: give an error if there are any mandatory options which are
1055
# not specified? Or maybe there shouldn't be any "mandatory
1056
# options" (it is an oxymoron)
1900
raise BzrCommandError("option '--%s' is not allowed for command %r"
1901
% (oname, cmd))
1057
1902
1058
1903
# mix arguments and options into one dictionary
1059
cmdargs = _match_args(canonical_cmd, args)
1904
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1905
cmdopts = {}
1060
1906
for k, v in opts.items():
1061
cmdargs[k.replace('-', '_')] = v
1907
cmdopts[k.replace('-', '_')] = v
1062
1908
1063
if profile:
1064
import hotshot
1909
if opt_profile:
1910
import hotshot, tempfile
1065
1911
pffileno, pfname = tempfile.mkstemp()
1066
1912
try:
1067
1913
prof = hotshot.Profile(pfname)
1068
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1914
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1069
1915
prof.close()
1070
1916
1071
1917
import hotshot.stats
1076
1922
## print_stats seems hardcoded to stdout
1077
1923
stats.print_stats(20)
1078
1924
1079
return ret
1925
return ret.status
1080
1926
1081
1927
finally:
1082
1928
os.close(pffileno)
1083
1929
os.remove(pfname)
1084
1930
else:
1085
return cmd_handler(**cmdargs) or 0
1086
1087
1088
1089
def _report_exception(e, summary):
1090
import traceback
1091
log_error('bzr: ' + summary)
1092
bzrlib.trace.log_exception(e)
1093
tb = sys.exc_info()[2]
1094
exinfo = traceback.extract_tb(tb)
1095
if exinfo:
1096
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1097
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1098
1099
1100
def cmd_assert_fail():
1101
assert False, "always fails"
1931
return cmd_class(cmdopts, cmdargs).status
1102
1932
1103
1933
1104
1934
def main(argv):
1105
bzrlib.trace.create_tracefile(argv)
1935
import bzrlib.ui
1936
1937
bzrlib.trace.open_tracefile(argv)
1938
1939
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1106
1940
1107
1941
try:
1108
1942
try:
1109
ret = run_bzr(argv)
1110
return ret
1111
except BzrError, e:
1112
_report_exception(e, 'error: ' + e.args[0])
1113
if len(e.args) > 1:
1114
for h in e.args[1]:
1115
# some explanation or hints
1116
log_error(' ' + h)
1117
return 1
1118
except AssertionError, e:
1119
msg = 'assertion failed'
1120
if str(e):
1121
msg += ': ' + str(e)
1122
_report_exception(e, msg)
1123
except Exception, e:
1124
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1125
return 1
1126
finally:
1127
bzrlib.trace.close_trace()
1128
1129
## TODO: Trap AssertionError
1130
1131
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1132
1943
return run_bzr(argv[1:])
1944
finally:
1945
# do this here inside the exception wrappers to catch EPIPE
1946
sys.stdout.flush()
1947
except BzrCommandError, e:
1948
# command line syntax error, etc
1949
log_error(str(e))
1950
return 1
1951
except BzrError, e:
1952
bzrlib.trace.log_exception()
1953
return 1
1954
except AssertionError, e:
1955
bzrlib.trace.log_exception('assertion failed: ' + str(e))
1956
return 3
1957
except KeyboardInterrupt, e:
1958
bzrlib.trace.note('interrupted')
1959
return 2
1960
except Exception, e:
1961
import errno
1962
if (isinstance(e, IOError)
1963
and hasattr(e, 'errno')
1964
and e.errno == errno.EPIPE):
1965
bzrlib.trace.note('broken pipe')
1966
return 2
1967
else:
1968
bzrlib.trace.log_exception()
1969
return 2
1133
1970
1134
1971
1135
1972
if __name__ == '__main__':
Loggerhead is a web-based interface for Breezy
Version: 2.0.1