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.15.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 Bazzar 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])
68
from errors import CommandError, NoPyBaz
7
from errors import CommandError
69
8
from patchsource import BzrPatchSource
70
9
from shelf import Shelf
10
from switch import cmd_switch
74
import bzrlib.builtins
75
import bzrlib.commands
76
from bzrlib.commands import get_cmd_object
13
from bzrlib.option import Option
77
15
from bzrlib.errors import BzrCommandError
78
from bzrlib.help import command_usage
80
from bzrlib.option import Option
81
16
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
86
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
18
from bzrlib import DEFAULT_IGNORE
21
DEFAULT_IGNORE.append('./.shelf')
22
DEFAULT_IGNORE.append('./.bzr-shelf*')
25
Option.OPTIONS['ignored'] = Option('ignored',
26
help='delete all ignored files.')
27
Option.OPTIONS['detritus'] = Option('detritus',
28
help='delete conflict files merge backups, and failed selftest dirs.' +
29
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
30
Option.OPTIONS['dry-run'] = Option('dry-run',
31
help='show files to delete instead of deleting them.')
89
33
class cmd_clean_tree(bzrlib.commands.Command):
90
"""Remove unwanted files from working tree.
92
By default, only unknown files, not ignored files, are deleted. Versioned
93
files are never deleted.
95
Another class is 'detritus', which includes files emitted by bzr during
96
normal operations and selftests. (The value of these files decreases with
99
If no options are specified, unknown files are deleted. Otherwise, option
100
flags are respected, and may be combined.
102
To check what clean-tree will do, use --dry-run.
34
"""Remove unwanted files from working tree. <BZRTOOLS>
35
Normally, ignored files are left alone.
104
takes_options = [Option('ignored', help='delete all ignored files.'),
105
Option('detritus', help='delete conflict files, merge'
106
' backups, and failed selftest dirs.'),
108
help='delete files unknown to bzr. (default)'),
109
Option('dry-run', help='show files to delete instead of'
111
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
37
takes_options = ['ignored', 'detritus', 'dry-run']
38
def run(self, ignored=False, detritus=False, dry_run=False):
112
39
from clean_tree import clean_tree
113
if not (unknown or ignored or detritus):
115
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
40
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
42
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
119
44
class cmd_graph_ancestry(bzrlib.commands.Command):
120
"""Produce ancestry graphs using dot.
45
"""Produce ancestry graphs using dot. <BZRTOOLS>
122
47
Output format is detected according to file extension. Some of the more
123
48
common output formats are html, png, gif, svg, ps. An extension of '.dot'
249
163
source = BzrPatchSource(revision, file_list)
250
164
s = Shelf(source.base)
251
s.shelve(source, all, message, no_color)
165
s.shelve(source, all, message)
255
# The following classes are only used as subcommands for 'shelf', they're
256
# not to be registered directly with bzr.
258
class cmd_shelf_list(bzrlib.commands.Command):
259
"""List the patches on the current shelf."""
260
aliases = ['list', 'ls']
265
class cmd_shelf_delete(bzrlib.commands.Command):
266
"""Delete the patch from the current shelf."""
267
aliases = ['delete', 'del']
268
takes_args = ['patch']
269
def run(self, patch):
270
self.shelf.delete(patch)
273
class cmd_shelf_switch(bzrlib.commands.Command):
274
"""Switch to the other shelf, create it if necessary."""
276
takes_args = ['othershelf']
277
def run(self, othershelf):
278
s = Shelf(self.shelf.base, othershelf)
282
class cmd_shelf_show(bzrlib.commands.Command):
283
"""Show the contents of the specified or topmost patch."""
284
aliases = ['show', 'cat', 'display']
285
takes_args = ['patch?']
286
def run(self, patch=None):
287
self.shelf.display(patch)
290
class cmd_shelf_upgrade(bzrlib.commands.Command):
291
"""Upgrade old format shelves."""
292
aliases = ['upgrade']
297
168
class cmd_shelf(bzrlib.commands.Command):
298
"""Perform various operations on your shelved patches. See also shelve."""
169
"""Perform various operations on your shelved patches. See also shelve.
172
list (ls) List the patches on the current shelf.
173
delete (del) <patch> Delete a patch from the current shelf.
174
switch <shelf> Switch to the named shelf, create it if necessary.
175
show <patch> Show the contents of the specified patch.
176
upgrade Upgrade old format shelves.
299
178
takes_args = ['subcommand', 'args*']
301
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
302
cmd_shelf_show, cmd_shelf_upgrade]
304
180
def run(self, subcommand, args_list):
307
if args_list is None:
309
cmd = self._get_cmd_object(subcommand)
310
183
source = BzrPatchSource()
311
184
s = Shelf(source.base)
313
return cmd.run_argv_aliases(args_list)
315
def _get_cmd_object(self, cmd_name):
316
for cmd_class in self.subcommands:
317
for alias in cmd_class.aliases:
318
if alias == cmd_name:
320
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
323
text = ["%s\n\nSubcommands:\n" % self.__doc__]
325
for cmd_class in self.subcommands:
326
text.extend(self.sub_help(cmd_class) + ['\n'])
330
def sub_help(self, cmd_class):
332
cmd_obj = cmd_class()
335
usage = command_usage(cmd_obj)
336
usage = usage.replace('bzr shelf-', '')
337
text.append('%s%s\n' % (indent, usage))
339
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
341
# Somewhat copied from bzrlib.help.help_on_command_options
343
for option_name, option in sorted(cmd_obj.options().items()):
344
if option_name == 'help':
346
option_help.append('%s--%s' % (3 * indent, option_name))
347
if option.type is not None:
348
option_help.append(' %s' % option.argname.upper())
349
if option.short_name():
350
option_help.append(', -%s' % option.short_name())
351
option_help.append('%s%s\n' % (2 * indent, option.help))
353
if len(option_help) > 0:
354
text.append('%soptions:\n' % (2 * indent))
355
text.extend(option_help)
186
if subcommand == 'ls' or subcommand == 'list':
187
self.__check_no_args(args_list, "shelf list takes no arguments!")
189
elif subcommand == 'delete' or subcommand == 'del':
190
self.__check_one_arg(args_list, "shelf delete takes one argument!")
191
s.delete(args_list[0])
192
elif subcommand == 'switch':
193
self.__check_one_arg(args_list, "shelf switch takes one argument!")
194
s = Shelf(source.base, args_list[0])
196
elif subcommand == 'show':
197
self.__check_one_arg(args_list, "shelf show takes one argument!")
198
s.display(args_list[0])
199
elif subcommand == 'upgrade':
200
self.__check_no_args(args_list, "shelf upgrade takes no arguments!")
203
print subcommand, args_list
204
print >>sys.stderr, "Unknown shelf subcommand '%s'" % subcommand
206
def __check_one_arg(self, args, msg):
207
if args is None or len(args) != 1:
208
raise CommandError(msg)
210
def __check_no_args(self, args, msg):
212
raise CommandError(msg)
360
215
class cmd_unshelve(bzrlib.commands.Command):
361
"""Restore shelved changes.
363
By default the most recently shelved changes are restored. However if you
364
specify a patch by name those changes will be restored instead.
216
"""Restore the most recently shelved changes to current tree. <BZRTOOLS>
366
217
See 'shelve' for more information.
368
219
takes_options = [
369
220
Option('all', help='Unshelve all changes without prompting'),
370
221
Option('force', help='Force unshelving even if errors occur'),
371
Option('no-color', help='Never display changes in color')
373
takes_args = ['patch?']
374
def run(self, patch=None, all=False, force=False, no_color=False):
223
def run(self, all=False, force=False):
375
224
source = BzrPatchSource()
376
225
s = Shelf(source.base)
377
s.unshelve(source, patch, all, force, no_color)
226
s.unshelve(source, all, force)
381
230
class cmd_shell(bzrlib.commands.Command):
382
"""Begin an interactive shell tailored for bzr.
231
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
383
232
Bzr commands can be used without typing bzr first, and will be run natively
384
233
when possible. Tab completion is tailored for bzr. The shell prompt shows
385
234
the branch nick, revno, and path.
437
281
class cmd_cbranch(bzrlib.commands.Command):
439
Create a new checkout, associated with a new repository branch.
283
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
441
When you cbranch, bzr looks up a target location in locations.conf, and
442
creates the branch there.
444
In your locations.conf, add the following lines:
445
[/working_directory_root]
446
cbranch_target = /branch_root
447
cbranch_target:policy = appendpath
449
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
450
working directory root, the branch will be created in
451
"/branch_root/foo/baz"
453
NOTE: cbranch also supports "cbranch_root", but that behaviour is
285
When you cbranch, bzr looks up the repository associated with your current
286
directory in branches.conf. It creates a new branch in that repository
287
with the same name and relative path as the checkout you request.
289
The branches.conf parameter is "cbranch_root". So if you want
290
cbranch operations in /home/jrandom/bigproject to produce branches in
291
/home/jrandom/bigproject/repository, you'd add this:
293
[/home/jrandom/bigproject]
294
cbranch_root = /home/jrandom/bigproject/repository
296
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
297
standalone branches will be produced. Standalone branches will also
298
be produced if the source branch is in 0.7 format (or earlier).
456
300
takes_options = [Option("lightweight",
457
help="Create a lightweight checkout"), 'revision']
301
help="Create a lightweight checkout")]
458
302
takes_args = ["source", "target?"]
459
def run(self, source, target=None, lightweight=False, revision=None):
303
def run(self, source, target=None, lightweight=False):
460
304
from cbranch import cbranch
461
return cbranch(source, target, lightweight=lightweight,
305
return cbranch(source, target, lightweight=lightweight)
465
308
class cmd_branches(bzrlib.commands.Command):
466
"""Scan a location for branches"""
309
"""Scan a location for branches <BZRTOOLS>"""
467
310
takes_args = ["location?"]
468
311
def run(self, location=None):
469
312
from branches import branches
528
371
branch_mark(mark, branch, delete)
531
class cmd_import(bzrlib.commands.Command):
532
"""Import sources from a directory, tarball or zip file
534
This command will import a directory, tarball or zip file into a bzr
535
tree, replacing any versioned files already present. If a directory is
536
specified, it is used as the target. If the directory does not exist, or
537
is not versioned, it is created.
539
Tarballs may be gzip or bzip2 compressed. This is autodetected.
541
If the tarball or zip has a single root directory, that directory is
542
stripped when extracting the tarball. This is not done for directories.
545
takes_args = ['source', 'tree?']
546
def run(self, source, tree=None):
547
from upstream_import import do_import
548
do_import(source, tree)
551
class cmd_cdiff(bzrlib.commands.Command):
552
"""A color version of bzr's diff"""
553
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
555
def _takes_options(self):
556
options = list(get_cmd_object('diff').takes_options)
557
options.append(Option('check-style',
558
help='Warn if trailing whitespace or spurious changes have been'
562
takes_options = property(_takes_options)
564
def run(self, check_style=False, *args, **kwargs):
565
from colordiff import colordiff
566
colordiff(check_style, *args, **kwargs)
569
class cmd_baz_import(bzrlib.commands.Command):
570
"""Import an Arch or Baz archive into a bzr repository.
572
This command should be used on local archives (or mirrors) only. It is
573
quite slow on remote archives.
575
reuse_history allows you to specify any previous imports you
576
have done of different archives, which this archive has branches
577
tagged from. This will dramatically reduce the time to convert
578
the archive as it will not have to convert the history already
579
converted in that other branch.
581
If you specify prefixes, only branches whose names start with that prefix
582
will be imported. Skipped branches will be listed, so you can import any
583
branches you missed by accident. Here's an example of doing a partial
584
import from thelove@canonical.com:
585
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
587
WARNING: Encoding should not be specified unless necessary, because if you
588
specify an encoding, your converted branch will not interoperate with
589
independently-converted branches, unless the other branches were converted
590
with exactly the same encoding. Any encoding recognized by Python may
591
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
594
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
595
takes_options = ['verbose', Option('prefixes', type=str,
596
help="Prefixes of branches to import, colon-separated"),
597
Option('encoding', type=str,
598
help='Force encoding to specified value. See WARNING.')]
600
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
601
reuse_history_list=[], prefixes=None):
602
from errors import NoPyBaz
605
baz_import.baz_import(to_root_dir, from_archive, encoding,
606
verbose, reuse_history_list, prefixes)
608
print "This command is disabled. Please install PyBaz."
611
class cmd_baz_import_branch(bzrlib.commands.Command):
612
"""Import an Arch or Baz branch into a bzr branch.
614
WARNING: Encoding should not be specified unless necessary, because if you
615
specify an encoding, your converted branch will not interoperate with
616
independently-converted branches, unless the other branches were converted
617
with exactly the same encoding. Any encoding recognized by Python may
618
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
621
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
622
takes_options = ['verbose', Option('max-count', type=int),
623
Option('encoding', type=str,
624
help='Force encoding to specified value. See WARNING.')]
626
def run(self, to_location, from_branch=None, fast=False, max_count=None,
627
encoding=None, verbose=False, dry_run=False,
628
reuse_history_list=[]):
629
from errors import NoPyBaz
632
baz_import.baz_import_branch(to_location, from_branch, fast,
633
max_count, verbose, encoding, dry_run,
636
print "This command is disabled. Please install PyBaz."
639
class cmd_rspush(bzrlib.commands.Command):
640
"""Upload this branch to another location using rsync.
642
If no location is specified, the last-used location will be used. To
643
prevent dirty trees from being uploaded, rspush will error out if there are
644
unknown files or local changes. It will also error out if the upstream
645
directory is non-empty and not an earlier version of the branch.
647
takes_args = ['location?']
648
takes_options = [Option('overwrite', help='Ignore differences between'
649
' branches and overwrite unconditionally'),
650
Option('no-tree', help='Do not push the working tree,'
653
def run(self, location=None, overwrite=False, no_tree=False):
654
from bzrlib import workingtree
656
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
657
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
658
working_tree=not no_tree)
661
class cmd_switch(bzrlib.commands.Command):
662
"""Set the branch of a lightweight checkout and update."""
664
takes_args = ['to_location']
666
def run(self, to_location):
667
from switch import cmd_switch
668
cmd_switch().run(to_location)
673
cmd_baz_import_branch,
374
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
375
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
376
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
377
cmd_multi_pull, cmd_switch, cmd_branch_mark]
380
command_decorators = []
383
import bzrlib.builtins
384
if not hasattr(bzrlib.builtins, "cmd_push"):
385
commands.append(push.cmd_push)
387
command_decorators.append(push.cmd_push)
389
from errors import NoPyBaz
392
commands.append(baz_import.cmd_baz_import_branch)
393
commands.append(baz_import.cmd_baz_import)
396
class cmd_baz_import_branch(bzrlib.commands.Command):
397
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
398
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
399
takes_options = ['verbose', Option('max-count', type=int)]
400
def run(self, to_location=None, from_branch=None, fast=False,
401
max_count=None, verbose=False, dry_run=False,
402
reuse_history_list=[]):
403
print "This command is disabled. Please install PyBaz."
406
class cmd_baz_import(bzrlib.commands.Command):
407
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
408
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
409
takes_options = ['verbose', Option('prefixes', type=str,
410
help="Prefixes of branches to import")]
411
def run(self, to_root_dir=None, from_archive=None, verbose=False,
412
reuse_history_list=[], prefixes=None):
413
print "This command is disabled. Please install PyBaz."
414
commands.extend((cmd_baz_import_branch, cmd_baz_import))
695
417
if hasattr(bzrlib.commands, 'register_command'):
696
418
for command in commands:
697
419
bzrlib.commands.register_command(command)
420
for command in command_decorators:
421
command._original_command = bzrlib.commands.register_command(
700
425
def test_suite():
701
427
from bzrlib.tests.TestUtil import TestLoader
703
429
from doctest import DocTestSuite, ELLIPSIS
704
430
from unittest import TestSuite
706
import tests.clean_tree
707
import tests.upstream_import
709
433
import tests.blackbox
710
434
import tests.shelf_tests
711
435
result = TestSuite()
712
436
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
713
result.addTest(tests.clean_tree.test_suite())
716
result.addTest(DocTestSuite(baz_import))
437
result.addTest(clean_tree.test_suite())
438
result.addTest(DocTestSuite(baz_import))
719
439
result.addTest(tests.test_suite())
720
440
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
721
441
result.addTest(tests.blackbox.test_suite())
722
result.addTest(tests.upstream_import.test_suite())
723
442
result.addTest(zap.test_suite())