Skip to content

trcks.oop.AwaitableTupleWrapper

Bases: BaseAwaitableWrapper[tuple[_T_co, ...]]

Type-safe and immutable wrapper for trcks.AwaitableTuple objects.

The wrapped object can be accessed via the attribute trcks.oop.AwaitableTupleWrapper.core. The trcks.oop.AwaitableTupleWrapper.map* methods allow method chaining. The trcks.oop.AwaitableTupleWrapper.tap* methods allow for side effects without changing the wrapped tuple.

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> async def slowly_double(n: int) -> int:
...     await asyncio.sleep(0.001)
...     return n * 2
...
>>> async def main() -> tuple[int, ...]:
...     return await (
...         AwaitableTupleWrapper
...         .construct_from_iterable((1, 2, 3))
...         .map_to_awaitable(slowly_double)
...         .core
...     )
...
>>> asyncio.run(main())
(2, 4, 6)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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
189
190
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
224
225
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
269
270
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
321
322
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
363
364
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
402
403
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
@final
class AwaitableTupleWrapper(BaseAwaitableWrapper[tuple[_T_co, ...]]):
    """Type-safe and immutable wrapper for [trcks.AwaitableTuple][] objects.

    The wrapped object can be accessed
    via the attribute `trcks.oop.AwaitableTupleWrapper.core`.
    The `trcks.oop.AwaitableTupleWrapper.map*` methods allow method chaining.
    The `trcks.oop.AwaitableTupleWrapper.tap*` methods allow for side effects
    without changing the wrapped tuple.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> async def slowly_double(n: int) -> int:
        ...     await asyncio.sleep(0.001)
        ...     return n * 2
        ...
        >>> async def main() -> tuple[int, ...]:
        ...     return await (
        ...         AwaitableTupleWrapper
        ...         .construct_from_iterable((1, 2, 3))
        ...         .map_to_awaitable(slowly_double)
        ...         .core
        ...     )
        ...
        >>> asyncio.run(main())
        (2, 4, 6)
    """

    __slots__: tuple[str, ...] = ()

    @staticmethod
    def construct(value: _T) -> AwaitableTupleWrapper[_T]:
        """Construct and wrap a [trcks.AwaitableTuple][] object from a value.

        Args:
            value: The value to be wrapped.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the wrapped [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> awaitable_tuple_wrapper = AwaitableTupleWrapper.construct(42)
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (42,)
        """
        return AwaitableTupleWrapper(at.construct(value))

    @staticmethod
    def construct_from_awaitable(
        awtbl: Awaitable[_T],
    ) -> AwaitableTupleWrapper[_T]:
        """Construct and wrap a [trcks.AwaitableTuple][] from an awaitable value.

        Args:
            awtbl: The awaitable value to be wrapped.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the wrapped [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> async def slowly_get_value() -> int:
            ...     await asyncio.sleep(0.001)
            ...     return 7
            ...
            >>> awaitable_tuple_wrapper = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_awaitable(slowly_get_value())
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (7,)
        """
        return AwaitableTupleWrapper(at.construct_from_awaitable(awtbl))

    @staticmethod
    def construct_from_iterable(it: Iterable[_T]) -> AwaitableTupleWrapper[_T]:
        """Construct and wrap a [trcks.AwaitableTuple][] from an iterable.

        Args:
            it: The [collections.abc.Iterable][] to be wrapped and converted.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the wrapped [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> awaitable_tuple_wrapper = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable([1, 2])
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (1, 2)
        """
        return AwaitableTupleWrapper(at.construct_from_iterable(it))

    @classmethod
    @deprecated("Use construct_from_iterable or the default constructor instead")
    def construct_from_tuple(
        cls,
        tpl: tuple[_T, ...],
    ) -> AwaitableTupleWrapper[_T]:
        """Deprecated alias for construct_from_iterable."""
        return cls.construct_from_iterable(tpl)  # pragma: no cover

    def map(self, f: Callable[[_T_co], _T]) -> AwaitableTupleWrapper[_T]:
        """Apply a synchronous function to each element in the wrapped
        [trcks.AwaitableTuple][] object.

        Args:
            f: The synchronous function to be applied to each element.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the wrapped [trcks.AwaitableTuple][] object containing
                the results of applying the function to each element.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> def double_integer(n: int) -> int:
            ...     return n * 2
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2, 3))
            ...     .map(double_integer)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (2, 4, 6)
        """
        return AwaitableTupleWrapper(at.map_(f)(self.core))

    def map_to_awaitable(
        self, f: Callable[[_T_co], Awaitable[_T]]
    ) -> AwaitableTupleWrapper[_T]:
        """Apply an asynchronous function to each element in the wrapped
        [trcks.AwaitableTuple][] object.

        Args:
            f: The asynchronous function to be applied to each element.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the wrapped [trcks.AwaitableTuple][] object containing
                the results of applying the function to each element.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> async def slowly_add_one(n: int) -> int:
            ...     await asyncio.sleep(0.001)
            ...     return n + 1
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2))
            ...     .map_to_awaitable(slowly_add_one)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (2, 3)
        """
        return AwaitableTupleWrapper(at.map_to_awaitable(f)(self.core))

    def map_to_awaitable_iterable(
        self, f: Callable[[_T_co], AwaitableIterable[_T]]
    ) -> AwaitableTupleWrapper[_T]:
        """Apply an asynchronous function returning a [trcks.AwaitableIterable][]
        to each element in the wrapped [trcks.AwaitableTuple][] and flatten.

        Args:
            f: The asynchronous function to be applied to each element,
                returning a [trcks.AwaitableIterable][].

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the flattened [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> async def slowly_duplicate(n: int) -> tuple[int, int]:
            ...     await asyncio.sleep(0.001)
            ...     return n, n
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2))
            ...     .map_to_awaitable_iterable(slowly_duplicate)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (1, 1, 2, 2)
        """
        return AwaitableTupleWrapper(at.map_to_awaitable_iterable(f)(self.core))

    @deprecated("Use map_to_awaitable_iterable instead")
    def map_to_awaitable_tuple(
        self, f: Callable[[_T_co], AwaitableTuple[_T]]
    ) -> AwaitableTupleWrapper[_T]:
        """Deprecated alias for
        [trcks.oop.AwaitableTupleWrapper.map_to_awaitable_iterable][].
        """
        return self.map_to_awaitable_iterable(f)  # pragma: no cover

    def map_to_iterable(
        self, f: Callable[[_T_co], Iterable[_T]]
    ) -> AwaitableTupleWrapper[_T]:
        """Apply a synchronous function returning an [collections.abc.Iterable][]
        to each element in the wrapped [trcks.AwaitableTuple][] object and flatten.

        Args:
            f: The synchronous function to be applied to each element,
                returning an [collections.abc.Iterable][].

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the flattened [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> def add_negative(n: int) -> tuple[int, int]:
            ...     return n, -n
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2))
            ...     .map_to_iterable(add_negative)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (1, -1, 2, -2)
        """
        return AwaitableTupleWrapper(at.map_to_iterable(f)(self.core))

    @deprecated("Use map_to_iterable instead")
    def map_to_tuple(
        self, f: Callable[[_T_co], tuple[_T, ...]]
    ) -> AwaitableTupleWrapper[_T]:
        """Deprecated alias for
        [trcks.oop.AwaitableTupleWrapper.map_to_iterable][].
        """
        return self.map_to_iterable(f)  # pragma: no cover

    def tap(self, f: Callable[[_T_co], object]) -> AwaitableTupleWrapper[_T_co]:
        """Apply a synchronous side effect to each element in the wrapped
        [trcks.AwaitableTuple][] object.

        Args:
            f: The synchronous side effect to be applied to each element.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the original [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> def log_integer(n: int) -> None:
            ...     print(f"Received: {n}")
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2))
            ...     .tap(log_integer)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            Received: 1
            Received: 2
            (1, 2)
        """
        return AwaitableTupleWrapper(at.tap(f)(self.core))

    def tap_to_awaitable(
        self, f: Callable[[_T_co], Awaitable[object]]
    ) -> AwaitableTupleWrapper[_T_co]:
        """Apply an asynchronous side effect to each element in the wrapped
        [trcks.AwaitableTuple][] object.

        Args:
            f: The asynchronous side effect to be applied to each element.

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the original [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> async def slowly_log(n: int) -> None:
            ...     await asyncio.sleep(0.001)
            ...     print(f"Logged: {n}")
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2))
            ...     .tap_to_awaitable(slowly_log)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            Logged: 1
            Logged: 2
            (1, 2)
        """
        return AwaitableTupleWrapper(at.tap_to_awaitable(f)(self.core))

    def tap_to_awaitable_iterable(
        self, f: Callable[[_T_co], AwaitableIterable[object]]
    ) -> AwaitableTupleWrapper[_T_co]:
        """Apply an asynchronous side effect returning a [trcks.AwaitableIterable][]
        to each element in the wrapped [trcks.AwaitableTuple][] object.

        Args:
            f: The asynchronous side effect to be applied to each element,
                returning a [trcks.AwaitableIterable][].

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the original [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> async def slowly_get_divisors(n: int) -> tuple[int, ...]:
            ...     await asyncio.sleep(0.001)
            ...     candidates = range(1, n + 1)
            ...     return tuple(c for c in candidates if n % c == 0)
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2, 3, 4))
            ...     .tap_to_awaitable_iterable(slowly_get_divisors)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (1, 2, 2, 3, 3, 4, 4, 4)
        """
        return AwaitableTupleWrapper(at.tap_to_awaitable_iterable(f)(self.core))

    @deprecated("Use tap_to_awaitable_iterable instead")
    def tap_to_awaitable_tuple(
        self, f: Callable[[_T_co], AwaitableTuple[object]]
    ) -> AwaitableTupleWrapper[_T_co]:
        """Deprecated alias for
        [trcks.oop.AwaitableTupleWrapper.tap_to_awaitable_iterable][].
        """
        return self.tap_to_awaitable_iterable(f)  # pragma: no cover

    def tap_to_iterable(
        self, f: Callable[[_T_co], Iterable[object]]
    ) -> AwaitableTupleWrapper[_T_co]:
        """Apply a synchronous side effect returning an [collections.abc.Iterable][]
        to each element in the wrapped [trcks.AwaitableTuple][] object.

        Args:
            f: The synchronous side effect to be applied to each element,
                returning an [collections.abc.Iterable][].

        Returns:
            A new [trcks.oop.AwaitableTupleWrapper][] instance with
                the original [trcks.AwaitableTuple][] object.

        Example:
            >>> import asyncio
            >>> from trcks.oop import AwaitableTupleWrapper
            >>> def get_divisors(n: int) -> tuple[int, ...]:
            ...     candidates = range(1, n + 1)
            ...     return tuple(c for c in candidates if n % c == 0)
            ...
            >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
            ...     AwaitableTupleWrapper
            ...     .construct_from_iterable((1, 2, 3, 4))
            ...     .tap_to_iterable(get_divisors)
            ... )
            >>> awaitable_tuple_wrapper
            AwaitableTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            (1, 2, 2, 3, 3, 4, 4, 4)
        """
        return AwaitableTupleWrapper(at.tap_to_iterable(f)(self.core))

    @deprecated("Use tap_to_iterable instead")
    def tap_to_tuple(
        self, f: Callable[[_T_co], tuple[object, ...]]
    ) -> AwaitableTupleWrapper[_T_co]:
        """Deprecated alias for
        [trcks.oop.AwaitableTupleWrapper.tap_to_iterable][].
        """
        return self.tap_to_iterable(f)  # pragma: no cover

construct(value) staticmethod

Construct and wrap a trcks.AwaitableTuple object from a value.

Parameters:

  • value (_T) –

    The value to be wrapped.

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> awaitable_tuple_wrapper = AwaitableTupleWrapper.construct(42)
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(42,)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@staticmethod
def construct(value: _T) -> AwaitableTupleWrapper[_T]:
    """Construct and wrap a [trcks.AwaitableTuple][] object from a value.

    Args:
        value: The value to be wrapped.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the wrapped [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> awaitable_tuple_wrapper = AwaitableTupleWrapper.construct(42)
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (42,)
    """
    return AwaitableTupleWrapper(at.construct(value))

construct_from_awaitable(awtbl) staticmethod

Construct and wrap a trcks.AwaitableTuple from an awaitable value.

Parameters:

  • awtbl (Awaitable[_T]) –

    The awaitable value to be wrapped.

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> async def slowly_get_value() -> int:
...     await asyncio.sleep(0.001)
...     return 7
...
>>> awaitable_tuple_wrapper = (
...     AwaitableTupleWrapper
...     .construct_from_awaitable(slowly_get_value())
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(7,)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
@staticmethod
def construct_from_awaitable(
    awtbl: Awaitable[_T],
) -> AwaitableTupleWrapper[_T]:
    """Construct and wrap a [trcks.AwaitableTuple][] from an awaitable value.

    Args:
        awtbl: The awaitable value to be wrapped.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the wrapped [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> async def slowly_get_value() -> int:
        ...     await asyncio.sleep(0.001)
        ...     return 7
        ...
        >>> awaitable_tuple_wrapper = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_awaitable(slowly_get_value())
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (7,)
    """
    return AwaitableTupleWrapper(at.construct_from_awaitable(awtbl))

construct_from_iterable(it) staticmethod

Construct and wrap a trcks.AwaitableTuple from an iterable.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> awaitable_tuple_wrapper = (
...     AwaitableTupleWrapper
...     .construct_from_iterable([1, 2])
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(1, 2)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
@staticmethod
def construct_from_iterable(it: Iterable[_T]) -> AwaitableTupleWrapper[_T]:
    """Construct and wrap a [trcks.AwaitableTuple][] from an iterable.

    Args:
        it: The [collections.abc.Iterable][] to be wrapped and converted.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the wrapped [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> awaitable_tuple_wrapper = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable([1, 2])
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (1, 2)
    """
    return AwaitableTupleWrapper(at.construct_from_iterable(it))

construct_from_tuple(tpl) classmethod

Deprecated alias for construct_from_iterable.

Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
133
134
135
136
137
138
139
140
@classmethod
@deprecated("Use construct_from_iterable or the default constructor instead")
def construct_from_tuple(
    cls,
    tpl: tuple[_T, ...],
) -> AwaitableTupleWrapper[_T]:
    """Deprecated alias for construct_from_iterable."""
    return cls.construct_from_iterable(tpl)  # pragma: no cover

map(f)

Apply a synchronous function to each element in the wrapped trcks.AwaitableTuple object.

Parameters:

  • f (Callable[[_T_co], _T]) –

    The synchronous function to be applied to each element.

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> def double_integer(n: int) -> int:
...     return n * 2
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2, 3))
...     .map(double_integer)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(2, 4, 6)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def map(self, f: Callable[[_T_co], _T]) -> AwaitableTupleWrapper[_T]:
    """Apply a synchronous function to each element in the wrapped
    [trcks.AwaitableTuple][] object.

    Args:
        f: The synchronous function to be applied to each element.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the wrapped [trcks.AwaitableTuple][] object containing
            the results of applying the function to each element.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> def double_integer(n: int) -> int:
        ...     return n * 2
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2, 3))
        ...     .map(double_integer)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (2, 4, 6)
    """
    return AwaitableTupleWrapper(at.map_(f)(self.core))

map_to_awaitable(f)

Apply an asynchronous function to each element in the wrapped trcks.AwaitableTuple object.

Parameters:

  • f (Callable[[_T_co], Awaitable[_T]]) –

    The asynchronous function to be applied to each element.

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> async def slowly_add_one(n: int) -> int:
...     await asyncio.sleep(0.001)
...     return n + 1
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2))
...     .map_to_awaitable(slowly_add_one)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(2, 3)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
def map_to_awaitable(
    self, f: Callable[[_T_co], Awaitable[_T]]
) -> AwaitableTupleWrapper[_T]:
    """Apply an asynchronous function to each element in the wrapped
    [trcks.AwaitableTuple][] object.

    Args:
        f: The asynchronous function to be applied to each element.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the wrapped [trcks.AwaitableTuple][] object containing
            the results of applying the function to each element.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> async def slowly_add_one(n: int) -> int:
        ...     await asyncio.sleep(0.001)
        ...     return n + 1
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2))
        ...     .map_to_awaitable(slowly_add_one)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (2, 3)
    """
    return AwaitableTupleWrapper(at.map_to_awaitable(f)(self.core))

map_to_awaitable_iterable(f)

Apply an asynchronous function returning a trcks.AwaitableIterable to each element in the wrapped trcks.AwaitableTuple and flatten.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> async def slowly_duplicate(n: int) -> tuple[int, int]:
...     await asyncio.sleep(0.001)
...     return n, n
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2))
...     .map_to_awaitable_iterable(slowly_duplicate)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(1, 1, 2, 2)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
def map_to_awaitable_iterable(
    self, f: Callable[[_T_co], AwaitableIterable[_T]]
) -> AwaitableTupleWrapper[_T]:
    """Apply an asynchronous function returning a [trcks.AwaitableIterable][]
    to each element in the wrapped [trcks.AwaitableTuple][] and flatten.

    Args:
        f: The asynchronous function to be applied to each element,
            returning a [trcks.AwaitableIterable][].

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the flattened [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> async def slowly_duplicate(n: int) -> tuple[int, int]:
        ...     await asyncio.sleep(0.001)
        ...     return n, n
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2))
        ...     .map_to_awaitable_iterable(slowly_duplicate)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (1, 1, 2, 2)
    """
    return AwaitableTupleWrapper(at.map_to_awaitable_iterable(f)(self.core))

map_to_awaitable_tuple(f)

Deprecated alias for trcks.oop.AwaitableTupleWrapper.map_to_awaitable_iterable.

Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
238
239
240
241
242
243
244
245
@deprecated("Use map_to_awaitable_iterable instead")
def map_to_awaitable_tuple(
    self, f: Callable[[_T_co], AwaitableTuple[_T]]
) -> AwaitableTupleWrapper[_T]:
    """Deprecated alias for
    [trcks.oop.AwaitableTupleWrapper.map_to_awaitable_iterable][].
    """
    return self.map_to_awaitable_iterable(f)  # pragma: no cover

map_to_iterable(f)

Apply a synchronous function returning an collections.abc.Iterable to each element in the wrapped trcks.AwaitableTuple object and flatten.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> def add_negative(n: int) -> tuple[int, int]:
...     return n, -n
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2))
...     .map_to_iterable(add_negative)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(1, -1, 2, -2)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def map_to_iterable(
    self, f: Callable[[_T_co], Iterable[_T]]
) -> AwaitableTupleWrapper[_T]:
    """Apply a synchronous function returning an [collections.abc.Iterable][]
    to each element in the wrapped [trcks.AwaitableTuple][] object and flatten.

    Args:
        f: The synchronous function to be applied to each element,
            returning an [collections.abc.Iterable][].

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the flattened [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> def add_negative(n: int) -> tuple[int, int]:
        ...     return n, -n
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2))
        ...     .map_to_iterable(add_negative)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (1, -1, 2, -2)
    """
    return AwaitableTupleWrapper(at.map_to_iterable(f)(self.core))

map_to_tuple(f)

Deprecated alias for trcks.oop.AwaitableTupleWrapper.map_to_iterable.

Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
279
280
281
282
283
284
285
286
@deprecated("Use map_to_iterable instead")
def map_to_tuple(
    self, f: Callable[[_T_co], tuple[_T, ...]]
) -> AwaitableTupleWrapper[_T]:
    """Deprecated alias for
    [trcks.oop.AwaitableTupleWrapper.map_to_iterable][].
    """
    return self.map_to_iterable(f)  # pragma: no cover

tap(f)

Apply a synchronous side effect to each element in the wrapped trcks.AwaitableTuple object.

Parameters:

  • f (Callable[[_T_co], object]) –

    The synchronous side effect to be applied to each element.

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> def log_integer(n: int) -> None:
...     print(f"Received: {n}")
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2))
...     .tap(log_integer)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
Received: 1
Received: 2
(1, 2)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
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
def tap(self, f: Callable[[_T_co], object]) -> AwaitableTupleWrapper[_T_co]:
    """Apply a synchronous side effect to each element in the wrapped
    [trcks.AwaitableTuple][] object.

    Args:
        f: The synchronous side effect to be applied to each element.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the original [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> def log_integer(n: int) -> None:
        ...     print(f"Received: {n}")
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2))
        ...     .tap(log_integer)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        Received: 1
        Received: 2
        (1, 2)
    """
    return AwaitableTupleWrapper(at.tap(f)(self.core))

tap_to_awaitable(f)

Apply an asynchronous side effect to each element in the wrapped trcks.AwaitableTuple object.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> async def slowly_log(n: int) -> None:
...     await asyncio.sleep(0.001)
...     print(f"Logged: {n}")
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2))
...     .tap_to_awaitable(slowly_log)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
Logged: 1
Logged: 2
(1, 2)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
319
320
321
322
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
def tap_to_awaitable(
    self, f: Callable[[_T_co], Awaitable[object]]
) -> AwaitableTupleWrapper[_T_co]:
    """Apply an asynchronous side effect to each element in the wrapped
    [trcks.AwaitableTuple][] object.

    Args:
        f: The asynchronous side effect to be applied to each element.

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the original [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> async def slowly_log(n: int) -> None:
        ...     await asyncio.sleep(0.001)
        ...     print(f"Logged: {n}")
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2))
        ...     .tap_to_awaitable(slowly_log)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        Logged: 1
        Logged: 2
        (1, 2)
    """
    return AwaitableTupleWrapper(at.tap_to_awaitable(f)(self.core))

tap_to_awaitable_iterable(f)

Apply an asynchronous side effect returning a trcks.AwaitableIterable to each element in the wrapped trcks.AwaitableTuple object.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> async def slowly_get_divisors(n: int) -> tuple[int, ...]:
...     await asyncio.sleep(0.001)
...     candidates = range(1, n + 1)
...     return tuple(c for c in candidates if n % c == 0)
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2, 3, 4))
...     .tap_to_awaitable_iterable(slowly_get_divisors)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(1, 2, 2, 3, 3, 4, 4, 4)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
def tap_to_awaitable_iterable(
    self, f: Callable[[_T_co], AwaitableIterable[object]]
) -> AwaitableTupleWrapper[_T_co]:
    """Apply an asynchronous side effect returning a [trcks.AwaitableIterable][]
    to each element in the wrapped [trcks.AwaitableTuple][] object.

    Args:
        f: The asynchronous side effect to be applied to each element,
            returning a [trcks.AwaitableIterable][].

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the original [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> async def slowly_get_divisors(n: int) -> tuple[int, ...]:
        ...     await asyncio.sleep(0.001)
        ...     candidates = range(1, n + 1)
        ...     return tuple(c for c in candidates if n % c == 0)
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2, 3, 4))
        ...     .tap_to_awaitable_iterable(slowly_get_divisors)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (1, 2, 2, 3, 3, 4, 4, 4)
    """
    return AwaitableTupleWrapper(at.tap_to_awaitable_iterable(f)(self.core))

tap_to_awaitable_tuple(f)

Deprecated alias for trcks.oop.AwaitableTupleWrapper.tap_to_awaitable_iterable.

Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
387
388
389
390
391
392
393
394
@deprecated("Use tap_to_awaitable_iterable instead")
def tap_to_awaitable_tuple(
    self, f: Callable[[_T_co], AwaitableTuple[object]]
) -> AwaitableTupleWrapper[_T_co]:
    """Deprecated alias for
    [trcks.oop.AwaitableTupleWrapper.tap_to_awaitable_iterable][].
    """
    return self.tap_to_awaitable_iterable(f)  # pragma: no cover

tap_to_iterable(f)

Apply a synchronous side effect returning an collections.abc.Iterable to each element in the wrapped trcks.AwaitableTuple object.

Parameters:

Returns:

Example 
>>> import asyncio
>>> from trcks.oop import AwaitableTupleWrapper
>>> def get_divisors(n: int) -> tuple[int, ...]:
...     candidates = range(1, n + 1)
...     return tuple(c for c in candidates if n % c == 0)
...
>>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
...     AwaitableTupleWrapper
...     .construct_from_iterable((1, 2, 3, 4))
...     .tap_to_iterable(get_divisors)
... )
>>> awaitable_tuple_wrapper
AwaitableTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
(1, 2, 2, 3, 3, 4, 4, 4)
Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
def tap_to_iterable(
    self, f: Callable[[_T_co], Iterable[object]]
) -> AwaitableTupleWrapper[_T_co]:
    """Apply a synchronous side effect returning an [collections.abc.Iterable][]
    to each element in the wrapped [trcks.AwaitableTuple][] object.

    Args:
        f: The synchronous side effect to be applied to each element,
            returning an [collections.abc.Iterable][].

    Returns:
        A new [trcks.oop.AwaitableTupleWrapper][] instance with
            the original [trcks.AwaitableTuple][] object.

    Example:
        >>> import asyncio
        >>> from trcks.oop import AwaitableTupleWrapper
        >>> def get_divisors(n: int) -> tuple[int, ...]:
        ...     candidates = range(1, n + 1)
        ...     return tuple(c for c in candidates if n % c == 0)
        ...
        >>> awaitable_tuple_wrapper: AwaitableTupleWrapper[int] = (
        ...     AwaitableTupleWrapper
        ...     .construct_from_iterable((1, 2, 3, 4))
        ...     .tap_to_iterable(get_divisors)
        ... )
        >>> awaitable_tuple_wrapper
        AwaitableTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        (1, 2, 2, 3, 3, 4, 4, 4)
    """
    return AwaitableTupleWrapper(at.tap_to_iterable(f)(self.core))

tap_to_tuple(f)

Deprecated alias for trcks.oop.AwaitableTupleWrapper.tap_to_iterable.

Source code in src/trcks/oop/_awaitable_tuple_wrapper.py 
429
430
431
432
433
434
435
436
@deprecated("Use tap_to_iterable instead")
def tap_to_tuple(
    self, f: Callable[[_T_co], tuple[object, ...]]
) -> AwaitableTupleWrapper[_T_co]:
    """Deprecated alias for
    [trcks.oop.AwaitableTupleWrapper.tap_to_iterable][].
    """
    return self.tap_to_iterable(f)  # pragma: no cover