Skip to content

Typing helpers

pykka.typing

Type hint helpers.

ActorMemberMixin

Mixin class for typing Actor methods which are accessible via proxy instances.

Version added: Pykka 4.0

Source code in src/pykka/typing.py 
63
64
65
66
67
68
69
70
71
72
73
74
class ActorMemberMixin:
    """Mixin class for typing Actor methods which are accessible via proxy instances.

    /// note | Version added: Pykka 4.0
    ///
    """

    stop = proxy_method(Actor.stop)
    on_start = proxy_method(Actor.on_start)
    on_stop = proxy_method(Actor.on_stop)
    on_failure = proxy_method(Actor.on_failure)
    on_receive = proxy_method(Actor.on_receive)

proxy_field 

proxy_field(field: T) -> Future[T]

Type a field on an actor proxy.

Version added: Pykka 4.0

Source code in src/pykka/typing.py 
43
44
45
46
47
48
49
def proxy_field(field: T) -> Future[T]:
    """Type a field on an actor proxy.

    /// note | Version added: Pykka 4.0
    ///
    """
    return field  # type: ignore[return-value]

proxy_method 

proxy_method(
    field: Callable[Concatenate[Any, P], T],
) -> Method[P, Future[T]]

Type a method on an actor proxy.

Version added: Pykka 4.0

Source code in src/pykka/typing.py 
52
53
54
55
56
57
58
59
60
def proxy_method(
    field: Callable[Concatenate[Any, P], T],
) -> Method[P, Future[T]]:
    """Type a method on an actor proxy.

    /// note | Version added: Pykka 4.0
    ///
    """
    return field  # type: ignore[return-value]