1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
===============
API Reference
===============
Protocol APIs
=============
.. module:: BTrees.Interfaces
.. versionchanged:: 4.8.0
Previously, ``ISized`` was defined here, but now it is
imported from :mod:`zope.interface.common.collections`. The
definition is the same.
Similarly, ``IReadSequence``, previously defined here,
has been replaced with
:mod:`zope.interface.common.sequence.IMinimalSequence <zope.interface.common.sequence>`.
.. caution::
Before version 4.8.0, most of these interfaces served as
documentation only, and were *not* implemented by the classes of
this package. For example, :class:`BTrees.OOBTree.BTree` did *not*
implement `IBTree`. (The exceptions were the :class:`IBTreeModule`
and :class:`IBTreeFamily` families of interfaces and
implementations.)
Beginning with version 4.8.0, objects implement the expected
interface; the ``BTree`` classes implement ``IBTree``, the set
classes implement the appropriate set interface and so on.
.. autointerface:: ICollection
.. autointerface:: IKeyed
.. autointerface:: ISetMutable
.. autointerface:: IKeySequence
.. autointerface:: IMinimalDictionary
.. autointerface:: IDictionaryIsh
.. autointerface:: IMerge
.. autointerface:: IIMerge
.. autointerface:: IMergeIntegerKey
BTree Family APIs
-----------------
.. autointerface:: ISet
.. autointerface:: ITreeSet
.. autointerface:: IBTree
.. autointerface:: IBTreeFamily
There are two families defined:
.. autodata:: BTrees.family32
.. autodata:: BTrees.family64
Module APIs
-----------
.. autointerface:: IBTreeModule
.. autointerface:: IObjectObjectBTreeModule
.. autointerface:: IIntegerObjectBTreeModule
.. autointerface:: IObjectIntegerBTreeModule
.. autointerface:: IIntegerIntegerBTreeModule
.. autointerface:: IIntegerFloatBTreeModule
Utilities
=========
.. automodule:: BTrees.Length
.. automodule:: BTrees.check
BTree Data Structure Variants
=============================
Integer Keys
------------
Float Values
~~~~~~~~~~~~
.. automodule:: BTrees.IFBTree
Integer Values
~~~~~~~~~~~~~~
.. automodule:: BTrees.IIBTree
Object Values
~~~~~~~~~~~~~
.. automodule:: BTrees.IOBTree
Unsigned Integer Values
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.IUBTree
Long Integer Keys
-----------------
Float Values
~~~~~~~~~~~~
.. automodule:: BTrees.LFBTree
Long Integer Values
~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.LLBTree
Object Values
~~~~~~~~~~~~~
.. automodule:: BTrees.LOBTree
Quad Unsigned Integer Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.LQBTree
Object Keys
-----------
Integer Values
~~~~~~~~~~~~~~
.. automodule:: BTrees.OIBTree
Long Integer Values
~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.OLBTree
Object Values
~~~~~~~~~~~~~
.. automodule:: BTrees.OOBTree
Quad Unsigned Integer Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.OQBTree
Unsigned Integer Values
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.OUBTree
Quad Unsigned Integer Keys
--------------------------
Float Values
~~~~~~~~~~~~
.. automodule:: BTrees.QFBTree
Long Integer Values
~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.QLBTree
Object Values
~~~~~~~~~~~~~
.. automodule:: BTrees.QOBTree
Quad Unsigned Integer Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.QQBTree
Unsigned Integer Keys
---------------------
Float Values
~~~~~~~~~~~~
.. automodule:: BTrees.UFBTree
Integer Values
~~~~~~~~~~~~~~
.. automodule:: BTrees.UIBTree
Object Values
~~~~~~~~~~~~~
.. automodule:: BTrees.UOBTree
Unsigned Integer Values
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: BTrees.UUBTree
|
