/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/revision.py

  • Committer: Jelmer Vernooij
  • Date: 2020-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/revision.py
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
# TODO: Some kind of command-line display of revision properties:
 
20
# perhaps show them in log -v and allow them as options to the commit command.
 
21
 
 
22
 
 
23
from .lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
from breezy import bugtracker
 
26
""")
 
27
from . import (
 
28
    errors,
 
29
    osutils,
 
30
    )
 
31
 
 
32
NULL_REVISION = b"null:"
 
33
CURRENT_REVISION = b"current:"
 
34
 
 
35
 
 
36
class Revision(object):
 
37
    """Single revision on a branch.
 
38
 
 
39
    Revisions may know their revision_hash, but only once they've been
 
40
    written out.  This is not stored because you cannot write the hash
 
41
    into the file it describes.
 
42
 
 
43
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
44
 
 
45
    parent_ids
 
46
        List of parent revision_ids
 
47
 
 
48
    properties
 
49
        Dictionary of revision properties.  These are attached to the
 
50
        revision as extra metadata.  The name must be a single
 
51
        word; the value can be an arbitrary string.
 
52
    """
 
53
 
 
54
    def __init__(self, revision_id, properties=None, **args):
 
55
        self.revision_id = revision_id
 
56
        if properties is None:
 
57
            self.properties = {}
 
58
        else:
 
59
            self.properties = properties
 
60
            self._check_properties()
 
61
        self.committer = None
 
62
        self.parent_ids = []
 
63
        self.parent_sha1s = []
 
64
        """Not used anymore - legacy from for 4."""
 
65
        self.__dict__.update(args)
 
66
 
 
67
    def __repr__(self):
 
68
        return "<Revision id %s>" % self.revision_id
 
69
 
 
70
    def __eq__(self, other):
 
71
        if not isinstance(other, Revision):
 
72
            return False
 
73
        return (
 
74
            self.inventory_sha1 == other.inventory_sha1
 
75
            and self.revision_id == other.revision_id
 
76
            and self.timestamp == other.timestamp
 
77
            and self.message == other.message
 
78
            and self.timezone == other.timezone
 
79
            and self.committer == other.committer
 
80
            and self.properties == other.properties
 
81
            and self.parent_ids == other.parent_ids)
 
82
 
 
83
    def __ne__(self, other):
 
84
        return not self.__eq__(other)
 
85
 
 
86
    def _check_properties(self):
 
87
        """Verify that all revision properties are OK."""
 
88
        for name, value in self.properties.items():
 
89
            # GZ 2017-06-10: What sort of string are properties exactly?
 
90
            not_text = not isinstance(name, str)
 
91
            if not_text or osutils.contains_whitespace(name):
 
92
                raise ValueError("invalid property name %r" % name)
 
93
            if not isinstance(value, (str, bytes)):
 
94
                raise ValueError("invalid property value %r for %r" %
 
95
                                 (value, name))
 
96
 
 
97
    def get_history(self, repository):
 
98
        """Return the canonical line-of-history for this revision.
 
99
 
 
100
        If ghosts are present this may differ in result from a ghost-free
 
101
        repository.
 
102
        """
 
103
        current_revision = self
 
104
        reversed_result = []
 
105
        while current_revision is not None:
 
106
            reversed_result.append(current_revision.revision_id)
 
107
            if not len(current_revision.parent_ids):
 
108
                reversed_result.append(None)
 
109
                current_revision = None
 
110
            else:
 
111
                next_revision_id = current_revision.parent_ids[0]
 
112
                current_revision = repository.get_revision(next_revision_id)
 
113
        reversed_result.reverse()
 
114
        return reversed_result
 
115
 
 
116
    def get_summary(self):
 
117
        """Get the first line of the log message for this revision.
 
118
 
 
119
        Return an empty string if message is None.
 
120
        """
 
121
        if self.message:
 
122
            return self.message.lstrip().split('\n', 1)[0]
 
123
        else:
 
124
            return ''
 
125
 
 
126
    def get_apparent_authors(self):
 
127
        """Return the apparent authors of this revision.
 
128
 
 
129
        If the revision properties contain the names of the authors,
 
130
        return them. Otherwise return the committer name.
 
131
 
 
132
        The return value will be a list containing at least one element.
 
133
        """
 
134
        authors = self.properties.get('authors', None)
 
135
        if authors is None:
 
136
            author = self.properties.get('author', self.committer)
 
137
            if author is None:
 
138
                return []
 
139
            return [author]
 
140
        else:
 
141
            return authors.split("\n")
 
142
 
 
143
    def iter_bugs(self):
 
144
        """Iterate over the bugs associated with this revision."""
 
145
        bug_property = self.properties.get('bugs', None)
 
146
        if bug_property is None:
 
147
            return iter([])
 
148
        return bugtracker.decode_bug_urls(bug_property)
 
149
 
 
150
 
 
151
def iter_ancestors(revision_id, revision_source, only_present=False):
 
152
    ancestors = (revision_id,)
 
153
    distance = 0
 
154
    while len(ancestors) > 0:
 
155
        new_ancestors = []
 
156
        for ancestor in ancestors:
 
157
            if not only_present:
 
158
                yield ancestor, distance
 
159
            try:
 
160
                revision = revision_source.get_revision(ancestor)
 
161
            except errors.NoSuchRevision as e:
 
162
                if e.revision == revision_id:
 
163
                    raise
 
164
                else:
 
165
                    continue
 
166
            if only_present:
 
167
                yield ancestor, distance
 
168
            new_ancestors.extend(revision.parent_ids)
 
169
        ancestors = new_ancestors
 
170
        distance += 1
 
171
 
 
172
 
 
173
def find_present_ancestors(revision_id, revision_source):
 
174
    """Return the ancestors of a revision present in a branch.
 
175
 
 
176
    It's possible that a branch won't have the complete ancestry of
 
177
    one of its revisions.
 
178
 
 
179
    """
 
180
    found_ancestors = {}
 
181
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
182
                                        only_present=True))
 
183
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
184
        if anc_id not in found_ancestors:
 
185
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
186
    return found_ancestors
 
187
 
 
188
 
 
189
def __get_closest(intersection):
 
190
    intersection.sort()
 
191
    matches = []
 
192
    for entry in intersection:
 
193
        if entry[0] == intersection[0][0]:
 
194
            matches.append(entry[2])
 
195
    return matches
 
196
 
 
197
 
 
198
def is_reserved_id(revision_id):
 
199
    """Determine whether a revision id is reserved
 
200
 
 
201
    :return: True if the revision is reserved, False otherwise
 
202
    """
 
203
    return isinstance(revision_id, bytes) and revision_id.endswith(b':')
 
204
 
 
205
 
 
206
def check_not_reserved_id(revision_id):
 
207
    """Raise ReservedId if the supplied revision_id is reserved"""
 
208
    if is_reserved_id(revision_id):
 
209
        raise errors.ReservedId(revision_id)
 
210
 
 
211
 
 
212
def ensure_null(revision_id):
 
213
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
214
    if revision_id is None:
 
215
        raise ValueError(
 
216
            'NULL_REVISION should be used for the null'
 
217
            ' revision instead of None.')
 
218
    return revision_id
 
219
 
 
220
 
 
221
def is_null(revision_id):
 
222
    if revision_id is None:
 
223
        raise ValueError('NULL_REVISION should be used for the null'
 
224
                         ' revision instead of None.')
 
225
    return (revision_id == NULL_REVISION)