Add logical operator support (__and__/__or__ methods on dataframe and column) (#171)

* fix __and__ docstring

* fix __and__ docs, add __or__

* more fixups

* Update spec/API_specification/dataframe_api/dataframe_object.py

* note that nulls should follow kleene logic

* type return

* Update spec/API_specification/dataframe_api/column_object.py

Author: MarcoGorelli

spec/API_specification/dataframe_api/column_object.py

@@ -73,6 +73,8 @@ def __eq__(self, other: Column | Scalar) -> Column:
         """
         Compare for equality.
 
+        Nulls should follow Kleene Logic.
+
         Parameters
         ----------
         other : Column or Scalar
@@ -89,6 +91,8 @@ def __ne__(self, other: Column | Scalar) -> Column:
         """
         Compare for non-equality.
 
+        Nulls should follow Kleene Logic.
+
         Parameters
         ----------
         other : Column or Scalar
@@ -165,9 +169,51 @@ def __lt__(self, other: Column | Scalar) -> Column:
         Column
         """
 
-    def __and__(self, other: Column | Scalar) -> Column:
+    def __and__(self, other: Column[bool] | bool) -> Column[bool]:
+        """
+        Apply logical 'and' to `other` Column (or scalar) and this Column.
+
+        Nulls should follow Kleene Logic.
+
+        Parameters
+        ----------
+        other : Column[bool] or bool
+            If Column, must have same length.
+
+        Returns
+        -------
+        Column
+
+        Raises
+        ------
+        ValueError
+            If `self` or `other` is not boolean.
+        """
+
+    def __or__(self, other: Column[bool] | bool) -> Column[bool]:
+        """
+        Apply logical 'or' to `other` Column (or scalar) and this column.
+
+        Nulls should follow Kleene Logic.
+
+        Parameters
+        ----------
+        other : Column[bool] or Scalar
+            If Column, must have same length.
+
+        Returns
+        -------
+        Column[bool]
+
+        Raises
+        ------
+        ValueError
+            If `self` or `other` is not boolean.
+        """
+
+    def __add__(self, other: Column | Scalar) -> Column:
         """
-        Add `other` dataframe or scalar to this column.
+        Add `other` column or scalar to this column.
 
         Parameters
         ----------
@@ -183,7 +229,7 @@ def __and__(self, other: Column | Scalar) -> Column:
 
     def __sub__(self, other: Column | Scalar) -> Column:
         """
-        Subtract `other` dataframe or scalar from this column.
+        Subtract `other` column or scalar from this column.
 
         Parameters
         ----------
@@ -199,7 +245,7 @@ def __sub__(self, other: Column | Scalar) -> Column:
 
     def __mul__(self, other: Column | Scalar) -> Column:
         """
-        Multiply `other` dataframe or scalar with this column.
+        Multiply `other` column or scalar with this column.
 
         Parameters
         ----------
@@ -231,7 +277,7 @@ def __truediv__(self, other: Column | Scalar) -> Column:
 
     def __floordiv__(self, other: Column | Scalar) -> Column:
         """
-        Floor-divide `other` dataframe or scalar to this column.
+        Floor-divide `other` column or scalar to this column.
 
         Parameters
         ----------

spec/API_specification/dataframe_api/dataframe_object.py

@@ -295,6 +295,8 @@ def __eq__(self, other: DataFrame | Scalar) -> DataFrame:
         """
         Compare for equality.
 
+        Nulls should follow Kleene Logic.
+
         Parameters
         ----------
         other : DataFrame or Scalar
@@ -312,6 +314,8 @@ def __ne__(self, other: DataFrame | Scalar) -> DataFrame:
         """
         Compare for non-equality.
 
+        Nulls should follow Kleene Logic.
+
         Parameters
         ----------
         other : DataFrame or Scalar
@@ -393,6 +397,48 @@ def __lt__(self, other: DataFrame | Scalar) -> DataFrame:
         """
         ...
 
+    def __and__(self, other: DataFrame[bool] | bool) -> DataFrame[bool]:
+        """
+        Apply logical 'and' to `other` DataFrame (or scalar) and this dataframe.
+
+        Nulls should follow Kleene Logic.
+
+        Parameters
+        ----------
+        other : DataFrame[bool] or bool
+            If DataFrame, must have same length.
+
+        Returns
+        -------
+        DataFrame[bool]
+
+        Raises
+        ------
+        ValueError
+            If `self` or `other` is not boolean.
+        """
+
+    def __or__(self, other: DataFrame[bool] | bool) -> DataFrame[bool]:
+        """
+        Apply logical 'or' to `other` DataFrame (or scalar) and this DataFrame.
+
+        Nulls should follow Kleene Logic.
+
+        Parameters
+        ----------
+        other : DataFrame[bool] or bool
+            If DataFrame, must have same length.
+
+        Returns
+        -------
+        DataFrame[bool]
+
+        Raises
+        ------
+        ValueError
+            If `self` or `other` is not boolean.
+        """
+
     def __add__(self, other: DataFrame | Scalar) -> DataFrame:
         """
         Add `other` dataframe or scalar to this dataframe.