~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Aaron Bentley
  • Date: 2007-01-04 15:37:11 UTC
  • Revision ID: abentley@panoramicfeedback.com-20070104153711-gghmtwum1xidifmj
Support deep cbranch hierarcy via appendpath

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
# Copyright (C) 2005, 2006 Aaron Bentley <aaron.bentley@utoronto.ca>
 
2
# Copyright (C) 2005, 2006 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
 
2
19
"""\
3
20
Various useful plugins for working with bzr.
4
21
"""
5
 
import rspush
6
 
from errors import CommandError
 
22
 
 
23
import bzrlib
 
24
 
 
25
 
 
26
__version__ = '0.14.0'
 
27
 
 
28
 
 
29
version_info = tuple(int(n) for n in __version__.split('.'))
 
30
 
 
31
 
 
32
def check_bzrlib_version(desired):
 
33
    """Check that bzrlib is compatible.
 
34
 
 
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.
 
39
    """
 
40
    desired_plus = (desired[0], desired[1]+1)
 
41
    bzrlib_version = bzrlib.version_info[:2]
 
42
    if bzrlib_version == desired:
 
43
        return
 
44
    try:
 
45
        from bzrlib.trace import warning
 
46
    except ImportError:
 
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)
 
54
    else:
 
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'
 
60
 
 
61
 
 
62
check_bzrlib_version(version_info[:2])
 
63
 
 
64
 
 
65
from errors import CommandError, NoPyBaz
7
66
from patchsource import BzrPatchSource
8
67
from shelf import Shelf
9
 
from switch import cmd_switch
10
68
import sys
11
69
import os.path
12
70
 
13
 
from bzrlib import DEFAULT_IGNORE
14
71
import bzrlib.builtins
15
 
import bzrlib.branch
16
72
import bzrlib.commands
17
73
from bzrlib.commands import get_cmd_object
18
74
from bzrlib.errors import BzrCommandError
19
75
from bzrlib.help import command_usage
 
76
import bzrlib.ignores
20
77
from bzrlib.option import Option
21
78
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__), 
22
79
                                                 "external")))
23
80
 
 
81
import show_paths
24
82
 
25
 
DEFAULT_IGNORE.append('./.shelf')
26
 
DEFAULT_IGNORE.append('./.bzr-shelf*')
 
83
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
27
84
 
28
85
 
29
86
class cmd_clean_tree(bzrlib.commands.Command):
30
87
    """Remove unwanted files from working tree.
31
 
    Normally, ignored files are left alone.
 
88
 
 
89
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
90
    files are never deleted.
 
91
 
 
92
    Another class is 'detritus', which includes files emitted by bzr during
 
93
    normal operations and selftests.  (The value of these files decreases with
 
94
    time.)
 
95
 
 
96
    If no options are specified, unknown files are deleted.  Otherwise, option
 
97
    flags are respected, and may be combined.
 
98
 
 
99
    To check what clean-tree will do, use --dry-run.
32
100
    """
33
101
    takes_options = [Option('ignored', help='delete all ignored files.'), 
34
 
                     Option('detritus', help='delete conflict files merge'
35
 
                            ' backups, and failed selftest dirs.  (*.THIS, '
36
 
                            '*.BASE, *.OTHER, *~, *.tmp)'), 
 
102
                     Option('detritus', help='delete conflict files, merge'
 
103
                            ' backups, and failed selftest dirs.'), 
 
104
                     Option('unknown', 
 
105
                            help='delete files unknown to bzr.  (default)'),
37
106
                     Option('dry-run', help='show files to delete instead of'
38
107
                            ' deleting them.')]
39
 
    def run(self, ignored=False, detritus=False, dry_run=False):
 
108
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
40
109
        from clean_tree import clean_tree
41
 
        clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
 
110
        if not (unknown or ignored or detritus):
 
111
            unknown = True
 
112
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus, 
 
113
                   dry_run=dry_run)
 
114
 
42
115
 
43
116
class cmd_graph_ancestry(bzrlib.commands.Command):
44
117
    """Produce ancestry graphs using dot.
81
154
                     help="Do not use rsvg to produce antialiased output"), 
82
155
                     Option('merge-branch', type=str, 
83
156
                     help="Use this branch to calcuate a merge base"), 
84
 
                     Option('cluster', help="Use clustered output.")]
 
157
                     Option('cluster', help="Use clustered output."),
 
158
                     Option('max-distance', help="Show no nodes farther than this",
 
159
                            type=int)]
85
160
    def run(self, branch, file, no_collapse=False, no_antialias=False,
86
 
        merge_branch=None, cluster=False):
 
161
        merge_branch=None, cluster=False, max_distance=None):
87
162
        import graph
88
163
        if cluster:
89
164
            ranking = "cluster"
90
165
        else:
91
166
            ranking = "forced"
92
167
        graph.write_ancestry_file(branch, file, not no_collapse, 
93
 
                                  not no_antialias, merge_branch, ranking)
 
168
                                  not no_antialias, merge_branch, ranking, 
 
169
                                  max_distance=max_distance)
 
170
 
94
171
 
95
172
class cmd_fetch_ghosts(bzrlib.commands.Command):
96
173
    """Attempt to retrieve ghosts from another branch.
105
182
 
106
183
strip_help="""Strip the smallest prefix containing num leading slashes  from \
107
184
each file name found in the patch file."""
108
 
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
109
 
                                help="""Handle extra bzr tags""")
 
185
 
 
186
 
110
187
class cmd_patch(bzrlib.commands.Command):
111
188
    """Apply a named patch to the current tree.
112
189
    """
113
190
    takes_args = ['filename?']
114
191
    takes_options = [Option('strip', type=int, help=strip_help)]
115
 
    def run(self, filename=None, strip=-1, bzrdiff=0):
 
192
    def run(self, filename=None, strip=None):
116
193
        from patch import patch
117
194
        from bzrlib.workingtree import WorkingTree
118
195
        wt = WorkingTree.open_containing('.')[0]
119
 
        if strip == -1:
120
 
            if bzrdiff: strip = 0
121
 
            else:       strip = 0
 
196
        if strip is None:
 
197
            strip = 0
 
198
        return patch(wt, filename, strip)
122
199
 
123
 
        return patch(wt, filename, strip, legacy= not bzrdiff)
124
200
 
125
201
class cmd_shelve(bzrlib.commands.Command):
126
202
    """Temporarily set aside some changes from the current tree.
147
223
    you can also unshelve changes in a different order by explicitly
148
224
    specifiying which changes to unshelve. This works best when the changes
149
225
    don't depend on each other.
 
226
 
 
227
    While you have patches on the shelf you can view and manipulate them with
 
228
    the 'shelf' command. Run 'bzr shelf -h' for more info.
150
229
    """
151
230
 
152
231
    takes_args = ['file*']
153
232
    takes_options = ['message', 'revision',
154
 
            Option('all', help='Shelve all changes without prompting')]
 
233
            Option('all', help='Shelve all changes without prompting'), 
 
234
            Option('no-color', help='Never display changes in color')]
155
235
 
156
 
    def run(self, all=False, file_list=None, message=None, revision=None):
 
236
    def run(self, all=False, file_list=None, message=None, revision=None,
 
237
            no_color=False):
157
238
        if revision is not None and revision:
158
239
            if len(revision) == 1:
159
240
                revision = revision[0]
163
244
 
164
245
        source = BzrPatchSource(revision, file_list)
165
246
        s = Shelf(source.base)
166
 
        s.shelve(source, all, message)
 
247
        s.shelve(source, all, message, no_color)
167
248
        return 0
168
249
 
169
250
 
219
300
    def run(self, subcommand, args_list):
220
301
        import sys
221
302
 
 
303
        if args_list is None:
 
304
            args_list = []
222
305
        cmd = self._get_cmd_object(subcommand)
223
306
        source = BzrPatchSource()
224
307
        s = Shelf(source.base)
270
353
        return text
271
354
 
272
355
 
273
 
 
274
356
class cmd_unshelve(bzrlib.commands.Command):
275
357
    """Restore shelved changes.
276
358
 
282
364
    takes_options = [
283
365
            Option('all', help='Unshelve all changes without prompting'),
284
366
            Option('force', help='Force unshelving even if errors occur'),
285
 
    ]
 
367
            Option('no-color', help='Never display changes in color')
 
368
        ]
286
369
    takes_args = ['patch?']
287
 
    def run(self, patch=None, all=False, force=False):
 
370
    def run(self, patch=None, all=False, force=False, no_color=False):
288
371
        source = BzrPatchSource()
289
372
        s = Shelf(source.base)
290
 
        s.unshelve(source, patch, all, force)
 
373
        s.unshelve(source, patch, all, force, no_color)
291
374
        return 0
292
375
 
293
376
 
313
396
        import shell
314
397
        return shell.run_shell()
315
398
 
 
399
 
316
400
class cmd_branch_history(bzrlib.commands.Command):
317
401
    """\
318
402
    Display the development history of a branch.
350
434
    """
351
435
    Create a new checkout, associated with a new repository branch.
352
436
    
353
 
    When you cbranch, bzr looks up the repository associated with your current
354
 
    directory in branches.conf.  It creates a new branch in that repository
355
 
    with the same name and relative path as the checkout you request.
356
 
 
357
 
    The branches.conf parameter is "cbranch_root".  So if you want 
358
 
    cbranch operations in /home/jrandom/bigproject to produce branches in 
359
 
    /home/jrandom/bigproject/repository, you'd add this:
360
 
 
361
 
    [/home/jrandom/bigproject]
362
 
    cbranch_root = /home/jrandom/bigproject/repository
363
 
 
364
 
    Note that if "/home/jrandom/bigproject/repository" isn't a repository,
365
 
    standalone branches will be produced.  Standalone branches will also
366
 
    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.
 
439
 
 
440
    In your locations.conf, add the following lines:
 
441
    [/working_directory_root]
 
442
    cbranch_target = /branch_root
 
443
    cbranch_target:policy = appendpath
 
444
 
 
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"
 
448
 
 
449
    NOTE: cbranch also supports "cbranch_root", but that behaviour is
 
450
    deprecated.
367
451
    """
368
452
    takes_options = [Option("lightweight", 
369
 
                            help="Create a lightweight checkout")]
 
453
                            help="Create a lightweight checkout"), 'revision']
370
454
    takes_args = ["source", "target?"]
371
 
    def run(self, source, target=None, lightweight=False):
 
455
    def run(self, source, target=None, lightweight=False, revision=None):
372
456
        from cbranch import cbranch
373
 
        return cbranch(source, target, lightweight=lightweight)
 
457
        return cbranch(source, target, lightweight=lightweight, 
 
458
                       revision=revision)
374
459
 
375
460
 
376
461
class cmd_branches(bzrlib.commands.Command):
438
523
        from branch_mark import branch_mark
439
524
        branch_mark(mark, branch, delete)
440
525
 
 
526
 
441
527
class cmd_import(bzrlib.commands.Command):
442
 
    """Import sources from a tarball
 
528
    """Import sources from a tarball or zip file
443
529
    
444
 
    This command will import a tarball into a bzr tree, replacing any versioned
445
 
    files already present.  If a directory is specified, it is used as the
446
 
    target.  If the directory does not exist, or is not versioned, it is
447
 
    created.
 
530
    This command will import a tarball or zip file into a bzr tree, replacing
 
531
    any versioned files already present.  If a directory is specified, it is
 
532
    used as the target.  If the directory does not exist, or is not versioned,
 
533
    it is created.
448
534
 
449
535
    Tarballs may be gzip or bzip2 compressed.  This is autodetected.
450
536
 
457
543
        from upstream_import import do_import
458
544
        do_import(source, tree)
459
545
 
460
 
class cmd_shove(bzrlib.commands.Command):
461
 
    """Apply uncommitted changes to another tree
462
 
    
463
 
    This is useful when you start to make changes in one tree, then realize
464
 
    they should really be done in a different tree.
465
 
 
466
 
    Shove is implemented using merge, so:
467
 
     - All changes, including renames and adds, will be applied.
468
 
     - No changes that have already been applied will be applied.
469
 
     - If the target is significantly different from the source, conflicts may
470
 
       be produced.
471
 
    """
472
 
 
473
 
    takes_args = ['target', 'source?']
474
 
    def run(self, target, source='.'):
475
 
        from shove import do_shove
476
 
        do_shove(source, target)
477
546
 
478
547
class cmd_cdiff(bzrlib.commands.Command):
479
548
    """A color version of bzr's diff"""
483
552
        from colordiff import colordiff
484
553
        colordiff(*args, **kwargs)
485
554
 
486
 
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
487
 
            cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
488
 
            cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches, 
489
 
            cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import, cmd_shove,
490
 
            cmd_cdiff]
491
 
 
492
 
 
493
 
commands.append(rspush.cmd_rspush)
494
 
 
495
 
from errors import NoPyBaz
496
 
try:
497
 
    import baz_import
498
 
    commands.append(baz_import.cmd_baz_import_branch)
499
 
    commands.append(baz_import.cmd_baz_import)
500
 
 
501
 
except NoPyBaz:
502
 
    class cmd_baz_import_branch(bzrlib.commands.Command):
503
 
        """Disabled. (Requires PyBaz)"""
504
 
        takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
505
 
        takes_options = ['verbose', Option('max-count', type=int)]
506
 
        def run(self, to_location=None, from_branch=None, fast=False, 
507
 
                max_count=None, verbose=False, dry_run=False,
508
 
                reuse_history_list=[]):
509
 
            print "This command is disabled.  Please install PyBaz."
510
 
 
511
 
 
512
 
    class cmd_baz_import(bzrlib.commands.Command):
513
 
        """Disabled. (Requires PyBaz)"""
514
 
        takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
515
 
        takes_options = ['verbose', Option('prefixes', type=str,
516
 
                         help="Prefixes of branches to import")]
517
 
        def run(self, to_root_dir=None, from_archive=None, verbose=False,
518
 
                reuse_history_list=[], prefixes=None):
519
 
                print "This command is disabled.  Please install PyBaz."
520
 
    commands.extend((cmd_baz_import_branch, cmd_baz_import))
 
555
 
 
556
class cmd_baz_import(bzrlib.commands.Command):
 
557
    """Import an Arch or Baz archive into a bzr repository.
 
558
 
 
559
    This command should be used on local archives (or mirrors) only.  It is
 
560
    quite slow on remote archives.
 
561
    
 
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.
 
567
 
 
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
 
573
 
 
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'
 
579
    are incompatible.
 
580
    """
 
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.')]
 
586
 
 
587
    def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
 
588
            reuse_history_list=[], prefixes=None):
 
589
        from errors import NoPyBaz
 
590
        try:
 
591
            import baz_import
 
592
            baz_import.baz_import(to_root_dir, from_archive, encoding,
 
593
                                  verbose, reuse_history_list, prefixes)
 
594
        except NoPyBaz:
 
595
            print "This command is disabled.  Please install PyBaz."
 
596
 
 
597
 
 
598
class cmd_baz_import_branch(bzrlib.commands.Command):
 
599
    """Import an Arch or Baz branch into a bzr branch.
 
600
 
 
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'
 
606
    are incompatible.
 
607
    """
 
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.')]
 
612
 
 
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
 
617
        try:
 
618
            import baz_import
 
619
            baz_import.baz_import_branch(to_location, from_branch, fast, 
 
620
                                         max_count, verbose, encoding, dry_run,
 
621
                                         reuse_history_list)
 
622
        except NoPyBaz:
 
623
            print "This command is disabled.  Please install PyBaz."
 
624
 
 
625
 
 
626
class cmd_rspush(bzrlib.commands.Command):
 
627
    """Upload this branch to another location using rsync.
 
628
 
 
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. 
 
633
    """
 
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,'
 
638
                            ' just the .bzr.')]
 
639
 
 
640
    def run(self, location=None, overwrite=False, no_tree=False):
 
641
        from bzrlib import workingtree
 
642
        import bzrtools
 
643
        cur_branch = workingtree.WorkingTree.open_containing(".")[0]
 
644
        bzrtools.rspush(cur_branch, location, overwrite=overwrite, 
 
645
                      working_tree=not no_tree)
 
646
 
 
647
 
 
648
class cmd_switch(bzrlib.commands.Command):
 
649
    """Set the branch of a lightweight checkout and update."""
 
650
 
 
651
    takes_args = ['to_location']
 
652
 
 
653
    def run(self, to_location):
 
654
        from switch import cmd_switch
 
655
        cmd_switch().run(to_location)
 
656
 
 
657
 
 
658
commands = [
 
659
            cmd_baz_import,
 
660
            cmd_baz_import_branch,
 
661
            cmd_branches,
 
662
            cmd_branch_history,
 
663
            cmd_branch_mark,
 
664
            cmd_cbranch,  
 
665
            cmd_cdiff,
 
666
            cmd_clean_tree,
 
667
            cmd_fetch_ghosts,
 
668
            cmd_graph_ancestry,
 
669
            cmd_import,
 
670
            cmd_multi_pull,
 
671
            cmd_patch,
 
672
            cmd_rspush,
 
673
            cmd_shelf, 
 
674
            cmd_shell,
 
675
            cmd_shelve, 
 
676
            cmd_switch,
 
677
            cmd_unshelve, 
 
678
            cmd_zap,            
 
679
            ]
521
680
 
522
681
 
523
682
if hasattr(bzrlib.commands, 'register_command'):
530
689
    import tests
531
690
    from doctest import DocTestSuite, ELLIPSIS
532
691
    from unittest import TestSuite
 
692
    import bzrtools
533
693
    import tests.clean_tree
534
 
    import upstream_import
 
694
    import tests.upstream_import
535
695
    import zap
536
696
    import tests.blackbox
537
697
    import tests.shelf_tests
546
706
    result.addTest(tests.test_suite())
547
707
    result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
548
708
    result.addTest(tests.blackbox.test_suite())
549
 
    result.addTest(upstream_import.test_suite())
 
709
    result.addTest(tests.upstream_import.test_suite())
550
710
    result.addTest(zap.test_suite())
551
711
    return result