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