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