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