Filter for maybe

Author: CucumisSativus

returns/maybe.py

@@ -141,6 +141,20 @@ def bind_optional(
 
         """
 
+    def filter(self,
+               function: Callable[[_ValueType], bool],
+               ) -> 'Maybe[_ValueType]':
+        """
+        Apply a predicate over the value. If the predicate returns true it returns the original value wrapped with Some.
+        If the predicate returns false, Nothing is returned
+
+        .. code:: python
+            >>> from returns.maybe import Maybe, Nothing, Some
+
+            >>> assert Some(5).filter(lambda x: x % 2 == 0) == Nothing
+            >>> assert Some(6).filter(lambda x: x % 2 == 0) == Some(6)
+            >>> assert Nothing.filter(lambda x: True) == Nothing
+        """
     def lash(
         self,
         function: Callable[[Any], Kind1['Maybe', _ValueType]],
@@ -338,6 +352,10 @@ def bind_optional(self, function):
         """Does nothing."""
         return self
 
+    def filter(self, function):
+        """Does nothing for ``Nothing`` """
+        return self
+
     def lash(self, function):
         """Composes this container with a function returning container."""
         return function(None)
@@ -414,6 +432,12 @@ def failure(self):
         """Raises exception for successful container."""
         raise UnwrapFailedError(self)
 
+    def filter(self, function):
+        if function(self._inner_value):
+            return self
+        else:
+            return _Nothing()
+
 
 Maybe.success_type = Some
 Maybe.failure_type = _Nothing

tests/test_maybe/test_maybe_filter.py

@@ -0,0 +1,10 @@
+from returns.maybe import Maybe, Nothing, Some
+
+
+def test_maybe_filter():
+    def predicate(value):
+        return value % 2 == 0
+
+    assert Some(5).filter(predicate) == Nothing
+    assert Some(6).filter(predicate) == Some(6)
+    assert Nothing.filter(predicate) == Nothing