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.
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
66
from patchsource import BzrPatchSource
8
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
11
77
from bzrlib.option import Option
13
from bzrlib.errors import BzrCommandError
14
sys.path.append(os.path.dirname(__file__))
16
Option.OPTIONS['ignored'] = Option('ignored',
17
help='delete all ignored files.')
18
Option.OPTIONS['detrius'] = Option('detrius',
19
help='delete conflict files merge backups, and failed selftest dirs.' +
20
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
21
Option.OPTIONS['dry-run'] = Option('dry-run',
22
help='show files to delete instead of deleting them.')
78
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
83
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
24
86
class cmd_clean_tree(bzrlib.commands.Command):
25
87
"""Remove unwanted files from working tree.
26
Normally, ignored files are left alone.
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.
28
takes_options = ['ignored', 'detrius', 'dry-run']
29
def run(self, ignored=False, detrius=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):
30
109
from clean_tree import clean_tree
31
clean_tree('.', ignored=ignored, detrius=detrius, dry_run=dry_run)
110
if not (unknown or ignored or detritus):
112
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
33
Option.OPTIONS['no-collapse'] = Option('no-collapse')
34
Option.OPTIONS['no-antialias'] = Option('no-antialias')
35
Option.OPTIONS['cluster'] = Option('cluster')
36
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
38
116
class cmd_graph_ancestry(bzrlib.commands.Command):
39
117
"""Produce ancestry graphs using dot.
41
119
Output format is detected according to file extension. Some of the more
42
common output formats are png, gif, svg, ps. An extension of '.dot' will
43
cause a dot graph file to be produced.
120
common output formats are html, png, gif, svg, ps. An extension of '.dot'
121
will cause a dot graph file to be produced. HTML output has mouseovers
122
that show the commit message.
45
124
Branches are labeled r?, where ? is the revno. If they have no revno,
46
125
with the last 5 characters of their revision identifier are used instead.
127
The value starting with d is "(maximum) distance from the null revision".
48
129
If --merge-branch is specified, the two branches are compared and a merge
78
165
graph.write_ancestry_file(branch, file, not no_collapse,
79
166
not no_antialias, merge_branch, ranking)
81
169
class cmd_fetch_ghosts(bzrlib.commands.Command):
82
170
"""Attempt to retrieve ghosts from another branch.
83
171
If the other branch is not supplied, the last-pulled branch is used.
85
173
aliases = ['fetch-missing']
86
174
takes_args = ['branch?']
87
def run(self, branch=None):
175
takes_options = [Option('no-fix')]
176
def run(self, branch=None, no_fix=False):
88
177
from fetch_ghosts import fetch_ghosts
178
fetch_ghosts(branch, no_fix)
91
180
strip_help="""Strip the smallest prefix containing num leading slashes from \
92
181
each file name found in the patch file."""
93
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
182
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
183
help="""Handle extra bzr tags""")
94
186
class cmd_patch(bzrlib.commands.Command):
95
187
"""Apply a named patch to the current tree.
97
189
takes_args = ['filename?']
98
takes_options = ['strip']
99
def run(self, filename=None, strip=0):
190
takes_options = [Option('strip', type=int, help=strip_help)]
191
def run(self, filename=None, strip=-1, bzrdiff=0):
100
192
from patch import patch
101
from bzrlib.branch import Branch
102
b = Branch.open_containing('.')[0]
103
return patch(b, filename, strip)
193
from bzrlib.workingtree import WorkingTree
194
wt = WorkingTree.open_containing('.')[0]
196
if bzrdiff: strip = 0
199
return patch(wt, filename, strip, legacy= not bzrdiff)
106
202
class cmd_shelve(bzrlib.commands.Command):
107
"""Temporarily remove some changes from the current tree.
108
Use 'unshelve' to restore these changes.
110
If filenames are specified, only changes to those files will be unshelved.
111
If a revision is specified, all changes since that revision will may be
203
"""Temporarily set aside some changes from the current tree.
205
Shelve allows you to temporarily put changes you've made "on the shelf",
206
ie. out of the way, until a later time when you can bring them back from
207
the shelf with the 'unshelve' command.
209
Shelve is intended to help separate several sets of text changes that have
210
been inappropriately mingled. If you just want to get rid of all changes
211
(text and otherwise) and you don't need to restore them later, use revert.
212
If you want to shelve all text changes at once, use shelve --all.
214
By default shelve asks you what you want to shelve, press '?' at the
215
prompt to get help. To shelve everything run shelve --all.
217
If filenames are specified, only the changes to those files will be
218
shelved, other files will be left untouched.
220
If a revision is specified, changes since that revision will be shelved.
222
You can put multiple items on the shelf. Normally each time you run
223
unshelve the most recently shelved changes will be reinstated. However,
224
you can also unshelve changes in a different order by explicitly
225
specifiying which changes to unshelve. This works best when the changes
226
don't depend on each other.
228
While you have patches on the shelf you can view and manipulate them with
229
the 'shelf' command. Run 'bzr shelf -h' for more info.
114
232
takes_args = ['file*']
115
takes_options = ['all', 'message', 'revision']
116
def run(self, all=False, file_list=None, message=None, revision=None):
117
if file_list is not None and len(file_list) > 0:
118
branchdir = file_list[0]
233
takes_options = ['message', 'revision',
234
Option('all', help='Shelve all changes without prompting'),
235
Option('no-color', help='Never display changes in color')]
237
def run(self, all=False, file_list=None, message=None, revision=None,
122
239
if revision is not None and revision:
123
240
if len(revision) == 1:
124
241
revision = revision[0]
126
raise BzrCommandError("shelve only accepts a single revision "
243
raise CommandError("shelve only accepts a single revision "
130
return s.shelve(all, message, revision, file_list)
246
source = BzrPatchSource(revision, file_list)
247
s = Shelf(source.base)
248
s.shelve(source, all, message, no_color)
252
# The following classes are only used as subcommands for 'shelf', they're
253
# not to be registered directly with bzr.
255
class cmd_shelf_list(bzrlib.commands.Command):
256
"""List the patches on the current shelf."""
257
aliases = ['list', 'ls']
262
class cmd_shelf_delete(bzrlib.commands.Command):
263
"""Delete the patch from the current shelf."""
264
aliases = ['delete', 'del']
265
takes_args = ['patch']
266
def run(self, patch):
267
self.shelf.delete(patch)
270
class cmd_shelf_switch(bzrlib.commands.Command):
271
"""Switch to the other shelf, create it if necessary."""
273
takes_args = ['othershelf']
274
def run(self, othershelf):
275
s = Shelf(self.shelf.base, othershelf)
279
class cmd_shelf_show(bzrlib.commands.Command):
280
"""Show the contents of the specified or topmost patch."""
281
aliases = ['show', 'cat', 'display']
282
takes_args = ['patch?']
283
def run(self, patch=None):
284
self.shelf.display(patch)
287
class cmd_shelf_upgrade(bzrlib.commands.Command):
288
"""Upgrade old format shelves."""
289
aliases = ['upgrade']
294
class cmd_shelf(bzrlib.commands.Command):
295
"""Perform various operations on your shelved patches. See also shelve."""
296
takes_args = ['subcommand', 'args*']
298
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
299
cmd_shelf_show, cmd_shelf_upgrade]
301
def run(self, subcommand, args_list):
304
if args_list is None:
306
cmd = self._get_cmd_object(subcommand)
307
source = BzrPatchSource()
308
s = Shelf(source.base)
310
return cmd.run_argv_aliases(args_list)
312
def _get_cmd_object(self, cmd_name):
313
for cmd_class in self.subcommands:
314
for alias in cmd_class.aliases:
315
if alias == cmd_name:
317
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
320
text = ["%s\n\nSubcommands:\n" % self.__doc__]
322
for cmd_class in self.subcommands:
323
text.extend(self.sub_help(cmd_class) + ['\n'])
327
def sub_help(self, cmd_class):
329
cmd_obj = cmd_class()
332
usage = command_usage(cmd_obj)
333
usage = usage.replace('bzr shelf-', '')
334
text.append('%s%s\n' % (indent, usage))
336
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
338
# Somewhat copied from bzrlib.help.help_on_command_options
340
for option_name, option in sorted(cmd_obj.options().items()):
341
if option_name == 'help':
343
option_help.append('%s--%s' % (3 * indent, option_name))
344
if option.type is not None:
345
option_help.append(' %s' % option.argname.upper())
346
if option.short_name():
347
option_help.append(', -%s' % option.short_name())
348
option_help.append('%s%s\n' % (2 * indent, option.help))
350
if len(option_help) > 0:
351
text.append('%soptions:\n' % (2 * indent))
352
text.extend(option_help)
133
357
class cmd_unshelve(bzrlib.commands.Command):
134
"""Restore previously-shelved changes to the current tree.
358
"""Restore shelved changes.
360
By default the most recently shelved changes are restored. However if you
361
specify a patch by name those changes will be restored instead.
363
See 'shelve' for more information.
366
Option('all', help='Unshelve all changes without prompting'),
367
Option('force', help='Force unshelving even if errors occur'),
368
Option('no-color', help='Never display changes in color')
370
takes_args = ['patch?']
371
def run(self, patch=None, all=False, force=False, no_color=False):
372
source = BzrPatchSource()
373
s = Shelf(source.base)
374
s.unshelve(source, patch, all, force, no_color)
141
378
class cmd_shell(bzrlib.commands.Command):
379
"""Begin an interactive shell tailored for bzr.
380
Bzr commands can be used without typing bzr first, and will be run natively
381
when possible. Tab completion is tailored for bzr. The shell prompt shows
382
the branch nick, revno, and path.
384
If it encounters any moderately complicated shell command, it will punt to
389
bzr bzrtools:287/> status
392
bzr bzrtools:287/> status --[TAB][TAB]
393
--all --help --revision --show-ids
394
bzr bzrtools:287/> status --
146
commands = [cmd_shelve, cmd_unshelve, cmd_clean_tree, cmd_graph_ancestry,
147
cmd_fetch_ghosts, cmd_patch, cmd_shell]
149
import bzrlib.builtins
150
if not hasattr(bzrlib.builtins, "cmd_annotate"):
151
commands.append(annotate.cmd_annotate)
152
if not hasattr(bzrlib.builtins, "cmd_push"):
153
commands.append(push.cmd_push)
155
from errors import NoPyBaz
158
commands.append(baz_import.cmd_baz_import)
161
class cmd_baz_import(bzrlib.commands.Command):
162
"""Disabled. (Requires PyBaz)"""
163
takes_args = ['to_root_dir?', 'from_archive?']
164
takes_options = ['verbose']
165
def run(self, to_root_dir=None, from_archive=None, verbose=False):
166
print "This command is disabled. Please install PyBaz."
167
commands.append(cmd_baz_import)
398
return shell.run_shell()
401
class cmd_branch_history(bzrlib.commands.Command):
403
Display the development history of a branch.
405
Each different committer or branch nick is considered a different line of
406
development. Committers are treated as the same if they have the same
407
name, or if they have the same email address.
409
takes_args = ["branch?"]
410
def run(self, branch=None):
411
from branchhistory import branch_history
412
return branch_history(branch)
415
class cmd_zap(bzrlib.commands.Command):
417
Remove a lightweight checkout, if it can be done safely.
419
This command will remove a lightweight checkout without losing data. That
420
means it only removes lightweight checkouts, and only if they have no
423
If --branch is specified, the branch will be deleted too, but only if the
424
the branch has no new commits (relative to its parent).
426
takes_options = [Option("branch", help="Remove associtated branch from"
428
takes_args = ["checkout"]
429
def run(self, checkout, branch=False):
431
return zap(checkout, remove_branch=branch)
434
class cmd_cbranch(bzrlib.commands.Command):
436
Create a new checkout, associated with a new repository branch.
438
When you cbranch, bzr looks up the repository associated with your current
439
directory in locations.conf. It creates a new branch in that repository
440
with the same name and relative path as the checkout you request.
442
The locations.conf parameter is "cbranch_root". So if you want
443
cbranch operations in /home/jrandom/bigproject to produce branches in
444
/home/jrandom/bigproject/repository, you'd add this:
446
[/home/jrandom/bigproject]
447
cbranch_root = /home/jrandom/bigproject/repository
449
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
450
standalone branches will be produced. Standalone branches will also
451
be produced if the source branch is in 0.7 format (or earlier).
453
takes_options = [Option("lightweight",
454
help="Create a lightweight checkout"), 'revision']
455
takes_args = ["source", "target?"]
456
def run(self, source, target=None, lightweight=False, revision=None):
457
from cbranch import cbranch
458
return cbranch(source, target, lightweight=lightweight,
462
class cmd_branches(bzrlib.commands.Command):
463
"""Scan a location for branches"""
464
takes_args = ["location?"]
465
def run(self, location=None):
466
from branches import branches
467
return branches(location)
470
class cmd_multi_pull(bzrlib.commands.Command):
471
"""Pull all the branches under a location, e.g. a repository.
473
Both branches present in the directory and the branches of checkouts are
476
takes_args = ["location?"]
477
def run(self, location=None):
478
from bzrlib.branch import Branch
479
from bzrlib.transport import get_transport
480
from bzrtools import iter_branch_tree
483
t = get_transport(location)
485
print "Can't list this type of location."
487
for branch, wt in iter_branch_tree(t):
492
parent = branch.get_parent()
499
if base.startswith(t.base):
500
relpath = base[len(t.base):].rstrip('/')
503
print "Pulling %s from %s" % (relpath, parent)
505
pullable.pull(Branch.open(parent))
510
class cmd_branch_mark(bzrlib.commands.Command):
512
Add, view or list branch markers <EXPERIMENTAL>
514
To add a mark, do 'bzr branch-mark MARK'.
515
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
517
To delete a mark, do 'bzr branch-mark --delete MARK'
519
These marks can be used to track a branch's status.
521
takes_args = ['mark?', 'branch?']
522
takes_options = [Option('delete', help='Delete this mark')]
523
def run(self, mark=None, branch=None, delete=False):
524
from branch_mark import branch_mark
525
branch_mark(mark, branch, delete)
528
class cmd_import(bzrlib.commands.Command):
529
"""Import sources from a tarball
531
This command will import a tarball into a bzr tree, replacing any versioned
532
files already present. If a directory is specified, it is used as the
533
target. If the directory does not exist, or is not versioned, it is
536
Tarballs may be gzip or bzip2 compressed. This is autodetected.
538
If the tarball has a single root directory, that directory is stripped
539
when extracting the tarball.
542
takes_args = ['source', 'tree?']
543
def run(self, source, tree=None):
544
from upstream_import import do_import
545
do_import(source, tree)
548
class cmd_cdiff(bzrlib.commands.Command):
549
"""A color version of bzr's diff"""
550
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
551
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
552
def run(*args, **kwargs):
553
from colordiff import colordiff
554
colordiff(*args, **kwargs)
557
class cmd_baz_import(bzrlib.commands.Command):
558
"""Import an Arch or Baz archive into a bzr repository.
560
This command should be used on local archives (or mirrors) only. It is
561
quite slow on remote archives.
563
reuse_history allows you to specify any previous imports you
564
have done of different archives, which this archive has branches
565
tagged from. This will dramatically reduce the time to convert
566
the archive as it will not have to convert the history already
567
converted in that other branch.
569
If you specify prefixes, only branches whose names start with that prefix
570
will be imported. Skipped branches will be listed, so you can import any
571
branches you missed by accident. Here's an example of doing a partial
572
import from thelove@canonical.com:
573
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
575
WARNING: Encoding should not be specified unless necessary, because if you
576
specify an encoding, your converted branch will not interoperate with
577
independently-converted branches, unless the other branches were converted
578
with exactly the same encoding. Any encoding recognized by Python may
579
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
582
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
583
takes_options = ['verbose', Option('prefixes', type=str,
584
help="Prefixes of branches to import, colon-separated"),
585
Option('encoding', type=str,
586
help='Force encoding to specified value. See WARNING.')]
588
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
589
reuse_history_list=[], prefixes=None):
590
from errors import NoPyBaz
593
baz_import.baz_import(to_root_dir, from_archive, encoding,
594
verbose, reuse_history_list, prefixes)
596
print "This command is disabled. Please install PyBaz."
599
class cmd_baz_import_branch(bzrlib.commands.Command):
600
"""Import an Arch or Baz branch into a bzr branch.
602
WARNING: Encoding should not be specified unless necessary, because if you
603
specify an encoding, your converted branch will not interoperate with
604
independently-converted branches, unless the other branches were converted
605
with exactly the same encoding. Any encoding recognized by Python may
606
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
609
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
610
takes_options = ['verbose', Option('max-count', type=int),
611
Option('encoding', type=str,
612
help='Force encoding to specified value. See WARNING.')]
614
def run(self, to_location, from_branch=None, fast=False, max_count=None,
615
encoding=None, verbose=False, dry_run=False,
616
reuse_history_list=[]):
617
from errors import NoPyBaz
620
baz_import.baz_import_branch(to_location, from_branch, fast,
621
max_count, verbose, encoding, dry_run,
624
print "This command is disabled. Please install PyBaz."
627
class cmd_rspush(bzrlib.commands.Command):
628
"""Upload this branch to another location using rsync.
630
If no location is specified, the last-used location will be used. To
631
prevent dirty trees from being uploaded, rspush will error out if there are
632
unknown files or local changes. It will also error out if the upstream
633
directory is non-empty and not an earlier version of the branch.
635
takes_args = ['location?']
636
takes_options = [Option('overwrite', help='Ignore differences between'
637
' branches and overwrite unconditionally'),
638
Option('no-tree', help='Do not push the working tree,'
641
def run(self, location=None, overwrite=False, no_tree=False):
642
from bzrlib import workingtree
644
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
645
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
646
working_tree=not no_tree)
649
class cmd_switch(bzrlib.commands.Command):
650
"""Set the branch of a lightweight checkout and update."""
652
takes_args = ['to_location']
654
def run(self, to_location):
655
from switch import cmd_switch
656
cmd_switch().run(to_location)
661
cmd_baz_import_branch,
169
683
if hasattr(bzrlib.commands, 'register_command'):
170
684
for command in commands:
171
685
bzrlib.commands.register_command(command)
173
688
def test_suite():
174
from doctest import DocTestSuite
175
from unittest import TestSuite, TestLoader
689
from bzrlib.tests.TestUtil import TestLoader
691
from doctest import DocTestSuite, ELLIPSIS
692
from unittest import TestSuite
694
import tests.clean_tree
695
import upstream_import
697
import tests.blackbox
698
import tests.shelf_tests
179
699
result = TestSuite()
180
result.addTest(DocTestSuite(bzrtools))
181
result.addTest(clean_tree.test_suite())
182
result.addTest(TestLoader().loadTestsFromModule(shelf_tests))
183
result.addTest(blackbox.test_suite())
700
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
701
result.addTest(tests.clean_tree.test_suite())
704
result.addTest(DocTestSuite(baz_import))
707
result.addTest(tests.test_suite())
708
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
709
result.addTest(tests.blackbox.test_suite())
710
result.addTest(upstream_import.test_suite())
711
result.addTest(zap.test_suite())