Skip to content

trcks.fp.monads.awaitable_result

Monadic functions for trcks.AwaitableResult.

Provides utilities for functional composition of asynchronous trcks.Result-returning functions.

Example 
>>> import asyncio
>>> import math
>>> from trcks import Result
>>> from trcks.fp.composition import pipe
>>> from trcks.fp.monads import awaitable_result as ar
>>> async def read_from_disk() -> Result[str, float]:
...     await asyncio.sleep(0.001)
...     return "failure", "not found"
...
>>> def get_square_root(x: float) -> Result[str, float]:
...     if x < 0:
...         return "failure", "negative value"
...     return "success", math.sqrt(x)
...
>>> async def write_to_disk(output: float) -> None:
...     await asyncio.sleep(0.001)
...     print(f"Wrote '{output}' to disk.")
...
>>> async def main() -> Result[str, float]:
...     awaitable_result = read_from_disk()
...     return await pipe(
...         (
...             awaitable_result,
...             ar.map_success_to_result(get_square_root),
...             ar.tap_success_to_awaitable(write_to_disk),
...         )
...     )
...
>>> asyncio.run(main())
('failure', 'not found')

construct_failure(value)

Create a trcks.AwaitableFailure object from a value.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from collections.abc import Awaitable
>>> from trcks.fp.monads import awaitable_result as ar
>>> a_rslt = ar.construct_failure("not found")
>>> isinstance(a_rslt, Awaitable)
True
>>> asyncio.run(ar.to_coroutine_result(a_rslt))
('failure', 'not found')
Source code in src/trcks/fp/monads/awaitable_result.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def construct_failure(value: _F) -> AwaitableFailure[_F]:
    """Create a [trcks.AwaitableFailure][] object from a value.

    Args:
        value: Value to be wrapped in a [trcks.AwaitableFailure][] object.

    Returns:
        A new [trcks.AwaitableFailure][] instance containing the given value.

    Example:
        >>> import asyncio
        >>> from collections.abc import Awaitable
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> a_rslt = ar.construct_failure("not found")
        >>> isinstance(a_rslt, Awaitable)
        True
        >>> asyncio.run(ar.to_coroutine_result(a_rslt))
        ('failure', 'not found')
    """
    return a.construct(r.construct_failure(value))

construct_failure_from_awaitable(awtbl)

Create a trcks.AwaitableFailure object from a collections.abc.Awaitable object.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from collections.abc import Awaitable
>>> from http import HTTPStatus
>>> from trcks.fp.monads import awaitable_result as ar
>>> async def get_status() -> HTTPStatus:
...     await asyncio.sleep(0.001)
...     return HTTPStatus.NOT_FOUND
...
>>> awaitable_status = get_status()
>>> isinstance(awaitable_status, Awaitable)
True
>>> a_rslt = ar.construct_failure_from_awaitable(awaitable_status)
>>> asyncio.run(ar.to_coroutine_result(a_rslt))
('failure', <HTTPStatus.NOT_FOUND: 404>)
Source code in src/trcks/fp/monads/awaitable_result.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def construct_failure_from_awaitable(awtbl: Awaitable[_F]) -> AwaitableFailure[_F]:
    """Create a [trcks.AwaitableFailure][] object
    from a [collections.abc.Awaitable][] object.

    Args:
        awtbl: [collections.abc.Awaitable][] object to be wrapped
            in a [trcks.AwaitableFailure][] object.

    Returns:
        A new [trcks.AwaitableFailure][] instance containing
            the value of the given [collections.abc.Awaitable][] object.

    Example:
        >>> import asyncio
        >>> from collections.abc import Awaitable
        >>> from http import HTTPStatus
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> async def get_status() -> HTTPStatus:
        ...     await asyncio.sleep(0.001)
        ...     return HTTPStatus.NOT_FOUND
        ...
        >>> awaitable_status = get_status()
        >>> isinstance(awaitable_status, Awaitable)
        True
        >>> a_rslt = ar.construct_failure_from_awaitable(awaitable_status)
        >>> asyncio.run(ar.to_coroutine_result(a_rslt))
        ('failure', <HTTPStatus.NOT_FOUND: 404>)
    """
    return a.map_(r.construct_failure)(awtbl)

construct_from_result(rslt)

Create a trcks.AwaitableResult object from a trcks.Result object.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from collections.abc import Awaitable
>>> from trcks.fp.monads import awaitable_result as ar
>>> a_rslt = ar.construct_from_result(("failure", "not found"))
>>> isinstance(a_rslt, Awaitable)
True
>>> asyncio.run(ar.to_coroutine_result(a_rslt))
('failure', 'not found')
Source code in src/trcks/fp/monads/awaitable_result.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
def construct_from_result(rslt: Result[_F, _S]) -> AwaitableResult[_F, _S]:
    """Create a [trcks.AwaitableResult][] object from a [trcks.Result][] object.

    Args:
        rslt: [trcks.Result][] object to be wrapped
            in a [trcks.AwaitableResult][] object.

    Returns:
        A new [trcks.AwaitableResult][] instance containing
            the value of the given [trcks.Result][] object.

    Example:
        >>> import asyncio
        >>> from collections.abc import Awaitable
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> a_rslt = ar.construct_from_result(("failure", "not found"))
        >>> isinstance(a_rslt, Awaitable)
        True
        >>> asyncio.run(ar.to_coroutine_result(a_rslt))
        ('failure', 'not found')
    """
    return a.construct(rslt)

construct_success(value)

Create a trcks.AwaitableSuccess object from a value.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from collections.abc import Awaitable
>>> from trcks.fp.monads import awaitable_result as ar
>>> a_rslt = ar.construct_success(42)
>>> isinstance(a_rslt, Awaitable)
True
>>> asyncio.run(ar.to_coroutine_result(a_rslt))
('success', 42)
Source code in src/trcks/fp/monads/awaitable_result.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
def construct_success(value: _S) -> AwaitableSuccess[_S]:
    """Create a [trcks.AwaitableSuccess][] object from a value.

    Args:
        value: Value to be wrapped in a [trcks.AwaitableSuccess][] object.

    Returns:
        A new [trcks.AwaitableSuccess][] instance containing the given value.

    Example:
        >>> import asyncio
        >>> from collections.abc import Awaitable
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> a_rslt = ar.construct_success(42)
        >>> isinstance(a_rslt, Awaitable)
        True
        >>> asyncio.run(ar.to_coroutine_result(a_rslt))
        ('success', 42)
    """
    return a.construct(r.construct_success(value))

construct_success_from_awaitable(awtbl)

Create a trcks.AwaitableSuccess object from a collections.abc.Awaitable object.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from collections.abc import Awaitable
>>> from trcks.fp.monads import awaitable_result as ar
>>> async def read_from_disk() -> str:
...     await asyncio.sleep(0.001)
...     return "Hello, world!"
...
>>> awaitable_str = read_from_disk()
>>> isinstance(awaitable_str, Awaitable)
True
>>> a_rslt = ar.construct_success_from_awaitable(awaitable_str)
>>> asyncio.run(ar.to_coroutine_result(a_rslt))
('success', 'Hello, world!')
Source code in src/trcks/fp/monads/awaitable_result.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
def construct_success_from_awaitable(awtbl: Awaitable[_S]) -> AwaitableSuccess[_S]:
    """Create a [trcks.AwaitableSuccess][] object
    from a [collections.abc.Awaitable][] object.

    Args:
        awtbl: [collections.abc.Awaitable][] object to be wrapped
            in a [trcks.AwaitableSuccess][] object.

    Returns:
        A new [trcks.AwaitableSuccess][] instance containing
            the value of the given [collections.abc.Awaitable][] object.

    Example:
        >>> import asyncio
        >>> from collections.abc import Awaitable
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> async def read_from_disk() -> str:
        ...     await asyncio.sleep(0.001)
        ...     return "Hello, world!"
        ...
        >>> awaitable_str = read_from_disk()
        >>> isinstance(awaitable_str, Awaitable)
        True
        >>> a_rslt = ar.construct_success_from_awaitable(awaitable_str)
        >>> asyncio.run(ar.to_coroutine_result(a_rslt))
        ('success', 'Hello, world!')
    """
    return a.map_(r.construct_success)(awtbl)

map_failure(f)

Create function that maps trcks.AwaitableFailure to trcks.AwaitableFailure values.

trcks.AwaitableSuccess values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks import AwaitableResult
>>> from trcks.fp.monads import awaitable_result as ar
>>> add_prefix_to_failure = ar.map_failure(lambda s: f"Prefix: {s}")
>>> a_rslt_1: AwaitableResult[str, float] = add_prefix_to_failure(
...     ar.construct_failure("negative value")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('failure', 'Prefix: negative value')
>>> a_rslt_2: AwaitableResult[str, float] = add_prefix_to_failure(
...     ar.construct_success(25.0)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('success', 25.0)
Source code in src/trcks/fp/monads/awaitable_result.py 
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def map_failure(
    f: Callable[[_F1], _F2],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F2, _S1]]:
    """Create function that maps [trcks.AwaitableFailure][]
    to [trcks.AwaitableFailure][] values.

    [trcks.AwaitableSuccess][] values are left unchanged.

    Args:
        f: Synchronous function to apply to the [trcks.AwaitableFailure][] values.

    Returns:
        Maps [trcks.AwaitableFailure][] values to [trcks.AwaitableFailure][] values
            according to the given function and
            leaves [trcks.AwaitableSuccess][] values unchanged.

    Example:
        >>> import asyncio
        >>> from trcks import AwaitableResult
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> add_prefix_to_failure = ar.map_failure(lambda s: f"Prefix: {s}")
        >>> a_rslt_1: AwaitableResult[str, float] = add_prefix_to_failure(
        ...     ar.construct_failure("negative value")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('failure', 'Prefix: negative value')
        >>> a_rslt_2: AwaitableResult[str, float] = add_prefix_to_failure(
        ...     ar.construct_success(25.0)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('success', 25.0)
    """
    return a.map_(r.map_failure(f))

map_failure_to_awaitable(f)

Create function that maps trcks.AwaitableFailure to trcks.AwaitableFailure values.

trcks.AwaitableSuccess values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks import AwaitableResult
>>> from trcks.fp.monads import awaitable_result as ar
>>> async def slowly_add_prefix(s: str) -> str:
...     await asyncio.sleep(0.001)
...     return f"Prefix: {s}"
...
>>> slowly_add_prefix_to_failure = ar.map_failure_to_awaitable(
...     slowly_add_prefix
... )
>>> a_rslt_1: AwaitableResult[str, float] = slowly_add_prefix_to_failure(
...     ar.construct_failure("negative value")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('failure', 'Prefix: negative value')
>>> a_rslt_2: AwaitableResult[str, float] = slowly_add_prefix_to_failure(
...     ar.construct_success(25.0)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('success', 25.0)
Source code in src/trcks/fp/monads/awaitable_result.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def map_failure_to_awaitable(
    f: Callable[[_F1], Awaitable[_F2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F2, _S1]]:
    """Create function that maps [trcks.AwaitableFailure][]
    to [trcks.AwaitableFailure][] values.

    [trcks.AwaitableSuccess][] values are left unchanged.

    Args:
        f: Asynchronous function to apply to the [trcks.AwaitableFailure][] values.

    Returns:
        Maps [trcks.AwaitableFailure][] values to [trcks.AwaitableFailure][] values
            according to the given asynchronous function and
            leaves [trcks.AwaitableSuccess][] values unchanged.

    Example:
        >>> import asyncio
        >>> from trcks import AwaitableResult
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> async def slowly_add_prefix(s: str) -> str:
        ...     await asyncio.sleep(0.001)
        ...     return f"Prefix: {s}"
        ...
        >>> slowly_add_prefix_to_failure = ar.map_failure_to_awaitable(
        ...     slowly_add_prefix
        ... )
        >>> a_rslt_1: AwaitableResult[str, float] = slowly_add_prefix_to_failure(
        ...     ar.construct_failure("negative value")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('failure', 'Prefix: negative value')
        >>> a_rslt_2: AwaitableResult[str, float] = slowly_add_prefix_to_failure(
        ...     ar.construct_success(25.0)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('success', 25.0)
    """

    def composed_f(value: _F1) -> AwaitableFailure[_F2]:
        return construct_failure_from_awaitable(f(value))

    return map_failure_to_awaitable_result(composed_f)

map_failure_to_awaitable_result(f)

Create function that maps trcks.AwaitableFailure values to trcks.AwaitableResult values.

trcks.AwaitableSuccess values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks import Result
>>> from trcks.fp.monads import awaitable_result as ar
>>> async def _slowly_replace_not_found(s: str) -> Result[str, float]:
...     await asyncio.sleep(0.001)
...     if s == "not found":
...         return "success", 0.0
...     return "failure", s
...
>>> slowly_replace_not_found = ar.map_failure_to_awaitable_result(
...     _slowly_replace_not_found
... )
>>>
>>> a_rslt_1 = slowly_replace_not_found(ar.construct_failure("not found"))
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('success', 0.0)
>>> a_rslt_2 = slowly_replace_not_found(ar.construct_failure("other failure"))
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('failure', 'other failure')
>>> a_rslt_3 = slowly_replace_not_found(ar.construct_success(25.0))
>>> asyncio.run(ar.to_coroutine_result(a_rslt_3))
('success', 25.0)
Source code in src/trcks/fp/monads/awaitable_result.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
def map_failure_to_awaitable_result(
    f: Callable[[_F1], AwaitableResult[_F2, _S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F2, _S1 | _S2]]:
    """Create function that maps [trcks.AwaitableFailure][] values
    to [trcks.AwaitableResult][] values.

    [trcks.AwaitableSuccess][] values are left unchanged.

    Args:
        f: Asynchronous function to apply to the [trcks.AwaitableFailure][] values.

    Returns:
        Maps [trcks.AwaitableFailure][] values
            to [trcks.AwaitableFailure][] and [trcks.AwaitableSuccess][] values
            according to the given asynchronous function and
            leaves [trcks.AwaitableSuccess][] values unchanged.

    Example:
        >>> import asyncio
        >>> from trcks import Result
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> async def _slowly_replace_not_found(s: str) -> Result[str, float]:
        ...     await asyncio.sleep(0.001)
        ...     if s == "not found":
        ...         return "success", 0.0
        ...     return "failure", s
        ...
        >>> slowly_replace_not_found = ar.map_failure_to_awaitable_result(
        ...     _slowly_replace_not_found
        ... )
        >>>
        >>> a_rslt_1 = slowly_replace_not_found(ar.construct_failure("not found"))
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('success', 0.0)
        >>> a_rslt_2 = slowly_replace_not_found(ar.construct_failure("other failure"))
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('failure', 'other failure')
        >>> a_rslt_3 = slowly_replace_not_found(ar.construct_success(25.0))
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_3))
        ('success', 25.0)
    """

    async def partially_mapped_f(rslt: Result[_F1, _S1]) -> Result[_F2, _S1 | _S2]:
        if rslt[0] == "failure":
            return await f(rslt[1])
        if rslt[0] == "success":
            return rslt
        return assert_never(rslt)  # type: ignore [unreachable]  # pragma: no cover

    return a.map_to_awaitable(partially_mapped_f)

map_failure_to_result(f)

Create function that maps trcks.AwaitableFailure values to trcks.AwaitableResult values.

trcks.AwaitableSuccess values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks import AwaitableResult
>>> from trcks.fp.monads import awaitable_result as ar
>>> replace_not_found_by_default_value = ar.map_failure_to_result(
...     lambda s: ("success", 0.0) if s == "not found" else ("failure", s)
... )
>>> a_rslt_1: AwaitableResult[str, float] = replace_not_found_by_default_value(
...     ar.construct_failure("not found")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('success', 0.0)
>>> a_rslt_2: AwaitableResult[str, float] = replace_not_found_by_default_value(
...     ar.construct_failure("other failure")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('failure', 'other failure')
>>> a_rslt_3: AwaitableResult[str, float] = replace_not_found_by_default_value(
...     ar.construct_success(25.0)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_3))
('success', 25.0)
Source code in src/trcks/fp/monads/awaitable_result.py 
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
def map_failure_to_result(
    f: Callable[[_F1], Result[_F2, _S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F2, _S1 | _S2]]:
    """Create function that maps [trcks.AwaitableFailure][] values
    to [trcks.AwaitableResult][] values.

    [trcks.AwaitableSuccess][] values are left unchanged.

    Args:
        f: Synchronous function to apply to the [trcks.AwaitableFailure][] values.

    Returns:
        Maps [trcks.AwaitableFailure][] values to [trcks.AwaitableResult][] values
            according to the given function and
            leaves [trcks.AwaitableSuccess][] values unchanged.

    Example:
        >>> import asyncio
        >>> from trcks import AwaitableResult
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> replace_not_found_by_default_value = ar.map_failure_to_result(
        ...     lambda s: ("success", 0.0) if s == "not found" else ("failure", s)
        ... )
        >>> a_rslt_1: AwaitableResult[str, float] = replace_not_found_by_default_value(
        ...     ar.construct_failure("not found")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('success', 0.0)
        >>> a_rslt_2: AwaitableResult[str, float] = replace_not_found_by_default_value(
        ...     ar.construct_failure("other failure")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('failure', 'other failure')
        >>> a_rslt_3: AwaitableResult[str, float] = replace_not_found_by_default_value(
        ...     ar.construct_success(25.0)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_3))
        ('success', 25.0)
    """
    return a.map_(r.map_failure_to_result(f))

map_success(f)

Create function that maps trcks.AwaitableSuccess to trcks.AwaitableSuccess values.

trcks.AwaitableFailure values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks import AwaitableResult
>>> from trcks.fp.monads import awaitable_result as ar
>>> def increase(n: int) -> int:
...     return n + 1
...
>>> increase_success = ar.map_success(increase)
>>> a_rslt_1: AwaitableResult[str, int] = increase_success(
...     ar.construct_failure("not found")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('failure', 'not found')
>>> a_rslt_2: AwaitableResult[str, int] = increase_success(
...     ar.construct_success(42)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('success', 43)
Source code in src/trcks/fp/monads/awaitable_result.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
def map_success(
    f: Callable[[_S1], _S2],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S2]]:
    """Create function that maps [trcks.AwaitableSuccess][]
    to [trcks.AwaitableSuccess][] values.

    [trcks.AwaitableFailure][] values are left unchanged.

    Args:
        f: Synchronous function to apply to the [trcks.AwaitableSuccess][] values.

    Returns:
        Leaves [trcks.AwaitableFailure][] values unchanged and
            maps [trcks.AwaitableSuccess][] values
            to new [trcks.AwaitableSuccess][] values
            according to the given function.

    Example:
        >>> import asyncio
        >>> from trcks import AwaitableResult
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> def increase(n: int) -> int:
        ...     return n + 1
        ...
        >>> increase_success = ar.map_success(increase)
        >>> a_rslt_1: AwaitableResult[str, int] = increase_success(
        ...     ar.construct_failure("not found")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('failure', 'not found')
        >>> a_rslt_2: AwaitableResult[str, int] = increase_success(
        ...     ar.construct_success(42)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('success', 43)
    """
    return a.map_(r.map_success(f))

map_success_to_awaitable(f)

Create function that maps trcks.AwaitableSuccess to trcks.AwaitableSuccess values.

trcks.AwaitableFailure values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>>
>>> from trcks import AwaitableResult
>>> from trcks.fp.monads import awaitable_result as ar
>>>
>>>
>>> async def increment_slowly(n: int) -> int:
...     return n + 1
...
>>> increase_success = ar.map_success_to_awaitable(increment_slowly)
>>>
>>> a_rslt_1: AwaitableResult[str, int] = increase_success(
...     ar.construct_failure("not found")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('failure', 'not found')
>>>
>>> a_rslt_2: AwaitableResult[str, int] = increase_success(
...     ar.construct_success(42)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('success', 43)
Source code in src/trcks/fp/monads/awaitable_result.py 
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
def map_success_to_awaitable(
    f: Callable[[_S1], Awaitable[_S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S2]]:
    """Create function that maps [trcks.AwaitableSuccess][]
    to [trcks.AwaitableSuccess][] values.

    [trcks.AwaitableFailure][] values are left unchanged.

    Args:
        f: Asynchronous function to apply to the [trcks.AwaitableSuccess][] values.

    Returns:
        Leaves [trcks.AwaitableFailure][] values unchanged and
            maps [trcks.AwaitableSuccess][] values
            to new [trcks.AwaitableSuccess][] values
            according to the given function.

    Example:
        >>> import asyncio
        >>>
        >>> from trcks import AwaitableResult
        >>> from trcks.fp.monads import awaitable_result as ar
        >>>
        >>>
        >>> async def increment_slowly(n: int) -> int:
        ...     return n + 1
        ...
        >>> increase_success = ar.map_success_to_awaitable(increment_slowly)
        >>>
        >>> a_rslt_1: AwaitableResult[str, int] = increase_success(
        ...     ar.construct_failure("not found")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('failure', 'not found')
        >>>
        >>> a_rslt_2: AwaitableResult[str, int] = increase_success(
        ...     ar.construct_success(42)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('success', 43)
    """

    def composed_f(value: _S1) -> AwaitableSuccess[_S2]:
        return construct_success_from_awaitable(f(value))

    return map_success_to_awaitable_result(composed_f)

map_success_to_awaitable_result(f)

Create function that maps trcks.AwaitableSuccess values to trcks.AwaitableResult values.

trcks.AwaitableFailure values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> import math
>>> from trcks import AwaitableResult, Result
>>> from trcks.fp.monads import awaitable_result as ar
>>> async def _get_square_root_slowly(x: float) -> Result[str, float]:
...     await asyncio.sleep(0.001)
...     if x < 0:
...         return "failure", "negative value"
...     return "success", math.sqrt(x)
...
>>> get_square_root_slowly = ar.map_success_to_awaitable_result(
...     _get_square_root_slowly
... )
>>> a_rslt_1: AwaitableResult[str, float] = get_square_root_slowly(
...     ar.construct_failure("not found")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('failure', 'not found')
>>> a_rslt_2: AwaitableResult[str, float] = get_square_root_slowly(
...     ar.construct_success(25.0)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('success', 5.0)
Source code in src/trcks/fp/monads/awaitable_result.py 
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
def map_success_to_awaitable_result(
    f: Callable[[_S1], AwaitableResult[_F2, _S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1 | _F2, _S2]]:
    """Create function that maps [trcks.AwaitableSuccess][] values
    to [trcks.AwaitableResult][] values.

    [trcks.AwaitableFailure][] values are left unchanged.

    Args:
        f: Asynchronous function to apply to the [trcks.AwaitableSuccess][] values.

    Returns:
        Leaves [trcks.AwaitableFailure][] values unchanged and
            maps [trcks.AwaitableSuccess][] values
            to [trcks.AwaitableFailure][] and [trcks.AwaitableSuccess][] values
            according to the given asynchronous function.

    Example:
        >>> import asyncio
        >>> import math
        >>> from trcks import AwaitableResult, Result
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> async def _get_square_root_slowly(x: float) -> Result[str, float]:
        ...     await asyncio.sleep(0.001)
        ...     if x < 0:
        ...         return "failure", "negative value"
        ...     return "success", math.sqrt(x)
        ...
        >>> get_square_root_slowly = ar.map_success_to_awaitable_result(
        ...     _get_square_root_slowly
        ... )
        >>> a_rslt_1: AwaitableResult[str, float] = get_square_root_slowly(
        ...     ar.construct_failure("not found")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('failure', 'not found')
        >>> a_rslt_2: AwaitableResult[str, float] = get_square_root_slowly(
        ...     ar.construct_success(25.0)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('success', 5.0)
    """

    async def partially_mapped_f(rslt: Result[_F1, _S1]) -> Result[_F1 | _F2, _S2]:
        if rslt[0] == "failure":
            return rslt
        if rslt[0] == "success":
            return await f(rslt[1])
        return assert_never(rslt)  # type: ignore [unreachable]  # pragma: no cover

    return a.map_to_awaitable(partially_mapped_f)

map_success_to_result(f)

Create function that maps trcks.AwaitableSuccess values to trcks.AwaitableResult values.

trcks.AwaitableFailure values are left unchanged.

Parameters:

Returns:

Example 
>>> import asyncio
>>> import math
>>> from trcks import Result
>>> from trcks.fp.monads import awaitable_result as ar
>>> def _get_square_root_slowly(x: float) -> Result[str, float]:
...     if x < 0:
...         return "failure", "negative value"
...     return "success", math.sqrt(x)
...
>>> get_square_root_slowly = ar.map_success_to_result(
...     _get_square_root_slowly
... )
>>> a_rslt_1 = get_square_root_slowly(
...     ar.construct_failure("not found")
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
('failure', 'not found')
>>> a_rslt_2 = get_square_root_slowly(
...     ar.construct_success(25.0)
... )
>>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
('success', 5.0)
Source code in src/trcks/fp/monads/awaitable_result.py 
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
def map_success_to_result(
    f: Callable[[_S1], Result[_F2, _S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1 | _F2, _S2]]:
    """Create function that maps [trcks.AwaitableSuccess][] values
    to [trcks.AwaitableResult][] values.

    [trcks.AwaitableFailure][] values are left unchanged.

    Args:
        f: Synchronous function to apply to the [trcks.AwaitableSuccess][] values.

    Returns:
        Leaves [trcks.AwaitableFailure][] values unchanged and
            maps [trcks.AwaitableSuccess][] values
            to [trcks.AwaitableFailure][] and [trcks.AwaitableSuccess][] values
            according to the given function.

    Example:
        >>> import asyncio
        >>> import math
        >>> from trcks import Result
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> def _get_square_root_slowly(x: float) -> Result[str, float]:
        ...     if x < 0:
        ...         return "failure", "negative value"
        ...     return "success", math.sqrt(x)
        ...
        >>> get_square_root_slowly = ar.map_success_to_result(
        ...     _get_square_root_slowly
        ... )
        >>> a_rslt_1 = get_square_root_slowly(
        ...     ar.construct_failure("not found")
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_1))
        ('failure', 'not found')
        >>> a_rslt_2 = get_square_root_slowly(
        ...     ar.construct_success(25.0)
        ... )
        >>> asyncio.run(ar.to_coroutine_result(a_rslt_2))
        ('success', 5.0)
    """
    return a.map_(r.map_success_to_result(f))

tap_failure(f)

Create function that applies a synchronous side effect to trcks.AwaitableFailure values.

trcks.AwaitableSuccess values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
def tap_failure(
    f: Callable[[_F1], object],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S1]]:
    """Create function that applies a synchronous side effect
    to [trcks.AwaitableFailure][] values.

    [trcks.AwaitableSuccess][] values are passed on without side effects.

    Args:
        f: Synchronous side effect to apply to the [trcks.AwaitableFailure][] value.

    Returns:
        Applies the given side effect to [trcks.AwaitableFailure][] values and
            returns the original [trcks.AwaitableFailure][] value.
            Passes on [trcks.AwaitableSuccess][] values without side effects.
    """
    return a.map_(r.tap_failure(f))

tap_failure_to_awaitable(f)

Create function that applies an asynchronous side effect to trcks.AwaitableFailure values.

trcks.AwaitableSuccess values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
def tap_failure_to_awaitable(
    f: Callable[[_F1], Awaitable[object]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S1]]:
    """Create function that applies an asynchronous side effect
    to [trcks.AwaitableFailure][] values.

    [trcks.AwaitableSuccess][] values are passed on without side effects.

    Args:
        f: Asynchronous side effect to apply to the [trcks.AwaitableFailure][] value.

    Returns:
        Applies the given side effect to [trcks.AwaitableFailure][] values and
            returns the original [trcks.AwaitableFailure][] value.
            Passes on [trcks.AwaitableSuccess][] values without side effects.
    """

    async def bypassed_f(value: _F1) -> _F1:
        _ = await f(value)
        return value

    return map_failure_to_awaitable(bypassed_f)

tap_failure_to_awaitable_result(f)

Create function that applies an asynchronous side effect with return type trcks.AwaitableResult to trcks.AwaitableFailure values.

trcks.AwaitableSuccess values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
def tap_failure_to_awaitable_result(
    f: Callable[[_F1], AwaitableResult[object, _S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S1 | _S2]]:
    """Create function that applies an asynchronous side effect
    with return type [trcks.AwaitableResult][] to [trcks.AwaitableFailure][] values.

    [trcks.AwaitableSuccess][] values are passed on without side effects.

    Args:
        f: Asynchronous side effect to apply to the [trcks.AwaitableFailure][] value.

    Returns:
        Applies the given side effect to [trcks.AwaitableFailure][] values.
            If the given side effect returns a [trcks.AwaitableFailure][],
            *the original* [trcks.AwaitableFailure][] value is returned.
            If the given side effect returns a [trcks.AwaitableSuccess][],
            *this* [trcks.AwaitableSuccess][] is returned.
            Passes on [trcks.AwaitableSuccess][] values without side effects.
    """

    async def bypassed_f(value: _F1) -> Result[_F1, _S2]:
        rslt: Result[object, _S2] = await f(value)
        if rslt[0] == "failure":
            return r.construct_failure(value)
        if rslt[0] == "success":
            return rslt
        return assert_never(rslt)  # type: ignore [unreachable]  # pragma: no cover

    return map_failure_to_awaitable_result(bypassed_f)

tap_failure_to_result(f)

Create function that applies a synchronous side effect with return type trcks.Result to trcks.AwaitableFailure values.

trcks.AwaitableSuccess values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
def tap_failure_to_result(
    f: Callable[[_F1], Result[object, _S2]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S1 | _S2]]:
    """Create function that applies a synchronous side effect
    with return type [trcks.Result][] to [trcks.AwaitableFailure][] values.

    [trcks.AwaitableSuccess][] values are passed on without side effects.

    Args:
        f: Synchronous side effect to apply to the [trcks.AwaitableFailure][] value.

    Returns:
        Applies the given side effect to [trcks.AwaitableFailure][] values.
            If the given side effect returns a [trcks.Failure][],
            *the original* [trcks.AwaitableFailure][] value is returned.
            If the given side effect returns a [trcks.Success][],
            *this* [trcks.Success][] is returned.
            Passes on [trcks.AwaitableSuccess][] values without side effects.
    """
    return a.map_(r.tap_failure_to_result(f))

tap_success(f)

Create function that applies a synchronous side effect to trcks.AwaitableSuccess values.

trcks.AwaitableFailure values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
def tap_success(
    f: Callable[[_S1], object],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S1]]:
    """Create function that applies a synchronous side effect
    to [trcks.AwaitableSuccess][] values.

    [trcks.AwaitableFailure][] values are passed on without side effects.

    Args:
        f: Synchronous side effect to apply to the [trcks.AwaitableSuccess][] value.

    Returns:
        Passes on [trcks.AwaitableFailure][] values without side effects.
            Applies the given side effect to [trcks.AwaitableSuccess][] values and
            returns the original [trcks.AwaitableSuccess][] value.
    """
    return a.map_(r.tap_success(f))

tap_success_to_awaitable(f)

Create function that applies an asynchronous side effect to trcks.AwaitableSuccess values.

trcks.AwaitableFailure values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
def tap_success_to_awaitable(
    f: Callable[[_S1], Awaitable[object]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1, _S1]]:
    """Create function that applies an asynchronous side effect
    to [trcks.AwaitableSuccess][] values.

    [trcks.AwaitableFailure][] values are passed on without side effects.

    Args:
        f: Asynchronous side effect to apply to the [trcks.AwaitableSuccess][] value.

    Returns:
        Passes on [trcks.AwaitableFailure][] values without side effects.
            Applies the given side effect to [trcks.AwaitableSuccess][] values and
            returns the original [trcks.AwaitableSuccess][] value.
    """

    async def bypassed_f(value: _S1) -> _S1:
        _ = await f(value)
        return value

    return map_success_to_awaitable(bypassed_f)

tap_success_to_awaitable_result(f)

Create function that applies an asynchronous side effect with return type trcks.AwaitableResult to trcks.AwaitableSuccess values.

trcks.AwaitableFailure values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
def tap_success_to_awaitable_result(
    f: Callable[[_S1], AwaitableResult[_F2, object]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1 | _F2, _S1]]:
    """Create function that applies an asynchronous side effect
    with return type [trcks.AwaitableResult][] to [trcks.AwaitableSuccess][] values.

    [trcks.AwaitableFailure][] values are passed on without side effects.

    Args:
        f: Asynchronous side effect to apply to the [trcks.AwaitableSuccess][] value.

    Returns:
        Passes on [trcks.AwaitableFailure][] values without side effects.
            Applies the given side effect to [trcks.AwaitableSuccess][] values.
            If the given side effect returns a [trcks.AwaitableFailure][],
            *this* [trcks.AwaitableFailure][] is returned.
            If the given side effect returns a [trcks.AwaitableSuccess][],
            *the original* [trcks.AwaitableSuccess][] value is returned.
    """

    async def bypassed_f(value: _S1) -> Result[_F2, _S1]:
        rslt: Result[_F2, object] = await f(value)
        if rslt[0] == "failure":
            return rslt
        if rslt[0] == "success":
            return r.construct_success(value)
        return assert_never(rslt)  # type: ignore [unreachable]  # pragma: no cover

    return map_success_to_awaitable_result(bypassed_f)

tap_success_to_result(f)

Create function that applies a synchronous side effect with return type trcks.Result to trcks.AwaitableSuccess values.

trcks.AwaitableFailure values are passed on without side effects.

Parameters:

Returns:

Source code in src/trcks/fp/monads/awaitable_result.py 
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
def tap_success_to_result(
    f: Callable[[_S1], Result[_F2, object]],
) -> Callable[[AwaitableResult[_F1, _S1]], AwaitableResult[_F1 | _F2, _S1]]:
    """Create function that applies a synchronous side effect
    with return type [trcks.Result][] to [trcks.AwaitableSuccess][] values.

    [trcks.AwaitableFailure][] values are passed on without side effects.

    Args:
        f: Synchronous side effect to apply to the [trcks.AwaitableSuccess][] value.

    Returns:
        Passes on [trcks.AwaitableFailure][] values without side effects.
            Applies the given side effect to [trcks.AwaitableSuccess][] values.
            If the given side effect returns a [trcks.Failure][],
            *this* [trcks.Failure][] is returned.
            If the given side effect returns a [trcks.Success][],
            *the original* [trcks.AwaitableSuccess][] value is returned.
    """
    return a.map_(r.tap_success_to_result(f))

to_coroutine_result(a_rslt) async

Turn a trcks.AwaitableResult into a collections.abc.Coroutine.

This is useful for functions that expect a coroutine (e.g. asyncio.run).

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks import Result
>>> from trcks.fp.monads import awaitable_result as ar
>>> asyncio.set_event_loop(asyncio.new_event_loop())
>>> future = asyncio.Future[Result[str, int]]()
>>> future.set_result(("success", 42))
>>> future
<Future finished result=('success', 42)>
>>> coro = ar.to_coroutine_result(future)
>>> coro
<coroutine object to_coroutine_result at ...>
>>> asyncio.run(coro)
('success', 42)
Source code in src/trcks/fp/monads/awaitable_result.py 
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
async def to_coroutine_result(a_rslt: AwaitableResult[_F, _S]) -> Result[_F, _S]:
    """Turn a [trcks.AwaitableResult][] into a [collections.abc.Coroutine][].

    This is useful for functions that expect a coroutine (e.g. [asyncio.run][]).

    Args:
        a_rslt:
            The [trcks.AwaitableResult][] to be transformed
                into a [collections.abc.Coroutine][].

    Returns:
        The given [trcks.AwaitableResult][] transformed
            into a [collections.abc.Coroutine][].

    Example:
        >>> import asyncio
        >>> from trcks import Result
        >>> from trcks.fp.monads import awaitable_result as ar
        >>> asyncio.set_event_loop(asyncio.new_event_loop())
        >>> future = asyncio.Future[Result[str, int]]()
        >>> future.set_result(("success", 42))
        >>> future
        <Future finished result=('success', 42)>
        >>> coro = ar.to_coroutine_result(future)
        >>> coro
        <coroutine object to_coroutine_result at ...>
        >>> asyncio.run(coro)
        ('success', 42)
    """
    return await a_rslt