← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-07-29 19:54:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050729195401-d5191bc202f55b27
- import a version of luke's emacs hooks

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# (C) 2005 Canonical
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
18
17
 
19
18
 
20
19
 
21
 
from xml import XMLMixin
22
 
 
23
 
try:
24
 
    from cElementTree import Element, ElementTree, SubElement
25
 
except ImportError:
26
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
27
 
 
28
 
 
29
 
class Revision(XMLMixin):
 
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=None):
 
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):
30
45
    """Single revision on a branch.
31
46
 
32
47
    Revisions may know their revision_hash, but only once they've been
33
48
    written out.  This is not stored because you cannot write the hash
34
49
    into the file it describes.
35
50
 
36
 
    :todo: Perhaps make predecessor be a child element, not an attribute?
 
51
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
52
 
 
53
    parents
 
54
        List of parent revisions, each is a RevisionReference.
37
55
    """
 
56
    inventory_id = None
 
57
    inventory_sha1 = None
 
58
    revision_id = None
 
59
    timestamp = None
 
60
    message = None
 
61
    timezone = None
 
62
    committer = None
 
63
    
38
64
    def __init__(self, **args):
39
 
        self.inventory_id = None
40
 
        self.revision_id = None
41
 
        self.timestamp = None
42
 
        self.message = None
43
 
        self.timezone = None
44
65
        self.__dict__.update(args)
 
66
        self.parents = []
45
67
 
46
68
 
47
69
    def __repr__(self):
48
 
        if self.revision_id:
49
 
            return "<Revision id %s>" % self.revision_id
 
70
        return "<Revision id %s>" % self.revision_id
50
71
 
51
72
        
52
73
    def to_element(self):
 
74
        from bzrlib.xml import Element, SubElement
 
75
        
53
76
        root = Element('revision',
54
77
                       committer = self.committer,
55
78
                       timestamp = '%.9f' % self.timestamp,
56
79
                       revision_id = self.revision_id,
57
80
                       inventory_id = self.inventory_id,
58
 
                       timezone = str(self.timezone))
59
 
        if self.precursor:
60
 
            root.set('precursor', self.precursor)
 
81
                       inventory_sha1 = self.inventory_sha1,
 
82
                       )
 
83
        if self.timezone:
 
84
            root.set('timezone', str(self.timezone))
61
85
        root.text = '\n'
62
86
        
63
87
        msg = SubElement(root, 'message')
64
88
        msg.text = self.message
65
89
        msg.tail = '\n'
66
90
 
 
91
        if self.parents:
 
92
            pelts = SubElement(root, 'parents')
 
93
            pelts.tail = pelts.text = '\n'
 
94
            for rr in self.parents:
 
95
                assert isinstance(rr, RevisionReference)
 
96
                p = SubElement(pelts, 'revision_ref')
 
97
                p.tail = '\n'
 
98
                assert rr.revision_id
 
99
                p.set('revision_id', rr.revision_id)
 
100
                if rr.revision_sha1:
 
101
                    p.set('revision_sha1', rr.revision_sha1)
 
102
 
67
103
        return root
68
104
 
69
105
 
70
106
    def from_element(cls, elt):
71
 
        # <changeset> is deprecated...
72
 
        if elt.tag not in ('revision', 'changeset'):
73
 
            bailout("unexpected tag in revision file: %r" % elt)
74
 
 
75
 
        cs = cls(committer = elt.get('committer'),
76
 
                 timestamp = float(elt.get('timestamp')),
77
 
                 precursor = elt.get('precursor'),
78
 
                 revision_id = elt.get('revision_id'),
79
 
                 inventory_id = elt.get('inventory_id'))
80
 
 
81
 
        v = elt.get('timezone')
82
 
        cs.timezone = v and int(v)
83
 
 
84
 
        cs.message = elt.findtext('message') # text of <message>
85
 
        return cs
 
107
        return unpack_revision(elt)
86
108
 
87
109
    from_element = classmethod(from_element)
88
110
 
 
111
 
 
112
 
 
113
def unpack_revision(elt):
 
114
    """Convert XML element into Revision object."""
 
115
    # <changeset> is deprecated...
 
116
    from bzrlib.errors import BzrError
 
117
    
 
118
    if elt.tag not in ('revision', 'changeset'):
 
119
        raise BzrError("unexpected tag in revision file: %r" % elt)
 
120
 
 
121
    rev = Revision(committer = elt.get('committer'),
 
122
                   timestamp = float(elt.get('timestamp')),
 
123
                   revision_id = elt.get('revision_id'),
 
124
                   inventory_id = elt.get('inventory_id'),
 
125
                   inventory_sha1 = elt.get('inventory_sha1')
 
126
                   )
 
127
 
 
128
    precursor = elt.get('precursor')
 
129
    precursor_sha1 = elt.get('precursor_sha1')
 
130
 
 
131
    pelts = elt.find('parents')
 
132
 
 
133
    if pelts:
 
134
        for p in pelts:
 
135
            assert p.tag == 'revision_ref', \
 
136
                   "bad parent node tag %r" % p.tag
 
137
            rev_ref = RevisionReference(p.get('revision_id'),
 
138
                                        p.get('revision_sha1'))
 
139
            rev.parents.append(rev_ref)
 
140
 
 
141
        if precursor:
 
142
            # must be consistent
 
143
            prec_parent = rev.parents[0].revision_id
 
144
            assert prec_parent == precursor
 
145
    elif precursor:
 
146
        # revisions written prior to 0.0.5 have a single precursor
 
147
        # give as an attribute
 
148
        rev_ref = RevisionReference(precursor, precursor_sha1)
 
149
        rev.parents.append(rev_ref)
 
150
 
 
151
    v = elt.get('timezone')
 
152
    rev.timezone = v and int(v)
 
153
 
 
154
    rev.message = elt.findtext('message') # text of <message>
 
155
    return rev
 
156
 
 
157
 
 
158
 
 
159
REVISION_ID_RE = None
 
160
 
 
161
def validate_revision_id(rid):
 
162
    """Check rid is syntactically valid for a revision id."""
 
163
    global REVISION_ID_RE
 
164
    if not REVISION_ID_RE:
 
165
        import re
 
166
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
 
167
 
 
168
    if not REVISION_ID_RE.match(rid):
 
169
        raise ValueError("malformed revision-id %r" % rid)
 
170