/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 breezy/knit.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-05 09:42:14 UTC
  • mto: This revision was merged to the branch mainline in revision 6666.
  • Revision ID: jelmer@jelmer.uk-20170605094214-iy8m1eay3skjasyf
Fix some more imports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
51
51
 
52
52
"""
53
53
 
 
54
from __future__ import absolute_import
54
55
 
55
 
from cStringIO import StringIO
56
 
from itertools import izip
57
56
import operator
58
57
import os
59
 
import sys
60
58
 
61
 
from bzrlib.lazy_import import lazy_import
 
59
from .lazy_import import lazy_import
62
60
lazy_import(globals(), """
63
 
from bzrlib import (
64
 
    annotate,
 
61
import gzip
 
62
 
 
63
from breezy import (
65
64
    debug,
66
65
    diff,
67
66
    graph as _mod_graph,
68
67
    index as _mod_index,
69
 
    lru_cache,
70
68
    pack,
71
 
    progress,
 
69
    patiencediff,
72
70
    static_tuple,
73
71
    trace,
74
72
    tsort,
75
73
    tuned_gzip,
76
74
    ui,
77
75
    )
 
76
 
 
77
from breezy.repofmt import pack_repo
 
78
from breezy.i18n import gettext
78
79
""")
79
 
from bzrlib import (
 
80
from . import (
 
81
    annotate,
80
82
    errors,
81
83
    osutils,
82
 
    patiencediff,
83
84
    )
84
 
from bzrlib.errors import (
85
 
    FileExists,
 
85
from .errors import (
86
86
    NoSuchFile,
87
 
    KnitError,
88
87
    InvalidRevisionId,
89
88
    KnitCorrupt,
90
89
    KnitHeaderError,
91
90
    RevisionNotPresent,
92
 
    RevisionAlreadyPresent,
93
91
    SHA1KnitCorrupt,
94
92
    )
95
 
from bzrlib.osutils import (
 
93
from .osutils import (
96
94
    contains_whitespace,
97
 
    contains_linebreaks,
98
95
    sha_string,
99
96
    sha_strings,
100
97
    split_lines,
101
98
    )
102
 
from bzrlib.versionedfile import (
 
99
from .sixish import (
 
100
    BytesIO,
 
101
    range,
 
102
    )
 
103
from .versionedfile import (
 
104
    _KeyRefs,
103
105
    AbsentContentFactory,
104
106
    adapter_registry,
105
107
    ConstantMapper,
106
108
    ContentFactory,
107
 
    ChunkedContentFactory,
108
109
    sort_groupcompress,
109
 
    VersionedFile,
110
 
    VersionedFiles,
 
110
    VersionedFilesWithFallbacks,
111
111
    )
112
112
 
113
113
 
192
192
        delta = self._annotate_factory.parse_line_delta(contents, rec[1],
193
193
            plain=True)
194
194
        compression_parent = factory.parents[0]
195
 
        basis_entry = self._basis_vf.get_record_stream(
196
 
            [compression_parent], 'unordered', True).next()
 
195
        basis_entry = next(self._basis_vf.get_record_stream(
 
196
            [compression_parent], 'unordered', True))
197
197
        if basis_entry.storage_kind == 'absent':
198
198
            raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
199
199
        basis_chunks = basis_entry.get_bytes_as('chunked')
228
228
        delta = self._plain_factory.parse_line_delta(contents, rec[1])
229
229
        compression_parent = factory.parents[0]
230
230
        # XXX: string splitting overhead.
231
 
        basis_entry = self._basis_vf.get_record_stream(
232
 
            [compression_parent], 'unordered', True).next()
 
231
        basis_entry = next(self._basis_vf.get_record_stream(
 
232
            [compression_parent], 'unordered', True))
233
233
        if basis_entry.storage_kind == 'absent':
234
234
            raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
235
235
        basis_chunks = basis_entry.get_bytes_as('chunked')
412
412
class KnitContent(object):
413
413
    """Content of a knit version to which deltas can be applied.
414
414
 
415
 
    This is always stored in memory as a list of lines with \n at the end,
 
415
    This is always stored in memory as a list of lines with \\n at the end,
416
416
    plus a flag saying if the final ending is really there or not, because that
417
417
    corresponds to the on-disk knit representation.
418
418
    """
470
470
 
471
471
    def __init__(self, lines):
472
472
        KnitContent.__init__(self)
473
 
        self._lines = lines
 
473
        self._lines = list(lines)
474
474
 
475
475
    def annotate(self):
476
476
        """Return a list of (origin, text) for each content line."""
491
491
    def text(self):
492
492
        try:
493
493
            lines = [text for origin, text in self._lines]
494
 
        except ValueError, e:
 
494
        except ValueError as e:
495
495
            # most commonly (only?) caused by the internal form of the knit
496
496
            # missing annotation information because of a bug - see thread
497
497
            # around 20071015
503
503
        return lines
504
504
 
505
505
    def copy(self):
506
 
        return AnnotatedKnitContent(self._lines[:])
 
506
        return AnnotatedKnitContent(self._lines)
507
507
 
508
508
 
509
509
class PlainKnitContent(KnitContent):
598
598
        #       but the code itself doesn't really depend on that.
599
599
        #       Figure out a way to not require the overhead of turning the
600
600
        #       list back into tuples.
601
 
        lines = [tuple(line.split(' ', 1)) for line in content]
 
601
        lines = (tuple(line.split(' ', 1)) for line in content)
602
602
        return AnnotatedKnitContent(lines)
603
603
 
604
604
    def parse_line_delta_iter(self, lines):
620
620
        """
621
621
        result = []
622
622
        lines = iter(lines)
623
 
        next = lines.next
624
623
 
625
624
        cache = {}
626
625
        def cache_and_return(line):
633
632
        if plain:
634
633
            for header in lines:
635
634
                start, end, count = [int(n) for n in header.split(',')]
636
 
                contents = [next().split(' ', 1)[1] for i in xrange(count)]
 
635
                contents = [next(lines).split(' ', 1)[1] for _ in range(count)]
637
636
                result.append((start, end, count, contents))
638
637
        else:
639
638
            for header in lines:
640
639
                start, end, count = [int(n) for n in header.split(',')]
641
 
                contents = [tuple(next().split(' ', 1)) for i in xrange(count)]
 
640
                contents = [tuple(next(lines).split(' ', 1))
 
641
                    for _ in range(count)]
642
642
                result.append((start, end, count, contents))
643
643
        return result
644
644
 
653
653
        Only the actual content lines.
654
654
        """
655
655
        lines = iter(lines)
656
 
        next = lines.next
657
656
        for header in lines:
658
657
            header = header.split(',')
659
658
            count = int(header[2])
660
 
            for i in xrange(count):
661
 
                origin, text = next().split(' ', 1)
 
659
            for _ in range(count):
 
660
                origin, text = next(lines).split(' ', 1)
662
661
                yield text
663
662
 
664
663
    def lower_fulltext(self, content):
686
685
        content = knit._get_content(key)
687
686
        # adjust for the fact that serialised annotations are only key suffixes
688
687
        # for this factory.
689
 
        if type(key) is tuple:
 
688
        if isinstance(key, tuple):
690
689
            prefix = key[:-1]
691
690
            origins = content.annotate()
692
691
            result = []
739
738
        Only the actual content lines.
740
739
        """
741
740
        lines = iter(lines)
742
 
        next = lines.next
743
741
        for header in lines:
744
742
            header = header.split(',')
745
743
            count = int(header[2])
746
 
            for i in xrange(count):
747
 
                yield next()
 
744
            for _ in range(count):
 
745
                yield next(lines)
748
746
 
749
747
    def lower_fulltext(self, content):
750
748
        return content.text()
805
803
        writer.begin()
806
804
        index = _KnitGraphIndex(graph_index, lambda:True, parents=parents,
807
805
            deltas=delta, add_callback=graph_index.add_nodes)
808
 
        access = _DirectPackAccess({})
 
806
        access = pack_repo._DirectPackAccess({})
809
807
        access.set_writer(writer, graph_index, (transport, 'newpack'))
810
808
        result = KnitVersionedFiles(index, access,
811
809
            max_delta_chain=max_delta_chain)
849
847
                in all_build_index_memos.itervalues()])
850
848
 
851
849
 
852
 
class KnitVersionedFiles(VersionedFiles):
 
850
class KnitVersionedFiles(VersionedFilesWithFallbacks):
853
851
    """Storage for many versioned files using knit compression.
854
852
 
855
853
    Backend storage is managed by indices and data objects.
873
871
            stored during insertion.
874
872
        :param reload_func: An function that can be called if we think we need
875
873
            to reload the pack listing and try again. See
876
 
            'bzrlib.repofmt.pack_repo.AggregateIndex' for the signature.
 
874
            'breezy.repofmt.pack_repo.AggregateIndex' for the signature.
877
875
        """
878
876
        self._index = index
879
877
        self._access = data_access
882
880
            self._factory = KnitAnnotateFactory()
883
881
        else:
884
882
            self._factory = KnitPlainFactory()
885
 
        self._fallback_vfs = []
 
883
        self._immediate_fallback_vfs = []
886
884
        self._reload_func = reload_func
887
885
 
888
886
    def __repr__(self):
891
889
            self._index,
892
890
            self._access)
893
891
 
 
892
    def without_fallbacks(self):
 
893
        """Return a clone of this object without any fallbacks configured."""
 
894
        return KnitVersionedFiles(self._index, self._access,
 
895
            self._max_delta_chain, self._factory.annotated,
 
896
            self._reload_func)
 
897
 
894
898
    def add_fallback_versioned_files(self, a_versioned_files):
895
899
        """Add a source of texts for texts not present in this knit.
896
900
 
897
901
        :param a_versioned_files: A VersionedFiles object.
898
902
        """
899
 
        self._fallback_vfs.append(a_versioned_files)
 
903
        self._immediate_fallback_vfs.append(a_versioned_files)
900
904
 
901
905
    def add_lines(self, key, parents, lines, parent_texts=None,
902
906
        left_matching_blocks=None, nostore_sha=None, random_id=False,
992
996
            lines = osutils.split_lines(line_bytes)
993
997
 
994
998
        for element in key[:-1]:
995
 
            if type(element) is not str:
 
999
            if not isinstance(element, str):
996
1000
                raise TypeError("key contains non-strings: %r" % (key,))
997
1001
        if key[-1] is None:
998
1002
            key = key[:-1] + ('sha1:' + digest,)
999
 
        elif type(key[-1]) is not str:
 
1003
        elif not isinstance(key[-1], str):
1000
1004
                raise TypeError("key contains non-strings: %r" % (key,))
1001
1005
        # Knit hunks are still last-element only
1002
1006
        version_id = key[-1]
1069
1073
                    raise errors.KnitCorrupt(self,
1070
1074
                        "Missing basis parent %s for %s" % (
1071
1075
                        compression_parent, key))
1072
 
        for fallback_vfs in self._fallback_vfs:
 
1076
        for fallback_vfs in self._immediate_fallback_vfs:
1073
1077
            fallback_vfs.check()
1074
1078
 
1075
1079
    def _check_add(self, key, lines, random_id, check_content):
1114
1118
        """
1115
1119
        delta_size = 0
1116
1120
        fulltext_size = None
1117
 
        for count in xrange(self._max_delta_chain):
 
1121
        for count in range(self._max_delta_chain):
1118
1122
            try:
1119
1123
                # Note that this only looks in the index of this particular
1120
1124
                # KnitVersionedFiles, not in the fallbacks.  This ensures that
1122
1126
                # boundaries.
1123
1127
                build_details = self._index.get_build_details([parent])
1124
1128
                parent_details = build_details[parent]
1125
 
            except (RevisionNotPresent, KeyError), e:
 
1129
            except (RevisionNotPresent, KeyError) as e:
1126
1130
                # Some basis is not locally present: always fulltext
1127
1131
                return False
1128
1132
            index_memo, compression_parent, _, _ = parent_details
1153
1157
 
1154
1158
        A dict of key to (record_details, index_memo, next, parents) is
1155
1159
        returned.
1156
 
        method is the way referenced data should be applied.
1157
 
        index_memo is the handle to pass to the data access to actually get the
1158
 
            data
1159
 
        next is the build-parent of the version, or None for fulltexts.
1160
 
        parents is the version_ids of the parents of this version
1161
 
 
1162
 
        :param allow_missing: If True do not raise an error on a missing component,
1163
 
            just ignore it.
 
1160
 
 
1161
        * method is the way referenced data should be applied.
 
1162
        * index_memo is the handle to pass to the data access to actually get
 
1163
          the data
 
1164
        * next is the build-parent of the version, or None for fulltexts.
 
1165
        * parents is the version_ids of the parents of this version
 
1166
 
 
1167
        :param allow_missing: If True do not raise an error on a missing
 
1168
            component, just ignore it.
1164
1169
        """
1165
1170
        component_data = {}
1166
1171
        pending_components = keys
1192
1197
        generator = _VFContentMapGenerator(self, [key])
1193
1198
        return generator._get_content(key)
1194
1199
 
1195
 
    def get_known_graph_ancestry(self, keys):
1196
 
        """Get a KnownGraph instance with the ancestry of keys."""
1197
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1198
 
        for fallback in self._fallback_vfs:
1199
 
            if not missing_keys:
1200
 
                break
1201
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1202
 
                                                missing_keys)
1203
 
            parent_map.update(f_parent_map)
1204
 
            missing_keys = f_missing_keys
1205
 
        kg = _mod_graph.KnownGraph(parent_map)
1206
 
        return kg
1207
 
 
1208
1200
    def get_parent_map(self, keys):
1209
1201
        """Get a map of the graph parents of keys.
1210
1202
 
1225
1217
            and so on.
1226
1218
        """
1227
1219
        result = {}
1228
 
        sources = [self._index] + self._fallback_vfs
 
1220
        sources = [self._index] + self._immediate_fallback_vfs
1229
1221
        source_results = []
1230
1222
        missing = set(keys)
1231
1223
        for source in sources:
1241
1233
        """Produce a dictionary of knit records.
1242
1234
 
1243
1235
        :return: {key:(record, record_details, digest, next)}
1244
 
            record
1245
 
                data returned from read_records (a KnitContentobject)
1246
 
            record_details
1247
 
                opaque information to pass to parse_record
1248
 
            digest
1249
 
                SHA1 digest of the full text after all steps are done
1250
 
            next
1251
 
                build-parent of the version, i.e. the leftmost ancestor.
 
1236
 
 
1237
            * record: data returned from read_records (a KnitContentobject)
 
1238
            * record_details: opaque information to pass to parse_record
 
1239
            * digest: SHA1 digest of the full text after all steps are done
 
1240
            * next: build-parent of the version, i.e. the leftmost ancestor.
1252
1241
                Will be None if the record is not a delta.
 
1242
 
1253
1243
        :param keys: The keys to build a map for
1254
1244
        :param allow_missing: If some records are missing, rather than
1255
1245
            error, just return the data that could be generated.
1299
1289
                    (record_details, index_memo, next) = position_map[key]
1300
1290
                    raw_record_map[key] = data, record_details, next
1301
1291
                return raw_record_map
1302
 
            except errors.RetryWithNewPacks, e:
 
1292
            except errors.RetryWithNewPacks as e:
1303
1293
                self._access.reload_or_raise(e)
1304
1294
 
1305
1295
    @classmethod
1408
1398
                    remaining_keys.discard(content_factory.key)
1409
1399
                    yield content_factory
1410
1400
                return
1411
 
            except errors.RetryWithNewPacks, e:
 
1401
            except errors.RetryWithNewPacks as e:
1412
1402
                self._access.reload_or_raise(e)
1413
1403
 
1414
1404
    def _get_remaining_record_stream(self, keys, ordering,
1525
1515
                        yield KnitContentFactory(key, global_map[key],
1526
1516
                            record_details, None, raw_data, self._factory.annotated, None)
1527
1517
                else:
1528
 
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
 
1518
                    vf = self._immediate_fallback_vfs[parent_maps.index(source) - 1]
1529
1519
                    for record in vf.get_record_stream(keys, ordering,
1530
1520
                        include_delta_closure):
1531
1521
                        yield record
1541
1531
            # record entry 2 is the 'digest'.
1542
1532
            result[key] = details[2]
1543
1533
        missing.difference_update(set(result))
1544
 
        for source in self._fallback_vfs:
 
1534
        for source in self._immediate_fallback_vfs:
1545
1535
            if not missing:
1546
1536
                break
1547
1537
            new_result = source.get_sha1s(missing)
1572
1562
        else:
1573
1563
            # self is not annotated, but we can strip annotations cheaply.
1574
1564
            annotated = ""
1575
 
            convertibles = set(["knit-annotated-ft-gz"])
 
1565
            convertibles = {"knit-annotated-ft-gz"}
1576
1566
            if self._max_delta_chain:
1577
1567
                delta_types.add("knit-annotated-delta-gz")
1578
1568
                convertibles.add("knit-annotated-delta-gz")
1618
1608
                raise RevisionNotPresent([record.key], self)
1619
1609
            elif ((record.storage_kind in knit_types)
1620
1610
                  and (compression_parent is None
1621
 
                       or not self._fallback_vfs
1622
 
                       or self._index.has_key(compression_parent)
1623
 
                       or not self.has_key(compression_parent))):
 
1611
                       or not self._immediate_fallback_vfs
 
1612
                       or compression_parent in self._index
 
1613
                       or compression_parent not in self)):
1624
1614
                # we can insert the knit record literally if either it has no
1625
1615
                # compression parent OR we already have its basis in this kvf
1626
1616
                # OR the basis is not present even in the fallbacks.  In the
1628
1618
                # will be well, or it won't turn up at all and we'll raise an
1629
1619
                # error at the end.
1630
1620
                #
1631
 
                # TODO: self.has_key is somewhat redundant with
1632
 
                # self._index.has_key; we really want something that directly
 
1621
                # TODO: self.__contains__ is somewhat redundant with
 
1622
                # self._index.__contains__; we really want something that directly
1633
1623
                # asks if it's only present in the fallbacks. -- mbp 20081119
1634
1624
                if record.storage_kind not in native_types:
1635
1625
                    try:
1668
1658
                    #
1669
1659
                    # They're required to be physically in this
1670
1660
                    # KnitVersionedFiles, not in a fallback.
1671
 
                    if not self._index.has_key(compression_parent):
 
1661
                    if compression_parent not in self._index:
1672
1662
                        pending = buffered_index_entries.setdefault(
1673
1663
                            compression_parent, [])
1674
1664
                        pending.append(index_entry)
1772
1762
                        key_records.append((key, details[0]))
1773
1763
                records_iter = enumerate(self._read_records_iter(key_records))
1774
1764
                for (key_idx, (key, data, sha_value)) in records_iter:
1775
 
                    pb.update('Walking content', key_idx, total)
 
1765
                    pb.update(gettext('Walking content'), key_idx, total)
1776
1766
                    compression_parent = build_details[key][1]
1777
1767
                    if compression_parent is None:
1778
1768
                        # fulltext
1790
1780
                    for line in line_iterator:
1791
1781
                        yield line, key
1792
1782
                done = True
1793
 
            except errors.RetryWithNewPacks, e:
 
1783
            except errors.RetryWithNewPacks as e:
1794
1784
                self._access.reload_or_raise(e)
1795
1785
        # If there are still keys we've not yet found, we look in the fallback
1796
1786
        # vfs, and hope to find them there.  Note that if the keys are found
1797
1787
        # but had no changes or no content, the fallback may not return
1798
1788
        # anything.
1799
 
        if keys and not self._fallback_vfs:
 
1789
        if keys and not self._immediate_fallback_vfs:
1800
1790
            # XXX: strictly the second parameter is meant to be the file id
1801
1791
            # but it's not easily accessible here.
1802
1792
            raise RevisionNotPresent(keys, repr(self))
1803
 
        for source in self._fallback_vfs:
 
1793
        for source in self._immediate_fallback_vfs:
1804
1794
            if not keys:
1805
1795
                break
1806
1796
            source_keys = set()
1808
1798
                source_keys.add(key)
1809
1799
                yield line, key
1810
1800
            keys.difference_update(source_keys)
1811
 
        pb.update('Walking content', total, total)
 
1801
        pb.update(gettext('Walking content'), total, total)
1812
1802
 
1813
1803
    def _make_line_delta(self, delta_seq, new_content):
1814
1804
        """Generate a line delta from delta_seq and new_content."""
1879
1869
        :return: the header and the decompressor stream.
1880
1870
                 as (stream, header_record)
1881
1871
        """
1882
 
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(raw_data))
 
1872
        df = gzip.GzipFile(mode='rb', fileobj=BytesIO(raw_data))
1883
1873
        try:
1884
1874
            # Current serialise
1885
1875
            rec = self._check_header(key, df.readline())
1886
 
        except Exception, e:
 
1876
        except Exception as e:
1887
1877
            raise KnitCorrupt(self,
1888
1878
                              "While reading {%s} got %s(%s)"
1889
1879
                              % (key, e.__class__.__name__, str(e)))
1894
1884
        # 4168 calls in 2880 217 internal
1895
1885
        # 4168 calls to _parse_record_header in 2121
1896
1886
        # 4168 calls to readlines in 330
1897
 
        df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(data))
 
1887
        df = gzip.GzipFile(mode='rb', fileobj=BytesIO(data))
1898
1888
        try:
1899
1889
            record_contents = df.readlines()
1900
 
        except Exception, e:
 
1890
        except Exception as e:
1901
1891
            raise KnitCorrupt(self, "Corrupt compressed record %r, got %s(%s)" %
1902
1892
                (data, e.__class__.__name__, str(e)))
1903
1893
        header = record_contents.pop(0)
1922
1912
        The result will be returned in whatever is the fastest to read.
1923
1913
        Not by the order requested. Also, multiple requests for the same
1924
1914
        record will only yield 1 response.
 
1915
 
1925
1916
        :param records: A list of (key, access_memo) entries
1926
1917
        :return: Yields (key, contents, digest) in the order
1927
1918
                 read, not the order requested
1939
1930
        raw_data = self._access.get_raw_records(
1940
1931
            [index_memo for key, index_memo in needed_records])
1941
1932
 
1942
 
        for (key, index_memo), data in \
1943
 
                izip(iter(needed_records), raw_data):
 
1933
        for (key, index_memo), data in zip(needed_records, raw_data):
1944
1934
            content, digest = self._parse_record(key[-1], data)
1945
1935
            yield key, content, digest
1946
1936
 
1976
1966
            raw_records = self._access.get_raw_records(needed_offsets)
1977
1967
 
1978
1968
        for key, index_memo in records:
1979
 
            data = raw_records.next()
 
1969
            data = next(raw_records)
1980
1970
            yield key, data
1981
1971
 
1982
1972
    def _record_to_data(self, key, digest, lines, dense_lines=None):
1985
1975
        :param key: The key of the record. Currently keys are always serialised
1986
1976
            using just the trailing component.
1987
1977
        :param dense_lines: The bytes of lines but in a denser form. For
1988
 
            instance, if lines is a list of 1000 bytestrings each ending in \n,
1989
 
            dense_lines may be a list with one line in it, containing all the
1990
 
            1000's lines and their \n's. Using dense_lines if it is already
1991
 
            known is a win because the string join to create bytes in this
1992
 
            function spends less time resizing the final string.
1993
 
        :return: (len, a StringIO instance with the raw data ready to read.)
 
1978
            instance, if lines is a list of 1000 bytestrings each ending in
 
1979
            \\n, dense_lines may be a list with one line in it, containing all
 
1980
            the 1000's lines and their \\n's. Using dense_lines if it is
 
1981
            already known is a win because the string join to create bytes in
 
1982
            this function spends less time resizing the final string.
 
1983
        :return: (len, a BytesIO instance with the raw data ready to read.)
1994
1984
        """
1995
1985
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1996
1986
        chunks.extend(dense_lines or lines)
1997
1987
        chunks.append("end %s\n" % key[-1])
1998
1988
        for chunk in chunks:
1999
 
            if type(chunk) is not str:
 
1989
            if not isinstance(chunk, str):
2000
1990
                raise AssertionError(
2001
1991
                    'data must be plain bytes was %s' % type(chunk))
2002
1992
        if lines and lines[-1][-1] != '\n':
2015
2005
        """See VersionedFiles.keys."""
2016
2006
        if 'evil' in debug.debug_flags:
2017
2007
            trace.mutter_callsite(2, "keys scales with size of history")
2018
 
        sources = [self._index] + self._fallback_vfs
 
2008
        sources = [self._index] + self._immediate_fallback_vfs
2019
2009
        result = set()
2020
2010
        for source in sources:
2021
2011
            result.update(source.keys())
2033
2023
        # Note that _get_content is only called when the _ContentMapGenerator
2034
2024
        # has been constructed with just one key requested for reconstruction.
2035
2025
        if key in self.nonlocal_keys:
2036
 
            record = self.get_record_stream().next()
 
2026
            record = next(self.get_record_stream())
2037
2027
            # Create a content object on the fly
2038
2028
            lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
2039
2029
            return PlainKnitContent(lines, record.key)
2061
2051
 
2062
2052
        missing_keys = set(nonlocal_keys)
2063
2053
        # Read from remote versioned file instances and provide to our caller.
2064
 
        for source in self.vf._fallback_vfs:
 
2054
        for source in self.vf._immediate_fallback_vfs:
2065
2055
            if not missing_keys:
2066
2056
                break
2067
2057
            # Loop over fallback repositories asking them for texts - ignore
2446
2436
                    line = "\n%s %s %s %s %s :" % (
2447
2437
                        key[-1], ','.join(options), pos, size,
2448
2438
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
2439
                    if not isinstance(line, str):
2450
2440
                        raise AssertionError(
2451
2441
                            'data must be utf8 was %s' % type(line))
2452
2442
                    lines.append(line)
2646
2636
        entry = self._kndx_cache[prefix][0][suffix]
2647
2637
        return key, entry[2], entry[3]
2648
2638
 
2649
 
    has_key = _mod_index._has_key_from_parent_map
 
2639
    __contains__ = _mod_index._has_key_from_parent_map
2650
2640
 
2651
2641
    def _init_index(self, path, extra_lines=[]):
2652
2642
        """Initialize an index."""
2653
 
        sio = StringIO()
 
2643
        sio = BytesIO()
2654
2644
        sio.write(self.HEADER)
2655
2645
        sio.writelines(extra_lines)
2656
2646
        sio.seek(0)
2668
2658
        result = set()
2669
2659
        # Identify all key prefixes.
2670
2660
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
2661
        if isinstance(self._mapper, ConstantMapper):
2672
2662
            prefixes = [()]
2673
2663
        else:
2674
2664
            relpaths = set()
2706
2696
                    del self._history
2707
2697
                except NoSuchFile:
2708
2698
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
2699
                    if isinstance(self._mapper, ConstantMapper):
2710
2700
                        # preserve behaviour for revisions.kndx etc.
2711
2701
                        self._init_index(path)
2712
2702
                    del self._cache
2786
2776
        return key[:-1], key[-1]
2787
2777
 
2788
2778
 
2789
 
class _KeyRefs(object):
2790
 
 
2791
 
    def __init__(self, track_new_keys=False):
2792
 
        # dict mapping 'key' to 'set of keys referring to that key'
2793
 
        self.refs = {}
2794
 
        if track_new_keys:
2795
 
            # set remembering all new keys
2796
 
            self.new_keys = set()
2797
 
        else:
2798
 
            self.new_keys = None
2799
 
 
2800
 
    def clear(self):
2801
 
        if self.refs:
2802
 
            self.refs.clear()
2803
 
        if self.new_keys:
2804
 
            self.new_keys.clear()
2805
 
 
2806
 
    def add_references(self, key, refs):
2807
 
        # Record the new references
2808
 
        for referenced in refs:
2809
 
            try:
2810
 
                needed_by = self.refs[referenced]
2811
 
            except KeyError:
2812
 
                needed_by = self.refs[referenced] = set()
2813
 
            needed_by.add(key)
2814
 
        # Discard references satisfied by the new key
2815
 
        self.add_key(key)
2816
 
 
2817
 
    def get_new_keys(self):
2818
 
        return self.new_keys
2819
 
    
2820
 
    def get_unsatisfied_refs(self):
2821
 
        return self.refs.iterkeys()
2822
 
 
2823
 
    def _satisfy_refs_for_key(self, key):
2824
 
        try:
2825
 
            del self.refs[key]
2826
 
        except KeyError:
2827
 
            # No keys depended on this key.  That's ok.
2828
 
            pass
2829
 
 
2830
 
    def add_key(self, key):
2831
 
        # satisfy refs for key, and remember that we've seen this key.
2832
 
        self._satisfy_refs_for_key(key)
2833
 
        if self.new_keys is not None:
2834
 
            self.new_keys.add(key)
2835
 
 
2836
 
    def satisfy_refs_for_keys(self, keys):
2837
 
        for key in keys:
2838
 
            self._satisfy_refs_for_key(key)
2839
 
 
2840
 
    def get_referrers(self):
2841
 
        result = set()
2842
 
        for referrers in self.refs.itervalues():
2843
 
            result.update(referrers)
2844
 
        return result
2845
 
 
2846
 
 
2847
2779
class _KnitGraphIndex(object):
2848
2780
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
2781
 
2851
2783
        add_callback=None, track_external_parent_refs=False):
2852
2784
        """Construct a KnitGraphIndex on a graph_index.
2853
2785
 
2854
 
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
 
2786
        :param graph_index: An implementation of breezy.index.GraphIndex.
2855
2787
        :param is_locked: A callback to check whether the object should answer
2856
2788
            queries.
2857
2789
        :param deltas: Allow delta-compressed records.
3156
3088
        node = self._get_node(key)
3157
3089
        return self._node_to_position(node)
3158
3090
 
3159
 
    has_key = _mod_index._has_key_from_parent_map
 
3091
    __contains__ = _mod_index._has_key_from_parent_map
3160
3092
 
3161
3093
    def keys(self):
3162
3094
        """Get all the keys in the collection.
3221
3153
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
3154
            length), where the key is the record key.
3223
3155
        """
3224
 
        if type(raw_data) is not str:
 
3156
        if not isinstance(raw_data, str):
3225
3157
            raise AssertionError(
3226
3158
                'data must be plain bytes was %s' % type(raw_data))
3227
3159
        result = []
3278
3210
                yield data
3279
3211
 
3280
3212
 
3281
 
class _DirectPackAccess(object):
3282
 
    """Access to data in one or more packs with less translation."""
3283
 
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
3285
 
        """Create a _DirectPackAccess object.
3286
 
 
3287
 
        :param index_to_packs: A dict mapping index objects to the transport
3288
 
            and file names for obtaining data.
3289
 
        :param reload_func: A function to call if we determine that the pack
3290
 
            files have moved and we need to reload our caches. See
3291
 
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
3292
 
        """
3293
 
        self._container_writer = None
3294
 
        self._write_index = None
3295
 
        self._indices = index_to_packs
3296
 
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
 
 
3299
 
    def add_raw_records(self, key_sizes, raw_data):
3300
 
        """Add raw knit bytes to a storage area.
3301
 
 
3302
 
        The data is spooled to the container writer in one bytes-record per
3303
 
        raw data item.
3304
 
 
3305
 
        :param sizes: An iterable of tuples containing the key and size of each
3306
 
            raw data segment.
3307
 
        :param raw_data: A bytestring containing the data.
3308
 
        :return: A list of memos to retrieve the record later. Each memo is an
3309
 
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
3310
 
            length), where the index field is the write_index object supplied
3311
 
            to the PackAccess object.
3312
 
        """
3313
 
        if type(raw_data) is not str:
3314
 
            raise AssertionError(
3315
 
                'data must be plain bytes was %s' % type(raw_data))
3316
 
        result = []
3317
 
        offset = 0
3318
 
        for key, size in key_sizes:
3319
 
            p_offset, p_length = self._container_writer.add_bytes_record(
3320
 
                raw_data[offset:offset+size], [])
3321
 
            offset += size
3322
 
            result.append((self._write_index, p_offset, p_length))
3323
 
        return result
3324
 
 
3325
 
    def flush(self):
3326
 
        """Flush pending writes on this access object.
3327
 
 
3328
 
        This will flush any buffered writes to a NewPack.
3329
 
        """
3330
 
        if self._flush_func is not None:
3331
 
            self._flush_func()
3332
 
            
3333
 
    def get_raw_records(self, memos_for_retrieval):
3334
 
        """Get the raw bytes for a records.
3335
 
 
3336
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
3337
 
            length) memo for retrieving the bytes. The Pack access method
3338
 
            looks up the pack to use for a given record in its index_to_pack
3339
 
            map.
3340
 
        :return: An iterator over the bytes of the records.
3341
 
        """
3342
 
        # first pass, group into same-index requests
3343
 
        request_lists = []
3344
 
        current_index = None
3345
 
        for (index, offset, length) in memos_for_retrieval:
3346
 
            if current_index == index:
3347
 
                current_list.append((offset, length))
3348
 
            else:
3349
 
                if current_index is not None:
3350
 
                    request_lists.append((current_index, current_list))
3351
 
                current_index = index
3352
 
                current_list = [(offset, length)]
3353
 
        # handle the last entry
3354
 
        if current_index is not None:
3355
 
            request_lists.append((current_index, current_list))
3356
 
        for index, offsets in request_lists:
3357
 
            try:
3358
 
                transport, path = self._indices[index]
3359
 
            except KeyError:
3360
 
                # A KeyError here indicates that someone has triggered an index
3361
 
                # reload, and this index has gone missing, we need to start
3362
 
                # over.
3363
 
                if self._reload_func is None:
3364
 
                    # If we don't have a _reload_func there is nothing that can
3365
 
                    # be done
3366
 
                    raise
3367
 
                raise errors.RetryWithNewPacks(index,
3368
 
                                               reload_occurred=True,
3369
 
                                               exc_info=sys.exc_info())
3370
 
            try:
3371
 
                reader = pack.make_readv_reader(transport, path, offsets)
3372
 
                for names, read_func in reader.iter_records():
3373
 
                    yield read_func(None)
3374
 
            except errors.NoSuchFile:
3375
 
                # A NoSuchFile error indicates that a pack file has gone
3376
 
                # missing on disk, we need to trigger a reload, and start over.
3377
 
                if self._reload_func is None:
3378
 
                    raise
3379
 
                raise errors.RetryWithNewPacks(transport.abspath(path),
3380
 
                                               reload_occurred=False,
3381
 
                                               exc_info=sys.exc_info())
3382
 
 
3383
 
    def set_writer(self, writer, index, transport_packname):
3384
 
        """Set a writer to use for adding data."""
3385
 
        if index is not None:
3386
 
            self._indices[index] = transport_packname
3387
 
        self._container_writer = writer
3388
 
        self._write_index = index
3389
 
 
3390
 
    def reload_or_raise(self, retry_exc):
3391
 
        """Try calling the reload function, or re-raise the original exception.
3392
 
 
3393
 
        This should be called after _DirectPackAccess raises a
3394
 
        RetryWithNewPacks exception. This function will handle the common logic
3395
 
        of determining when the error is fatal versus being temporary.
3396
 
        It will also make sure that the original exception is raised, rather
3397
 
        than the RetryWithNewPacks exception.
3398
 
 
3399
 
        If this function returns, then the calling function should retry
3400
 
        whatever operation was being performed. Otherwise an exception will
3401
 
        be raised.
3402
 
 
3403
 
        :param retry_exc: A RetryWithNewPacks exception.
3404
 
        """
3405
 
        is_error = False
3406
 
        if self._reload_func is None:
3407
 
            is_error = True
3408
 
        elif not self._reload_func():
3409
 
            # The reload claimed that nothing changed
3410
 
            if not retry_exc.reload_occurred:
3411
 
                # If there wasn't an earlier reload, then we really were
3412
 
                # expecting to find changes. We didn't find them, so this is a
3413
 
                # hard error
3414
 
                is_error = True
3415
 
        if is_error:
3416
 
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
3417
 
            raise exc_class, exc_value, exc_traceback
3418
 
 
3419
 
 
3420
 
# Deprecated, use PatienceSequenceMatcher instead
3421
 
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
3422
 
 
3423
 
 
3424
3213
def annotate_knit(knit, revision_id):
3425
3214
    """Annotate a knit with no cached annotations.
3426
3215
 
3469
3258
            passing to read_records_iter to start reading in the raw data from
3470
3259
            the pack file.
3471
3260
        """
3472
 
        pending = set([key])
 
3261
        pending = {key}
3473
3262
        records = []
3474
3263
        ann_keys = set()
3475
3264
        self._num_needed_children[key] = 1
3524
3313
        return records, ann_keys
3525
3314
 
3526
3315
    def _get_needed_texts(self, key, pb=None):
3527
 
        # if True or len(self._vf._fallback_vfs) > 0:
3528
 
        if len(self._vf._fallback_vfs) > 0:
 
3316
        # if True or len(self._vf._immediate_fallback_vfs) > 0:
 
3317
        if len(self._vf._immediate_fallback_vfs) > 0:
3529
3318
            # If we have fallbacks, go to the generic path
3530
3319
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3531
3320
                yield v
3536
3325
                for idx, (sub_key, text, num_lines) in enumerate(
3537
3326
                                                self._extract_texts(records)):
3538
3327
                    if pb is not None:
3539
 
                        pb.update('annotating', idx, len(records))
 
3328
                        pb.update(gettext('annotating'), idx, len(records))
3540
3329
                    yield sub_key, text, num_lines
3541
3330
                for sub_key in ann_keys:
3542
3331
                    text = self._text_cache[sub_key]
3543
3332
                    num_lines = len(text) # bad assumption
3544
3333
                    yield sub_key, text, num_lines
3545
3334
                return
3546
 
            except errors.RetryWithNewPacks, e:
 
3335
            except errors.RetryWithNewPacks as e:
3547
3336
                self._vf._access.reload_or_raise(e)
3548
3337
                # The cached build_details are no longer valid
3549
3338
                self._all_build_details.clear()
3708
3497
                    to_process.extend(self._process_pending(key))
3709
3498
 
3710
3499
try:
3711
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3712
 
except ImportError, e:
 
3500
    from ._knit_load_data_pyx import _load_data_c as _load_data
 
3501
except ImportError as e:
3713
3502
    osutils.failed_to_load_extension(e)
3714
 
    from bzrlib._knit_load_data_py import _load_data_py as _load_data
 
3503
    from ._knit_load_data_py import _load_data_py as _load_data