Adds .from_io constructor to ReaderFutureResult and ReaderIOResult, refs #274

Author: sobolevn

CHANGELOG.md

@@ -68,7 +68,9 @@ See [0Ver](https://0ver.org/).
 - Adds `bind_io` method to `IOResult`
 - Adds `bind_io` method to `RequiresContextIOResult`
 - Adds `or_else` method to `Maybe`
+- Adds `.from_io` and `.from_failed_io` to `RequiresContextIOResult`
 
+- Syncs naming in `from_*` methods, now all parameters are named `inner_value`
 - Adds `not_` composition helper
 - Adds `flatten` support for `Future`,
   `FutureResult` and `RequiresContextFutureResult`

docs/pages/context.rst

@@ -421,6 +421,21 @@ How to create unit objects?
 - ``from_value`` when you want to mark some raw value as a ``Success``
 - ``from_failure`` when you want to mark some raw value as a ``Failure``
 - ``from_result`` when you already have ``Result`` container
+- ``from_io`` when you have successful ``IO`` container
+- ``from_failed_io`` when you have failed ``IO`` container
+- ``from_ioresult`` when you already have ``IOResult`` container
+- ``from_context`` when you have successful ``RequiresContext``
+- ``from_failed_context`` when you have failed ``RequiresContext``
+- ``from_typecast`` when you have ``RequiresContext[..., IOResult]``
+
+``RequiresContextFutureResult`` requires
+you to use one of the following methods:
+
+- ``from_value`` when you want to mark some raw value as a ``Success``
+- ``from_failure`` when you want to mark some raw value as a ``Failure``
+- ``from_result`` when you already have ``Result`` container
+- ``from_io`` when you have successful ``IO`` container
+- ``from_failed_io`` when you have failed ``IO`` container
 - ``from_ioresult`` when you already have ``IOResult`` container
 - ``from_context`` when you have successful ``RequiresContext``
 - ``from_failed_context`` when you have failed ``RequiresContext``

returns/context/requires_context.py

@@ -229,7 +229,7 @@ def from_value(
     @classmethod
     def from_iterable(
         cls,
-        containers: Iterable['RequiresContext[_EnvType, _ValueType]'],
+        inner_value: Iterable['RequiresContext[_EnvType, _ValueType]'],
     ) -> 'RequiresContext[_EnvType, Sequence[_ValueType]]':
         """
         Transforms an iterable of ``RequiresContext`` containers.
@@ -246,12 +246,12 @@ def from_iterable(
           ... ])(...) == (1, 2)
 
         """
-        return iterable(cls, containers)
+        return iterable(cls, inner_value)
 
     @classmethod
     def from_requires_context_result(
         cls,
-        container: 'RequiresContextResult[_EnvType, _ValueType, _ErrorType]',
+        inner_value: 'RequiresContextResult[_EnvType, _ValueType, _ErrorType]',
     ) -> 'RequiresContext[_EnvType, Result[_ValueType, _ErrorType]]':
         """
         Typecasts ``RequiresContextResult`` to ``RequiresContext`` instance.
@@ -271,12 +271,13 @@ def from_requires_context_result(
         Can be reverted with ``RequiresContextResult.from_typecast``.
 
         """
-        return RequiresContext(container)
+        return RequiresContext(inner_value)
 
     @classmethod
     def from_requires_context_ioresult(
         cls,
-        container: 'RequiresContextIOResult[_EnvType, _ValueType, _ErrorType]',
+        inner_value:
+            'RequiresContextIOResult[_EnvType, _ValueType, _ErrorType]',
     ) -> 'RequiresContext[_EnvType, IOResult[_ValueType, _ErrorType]]':
         """
         Typecasts ``RequiresContextIOResult`` to ``RequiresContext`` instance.
@@ -296,7 +297,7 @@ def from_requires_context_ioresult(
         Can be reverted with ``RequiresContextIOResult.from_typecast``.
 
         """
-        return RequiresContext(container)
+        return RequiresContext(inner_value)
 
 
 @final

returns/context/requires_context_future_result.py

@@ -664,6 +664,54 @@ def from_result(
             lambda _: FutureResult.from_result(inner_value),
         )
 
+    @classmethod
+    def from_io(
+        cls,
+        inner_value: IO[_NewValueType],
+    ) -> 'RequiresContextFutureResult[NoDeps, _NewValueType, Any]':
+        """
+        Creates new container from successful ``IO`` value.
+
+        .. code:: python
+
+          >>> import anyio
+          >>> from returns.io import IO, IOSuccess
+          >>> from returns.context import RequiresContextFutureResult
+
+          >>> assert anyio.run(
+          ...     RequiresContextFutureResult.from_io(IO(1)),
+          ...     RequiresContextFutureResult.empty,
+          ... ) == IOSuccess(1)
+
+        """
+        return RequiresContextFutureResult(
+            lambda deps: FutureResult.from_io(inner_value),
+        )
+
+    @classmethod
+    def from_failed_io(
+        cls,
+        inner_value: IO[_NewErrorType],
+    ) -> 'RequiresContextFutureResult[NoDeps, Any, _NewErrorType]':
+        """
+        Creates a new container from failed ``IO`` value.
+
+        .. code:: python
+
+          >>> import anyio
+          >>> from returns.io import IO, IOFailure
+          >>> from returns.context import RequiresContextFutureResult
+
+          >>> assert anyio.run(
+          ...     RequiresContextFutureResult.from_failed_io(IO(1)),
+          ...     RequiresContextFutureResult.empty,
+          ... ) == IOFailure(1)
+
+        """
+        return RequiresContextFutureResult(
+            lambda deps: FutureResult.from_failed_io(inner_value),
+        )
+
     @classmethod
     def from_ioresult(
         cls, inner_value: IOResult[_ValueType, _ErrorType],
@@ -695,7 +743,7 @@ def from_ioresult(
     @classmethod
     def from_typecast(
         cls,
-        container: 'RequiresContext['
+        inner_value: 'RequiresContext['
             '_EnvType, FutureResult[_NewValueType, _NewErrorType]]',
     ) -> 'RequiresContextFutureResult[_EnvType, _NewValueType, _NewErrorType]':
         """
@@ -728,7 +776,7 @@ def from_typecast(
           ... ) == IOFailure(1)
 
         """
-        return RequiresContextFutureResult(container)
+        return RequiresContextFutureResult(inner_value)
 
     @classmethod
     def from_context(
@@ -860,7 +908,7 @@ def from_failure(
     @classmethod
     def from_iterable(
         cls,
-        containers:
+        inner_value:
             Iterable[
                 'RequiresContextFutureResult[_EnvType, _ValueType, _ErrorType]',
             ],
@@ -893,7 +941,7 @@ def from_iterable(
           ... ) == IOFailure('a')
 
         """
-        return iterable(cls, containers)
+        return iterable(cls, inner_value)
 
 
 @final

returns/context/requires_context_ioresult.py

@@ -619,6 +619,50 @@ def from_result(
             lambda _: IOResult.from_result(inner_value),
         )
 
+    @classmethod
+    def from_io(
+        cls,
+        inner_value: IO[_NewValueType],
+    ) -> 'RequiresContextIOResult[NoDeps, _NewValueType, Any]':
+        """
+        Creates new container from successful ``IO`` value.
+
+        .. code:: python
+
+          >>> from returns.io import IO, IOSuccess
+          >>> from returns.context import RequiresContextIOResult
+
+          >>> assert RequiresContextIOResult.from_io(IO(1))(
+          ...     RequiresContextIOResult.empty,
+          ... ) == IOSuccess(1)
+
+        """
+        return RequiresContextIOResult(
+            lambda deps: IOResult.from_io(inner_value),
+        )
+
+    @classmethod
+    def from_failed_io(
+        cls,
+        inner_value: IO[_NewErrorType],
+    ) -> 'RequiresContextIOResult[NoDeps, Any, _NewErrorType]':
+        """
+        Creates a new container from failed ``IO`` value.
+
+        .. code:: python
+
+          >>> from returns.io import IO, IOFailure
+          >>> from returns.context import RequiresContextIOResult
+
+          >>> assert RequiresContextIOResult.from_failed_io(IO(1))(
+          ...     RequiresContextIOResult.empty,
+          ... ) == IOFailure(1)
+
+        """
+        return RequiresContextIOResult(
+            lambda deps: IOResult.from_failed_io(inner_value),
+        )
+
     @classmethod
     def from_ioresult(
         cls, inner_value: IOResult[_ValueType, _ErrorType],
@@ -646,7 +690,7 @@ def from_ioresult(
     @classmethod
     def from_typecast(
         cls,
-        container:
+        inner_value:
             'RequiresContext[_EnvType, IOResult[_NewValueType, _NewErrorType]]',
     ) -> 'RequiresContextIOResult[_EnvType, _NewValueType, _NewErrorType]':
         """
@@ -671,7 +715,7 @@ def from_typecast(
           ... )(RequiresContextIOResult.empty) == IOFailure(1)
 
         """
-        return RequiresContextIOResult(container)
+        return RequiresContextIOResult(inner_value)
 
     @classmethod
     def from_context(
@@ -782,7 +826,7 @@ def from_failure(
     @classmethod
     def from_iterable(
         cls,
-        containers:
+        inner_value:
             Iterable[
                 'RequiresContextIOResult[_EnvType, _ValueType, _ErrorType]',
             ],
@@ -813,7 +857,7 @@ def from_iterable(
           ... ])(...) == IOFailure('a')
 
         """
-        return iterable(cls, containers)
+        return iterable(cls, inner_value)
 
 
 @final

returns/context/requires_context_result.py

@@ -489,7 +489,7 @@ def from_result(
     @classmethod
     def from_typecast(
         cls,
-        container:
+        inner_value:
             'RequiresContext[_EnvType, Result[_NewValueType, _NewErrorType]]',
     ) -> 'RequiresContextResult[_EnvType, _NewValueType, _NewErrorType]':
         """
@@ -514,7 +514,7 @@ def from_typecast(
           ... )(RequiresContextResult.empty) == Failure(1)
 
         """
-        return RequiresContextResult(container)
+        return RequiresContextResult(inner_value)
 
     @classmethod
     def from_context(
@@ -587,7 +587,7 @@ def from_failure(
     @classmethod
     def from_iterable(
         cls,
-        containers:
+        inner_value:
             Iterable['RequiresContextResult[_EnvType, _ValueType, _ErrorType]'],
     ) -> 'RequiresContextResult[_EnvType, Sequence[_ValueType], _ErrorType]':
         """
@@ -616,7 +616,7 @@ def from_iterable(
           ... ])(...) == Failure('a')
 
         """
-        return iterable(cls, containers)
+        return iterable(cls, inner_value)
 
 
 @final