← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge_directive.py

Add a NEWS entry and prepare submission.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge_directive.py
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
from StringIO import StringIO
19
19
import re
20
20
 
21
 
from bzrlib import lazy_import
22
 
lazy_import.lazy_import(globals(), """
23
21
from bzrlib import (
24
22
    branch as _mod_branch,
25
23
    diff,
26
 
    email_message,
27
24
    errors,
28
25
    gpg,
29
26
    hooks,
37
34
from bzrlib.bundle import (
38
35
    serializer as bundle_serializer,
39
36
    )
40
 
""")
 
37
from bzrlib.email_message import EmailMessage
41
38
 
42
39
 
43
40
class MergeRequestBodyParams(object):
59
56
    """Hooks for MergeDirective classes."""
60
57
 
61
58
    def __init__(self):
62
 
        hooks.Hooks.__init__(self, "bzrlib.merge_directive", "BaseMergeDirective.hooks")
63
 
        self.add_hook('merge_request_body',
 
59
        hooks.Hooks.__init__(self)
 
60
        self.create_hook(hooks.HookPoint('merge_request_body',
64
61
            "Called with a MergeRequestBodyParams when a body is needed for"
65
62
            " a merge request.  Callbacks must return a body.  If more"
66
63
            " than one callback is registered, the output of one callback is"
67
 
            " provided to the next.", (1, 15, 0))
68
 
 
69
 
 
70
 
class BaseMergeDirective(object):
71
 
    """A request to perform a merge into a branch.
72
 
 
73
 
    This is the base class that all merge directive implementations 
74
 
    should derive from.
75
 
 
76
 
    :cvar multiple_output_files: Whether or not this merge directive 
77
 
        stores a set of revisions in more than one file
78
 
    """
 
64
            " provided to the next.", (1, 15, 0), False))
 
65
 
 
66
 
 
67
class _BaseMergeDirective(object):
79
68
 
80
69
    hooks = MergeDirectiveHooks()
81
70
 
82
 
    multiple_output_files = False
83
 
 
84
71
    def __init__(self, revision_id, testament_sha1, time, timezone,
85
72
                 target_branch, patch=None, source_branch=None, message=None,
86
73
                 bundle=None):
105
92
        self.source_branch = source_branch
106
93
        self.message = message
107
94
 
108
 
    def to_lines(self):
109
 
        """Serialize as a list of lines
110
 
 
111
 
        :return: a list of lines
112
 
        """
113
 
        raise NotImplementedError(self.to_lines)
114
 
 
115
 
    def to_files(self):
116
 
        """Serialize as a set of files.
117
 
 
118
 
        :return: List of tuples with filename and contents as lines
119
 
        """
120
 
        raise NotImplementedError(self.to_files)
121
 
 
122
 
    def get_raw_bundle(self):
123
 
        """Return the bundle for this merge directive.
124
 
 
125
 
        :return: bundle text or None if there is no bundle
126
 
        """
127
 
        return None
128
 
 
129
95
    def _to_lines(self, base_revision=False):
130
96
        """Serialize as a list of lines
131
97
 
145
111
        lines.append('# \n')
146
112
        return lines
147
113
 
148
 
    def write_to_directory(self, path):
149
 
        """Write this merge directive to a series of files in a directory.
150
 
 
151
 
        :param path: Filesystem path to write to
152
 
        """
153
 
        raise NotImplementedError(self.write_to_directory)
154
 
 
155
114
    @classmethod
156
115
    def from_objects(klass, repository, revision_id, time, timezone,
157
116
                 target_branch, patch_type='bundle',
266
225
            body = self.to_signed(branch)
267
226
        else:
268
227
            body = ''.join(self.to_lines())
269
 
        message = email_message.EmailMessage(mail_from, mail_to, subject,
270
 
            body)
 
228
        message = EmailMessage(mail_from, mail_to, subject, body)
271
229
        return message
272
230
 
273
231
    def install_revisions(self, target_repo):
345
303
                                          basename, body)
346
304
 
347
305
 
348
 
class MergeDirective(BaseMergeDirective):
 
306
class MergeDirective(_BaseMergeDirective):
349
307
 
350
308
    """A request to perform a merge into a branch.
351
309
 
380
338
        :param source_branch: A public location to merge the revision from
381
339
        :param message: The message to use when committing this merge
382
340
        """
383
 
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
 
341
        _BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
384
342
            timezone, target_branch, patch, source_branch, message)
385
343
        if patch_type not in (None, 'diff', 'bundle'):
386
344
            raise ValueError(patch_type)
470
428
        return None, self.revision_id, 'inapplicable'
471
429
 
472
430
 
473
 
class MergeDirective2(BaseMergeDirective):
 
431
class MergeDirective2(_BaseMergeDirective):
474
432
 
475
433
    _format_string = 'Bazaar merge directive format 2 (Bazaar 0.90)'
476
434
 
479
437
                 bundle=None, base_revision_id=None):
480
438
        if source_branch is None and bundle is None:
481
439
            raise errors.NoMergeSource()
482
 
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
 
440
        _BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
483
441
            timezone, target_branch, patch, source_branch, message)
484
442
        self.bundle = bundle
485
443
        self.base_revision_id = base_revision_id