~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to command_classes.py

  • Committer: Aaron Bentley
  • Date: 2011-04-27 00:06:36 UTC
  • Revision ID: aaron@aaronbentley.com-20110427000636-od4xzn1u465mqzfm
Fix long line.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
2
 
"""\
3
 
Various useful plugins for working with bzr.
4
 
"""
5
 
import bzrlib.commands
6
 
import push
 
1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron@aaronbentley.com>
 
2
# Copyright (C) 2005, 2006, 2011 Canonical Limited.
 
3
# Copyright (C) 2006 Michael Ellerman.
 
4
#
 
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.
 
9
#
 
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.
 
14
#
 
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
 
18
 
 
19
import errno
 
20
 
 
21
import bzrlib
 
22
 
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
from bzrlib import help, urlutils
 
26
import shelf
 
27
""")
 
28
 
 
29
from command import BzrToolsCommand
7
30
from errors import CommandError
8
31
from patchsource import BzrPatchSource
9
 
from shelf import Shelf
10
32
import sys
11
33
import os.path
12
 
from bzrlib.option import Option
13
 
import bzrlib.branch
 
34
 
 
35
import bzrlib.builtins
 
36
import bzrlib.commands
 
37
from bzrlib.branch import Branch
 
38
from bzrlib.bzrdir import BzrDir
 
39
from bzrlib.commands import get_cmd_object
14
40
from bzrlib.errors import BzrCommandError
15
 
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__), 
16
 
                                                 "external")))
17
 
from bzrlib import DEFAULT_IGNORE
18
 
 
19
 
 
20
 
DEFAULT_IGNORE.append('./.shelf')
21
 
DEFAULT_IGNORE.append('./.bzr-shelf*')
22
 
 
23
 
 
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.')
31
 
 
32
 
class cmd_clean_tree(bzrlib.commands.Command):
33
 
    """Remove unwanted files from working tree.  <BZRTOOLS>
34
 
    Normally, ignored files are left alone.
35
 
    """
36
 
    takes_options = ['ignored', 'detritus', 'dry-run']
37
 
    def run(self, ignored=False, detritus=False, dry_run=False):
38
 
        from clean_tree import clean_tree
39
 
        clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
40
 
 
41
 
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
42
 
 
43
 
class cmd_graph_ancestry(bzrlib.commands.Command):
44
 
    """Produce ancestry graphs using dot.  <BZRTOOLS>
45
 
    
 
41
import bzrlib.ignores
 
42
from bzrlib.trace import note
 
43
from bzrlib.option import Option, RegistryOption
 
44
from bzrlib.workingtree import WorkingTree
 
45
 
 
46
from command import BzrToolsCommand
 
47
 
 
48
 
 
49
class cmd_graph_ancestry(BzrToolsCommand):
 
50
    """Produce ancestry graphs using dot.
 
51
 
46
52
    Output format is detected according to file extension.  Some of the more
47
53
    common output formats are html, png, gif, svg, ps.  An extension of '.dot'
48
54
    will cause a dot graph file to be produced.  HTML output has mouseovers
52
58
    with the last 5 characters of their revision identifier are used instead.
53
59
 
54
60
    The value starting with d is "(maximum) distance from the null revision".
55
 
    
 
61
 
56
62
    If --merge-branch is specified, the two branches are compared and a merge
57
63
    base is selected.
58
 
    
 
64
 
59
65
    Legend:
60
66
    white    normal revision
61
67
    yellow   THIS  history
75
81
    If available, rsvg is used to antialias PNG and JPEG output, but this can
76
82
    be disabled with --no-antialias.
77
83
    """
78
 
    takes_args = ['branch', 'file']
79
 
    takes_options = [Option('no-collapse', help="Do not skip simple nodes"), 
 
84
    takes_args = ['file', 'merge_branch?']
 
85
    takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
80
86
                     Option('no-antialias',
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.")]
85
 
    def run(self, branch, file, no_collapse=False, no_antialias=False,
86
 
        merge_branch=None, cluster=False):
 
87
                     help="Do not use rsvg to produce antialiased output."),
 
88
                     Option('merge-branch', type=str,
 
89
                     help="Use this branch to calcuate a merge base."),
 
90
                     Option('cluster', help="Use clustered output."),
 
91
                     Option('max-distance',
 
92
                            help="Show no nodes farther than this.", type=int),
 
93
                     Option('directory',
 
94
                            help='Source branch to use (default is current'
 
95
                            ' directory).',
 
96
                            short_name='d',
 
97
                            type=unicode),
 
98
                    ]
 
99
    def run(self, file, merge_branch=None, no_collapse=False,
 
100
            no_antialias=False, cluster=False, max_distance=100,
 
101
            directory='.'):
 
102
        if max_distance == -1:
 
103
            max_distance = None
87
104
        import graph
88
105
        if cluster:
89
106
            ranking = "cluster"
90
107
        else:
91
108
            ranking = "forced"
92
 
        graph.write_ancestry_file(branch, file, not no_collapse, 
93
 
                                  not no_antialias, merge_branch, ranking)
94
 
 
95
 
class cmd_fetch_ghosts(bzrlib.commands.Command):
96
 
    """Attempt to retrieve ghosts from another branch.  <BZRTOOLS>
 
109
        graph.write_ancestry_file(directory, file, not no_collapse,
 
110
                                  not no_antialias, merge_branch, ranking,
 
111
                                  max_distance=max_distance)
 
112
 
 
113
 
 
114
class cmd_fetch_ghosts(BzrToolsCommand):
 
115
    """Attempt to retrieve ghosts from another branch.
97
116
    If the other branch is not supplied, the last-pulled branch is used.
98
117
    """
99
118
    aliases = ['fetch-missing']
100
119
    takes_args = ['branch?']
101
 
    takes_options = [Option('no-fix')]
 
120
    takes_options = [Option('no-fix', help="Skip additional synchonization.")]
102
121
    def run(self, branch=None, no_fix=False):
103
122
        from fetch_ghosts import fetch_ghosts
104
 
        fetch_ghosts(branch, no_fix)
 
123
        fetch_ghosts(branch, do_reconcile=not no_fix)
105
124
 
106
125
strip_help="""Strip the smallest prefix containing num leading slashes  from \
107
126
each file name found in the patch file."""
108
 
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
109
 
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
110
 
                                help="""Handle extra bzr tags""")
111
 
class cmd_patch(bzrlib.commands.Command):
112
 
    """Apply a named patch to the current tree.  <BZRTOOLS>
 
127
 
 
128
 
 
129
class cmd_patch(BzrToolsCommand):
 
130
    """Apply a named patch to the current tree.
113
131
    """
114
132
    takes_args = ['filename?']
115
 
    takes_options = ['strip','bzrdiff']
116
 
    def run(self, filename=None, strip=-1, bzrdiff=0):
 
133
    takes_options = [Option('strip', type=int, short_name='p',
 
134
                            help=strip_help),
 
135
                     Option('silent', help='Suppress chatter.')]
 
136
    def run(self, filename=None, strip=None, silent=False):
117
137
        from patch import patch
118
138
        from bzrlib.workingtree import WorkingTree
119
139
        wt = WorkingTree.open_containing('.')[0]
120
 
        if strip == -1:
121
 
            if bzrdiff: strip = 0
122
 
            else:       strip = 1
123
 
 
124
 
        return patch(wt, filename, strip, legacy= not bzrdiff)
125
 
 
126
 
class cmd_shelve(bzrlib.commands.Command):
127
 
    """Temporarily set aside some changes from the current tree.  <BZRTOOLS>
 
140
        if strip is None:
 
141
            strip = 0
 
142
        return patch(wt, filename, strip, silent)
 
143
 
 
144
 
 
145
class cmd_shelve1(BzrToolsCommand):
 
146
    """Temporarily set aside some changes from the current tree.
128
147
 
129
148
    Shelve allows you to temporarily put changes you've made "on the shelf",
130
149
    ie. out of the way, until a later time when you can bring them back from
131
 
    the shelf with the 'unshelve' command.
 
150
    the shelf with the 'unshelve1' command.
132
151
 
133
152
    Shelve is intended to help separate several sets of text changes that have
134
153
    been inappropriately mingled.  If you just want to get rid of all changes
135
154
    (text and otherwise) and you don't need to restore them later, use revert.
136
 
    If you want to shelve all text changes at once, use shelve --all.
137
 
 
138
 
    By default shelve asks you what you want to shelve, press '?' at the
139
 
    prompt to get help. To shelve everything run shelve --all.
140
 
 
141
 
    You can put multiple items on the shelf, each time you run unshelve the
142
 
    most recently shelved changes will be reinstated.
 
155
    If you want to shelve all text changes at once, use shelve1 --all.
 
156
 
 
157
    By default shelve1 asks you what you want to shelve, press '?' at the
 
158
    prompt to get help. To shelve everything run shelve1 --all.
143
159
 
144
160
    If filenames are specified, only the changes to those files will be
145
161
    shelved, other files will be left untouched.
146
162
 
147
163
    If a revision is specified, changes since that revision will be shelved.
 
164
 
 
165
    You can put multiple items on the shelf. Normally each time you run
 
166
    unshelve1 the most recently shelved changes will be reinstated. However,
 
167
    you can also unshelve changes in a different order by explicitly
 
168
    specifiying which changes to unshelve1. This works best when the changes
 
169
    don't depend on each other.
 
170
 
 
171
    While you have patches on the shelf you can view and manipulate them with
 
172
    the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
148
173
    """
149
174
 
150
175
    takes_args = ['file*']
151
 
    takes_options = ['message', 'revision',
152
 
            Option('all', help='Shelve all changes without prompting')]
 
176
    takes_options = [Option('message',
 
177
            help='A message to associate with the shelved changes.',
 
178
            short_name='m', type=unicode),
 
179
            'revision',
 
180
            Option('all', help='Shelve all changes without prompting.'),
 
181
            Option('no-color', help='Never display changes in color.')]
153
182
 
154
 
    def run(self, all=False, file_list=None, message=None, revision=None):
 
183
    def run(self, all=False, file_list=None, message=None, revision=None,
 
184
            no_color=False):
155
185
        if revision is not None and revision:
156
186
            if len(revision) == 1:
157
187
                revision = revision[0]
160
190
                                  "parameter.")
161
191
 
162
192
        source = BzrPatchSource(revision, file_list)
163
 
        s = Shelf(source.base)
164
 
        s.shelve(source, all, message)
 
193
        s = shelf.Shelf(source.base)
 
194
        s.shelve(source, all, message, no_color)
165
195
        return 0
166
196
 
167
 
class cmd_shelf(bzrlib.commands.Command):
168
 
    """Perform various operations on your shelved patches. See also shelve.
169
 
 
170
 
    Subcommands:
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.
176
 
    """
 
197
 
 
198
# The following classes are only used as subcommands for 'shelf1', they're
 
199
# not to be registered directly with bzr.
 
200
 
 
201
class cmd_shelf_list(bzrlib.commands.Command):
 
202
    """List the patches on the current shelf."""
 
203
    aliases = ['list', 'ls']
 
204
    def run(self):
 
205
        self.shelf.list()
 
206
 
 
207
 
 
208
class cmd_shelf_delete(bzrlib.commands.Command):
 
209
    """Delete the patch from the current shelf."""
 
210
    aliases = ['delete', 'del']
 
211
    takes_args = ['patch']
 
212
    def run(self, patch):
 
213
        self.shelf.delete(patch)
 
214
 
 
215
 
 
216
class cmd_shelf_switch(bzrlib.commands.Command):
 
217
    """Switch to the other shelf, create it if necessary."""
 
218
    aliases = ['switch']
 
219
    takes_args = ['othershelf']
 
220
    def run(self, othershelf):
 
221
        s = shelf.Shelf(self.shelf.base, othershelf)
 
222
        s.make_default()
 
223
 
 
224
 
 
225
class cmd_shelf_show(bzrlib.commands.Command):
 
226
    """Show the contents of the specified or topmost patch."""
 
227
    aliases = ['show', 'cat', 'display']
 
228
    takes_args = ['patch?']
 
229
    def run(self, patch=None):
 
230
        self.shelf.display(patch)
 
231
 
 
232
 
 
233
class cmd_shelf_upgrade(bzrlib.commands.Command):
 
234
    """Upgrade old format shelves."""
 
235
    aliases = ['upgrade']
 
236
    def run(self):
 
237
        self.shelf.upgrade()
 
238
 
 
239
 
 
240
class cmd_shelf1(BzrToolsCommand):
 
241
    """Perform various operations on your shelved patches. See also shelve1."""
177
242
    takes_args = ['subcommand', 'args*']
178
243
 
 
244
    subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
 
245
        cmd_shelf_show, cmd_shelf_upgrade]
 
246
 
179
247
    def run(self, subcommand, args_list):
180
248
        import sys
181
249
 
 
250
        if args_list is None:
 
251
            args_list = []
 
252
        cmd = self._get_cmd_object(subcommand)
182
253
        source = BzrPatchSource()
183
 
        s = Shelf(source.base)
184
 
 
185
 
        if subcommand == 'ls' or subcommand == 'list':
186
 
            self.__check_no_args(args_list, "shelf list takes no arguments!")
187
 
            s.list()
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])
194
 
            s.make_default()
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!")
200
 
            s.upgrade()
201
 
        else:
202
 
            print subcommand, args_list
203
 
            print >>sys.stderr, "Unknown shelf subcommand '%s'" % subcommand
204
 
 
205
 
    def __check_one_arg(self, args, msg):
206
 
        if args is None or len(args) != 1:
207
 
            raise CommandError(msg)
208
 
 
209
 
    def __check_no_args(self, args, msg):
210
 
        if args is not None:
211
 
            raise CommandError(msg)
212
 
 
213
 
 
214
 
class cmd_unshelve(bzrlib.commands.Command):
215
 
    """Restore the most recently shelved changes to current tree.  <BZRTOOLS>
216
 
    See 'shelve' for more information.
 
254
        s = shelf.Shelf(source.base)
 
255
        cmd.shelf = s
 
256
 
 
257
        if args_list is None:
 
258
            args_list = []
 
259
        return cmd.run_argv_aliases(args_list)
 
260
 
 
261
    def _get_cmd_object(self, cmd_name):
 
262
        for cmd_class in self.subcommands:
 
263
            for alias in cmd_class.aliases:
 
264
                if alias == cmd_name:
 
265
                    return cmd_class()
 
266
        raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
 
267
 
 
268
    def help(self):
 
269
        text = ["%s\n\nSubcommands:\n" % self.__doc__]
 
270
 
 
271
        for cmd_class in self.subcommands:
 
272
            text.extend(self.sub_help(cmd_class) + ['\n'])
 
273
 
 
274
        return ''.join(text)
 
275
 
 
276
    def sub_help(self, cmd_class):
 
277
        text = []
 
278
        cmd_obj = cmd_class()
 
279
        indent = 2 * ' '
 
280
 
 
281
        usage = cmd_obj._usage()
 
282
        usage = usage.replace('bzr shelf-', '')
 
283
        text.append('%s%s\n' % (indent, usage))
 
284
 
 
285
        text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
 
286
 
 
287
        # Somewhat copied from bzrlib.help.help_on_command_options
 
288
        option_help = []
 
289
        for option_name, option in sorted(cmd_obj.options().items()):
 
290
            if option_name == 'help':
 
291
                continue
 
292
            option_help.append('%s--%s' % (3 * indent, option_name))
 
293
            if option.type is not None:
 
294
                option_help.append(' %s' % option.argname.upper())
 
295
            if option.short_name():
 
296
                option_help.append(', -%s' % option.short_name())
 
297
            option_help.append('%s%s\n' % (2 * indent, option.help))
 
298
 
 
299
        if len(option_help) > 0:
 
300
            text.append('%soptions:\n' % (2 * indent))
 
301
            text.extend(option_help)
 
302
 
 
303
        return text
 
304
 
 
305
 
 
306
class cmd_unshelve1(BzrToolsCommand):
 
307
    """Restore shelved changes.
 
308
 
 
309
    By default the most recently shelved changes are restored. However if you
 
310
    specify a patch by name those changes will be restored instead.
 
311
 
 
312
    See 'shelve1' for more information.
217
313
    """
218
314
    takes_options = [
219
 
            Option('all', help='Unshelve all changes without prompting'),
220
 
            Option('force', help='Force unshelving even if errors occur'),
221
 
    ]
222
 
    def run(self, all=False, force=False):
 
315
            Option('all', help='Unshelve all changes without prompting.'),
 
316
            Option('force', help='Force unshelving even if errors occur.'),
 
317
            Option('no-color', help='Never display changes in color.')
 
318
        ]
 
319
    takes_args = ['patch?']
 
320
    def run(self, patch=None, all=False, force=False, no_color=False):
223
321
        source = BzrPatchSource()
224
 
        s = Shelf(source.base)
225
 
        s.unshelve(source, all, force)
 
322
        s = shelf.Shelf(source.base)
 
323
        s.unshelve(source, patch, all, force, no_color)
226
324
        return 0
227
325
 
228
326
 
229
 
class cmd_shell(bzrlib.commands.Command):
230
 
    """Begin an interactive shell tailored for bzr.  <BZRTOOLS>
 
327
class cmd_shell(BzrToolsCommand):
 
328
    """Begin an interactive shell tailored for bzr.
231
329
    Bzr commands can be used without typing bzr first, and will be run natively
232
330
    when possible.  Tab completion is tailored for bzr.  The shell prompt shows
233
331
    the branch nick, revno, and path.
244
342
    --all        --help       --revision   --show-ids
245
343
    bzr bzrtools:287/> status --
246
344
    """
247
 
    def run(self):
 
345
    takes_options = [
 
346
        Option('directory',
 
347
            help='Branch in which to start the shell, '
 
348
                 'rather than the one containing the working directory.',
 
349
            short_name='d',
 
350
            type=unicode,
 
351
            ),
 
352
        ]
 
353
    def run(self, directory=None):
248
354
        import shell
249
 
        return shell.run_shell()
250
 
 
251
 
class cmd_branch_history(bzrlib.commands.Command):
 
355
        return shell.run_shell(directory)
 
356
 
 
357
 
 
358
class cmd_branch_history(BzrToolsCommand):
252
359
    """\
253
 
    Display the development history of a branch  <BZRTOOLS>.
 
360
    Display the development history of a branch.
254
361
 
255
362
    Each different committer or branch nick is considered a different line of
256
363
    development.  Committers are treated as the same if they have the same
258
365
    """
259
366
    takes_args = ["branch?"]
260
367
    def run(self, branch=None):
261
 
        from branchhistory import branch_history 
 
368
        from branchhistory import branch_history
262
369
        return branch_history(branch)
263
370
 
264
371
 
265
 
class cmd_zap(bzrlib.commands.Command):
 
372
class cmd_zap(BzrToolsCommand):
266
373
    """\
267
 
    Remove a checkout, if it can be done safely. <BZRTOOLS>
268
 
 
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.
 
374
    Remove a lightweight checkout, if it can be done safely.
 
375
 
 
376
    This command will remove a lightweight checkout without losing data.  That
 
377
    means it only removes lightweight checkouts, and only if they have no
 
378
    uncommitted changes.
 
379
 
 
380
    If --branch is specified, the branch will be deleted too, but only if the
 
381
    the branch has no new commits (relative to its parent).
 
382
 
 
383
    If bzr-pipeline is also installed, the --store option will store changes
 
384
    in the branch before deleting the tree.  To restore the changes, do::
 
385
 
 
386
      bzr checkout --lightweight $BRANCH $CHECKOUT
 
387
      bzr switch-pipe -d $CHECKOUT `bzr nick -d $CHECKOUT`
271
388
    """
 
389
    takes_options = [Option("branch", help="Remove associated branch from"
 
390
                                           " repository."),
 
391
                     RegistryOption('change_policy',
 
392
                                    'How to handle changed files',
 
393
                                    lazy_registry =
 
394
                                    ('bzrlib.plugins.bzrtools.zap',
 
395
                                        'change_policy_registry'),
 
396
                                    value_switches=True,
 
397
                                    enum_switch=False)]
272
398
    takes_args = ["checkout"]
273
 
    def run(self, checkout):
274
 
        from zap import zap
275
 
        return zap(checkout)
276
 
 
277
 
 
278
 
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
279
 
            cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
280
 
            cmd_branch_history, cmd_zap]
281
 
 
282
 
 
283
 
command_decorators = []
284
 
 
285
 
 
286
 
import bzrlib.builtins
287
 
if not hasattr(bzrlib.builtins, "cmd_push"):
288
 
    commands.append(push.cmd_push)
289
 
else:
290
 
    command_decorators.append(push.cmd_push)
291
 
 
292
 
from errors import NoPyBaz
293
 
try:
294
 
    import baz_import
295
 
    commands.append(baz_import.cmd_baz_import_branch)
296
 
    commands.append(baz_import.cmd_baz_import)
297
 
 
298
 
except NoPyBaz:
299
 
    class cmd_baz_import_branch(bzrlib.commands.Command):
300
 
        """Disabled. (Requires PyBaz)   <BZRTOOLS>"""
301
 
        takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
302
 
        takes_options = ['verbose', Option('max-count', type=int)]
303
 
        def run(self, to_location=None, from_branch=None, fast=False, 
304
 
                max_count=None, verbose=False, dry_run=False,
305
 
                reuse_history_list=[]):
306
 
            print "This command is disabled.  Please install PyBaz."
307
 
 
308
 
 
309
 
    class cmd_baz_import(bzrlib.commands.Command):
310
 
        """Disabled. (Requires PyBaz)   <BZRTOOLS>"""
311
 
        takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
312
 
        takes_options = ['verbose', Option('prefixes', type=str,
313
 
                         help="Prefixes of branches to import")]
314
 
        def run(self, to_root_dir=None, from_archive=None, verbose=False,
315
 
                reuse_history_list=[], prefixes=None):
316
 
                print "This command is disabled.  Please install PyBaz."
317
 
    commands.extend((cmd_baz_import_branch, cmd_baz_import))
318
 
 
319
 
 
320
 
if hasattr(bzrlib.commands, 'register_command'):
321
 
    for command in commands:
322
 
        bzrlib.commands.register_command(command)
323
 
    for command in command_decorators:
324
 
        command._original_command = bzrlib.commands.register_command(
325
 
            command, True)
326
 
 
327
 
 
328
 
def test_suite():
329
 
    import baz_import
330
 
    from bzrlib.tests.TestUtil import TestLoader
331
 
    import tests
332
 
    from doctest import DocTestSuite, ELLIPSIS
333
 
    from unittest import TestSuite
334
 
    import clean_tree
335
 
    import zap
336
 
    import tests.blackbox
337
 
    import tests.shelf_tests
338
 
    result = TestSuite()
339
 
    result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
340
 
    result.addTest(clean_tree.test_suite())
341
 
    result.addTest(DocTestSuite(baz_import))
342
 
    result.addTest(tests.test_suite())
343
 
    result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
344
 
    result.addTest(tests.blackbox.test_suite())
345
 
    result.addTest(zap.test_suite())
346
 
    return result
 
399
    def run(self, checkout, branch=False, change_policy=None):
 
400
        from zap import (
 
401
            change_policy_registry,
 
402
            StoreChanges,
 
403
            zap,
 
404
        )
 
405
        if change_policy is None:
 
406
            change_policy = change_policy_registry.get()
 
407
        if change_policy is StoreChanges:
 
408
            try:
 
409
                import bzrlib.plugins.pipeline
 
410
            except ImportError:
 
411
                raise BzrCommandError('--store requires bzr-pipeline.')
 
412
        return zap(checkout, remove_branch=branch, policy=change_policy)
 
413
 
 
414
 
 
415
class cmd_cbranch(BzrToolsCommand):
 
416
    """
 
417
    Create a new checkout, associated with a new repository branch.
 
418
 
 
419
    When you cbranch, bzr looks up a target location in locations.conf, and
 
420
    creates the branch there.
 
421
 
 
422
    In your locations.conf, add the following lines:
 
423
    [/working_directory_root]
 
424
    cbranch_target = /branch_root
 
425
    cbranch_target:policy = appendpath
 
426
 
 
427
    This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
 
428
    working directory root, the branch will be created in
 
429
    "/branch_root/foo/baz"
 
430
 
 
431
    NOTE: cbranch also supports "cbranch_root", but that behaviour is
 
432
    deprecated.
 
433
    """
 
434
    takes_options = [Option("lightweight",
 
435
                            help="Create a lightweight checkout."), 'revision',
 
436
                     Option('files-from', type=unicode,
 
437
                            help='Accelerate checkout using files from this'
 
438
                                 ' tree.'),
 
439
                     Option('hardlink',
 
440
                            help='Hard-link files from source/files-from tree'
 
441
                            ' where posible.')]
 
442
    takes_args = ["source", "target?"]
 
443
    def run(self, source, target=None, lightweight=False, revision=None,
 
444
            files_from=None, hardlink=False):
 
445
        from cbranch import cbranch
 
446
        return cbranch(source, target, lightweight=lightweight,
 
447
                       revision=revision, files_from=files_from,
 
448
                       hardlink=hardlink)
 
449
 
 
450
 
 
451
class cmd_branches(BzrToolsCommand):
 
452
    """Scan a location for branches"""
 
453
    takes_args = ["location?"]
 
454
    def run(self, location=None):
 
455
        from branches import branches
 
456
        return branches(location)
 
457
 
 
458
class cmd_trees(BzrToolsCommand):
 
459
    """Scan a location for trees"""
 
460
    takes_args = ['location?']
 
461
    def run(self, location='.'):
 
462
        from bzrlib.workingtree import WorkingTree
 
463
        from bzrlib.transport import get_transport
 
464
        t = get_transport(location)
 
465
        for tree in WorkingTree.find_trees(location):
 
466
            self.outf.write('%s\n' % t.relpath(
 
467
                tree.bzrdir.root_transport.base))
 
468
 
 
469
class cmd_multi_pull(BzrToolsCommand):
 
470
    """Pull all the branches under a location, e.g. a repository.
 
471
 
 
472
    Both branches present in the directory and the branches of checkouts are
 
473
    pulled.
 
474
    """
 
475
    takes_args = ["location?"]
 
476
    def run(self, location=None):
 
477
        from bzrlib.transport import get_transport
 
478
        from bzrtools import iter_branch_tree
 
479
        if location is None:
 
480
            location = '.'
 
481
        t = get_transport(location)
 
482
        possible_transports = []
 
483
        if not t.listable():
 
484
            print "Can't list this type of location."
 
485
            return 3
 
486
        for branch, wt in iter_branch_tree(t):
 
487
            if wt is None:
 
488
                pullable = branch
 
489
            else:
 
490
                pullable = wt
 
491
            parent = branch.get_parent()
 
492
            if parent is None:
 
493
                continue
 
494
            if wt is not None:
 
495
                base = wt.basedir
 
496
            else:
 
497
                base = branch.base
 
498
            if base.startswith(t.base):
 
499
                relpath = base[len(t.base):].rstrip('/')
 
500
            else:
 
501
                relpath = base
 
502
            print "Pulling %s from %s" % (relpath, parent)
 
503
            try:
 
504
                branch_t = get_transport(parent, possible_transports)
 
505
                pullable.pull(Branch.open_from_transport(branch_t))
 
506
            except Exception, e:
 
507
                print e
 
508
 
 
509
 
 
510
 
 
511
class cmd_import(BzrToolsCommand):
 
512
    """Import sources from a directory, tarball or zip file
 
513
 
 
514
    This command will import a directory, tarball or zip file into a bzr
 
515
    tree, replacing any versioned files already present.  If a directory is
 
516
    specified, it is used as the target.  If the directory does not exist, or
 
517
    is not versioned, it is created.
 
518
 
 
519
    Tarballs may be gzip or bzip2 compressed.  This is autodetected.
 
520
 
 
521
    If the tarball or zip has a single root directory, that directory is
 
522
    stripped when extracting the tarball.  This is not done for directories.
 
523
    """
 
524
 
 
525
    takes_args = ['source', 'tree?']
 
526
    def run(self, source, tree=None):
 
527
        from upstream_import import do_import
 
528
        do_import(source, tree)
 
529
 
 
530
 
 
531
class cmd_cdiff(BzrToolsCommand):
 
532
    """A color version of bzr's diff"""
 
533
    takes_args = property(lambda x: get_cmd_object('diff').takes_args)
 
534
    takes_options = list(get_cmd_object('diff').takes_options) + [
 
535
        RegistryOption.from_kwargs('color',
 
536
            'Color mode to use.',
 
537
            title='Color Mode', value_switches=False, enum_switch=True,
 
538
            never='Never colorize output.',
 
539
            auto='Only colorize output if terminal supports it and STDOUT is a'
 
540
            ' TTY.',
 
541
            always='Always colorize output (default).'),
 
542
        Option('check-style',
 
543
            help='Warn if trailing whitespace or spurious changes have been'
 
544
                 ' added.')]
 
545
 
 
546
    def run(self, color='always', check_style=False, *args, **kwargs):
 
547
        from colordiff import colordiff
 
548
        colordiff(color, check_style, *args, **kwargs)
 
549
 
 
550
 
 
551
class cmd_conflict_diff(BzrToolsCommand):
 
552
 
 
553
    """Compare a conflicted file against BASE."""
 
554
 
 
555
    encoding_type = 'exact'
 
556
    takes_args = ['file*']
 
557
    takes_options = [
 
558
        RegistryOption.from_kwargs('direction', 'Direction of comparison.',
 
559
            value_switches=True, enum_switch=False,
 
560
            other='Compare OTHER against common base.',
 
561
            this='Compare THIS against common base.')]
 
562
 
 
563
    def run(self, file_list, direction='other'):
 
564
        from bzrlib.plugins.bzrtools.colordiff import DiffWriter
 
565
        from conflict_diff import ConflictDiffer
 
566
        dw = DiffWriter(self.outf, check_style=False, color='auto')
 
567
        ConflictDiffer().run(dw, file_list, direction)
 
568
 
 
569
 
 
570
class cmd_rspush(BzrToolsCommand):
 
571
    """Upload this branch to another location using rsync.
 
572
 
 
573
    If no location is specified, the last-used location will be used.  To
 
574
    prevent dirty trees from being uploaded, rspush will error out if there are
 
575
    unknown files or local changes.  It will also error out if the upstream
 
576
    directory is non-empty and not an earlier version of the branch.
 
577
    """
 
578
    takes_args = ['location?']
 
579
    takes_options = [Option('overwrite', help='Ignore differences between'
 
580
                            ' branches and overwrite unconditionally.'),
 
581
                     Option('no-tree', help='Do not push the working tree,'
 
582
                            ' just the .bzr.')]
 
583
 
 
584
    def run(self, location=None, overwrite=False, no_tree=False):
 
585
        from bzrlib import workingtree
 
586
        import bzrtools
 
587
        cur_branch = workingtree.WorkingTree.open_containing(".")[0]
 
588
        bzrtools.rspush(cur_branch, location, overwrite=overwrite,
 
589
                      working_tree=not no_tree)
 
590
 
 
591
 
 
592
class cmd_link_tree(BzrToolsCommand):
 
593
    """Hardlink matching files to another tree.
 
594
 
 
595
    Only files with identical content and execute bit will be linked.
 
596
    """
 
597
    takes_args = ['location']
 
598
 
 
599
    def run(self, location):
 
600
        from bzrlib import workingtree
 
601
        from bzrlib.plugins.bzrtools.link_tree import link_tree
 
602
        target_tree = workingtree.WorkingTree.open_containing(".")[0]
 
603
        source_tree = workingtree.WorkingTree.open(location)
 
604
        target_tree.lock_write()
 
605
        try:
 
606
            source_tree.lock_read()
 
607
            try:
 
608
                link_tree(target_tree, source_tree)
 
609
            finally:
 
610
                source_tree.unlock()
 
611
        finally:
 
612
            target_tree.unlock()
 
613
 
 
614
 
 
615
class cmd_create_mirror(BzrToolsCommand):
 
616
    """Create a mirror of another branch.
 
617
 
 
618
    This is similar to `bzr branch`, but copies more settings, including the
 
619
    submit branch and nickname.
 
620
 
 
621
    It sets the public branch and parent of the target to the source location.
 
622
    """
 
623
 
 
624
    takes_args = ['source', 'target']
 
625
 
 
626
    def run(self, source, target):
 
627
        source_branch = Branch.open(source)
 
628
        from bzrlib.plugins.bzrtools.mirror import create_mirror
 
629
        create_mirror(source_branch, target, [])