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