/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/pack.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/pack.py
20
20
doc/developers/container-format.txt.
21
21
"""
22
22
 
23
 
from __future__ import absolute_import
24
 
 
 
23
from cStringIO import StringIO
25
24
import re
26
25
 
27
 
from .. import errors
28
 
from ..sixish import (
29
 
    BytesIO,
30
 
    )
31
 
 
32
 
 
33
 
FORMAT_ONE = b"Bazaar pack format 1 (introduced in 0.18)"
34
 
 
35
 
 
36
 
_whitespace_re = re.compile(b'[\t\n\x0b\x0c\r ]')
 
26
from bzrlib import errors
 
27
 
 
28
 
 
29
FORMAT_ONE = "Bazaar pack format 1 (introduced in 0.18)"
 
30
 
 
31
 
 
32
_whitespace_re = re.compile('[\t\n\x0b\x0c\r ]')
37
33
 
38
34
 
39
35
def _check_name(name):
59
55
    """
60
56
    try:
61
57
        name.decode('utf-8')
62
 
    except UnicodeDecodeError as e:
 
58
    except UnicodeDecodeError, e:
63
59
        raise errors.InvalidRecordError(str(e))
64
60
 
65
61
 
73
69
 
74
70
    def begin(self):
75
71
        """Return the bytes to begin a container."""
76
 
        return FORMAT_ONE + b"\n"
 
72
        return FORMAT_ONE + "\n"
77
73
 
78
74
    def end(self):
79
75
        """Return the bytes to finish a container."""
80
 
        return b"E"
 
76
        return "E"
81
77
 
82
 
    def bytes_header(self, length, names):
83
 
        """Return the header for a Bytes record."""
 
78
    def bytes_record(self, bytes, names):
 
79
        """Return the bytes for a Bytes record with the given name and
 
80
        contents.
 
81
        """
84
82
        # Kind marker
85
 
        byte_sections = [b"B"]
 
83
        byte_sections = ["B"]
86
84
        # Length
87
 
        byte_sections.append(b"%d\n" % (length,))
 
85
        byte_sections.append(str(len(bytes)) + "\n")
88
86
        # Names
89
87
        for name_tuple in names:
90
88
            # Make sure we're writing valid names.  Note that we will leave a
91
89
            # half-written record if a name is bad!
92
90
            for name in name_tuple:
93
91
                _check_name(name)
94
 
            byte_sections.append(b'\x00'.join(name_tuple) + b"\n")
 
92
            byte_sections.append('\x00'.join(name_tuple) + "\n")
95
93
        # End of headers
96
 
        byte_sections.append(b"\n")
97
 
        return b''.join(byte_sections)
98
 
 
99
 
    def bytes_record(self, bytes, names):
100
 
        """Return the bytes for a Bytes record with the given name and
101
 
        contents.
102
 
 
103
 
        If the content may be large, construct the header separately and then
104
 
        stream out the contents.
105
 
        """
106
 
        return self.bytes_header(len(bytes), names) + bytes
 
94
        byte_sections.append("\n")
 
95
        # Finally, the contents.
 
96
        byte_sections.append(bytes)
 
97
        # XXX: This causes a memory copy of bytes in size, but is usually
 
98
        # faster than two write calls (12 vs 13 seconds to output a gig of
 
99
        # 1k records.) - results may differ on significantly larger records
 
100
        # like .iso's but as they should be rare in any case and thus not
 
101
        # likely to be the common case. The biggest issue is causing extreme
 
102
        # memory pressure in that case. One possibly improvement here is to
 
103
        # check the size of the content before deciding to join here vs call
 
104
        # write twice.
 
105
        return ''.join(byte_sections)
107
106
 
108
107
 
109
108
class ContainerWriter(object):
114
113
        introduced by the begin() and end() methods.
115
114
    """
116
115
 
117
 
    # Join up headers with the body if writing fewer than this many bytes:
118
 
    # trades off memory usage and copying to do less IO ops.
119
 
    _JOIN_WRITES_THRESHOLD = 100000
120
 
 
121
116
    def __init__(self, write_func):
122
117
        """Constructor.
123
118
 
156
151
            and thus are only suitable for use by a ContainerReader.
157
152
        """
158
153
        current_offset = self.current_offset
159
 
        length = len(bytes)
160
 
        if length < self._JOIN_WRITES_THRESHOLD:
161
 
            self.write_func(self._serialiser.bytes_header(length, names)
162
 
                + bytes)
163
 
        else:
164
 
            self.write_func(self._serialiser.bytes_header(length, names))
165
 
            self.write_func(bytes)
 
154
        serialised_record = self._serialiser.bytes_record(bytes, names)
 
155
        self.write_func(serialised_record)
166
156
        self.records_written += 1
167
157
        # return a memo of where we wrote data to allow random access.
168
158
        return current_offset, self.current_offset - current_offset
194
184
    def _next(self):
195
185
        if (self._string is None or
196
186
            self._string.tell() == self._string_length):
197
 
            offset, data = next(self.readv_result)
 
187
            offset, data = self.readv_result.next()
198
188
            self._string_length = len(data)
199
 
            self._string = BytesIO(data)
 
189
            self._string = StringIO(data)
200
190
 
201
191
    def read(self, length):
202
192
        self._next()
211
201
        """Note that readline will not cross readv segments."""
212
202
        self._next()
213
203
        result = self._string.readline()
214
 
        if self._string.tell() == self._string_length and result[-1:] != b'\n':
 
204
        if self._string.tell() == self._string_length and result[-1] != '\n':
215
205
            raise errors.BzrError('short readline in the readvfile hunk: %r'
216
206
                % (result, ))
217
207
        return result
247
237
 
248
238
    def _read_line(self):
249
239
        line = self._source.readline()
250
 
        if not line.endswith(b'\n'):
 
240
        if not line.endswith('\n'):
251
241
            raise errors.UnexpectedEndOfContainerError()
252
 
        return line.rstrip(b'\n')
 
242
        return line.rstrip('\n')
253
243
 
254
244
 
255
245
class ContainerReader(BaseReader):
302
292
 
303
293
    def _iter_record_objects(self):
304
294
        while True:
305
 
            try:
306
 
                record_kind = self.reader_func(1)
307
 
            except StopIteration:
308
 
                return
309
 
            if record_kind == b'B':
 
295
            record_kind = self.reader_func(1)
 
296
            if record_kind == 'B':
310
297
                # Bytes record.
311
298
                reader = BytesRecordReader(self._source)
312
299
                yield reader
313
 
            elif record_kind == b'E':
 
300
            elif record_kind == 'E':
314
301
                # End marker.  There are no more records.
315
302
                return
316
 
            elif record_kind == b'':
 
303
            elif record_kind == '':
317
304
                # End of stream encountered, but no End Marker record seen, so
318
305
                # this container is incomplete.
319
306
                raise errors.UnexpectedEndOfContainerError()
346
333
                # risk that the same unicode string has been encoded two
347
334
                # different ways.
348
335
                if name_tuple in all_names:
349
 
                    raise errors.DuplicateRecordNameError(name_tuple[0])
 
336
                    raise errors.DuplicateRecordNameError(name_tuple)
350
337
                all_names.add(name_tuple)
351
338
        excess_bytes = self.reader_func(1)
352
 
        if excess_bytes != b'':
 
339
        if excess_bytes != '':
353
340
            raise errors.ContainerHasExcessDataError(excess_bytes)
354
341
 
355
342
 
378
365
        names = []
379
366
        while True:
380
367
            name_line = self._read_line()
381
 
            if name_line == b'':
 
368
            if name_line == '':
382
369
                break
383
 
            name_tuple = tuple(name_line.split(b'\x00'))
 
370
            name_tuple = tuple(name_line.split('\x00'))
384
371
            for name in name_tuple:
385
372
                _check_name(name)
386
373
            names.append(name_tuple)
421
408
    """
422
409
 
423
410
    def __init__(self):
424
 
        self._buffer = b''
 
411
        self._buffer = ''
425
412
        self._state_handler = self._state_expecting_format_line
426
413
        self._parsed_records = []
427
414
        self._reset_current_record()
461
448
        If a newline byte is not found in the buffer, the buffer is
462
449
        unchanged and this returns None instead.
463
450
        """
464
 
        newline_pos = self._buffer.find(b'\n')
 
451
        newline_pos = self._buffer.find('\n')
465
452
        if newline_pos != -1:
466
453
            line = self._buffer[:newline_pos]
467
454
            self._buffer = self._buffer[newline_pos+1:]
478
465
 
479
466
    def _state_expecting_record_type(self):
480
467
        if len(self._buffer) >= 1:
481
 
            record_type = self._buffer[:1]
 
468
            record_type = self._buffer[0]
482
469
            self._buffer = self._buffer[1:]
483
 
            if record_type == b'B':
 
470
            if record_type == 'B':
484
471
                self._state_handler = self._state_expecting_length
485
 
            elif record_type == b'E':
 
472
            elif record_type == 'E':
486
473
                self.finished = True
487
474
                self._state_handler = self._state_expecting_nothing
488
475
            else:
500
487
 
501
488
    def _state_expecting_name(self):
502
489
        encoded_name_parts = self._consume_line()
503
 
        if encoded_name_parts == b'':
 
490
        if encoded_name_parts == '':
504
491
            self._state_handler = self._state_expecting_body
505
492
        elif encoded_name_parts:
506
 
            name_parts = tuple(encoded_name_parts.split(b'\x00'))
 
493
            name_parts = tuple(encoded_name_parts.split('\x00'))
507
494
            for name_part in name_parts:
508
495
                _check_name(name_part)
509
496
            self._current_record_names.append(name_parts)