16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
Various useful plugins for working with bzr.
26
__version__ = '0.14.0'
29
version_info = tuple(int(n) for n in __version__.split('.'))
32
def check_bzrlib_version(desired):
33
"""Check that bzrlib is compatible.
35
If version is < bzrtools version, assume incompatible.
36
If version == bzrtools version, assume completely compatible
37
If version == bzrtools version + 1, assume compatible, with deprecations
38
Otherwise, assume incompatible.
40
desired_plus = (desired[0], desired[1]+1)
41
bzrlib_version = bzrlib.version_info[:2]
42
if bzrlib_version == desired:
45
from bzrlib.trace import warning
47
# get the message out any way we can
48
from warnings import warn as warning
49
if bzrlib_version < desired:
50
warning('Installed bzr version %s is too old to be used with bzrtools'
51
' %s.' % (bzrlib.__version__, __version__))
52
# Not using BzrNewError, because it may not exist.
53
raise Exception, ('Version mismatch', version_info)
55
warning('Bzrtools is not up to date with installed bzr version %s.'
56
' \nThere should be a newer version available, e.g. %i.%i.'
57
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
58
if bzrlib_version != desired_plus:
59
raise Exception, 'Version mismatch'
62
check_bzrlib_version(version_info[:2])
65
from errors import CommandError, NoPyBaz
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import help, urlutils
27
from command import BzrToolsCommand
28
from errors import CommandError
66
29
from patchsource import BzrPatchSource
67
from shelf import Shelf
71
33
import bzrlib.builtins
72
34
import bzrlib.commands
35
from bzrlib.branch import Branch
36
from bzrlib.bzrdir import BzrDir
73
37
from bzrlib.commands import get_cmd_object
74
38
from bzrlib.errors import BzrCommandError
75
from bzrlib.help import command_usage
76
39
import bzrlib.ignores
40
from bzrlib.trace import note
77
41
from bzrlib.option import Option
78
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
83
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
86
class cmd_clean_tree(bzrlib.commands.Command):
43
from command import BzrToolsCommand
46
class cmd_clean_tree(BzrToolsCommand):
87
47
"""Remove unwanted files from working tree.
89
49
By default, only unknown files, not ignored files, are deleted. Versioned
99
59
To check what clean-tree will do, use --dry-run.
101
takes_options = [Option('ignored', help='delete all ignored files.'),
102
Option('detritus', help='delete conflict files, merge'
103
' backups, and failed selftest dirs.'),
105
help='delete files unknown to bzr. (default)'),
106
Option('dry-run', help='show files to delete instead of'
108
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
61
takes_options = [Option('ignored', help='Delete all ignored files.'),
62
Option('detritus', help='Delete conflict files, merge'
63
' backups, and failed selftest dirs.'),
65
help='Delete files unknown to bzr (default).'),
66
Option('dry-run', help='Show files to delete instead of'
68
Option('force', help='Do not prompt before deleting.')]
69
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
109
71
from clean_tree import clean_tree
110
72
if not (unknown or ignored or detritus):
112
76
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
116
class cmd_graph_ancestry(bzrlib.commands.Command):
77
dry_run=dry_run, no_prompt=force)
80
class cmd_graph_ancestry(BzrToolsCommand):
117
81
"""Produce ancestry graphs using dot.
119
83
Output format is detected according to file extension. Some of the more
148
112
If available, rsvg is used to antialias PNG and JPEG output, but this can
149
113
be disabled with --no-antialias.
151
takes_args = ['branch', 'file']
152
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
115
takes_args = ['file', 'merge_branch?']
116
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
153
117
Option('no-antialias',
154
help="Do not use rsvg to produce antialiased output"),
155
Option('merge-branch', type=str,
156
help="Use this branch to calcuate a merge base"),
157
Option('cluster', help="Use clustered output.")]
158
def run(self, branch, file, no_collapse=False, no_antialias=False,
159
merge_branch=None, cluster=False):
118
help="Do not use rsvg to produce antialiased output."),
119
Option('merge-branch', type=str,
120
help="Use this branch to calcuate a merge base."),
121
Option('cluster', help="Use clustered output."),
122
Option('max-distance',
123
help="Show no nodes farther than this.", type=int),
125
help='Source branch to use (default is current'
130
def run(self, file, merge_branch=None, no_collapse=False,
131
no_antialias=False, cluster=False, max_distance=100,
133
if max_distance == -1:
162
137
ranking = "cluster"
164
139
ranking = "forced"
165
graph.write_ancestry_file(branch, file, not no_collapse,
166
not no_antialias, merge_branch, ranking)
169
class cmd_fetch_ghosts(bzrlib.commands.Command):
140
graph.write_ancestry_file(directory, file, not no_collapse,
141
not no_antialias, merge_branch, ranking,
142
max_distance=max_distance)
145
class cmd_fetch_ghosts(BzrToolsCommand):
170
146
"""Attempt to retrieve ghosts from another branch.
171
147
If the other branch is not supplied, the last-pulled branch is used.
173
149
aliases = ['fetch-missing']
174
150
takes_args = ['branch?']
175
takes_options = [Option('no-fix')]
151
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
176
152
def run(self, branch=None, no_fix=False):
177
153
from fetch_ghosts import fetch_ghosts
178
154
fetch_ghosts(branch, no_fix)
181
157
each file name found in the patch file."""
184
class cmd_patch(bzrlib.commands.Command):
160
class cmd_patch(BzrToolsCommand):
185
161
"""Apply a named patch to the current tree.
187
163
takes_args = ['filename?']
188
takes_options = [Option('strip', type=int, help=strip_help)]
189
def run(self, filename=None, strip=None):
164
takes_options = [Option('strip', type=int, help=strip_help),
165
Option('silent', help='Suppress chatter.')]
166
def run(self, filename=None, strip=None, silent=False):
190
167
from patch import patch
191
168
from bzrlib.workingtree import WorkingTree
192
169
wt = WorkingTree.open_containing('.')[0]
193
170
if strip is None:
195
return patch(wt, filename, strip)
198
class cmd_shelve(bzrlib.commands.Command):
172
return patch(wt, filename, strip, silent)
175
class cmd_shelve1(BzrToolsCommand):
199
176
"""Temporarily set aside some changes from the current tree.
201
178
Shelve allows you to temporarily put changes you've made "on the shelf",
202
179
ie. out of the way, until a later time when you can bring them back from
203
the shelf with the 'unshelve' command.
180
the shelf with the 'unshelve1' command.
205
182
Shelve is intended to help separate several sets of text changes that have
206
183
been inappropriately mingled. If you just want to get rid of all changes
207
184
(text and otherwise) and you don't need to restore them later, use revert.
208
If you want to shelve all text changes at once, use shelve --all.
185
If you want to shelve all text changes at once, use shelve1 --all.
210
By default shelve asks you what you want to shelve, press '?' at the
211
prompt to get help. To shelve everything run shelve --all.
187
By default shelve1 asks you what you want to shelve, press '?' at the
188
prompt to get help. To shelve everything run shelve1 --all.
213
190
If filenames are specified, only the changes to those files will be
214
191
shelved, other files will be left untouched.
216
193
If a revision is specified, changes since that revision will be shelved.
218
195
You can put multiple items on the shelf. Normally each time you run
219
unshelve the most recently shelved changes will be reinstated. However,
196
unshelve1 the most recently shelved changes will be reinstated. However,
220
197
you can also unshelve changes in a different order by explicitly
221
specifiying which changes to unshelve. This works best when the changes
198
specifiying which changes to unshelve1. This works best when the changes
222
199
don't depend on each other.
224
201
While you have patches on the shelf you can view and manipulate them with
225
202
the 'shelf' command. Run 'bzr shelf -h' for more info.
228
206
takes_args = ['file*']
229
takes_options = ['message', 'revision',
230
Option('all', help='Shelve all changes without prompting'),
231
Option('no-color', help='Never display changes in color')]
207
takes_options = [Option('message',
208
help='A message to associate with the shelved changes.',
209
short_name='m', type=unicode),
211
Option('all', help='Shelve all changes without prompting.'),
212
Option('no-color', help='Never display changes in color.')]
233
214
def run(self, all=False, file_list=None, message=None, revision=None,
353
class cmd_unshelve(bzrlib.commands.Command):
337
class cmd_unshelve1(BzrToolsCommand):
354
338
"""Restore shelved changes.
356
340
By default the most recently shelved changes are restored. However if you
357
341
specify a patch by name those changes will be restored instead.
359
See 'shelve' for more information.
343
See 'shelve1' for more information.
345
aliases = ['unshelve']
361
346
takes_options = [
362
Option('all', help='Unshelve all changes without prompting'),
363
Option('force', help='Force unshelving even if errors occur'),
364
Option('no-color', help='Never display changes in color')
347
Option('all', help='Unshelve all changes without prompting.'),
348
Option('force', help='Force unshelving even if errors occur.'),
349
Option('no-color', help='Never display changes in color.')
366
351
takes_args = ['patch?']
367
352
def run(self, patch=None, all=False, force=False, no_color=False):
368
353
source = BzrPatchSource()
369
s = Shelf(source.base)
354
s = shelf.Shelf(source.base)
370
355
s.unshelve(source, patch, all, force, no_color)
374
class cmd_shell(bzrlib.commands.Command):
359
class cmd_shell(BzrToolsCommand):
375
360
"""Begin an interactive shell tailored for bzr.
376
361
Bzr commands can be used without typing bzr first, and will be run natively
377
362
when possible. Tab completion is tailored for bzr. The shell prompt shows
419
404
If --branch is specified, the branch will be deleted too, but only if the
420
405
the branch has no new commits (relative to its parent).
422
takes_options = [Option("branch", help="Remove associtated branch from"
407
takes_options = [Option("branch", help="Remove associated branch from"
409
Option('force', help='Delete tree even if contents are'
424
411
takes_args = ["checkout"]
425
def run(self, checkout, branch=False):
412
def run(self, checkout, branch=False, force=False):
426
413
from zap import zap
427
return zap(checkout, remove_branch=branch)
430
class cmd_cbranch(bzrlib.commands.Command):
414
return zap(checkout, remove_branch=branch, allow_modified=force)
417
class cmd_cbranch(BzrToolsCommand):
432
419
Create a new checkout, associated with a new repository branch.
434
When you cbranch, bzr looks up the repository associated with your current
435
directory in locations.conf. It creates a new branch in that repository
436
with the same name and relative path as the checkout you request.
438
The locations.conf parameter is "cbranch_root". So if you want
439
cbranch operations in /home/jrandom/bigproject to produce branches in
440
/home/jrandom/bigproject/repository, you'd add this:
442
[/home/jrandom/bigproject]
443
cbranch_root = /home/jrandom/bigproject/repository
445
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
446
standalone branches will be produced. Standalone branches will also
447
be produced if the source branch is in 0.7 format (or earlier).
421
When you cbranch, bzr looks up a target location in locations.conf, and
422
creates the branch there.
424
In your locations.conf, add the following lines:
425
[/working_directory_root]
426
cbranch_target = /branch_root
427
cbranch_target:policy = appendpath
429
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
430
working directory root, the branch will be created in
431
"/branch_root/foo/baz"
433
NOTE: cbranch also supports "cbranch_root", but that behaviour is
449
takes_options = [Option("lightweight",
450
help="Create a lightweight checkout"), 'revision']
436
takes_options = [Option("lightweight",
437
help="Create a lightweight checkout."), 'revision',
438
Option('files-from', type=unicode,
439
help='Accelerate checkout using files from this'
442
help='Hard-link files from source/files-from tree'
451
444
takes_args = ["source", "target?"]
452
def run(self, source, target=None, lightweight=False, revision=None):
445
def run(self, source, target=None, lightweight=False, revision=None,
446
files_from=None, hardlink=False):
453
447
from cbranch import cbranch
454
return cbranch(source, target, lightweight=lightweight,
458
class cmd_branches(bzrlib.commands.Command):
448
return cbranch(source, target, lightweight=lightweight,
449
revision=revision, files_from=files_from,
453
class cmd_branches(BzrToolsCommand):
459
454
"""Scan a location for branches"""
460
455
takes_args = ["location?"]
461
456
def run(self, location=None):
462
457
from branches import branches
463
458
return branches(location)
460
class cmd_trees(BzrToolsCommand):
461
"""Scan a location for trees"""
462
takes_args = ['location?']
463
def run(self, location='.'):
464
from bzrlib.workingtree import WorkingTree
465
from bzrlib.transport import get_transport
466
t = get_transport(location)
467
for tree in WorkingTree.find_trees(location):
468
self.outf.write('%s\n' % t.relpath(
469
tree.bzrdir.root_transport.base))
466
class cmd_multi_pull(bzrlib.commands.Command):
471
class cmd_multi_pull(BzrToolsCommand):
467
472
"""Pull all the branches under a location, e.g. a repository.
469
474
Both branches present in the directory and the branches of checkouts are
472
477
takes_args = ["location?"]
473
478
def run(self, location=None):
474
from bzrlib.branch import Branch
475
479
from bzrlib.transport import get_transport
476
480
from bzrtools import iter_branch_tree
477
481
if location is None:
479
483
t = get_transport(location)
484
possible_transports = []
480
485
if not t.listable():
481
486
print "Can't list this type of location."
499
504
print "Pulling %s from %s" % (relpath, parent)
501
pullable.pull(Branch.open(parent))
506
branch_t = get_transport(parent, possible_transports)
507
pullable.pull(Branch.open_from_transport(branch_t))
502
508
except Exception, e:
506
class cmd_branch_mark(bzrlib.commands.Command):
508
Add, view or list branch markers <EXPERIMENTAL>
510
To add a mark, do 'bzr branch-mark MARK'.
511
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
513
To delete a mark, do 'bzr branch-mark --delete MARK'
515
These marks can be used to track a branch's status.
517
takes_args = ['mark?', 'branch?']
518
takes_options = [Option('delete', help='Delete this mark')]
519
def run(self, mark=None, branch=None, delete=False):
520
from branch_mark import branch_mark
521
branch_mark(mark, branch, delete)
524
class cmd_import(bzrlib.commands.Command):
525
"""Import sources from a tarball
527
This command will import a tarball into a bzr tree, replacing any versioned
528
files already present. If a directory is specified, it is used as the
529
target. If the directory does not exist, or is not versioned, it is
513
class cmd_import(BzrToolsCommand):
514
"""Import sources from a directory, tarball or zip file
516
This command will import a directory, tarball or zip file into a bzr
517
tree, replacing any versioned files already present. If a directory is
518
specified, it is used as the target. If the directory does not exist, or
519
is not versioned, it is created.
532
521
Tarballs may be gzip or bzip2 compressed. This is autodetected.
534
If the tarball has a single root directory, that directory is stripped
535
when extracting the tarball.
523
If the tarball or zip has a single root directory, that directory is
524
stripped when extracting the tarball. This is not done for directories.
538
527
takes_args = ['source', 'tree?']
539
528
def run(self, source, tree=None):
540
529
from upstream_import import do_import
541
530
do_import(source, tree)
544
class cmd_cdiff(bzrlib.commands.Command):
533
class cmd_cdiff(BzrToolsCommand):
545
534
"""A color version of bzr's diff"""
546
535
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
547
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
548
def run(*args, **kwargs):
536
takes_options = list(get_cmd_object('diff').takes_options) + [
537
Option('check-style',
538
help='Warn if trailing whitespace or spurious changes have been'
541
def run(self, check_style=False, *args, **kwargs):
549
542
from colordiff import colordiff
550
colordiff(*args, **kwargs)
553
class cmd_baz_import(bzrlib.commands.Command):
554
"""Import an Arch or Baz archive into a bzr repository.
556
This command should be used on local archives (or mirrors) only. It is
557
quite slow on remote archives.
559
reuse_history allows you to specify any previous imports you
560
have done of different archives, which this archive has branches
561
tagged from. This will dramatically reduce the time to convert
562
the archive as it will not have to convert the history already
563
converted in that other branch.
565
If you specify prefixes, only branches whose names start with that prefix
566
will be imported. Skipped branches will be listed, so you can import any
567
branches you missed by accident. Here's an example of doing a partial
568
import from thelove@canonical.com:
569
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
571
WARNING: Encoding should not be specified unless necessary, because if you
572
specify an encoding, your converted branch will not interoperate with
573
independently-converted branches, unless the other branches were converted
574
with exactly the same encoding. Any encoding recognized by Python may
575
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
578
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
579
takes_options = ['verbose', Option('prefixes', type=str,
580
help="Prefixes of branches to import, colon-separated"),
581
Option('encoding', type=str,
582
help='Force encoding to specified value. See WARNING.')]
584
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
585
reuse_history_list=[], prefixes=None):
586
from errors import NoPyBaz
589
baz_import.baz_import(to_root_dir, from_archive, encoding,
590
verbose, reuse_history_list, prefixes)
592
print "This command is disabled. Please install PyBaz."
595
class cmd_baz_import_branch(bzrlib.commands.Command):
596
"""Import an Arch or Baz branch into a bzr branch.
598
WARNING: Encoding should not be specified unless necessary, because if you
599
specify an encoding, your converted branch will not interoperate with
600
independently-converted branches, unless the other branches were converted
601
with exactly the same encoding. Any encoding recognized by Python may
602
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
605
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
606
takes_options = ['verbose', Option('max-count', type=int),
607
Option('encoding', type=str,
608
help='Force encoding to specified value. See WARNING.')]
610
def run(self, to_location, from_branch=None, fast=False, max_count=None,
611
encoding=None, verbose=False, dry_run=False,
612
reuse_history_list=[]):
613
from errors import NoPyBaz
616
baz_import.baz_import_branch(to_location, from_branch, fast,
617
max_count, verbose, encoding, dry_run,
620
print "This command is disabled. Please install PyBaz."
623
class cmd_rspush(bzrlib.commands.Command):
543
colordiff(check_style, *args, **kwargs)
546
class cmd_rspush(BzrToolsCommand):
624
547
"""Upload this branch to another location using rsync.
626
If no location is specified, the last-used location will be used. To
627
prevent dirty trees from being uploaded, rspush will error out if there are
628
unknown files or local changes. It will also error out if the upstream
629
directory is non-empty and not an earlier version of the branch.
549
If no location is specified, the last-used location will be used. To
550
prevent dirty trees from being uploaded, rspush will error out if there are
551
unknown files or local changes. It will also error out if the upstream
552
directory is non-empty and not an earlier version of the branch.
631
554
takes_args = ['location?']
632
555
takes_options = [Option('overwrite', help='Ignore differences between'
633
' branches and overwrite unconditionally'),
556
' branches and overwrite unconditionally.'),
634
557
Option('no-tree', help='Do not push the working tree,'
635
558
' just the .bzr.')]
638
561
from bzrlib import workingtree
640
563
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
641
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
564
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
642
565
working_tree=not no_tree)
645
class cmd_switch(bzrlib.commands.Command):
646
"""Set the branch of a lightweight checkout and update."""
648
takes_args = ['to_location']
650
def run(self, to_location):
651
from switch import cmd_switch
652
cmd_switch().run(to_location)
657
cmd_baz_import_branch,
679
if hasattr(bzrlib.commands, 'register_command'):
680
for command in commands:
681
bzrlib.commands.register_command(command)
685
from bzrlib.tests.TestUtil import TestLoader
687
from doctest import DocTestSuite, ELLIPSIS
688
from unittest import TestSuite
690
import tests.clean_tree
691
import upstream_import
693
import tests.blackbox
694
import tests.shelf_tests
696
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
697
result.addTest(tests.clean_tree.test_suite())
700
result.addTest(DocTestSuite(baz_import))
703
result.addTest(tests.test_suite())
704
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
705
result.addTest(tests.blackbox.test_suite())
706
result.addTest(upstream_import.test_suite())
707
result.addTest(zap.test_suite())
568
class cmd_link_tree(BzrToolsCommand):
569
"""Hardlink matching files to another tree.
571
Only files with identical content and execute bit will be linked.
573
takes_args = ['location']
575
def run(self, location):
576
from bzrlib import workingtree
577
from bzrlib.plugins.bzrtools.link_tree import link_tree
578
target_tree = workingtree.WorkingTree.open_containing(".")[0]
579
source_tree = workingtree.WorkingTree.open(location)
580
target_tree.lock_write()
582
source_tree.lock_read()
584
link_tree(target_tree, source_tree)
added
removed
command_classes.py
