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.17.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 Bazaar version %s is too old to be used with'
52
'"Bzrtools" %s.' % (bzrlib.__version__, __version__))
53
# Not using BzrNewError, because it may not exist.
54
raise Exception, ('Version mismatch', version_info)
56
warning('Plugin "Bzrtools" is not up to date with installed Bazaar'
58
' There should be a newer version of Bzrtools available, e.g.'
60
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
61
if bzrlib_version != desired_plus:
62
raise Exception, 'Version mismatch'
65
check_bzrlib_version(version_info[:2])
67
23
from bzrlib.lazy_import import lazy_import
68
24
lazy_import(globals(), """
69
from bzrlib import help
25
from bzrlib import help, urlutils
73
from errors import CommandError, NoPyBaz
29
from command import BzrToolsCommand
30
from errors import CommandError
74
31
from patchsource import BzrPatchSource
78
35
import bzrlib.builtins
79
36
import bzrlib.commands
37
from bzrlib.branch import Branch
38
from bzrlib.bzrdir import BzrDir
80
39
from bzrlib.commands import get_cmd_object
81
40
from bzrlib.errors import BzrCommandError
82
41
import bzrlib.ignores
83
from bzrlib.option import Option
84
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
89
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
92
class cmd_clean_tree(bzrlib.commands.Command):
93
"""Remove unwanted files from working tree.
95
By default, only unknown files, not ignored files, are deleted. Versioned
96
files are never deleted.
98
Another class is 'detritus', which includes files emitted by bzr during
99
normal operations and selftests. (The value of these files decreases with
102
If no options are specified, unknown files are deleted. Otherwise, option
103
flags are respected, and may be combined.
105
To check what clean-tree will do, use --dry-run.
107
takes_options = [Option('ignored', help='delete all ignored files.'),
108
Option('detritus', help='delete conflict files, merge'
109
' backups, and failed selftest dirs.'),
111
help='delete files unknown to bzr. (default)'),
112
Option('dry-run', help='show files to delete instead of'
114
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
115
from clean_tree import clean_tree
116
if not (unknown or ignored or detritus):
118
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
122
class cmd_graph_ancestry(bzrlib.commands.Command):
42
from bzrlib.trace import note
43
from bzrlib.option import Option, RegistryOption
44
from bzrlib.workingtree import WorkingTree
46
from command import BzrToolsCommand
49
class cmd_graph_ancestry(BzrToolsCommand):
123
50
"""Produce ancestry graphs using dot.
125
52
Output format is detected according to file extension. Some of the more
126
53
common output formats are html, png, gif, svg, ps. An extension of '.dot'
127
54
will cause a dot graph file to be produced. HTML output has mouseovers
154
81
If available, rsvg is used to antialias PNG and JPEG output, but this can
155
82
be disabled with --no-antialias.
157
takes_args = ['branch', 'file']
158
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
84
takes_args = ['file', 'merge_branch?']
85
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
159
86
Option('no-antialias',
160
help="Do not use rsvg to produce antialiased output"),
161
Option('merge-branch', type=str,
162
help="Use this branch to calcuate a merge base"),
87
help="Do not use rsvg to produce antialiased output."),
88
Option('merge-branch', type=str,
89
help="Use this branch to calcuate a merge base."),
163
90
Option('cluster', help="Use clustered output."),
164
Option('max-distance', help="Show no nodes farther than this",
166
def run(self, branch, file, no_collapse=False, no_antialias=False,
167
merge_branch=None, cluster=False, max_distance=None):
91
Option('max-distance',
92
help="Show no nodes farther than this.", type=int),
94
help='Source branch to use (default is current'
99
def run(self, file, merge_branch=None, no_collapse=False,
100
no_antialias=False, cluster=False, max_distance=100,
102
if max_distance == -1:
170
106
ranking = "cluster"
172
108
ranking = "forced"
173
graph.write_ancestry_file(branch, file, not no_collapse,
174
not no_antialias, merge_branch, ranking,
109
graph.write_ancestry_file(directory, file, not no_collapse,
110
not no_antialias, merge_branch, ranking,
175
111
max_distance=max_distance)
178
class cmd_fetch_ghosts(bzrlib.commands.Command):
114
class cmd_fetch_ghosts(BzrToolsCommand):
179
115
"""Attempt to retrieve ghosts from another branch.
180
116
If the other branch is not supplied, the last-pulled branch is used.
182
118
aliases = ['fetch-missing']
183
119
takes_args = ['branch?']
184
takes_options = [Option('no-fix')]
120
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
185
121
def run(self, branch=None, no_fix=False):
186
122
from fetch_ghosts import fetch_ghosts
187
fetch_ghosts(branch, no_fix)
123
fetch_ghosts(branch, do_reconcile=not no_fix)
189
125
strip_help="""Strip the smallest prefix containing num leading slashes from \
190
126
each file name found in the patch file."""
193
class cmd_patch(bzrlib.commands.Command):
129
class cmd_patch(BzrToolsCommand):
194
130
"""Apply a named patch to the current tree.
196
132
takes_args = ['filename?']
197
takes_options = [Option('strip', type=int, help=strip_help),
198
Option('silent', help='Suppress chatter')]
133
takes_options = [Option('strip', type=int, short_name='p',
135
Option('silent', help='Suppress chatter.')]
199
136
def run(self, filename=None, strip=None, silent=False):
200
137
from patch import patch
201
138
from bzrlib.workingtree import WorkingTree
226
163
If a revision is specified, changes since that revision will be shelved.
228
165
You can put multiple items on the shelf. Normally each time you run
229
unshelve the most recently shelved changes will be reinstated. However,
166
unshelve1 the most recently shelved changes will be reinstated. However,
230
167
you can also unshelve changes in a different order by explicitly
231
specifiying which changes to unshelve. This works best when the changes
168
specifiying which changes to unshelve1. This works best when the changes
232
169
don't depend on each other.
234
171
While you have patches on the shelf you can view and manipulate them with
235
the 'shelf' command. Run 'bzr shelf -h' for more info.
172
the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
238
175
takes_args = ['file*']
239
takes_options = ['message', 'revision',
240
Option('all', help='Shelve all changes without prompting'),
241
Option('no-color', help='Never display changes in color')]
176
takes_options = [Option('message',
177
help='A message to associate with the shelved changes.',
178
short_name='m', type=unicode),
180
Option('all', help='Shelve all changes without prompting.'),
181
Option('no-color', help='Never display changes in color.')]
243
183
def run(self, all=False, file_list=None, message=None, revision=None,
432
380
If --branch is specified, the branch will be deleted too, but only if the
433
381
the branch has no new commits (relative to its parent).
383
If bzr-pipeline is also installed, the --store option will store changes
384
in the branch before deleting the tree. To restore the changes, do::
386
bzr checkout --lightweight $BRANCH $CHECKOUT
387
bzr switch-pipe -d $CHECKOUT `bzr nick -d $CHECKOUT`
435
takes_options = [Option("branch", help="Remove associtated branch from"
389
takes_options = [Option("branch", help="Remove associated branch from"
391
RegistryOption('change_policy',
392
'How to handle changed files',
394
('bzrlib.plugins.bzrtools.zap',
395
'change_policy_registry'),
437
398
takes_args = ["checkout"]
438
def run(self, checkout, branch=False):
440
return zap(checkout, remove_branch=branch)
443
class cmd_cbranch(bzrlib.commands.Command):
399
def run(self, checkout, branch=False, change_policy=None):
401
change_policy_registry,
405
if change_policy is None:
406
change_policy = change_policy_registry.get()
407
if change_policy is StoreChanges:
409
import bzrlib.plugins.pipeline
411
raise BzrCommandError('--store requires bzr-pipeline.')
412
return zap(checkout, remove_branch=branch, policy=change_policy)
415
class cmd_cbranch(BzrToolsCommand):
445
417
Create a new checkout, associated with a new repository branch.
447
419
When you cbranch, bzr looks up a target location in locations.conf, and
448
420
creates the branch there.
453
425
cbranch_target:policy = appendpath
455
427
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
456
working directory root, the branch will be created in
428
working directory root, the branch will be created in
457
429
"/branch_root/foo/baz"
459
431
NOTE: cbranch also supports "cbranch_root", but that behaviour is
462
takes_options = [Option("lightweight",
463
help="Create a lightweight checkout"), 'revision']
434
takes_options = [Option("lightweight",
435
help="Create a lightweight checkout."), 'revision',
436
Option('files-from', type=unicode,
437
help='Accelerate checkout using files from this'
440
help='Hard-link files from source/files-from tree'
464
442
takes_args = ["source", "target?"]
465
def run(self, source, target=None, lightweight=False, revision=None):
443
def run(self, source, target=None, lightweight=False, revision=None,
444
files_from=None, hardlink=False):
466
445
from cbranch import cbranch
467
return cbranch(source, target, lightweight=lightweight,
471
class cmd_branches(bzrlib.commands.Command):
446
return cbranch(source, target, lightweight=lightweight,
447
revision=revision, files_from=files_from,
451
class cmd_branches(BzrToolsCommand):
472
452
"""Scan a location for branches"""
473
453
takes_args = ["location?"]
474
454
def run(self, location=None):
475
455
from branches import branches
476
456
return branches(location)
458
class cmd_trees(BzrToolsCommand):
459
"""Scan a location for trees"""
460
takes_args = ['location?']
461
def run(self, location='.'):
462
from bzrlib.workingtree import WorkingTree
463
from bzrlib.transport import get_transport
464
t = get_transport(location)
465
for tree in WorkingTree.find_trees(location):
466
self.outf.write('%s\n' % t.relpath(
467
tree.bzrdir.root_transport.base))
479
class cmd_multi_pull(bzrlib.commands.Command):
469
class cmd_multi_pull(BzrToolsCommand):
480
470
"""Pull all the branches under a location, e.g. a repository.
482
472
Both branches present in the directory and the branches of checkouts are
485
475
takes_args = ["location?"]
486
476
def run(self, location=None):
487
from bzrlib.branch import Branch
488
477
from bzrlib.transport import get_transport
489
478
from bzrtools import iter_branch_tree
490
479
if location is None:
492
481
t = get_transport(location)
482
possible_transports = []
493
483
if not t.listable():
494
484
print "Can't list this type of location."
512
502
print "Pulling %s from %s" % (relpath, parent)
514
pullable.pull(Branch.open(parent))
504
branch_t = get_transport(parent, possible_transports)
505
pullable.pull(Branch.open_from_transport(branch_t))
515
506
except Exception, e:
519
class cmd_branch_mark(bzrlib.commands.Command):
521
Add, view or list branch markers <EXPERIMENTAL>
523
To add a mark, do 'bzr branch-mark MARK'.
524
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
526
To delete a mark, do 'bzr branch-mark --delete MARK'
528
These marks can be used to track a branch's status.
530
takes_args = ['mark?', 'branch?']
531
takes_options = [Option('delete', help='Delete this mark')]
532
def run(self, mark=None, branch=None, delete=False):
533
from branch_mark import branch_mark
534
branch_mark(mark, branch, delete)
537
class cmd_import(bzrlib.commands.Command):
511
class cmd_import(BzrToolsCommand):
538
512
"""Import sources from a directory, tarball or zip file
540
514
This command will import a directory, tarball or zip file into a bzr
541
515
tree, replacing any versioned files already present. If a directory is
542
516
specified, it is used as the target. If the directory does not exist, or
547
521
If the tarball or zip has a single root directory, that directory is
548
522
stripped when extracting the tarball. This is not done for directories.
551
525
takes_args = ['source', 'tree?']
552
526
def run(self, source, tree=None):
553
527
from upstream_import import do_import
554
528
do_import(source, tree)
557
class cmd_cdiff(bzrlib.commands.Command):
531
class cmd_cdiff(BzrToolsCommand):
558
532
"""A color version of bzr's diff"""
559
533
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
561
def _takes_options(self):
562
options = list(get_cmd_object('diff').takes_options)
563
options.append(Option('check-style',
534
takes_options = list(get_cmd_object('diff').takes_options) + [
535
RegistryOption.from_kwargs('color',
536
'Color mode to use.',
537
title='Color Mode', value_switches=False, enum_switch=True,
538
never='Never colorize output.',
539
auto='Only colorize output if terminal supports it and STDOUT is a'
541
always='Always colorize output (default).'),
542
Option('check-style',
564
543
help='Warn if trailing whitespace or spurious changes have been'
568
takes_options = property(_takes_options)
570
def run(self, check_style=False, *args, **kwargs):
546
def run(self, color='always', check_style=False, *args, **kwargs):
571
547
from colordiff import colordiff
572
colordiff(check_style, *args, **kwargs)
575
class cmd_baz_import(bzrlib.commands.Command):
576
"""Import an Arch or Baz archive into a bzr repository.
578
This command should be used on local archives (or mirrors) only. It is
579
quite slow on remote archives.
581
reuse_history allows you to specify any previous imports you
582
have done of different archives, which this archive has branches
583
tagged from. This will dramatically reduce the time to convert
584
the archive as it will not have to convert the history already
585
converted in that other branch.
587
If you specify prefixes, only branches whose names start with that prefix
588
will be imported. Skipped branches will be listed, so you can import any
589
branches you missed by accident. Here's an example of doing a partial
590
import from thelove@canonical.com:
591
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
593
WARNING: Encoding should not be specified unless necessary, because if you
594
specify an encoding, your converted branch will not interoperate with
595
independently-converted branches, unless the other branches were converted
596
with exactly the same encoding. Any encoding recognized by Python may
597
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
600
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
601
takes_options = ['verbose', Option('prefixes', type=str,
602
help="Prefixes of branches to import, colon-separated"),
603
Option('encoding', type=str,
604
help='Force encoding to specified value. See WARNING.')]
606
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
607
reuse_history_list=[], prefixes=None):
608
from errors import NoPyBaz
611
baz_import.baz_import(to_root_dir, from_archive, encoding,
612
verbose, reuse_history_list, prefixes)
614
print "This command is disabled. Please install PyBaz."
617
class cmd_baz_import_branch(bzrlib.commands.Command):
618
"""Import an Arch or Baz branch into a bzr branch.
620
WARNING: Encoding should not be specified unless necessary, because if you
621
specify an encoding, your converted branch will not interoperate with
622
independently-converted branches, unless the other branches were converted
623
with exactly the same encoding. Any encoding recognized by Python may
624
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
627
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
628
takes_options = ['verbose', Option('max-count', type=int),
629
Option('encoding', type=str,
630
help='Force encoding to specified value. See WARNING.')]
632
def run(self, to_location, from_branch=None, fast=False, max_count=None,
633
encoding=None, verbose=False, dry_run=False,
634
reuse_history_list=[]):
635
from errors import NoPyBaz
638
baz_import.baz_import_branch(to_location, from_branch, fast,
639
max_count, verbose, encoding, dry_run,
642
print "This command is disabled. Please install PyBaz."
645
class cmd_rspush(bzrlib.commands.Command):
548
colordiff(color, check_style, *args, **kwargs)
551
class cmd_conflict_diff(BzrToolsCommand):
553
"""Compare a conflicted file against BASE."""
555
encoding_type = 'exact'
556
takes_args = ['file*']
558
RegistryOption.from_kwargs('direction', 'Direction of comparison.',
559
value_switches=True, enum_switch=False,
560
other='Compare OTHER against common base.',
561
this='Compare THIS against common base.')]
563
def run(self, file_list, direction='other'):
564
from bzrlib.plugins.bzrtools.colordiff import DiffWriter
565
from conflict_diff import ConflictDiffer
566
dw = DiffWriter(self.outf, check_style=False, color='auto')
567
ConflictDiffer().run(dw, file_list, direction)
570
class cmd_rspush(BzrToolsCommand):
646
571
"""Upload this branch to another location using rsync.
648
If no location is specified, the last-used location will be used. To
649
prevent dirty trees from being uploaded, rspush will error out if there are
650
unknown files or local changes. It will also error out if the upstream
651
directory is non-empty and not an earlier version of the branch.
573
If no location is specified, the last-used location will be used. To
574
prevent dirty trees from being uploaded, rspush will error out if there are
575
unknown files or local changes. It will also error out if the upstream
576
directory is non-empty and not an earlier version of the branch.
653
578
takes_args = ['location?']
654
579
takes_options = [Option('overwrite', help='Ignore differences between'
655
' branches and overwrite unconditionally'),
580
' branches and overwrite unconditionally.'),
656
581
Option('no-tree', help='Do not push the working tree,'
657
582
' just the .bzr.')]
660
585
from bzrlib import workingtree
662
587
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
663
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
588
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
664
589
working_tree=not no_tree)
667
class cmd_switch(bzrlib.commands.Command):
668
"""Set the branch of a lightweight checkout and update."""
670
takes_args = ['to_location']
672
def run(self, to_location):
673
from switch import cmd_switch
674
cmd_switch().run(to_location)
679
cmd_baz_import_branch,
701
if hasattr(bzrlib.commands, 'register_command'):
702
for command in commands:
703
bzrlib.commands.register_command(command)
707
from bzrlib.tests.TestUtil import TestLoader
709
from doctest import DocTestSuite, ELLIPSIS
710
from unittest import TestSuite
712
import tests.clean_tree
713
import tests.is_clean
714
import tests.upstream_import
716
import tests.blackbox
717
import tests.shelf_tests
719
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
720
result.addTest(tests.clean_tree.test_suite())
723
result.addTest(DocTestSuite(baz_import))
726
result.addTest(tests.test_suite())
727
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
728
result.addTest(tests.blackbox.test_suite())
729
result.addTest(tests.upstream_import.test_suite())
730
result.addTest(zap.test_suite())
731
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
592
class cmd_link_tree(BzrToolsCommand):
593
"""Hardlink matching files to another tree.
595
Only files with identical content and execute bit will be linked.
597
takes_args = ['location']
599
def run(self, location):
600
from bzrlib import workingtree
601
from bzrlib.plugins.bzrtools.link_tree import link_tree
602
target_tree = workingtree.WorkingTree.open_containing(".")[0]
603
source_tree = workingtree.WorkingTree.open(location)
604
target_tree.lock_write()
606
source_tree.lock_read()
608
link_tree(target_tree, source_tree)
615
class cmd_create_mirror(BzrToolsCommand):
616
"""Create a mirror of another branch.
618
This is similar to `bzr branch`, but copies more settings, including the
619
submit branch and nickname.
621
It sets the public branch and parent of the target to the source location.
624
takes_args = ['source', 'target']
626
def run(self, source, target):
627
source_branch = Branch.open(source)
628
from bzrlib.plugins.bzrtools.mirror import create_mirror
629
create_mirror(source_branch, target, [])