Changelog and documentation

zopefoundation · Jun 2, 2020 · 13060d0 · 13060d0
1 parent 5f15484
commit 13060d0
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/BTrees/Interfaces.py b/BTrees/Interfaces.py
@@ -277,6 +277,10 @@ class IMerge(Interface):
     :meth:`BTrees.IIBTree.IIBTree.union` can only be used with :class:`~BTrees.IIBTree.IIBTree`,
     :class:`~BTrees.IIBTree.IIBucket`, :class:`~BTrees.IIBTree.IISet`, and :class:`~BTrees.IIBTree.IITreeSet`.
 
+    The number protocols methods ``__and__``, ``__or__`` and ``__sub__`` are provided
+    by all the data structures. They are shortcuts for :meth:`~BTrees.Interfaces.IMerge.intersection`,
+    :meth:`~BTrees.Interfaces.IMerge.union` and :meth:`~BTrees.Interfaces.IMerge.difference`.
+
     The implementing module has a value type. The :class:`~BTrees.IOBTree.IOBTree` and :class:`~BTrees.OOBTree.OOBTree`
     modules have object value type. The :class:`~BTrees.IIBTree.IIBTree` and :class:`~BTrees.OIBTree.OIBTree` modules
     have integer value types. Other modules may be defined in the
@@ -316,6 +320,16 @@ def intersection(c1, c2):
         collections.
         """
 
+    def __and__(self, other):
+        """Shortcut for :meth:`~BTrees.Interfaces.IMerge.intersection`"""
+
+    def __or__(self, other):
+        """Shortcut for :meth:`~BTrees.Interfaces.IMerge.union`"""
+
+    def __sub__(self, other):
+        """Shortcut for :meth:`~BTrees.Interfaces.IMerge.difference`"""
+
+
 
 class IBTreeModule(Interface):
     """These are available in all modules (IOBTree, OIBTree, OOBTree, IIBTree,

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -5,7 +5,11 @@
 4.7.3 (unreleased)
 ==================
 
-- Nothing changed yet.
+- BTrees, TreeSet, Set and Buckets implements the ``__and__``,
+  ``__or__`` and ``__sub__`` as shortcuts for
+  :meth:`~BTrees.Interfaces.IMerge.intersection`,
+  :meth:`~BTrees.Interfaces.IMerge.union` and
+  :meth:`~BTrees.Interfaces.IMerge.difference`.
 
 
 4.7.2 (2020-04-07)