~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weavefile.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
#
17
17
# Author: Martin Pool <mbp@canonical.com>
18
18
 
19
 
 
20
 
 
21
 
 
22
19
"""Store and retrieve weaves in files.
23
20
 
24
21
There is one format marker followed by a blank line, followed by a
37
34
line contains a newline, or ',' if not.
38
35
"""
39
36
 
 
37
from __future__ import absolute_import
 
38
 
40
39
# TODO: When extracting a single version it'd be enough to just pass
41
40
# an iterator returning the weave lines...  We don't really need to
42
41
# deserialize it into memory.
45
44
 
46
45
 
47
46
def write_weave(weave, f, format=None):
48
 
    if format == None or format == 1:
 
47
    if format is None or format == 1:
49
48
        return write_weave_v5(weave, f)
50
49
    else:
51
50
        raise ValueError("unknown weave format %r" % format)
53
52
 
54
53
def write_weave_v5(weave, f):
55
54
    """Write weave to file f."""
56
 
    print >>f, FORMAT_1,
 
55
    f.write(FORMAT_1)
57
56
 
58
57
    for version, included in enumerate(weave._parents):
59
58
        if included:
60
59
            # mininc = weave.minimal_parents(version)
61
60
            mininc = included
62
 
            print >>f, 'i',
63
 
            for i in mininc:
64
 
                print >>f, i,
65
 
            print >>f
 
61
            f.write('i ')
 
62
            f.write(' '.join(str(i) for i in mininc))
 
63
            f.write('\n')
66
64
        else:
67
 
            print >>f, 'i'
68
 
        print >>f, '1', weave._sha1s[version]
69
 
        print >>f, 'n', weave._names[version]
70
 
        print >>f
 
65
            f.write('i\n')
 
66
        f.write('1 ' + weave._sha1s[version] + '\n')
 
67
        f.write('n ' + weave._names[version] + '\n')
 
68
        f.write('\n')
71
69
 
72
 
    print >>f, 'w'
 
70
    f.write('w\n')
73
71
 
74
72
    for l in weave._weave:
75
73
        if isinstance(l, tuple):
76
 
            assert l[0] in '{}[]'
77
74
            if l[0] == '}':
78
 
                print >>f, '}'
 
75
                f.write('}\n')
79
76
            else:
80
 
                print >>f, '%s %d' % l
 
77
                f.write('%s %d\n' % l)
81
78
        else: # text line
82
79
            if not l:
83
 
                print >>f, ', '
 
80
                f.write(', \n')
84
81
            elif l[-1] == '\n':
85
 
                assert l.find('\n', 0, -1) == -1
86
 
                print >>f, '.', l,
 
82
                f.write('. ' + l)
87
83
            else:
88
 
                assert l.find('\n') == -1
89
 
                print >>f, ',', l
90
 
 
91
 
    print >>f, 'W'
92
 
 
93
 
 
94
 
 
95
 
def read_weave(f,prelude=False):
96
 
    return read_weave_v5(f,prelude=prelude)
97
 
 
98
 
 
99
 
def read_weave_v5(f,prelude=False):
100
 
    from weave import Weave, WeaveFormatError
 
84
                f.write(', ' + l + '\n')
 
85
 
 
86
    f.write('W\n')
 
87
 
 
88
 
 
89
 
 
90
def read_weave(f):
 
91
    # FIXME: detect the weave type and dispatch
 
92
    from bzrlib.weave import Weave
101
93
    w = Weave(getattr(f, 'name', None))
102
 
 
103
 
    l = f.readline()
 
94
    _read_weave_v5(f, w)
 
95
    return w
 
96
 
 
97
 
 
98
def _read_weave_v5(f, w):
 
99
    """Private helper routine to read a weave format 5 file into memory.
 
100
 
 
101
    This is only to be used by read_weave and WeaveFile.__init__.
 
102
    """
 
103
    #  200   0   2075.5080   1084.0360   bzrlib.weavefile:104(_read_weave_v5)
 
104
    # +60412 0    366.5900    366.5900   +<method 'readline' of 'file' objects>
 
105
    # +59982 0    320.5280    320.5280   +<method 'startswith' of 'str' objects>
 
106
    # +59363 0    297.8080    297.8080   +<method 'append' of 'list' objects>
 
107
    # replace readline call with iter over all lines ->
 
108
    # safe because we already suck on memory.
 
109
    #  200   0   1492.7170    802.6220   bzrlib.weavefile:104(_read_weave_v5)
 
110
    # +59982 0    329.9100    329.9100   +<method 'startswith' of 'str' objects>
 
111
    # +59363 0    320.2980    320.2980   +<method 'append' of 'list' objects>
 
112
    # replaced startswith with slice lookups:
 
113
    #  200   0    851.7250    501.1120   bzrlib.weavefile:104(_read_weave_v5)
 
114
    # +59363 0    311.8780    311.8780   +<method 'append' of 'list' objects>
 
115
    # +200   0     30.2500     30.2500   +<method 'readlines' of 'file' objects>
 
116
 
 
117
    from bzrlib.weave import WeaveFormatError
 
118
 
 
119
    try:
 
120
        lines = iter(f.readlines())
 
121
    finally:
 
122
        f.close()
 
123
 
 
124
    try:
 
125
        l = lines.next()
 
126
    except StopIteration:
 
127
        raise WeaveFormatError('invalid weave file: no header')
 
128
 
104
129
    if l != FORMAT_1:
105
130
        raise WeaveFormatError('invalid weave file header: %r' % l)
106
131
 
107
132
    ver = 0
 
133
    # read weave header.
108
134
    while True:
109
 
        l = f.readline()
 
135
        l = lines.next()
110
136
        if l[0] == 'i':
111
137
            if len(l) > 2:
112
138
                w._parents.append(map(int, l[2:].split(' ')))
113
139
            else:
114
140
                w._parents.append([])
115
 
 
116
 
            l = f.readline()[:-1]
117
 
            assert l.startswith('1 ')
 
141
            l = lines.next()[:-1]
118
142
            w._sha1s.append(l[2:])
119
 
                
120
 
            l = f.readline()
121
 
            assert l.startswith('n ')
 
143
            l = lines.next()
122
144
            name = l[2:-1]
123
 
            assert name not in w._name_map
124
145
            w._names.append(name)
125
146
            w._name_map[name] = ver
126
 
                
127
 
            l = f.readline()
128
 
            assert l == '\n'
129
 
 
 
147
            l = lines.next()
130
148
            ver += 1
131
149
        elif l == 'w\n':
132
150
            break
133
151
        else:
134
152
            raise WeaveFormatError('unexpected line %r' % l)
135
153
 
136
 
    if prelude:
137
 
        return w
138
 
 
 
154
    # read weave body
139
155
    while True:
140
 
        l = f.readline()
 
156
        l = lines.next()
141
157
        if l == 'W\n':
142
158
            break
143
 
        elif l.startswith('. '):
 
159
        elif '. ' == l[0:2]:
144
160
            w._weave.append(l[2:])  # include newline
145
 
        elif l.startswith(', '):
 
161
        elif ', ' == l[0:2]:
146
162
            w._weave.append(l[2:-1])        # exclude newline
147
163
        elif l == '}\n':
148
164
            w._weave.append(('}', None))
149
165
        else:
150
 
            assert l[0] in '{[]', l
151
 
            assert l[1] == ' ', l
152
166
            w._weave.append((intern(l[0]), int(l[2:])))
153
 
 
154
167
    return w
155