/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 bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-06-28 05:33:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050628053340-ea73b03fbcde9c46
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
  called as needed.  

- Avoid importing xml and ElementTree library unless needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
 
1
# (C) 2005 Canonical
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
 
 
19
 
 
20
class RevisionReference(object):
 
21
    """
 
22
    Reference to a stored revision.
 
23
 
 
24
    Includes the revision_id and revision_sha1.
 
25
    """
 
26
    revision_id = None
 
27
    revision_sha1 = None
 
28
    def __init__(self, revision_id, revision_sha1):
 
29
        if revision_id == None \
 
30
           or isinstance(revision_id, basestring):
 
31
            self.revision_id = revision_id
 
32
        else:
 
33
            raise ValueError('bad revision_id %r' % revision_id)
 
34
 
 
35
        if revision_sha1 != None:
 
36
            if isinstance(revision_sha1, basestring) \
 
37
               and len(revision_sha1) == 40:
 
38
                self.revision_sha1 = revision_sha1
 
39
            else:
 
40
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
 
41
                
 
42
 
 
43
 
 
44
class Revision(object):
 
45
    """Single revision on a branch.
 
46
 
 
47
    Revisions may know their revision_hash, but only once they've been
 
48
    written out.  This is not stored because you cannot write the hash
 
49
    into the file it describes.
 
50
 
 
51
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
52
    To support old clients this is written out in a slightly redundant
 
53
    form: the first parent as the predecessor.  This will eventually
 
54
    be dropped.
 
55
 
 
56
    parents
 
57
        List of parent revisions, each is a RevisionReference.
 
58
    """
 
59
    inventory_id = None
 
60
    inventory_sha1 = None
 
61
    revision_id = None
 
62
    timestamp = None
 
63
    message = None
 
64
    timezone = None
 
65
    committer = None
 
66
    
 
67
    def __init__(self, **args):
 
68
        self.__dict__.update(args)
 
69
        self.parents = []
 
70
 
 
71
    def _get_precursor(self):
 
72
        from warnings import warn
 
73
        warn("Revision.precursor is deprecated", stacklevel=2)
 
74
        if self.parents:
 
75
            return self.parents[0].revision_id
 
76
        else:
 
77
            return None
 
78
 
 
79
 
 
80
    def _get_precursor_sha1(self):
 
81
        from warnings import warn
 
82
        warn("Revision.precursor_sha1 is deprecated", stacklevel=2)
 
83
        if self.parents:
 
84
            return self.parents[0].revision_sha1
 
85
        else:
 
86
            return None    
 
87
 
 
88
 
 
89
    def _fail(self):
 
90
        raise Exception("can't assign to precursor anymore")
 
91
 
 
92
 
 
93
    precursor = property(_get_precursor, _fail, _fail)
 
94
    precursor_sha1 = property(_get_precursor_sha1, _fail, _fail)
 
95
 
 
96
 
 
97
 
 
98
    def __repr__(self):
 
99
        return "<Revision id %s>" % self.revision_id
 
100
 
 
101
        
 
102
    def to_element(self):
 
103
        from bzrlib.xml import Element, SubElement
 
104
        
 
105
        root = Element('revision',
 
106
                       committer = self.committer,
 
107
                       timestamp = '%.9f' % self.timestamp,
 
108
                       revision_id = self.revision_id,
 
109
                       inventory_id = self.inventory_id,
 
110
                       inventory_sha1 = self.inventory_sha1,
 
111
                       )
 
112
        if self.timezone:
 
113
            root.set('timezone', str(self.timezone))
 
114
        root.text = '\n'
 
115
        
 
116
        msg = SubElement(root, 'message')
 
117
        msg.text = self.message
 
118
        msg.tail = '\n'
 
119
 
 
120
        if self.parents:
 
121
            # first parent stored as precursor for compatability with 0.0.5 and
 
122
            # earlier
 
123
            pr = self.parents[0]
 
124
            assert pr.revision_id
 
125
            root.set('precursor', pr.revision_id)
 
126
            if pr.revision_sha1:
 
127
                root.set('precursor_sha1', pr.revision_sha1)
 
128
                
 
129
        if self.parents:
 
130
            pelts = SubElement(root, 'parents')
 
131
            pelts.tail = pelts.text = '\n'
 
132
            for rr in self.parents:
 
133
                assert isinstance(rr, RevisionReference)
 
134
                p = SubElement(pelts, 'revision_ref')
 
135
                p.tail = '\n'
 
136
                assert rr.revision_id
 
137
                p.set('revision_id', rr.revision_id)
 
138
                if rr.revision_sha1:
 
139
                    p.set('revision_sha1', rr.revision_sha1)
 
140
 
 
141
        return root
 
142
 
 
143
 
 
144
    def from_element(cls, elt):
 
145
        return unpack_revision(elt)
 
146
 
 
147
    from_element = classmethod(from_element)
 
148
 
 
149
 
 
150
 
 
151
def unpack_revision(elt):
 
152
    """Convert XML element into Revision object."""
 
153
    # <changeset> is deprecated...
 
154
    from bzrlib.errors import BzrError
 
155
    
 
156
    if elt.tag not in ('revision', 'changeset'):
 
157
        raise BzrError("unexpected tag in revision file: %r" % elt)
 
158
 
 
159
    rev = Revision(committer = elt.get('committer'),
 
160
                   timestamp = float(elt.get('timestamp')),
 
161
                   revision_id = elt.get('revision_id'),
 
162
                   inventory_id = elt.get('inventory_id'),
 
163
                   inventory_sha1 = elt.get('inventory_sha1')
 
164
                   )
 
165
 
 
166
    precursor = elt.get('precursor')
 
167
    precursor_sha1 = elt.get('precursor_sha1')
 
168
 
 
169
    pelts = elt.find('parents')
 
170
 
 
171
    if precursor:
 
172
        # revisions written prior to 0.0.5 have a single precursor
 
173
        # give as an attribute
 
174
        rev_ref = RevisionReference(precursor, precursor_sha1)
 
175
        rev.parents.append(rev_ref)
 
176
    elif pelts:
 
177
        for p in pelts:
 
178
            assert p.tag == 'revision_ref', \
 
179
                   "bad parent node tag %r" % p.tag
 
180
            rev_ref = RevisionReference(p.get('revision_id'),
 
181
                                        p.get('revision_sha1'))
 
182
            rev.parents.append(rev_ref)
 
183
 
 
184
    v = elt.get('timezone')
 
185
    rev.timezone = v and int(v)
 
186
 
 
187
    rev.message = elt.findtext('message') # text of <message>
 
188
    return rev