~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Aaron Bentley
  • Date: 2006-07-31 17:42:48 UTC
  • Revision ID: abentley@panoramicfeedback.com-20060731174248-3ae47c0d23759f76
Add bug report

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
 
 
1
#!/usr/bin/python
19
2
"""\
20
3
Various useful plugins for working with bzr.
21
4
"""
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
 
5
import rspush
 
6
from errors import CommandError
66
7
from patchsource import BzrPatchSource
67
8
from shelf import Shelf
 
9
from switch import cmd_switch
68
10
import sys
69
11
import os.path
70
12
 
71
13
import bzrlib.builtins
 
14
import bzrlib.branch
72
15
import bzrlib.commands
73
16
from bzrlib.commands import get_cmd_object
74
17
from bzrlib.errors import BzrCommandError
78
21
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__), 
79
22
                                                 "external")))
80
23
 
81
 
import show_paths
82
 
 
83
 
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
 
24
bzrlib.ignores.add_runtime_ignores(['./.shelf', './.bzr-shelf*'])
84
25
 
85
26
 
86
27
class cmd_clean_tree(bzrlib.commands.Command):
112
53
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus, 
113
54
                   dry_run=dry_run)
114
55
 
115
 
 
116
56
class cmd_graph_ancestry(bzrlib.commands.Command):
117
57
    """Produce ancestry graphs using dot.
118
58
    
165
105
        graph.write_ancestry_file(branch, file, not no_collapse, 
166
106
                                  not no_antialias, merge_branch, ranking)
167
107
 
168
 
 
169
108
class cmd_fetch_ghosts(bzrlib.commands.Command):
170
109
    """Attempt to retrieve ghosts from another branch.
171
110
    If the other branch is not supplied, the last-pulled branch is used.
179
118
 
180
119
strip_help="""Strip the smallest prefix containing num leading slashes  from \
181
120
each file name found in the patch file."""
182
 
 
183
 
 
 
121
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
 
122
                                help="""Handle extra bzr tags""")
184
123
class cmd_patch(bzrlib.commands.Command):
185
124
    """Apply a named patch to the current tree.
186
125
    """
187
126
    takes_args = ['filename?']
188
127
    takes_options = [Option('strip', type=int, help=strip_help)]
189
 
    def run(self, filename=None, strip=None):
 
128
    def run(self, filename=None, strip=-1, bzrdiff=0):
190
129
        from patch import patch
191
130
        from bzrlib.workingtree import WorkingTree
192
131
        wt = WorkingTree.open_containing('.')[0]
193
 
        if strip is None:
194
 
            strip = 0
195
 
        return patch(wt, filename, strip)
 
132
        if strip == -1:
 
133
            if bzrdiff: strip = 0
 
134
            else:       strip = 0
196
135
 
 
136
        return patch(wt, filename, strip, legacy= not bzrdiff)
197
137
 
198
138
class cmd_shelve(bzrlib.commands.Command):
199
139
    """Temporarily set aside some changes from the current tree.
220
160
    you can also unshelve changes in a different order by explicitly
221
161
    specifiying which changes to unshelve. This works best when the changes
222
162
    don't depend on each other.
223
 
 
224
 
    While you have patches on the shelf you can view and manipulate them with
225
 
    the 'shelf' command. Run 'bzr shelf -h' for more info.
226
163
    """
227
164
 
228
165
    takes_args = ['file*']
229
166
    takes_options = ['message', 'revision',
230
 
            Option('all', help='Shelve all changes without prompting'), 
231
 
            Option('no-color', help='Never display changes in color')]
 
167
            Option('all', help='Shelve all changes without prompting')]
232
168
 
233
 
    def run(self, all=False, file_list=None, message=None, revision=None,
234
 
            no_color=False):
 
169
    def run(self, all=False, file_list=None, message=None, revision=None):
235
170
        if revision is not None and revision:
236
171
            if len(revision) == 1:
237
172
                revision = revision[0]
241
176
 
242
177
        source = BzrPatchSource(revision, file_list)
243
178
        s = Shelf(source.base)
244
 
        s.shelve(source, all, message, no_color)
 
179
        s.shelve(source, all, message)
245
180
        return 0
246
181
 
247
182
 
297
232
    def run(self, subcommand, args_list):
298
233
        import sys
299
234
 
300
 
        if args_list is None:
301
 
            args_list = []
302
235
        cmd = self._get_cmd_object(subcommand)
303
236
        source = BzrPatchSource()
304
237
        s = Shelf(source.base)
350
283
        return text
351
284
 
352
285
 
 
286
 
353
287
class cmd_unshelve(bzrlib.commands.Command):
354
288
    """Restore shelved changes.
355
289
 
361
295
    takes_options = [
362
296
            Option('all', help='Unshelve all changes without prompting'),
363
297
            Option('force', help='Force unshelving even if errors occur'),
364
 
            Option('no-color', help='Never display changes in color')
365
 
        ]
 
298
    ]
366
299
    takes_args = ['patch?']
367
 
    def run(self, patch=None, all=False, force=False, no_color=False):
 
300
    def run(self, patch=None, all=False, force=False):
368
301
        source = BzrPatchSource()
369
302
        s = Shelf(source.base)
370
 
        s.unshelve(source, patch, all, force, no_color)
 
303
        s.unshelve(source, patch, all, force)
371
304
        return 0
372
305
 
373
306
 
393
326
        import shell
394
327
        return shell.run_shell()
395
328
 
396
 
 
397
329
class cmd_branch_history(bzrlib.commands.Command):
398
330
    """\
399
331
    Display the development history of a branch.
432
364
    Create a new checkout, associated with a new repository branch.
433
365
    
434
366
    When you cbranch, bzr looks up the repository associated with your current
435
 
    directory in locations.conf.  It creates a new branch in that repository
 
367
    directory in branches.conf.  It creates a new branch in that repository
436
368
    with the same name and relative path as the checkout you request.
437
369
 
438
 
    The locations.conf parameter is "cbranch_root".  So if you want 
 
370
    The branches.conf parameter is "cbranch_root".  So if you want 
439
371
    cbranch operations in /home/jrandom/bigproject to produce branches in 
440
372
    /home/jrandom/bigproject/repository, you'd add this:
441
373
 
520
452
        from branch_mark import branch_mark
521
453
        branch_mark(mark, branch, delete)
522
454
 
523
 
 
524
455
class cmd_import(bzrlib.commands.Command):
525
456
    """Import sources from a tarball
526
457
    
540
471
        from upstream_import import do_import
541
472
        do_import(source, tree)
542
473
 
 
474
class cmd_shove(bzrlib.commands.Command):
 
475
    """Apply uncommitted changes to another tree
 
476
    
 
477
    This is useful when you start to make changes in one tree, then realize
 
478
    they should really be done in a different tree.
 
479
 
 
480
    Shove is implemented using merge, so:
 
481
     - All changes, including renames and adds, will be applied.
 
482
     - No changes that have already been applied will be applied.
 
483
     - If the target is significantly different from the source, conflicts may
 
484
       be produced.
 
485
    """
 
486
 
 
487
    takes_args = ['target', 'source?']
 
488
    def run(self, target, source='.'):
 
489
        from shove import do_shove
 
490
        do_shove(source, target)
543
491
 
544
492
class cmd_cdiff(bzrlib.commands.Command):
545
493
    """A color version of bzr's diff"""
549
497
        from colordiff import colordiff
550
498
        colordiff(*args, **kwargs)
551
499
 
552
 
 
553
 
class cmd_baz_import(bzrlib.commands.Command):
554
 
    """Import an Arch or Baz archive into a bzr repository.
555
 
 
556
 
    This command should be used on local archives (or mirrors) only.  It is
557
 
    quite slow on remote archives.
558
 
    
559
 
    reuse_history allows you to specify any previous imports you 
560
 
    have done of different archives, which this archive has branches
561
 
    tagged from. This will dramatically reduce the time to convert 
562
 
    the archive as it will not have to convert the history already
563
 
    converted in that other branch.
564
 
 
565
 
    If you specify prefixes, only branches whose names start with that prefix
566
 
    will be imported.  Skipped branches will be listed, so you can import any
567
 
    branches you missed by accident.  Here's an example of doing a partial
568
 
    import from thelove@canonical.com:
569
 
    bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
570
 
 
571
 
    WARNING: Encoding should not be specified unless necessary, because if you
572
 
    specify an encoding, your converted branch will not interoperate with
573
 
    independently-converted branches, unless the other branches were converted
574
 
    with exactly the same encoding.  Any encoding recognized by Python may
575
 
    be specified.  Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
576
 
    are incompatible.
577
 
    """
578
 
    takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
579
 
    takes_options = ['verbose', Option('prefixes', type=str,
580
 
                     help="Prefixes of branches to import, colon-separated"),
581
 
                     Option('encoding', type=str, 
582
 
                     help='Force encoding to specified value.  See WARNING.')]
583
 
 
584
 
    def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
585
 
            reuse_history_list=[], prefixes=None):
586
 
        from errors import NoPyBaz
587
 
        try:
588
 
            import baz_import
589
 
            baz_import.baz_import(to_root_dir, from_archive, encoding,
590
 
                                  verbose, reuse_history_list, prefixes)
591
 
        except NoPyBaz:
592
 
            print "This command is disabled.  Please install PyBaz."
593
 
 
594
 
 
595
 
class cmd_baz_import_branch(bzrlib.commands.Command):
596
 
    """Import an Arch or Baz branch into a bzr branch.
597
 
 
598
 
    WARNING: Encoding should not be specified unless necessary, because if you
599
 
    specify an encoding, your converted branch will not interoperate with
600
 
    independently-converted branches, unless the other branches were converted
601
 
    with exactly the same encoding.  Any encoding recognized by Python may
602
 
    be specified.  Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
603
 
    are incompatible.
604
 
    """
605
 
    takes_args = ['to_location', 'from_branch?', 'reuse_history*']
606
 
    takes_options = ['verbose', Option('max-count', type=int),
607
 
                     Option('encoding', type=str, 
608
 
                     help='Force encoding to specified value.  See WARNING.')]
609
 
 
610
 
    def run(self, to_location, from_branch=None, fast=False, max_count=None,
611
 
            encoding=None, verbose=False, dry_run=False,
612
 
            reuse_history_list=[]):
613
 
        from errors import NoPyBaz
614
 
        try:
615
 
            import baz_import
616
 
            baz_import.baz_import_branch(to_location, from_branch, fast, 
617
 
                                         max_count, verbose, encoding, dry_run,
618
 
                                         reuse_history_list)
619
 
        except NoPyBaz:
620
 
            print "This command is disabled.  Please install PyBaz."
621
 
 
622
 
 
623
 
class cmd_rspush(bzrlib.commands.Command):
624
 
    """Upload this branch to another location using rsync.
625
 
 
626
 
    If no location is specified, the last-used location will be used.  To 
627
 
    prevent dirty trees from being uploaded, rspush will error out if there are 
628
 
    unknown files or local changes.  It will also error out if the upstream 
629
 
    directory is non-empty and not an earlier version of the branch. 
630
 
    """
631
 
    takes_args = ['location?']
632
 
    takes_options = [Option('overwrite', help='Ignore differences between'
633
 
                            ' branches and overwrite unconditionally'),
634
 
                     Option('no-tree', help='Do not push the working tree,'
635
 
                            ' just the .bzr.')]
636
 
 
637
 
    def run(self, location=None, overwrite=False, no_tree=False):
638
 
        from bzrlib import workingtree
639
 
        import bzrtools
640
 
        cur_branch = workingtree.WorkingTree.open_containing(".")[0]
641
 
        bzrtools.rspush(cur_branch, location, overwrite=overwrite, 
642
 
                      working_tree=not no_tree)
643
 
 
644
 
 
645
 
class cmd_switch(bzrlib.commands.Command):
646
 
    """Set the branch of a lightweight checkout and update."""
647
 
 
648
 
    takes_args = ['to_location']
649
 
 
650
 
    def run(self, to_location):
651
 
        from switch import cmd_switch
652
 
        cmd_switch().run(to_location)
653
 
 
654
 
 
655
 
commands = [
656
 
            cmd_baz_import,
657
 
            cmd_baz_import_branch,
658
 
            cmd_branches,
659
 
            cmd_branch_history,
660
 
            cmd_branch_mark,
661
 
            cmd_cbranch,  
662
 
            cmd_cdiff,
663
 
            cmd_clean_tree,
664
 
            cmd_fetch_ghosts,
665
 
            cmd_graph_ancestry,
666
 
            cmd_import,
667
 
            cmd_multi_pull,
668
 
            cmd_patch,
669
 
            cmd_rspush,
670
 
            cmd_shelf, 
671
 
            cmd_shell,
672
 
            cmd_shelve, 
673
 
            cmd_switch,
674
 
            cmd_unshelve, 
675
 
            cmd_zap,            
676
 
            ]
 
500
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
 
501
            cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
 
502
            cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches, 
 
503
            cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import, cmd_shove,
 
504
            cmd_cdiff]
 
505
 
 
506
 
 
507
commands.append(rspush.cmd_rspush)
 
508
 
 
509
from errors import NoPyBaz
 
510
try:
 
511
    import baz_import
 
512
    commands.append(baz_import.cmd_baz_import_branch)
 
513
    commands.append(baz_import.cmd_baz_import)
 
514
 
 
515
except NoPyBaz:
 
516
    class cmd_baz_import_branch(bzrlib.commands.Command):
 
517
        """Disabled. (Requires PyBaz)"""
 
518
        takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
 
519
        takes_options = ['verbose', Option('max-count', type=int)]
 
520
        def run(self, to_location=None, from_branch=None, fast=False, 
 
521
                max_count=None, verbose=False, dry_run=False,
 
522
                reuse_history_list=[]):
 
523
            print "This command is disabled.  Please install PyBaz."
 
524
 
 
525
 
 
526
    class cmd_baz_import(bzrlib.commands.Command):
 
527
        """Disabled. (Requires PyBaz)"""
 
528
        takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
 
529
        takes_options = ['verbose', Option('prefixes', type=str,
 
530
                         help="Prefixes of branches to import")]
 
531
        def run(self, to_root_dir=None, from_archive=None, verbose=False,
 
532
                reuse_history_list=[], prefixes=None):
 
533
                print "This command is disabled.  Please install PyBaz."
 
534
    commands.extend((cmd_baz_import_branch, cmd_baz_import))
677
535
 
678
536
 
679
537
if hasattr(bzrlib.commands, 'register_command'):
686
544
    import tests
687
545
    from doctest import DocTestSuite, ELLIPSIS
688
546
    from unittest import TestSuite
689
 
    import bzrtools
690
547
    import tests.clean_tree
691
548
    import upstream_import
692
549
    import zap