:mod:`BTrees` API Reference
===========================


Protocol APIs
-------------

.. automodule:: BTrees.Interfaces

  .. autointerface:: ICollection
     :members:
     :member-order: bysource

  .. autointerface:: IReadSequence
     :members:
     :member-order: bysource

  .. autointerface:: IKeyed
     :members:
     :member-order: bysource

  .. autointerface:: ISetMutable
     :members:
     :member-order: bysource

  .. autointerface:: ISized
     :members:
     :member-order: bysource

  .. autointerface:: IKeySequence
     :members:
     :member-order: bysource

  .. autointerface:: IMinimalDictionary
     :members:
     :member-order: bysource

  .. autointerface:: IDictionaryIsh
     :members:
     :member-order: bysource

  .. autointerface:: IMerge
     :members:
     :member-order: bysource

  .. autointerface:: IIMerge
     :members:
     :member-order: bysource

  .. autointerface:: IMergeIntegerKey
     :members:
     :member-order: bysource

  BTree Family APIs
  -----------------

  .. autointerface:: ISet
     :members:
     :member-order: bysource

  .. autointerface:: ITreeSet
     :members:
     :member-order: bysource

  .. autointerface:: IBTree
     :members:
     :member-order: bysource

  .. autointerface:: IBTreeFamily
     :members:
     :member-order: bysource

  Module APIs
  -----------

  .. autointerface:: IBTreeModule
     :members:
     :member-order: bysource

  .. autointerface:: IObjectObjectBTreeModule
     :members:
     :member-order: bysource

  .. autointerface:: IIntegerObjectBTreeModule
     :members:
     :member-order: bysource

  .. autointerface:: IObjectIntegerBTreeModule
     :members:
     :member-order: bysource

  .. autointerface:: IIntegerIntegerBTreeModule
     :members:
     :member-order: bysource

  .. autointerface:: IIntegerFloatBTreeModule
     :members:
     :member-order: bysource
