API Reference

Protocol APIs

Changed in version 4.8.0: Previously, ISized was defined here, but now it is imported from zope.interface.common.collections. The definition is the same.

Similarly, IReadSequence, previously defined here, has been replaced with zope.interface.common.sequence.IMinimalSequence.

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, BTrees.OOBTree.BTree did not implement IBTree. (The exceptions were the IBTreeModule and 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.

interface BTrees.Interfaces.ICollection[source]

A collection of zero or more objects.

In a boolean context, objects implementing this interface are True if the collection is non-empty, and False if the collection is empty.

clear()

Remove all of the items from the collection.

interface BTrees.Interfaces.IKeyed[source]

Extends: BTrees.Interfaces.ICollection

has_key(key)

Check whether the object has an item with the given key.

Return a true value if the key is present, else a false value.

keys(min=None, max=None, excludemin=False, excludemax=False)

Return an IMinimalSequence containing the keys in the collection.

The type of the IMinimalSequence is not specified. It could be a list or a tuple or some other type.

All arguments are optional, and may be specified as keyword arguments, or by position.

If a min is specified, then output is constrained to keys greater than or equal to the given min, and, if excludemin is specified and true, is further constrained to keys strictly greater than min. A min value of None is ignored. If min is None or not specified, and excludemin is true, the smallest key is excluded.

If a max is specified, then output is constrained to keys less than or equal to the given max, and, if excludemax is specified and true, is further constrained to keys strictly less than max. A max value of None is ignored. If max is None or not specified, and excludemax is true, the largest key is excluded.

maxKey(key=None)

Return the maximum key.

If a key argument if provided and not None, return the largest key that is less than or equal to the argument. Raise an exception if no such key exists.

minKey(key=None)

Return the minimum key.

If a key argument if provided and not None, return the smallest key that is greater than or equal to the argument. Raise an exception if no such key exists.

interface BTrees.Interfaces.ISetMutable[source]

Extends: BTrees.Interfaces.IKeyed

insert(key)

Add the key (value) to the set.

If the key was already in the set, return 0, otherwise return 1.

remove(key)

Remove the key from the set.

Raises KeyError if key is not in the set.

update(seq)

Add the items from the given sequence to the set.

__and__(other)

Shortcut for intersection()

New in version 4.8.0.

__iand__(other)

As for set.intersection_update(): Update this object, keeping only elements found in both it and other.

New in version 4.8.0.

__or__(other)

Shortcut for union()

New in version 4.8.0.

__ior__(other)

As for set.update(): Update this object, adding elements from other.

New in version 4.8.0.

__sub__(other)

Shortcut for difference()

New in version 4.8.0.

__isub__(other)

As for set.difference_update(): Update this object, removing elements found in other.

New in version 4.8.0.

isdisjoint(other)

As for set.isdisjoint(): Return True if the set has no elements in common with other.

New in version 4.8.0.

discard(key)

As for set.discard(): Remove the key from the set, but only if it is present.

New in version 4.8.0.

pop()

As for set.pop(): Remove and return an arbitrary element; raise KeyError if the object is empty.

New in version 4.8.0.

__ixor__(other)

As for set.symmetric_difference_update(): Update this object, keeping only elements found in either set but not in both.

New in version 4.8.0.

interface BTrees.Interfaces.IKeySequence[source]

Extends: BTrees.Interfaces.IKeyed, zope.interface.common.collections.ISized

__getitem__(index)

Return the key in the given index position.

This allows iteration with for loops and use in functions, like map and list, that read sequences.

interface BTrees.Interfaces.IMinimalDictionary[source]

Extends: BTrees.Interfaces.IKeyed, zope.interface.common.collections.IMapping

Mapping operations.

Changed in version 4.8.0: Now extends zope.interface.common.collections.IMapping.

get(key, default)

Get the value associated with the given key.

Return the default if has_key() is false with the given key.

__getitem__(key)

Get the value associated with the given key.

Raise KeyError if has_key() is false with the given key.

__setitem__(key, value)

Set the value associated with the given key.

__delitem__(key)

Delete the value associated with the given key.

Raise class:KeyError if has_key() is false with the given key.

values(min=None, max=None, excludemin=False, excludemax=False)

Return an IMinimalSequence containing the values in the collection.

The type of the IMinimalSequence is not specified. It could be a list or a tuple or some other type.

All arguments are optional, and may be specified as keyword arguments, or by position.

If a min is specified, then output is constrained to values whose keys are greater than or equal to the given min, and, if excludemin is specified and true, is further constrained to values whose keys are strictly greater than min. A min value of None is ignored. If min is None or not specified, and excludemin is true, the value corresponding to the smallest key is excluded.

If a max is specified, then output is constrained to values whose keys are less than or equal to the given max, and, if excludemax is specified and true, is further constrained to values whose keys are strictly less than max. A max value of None is ignored. If max is None or not specified, and excludemax is true, the value corresponding to the largest key is excluded.

items(min=None, max=None, excludemin=False, excludemax=False)

Return an IMinimalSequence containing the items in the collection.

An item is a 2-tuple, a (key, value) pair.

The type of the IMinimalSequence is not specified. It could be a list or a tuple or some other type.

All arguments are optional, and may be specified as keyword arguments, or by position.

If a min is specified, then output is constrained to items whose keys are greater than or equal to the given min, and, if excludemin is specified and true, is further constrained to items whose keys are strictly greater than min. A min value of None is ignored. If min is None or not specified, and excludemin is true, the item with the smallest key is excluded.

If a max is specified, then output is constrained to items whose keys are less than or equal to the given max, and, if excludemax is specified and true, is further constrained to items whose keys are strictly less than *max. A max value of None is ignored. If max is None or not specified, and excludemax is true, the item with the largest key is excluded.

interface BTrees.Interfaces.IDictionaryIsh[source]

Extends: BTrees.Interfaces.IMinimalDictionary

update(collection)

Add the items from the given collection object to the collection.

The input collection must be a sequence of (key, value) 2-tuples, or an object with an ‘items’ method that returns a sequence of (key, value) pairs.

byValue(minValue)

Return a sequence of (value, key) pairs, sorted by value.

Values < minValue are omitted and other values are “normalized” by the minimum value. This normalization may be a noop, but, for integer values, the normalization is division.

setdefault(key, d)

D.setdefault(k, d) -> D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the dictionary as the value of k.

Note that, unlike as for Python’s dict.setdefault(), d is not optional. Python defaults d to None, but that doesn’t make sense for mappings that can’t have None as a value (for example, an IIBTree can have only integers as values).

pop(key, d)

D.pop(k[, d]) -> v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem()

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

New in version 4.8.0.

interface BTrees.Interfaces.IMerge[source]

Object with methods for merging sets, buckets, and trees.

These methods are supplied in modules that define collection classes with particular key and value types. The operations apply only to collections from the same module. For example, the BTrees.IIBTree.IIBTree.union() can only be used with IIBTree, IIBucket, IISet, and IITreeSet.

The number protocols methods __and__, __or__ and __sub__ are provided by all the data structures. They are shortcuts for intersection(), union() and difference().

The implementing module has a value type. The IOBTree and OOBTree modules have object value type. The IIBTree and OIBTree modules have integer value types. Other modules may be defined in the future that have other value types.

The individual types are classified into set (Set and TreeSet) and mapping (Bucket and BTree) types.

difference(c1, c2)

Return the keys or items in c1 for which there is no key in c2.

If c1 is None, then None is returned. If c2 is None, then c1 is returned.

If neither c1 nor c2 is None, the output is a Set if c1 is a Set or TreeSet, and is a Bucket if c1 is a Bucket or BTree.

While c1 must be one of those types, c2 can be any Python iterable returning the correct types of objects.

Changed in version 4.8.0: Add support for c2 to be an arbitrary iterable.

union(c1, c2)

Compute the Union of c1 and c2.

If c1 is None, then c2 is returned, otherwise, if c2 is None, then c1 is returned.

The output is a Set containing keys from the input collections.

c1 and c2 can be any Python iterables returning the correct type of objects.

Changed in version 4.8.0: Add support for arbitrary iterables.

intersection(c1, c2)

Compute the intersection of c1 and c2.

If c1 is None, then c2 is returned, otherwise, if c2 is None, then c1 is returned.

The output is a Set containing matching keys from the input collections.

c1 and c2 can be any Python iterables returning the correct type of objects.

Changed in version 4.8.0: Add support for arbitrary iterables.

interface BTrees.Interfaces.IIMerge[source]

Extends: BTrees.Interfaces.IMerge

Merge collections with integer value type.

A primary intent is to support operations with no or integer values, which are used as “scores” to rate indiviual keys. That is, in this context, a BTree or Bucket is viewed as a set with scored keys, using integer scores.

weightedUnion(c1, c2, weight1=1, weight2=1)

Compute the weighted union of c1 and c2.

If c1 and c2 are None, the output is (0, None).

If c1 is None and c2 is not None, the output is (weight2, c2).

If c1 is not None and c2 is None, the output is (weight1, c1).

Else, and hereafter, c1 is not None and c2 is not None.

If c1 and c2 are both sets, the output is 1 and the (unweighted) union of the sets.

Else the output is 1 and a Bucket whose keys are the union of c1 and c2’s keys, and whose values are:

v1*weight1 + v2*weight2

where:

  v1 is 0        if the key is not in c1
        1        if the key is in c1 and c1 is a set
        c1[key]  if the key is in c1 and c1 is a mapping

  v2 is 0        if the key is not in c2
        1        if the key is in c2 and c2 is a set
        c2[key]  if the key is in c2 and c2 is a mapping

Note that c1 and c2 must be collections.

weightedIntersection(c1, c2, weight1=1, weight2=1)

Compute the weighted intersection of c1 and c2.

If c1 and c2 are None, the output is (0, None).

If c1 is None and c2 is not None, the output is (weight2, c2).

If c1 is not None and c2 is None, the output is (weight1, c1).

Else, and hereafter, c1 is not None and c2 is not None.

If c1 and c2 are both sets, the output is the sum of the weights and the (unweighted) intersection of the sets.

Else the output is 1 and a Bucket whose keys are the intersection of c1 and c2’s keys, and whose values are:

v1*weight1 + v2*weight2

where:

  v1 is 1        if c1 is a set
        c1[key]  if c1 is a mapping

  v2 is 1        if c2 is a set
        c2[key]  if c2 is a mapping

Note that c1 and c2 must be collections.

interface BTrees.Interfaces.IMergeIntegerKey[source]

Extends: BTrees.Interfaces.IMerge

IMerge-able objects with integer keys.

Concretely, this means the types in IOBTree and IIBTree.

multiunion(seq)

Return union of (zero or more) integer sets, as an integer set.

seq is a sequence of objects each convertible to an integer set. These objects are convertible to an integer set:

The union is returned as a Set from the same module (for example, BTrees.IIBTree.multiunion() returns an BTrees.IIBTree.IISet).

The point to this method is that it can run much faster than doing a sequence of two-input union() calls. Under the covers, all the integers in all the inputs are sorted via a single linear-time radix sort, then duplicates are removed in a second linear-time pass.

Changed in version 4.8.0: Add support for arbitrary iterables of integers.

BTree Family APIs

interface BTrees.Interfaces.ISet[source]

Extends: BTrees.Interfaces.ISetMutable, BTrees.Interfaces.IKeySequence

A set of unique items stored in a single persistent object.

interface BTrees.Interfaces.ITreeSet[source]

Extends: BTrees.Interfaces.ISetMutable

A set of unique items stored in a tree of persistent objects.

interface BTrees.Interfaces.IBTree[source]

Extends: BTrees.Interfaces.IDictionaryIsh

insert(key, value)

Insert a key and value into the collection.

If the key was already in the collection, then there is no change and 0 is returned.

If the key was not already in the collection, then the item is added and 1 is returned.

This method is here to allow one to generate random keys and to insert and test whether the key was there in one operation.

A standard idiom for generating new keys will be:

key = generate_key()
while not t.insert(key, value):
    key=generate_key()
__and__(other)

Shortcut for intersection()

__or__(other)

Shortcut for union()

__sub__(other)

Shortcut for difference()

interface BTrees.Interfaces.IBTreeFamily[source]

the 64-bit or 32-bit family

IF

The IIntegerFloatBTreeModule for this family

II

The IIntegerIntegerBTreeModule for this family

IO

The IIntegerObjectBTreeModule for this family

IU

The IIntegerUnsignedBTreeModule for this family

UF

The IUnsignedFloatBTreeModule for this family

UI

The IUnsignedIntegerBTreeModule for this family

UO

The IUnsignedObjectBTreeModule for this family

UU

The IUnsignedUnsignedBTreeModule for this family

OI

The IObjectIntegerBTreeModule for this family

OO

The IObjectObjectBTreeModule for this family

OU

The IObjectUnsignedBTreeModule for this family

maxint

The maximum signed integer storable in this family

maxuint

The maximum unsigned integer storable in this family

minint

The minimum signed integer storable in this family

There are two families defined:

BTrees.family32 = <BTree family using 32 bits. Supports signed integer values from -2,147,483,648 to 2,147,483,647 and maximum unsigned integer value 4,294,967,295.>

32-bit BTree family.

BTrees.family64 = <BTree family using 64 bits. Supports signed integer values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 and maximum unsigned integer value 18,446,744,073,709,551,615.>

64-bit BTree family.

Module APIs

interface BTrees.Interfaces.IBTreeModule[source]

These are available in all modules (IOBTree, OIBTree, OOBTree, IIBTree, IFBTree, LFBTree, LOBTree, OLBTree, and LLBTree).

BTree

The IBTree for this module.

Also available as [prefix]BTree, as in IOBTree.

Bucket

The leaf-node data buckets used by the BTree.

(IBucket is not currently defined in this file, but is essentially IDictionaryIsh, with the exception of __nonzero__, as of this writing.)

Also available as [prefix]Bucket, as in IOBucket.

TreeSet

The ITreeSet for this module.

Also available as [prefix]TreeSet, as in IOTreeSet.

Set

The ISet for this module: the leaf-node data buckets used by the TreeSet.

Also available as [prefix]BTree, as in IOSet.

interface BTrees.Interfaces.IObjectObjectBTreeModule[source]

Extends: BTrees.Interfaces.IBTreeModule, BTrees.Interfaces.IMerge

keys, or set values, are objects; values are also objects.

Object keys (and set values) must sort reliably (for instance, not on object id)! Homogenous key types recommended.

describes OOBTree

interface BTrees.Interfaces.IIntegerObjectBTreeModule[source]

Extends: BTrees.Interfaces._IMergeBTreeModule

keys, or set values, are signed integers; values are objects.

describes IOBTree and LOBTree

interface BTrees.Interfaces.IObjectIntegerBTreeModule[source]

Extends: BTrees.Interfaces._IMergeBTreeModule

keys, or set values, are objects; values are signed integers.

Object keys (and set values) must sort reliably (for instance, not on object id)! Homogenous key types recommended.

describes OIBTree and LOBTree

interface BTrees.Interfaces.IIntegerIntegerBTreeModule[source]

Extends: BTrees.Interfaces._IMergeBTreeModule, BTrees.Interfaces.IMergeIntegerKey

keys, or set values, are signed integers; values are also signed integers.

describes IIBTree and LLBTree

interface BTrees.Interfaces.IIntegerFloatBTreeModule[source]

Extends: BTrees.Interfaces._IMergeBTreeModule

keys, or set values, are signed integers; values are floats.

describes IFBTree and LFBTree

Utilities

class BTrees.Length.Length(v=0)[source]

Bases: Persistent

BTree lengths are often too expensive to compute.

Objects that use BTrees need to keep track of lengths themselves. This class provides an object for doing this.

As a bonus, the object support application-level conflict resolution.

It is tempting to to assign length objects to __len__ attributes to provide instance-specific __len__ methods. However, this no longer works as expected, because new-style classes cache class-defined slot methods (like __len__) in C type slots. Thus, instance-defined slot fillers are ignored.

__call__(*args)[source]

Return the current length value.

__getstate__()[source]

Get the object serialization state

If the object has no assigned slots and has no instance dictionary, then None is returned.

If the object has no assigned slots and has an instance dictionary, then the a copy of the instance dictionary is returned. The copy has any items with names starting with ‘_v_’ or ‘_p_’ ommitted.

If the object has assigned slots, then a two-element tuple is returned. The first element is either None or a copy of the instance dictionary, as described above. The second element is a dictionary with items for each of the assigned slots.

__init__(v=0)[source]
__setstate__(v)[source]

Set the object serialization state

The state should be in one of 3 forms:

  • None

    Ignored

  • A dictionary

    In this case, the object’s instance dictionary will be cleared and updated with the new state.

  • A two-tuple with a string as the first element.

    In this case, the method named by the string in the first element will be called with the second element.

    This form supports migration of data formats.

  • A two-tuple with None or a Dictionary as the first element and with a dictionary as the second element.

    If the first element is not None, then the object’s instance dictionary will be cleared and updated with the value.

    The items in the second element will be assigned as attributes.

change(delta)[source]

Add delta to the length value.

set(v)[source]

Set the length value to v.

__dict__ = mappingproxy({'__module__': 'BTrees.Length', '__doc__': 'BTree lengths are often too expensive to compute.\n\n    Objects that use BTrees need to keep track of lengths themselves.\n    This class provides an object for doing this.\n\n    As a bonus, the object support application-level conflict\n    resolution.\n\n    It is tempting to to assign length objects to __len__ attributes\n    to provide instance-specific __len__ methods.  However, this no\n    longer works as expected, because new-style classes cache\n    class-defined slot methods (like __len__) in C type slots.  Thus,\n    instance-defined slot fillers are ignored.\n    ', 'value': 0, '__init__': <function Length.__init__>, '__getstate__': <function Length.__getstate__>, '__setstate__': <function Length.__setstate__>, 'set': <function Length.set>, '_p_resolveConflict': <function Length._p_resolveConflict>, 'change': <function Length.change>, '__call__': <function Length.__call__>, '__dict__': <attribute '__dict__' of 'Length' objects>, '__weakref__': <attribute '__weakref__' of 'Length' objects>, '__annotations__': {}})
__module__ = 'BTrees.Length'
__weakref__

list of weak references to the object (if defined)

value = 0

Utilities for working with BTrees (TreeSets, Buckets, and Sets) at a low level.

The primary function is check(btree), which performs value-based consistency checks of a kind BTree._Tree._check() does not perform. See the function docstring for details.

display(btree) displays the internal structure of a BTree (TreeSet, etc) to stdout.

CAUTION: When a BTree node has only a single bucket child, it can be impossible to get at the bucket from Python code (__getstate__() may squash the bucket object out of existence, as a pickling storage optimization). In such a case, the code here synthesizes a temporary bucket with the same keys (and values, if the bucket is of a mapping type). This has no first-order consequences, but can mislead if you pay close attention to reported object addresses and/or object identity (the synthesized bucket has an address that doesn’t exist in the actual BTree).

class BTrees.check.Checker(obj)[source]

Bases: Walker

__init__(obj)[source]
check()[source]
check_sorted(obj, path, keys, lo, hi)[source]
complain(msg, obj, path)[source]
visit_btree(obj, path, parent, is_mapping, keys, kids, lo, hi)[source]
visit_bucket(obj, path, parent, is_mapping, keys, values, lo, hi)[source]
__module__ = 'BTrees.check'
class BTrees.check.Printer(obj)[source]

Bases: Walker

__init__(obj)[source]
display()[source]
visit_btree(obj, path, parent, is_mapping, keys, kids, lo, hi)[source]
visit_bucket(obj, path, parent, is_mapping, keys, values, lo, hi)[source]
__annotations__ = {}
__module__ = 'BTrees.check'
class BTrees.check.Walker(obj)[source]

Bases: object

__init__(obj)[source]
visit_btree(obj, path, parent, is_mapping, keys, kids, lo, hi)[source]
visit_bucket(obj, path, parent, is_mapping, keys, values, lo, hi)[source]
walk()[source]
__annotations__ = {}
__dict__ = mappingproxy({'__module__': 'BTrees.check', '__init__': <function Walker.__init__>, 'visit_btree': <function Walker.visit_btree>, 'visit_bucket': <function Walker.visit_bucket>, 'walk': <function Walker.walk>, '__dict__': <attribute '__dict__' of 'Walker' objects>, '__weakref__': <attribute '__weakref__' of 'Walker' objects>, '__doc__': None, '__annotations__': {}})
__module__ = 'BTrees.check'
__weakref__

list of weak references to the object (if defined)

BTrees.check.check(btree)[source]

Check internal value-based invariants in a BTree or TreeSet.

The BTrees._base._Tree._check method checks internal C-level pointer consistency. The check() function here checks value-based invariants: whether the keys in leaf bucket and internal nodes are in strictly increasing order, and whether they all lie in their expected range. The latter is a subtle invariant that can’t be checked locally – it requires propagating range info down from the root of the tree, and modifying it at each level for each child.

Raises AssertionError if anything is wrong, with a string detail explaining the problems. The entire tree is checked before AssertionError is raised, and the string detail may be large (depending on how much went wrong).

BTrees.check.classify(obj)[source]
BTrees.check.crack_btree(t, is_mapping)[source]
BTrees.check.crack_bucket(b, is_mapping)[source]
BTrees.check.display(btree)[source]

Display the internal structure of a BTree, Bucket, TreeSet or Set.

BTrees.check.type_and_adr(obj)[source]

BTree Data Structure Variants

Integer Keys

Float Values

BTrees.IFBTree.BTree

alias of IFBTree

BTrees.IFBTree.Bucket

alias of IFBucket

class BTrees.IFBTree.IFBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(IFBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
class BTrees.IFBTree.IFBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.IFBTree.IFSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.IFBTree.IFTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(IFTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
BTrees.IFBTree.Set

alias of IFSet

BTrees.IFBTree.TreeSet

alias of IFTreeSet

BTrees.IFBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.IFBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.IFBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.IFBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.IFBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.IFBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Integer Values

BTrees.IIBTree.BTree

alias of IIBTree

BTrees.IIBTree.Bucket

alias of IIBucket

class BTrees.IIBTree.IIBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(IIBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
class BTrees.IIBTree.IIBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.IIBTree.IISet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.IIBTree.IITreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(IITreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
BTrees.IIBTree.Set

alias of IISet

BTrees.IIBTree.TreeSet

alias of IITreeSet

BTrees.IIBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.IIBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.IIBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.IIBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.IIBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.IIBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Object Values

BTrees.IOBTree.BTree

alias of IOBTree

BTrees.IOBTree.Bucket

alias of IOBucket

class BTrees.IOBTree.IOBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(IOBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 60
class BTrees.IOBTree.IOBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.IOBTree.IOSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.IOBTree.IOTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(IOTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 60
BTrees.IOBTree.Set

alias of IOSet

BTrees.IOBTree.TreeSet

alias of IOTreeSet

BTrees.IOBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.IOBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.IOBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.IOBTree.union(o1, o2)

compute the union of o1 and o2

Unsigned Integer Values

BTrees.IUBTree.BTree

alias of IUBTree

BTrees.IUBTree.Bucket

alias of IUBucket

class BTrees.IUBTree.IUBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(IUBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
class BTrees.IUBTree.IUBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.IUBTree.IUSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.IUBTree.IUTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(IUTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
BTrees.IUBTree.Set

alias of IUSet

BTrees.IUBTree.TreeSet

alias of IUTreeSet

BTrees.IUBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.IUBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.IUBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.IUBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.IUBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.IUBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Long Integer Keys

Float Values

BTrees.LFBTree.BTree

alias of LFBTree

BTrees.LFBTree.Bucket

alias of LFBucket

class BTrees.LFBTree.LFBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(LFBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
class BTrees.LFBTree.LFBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.LFBTree.LFSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.LFBTree.LFTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(LFTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
BTrees.LFBTree.Set

alias of LFSet

BTrees.LFBTree.TreeSet

alias of LFTreeSet

BTrees.LFBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.LFBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.LFBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.LFBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.LFBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.LFBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Long Integer Values

BTrees.LLBTree.BTree

alias of LLBTree

BTrees.LLBTree.Bucket

alias of LLBucket

class BTrees.LLBTree.LLBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(LLBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
class BTrees.LLBTree.LLBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.LLBTree.LLSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.LLBTree.LLTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(LLTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
BTrees.LLBTree.Set

alias of LLSet

BTrees.LLBTree.TreeSet

alias of LLTreeSet

BTrees.LLBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.LLBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.LLBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.LLBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.LLBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.LLBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Object Values

BTrees.LOBTree.BTree

alias of LOBTree

BTrees.LOBTree.Bucket

alias of LOBucket

class BTrees.LOBTree.LOBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(LOBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 60
class BTrees.LOBTree.LOBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.LOBTree.LOSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.LOBTree.LOTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(LOTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 60
BTrees.LOBTree.Set

alias of LOSet

BTrees.LOBTree.TreeSet

alias of LOTreeSet

BTrees.LOBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.LOBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.LOBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.LOBTree.union(o1, o2)

compute the union of o1 and o2

Quad Unsigned Integer Values

BTrees.LQBTree.BTree

alias of LQBTree

BTrees.LQBTree.Bucket

alias of LQBucket

class BTrees.LQBTree.LQBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(LQBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
class BTrees.LQBTree.LQBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.LQBTree.LQSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.LQBTree.LQTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(LQTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 500
max_leaf_size = 120
BTrees.LQBTree.Set

alias of LQSet

BTrees.LQBTree.TreeSet

alias of LQTreeSet

BTrees.LQBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.LQBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.LQBTree.multiunion(seq)

compute union of a sequence of integer sets.

Each element of seq must be an integer set, or convertible to one via the set iteration protocol. The union returned is an IISet.

BTrees.LQBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.LQBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.LQBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Object Keys

Integer Values

BTrees.OIBTree.BTree

alias of OIBTree

BTrees.OIBTree.Bucket

alias of OIBucket

class BTrees.OIBTree.OIBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(OIBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 250
max_leaf_size = 60
class BTrees.OIBTree.OIBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.OIBTree.OISet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.OIBTree.OITreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(OITreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 250
max_leaf_size = 60
BTrees.OIBTree.Set

alias of OISet

BTrees.OIBTree.TreeSet

alias of OITreeSet

BTrees.OIBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.OIBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.OIBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.OIBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.OIBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Long Integer Values

BTrees.OLBTree.BTree

alias of OLBTree

BTrees.OLBTree.Bucket

alias of OLBucket

class BTrees.OLBTree.OLBTree

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__() state

Return the picklable state of the BTree.

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__(state)

Set the state of the BTree.

__sub__(value, /)

Return self-value.

byValue(min) list of value, key pairs

Returns list of value, key pairs where the value is >= min. The list is sorted by value. Note that items() returns keys in the opposite order.

clear()

Remove all of the items from the BTree.

get(key[, default=None]) Value for key or default

Return the value or the default if the key is not found.

has_key(key)

Return true if the BTree contains the given key.

insert(key, value) 0 or 1

Add an item if the key is not already used. Return 1 if the item was added, or 0 otherwise.

items([min, max]) -- list of key, value pairs

Returns the items of the BTree. If min and max are supplied, only items with keys greater than min and less than max are returned.

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys([min, max]) list of keys

Returns the keys of the BTree. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the BTree as the value of k.

update(collection)

Add the items from the given collection.

values([min, max]) list of values

Returns the values of the BTree. If min and max are supplied, only values corresponding to keys greater than min and less than max are returned.

__implemented__ = classImplements(OLBTree, IBTree)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 250
max_leaf_size = 60
class BTrees.OLBTree.OLBucket

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__delitem__(key, /)

Delete self[key].

__getitem__(key, /)

Return self[key].

__getstate__()

__getstate__() – Return the picklable state of the object

__init__(*args, **kwargs)
__iter__()

Implement iter(self).

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__setitem__(key, value, /)

Set self[key] to value.

__setstate__()

__setstate__() – Set the state of the object

__sub__(value, /)

Return self-value.

byValue()

byValue(min) – Return value-keys with values >= min and reverse sorted by values

clear()

clear() – Remove all of the items from the bucket

get()

get(key[,default]) – Look up a value

Return the default (or None) if the key is not found.

has_key()

has_key(key) – Test whether the bucket contains the given key

items()

items([min, max])) – Return the items

iteritems([min[, max]]) an iterator over the (key, value) items of B
iterkeys([min[, max]]) an iterator over the keys of B
itervalues([min[, max]]) an iterator over the values of B
keys()

keys([min, max]) – Return the keys

maxKey()

maxKey([key]) – Find the maximum key

If an argument is given, find the maximum <= the argument

minKey()

minKey([key]) – Find the minimum key

If an argument is given, find the minimum >= the argument

pop(k[, d]) v, remove key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k, d) D.get(k, d), also set D[k]=d if k not in D.

Return the value like get() except that if key is missing, d is both returned and inserted into the bucket as the value of k.

update()

update(collection) – Add the items from the given collection

values()

values([min, max]) – Return the values

__slotnames__ = ()
class BTrees.OLBTree.OLSet

Bases: Persistent

__and__(value, /)

Return self&value.

__contains__(key, /)

Return key in self.

__getitem__(key, /)

Return self[key].

__getstate__()

Return the picklable state of the object

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__()

Set the state of the object

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add(id)

Add a key to the set

clear()

Remove all of the items from the bucket

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Test whether the bucket contains the given key

insert(id)

Add a key to the set

isdisjoint()

Return True if two sets have a null intersection.

keys()

Return the keys

maxKey([key])

Find the maximum key

If an argument is given, find the maximum <= the argument

minKey([key])

Find the minimum key

If an argument is given, find the minimum >= the argument

pop()

Remove and return an arbitrary item.

remove(id)

Remove an id from the set

update(seq)

Add the items from the given sequence to the set

__slotnames__ = ()
class BTrees.OLBTree.OLTreeSet

Bases: Persistent

__and__(value, /)

Return self&value.

__bool__()

True if self else False

__contains__(key, /)

Return key in self.

__getstate__() state

Return the picklable state of the TreeSet.

__iand__(value, /)

Return self&=value.

__init__(*args, **kwargs)
__ior__(value, /)

Return self|=value.

__isub__(value, /)

Return self-=value.

__iter__()

Implement iter(self).

__ixor__(value, /)

Return self^=value.

__len__()

Return len(self).

__new__(**kwargs)
__or__(value, /)

Return self|value.

__rand__(value, /)

Return value&self.

__ror__(value, /)

Return value|self.

__rsub__(value, /)

Return value-self.

__rxor__(value, /)

Return value^self.

__setstate__(state)

Set the state of the TreeSet.

__sub__(value, /)

Return self-value.

__xor__(value, /)

Return self^value.

add()

add(id) – Add an item to the set

clear()

Remove all of the items from the BTree.

discard()

Remove an element from a set if it is a member.

If the element is not a member, do nothing.

has_key(key)

Return true if the TreeSet contains the given key.

insert()

insert(id) – Add an item to the set

isdisjoint()

Return True if two sets have a null intersection.

keys([min, max]) list of keys

Returns the keys of the TreeSet. If min and max are supplied, only keys greater than min and less than max are returned.

maxKey([max]) key

Return the largest key in the BTree. If max is specified, return the largest key <= max.

minKey([mi]) key

Return the smallest key in the BTree. If min is specified, return the smallest key >= min.

pop()

pop() – Remove and return a key from the set

remove()

remove(id) – Remove a key from the set

update(collection)

Add the items from the given collection.

__implemented__ = classImplements(OLTreeSet, ITreeSet)
__providedBy__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

__slotnames__ = ()
max_internal_size = 250
max_leaf_size = 60
BTrees.OLBTree.Set

alias of OLSet

BTrees.OLBTree.TreeSet

alias of OLTreeSet

BTrees.OLBTree.difference(o1, o2)

compute the difference between o1 and o2

BTrees.OLBTree.intersection(o1, o2)

compute the intersection of o1 and o2

BTrees.OLBTree.union(o1, o2)

compute the union of o1 and o2

BTrees.OLBTree.weightedIntersection(o1, o2[, w1, w2])

compute the intersection of o1 and o2

w1 and w2 are weights.

BTrees.OLBTree.weightedUnion(o1, o2[, w1, w2])

compute the union of o1 and o2

w1 and w2 are weights.

Object Values

BTrees.OOBTree.BTree

alias of OOBTree

BTrees.OOBTree.Bucket

alias of OOBucket

class BTrees.OOBTree.OOBTree

Bases: Persistent

__and__(value