1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical Limited.
3
# Copyright (C) 2006 Michael Ellerman.
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
Various useful plugins for working with bzr.
26
__version__ = '0.19.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 or (bzrlib_version == desired_plus and
43
bzrlib.version_info[3] == 'dev'):
46
from bzrlib.trace import warning
48
# get the message out any way we can
49
from warnings import warn as warning
50
if bzrlib_version < desired:
51
warning('Installed Bazaar version %s is too old to be used with'
53
'"Bzrtools" %s.' % (bzrlib.__version__, __version__))
54
# Not using BzrNewError, because it may not exist.
55
raise Exception, ('Version mismatch', version_info)
57
warning('Plugin "Bzrtools" is not up to date with installed Bazaar'
59
' There should be a newer version of Bzrtools available, e.g.'
61
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
62
if bzrlib_version != desired_plus:
63
raise Exception, 'Version mismatch'
66
check_bzrlib_version(version_info[:2])
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
70
from bzrlib import help
74
from errors import CommandError, NoPyBaz
75
from patchsource import BzrPatchSource
79
import bzrlib.builtins
80
import bzrlib.commands
81
from bzrlib.commands import get_cmd_object
82
from bzrlib.errors import BzrCommandError
84
from bzrlib.option import Option
85
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
90
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
93
class cmd_clean_tree(bzrlib.commands.Command):
94
"""Remove unwanted files from working tree.
96
By default, only unknown files, not ignored files, are deleted. Versioned
97
files are never deleted.
99
Another class is 'detritus', which includes files emitted by bzr during
100
normal operations and selftests. (The value of these files decreases with
103
If no options are specified, unknown files are deleted. Otherwise, option
104
flags are respected, and may be combined.
106
To check what clean-tree will do, use --dry-run.
108
takes_options = [Option('ignored', help='Delete all ignored files.'),
109
Option('detritus', help='Delete conflict files, merge'
110
' backups, and failed selftest dirs.'),
112
help='Delete files unknown to bzr (default).'),
113
Option('dry-run', help='Show files to delete instead of'
115
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
116
from clean_tree import clean_tree
117
if not (unknown or ignored or detritus):
119
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
123
class cmd_graph_ancestry(bzrlib.commands.Command):
124
"""Produce ancestry graphs using dot.
126
Output format is detected according to file extension. Some of the more
127
common output formats are html, png, gif, svg, ps. An extension of '.dot'
128
will cause a dot graph file to be produced. HTML output has mouseovers
129
that show the commit message.
131
Branches are labeled r?, where ? is the revno. If they have no revno,
132
with the last 5 characters of their revision identifier are used instead.
134
The value starting with d is "(maximum) distance from the null revision".
136
If --merge-branch is specified, the two branches are compared and a merge
140
white normal revision
143
orange COMMON history
144
blue COMMON non-history ancestor
145
green Merge base (COMMON ancestor farthest from the null revision)
146
dotted Ghost revision (missing from branch storage)
148
Ancestry is usually collapsed by skipping revisions with a single parent
149
and descendant. The number of skipped revisions is shown on the arrow.
150
This feature can be disabled with --no-collapse.
152
By default, revisions are ordered by distance from root, but they can be
153
clustered instead using --cluster.
155
If available, rsvg is used to antialias PNG and JPEG output, but this can
156
be disabled with --no-antialias.
158
takes_args = ['file', 'merge_branch?']
159
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
160
Option('no-antialias',
161
help="Do not use rsvg to produce antialiased output."),
162
Option('merge-branch', type=str,
163
help="Use this branch to calcuate a merge base."),
164
Option('cluster', help="Use clustered output."),
165
Option('max-distance',
166
help="Show no nodes farther than this.", type=int),
168
help='Source branch to use (default is current'
173
def run(self, file, merge_branch=None, no_collapse=False,
174
no_antialias=False, cluster=False, max_distance=100,
176
if max_distance == -1:
183
graph.write_ancestry_file(directory, file, not no_collapse,
184
not no_antialias, merge_branch, ranking,
185
max_distance=max_distance)
188
class cmd_fetch_ghosts(bzrlib.commands.Command):
189
"""Attempt to retrieve ghosts from another branch.
190
If the other branch is not supplied, the last-pulled branch is used.
192
aliases = ['fetch-missing']
193
takes_args = ['branch?']
194
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
195
def run(self, branch=None, no_fix=False):
196
from fetch_ghosts import fetch_ghosts
197
fetch_ghosts(branch, no_fix)
199
strip_help="""Strip the smallest prefix containing num leading slashes from \
200
each file name found in the patch file."""
203
class cmd_patch(bzrlib.commands.Command):
204
"""Apply a named patch to the current tree.
206
takes_args = ['filename?']
207
takes_options = [Option('strip', type=int, help=strip_help),
208
Option('silent', help='Suppress chatter.')]
209
def run(self, filename=None, strip=None, silent=False):
210
from patch import patch
211
from bzrlib.workingtree import WorkingTree
212
wt = WorkingTree.open_containing('.')[0]
215
return patch(wt, filename, strip, silent)
218
class cmd_shelve(bzrlib.commands.Command):
219
"""Temporarily set aside some changes from the current tree.
221
Shelve allows you to temporarily put changes you've made "on the shelf",
222
ie. out of the way, until a later time when you can bring them back from
223
the shelf with the 'unshelve' command.
225
Shelve is intended to help separate several sets of text changes that have
226
been inappropriately mingled. If you just want to get rid of all changes
227
(text and otherwise) and you don't need to restore them later, use revert.
228
If you want to shelve all text changes at once, use shelve --all.
230
By default shelve asks you what you want to shelve, press '?' at the
231
prompt to get help. To shelve everything run shelve --all.
233
If filenames are specified, only the changes to those files will be
234
shelved, other files will be left untouched.
236
If a revision is specified, changes since that revision will be shelved.
238
You can put multiple items on the shelf. Normally each time you run
239
unshelve the most recently shelved changes will be reinstated. However,
240
you can also unshelve changes in a different order by explicitly
241
specifiying which changes to unshelve. This works best when the changes
242
don't depend on each other.
244
While you have patches on the shelf you can view and manipulate them with
245
the 'shelf' command. Run 'bzr shelf -h' for more info.
248
takes_args = ['file*']
249
takes_options = [Option('message',
250
help='A message to associate with the shelved changes.',
253
Option('all', help='Shelve all changes without prompting.'),
254
Option('no-color', help='Never display changes in color.')]
256
def run(self, all=False, file_list=None, message=None, revision=None,
258
if revision is not None and revision:
259
if len(revision) == 1:
260
revision = revision[0]
262
raise CommandError("shelve only accepts a single revision "
265
source = BzrPatchSource(revision, file_list)
266
s = shelf.Shelf(source.base)
267
s.shelve(source, all, message, no_color)
271
# The following classes are only used as subcommands for 'shelf', they're
272
# not to be registered directly with bzr.
274
class cmd_shelf_list(bzrlib.commands.Command):
275
"""List the patches on the current shelf."""
276
aliases = ['list', 'ls']
281
class cmd_shelf_delete(bzrlib.commands.Command):
282
"""Delete the patch from the current shelf."""
283
aliases = ['delete', 'del']
284
takes_args = ['patch']
285
def run(self, patch):
286
self.shelf.delete(patch)
289
class cmd_shelf_switch(bzrlib.commands.Command):
290
"""Switch to the other shelf, create it if necessary."""
292
takes_args = ['othershelf']
293
def run(self, othershelf):
294
s = shelf.Shelf(self.shelf.base, othershelf)
298
class cmd_shelf_show(bzrlib.commands.Command):
299
"""Show the contents of the specified or topmost patch."""
300
aliases = ['show', 'cat', 'display']
301
takes_args = ['patch?']
302
def run(self, patch=None):
303
self.shelf.display(patch)
306
class cmd_shelf_upgrade(bzrlib.commands.Command):
307
"""Upgrade old format shelves."""
308
aliases = ['upgrade']
313
class cmd_shelf(bzrlib.commands.Command):
314
"""Perform various operations on your shelved patches. See also shelve."""
315
takes_args = ['subcommand', 'args*']
317
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
318
cmd_shelf_show, cmd_shelf_upgrade]
320
def run(self, subcommand, args_list):
323
if args_list is None:
325
cmd = self._get_cmd_object(subcommand)
326
source = BzrPatchSource()
327
s = shelf.Shelf(source.base)
330
if args_list is None:
332
return cmd.run_argv_aliases(args_list)
334
def _get_cmd_object(self, cmd_name):
335
for cmd_class in self.subcommands:
336
for alias in cmd_class.aliases:
337
if alias == cmd_name:
339
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
342
text = ["%s\n\nSubcommands:\n" % self.__doc__]
344
for cmd_class in self.subcommands:
345
text.extend(self.sub_help(cmd_class) + ['\n'])
349
def sub_help(self, cmd_class):
351
cmd_obj = cmd_class()
354
usage = cmd_obj._usage()
355
usage = usage.replace('bzr shelf-', '')
356
text.append('%s%s\n' % (indent, usage))
358
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
360
# Somewhat copied from bzrlib.help.help_on_command_options
362
for option_name, option in sorted(cmd_obj.options().items()):
363
if option_name == 'help':
365
option_help.append('%s--%s' % (3 * indent, option_name))
366
if option.type is not None:
367
option_help.append(' %s' % option.argname.upper())
368
if option.short_name():
369
option_help.append(', -%s' % option.short_name())
370
option_help.append('%s%s\n' % (2 * indent, option.help))
372
if len(option_help) > 0:
373
text.append('%soptions:\n' % (2 * indent))
374
text.extend(option_help)
379
class cmd_unshelve(bzrlib.commands.Command):
380
"""Restore shelved changes.
382
By default the most recently shelved changes are restored. However if you
383
specify a patch by name those changes will be restored instead.
385
See 'shelve' for more information.
388
Option('all', help='Unshelve all changes without prompting.'),
389
Option('force', help='Force unshelving even if errors occur.'),
390
Option('no-color', help='Never display changes in color.')
392
takes_args = ['patch?']
393
def run(self, patch=None, all=False, force=False, no_color=False):
394
source = BzrPatchSource()
395
s = shelf.Shelf(source.base)
396
s.unshelve(source, patch, all, force, no_color)
400
class cmd_shell(bzrlib.commands.Command):
401
"""Begin an interactive shell tailored for bzr.
402
Bzr commands can be used without typing bzr first, and will be run natively
403
when possible. Tab completion is tailored for bzr. The shell prompt shows
404
the branch nick, revno, and path.
406
If it encounters any moderately complicated shell command, it will punt to
411
bzr bzrtools:287/> status
414
bzr bzrtools:287/> status --[TAB][TAB]
415
--all --help --revision --show-ids
416
bzr bzrtools:287/> status --
420
return shell.run_shell()
423
class cmd_branch_history(bzrlib.commands.Command):
425
Display the development history of a branch.
427
Each different committer or branch nick is considered a different line of
428
development. Committers are treated as the same if they have the same
429
name, or if they have the same email address.
431
takes_args = ["branch?"]
432
def run(self, branch=None):
433
from branchhistory import branch_history
434
return branch_history(branch)
437
class cmd_zap(bzrlib.commands.Command):
439
Remove a lightweight checkout, if it can be done safely.
441
This command will remove a lightweight checkout without losing data. That
442
means it only removes lightweight checkouts, and only if they have no
445
If --branch is specified, the branch will be deleted too, but only if the
446
the branch has no new commits (relative to its parent).
448
takes_options = [Option("branch", help="Remove associated branch from"
450
takes_args = ["checkout"]
451
def run(self, checkout, branch=False):
453
return zap(checkout, remove_branch=branch)
456
class cmd_cbranch(bzrlib.commands.Command):
458
Create a new checkout, associated with a new repository branch.
460
When you cbranch, bzr looks up a target location in locations.conf, and
461
creates the branch there.
463
In your locations.conf, add the following lines:
464
[/working_directory_root]
465
cbranch_target = /branch_root
466
cbranch_target:policy = appendpath
468
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
469
working directory root, the branch will be created in
470
"/branch_root/foo/baz"
472
NOTE: cbranch also supports "cbranch_root", but that behaviour is
475
takes_options = [Option("lightweight",
476
help="Create a lightweight checkout."), 'revision']
477
takes_args = ["source", "target?"]
478
def run(self, source, target=None, lightweight=False, revision=None):
479
from cbranch import cbranch
480
return cbranch(source, target, lightweight=lightweight,
484
class cmd_branches(bzrlib.commands.Command):
485
"""Scan a location for branches"""
486
takes_args = ["location?"]
487
def run(self, location=None):
488
from branches import branches
489
return branches(location)
492
class cmd_multi_pull(bzrlib.commands.Command):
493
"""Pull all the branches under a location, e.g. a repository.
495
Both branches present in the directory and the branches of checkouts are
498
takes_args = ["location?"]
499
def run(self, location=None):
500
from bzrlib.branch import Branch
501
from bzrlib.transport import get_transport
502
from bzrtools import iter_branch_tree
505
t = get_transport(location)
507
print "Can't list this type of location."
509
for branch, wt in iter_branch_tree(t):
514
parent = branch.get_parent()
521
if base.startswith(t.base):
522
relpath = base[len(t.base):].rstrip('/')
525
print "Pulling %s from %s" % (relpath, parent)
527
pullable.pull(Branch.open(parent))
532
class cmd_branch_mark(bzrlib.commands.Command):
534
Add, view or list branch markers <EXPERIMENTAL>
536
To add a mark, do 'bzr branch-mark MARK'.
537
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
539
To delete a mark, do 'bzr branch-mark --delete MARK'
541
These marks can be used to track a branch's status.
543
takes_args = ['mark?', 'branch?']
544
takes_options = [Option('delete', help='Delete this mark.')]
545
def run(self, mark=None, branch=None, delete=False):
546
from branch_mark import branch_mark
547
branch_mark(mark, branch, delete)
550
class cmd_import(bzrlib.commands.Command):
551
"""Import sources from a directory, tarball or zip file
553
This command will import a directory, tarball or zip file into a bzr
554
tree, replacing any versioned files already present. If a directory is
555
specified, it is used as the target. If the directory does not exist, or
556
is not versioned, it is created.
558
Tarballs may be gzip or bzip2 compressed. This is autodetected.
560
If the tarball or zip has a single root directory, that directory is
561
stripped when extracting the tarball. This is not done for directories.
564
takes_args = ['source', 'tree?']
565
def run(self, source, tree=None):
566
from upstream_import import do_import
567
do_import(source, tree)
570
class cmd_cdiff(bzrlib.commands.Command):
571
"""A color version of bzr's diff"""
572
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
574
def _takes_options(self):
575
options = list(get_cmd_object('diff').takes_options)
576
options.append(Option('check-style',
577
help='Warn if trailing whitespace or spurious changes have been'
581
takes_options = property(_takes_options)
583
def run(self, check_style=False, *args, **kwargs):
584
from colordiff import colordiff
585
colordiff(check_style, *args, **kwargs)
588
class cmd_baz_import(bzrlib.commands.Command):
589
"""Import an Arch or Baz archive into a bzr repository.
591
This command should be used on local archives (or mirrors) only. It is
592
quite slow on remote archives.
594
reuse_history allows you to specify any previous imports you
595
have done of different archives, which this archive has branches
596
tagged from. This will dramatically reduce the time to convert
597
the archive as it will not have to convert the history already
598
converted in that other branch.
600
If you specify prefixes, only branches whose names start with that prefix
601
will be imported. Skipped branches will be listed, so you can import any
602
branches you missed by accident. Here's an example of doing a partial
603
import from thelove@canonical.com:
604
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
606
WARNING: Encoding should not be specified unless necessary, because if you
607
specify an encoding, your converted branch will not interoperate with
608
independently-converted branches, unless the other branches were converted
609
with exactly the same encoding. Any encoding recognized by Python may
610
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
613
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
614
takes_options = ['verbose', Option('prefixes', type=str,
615
help="Prefixes of branches to import, colon-separated."),
616
Option('encoding', type=str,
617
help='Force encoding to specified value. See WARNING.')]
619
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
620
reuse_history_list=[], prefixes=None):
621
from errors import NoPyBaz
624
baz_import.baz_import(to_root_dir, from_archive, encoding,
625
verbose, reuse_history_list, prefixes)
627
print "This command is disabled. Please install PyBaz."
630
class cmd_baz_import_branch(bzrlib.commands.Command):
631
"""Import an Arch or Baz branch into a bzr branch.
633
WARNING: Encoding should not be specified unless necessary, because if you
634
specify an encoding, your converted branch will not interoperate with
635
independently-converted branches, unless the other branches were converted
636
with exactly the same encoding. Any encoding recognized by Python may
637
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
640
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
641
takes_options = ['verbose', Option('max-count', type=int),
642
Option('encoding', type=str,
643
help='Force encoding to specified value. See WARNING.')]
645
def run(self, to_location, from_branch=None, fast=False, max_count=None,
646
encoding=None, verbose=False, dry_run=False,
647
reuse_history_list=[]):
648
from errors import NoPyBaz
651
baz_import.baz_import_branch(to_location, from_branch, fast,
652
max_count, verbose, encoding, dry_run,
655
print "This command is disabled. Please install PyBaz."
658
class cmd_rspush(bzrlib.commands.Command):
659
"""Upload this branch to another location using rsync.
661
If no location is specified, the last-used location will be used. To
662
prevent dirty trees from being uploaded, rspush will error out if there are
663
unknown files or local changes. It will also error out if the upstream
664
directory is non-empty and not an earlier version of the branch.
666
takes_args = ['location?']
667
takes_options = [Option('overwrite', help='Ignore differences between'
668
' branches and overwrite unconditionally.'),
669
Option('no-tree', help='Do not push the working tree,'
672
def run(self, location=None, overwrite=False, no_tree=False):
673
from bzrlib import workingtree
675
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
676
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
677
working_tree=not no_tree)
680
class cmd_switch(bzrlib.commands.Command):
681
"""Set the branch of a lightweight checkout and update."""
683
takes_args = ['to_location']
685
def run(self, to_location):
686
from switch import cmd_switch
687
cmd_switch().run(to_location)
692
cmd_baz_import_branch,
714
if hasattr(bzrlib.commands, 'register_command'):
715
for command in commands:
716
bzrlib.commands.register_command(command)
720
from bzrlib.tests.TestUtil import TestLoader
722
from doctest import DocTestSuite, ELLIPSIS
723
from unittest import TestSuite
725
import tests.clean_tree
726
import tests.is_clean
727
import tests.upstream_import
729
import tests.blackbox
730
import tests.shelf_tests
732
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
733
result.addTest(tests.clean_tree.test_suite())
736
result.addTest(DocTestSuite(baz_import))
739
result.addTest(tests.test_suite())
740
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
741
result.addTest(tests.blackbox.test_suite())
742
result.addTest(tests.upstream_import.test_suite())
743
result.addTest(zap.test_suite())
744
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
added
removed
__init__.py
