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
3
Various useful plugins for working with bzr.
26
__version__ = '0.16.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
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
69
from bzrlib import help
73
from errors import CommandError, NoPyBaz
7
from errors import CommandError
74
8
from patchsource import BzrPatchSource
9
from shelf import Shelf
78
import bzrlib.builtins
79
import bzrlib.commands
80
from bzrlib.commands import get_cmd_object
12
from bzrlib.option import Option
81
14
from bzrlib.errors import BzrCommandError
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'])
15
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
17
from bzrlib import DEFAULT_IGNORE
20
DEFAULT_IGNORE.append('./.shelf')
21
DEFAULT_IGNORE.append('./.bzr-shelf*')
24
Option.OPTIONS['ignored'] = Option('ignored',
25
help='delete all ignored files.')
26
Option.OPTIONS['detritus'] = Option('detritus',
27
help='delete conflict files merge backups, and failed selftest dirs.' +
28
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
29
Option.OPTIONS['dry-run'] = Option('dry-run',
30
help='show files to delete instead of deleting them.')
92
32
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.
33
"""Remove unwanted files from working tree. <BZRTOOLS>
34
Normally, ignored files are left alone.
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):
36
takes_options = ['ignored', 'detritus', 'dry-run']
37
def run(self, ignored=False, detritus=False, dry_run=False):
115
38
from clean_tree import clean_tree
116
if not (unknown or ignored or detritus):
118
clean_tree('.', out=self.outf, unknown=unknown, ignored=ignored,
119
detritus=detritus, dry_run=dry_run)
39
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
41
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
122
43
class cmd_graph_ancestry(bzrlib.commands.Command):
123
"""Produce ancestry graphs using dot.
44
"""Produce ancestry graphs using dot. <BZRTOOLS>
125
46
Output format is detected according to file extension. Some of the more
126
47
common output formats are html, png, gif, svg, ps. An extension of '.dot'
127
48
will cause a dot graph file to be produced. HTML output has mouseovers
155
76
be disabled with --no-antialias.
157
78
takes_args = ['branch', 'file']
158
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
79
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
159
80
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"),
163
Option('cluster', help="Use clustered output."),
164
Option('max-distance', help="Show no nodes farther than this",
81
help="Do not use rsvg to produce antialiased output"),
82
Option('merge-branch', type=str,
83
help="Use this branch to calcuate a merge base"),
84
Option('cluster', help="Use clustered output.")]
166
85
def run(self, branch, file, no_collapse=False, no_antialias=False,
167
merge_branch=None, cluster=False, max_distance=None):
86
merge_branch=None, cluster=False):
170
89
ranking = "cluster"
172
91
ranking = "forced"
173
graph.write_ancestry_file(branch, file, not no_collapse,
174
not no_antialias, merge_branch, ranking,
175
max_distance=max_distance)
92
graph.write_ancestry_file(branch, file, not no_collapse,
93
not no_antialias, merge_branch, ranking)
178
95
class cmd_fetch_ghosts(bzrlib.commands.Command):
179
"""Attempt to retrieve ghosts from another branch.
96
"""Attempt to retrieve ghosts from another branch. <BZRTOOLS>
180
97
If the other branch is not supplied, the last-pulled branch is used.
182
99
aliases = ['fetch-missing']
252
162
source = BzrPatchSource(revision, file_list)
253
s = shelf.Shelf(source.base)
254
s.shelve(source, all, message, no_color)
163
s = Shelf(source.base)
164
s.shelve(source, all, message)
258
# The following classes are only used as subcommands for 'shelf', they're
259
# not to be registered directly with bzr.
261
class cmd_shelf_list(bzrlib.commands.Command):
262
"""List the patches on the current shelf."""
263
aliases = ['list', 'ls']
268
class cmd_shelf_delete(bzrlib.commands.Command):
269
"""Delete the patch from the current shelf."""
270
aliases = ['delete', 'del']
271
takes_args = ['patch']
272
def run(self, patch):
273
self.shelf.delete(patch)
276
class cmd_shelf_switch(bzrlib.commands.Command):
277
"""Switch to the other shelf, create it if necessary."""
279
takes_args = ['othershelf']
280
def run(self, othershelf):
281
s = shelf.Shelf(self.shelf.base, othershelf)
285
class cmd_shelf_show(bzrlib.commands.Command):
286
"""Show the contents of the specified or topmost patch."""
287
aliases = ['show', 'cat', 'display']
288
takes_args = ['patch?']
289
def run(self, patch=None):
290
self.shelf.display(patch)
293
class cmd_shelf_upgrade(bzrlib.commands.Command):
294
"""Upgrade old format shelves."""
295
aliases = ['upgrade']
300
167
class cmd_shelf(bzrlib.commands.Command):
301
"""Perform various operations on your shelved patches. See also shelve."""
168
"""Perform various operations on your shelved patches. See also shelve.
171
list (ls) List the patches on the current shelf.
172
delete (del) <patch> Delete a patch from the current shelf.
173
switch <shelf> Switch to the named shelf, create it if necessary.
174
show <patch> Show the contents of the specified patch.
175
upgrade Upgrade old format shelves.
302
177
takes_args = ['subcommand', 'args*']
304
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
305
cmd_shelf_show, cmd_shelf_upgrade]
307
179
def run(self, subcommand, args_list):
310
if args_list is None:
312
cmd = self._get_cmd_object(subcommand)
313
182
source = BzrPatchSource()
314
s = shelf.Shelf(source.base)
317
if args_list is None:
319
return cmd.run_argv_aliases(args_list)
321
def _get_cmd_object(self, cmd_name):
322
for cmd_class in self.subcommands:
323
for alias in cmd_class.aliases:
324
if alias == cmd_name:
326
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
329
text = ["%s\n\nSubcommands:\n" % self.__doc__]
331
for cmd_class in self.subcommands:
332
text.extend(self.sub_help(cmd_class) + ['\n'])
336
def sub_help(self, cmd_class):
338
cmd_obj = cmd_class()
341
usage = help.command_usage(cmd_obj)
342
usage = usage.replace('bzr shelf-', '')
343
text.append('%s%s\n' % (indent, usage))
345
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
347
# Somewhat copied from bzrlib.help.help_on_command_options
349
for option_name, option in sorted(cmd_obj.options().items()):
350
if option_name == 'help':
352
option_help.append('%s--%s' % (3 * indent, option_name))
353
if option.type is not None:
354
option_help.append(' %s' % option.argname.upper())
355
if option.short_name():
356
option_help.append(', -%s' % option.short_name())
357
option_help.append('%s%s\n' % (2 * indent, option.help))
359
if len(option_help) > 0:
360
text.append('%soptions:\n' % (2 * indent))
361
text.extend(option_help)
183
s = Shelf(source.base)
185
if subcommand == 'ls' or subcommand == 'list':
186
self.__check_no_args(args_list, "shelf list takes no arguments!")
188
elif subcommand == 'delete' or subcommand == 'del':
189
self.__check_one_arg(args_list, "shelf delete takes one argument!")
190
s.delete(args_list[0])
191
elif subcommand == 'switch':
192
self.__check_one_arg(args_list, "shelf switch takes one argument!")
193
s = Shelf(source.base, args_list[0])
195
elif subcommand == 'show':
196
self.__check_one_arg(args_list, "shelf show takes one argument!")
197
s.display(args_list[0])
198
elif subcommand == 'upgrade':
199
self.__check_no_args(args_list, "shelf upgrade takes no arguments!")
202
print subcommand, args_list
203
print >>sys.stderr, "Unknown shelf subcommand '%s'" % subcommand
205
def __check_one_arg(self, args, msg):
206
if args is None or len(args) != 1:
207
raise CommandError(msg)
209
def __check_no_args(self, args, msg):
211
raise CommandError(msg)
366
214
class cmd_unshelve(bzrlib.commands.Command):
367
"""Restore shelved changes.
369
By default the most recently shelved changes are restored. However if you
370
specify a patch by name those changes will be restored instead.
215
"""Restore the most recently shelved changes to current tree. <BZRTOOLS>
372
216
See 'shelve' for more information.
374
218
takes_options = [
375
219
Option('all', help='Unshelve all changes without prompting'),
376
220
Option('force', help='Force unshelving even if errors occur'),
377
Option('no-color', help='Never display changes in color')
379
takes_args = ['patch?']
380
def run(self, patch=None, all=False, force=False, no_color=False):
222
def run(self, all=False, force=False):
381
223
source = BzrPatchSource()
382
s = shelf.Shelf(source.base)
383
s.unshelve(source, patch, all, force, no_color)
224
s = Shelf(source.base)
225
s.unshelve(source, all, force)
387
229
class cmd_shell(bzrlib.commands.Command):
388
"""Begin an interactive shell tailored for bzr.
230
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
389
231
Bzr commands can be used without typing bzr first, and will be run natively
390
232
when possible. Tab completion is tailored for bzr. The shell prompt shows
391
233
the branch nick, revno, and path.
418
259
takes_args = ["branch?"]
419
260
def run(self, branch=None):
420
from branchhistory import branch_history
261
from branchhistory import branch_history
421
262
return branch_history(branch)
424
265
class cmd_zap(bzrlib.commands.Command):
426
Remove a lightweight checkout, if it can be done safely.
428
This command will remove a lightweight checkout without losing data. That
429
means it only removes lightweight checkouts, and only if they have no
432
If --branch is specified, the branch will be deleted too, but only if the
433
the branch has no new commits (relative to its parent).
267
Remove a checkout, if it can be done safely. <BZRTOOLS>
269
This command will remove a checkout without losing data. That means
270
it only removes checkouts, and only if they have no uncommitted changes.
435
takes_options = [Option("branch", help="Remove associtated branch from"
437
272
takes_args = ["checkout"]
438
def run(self, checkout, branch=False):
273
def run(self, checkout):
439
274
from zap import zap
440
return zap(checkout, remove_branch=branch)
443
278
class cmd_cbranch(bzrlib.commands.Command):
445
Create a new checkout, associated with a new repository branch.
447
When you cbranch, bzr looks up a target location in locations.conf, and
448
creates the branch there.
450
In your locations.conf, add the following lines:
451
[/working_directory_root]
452
cbranch_target = /branch_root
453
cbranch_target:policy = appendpath
455
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
457
"/branch_root/foo/baz"
459
NOTE: cbranch also supports "cbranch_root", but that behaviour is
280
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
282
When you cbranch, bzr looks up the repository associated with your current
283
directory in branches.conf. It creates a new branch in that repository
284
with the same name and relative path as the checkout you request.
286
The branches.conf parameter is "cbranch_root". So if you want
287
cbranch operations in /home/jrandom/bigproject to produce branches in
288
/home/jrandom/bigproject/repository, you'd add this:
290
[/home/jrandom/bigproject]
291
cbranch_root = /home/jrandom/bigproject/repository
293
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
294
standalone branches will be produced. Standalone branches will also
295
be produced if the source branch is in 0.7 format (or earlier).
462
takes_options = [Option("lightweight",
463
help="Create a lightweight checkout"), 'revision']
464
takes_args = ["source", "target?"]
465
def run(self, source, target=None, lightweight=False, revision=None):
297
takes_args = ["source", "target"]
298
def run(self, source, target):
466
299
from cbranch import cbranch
467
return cbranch(source, target, lightweight=lightweight,
300
return cbranch(source, target)
471
302
class cmd_branches(bzrlib.commands.Command):
472
"""Scan a location for branches"""
303
"""Scan a location for branches <BZRTOOLS>"""
473
304
takes_args = ["location?"]
474
305
def run(self, location=None):
475
306
from branches import branches
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):
538
"""Import sources from a directory, tarball or zip file
540
This command will import a directory, tarball or zip file into a bzr
541
tree, replacing any versioned files already present. If a directory is
542
specified, it is used as the target. If the directory does not exist, or
543
is not versioned, it is created.
545
Tarballs may be gzip or bzip2 compressed. This is autodetected.
547
If the tarball or zip has a single root directory, that directory is
548
stripped when extracting the tarball. This is not done for directories.
551
takes_args = ['source', 'tree?']
552
def run(self, source, tree=None):
553
from upstream_import import do_import
554
do_import(source, tree)
557
class cmd_cdiff(bzrlib.commands.Command):
558
"""A color version of bzr's diff"""
559
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',
564
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):
571
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):
646
"""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.
653
takes_args = ['location?']
654
takes_options = [Option('overwrite', help='Ignore differences between'
655
' branches and overwrite unconditionally'),
656
Option('no-tree', help='Do not push the working tree,'
659
def run(self, location=None, overwrite=False, no_tree=False):
660
from bzrlib import workingtree
662
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
663
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
664
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,
350
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
351
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
352
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
356
command_decorators = []
359
import bzrlib.builtins
360
if not hasattr(bzrlib.builtins, "cmd_push"):
361
commands.append(push.cmd_push)
363
command_decorators.append(push.cmd_push)
365
from errors import NoPyBaz
368
commands.append(baz_import.cmd_baz_import_branch)
369
commands.append(baz_import.cmd_baz_import)
372
class cmd_baz_import_branch(bzrlib.commands.Command):
373
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
374
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
375
takes_options = ['verbose', Option('max-count', type=int)]
376
def run(self, to_location=None, from_branch=None, fast=False,
377
max_count=None, verbose=False, dry_run=False,
378
reuse_history_list=[]):
379
print "This command is disabled. Please install PyBaz."
382
class cmd_baz_import(bzrlib.commands.Command):
383
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
384
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
385
takes_options = ['verbose', Option('prefixes', type=str,
386
help="Prefixes of branches to import")]
387
def run(self, to_root_dir=None, from_archive=None, verbose=False,
388
reuse_history_list=[], prefixes=None):
389
print "This command is disabled. Please install PyBaz."
390
commands.extend((cmd_baz_import_branch, cmd_baz_import))
701
393
if hasattr(bzrlib.commands, 'register_command'):
702
394
for command in commands:
703
395
bzrlib.commands.register_command(command)
396
for command in command_decorators:
397
command._original_command = bzrlib.commands.register_command(
706
401
def test_suite():
707
403
from bzrlib.tests.TestUtil import TestLoader
709
405
from doctest import DocTestSuite, ELLIPSIS
710
406
from unittest import TestSuite
712
import tests.clean_tree
713
import tests.is_clean
714
import tests.upstream_import
716
409
import tests.blackbox
717
410
import tests.shelf_tests
718
411
result = TestSuite()
719
412
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
720
result.addTest(tests.clean_tree.test_suite())
723
result.addTest(DocTestSuite(baz_import))
413
result.addTest(clean_tree.test_suite())
414
result.addTest(DocTestSuite(baz_import))
726
415
result.addTest(tests.test_suite())
727
416
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
728
417
result.addTest(tests.blackbox.test_suite())
729
result.addTest(tests.upstream_import.test_suite())
730
418
result.addTest(zap.test_suite())
731
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))