← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Aaron Bentley
  • Date: 2008-11-23 16:38:39 UTC
  • mto: This revision was merged to the branch mainline in revision 3892.
  • Revision ID: aaron@aaronbentley.com-20081123163839-ew27m17130fz85v6
Update documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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:
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: Some kind of command-line display of revision properties: 
20
18
# perhaps show them in log -v and allow them as options to the commit command.
21
19
 
22
20
 
23
21
from bzrlib.lazy_import import lazy_import
24
22
lazy_import(globals(), """
25
 
from bzrlib import bugtracker
 
23
from bzrlib import deprecated_graph
26
24
""")
27
25
from bzrlib import (
28
26
    errors,
29
27
    symbol_versioning,
30
28
    )
31
29
from bzrlib.osutils import contains_whitespace
 
30
from bzrlib.progress import DummyProgress
32
31
 
33
32
NULL_REVISION="null:"
34
33
CURRENT_REVISION="current:"
48
47
 
49
48
    properties
50
49
        Dictionary of revision properties.  These are attached to the
51
 
        revision as extra metadata.  The name must be a single
 
50
        revision as extra metadata.  The name must be a single 
52
51
        word; the value can be an arbitrary string.
53
52
    """
54
 
 
 
53
    
55
54
    def __init__(self, revision_id, properties=None, **args):
56
55
        self.revision_id = revision_id
57
 
        if properties is None:
58
 
            self.properties = {}
59
 
        else:
60
 
            self.properties = properties
61
 
            self._check_properties()
62
 
        self.committer = None
 
56
        self.properties = properties or {}
 
57
        self._check_properties()
63
58
        self.parent_ids = []
64
59
        self.parent_sha1s = []
65
60
        """Not used anymore - legacy from for 4."""
71
66
    def __eq__(self, other):
72
67
        if not isinstance(other, Revision):
73
68
            return False
 
69
        # FIXME: rbc 20050930 parent_ids are not being compared
74
70
        return (
75
71
                self.inventory_sha1 == other.inventory_sha1
76
72
                and self.revision_id == other.revision_id
78
74
                and self.message == other.message
79
75
                and self.timezone == other.timezone
80
76
                and self.committer == other.committer
81
 
                and self.properties == other.properties
82
 
                and self.parent_ids == other.parent_ids)
 
77
                and self.properties == other.properties)
83
78
 
84
79
    def __ne__(self, other):
85
80
        return not self.__eq__(other)
90
85
            if not isinstance(name, basestring) or contains_whitespace(name):
91
86
                raise ValueError("invalid property name %r" % name)
92
87
            if not isinstance(value, basestring):
93
 
                raise ValueError("invalid property value %r for %r" %
94
 
                                 (value, name))
 
88
                raise ValueError("invalid property value %r for %r" % 
 
89
                                 (name, value))
95
90
 
96
91
    def get_history(self, repository):
97
92
        """Return the canonical line-of-history for this revision.
114
109
 
115
110
    def get_summary(self):
116
111
        """Get the first line of the log message for this revision.
117
 
 
118
 
        Return an empty string if message is None.
119
 
        """
120
 
        if self.message:
121
 
            return self.message.lstrip().split('\n', 1)[0]
122
 
        else:
123
 
            return ''
124
 
 
125
 
    def get_apparent_authors(self):
126
 
        """Return the apparent authors of this revision.
127
 
 
128
 
        If the revision properties contain the names of the authors,
129
 
        return them. Otherwise return the committer name.
130
 
 
131
 
        The return value will be a list containing at least one element.
132
 
        """
133
 
        authors = self.properties.get('authors', None)
134
 
        if authors is None:
135
 
            author = self.properties.get('author', self.committer)
136
 
            if author is None:
137
 
                return []
138
 
            return [author]
139
 
        else:
140
 
            return authors.split("\n")
141
 
 
142
 
    def iter_bugs(self):
143
 
        """Iterate over the bugs associated with this revision."""
144
 
        bug_property = self.properties.get('bugs', None)
145
 
        if bug_property is None:
146
 
            return
147
 
        for line in bug_property.splitlines():
148
 
            try:
149
 
                url, status = line.split(None, 2)
150
 
            except ValueError:
151
 
                raise errors.InvalidLineInBugsProperty(line)
152
 
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
153
 
                raise errors.InvalidBugStatus(status)
154
 
            yield url, status
 
112
        """
 
113
        return self.message.lstrip().split('\n', 1)[0]
 
114
 
 
115
    def get_apparent_author(self):
 
116
        """Return the apparent author of this revision.
 
117
 
 
118
        If the revision properties contain the author name,
 
119
        return it. Otherwise return the committer name.
 
120
        """
 
121
        return self.properties.get('author', self.committer)
155
122
 
156
123
 
157
124
def iter_ancestors(revision_id, revision_source, only_present=False):
166
133
                revision = revision_source.get_revision(ancestor)
167
134
            except errors.NoSuchRevision, e:
168
135
                if e.revision == revision_id:
169
 
                    raise
 
136
                    raise 
170
137
                else:
171
138
                    continue
172
139
            if only_present:
180
147
    """Return the ancestors of a revision present in a branch.
181
148
 
182
149
    It's possible that a branch won't have the complete ancestry of
183
 
    one of its revisions.
 
150
    one of its revisions.  
184
151
 
185
152
    """
186
153
    found_ancestors = {}
190
157
        if anc_id not in found_ancestors:
191
158
            found_ancestors[anc_id] = (anc_order, anc_distance)
192
159
    return found_ancestors
193
 
 
 
160
    
194
161
 
195
162
def __get_closest(intersection):
196
163
    intersection.sort()
197
 
    matches = []
 
164
    matches = [] 
198
165
    for entry in intersection:
199
166
        if entry[0] == intersection[0][0]:
200
167
            matches.append(entry[2])
204
171
def is_reserved_id(revision_id):
205
172
    """Determine whether a revision id is reserved
206
173
 
207
 
    :return: True if the revision is reserved, False otherwise
 
174
    :return: True if the revision is is reserved, False otherwise
208
175
    """
209
176
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
210
177