Skip to content

trcks.oop.Wrapper

Bases: BaseWrapper[_T_co]

Type-safe and immutable wrapper for arbitrary objects.

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

Examples:

The string "Hello" is wrapped and manipulated in the following example. Finally, the result is unwrapped:

>>> wrapper = (
...     Wrapper(core="Hello")
...     .map(len)
...     .tap(lambda n: print(f"Received {n}."))
...     .map(lambda n: f"Length: {n}")
... )
Received 5.
>>> wrapper
Wrapper(core='Length: 5')
>>> wrapper.core
'Length: 5'
Source code in src/trcks/oop/_wrapper.py
 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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
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
503
504
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
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
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
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
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
@final
@dataclass(frozen=True, slots=True)
class Wrapper(BaseWrapper[_T_co]):
    """Type-safe and immutable wrapper for arbitrary objects.

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

    Examples:
        The string `"Hello"` is wrapped and manipulated in the following example.
        Finally, the result is unwrapped:

        >>> wrapper = (
        ...     Wrapper(core="Hello")
        ...     .map(len)
        ...     .tap(lambda n: print(f"Received {n}."))
        ...     .map(lambda n: f"Length: {n}")
        ... )
        Received 5.
        >>> wrapper
        Wrapper(core='Length: 5')
        >>> wrapper.core
        'Length: 5'
    """

    @staticmethod
    def construct(value: _T, /) -> Wrapper[_T]:
        """Alias for the default constructor.

        Args:
            value: The object to be wrapped.

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

        Examples:
            >>> Wrapper.construct(5)
            Wrapper(core=5)
        """
        return Wrapper(core=value)

    def map(
        self,
        callable_: Callable[Concatenate[_T_co, _P], _T],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> Wrapper[_T]:
        """Apply a synchronous function to the wrapped object.

        Args:
            callable_: The synchronous function to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A new [trcks.oop.Wrapper][] instance
                with the result of the function application.

        Examples:
            >>> Wrapper.construct(5).map(lambda n: f"The number is {n}.")
            Wrapper(core='The number is 5.')
        """
        return Wrapper(callable_(self.core, *args, **kwargs))

    def map_to_awaitable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], Awaitable[_T]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableWrapper[_T]:
        """Apply an asynchronous function to the wrapped object.

        Args:
            callable_: The asynchronous function to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableWrapper][] instance with
                the result of the function application.

        Examples:
            >>> import asyncio
            >>> from trcks.oop import Wrapper
            >>> async def stringify_slowly(o: object) -> str:
            ...     await asyncio.sleep(0.001)
            ...     return str(o)
            ...
            >>> awaitable_wrapper = Wrapper.construct(3.14).map_to_awaitable(
            ...     stringify_slowly
            ... )
            >>> awaitable_wrapper
            AwaitableWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_wrapper.core_as_coroutine)
            '3.14'
        """
        return AwaitableWrapper(
            i.map_to_awaitable(callable_, *args, **kwargs)(self.core)
        )

    def map_to_awaitable_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableIterable[_T]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableTupleWrapper[_T]:
        """Apply an asynchronous function returning a [collections.abc.Iterable][]
        to the wrapped object.

        Args:
            callable_: The asynchronous function to be applied, returning a
                [collections.abc.Iterable][].
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableTupleWrapper][] instance with
                the result of the function application.

        Examples:
            >>> import asyncio
            >>> from trcks.oop import Wrapper
            >>> async def slowly_duplicate(n: int) -> tuple[int, int]:
            ...     await asyncio.sleep(0.001)
            ...     return n, n
            ...
            >>> async def main() -> tuple[int, ...]:
            ...     awaitable_tuple_wrapper = (
            ...         Wrapper.construct(7).map_to_awaitable_iterable(slowly_duplicate)
            ...     )
            ...     result_tuple = await awaitable_tuple_wrapper.core
            ...     assert len(result_tuple) == 2
            ...     return result_tuple
            ...
            >>> asyncio.run(main())
            (7, 7)
        """
        return AwaitableTupleWrapper(
            i.map_to_awaitable_iterable(callable_, *args, **kwargs)(self.core)
        )

    def map_to_awaitable_result(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableResult[_F, _S]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableResultWrapper[_F, _S]:
        """Apply an asynchronous function with return type [trcks.Result][]
        to the wrapped object.

        Args:
            callable_: The asynchronous function to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableResultWrapper][] instance with
                the result of the function application.

        Examples:
            >>> import asyncio
            >>> from trcks import Result
            >>> from trcks.oop import Wrapper
            >>> async def slowly_assert_non_negative(
            ...     x: float,
            ... ) -> Result[str, float]:
            ...     await asyncio.sleep(0.001)
            ...     if x < 0:
            ...         return "failure", "negative value"
            ...     return "success", x
            ...
            >>> awaitable_result_wrapper = (
            ...     Wrapper
            ...     .construct(42.0)
            ...     .map_to_awaitable_result(slowly_assert_non_negative)
            ... )
            >>> awaitable_result_wrapper
            AwaitableResultWrapper(core=<coroutine object ...>)
            >>> asyncio.run(awaitable_result_wrapper.core_as_coroutine)
            ('success', 42.0)
        """
        return AwaitableResultWrapper(
            i.map_to_awaitable_result(callable_, *args, **kwargs)(self.core)
        )

    def map_to_awaitable_result_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableResultIterable[_F, _S]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableResultTupleWrapper[_F, _S]:
        """Apply an asynchronous function with return type
        [trcks.AwaitableResultIterable][] to the wrapped object.

        Args:
            callable_: The asynchronous function to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableResultTupleWrapper][] instance with
                the result of the function application.

        Examples:
            >>> import asyncio
            >>> from trcks import AwaitableResultTuple
            >>> from trcks.oop import Wrapper
            >>> async def validate(x: float) -> AwaitableResultTuple[str, float]:
            ...     await asyncio.sleep(0.001)
            ...     if x < 0:
            ...         return "failure", "negative value"
            ...     return "success", (x, x * 2)
            ...
            >>> wrapper = (
            ...     Wrapper
            ...     .construct(5.0)
            ...     .map_to_awaitable_result_iterable(validate)
            ... )
            >>> wrapper
            AwaitableResultTupleWrapper(core=<coroutine object ...>)
            >>> asyncio.run(wrapper.core_as_coroutine)
            ('success', (5.0, 10.0))
        """
        return AwaitableResultTupleWrapper(
            i.map_to_awaitable_result_iterable(callable_, *args, **kwargs)(self.core)
        )

    @deprecated("Use map_to_awaitable_result_iterable instead")
    def map_to_awaitable_result_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableResultTuple[_F, _S]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableResultTupleWrapper[_F, _S]:
        """Deprecated alias for
        [trcks.oop.Wrapper.map_to_awaitable_result_iterable][].
        """
        return self.map_to_awaitable_result_iterable(
            callable_, *args, **kwargs
        )  # pragma: no cover

    @deprecated("Use map_to_awaitable_iterable instead")
    def map_to_awaitable_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableTuple[_T]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableTupleWrapper[_T]:
        """Deprecated alias for [trcks.oop.Wrapper.map_to_awaitable_iterable][]."""
        return self.map_to_awaitable_iterable(
            callable_, *args, **kwargs
        )  # pragma: no cover

    def map_to_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], Iterable[_T]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> TupleWrapper[_T]:
        """Apply a function returning an [collections.abc.Iterable][]
        to the wrapped object.

        Args:
            callable_: The function to be applied,
                returning a [collections.abc.Iterable][].
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.TupleWrapper][] instance with
                the result of the function application.

        Examples:
            >>> from trcks.oop import Wrapper
            >>> def duplicate(n: int) -> tuple[int, int]:
            ...     return n, n
            ...
            >>> Wrapper.construct(3).map_to_iterable(duplicate)
            TupleWrapper(core=(3, 3))
        """
        return TupleWrapper(i.map_to_iterable(callable_, *args, **kwargs)(self.core))

    def map_to_result(
        self,
        callable_: Callable[Concatenate[_T_co, _P], Result[_F, _S]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> ResultWrapper[_F, _S]:
        """Apply a synchronous function with return type [trcks.Result][]
        to the wrapped object.

        Args:
            callable_: The synchronous function to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.ResultWrapper][] instance with
                the result of the function application.

        Examples:
            >>> Wrapper.construct(-1).map_to_result(
            ...     lambda n: ("success", n)
            ...     if n >= 0
            ...     else ("failure", "negative value")
            ... )
            ResultWrapper(core=('failure', 'negative value'))
        """
        return ResultWrapper(i.map_to_result(callable_, *args, **kwargs)(self.core))

    def map_to_result_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], ResultIterable[_F, _S]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> ResultTupleWrapper[_F, _S]:
        """Apply a synchronous function with return type [trcks.ResultIterable][]
        to the wrapped object.

        Args:
            callable_: The synchronous function to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.ResultTupleWrapper][] instance with
                the result of the function application.

        Examples:
            >>> from trcks import ResultTuple
            >>> Wrapper.construct(-1).map_to_result_iterable(
            ...     lambda n: ("success", (n, n))
            ...     if n >= 0
            ...     else ("failure", "negative value")
            ... )
            ResultTupleWrapper(core=('failure', 'negative value'))
        """
        return ResultTupleWrapper(
            i.map_to_result_iterable(callable_, *args, **kwargs)(self.core)
        )

    @deprecated("Use map_to_result_iterable instead")
    def map_to_result_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], ResultTuple[_F, _S]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> ResultTupleWrapper[_F, _S]:
        """Deprecated alias for [trcks.oop.Wrapper.map_to_result_iterable][]."""
        return self.map_to_result_iterable(
            callable_, *args, **kwargs
        )  # pragma: no cover

    @deprecated("Use map_to_iterable instead")
    def map_to_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], tuple[_T, ...]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> TupleWrapper[_T]:
        """Deprecated alias for [trcks.oop.Wrapper.map_to_iterable][]."""
        return self.map_to_iterable(callable_, *args, **kwargs)  # pragma: no cover

    def tap(
        self,
        callable_: Callable[Concatenate[_T_co, _P], object],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> Wrapper[_T_co]:
        """Apply a synchronous side effect to the wrapped object.

        Args:
            callable_: The synchronous side effect to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A new [trcks.oop.Wrapper][] instance with the original wrapped object,
                allowing for further method chaining.

        Examples:
            >>> wrapper = Wrapper.construct(5).tap(lambda n: print(f"Number: {n}"))
            Number: 5
            >>> wrapper
            Wrapper(core=5)
        """
        return self.map(i.tap(callable_, *args, **kwargs))

    def tap_to_awaitable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], Awaitable[object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableWrapper[_T_co]:
        """Apply an asynchronous side effect to the wrapped object.

        Args:
            callable_: The asynchronous side effect to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableWrapper][] instance with the original wrapped object.

        Examples:
            >>> import asyncio
            >>> from trcks.oop import Wrapper
            >>> async def write_to_disk(s: str) -> None:
            ...     await asyncio.sleep(0.001)
            ...     print(f"Wrote '{s}' to disk.")
            ...
            >>> awaitable_wrapper = Wrapper.construct(
            ...     "Hello, world!"
            ... ).tap_to_awaitable(write_to_disk)
            >>> awaitable_wrapper
            AwaitableWrapper(core=<coroutine object ...>)
            >>> value = asyncio.run(awaitable_wrapper.core_as_coroutine)
            Wrote 'Hello, world!' to disk.
            >>> value
            'Hello, world!'
        """
        return AwaitableWrapper(
            i.tap_to_awaitable(callable_, *args, **kwargs)(self.core)
        )

    def tap_to_awaitable_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableIterable[object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableTupleWrapper[_T_co]:
        """Apply an asynchronous side effect returning a [trcks.AwaitableIterable][]
        to the wrapped object.

        Args:
            callable_: The asynchronous side effect to be applied,
                returning a [trcks.AwaitableIterable][].
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableTupleWrapper][] instance with
                the original wrapped object repeated once per item returned by the
                side effect.

        Examples:
            >>> import asyncio
            >>> from trcks.oop import Wrapper
            >>> async def write_to_disk(n: int) -> tuple[str, str]:
            ...     await asyncio.sleep(0.001)
            ...     print(f"Wrote {n} to disk.")
            ...     return "left", "right"
            ...
            >>> awaitable_tuple_wrapper = Wrapper.construct(
            ...     3
            ... ).tap_to_awaitable_iterable(write_to_disk)
            >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
            Wrote 3 to disk.
            (3, 3)
        """
        return AwaitableTupleWrapper(
            i.tap_to_awaitable_iterable(callable_, *args, **kwargs)(self.core)
        )

    def tap_to_awaitable_result(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableResult[_F, object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableResultWrapper[_F, _T_co]:
        """Apply an asynchronous side effect with return type [trcks.Result][]
        to the wrapped object.

        Args:
            callable_: The asynchronous side effect to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableResultWrapper][] instance with

                - *the returned* [trcks.Failure][]
                    if the given side effect returns a [trcks.Failure][] or
                - a [trcks.Success][] instance containing *the original* wrapped object
                    if the given side effect returns a [trcks.Success][].

        Examples:
            >>> import asyncio
            >>> from trcks import Result
            >>> from trcks.oop import Wrapper
            >>> async def write_to_disk(s: str, path: str) -> Result[str, None]:
            ...     if path != "output.txt":
            ...         return "failure", "write error"
            ...     await asyncio.sleep(0.001)
            ...     print(f"Wrote '{s}' to file {path}.")
            ...     return "success", None
            ...
            >>> awaitable_result_wrapper_1 = Wrapper.construct(
            ...     "Hello, world!"
            ... ).tap_to_awaitable_result(
            ...     lambda s: write_to_disk(s, "destination.txt")
            ... )
            >>> awaitable_result_wrapper_1
            AwaitableResultWrapper(core=<coroutine object ...>)
            >>> result_1 = asyncio.run(awaitable_result_wrapper_1.core_as_coroutine)
            >>> result_1
            ('failure', 'write error')
            >>> awaitable_result_wrapper_2 = Wrapper.construct(
            ...     "Hello, world!"
            ... ).tap_to_awaitable_result(
            ...     lambda s: write_to_disk(s, "output.txt")
            ... )
            >>> awaitable_result_wrapper_2
            AwaitableResultWrapper(core=<coroutine object ...>)
            >>> result_2 = asyncio.run(awaitable_result_wrapper_2.core_as_coroutine)
            Wrote 'Hello, world!' to file output.txt.
            >>> result_2
            ('success', 'Hello, world!')
        """
        return AwaitableResultWrapper(
            i.tap_to_awaitable_result(callable_, *args, **kwargs)(self.core)
        )

    def tap_to_awaitable_result_iterable(
        self,
        callable_: Callable[
            Concatenate[_T_co, _P], AwaitableResultIterable[_F, object]
        ],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableResultTupleWrapper[_F, _T_co]:
        """Apply an asynchronous side effect with return type
        [trcks.AwaitableResultIterable][] to the wrapped object.

        Args:
            callable_: The asynchronous side effect to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.AwaitableResultTupleWrapper][] instance with

                - *the returned* [trcks.Failure][]
                    if the given side effect returns a [trcks.Failure][] or
                - *the original* wrapped object repeated once per element
                    in the side effect output if the given side effect
                    returns [trcks.SuccessIterable][].

        Examples:
            >>> import asyncio
            >>> from trcks import AwaitableResultTuple
            >>> from trcks.oop import Wrapper
            >>> async def write_twice(
            ...     s: str,
            ... ) -> AwaitableResultTuple[str, None]:
            ...     await asyncio.sleep(0.001)
            ...     print(f"Wrote '{s}' twice.")
            ...     return "success", (None, None)
            ...
            >>> wrapper = Wrapper.construct(
            ...     "Hello, world!"
            ... ).tap_to_awaitable_result_iterable(write_twice)
            >>> wrapper
            AwaitableResultTupleWrapper(core=<coroutine object ...>)
            >>> result = asyncio.run(wrapper.core_as_coroutine)
            Wrote 'Hello, world!' twice.
            >>> result
            ('success', ('Hello, world!', 'Hello, world!'))
        """
        return AwaitableResultTupleWrapper(
            i.tap_to_awaitable_result_iterable(callable_, *args, **kwargs)(self.core)
        )

    @deprecated("Use tap_to_awaitable_result_iterable instead")
    def tap_to_awaitable_result_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableResultTuple[_F, object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableResultTupleWrapper[_F, _T_co]:
        """Deprecated alias for
        [trcks.oop.Wrapper.tap_to_awaitable_result_iterable][].
        """
        return self.tap_to_awaitable_result_iterable(
            callable_, *args, **kwargs
        )  # pragma: no cover

    @deprecated("Use tap_to_awaitable_iterable instead")
    def tap_to_awaitable_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], AwaitableTuple[object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> AwaitableTupleWrapper[_T_co]:
        """Deprecated alias for [trcks.oop.Wrapper.tap_to_awaitable_iterable][]."""
        return self.tap_to_awaitable_iterable(
            callable_, *args, **kwargs
        )  # pragma: no cover

    def tap_to_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], Iterable[object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> TupleWrapper[_T_co]:
        """Apply a side effect returning an [collections.abc.Iterable][] to the
        wrapped object.

        Args:
            callable_: The side effect to be applied, returning an
                [collections.abc.Iterable][].
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.TupleWrapper][] instance with the original wrapped
                object repeated once per item returned by the side effect.

        Examples:
            >>> from trcks.oop import Wrapper
            >>> def write_to_disk(n: int) -> tuple[str, str]:
            ...     print(f"Wrote {n} to disk.")
            ...     return "left", "right"
            ...
            >>> Wrapper.construct(3).tap_to_iterable(write_to_disk)
            Wrote 3 to disk.
            TupleWrapper(core=(3, 3))
        """
        return TupleWrapper(i.tap_to_iterable(callable_, *args, **kwargs)(self.core))

    def tap_to_result(
        self,
        callable_: Callable[Concatenate[_T_co, _P], Result[_F, object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> ResultWrapper[_F, _T_co]:
        """Apply a synchronous side effect with return type [trcks.Result][]
        to the wrapped object.

        Args:
            callable_: The synchronous side effect to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.ResultWrapper][] instance with

                - *the returned* [trcks.Failure][]
                    if the given side effect returns a [trcks.Failure][] or
                - a [trcks.Success][] instance containing *the original* wrapped object
                    if the given side effect returns a [trcks.Success][].

        Examples:
            >>> from trcks import Result
            >>> from trcks.oop import Wrapper
            >>> def print_positive_float(x: float) -> Result[str, None]:
            ...     if x <= 0:
            ...         return "failure", "not positive"
            ...     return "success", print(f"Positive float: {x}")
            ...
            >>> result_wrapper_1 = Wrapper.construct(-2.3).tap_to_result(
            ...     print_positive_float
            ... )
            >>> result_wrapper_1
            ResultWrapper(core=('failure', 'not positive'))
            >>> result_wrapper_2 = Wrapper.construct(3.5).tap_to_result(
            ...     print_positive_float
            ... )
            Positive float: 3.5
            >>> result_wrapper_2
            ResultWrapper(core=('success', 3.5))
        """
        return ResultWrapper(i.tap_to_result(callable_, *args, **kwargs)(self.core))

    def tap_to_result_iterable(
        self,
        callable_: Callable[Concatenate[_T_co, _P], ResultIterable[_F, object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> ResultTupleWrapper[_F, _T_co]:
        """Apply a synchronous side effect with return type [trcks.ResultIterable][]
        to the wrapped object.

        Args:
            callable_: The synchronous side effect to be applied.
            *args:
                Positional arguments to be passed to `callable_`.
            **kwargs:
                Keyword arguments to be passed to `callable_`.

        Returns:
            A [trcks.oop.ResultTupleWrapper][] instance with

                - *the returned* [trcks.Failure][]
                    if the given side effect returns a [trcks.Failure][] or
                - *the original* [trcks.SuccessIterable][] element repeated once
                    per element in the side effect output if the given side effect
                    returns [trcks.SuccessIterable][].

        Examples:
            >>> from trcks import ResultTuple
            >>> from trcks.oop import Wrapper
            >>> def print_positive_float(x: float) -> ResultTuple[str, None]:
            ...     if x <= 0:
            ...         return "failure", "not positive"
            ...     return (
            ...         "success",
            ...         (print(f"Positive float: {x}"), print(f"Positive float: {x}"))
            ...     )
            >>> result_tuple_wrapper_1 = Wrapper.construct(
            ...     -2.3
            ... ).tap_to_result_iterable(print_positive_float)
            >>> result_tuple_wrapper_1
            ResultTupleWrapper(core=('failure', 'not positive'))
            >>> result_tuple_wrapper_2 = Wrapper.construct(
            ...     3.5
            ... ).tap_to_result_iterable(print_positive_float)
            Positive float: 3.5
            Positive float: 3.5
            >>> result_tuple_wrapper_2
            ResultTupleWrapper(core=('success', (3.5, 3.5)))
        """
        return ResultTupleWrapper(
            i.tap_to_result_iterable(callable_, *args, **kwargs)(self.core)
        )

    @deprecated("Use tap_to_result_iterable instead")
    def tap_to_result_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], ResultTuple[_F, object]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> ResultTupleWrapper[_F, _T_co]:
        """Deprecated alias for [trcks.oop.Wrapper.tap_to_result_iterable][]."""
        return self.tap_to_result_iterable(
            callable_, *args, **kwargs
        )  # pragma: no cover

    @deprecated("Use tap_to_iterable instead")
    def tap_to_tuple(
        self,
        callable_: Callable[Concatenate[_T_co, _P], tuple[object, ...]],
        /,
        *args: _P.args,
        **kwargs: _P.kwargs,
    ) -> TupleWrapper[_T_co]:
        """Deprecated alias for [trcks.oop.Wrapper.tap_to_iterable][]."""
        return self.tap_to_iterable(callable_, *args, **kwargs)  # pragma: no cover

construct(value) staticmethod

Alias for the default constructor.

Parameters:

  • value (_T) –

    The object to be wrapped.

Returns:

Examples:

>>> Wrapper.construct(5)
Wrapper(core=5)
Source code in src/trcks/oop/_wrapper.py
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@staticmethod
def construct(value: _T, /) -> Wrapper[_T]:
    """Alias for the default constructor.

    Args:
        value: The object to be wrapped.

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

    Examples:
        >>> Wrapper.construct(5)
        Wrapper(core=5)
    """
    return Wrapper(core=value)

map(callable_, /, *args, **kwargs)

Apply a synchronous function to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], _T]) –

    The synchronous function to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> Wrapper.construct(5).map(lambda n: f"The number is {n}.")
Wrapper(core='The number is 5.')
Source code in src/trcks/oop/_wrapper.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
def map(
    self,
    callable_: Callable[Concatenate[_T_co, _P], _T],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> Wrapper[_T]:
    """Apply a synchronous function to the wrapped object.

    Args:
        callable_: The synchronous function to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A new [trcks.oop.Wrapper][] instance
            with the result of the function application.

    Examples:
        >>> Wrapper.construct(5).map(lambda n: f"The number is {n}.")
        Wrapper(core='The number is 5.')
    """
    return Wrapper(callable_(self.core, *args, **kwargs))

map_to_awaitable(callable_, /, *args, **kwargs)

Apply an asynchronous function to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], Awaitable[_T]]) –

    The asynchronous function to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks.oop import Wrapper
>>> async def stringify_slowly(o: object) -> str:
...     await asyncio.sleep(0.001)
...     return str(o)
...
>>> awaitable_wrapper = Wrapper.construct(3.14).map_to_awaitable(
...     stringify_slowly
... )
>>> awaitable_wrapper
AwaitableWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_wrapper.core_as_coroutine)
'3.14'
Source code in src/trcks/oop/_wrapper.py
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
def map_to_awaitable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], Awaitable[_T]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableWrapper[_T]:
    """Apply an asynchronous function to the wrapped object.

    Args:
        callable_: The asynchronous function to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableWrapper][] instance with
            the result of the function application.

    Examples:
        >>> import asyncio
        >>> from trcks.oop import Wrapper
        >>> async def stringify_slowly(o: object) -> str:
        ...     await asyncio.sleep(0.001)
        ...     return str(o)
        ...
        >>> awaitable_wrapper = Wrapper.construct(3.14).map_to_awaitable(
        ...     stringify_slowly
        ... )
        >>> awaitable_wrapper
        AwaitableWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_wrapper.core_as_coroutine)
        '3.14'
    """
    return AwaitableWrapper(
        i.map_to_awaitable(callable_, *args, **kwargs)(self.core)
    )

map_to_awaitable_iterable(callable_, /, *args, **kwargs)

Apply an asynchronous function returning a collections.abc.Iterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], AwaitableIterable[_T]]) –

    The asynchronous function to be applied, returning a collections.abc.Iterable.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks.oop import Wrapper
>>> async def slowly_duplicate(n: int) -> tuple[int, int]:
...     await asyncio.sleep(0.001)
...     return n, n
...
>>> async def main() -> tuple[int, ...]:
...     awaitable_tuple_wrapper = (
...         Wrapper.construct(7).map_to_awaitable_iterable(slowly_duplicate)
...     )
...     result_tuple = await awaitable_tuple_wrapper.core
...     assert len(result_tuple) == 2
...     return result_tuple
...
>>> asyncio.run(main())
(7, 7)
Source code in src/trcks/oop/_wrapper.py
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
def map_to_awaitable_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableIterable[_T]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableTupleWrapper[_T]:
    """Apply an asynchronous function returning a [collections.abc.Iterable][]
    to the wrapped object.

    Args:
        callable_: The asynchronous function to be applied, returning a
            [collections.abc.Iterable][].
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableTupleWrapper][] instance with
            the result of the function application.

    Examples:
        >>> import asyncio
        >>> from trcks.oop import Wrapper
        >>> async def slowly_duplicate(n: int) -> tuple[int, int]:
        ...     await asyncio.sleep(0.001)
        ...     return n, n
        ...
        >>> async def main() -> tuple[int, ...]:
        ...     awaitable_tuple_wrapper = (
        ...         Wrapper.construct(7).map_to_awaitable_iterable(slowly_duplicate)
        ...     )
        ...     result_tuple = await awaitable_tuple_wrapper.core
        ...     assert len(result_tuple) == 2
        ...     return result_tuple
        ...
        >>> asyncio.run(main())
        (7, 7)
    """
    return AwaitableTupleWrapper(
        i.map_to_awaitable_iterable(callable_, *args, **kwargs)(self.core)
    )

map_to_awaitable_result(callable_, /, *args, **kwargs)

Apply an asynchronous function with return type trcks.Result to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], AwaitableResult[_F, _S]]) –

    The asynchronous function to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks import Result
>>> from trcks.oop import Wrapper
>>> async def slowly_assert_non_negative(
...     x: float,
... ) -> Result[str, float]:
...     await asyncio.sleep(0.001)
...     if x < 0:
...         return "failure", "negative value"
...     return "success", x
...
>>> awaitable_result_wrapper = (
...     Wrapper
...     .construct(42.0)
...     .map_to_awaitable_result(slowly_assert_non_negative)
... )
>>> awaitable_result_wrapper
AwaitableResultWrapper(core=<coroutine object ...>)
>>> asyncio.run(awaitable_result_wrapper.core_as_coroutine)
('success', 42.0)
Source code in src/trcks/oop/_wrapper.py
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
def map_to_awaitable_result(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableResult[_F, _S]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableResultWrapper[_F, _S]:
    """Apply an asynchronous function with return type [trcks.Result][]
    to the wrapped object.

    Args:
        callable_: The asynchronous function to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableResultWrapper][] instance with
            the result of the function application.

    Examples:
        >>> import asyncio
        >>> from trcks import Result
        >>> from trcks.oop import Wrapper
        >>> async def slowly_assert_non_negative(
        ...     x: float,
        ... ) -> Result[str, float]:
        ...     await asyncio.sleep(0.001)
        ...     if x < 0:
        ...         return "failure", "negative value"
        ...     return "success", x
        ...
        >>> awaitable_result_wrapper = (
        ...     Wrapper
        ...     .construct(42.0)
        ...     .map_to_awaitable_result(slowly_assert_non_negative)
        ... )
        >>> awaitable_result_wrapper
        AwaitableResultWrapper(core=<coroutine object ...>)
        >>> asyncio.run(awaitable_result_wrapper.core_as_coroutine)
        ('success', 42.0)
    """
    return AwaitableResultWrapper(
        i.map_to_awaitable_result(callable_, *args, **kwargs)(self.core)
    )

map_to_awaitable_result_iterable(callable_, /, *args, **kwargs)

Apply an asynchronous function with return type trcks.AwaitableResultIterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], AwaitableResultIterable[_F, _S]]) –

    The asynchronous function to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks import AwaitableResultTuple
>>> from trcks.oop import Wrapper
>>> async def validate(x: float) -> AwaitableResultTuple[str, float]:
...     await asyncio.sleep(0.001)
...     if x < 0:
...         return "failure", "negative value"
...     return "success", (x, x * 2)
...
>>> wrapper = (
...     Wrapper
...     .construct(5.0)
...     .map_to_awaitable_result_iterable(validate)
... )
>>> wrapper
AwaitableResultTupleWrapper(core=<coroutine object ...>)
>>> asyncio.run(wrapper.core_as_coroutine)
('success', (5.0, 10.0))
Source code in src/trcks/oop/_wrapper.py
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
def map_to_awaitable_result_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableResultIterable[_F, _S]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableResultTupleWrapper[_F, _S]:
    """Apply an asynchronous function with return type
    [trcks.AwaitableResultIterable][] to the wrapped object.

    Args:
        callable_: The asynchronous function to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableResultTupleWrapper][] instance with
            the result of the function application.

    Examples:
        >>> import asyncio
        >>> from trcks import AwaitableResultTuple
        >>> from trcks.oop import Wrapper
        >>> async def validate(x: float) -> AwaitableResultTuple[str, float]:
        ...     await asyncio.sleep(0.001)
        ...     if x < 0:
        ...         return "failure", "negative value"
        ...     return "success", (x, x * 2)
        ...
        >>> wrapper = (
        ...     Wrapper
        ...     .construct(5.0)
        ...     .map_to_awaitable_result_iterable(validate)
        ... )
        >>> wrapper
        AwaitableResultTupleWrapper(core=<coroutine object ...>)
        >>> asyncio.run(wrapper.core_as_coroutine)
        ('success', (5.0, 10.0))
    """
    return AwaitableResultTupleWrapper(
        i.map_to_awaitable_result_iterable(callable_, *args, **kwargs)(self.core)
    )

map_to_awaitable_result_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.map_to_awaitable_result_iterable.

Source code in src/trcks/oop/_wrapper.py
285
286
287
288
289
290
291
292
293
294
295
296
297
298
@deprecated("Use map_to_awaitable_result_iterable instead")
def map_to_awaitable_result_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableResultTuple[_F, _S]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableResultTupleWrapper[_F, _S]:
    """Deprecated alias for
    [trcks.oop.Wrapper.map_to_awaitable_result_iterable][].
    """
    return self.map_to_awaitable_result_iterable(
        callable_, *args, **kwargs
    )  # pragma: no cover

map_to_awaitable_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.map_to_awaitable_iterable.

Source code in src/trcks/oop/_wrapper.py
300
301
302
303
304
305
306
307
308
309
310
311
@deprecated("Use map_to_awaitable_iterable instead")
def map_to_awaitable_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableTuple[_T]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableTupleWrapper[_T]:
    """Deprecated alias for [trcks.oop.Wrapper.map_to_awaitable_iterable][]."""
    return self.map_to_awaitable_iterable(
        callable_, *args, **kwargs
    )  # pragma: no cover

map_to_iterable(callable_, /, *args, **kwargs)

Apply a function returning an collections.abc.Iterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], Iterable[_T]]) –

    The function to be applied, returning a collections.abc.Iterable.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> from trcks.oop import Wrapper
>>> def duplicate(n: int) -> tuple[int, int]:
...     return n, n
...
>>> Wrapper.construct(3).map_to_iterable(duplicate)
TupleWrapper(core=(3, 3))
Source code in src/trcks/oop/_wrapper.py
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
def map_to_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], Iterable[_T]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> TupleWrapper[_T]:
    """Apply a function returning an [collections.abc.Iterable][]
    to the wrapped object.

    Args:
        callable_: The function to be applied,
            returning a [collections.abc.Iterable][].
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.TupleWrapper][] instance with
            the result of the function application.

    Examples:
        >>> from trcks.oop import Wrapper
        >>> def duplicate(n: int) -> tuple[int, int]:
        ...     return n, n
        ...
        >>> Wrapper.construct(3).map_to_iterable(duplicate)
        TupleWrapper(core=(3, 3))
    """
    return TupleWrapper(i.map_to_iterable(callable_, *args, **kwargs)(self.core))

map_to_result(callable_, /, *args, **kwargs)

Apply a synchronous function with return type trcks.Result to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], Result[_F, _S]]) –

    The synchronous function to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> Wrapper.construct(-1).map_to_result(
...     lambda n: ("success", n)
...     if n >= 0
...     else ("failure", "negative value")
... )
ResultWrapper(core=('failure', 'negative value'))
Source code in src/trcks/oop/_wrapper.py
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
def map_to_result(
    self,
    callable_: Callable[Concatenate[_T_co, _P], Result[_F, _S]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> ResultWrapper[_F, _S]:
    """Apply a synchronous function with return type [trcks.Result][]
    to the wrapped object.

    Args:
        callable_: The synchronous function to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.ResultWrapper][] instance with
            the result of the function application.

    Examples:
        >>> Wrapper.construct(-1).map_to_result(
        ...     lambda n: ("success", n)
        ...     if n >= 0
        ...     else ("failure", "negative value")
        ... )
        ResultWrapper(core=('failure', 'negative value'))
    """
    return ResultWrapper(i.map_to_result(callable_, *args, **kwargs)(self.core))

map_to_result_iterable(callable_, /, *args, **kwargs)

Apply a synchronous function with return type trcks.ResultIterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], ResultIterable[_F, _S]]) –

    The synchronous function to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> from trcks import ResultTuple
>>> Wrapper.construct(-1).map_to_result_iterable(
...     lambda n: ("success", (n, n))
...     if n >= 0
...     else ("failure", "negative value")
... )
ResultTupleWrapper(core=('failure', 'negative value'))
Source code in src/trcks/oop/_wrapper.py
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
def map_to_result_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], ResultIterable[_F, _S]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> ResultTupleWrapper[_F, _S]:
    """Apply a synchronous function with return type [trcks.ResultIterable][]
    to the wrapped object.

    Args:
        callable_: The synchronous function to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.ResultTupleWrapper][] instance with
            the result of the function application.

    Examples:
        >>> from trcks import ResultTuple
        >>> Wrapper.construct(-1).map_to_result_iterable(
        ...     lambda n: ("success", (n, n))
        ...     if n >= 0
        ...     else ("failure", "negative value")
        ... )
        ResultTupleWrapper(core=('failure', 'negative value'))
    """
    return ResultTupleWrapper(
        i.map_to_result_iterable(callable_, *args, **kwargs)(self.core)
    )

map_to_result_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.map_to_result_iterable.

Source code in src/trcks/oop/_wrapper.py
410
411
412
413
414
415
416
417
418
419
420
421
@deprecated("Use map_to_result_iterable instead")
def map_to_result_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], ResultTuple[_F, _S]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> ResultTupleWrapper[_F, _S]:
    """Deprecated alias for [trcks.oop.Wrapper.map_to_result_iterable][]."""
    return self.map_to_result_iterable(
        callable_, *args, **kwargs
    )  # pragma: no cover

map_to_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.map_to_iterable.

Source code in src/trcks/oop/_wrapper.py
423
424
425
426
427
428
429
430
431
432
@deprecated("Use map_to_iterable instead")
def map_to_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], tuple[_T, ...]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> TupleWrapper[_T]:
    """Deprecated alias for [trcks.oop.Wrapper.map_to_iterable][]."""
    return self.map_to_iterable(callable_, *args, **kwargs)  # pragma: no cover

tap(callable_, /, *args, **kwargs)

Apply a synchronous side effect to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], object]) –

    The synchronous side effect to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

  • Wrapper[_T_co] –

    A new trcks.oop.Wrapper instance with the original wrapped object, allowing for further method chaining.

Examples:

>>> wrapper = Wrapper.construct(5).tap(lambda n: print(f"Number: {n}"))
Number: 5
>>> wrapper
Wrapper(core=5)
Source code in src/trcks/oop/_wrapper.py
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
def tap(
    self,
    callable_: Callable[Concatenate[_T_co, _P], object],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> Wrapper[_T_co]:
    """Apply a synchronous side effect to the wrapped object.

    Args:
        callable_: The synchronous side effect to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A new [trcks.oop.Wrapper][] instance with the original wrapped object,
            allowing for further method chaining.

    Examples:
        >>> wrapper = Wrapper.construct(5).tap(lambda n: print(f"Number: {n}"))
        Number: 5
        >>> wrapper
        Wrapper(core=5)
    """
    return self.map(i.tap(callable_, *args, **kwargs))

tap_to_awaitable(callable_, /, *args, **kwargs)

Apply an asynchronous side effect to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], Awaitable[object]]) –

    The asynchronous side effect to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks.oop import Wrapper
>>> async def write_to_disk(s: str) -> None:
...     await asyncio.sleep(0.001)
...     print(f"Wrote '{s}' to disk.")
...
>>> awaitable_wrapper = Wrapper.construct(
...     "Hello, world!"
... ).tap_to_awaitable(write_to_disk)
>>> awaitable_wrapper
AwaitableWrapper(core=<coroutine object ...>)
>>> value = asyncio.run(awaitable_wrapper.core_as_coroutine)
Wrote 'Hello, world!' to disk.
>>> value
'Hello, world!'
Source code in src/trcks/oop/_wrapper.py
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
def tap_to_awaitable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], Awaitable[object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableWrapper[_T_co]:
    """Apply an asynchronous side effect to the wrapped object.

    Args:
        callable_: The asynchronous side effect to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableWrapper][] instance with the original wrapped object.

    Examples:
        >>> import asyncio
        >>> from trcks.oop import Wrapper
        >>> async def write_to_disk(s: str) -> None:
        ...     await asyncio.sleep(0.001)
        ...     print(f"Wrote '{s}' to disk.")
        ...
        >>> awaitable_wrapper = Wrapper.construct(
        ...     "Hello, world!"
        ... ).tap_to_awaitable(write_to_disk)
        >>> awaitable_wrapper
        AwaitableWrapper(core=<coroutine object ...>)
        >>> value = asyncio.run(awaitable_wrapper.core_as_coroutine)
        Wrote 'Hello, world!' to disk.
        >>> value
        'Hello, world!'
    """
    return AwaitableWrapper(
        i.tap_to_awaitable(callable_, *args, **kwargs)(self.core)
    )

tap_to_awaitable_iterable(callable_, /, *args, **kwargs)

Apply an asynchronous side effect returning a trcks.AwaitableIterable to the wrapped object.

Parameters:

Returns:

Examples:

>>> import asyncio
>>> from trcks.oop import Wrapper
>>> async def write_to_disk(n: int) -> tuple[str, str]:
...     await asyncio.sleep(0.001)
...     print(f"Wrote {n} to disk.")
...     return "left", "right"
...
>>> awaitable_tuple_wrapper = Wrapper.construct(
...     3
... ).tap_to_awaitable_iterable(write_to_disk)
>>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
Wrote 3 to disk.
(3, 3)
Source code in src/trcks/oop/_wrapper.py
502
503
504
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
def tap_to_awaitable_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableIterable[object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableTupleWrapper[_T_co]:
    """Apply an asynchronous side effect returning a [trcks.AwaitableIterable][]
    to the wrapped object.

    Args:
        callable_: The asynchronous side effect to be applied,
            returning a [trcks.AwaitableIterable][].
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableTupleWrapper][] instance with
            the original wrapped object repeated once per item returned by the
            side effect.

    Examples:
        >>> import asyncio
        >>> from trcks.oop import Wrapper
        >>> async def write_to_disk(n: int) -> tuple[str, str]:
        ...     await asyncio.sleep(0.001)
        ...     print(f"Wrote {n} to disk.")
        ...     return "left", "right"
        ...
        >>> awaitable_tuple_wrapper = Wrapper.construct(
        ...     3
        ... ).tap_to_awaitable_iterable(write_to_disk)
        >>> asyncio.run(awaitable_tuple_wrapper.core_as_coroutine)
        Wrote 3 to disk.
        (3, 3)
    """
    return AwaitableTupleWrapper(
        i.tap_to_awaitable_iterable(callable_, *args, **kwargs)(self.core)
    )

tap_to_awaitable_result(callable_, /, *args, **kwargs)

Apply an asynchronous side effect with return type trcks.Result to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], AwaitableResult[_F, object]]) –

    The asynchronous side effect to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks import Result
>>> from trcks.oop import Wrapper
>>> async def write_to_disk(s: str, path: str) -> Result[str, None]:
...     if path != "output.txt":
...         return "failure", "write error"
...     await asyncio.sleep(0.001)
...     print(f"Wrote '{s}' to file {path}.")
...     return "success", None
...
>>> awaitable_result_wrapper_1 = Wrapper.construct(
...     "Hello, world!"
... ).tap_to_awaitable_result(
...     lambda s: write_to_disk(s, "destination.txt")
... )
>>> awaitable_result_wrapper_1
AwaitableResultWrapper(core=<coroutine object ...>)
>>> result_1 = asyncio.run(awaitable_result_wrapper_1.core_as_coroutine)
>>> result_1
('failure', 'write error')
>>> awaitable_result_wrapper_2 = Wrapper.construct(
...     "Hello, world!"
... ).tap_to_awaitable_result(
...     lambda s: write_to_disk(s, "output.txt")
... )
>>> awaitable_result_wrapper_2
AwaitableResultWrapper(core=<coroutine object ...>)
>>> result_2 = asyncio.run(awaitable_result_wrapper_2.core_as_coroutine)
Wrote 'Hello, world!' to file output.txt.
>>> result_2
('success', 'Hello, world!')
Source code in src/trcks/oop/_wrapper.py
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
def tap_to_awaitable_result(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableResult[_F, object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableResultWrapper[_F, _T_co]:
    """Apply an asynchronous side effect with return type [trcks.Result][]
    to the wrapped object.

    Args:
        callable_: The asynchronous side effect to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableResultWrapper][] instance with

            - *the returned* [trcks.Failure][]
                if the given side effect returns a [trcks.Failure][] or
            - a [trcks.Success][] instance containing *the original* wrapped object
                if the given side effect returns a [trcks.Success][].

    Examples:
        >>> import asyncio
        >>> from trcks import Result
        >>> from trcks.oop import Wrapper
        >>> async def write_to_disk(s: str, path: str) -> Result[str, None]:
        ...     if path != "output.txt":
        ...         return "failure", "write error"
        ...     await asyncio.sleep(0.001)
        ...     print(f"Wrote '{s}' to file {path}.")
        ...     return "success", None
        ...
        >>> awaitable_result_wrapper_1 = Wrapper.construct(
        ...     "Hello, world!"
        ... ).tap_to_awaitable_result(
        ...     lambda s: write_to_disk(s, "destination.txt")
        ... )
        >>> awaitable_result_wrapper_1
        AwaitableResultWrapper(core=<coroutine object ...>)
        >>> result_1 = asyncio.run(awaitable_result_wrapper_1.core_as_coroutine)
        >>> result_1
        ('failure', 'write error')
        >>> awaitable_result_wrapper_2 = Wrapper.construct(
        ...     "Hello, world!"
        ... ).tap_to_awaitable_result(
        ...     lambda s: write_to_disk(s, "output.txt")
        ... )
        >>> awaitable_result_wrapper_2
        AwaitableResultWrapper(core=<coroutine object ...>)
        >>> result_2 = asyncio.run(awaitable_result_wrapper_2.core_as_coroutine)
        Wrote 'Hello, world!' to file output.txt.
        >>> result_2
        ('success', 'Hello, world!')
    """
    return AwaitableResultWrapper(
        i.tap_to_awaitable_result(callable_, *args, **kwargs)(self.core)
    )

tap_to_awaitable_result_iterable(callable_, /, *args, **kwargs)

Apply an asynchronous side effect with return type trcks.AwaitableResultIterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], AwaitableResultIterable[_F, object]]) –

    The asynchronous side effect to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> import asyncio
>>> from trcks import AwaitableResultTuple
>>> from trcks.oop import Wrapper
>>> async def write_twice(
...     s: str,
... ) -> AwaitableResultTuple[str, None]:
...     await asyncio.sleep(0.001)
...     print(f"Wrote '{s}' twice.")
...     return "success", (None, None)
...
>>> wrapper = Wrapper.construct(
...     "Hello, world!"
... ).tap_to_awaitable_result_iterable(write_twice)
>>> wrapper
AwaitableResultTupleWrapper(core=<coroutine object ...>)
>>> result = asyncio.run(wrapper.core_as_coroutine)
Wrote 'Hello, world!' twice.
>>> result
('success', ('Hello, world!', 'Hello, world!'))
Source code in src/trcks/oop/_wrapper.py
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
def tap_to_awaitable_result_iterable(
    self,
    callable_: Callable[
        Concatenate[_T_co, _P], AwaitableResultIterable[_F, object]
    ],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableResultTupleWrapper[_F, _T_co]:
    """Apply an asynchronous side effect with return type
    [trcks.AwaitableResultIterable][] to the wrapped object.

    Args:
        callable_: The asynchronous side effect to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.AwaitableResultTupleWrapper][] instance with

            - *the returned* [trcks.Failure][]
                if the given side effect returns a [trcks.Failure][] or
            - *the original* wrapped object repeated once per element
                in the side effect output if the given side effect
                returns [trcks.SuccessIterable][].

    Examples:
        >>> import asyncio
        >>> from trcks import AwaitableResultTuple
        >>> from trcks.oop import Wrapper
        >>> async def write_twice(
        ...     s: str,
        ... ) -> AwaitableResultTuple[str, None]:
        ...     await asyncio.sleep(0.001)
        ...     print(f"Wrote '{s}' twice.")
        ...     return "success", (None, None)
        ...
        >>> wrapper = Wrapper.construct(
        ...     "Hello, world!"
        ... ).tap_to_awaitable_result_iterable(write_twice)
        >>> wrapper
        AwaitableResultTupleWrapper(core=<coroutine object ...>)
        >>> result = asyncio.run(wrapper.core_as_coroutine)
        Wrote 'Hello, world!' twice.
        >>> result
        ('success', ('Hello, world!', 'Hello, world!'))
    """
    return AwaitableResultTupleWrapper(
        i.tap_to_awaitable_result_iterable(callable_, *args, **kwargs)(self.core)
    )

tap_to_awaitable_result_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.tap_to_awaitable_result_iterable.

Source code in src/trcks/oop/_wrapper.py
659
660
661
662
663
664
665
666
667
668
669
670
671
672
@deprecated("Use tap_to_awaitable_result_iterable instead")
def tap_to_awaitable_result_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableResultTuple[_F, object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableResultTupleWrapper[_F, _T_co]:
    """Deprecated alias for
    [trcks.oop.Wrapper.tap_to_awaitable_result_iterable][].
    """
    return self.tap_to_awaitable_result_iterable(
        callable_, *args, **kwargs
    )  # pragma: no cover

tap_to_awaitable_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.tap_to_awaitable_iterable.

Source code in src/trcks/oop/_wrapper.py
674
675
676
677
678
679
680
681
682
683
684
685
@deprecated("Use tap_to_awaitable_iterable instead")
def tap_to_awaitable_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], AwaitableTuple[object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> AwaitableTupleWrapper[_T_co]:
    """Deprecated alias for [trcks.oop.Wrapper.tap_to_awaitable_iterable][]."""
    return self.tap_to_awaitable_iterable(
        callable_, *args, **kwargs
    )  # pragma: no cover

tap_to_iterable(callable_, /, *args, **kwargs)

Apply a side effect returning an collections.abc.Iterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], Iterable[object]]) –

    The side effect to be applied, returning an collections.abc.Iterable.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> from trcks.oop import Wrapper
>>> def write_to_disk(n: int) -> tuple[str, str]:
...     print(f"Wrote {n} to disk.")
...     return "left", "right"
...
>>> Wrapper.construct(3).tap_to_iterable(write_to_disk)
Wrote 3 to disk.
TupleWrapper(core=(3, 3))
Source code in src/trcks/oop/_wrapper.py
687
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
717
718
719
def tap_to_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], Iterable[object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> TupleWrapper[_T_co]:
    """Apply a side effect returning an [collections.abc.Iterable][] to the
    wrapped object.

    Args:
        callable_: The side effect to be applied, returning an
            [collections.abc.Iterable][].
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.TupleWrapper][] instance with the original wrapped
            object repeated once per item returned by the side effect.

    Examples:
        >>> from trcks.oop import Wrapper
        >>> def write_to_disk(n: int) -> tuple[str, str]:
        ...     print(f"Wrote {n} to disk.")
        ...     return "left", "right"
        ...
        >>> Wrapper.construct(3).tap_to_iterable(write_to_disk)
        Wrote 3 to disk.
        TupleWrapper(core=(3, 3))
    """
    return TupleWrapper(i.tap_to_iterable(callable_, *args, **kwargs)(self.core))

tap_to_result(callable_, /, *args, **kwargs)

Apply a synchronous side effect with return type trcks.Result to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], Result[_F, object]]) –

    The synchronous side effect to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> from trcks import Result
>>> from trcks.oop import Wrapper
>>> def print_positive_float(x: float) -> Result[str, None]:
...     if x <= 0:
...         return "failure", "not positive"
...     return "success", print(f"Positive float: {x}")
...
>>> result_wrapper_1 = Wrapper.construct(-2.3).tap_to_result(
...     print_positive_float
... )
>>> result_wrapper_1
ResultWrapper(core=('failure', 'not positive'))
>>> result_wrapper_2 = Wrapper.construct(3.5).tap_to_result(
...     print_positive_float
... )
Positive float: 3.5
>>> result_wrapper_2
ResultWrapper(core=('success', 3.5))
Source code in src/trcks/oop/_wrapper.py
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
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
def tap_to_result(
    self,
    callable_: Callable[Concatenate[_T_co, _P], Result[_F, object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> ResultWrapper[_F, _T_co]:
    """Apply a synchronous side effect with return type [trcks.Result][]
    to the wrapped object.

    Args:
        callable_: The synchronous side effect to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.ResultWrapper][] instance with

            - *the returned* [trcks.Failure][]
                if the given side effect returns a [trcks.Failure][] or
            - a [trcks.Success][] instance containing *the original* wrapped object
                if the given side effect returns a [trcks.Success][].

    Examples:
        >>> from trcks import Result
        >>> from trcks.oop import Wrapper
        >>> def print_positive_float(x: float) -> Result[str, None]:
        ...     if x <= 0:
        ...         return "failure", "not positive"
        ...     return "success", print(f"Positive float: {x}")
        ...
        >>> result_wrapper_1 = Wrapper.construct(-2.3).tap_to_result(
        ...     print_positive_float
        ... )
        >>> result_wrapper_1
        ResultWrapper(core=('failure', 'not positive'))
        >>> result_wrapper_2 = Wrapper.construct(3.5).tap_to_result(
        ...     print_positive_float
        ... )
        Positive float: 3.5
        >>> result_wrapper_2
        ResultWrapper(core=('success', 3.5))
    """
    return ResultWrapper(i.tap_to_result(callable_, *args, **kwargs)(self.core))

tap_to_result_iterable(callable_, /, *args, **kwargs)

Apply a synchronous side effect with return type trcks.ResultIterable to the wrapped object.

Parameters:

  • callable_ (Callable[Concatenate[_T_co, _P], ResultIterable[_F, object]]) –

    The synchronous side effect to be applied.

  • *args (args, default: () ) –

    Positional arguments to be passed to callable_.

  • **kwargs (kwargs, default: {} ) –

    Keyword arguments to be passed to callable_.

Returns:

Examples:

>>> from trcks import ResultTuple
>>> from trcks.oop import Wrapper
>>> def print_positive_float(x: float) -> ResultTuple[str, None]:
...     if x <= 0:
...         return "failure", "not positive"
...     return (
...         "success",
...         (print(f"Positive float: {x}"), print(f"Positive float: {x}"))
...     )
>>> result_tuple_wrapper_1 = Wrapper.construct(
...     -2.3
... ).tap_to_result_iterable(print_positive_float)
>>> result_tuple_wrapper_1
ResultTupleWrapper(core=('failure', 'not positive'))
>>> result_tuple_wrapper_2 = Wrapper.construct(
...     3.5
... ).tap_to_result_iterable(print_positive_float)
Positive float: 3.5
Positive float: 3.5
>>> result_tuple_wrapper_2
ResultTupleWrapper(core=('success', (3.5, 3.5)))
Source code in src/trcks/oop/_wrapper.py
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
def tap_to_result_iterable(
    self,
    callable_: Callable[Concatenate[_T_co, _P], ResultIterable[_F, object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> ResultTupleWrapper[_F, _T_co]:
    """Apply a synchronous side effect with return type [trcks.ResultIterable][]
    to the wrapped object.

    Args:
        callable_: The synchronous side effect to be applied.
        *args:
            Positional arguments to be passed to `callable_`.
        **kwargs:
            Keyword arguments to be passed to `callable_`.

    Returns:
        A [trcks.oop.ResultTupleWrapper][] instance with

            - *the returned* [trcks.Failure][]
                if the given side effect returns a [trcks.Failure][] or
            - *the original* [trcks.SuccessIterable][] element repeated once
                per element in the side effect output if the given side effect
                returns [trcks.SuccessIterable][].

    Examples:
        >>> from trcks import ResultTuple
        >>> from trcks.oop import Wrapper
        >>> def print_positive_float(x: float) -> ResultTuple[str, None]:
        ...     if x <= 0:
        ...         return "failure", "not positive"
        ...     return (
        ...         "success",
        ...         (print(f"Positive float: {x}"), print(f"Positive float: {x}"))
        ...     )
        >>> result_tuple_wrapper_1 = Wrapper.construct(
        ...     -2.3
        ... ).tap_to_result_iterable(print_positive_float)
        >>> result_tuple_wrapper_1
        ResultTupleWrapper(core=('failure', 'not positive'))
        >>> result_tuple_wrapper_2 = Wrapper.construct(
        ...     3.5
        ... ).tap_to_result_iterable(print_positive_float)
        Positive float: 3.5
        Positive float: 3.5
        >>> result_tuple_wrapper_2
        ResultTupleWrapper(core=('success', (3.5, 3.5)))
    """
    return ResultTupleWrapper(
        i.tap_to_result_iterable(callable_, *args, **kwargs)(self.core)
    )

tap_to_result_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.tap_to_result_iterable.

Source code in src/trcks/oop/_wrapper.py
821
822
823
824
825
826
827
828
829
830
831
832
@deprecated("Use tap_to_result_iterable instead")
def tap_to_result_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], ResultTuple[_F, object]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> ResultTupleWrapper[_F, _T_co]:
    """Deprecated alias for [trcks.oop.Wrapper.tap_to_result_iterable][]."""
    return self.tap_to_result_iterable(
        callable_, *args, **kwargs
    )  # pragma: no cover

tap_to_tuple(callable_, /, *args, **kwargs)

Deprecated alias for trcks.oop.Wrapper.tap_to_iterable.

Source code in src/trcks/oop/_wrapper.py
834
835
836
837
838
839
840
841
842
843
@deprecated("Use tap_to_iterable instead")
def tap_to_tuple(
    self,
    callable_: Callable[Concatenate[_T_co, _P], tuple[object, ...]],
    /,
    *args: _P.args,
    **kwargs: _P.kwargs,
) -> TupleWrapper[_T_co]:
    """Deprecated alias for [trcks.oop.Wrapper.tap_to_iterable][]."""
    return self.tap_to_iterable(callable_, *args, **kwargs)  # pragma: no cover