1
# Copyright (C) 2005, 2006 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
3
20
Various useful plugins for working with bzr.
7
from errors import CommandError
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
8
66
from patchsource import BzrPatchSource
9
67
from shelf import Shelf
71
import bzrlib.builtins
72
import bzrlib.commands
73
from bzrlib.commands import get_cmd_object
74
from bzrlib.errors import BzrCommandError
75
from bzrlib.help import command_usage
12
77
from bzrlib.option import Option
14
from bzrlib.errors import BzrCommandError
15
78
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.')
83
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
32
86
class cmd_clean_tree(bzrlib.commands.Command):
33
"""Remove unwanted files from working tree. <BZRTOOLS>
34
Normally, ignored files are left alone.
87
"""Remove unwanted files from working tree.
89
By default, only unknown files, not ignored files, are deleted. Versioned
90
files are never deleted.
92
Another class is 'detritus', which includes files emitted by bzr during
93
normal operations and selftests. (The value of these files decreases with
96
If no options are specified, unknown files are deleted. Otherwise, option
97
flags are respected, and may be combined.
99
To check what clean-tree will do, use --dry-run.
36
takes_options = ['ignored', 'detritus', 'dry-run']
37
def run(self, ignored=False, detritus=False, dry_run=False):
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):
38
109
from clean_tree import clean_tree
39
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
110
if not (unknown or ignored or detritus):
112
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
41
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
43
116
class cmd_graph_ancestry(bzrlib.commands.Command):
44
"""Produce ancestry graphs using dot. <BZRTOOLS>
117
"""Produce ancestry graphs using dot.
46
119
Output format is detected according to file extension. Some of the more
47
120
common output formats are html, png, gif, svg, ps. An extension of '.dot'
162
245
source = BzrPatchSource(revision, file_list)
163
246
s = Shelf(source.base)
164
s.shelve(source, all, message)
247
s.shelve(source, all, message, no_color)
251
# The following classes are only used as subcommands for 'shelf', they're
252
# not to be registered directly with bzr.
254
class cmd_shelf_list(bzrlib.commands.Command):
255
"""List the patches on the current shelf."""
256
aliases = ['list', 'ls']
261
class cmd_shelf_delete(bzrlib.commands.Command):
262
"""Delete the patch from the current shelf."""
263
aliases = ['delete', 'del']
264
takes_args = ['patch']
265
def run(self, patch):
266
self.shelf.delete(patch)
269
class cmd_shelf_switch(bzrlib.commands.Command):
270
"""Switch to the other shelf, create it if necessary."""
272
takes_args = ['othershelf']
273
def run(self, othershelf):
274
s = Shelf(self.shelf.base, othershelf)
278
class cmd_shelf_show(bzrlib.commands.Command):
279
"""Show the contents of the specified or topmost patch."""
280
aliases = ['show', 'cat', 'display']
281
takes_args = ['patch?']
282
def run(self, patch=None):
283
self.shelf.display(patch)
286
class cmd_shelf_upgrade(bzrlib.commands.Command):
287
"""Upgrade old format shelves."""
288
aliases = ['upgrade']
167
293
class cmd_shelf(bzrlib.commands.Command):
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.
294
"""Perform various operations on your shelved patches. See also shelve."""
177
295
takes_args = ['subcommand', 'args*']
297
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
298
cmd_shelf_show, cmd_shelf_upgrade]
179
300
def run(self, subcommand, args_list):
303
if args_list is None:
305
cmd = self._get_cmd_object(subcommand)
182
306
source = BzrPatchSource()
183
307
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)
309
return cmd.run_argv_aliases(args_list)
311
def _get_cmd_object(self, cmd_name):
312
for cmd_class in self.subcommands:
313
for alias in cmd_class.aliases:
314
if alias == cmd_name:
316
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
319
text = ["%s\n\nSubcommands:\n" % self.__doc__]
321
for cmd_class in self.subcommands:
322
text.extend(self.sub_help(cmd_class) + ['\n'])
326
def sub_help(self, cmd_class):
328
cmd_obj = cmd_class()
331
usage = command_usage(cmd_obj)
332
usage = usage.replace('bzr shelf-', '')
333
text.append('%s%s\n' % (indent, usage))
335
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
337
# Somewhat copied from bzrlib.help.help_on_command_options
339
for option_name, option in sorted(cmd_obj.options().items()):
340
if option_name == 'help':
342
option_help.append('%s--%s' % (3 * indent, option_name))
343
if option.type is not None:
344
option_help.append(' %s' % option.argname.upper())
345
if option.short_name():
346
option_help.append(', -%s' % option.short_name())
347
option_help.append('%s%s\n' % (2 * indent, option.help))
349
if len(option_help) > 0:
350
text.append('%soptions:\n' % (2 * indent))
351
text.extend(option_help)
214
356
class cmd_unshelve(bzrlib.commands.Command):
215
"""Restore the most recently shelved changes to current tree. <BZRTOOLS>
357
"""Restore shelved changes.
359
By default the most recently shelved changes are restored. However if you
360
specify a patch by name those changes will be restored instead.
216
362
See 'shelve' for more information.
218
364
takes_options = [
219
365
Option('all', help='Unshelve all changes without prompting'),
220
366
Option('force', help='Force unshelving even if errors occur'),
222
def run(self, all=False, force=False):
367
Option('no-color', help='Never display changes in color')
369
takes_args = ['patch?']
370
def run(self, patch=None, all=False, force=False, no_color=False):
223
371
source = BzrPatchSource()
224
372
s = Shelf(source.base)
225
s.unshelve(source, all, force)
373
s.unshelve(source, patch, all, force, no_color)
229
377
class cmd_shell(bzrlib.commands.Command):
230
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
378
"""Begin an interactive shell tailored for bzr.
231
379
Bzr commands can be used without typing bzr first, and will be run natively
232
380
when possible. Tab completion is tailored for bzr. The shell prompt shows
233
381
the branch nick, revno, and path.
265
414
class cmd_zap(bzrlib.commands.Command):
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.
416
Remove a lightweight checkout, if it can be done safely.
418
This command will remove a lightweight checkout without losing data. That
419
means it only removes lightweight checkouts, and only if they have no
422
If --branch is specified, the branch will be deleted too, but only if the
423
the branch has no new commits (relative to its parent).
425
takes_options = [Option("branch", help="Remove associtated branch from"
272
427
takes_args = ["checkout"]
273
def run(self, checkout):
428
def run(self, checkout, branch=False):
274
429
from zap import zap
430
return zap(checkout, remove_branch=branch)
278
433
class cmd_cbranch(bzrlib.commands.Command):
280
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
435
Create a new checkout, associated with a new repository branch.
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).
437
When you cbranch, bzr looks up a target location in locations.conf, and
438
creates the branch there.
440
In your locations.conf, add the following lines:
441
[/working_directory_root]
442
cbranch_target = /branch_root
443
cbranch_target:policy = appendpath
445
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
446
working directory root, the branch will be created in
447
"/branch_root/foo/baz"
449
NOTE: cbranch also supports "cbranch_root", but that behaviour is
297
takes_args = ["source", "target"]
298
def run(self, source, target):
452
takes_options = [Option("lightweight",
453
help="Create a lightweight checkout"), 'revision']
454
takes_args = ["source", "target?"]
455
def run(self, source, target=None, lightweight=False, revision=None):
299
456
from cbranch import cbranch
300
return cbranch(source, target)
457
return cbranch(source, target, lightweight=lightweight,
302
461
class cmd_branches(bzrlib.commands.Command):
303
"""Scan a location for branches <BZRTOOLS>"""
462
"""Scan a location for branches"""
304
463
takes_args = ["location?"]
305
464
def run(self, location=None):
306
465
from branches import branches
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))
509
class cmd_branch_mark(bzrlib.commands.Command):
511
Add, view or list branch markers <EXPERIMENTAL>
513
To add a mark, do 'bzr branch-mark MARK'.
514
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
516
To delete a mark, do 'bzr branch-mark --delete MARK'
518
These marks can be used to track a branch's status.
520
takes_args = ['mark?', 'branch?']
521
takes_options = [Option('delete', help='Delete this mark')]
522
def run(self, mark=None, branch=None, delete=False):
523
from branch_mark import branch_mark
524
branch_mark(mark, branch, delete)
527
class cmd_import(bzrlib.commands.Command):
528
"""Import sources from a directory, tarball or zip file
530
This command will import a directory, tarball or zip file into a bzr
531
tree, replacing any versioned files already present. If a directory is
532
specified, it is used as the target. If the directory does not exist, or
533
is not versioned, it is created.
535
Tarballs may be gzip or bzip2 compressed. This is autodetected.
537
If the tarball or zip has a single root directory, that directory is
538
stripped when extracting the tarball. This is not done for directories.
541
takes_args = ['source', 'tree?']
542
def run(self, source, tree=None):
543
from upstream_import import do_import
544
do_import(source, tree)
547
class cmd_cdiff(bzrlib.commands.Command):
548
"""A color version of bzr's diff"""
549
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
550
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
551
def run(*args, **kwargs):
552
from colordiff import colordiff
553
colordiff(*args, **kwargs)
556
class cmd_baz_import(bzrlib.commands.Command):
557
"""Import an Arch or Baz archive into a bzr repository.
559
This command should be used on local archives (or mirrors) only. It is
560
quite slow on remote archives.
562
reuse_history allows you to specify any previous imports you
563
have done of different archives, which this archive has branches
564
tagged from. This will dramatically reduce the time to convert
565
the archive as it will not have to convert the history already
566
converted in that other branch.
568
If you specify prefixes, only branches whose names start with that prefix
569
will be imported. Skipped branches will be listed, so you can import any
570
branches you missed by accident. Here's an example of doing a partial
571
import from thelove@canonical.com:
572
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
574
WARNING: Encoding should not be specified unless necessary, because if you
575
specify an encoding, your converted branch will not interoperate with
576
independently-converted branches, unless the other branches were converted
577
with exactly the same encoding. Any encoding recognized by Python may
578
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
581
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
582
takes_options = ['verbose', Option('prefixes', type=str,
583
help="Prefixes of branches to import, colon-separated"),
584
Option('encoding', type=str,
585
help='Force encoding to specified value. See WARNING.')]
587
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
588
reuse_history_list=[], prefixes=None):
589
from errors import NoPyBaz
592
baz_import.baz_import(to_root_dir, from_archive, encoding,
593
verbose, reuse_history_list, prefixes)
595
print "This command is disabled. Please install PyBaz."
598
class cmd_baz_import_branch(bzrlib.commands.Command):
599
"""Import an Arch or Baz branch into a bzr branch.
601
WARNING: Encoding should not be specified unless necessary, because if you
602
specify an encoding, your converted branch will not interoperate with
603
independently-converted branches, unless the other branches were converted
604
with exactly the same encoding. Any encoding recognized by Python may
605
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
608
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
609
takes_options = ['verbose', Option('max-count', type=int),
610
Option('encoding', type=str,
611
help='Force encoding to specified value. See WARNING.')]
613
def run(self, to_location, from_branch=None, fast=False, max_count=None,
614
encoding=None, verbose=False, dry_run=False,
615
reuse_history_list=[]):
616
from errors import NoPyBaz
619
baz_import.baz_import_branch(to_location, from_branch, fast,
620
max_count, verbose, encoding, dry_run,
623
print "This command is disabled. Please install PyBaz."
626
class cmd_rspush(bzrlib.commands.Command):
627
"""Upload this branch to another location using rsync.
629
If no location is specified, the last-used location will be used. To
630
prevent dirty trees from being uploaded, rspush will error out if there are
631
unknown files or local changes. It will also error out if the upstream
632
directory is non-empty and not an earlier version of the branch.
634
takes_args = ['location?']
635
takes_options = [Option('overwrite', help='Ignore differences between'
636
' branches and overwrite unconditionally'),
637
Option('no-tree', help='Do not push the working tree,'
640
def run(self, location=None, overwrite=False, no_tree=False):
641
from bzrlib import workingtree
643
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
644
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
645
working_tree=not no_tree)
648
class cmd_switch(bzrlib.commands.Command):
649
"""Set the branch of a lightweight checkout and update."""
651
takes_args = ['to_location']
653
def run(self, to_location):
654
from switch import cmd_switch
655
cmd_switch().run(to_location)
660
cmd_baz_import_branch,
393
682
if hasattr(bzrlib.commands, 'register_command'):
394
683
for command in commands:
395
684
bzrlib.commands.register_command(command)
396
for command in command_decorators:
397
command._original_command = bzrlib.commands.register_command(
401
687
def test_suite():
403
688
from bzrlib.tests.TestUtil import TestLoader
405
690
from doctest import DocTestSuite, ELLIPSIS
406
691
from unittest import TestSuite
693
import tests.clean_tree
694
import tests.upstream_import
409
696
import tests.blackbox
410
697
import tests.shelf_tests
411
698
result = TestSuite()
412
699
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
413
result.addTest(clean_tree.test_suite())
414
result.addTest(DocTestSuite(baz_import))
700
result.addTest(tests.clean_tree.test_suite())
703
result.addTest(DocTestSuite(baz_import))
415
706
result.addTest(tests.test_suite())
416
707
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
417
708
result.addTest(tests.blackbox.test_suite())
709
result.addTest(tests.upstream_import.test_suite())
418
710
result.addTest(zap.test_suite())