Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 0 additions & 42 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 15 additions & 1 deletion src/apify/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@

from apify_shared.consts import WebhookEventType
from crawlee import Request
from crawlee.events._types import Event
from crawlee.events import (
Event,
EventAbortingData,
EventExitData,
EventListener,
EventMigratingData,
EventPersistStateData,
EventSystemInfoData,
)

from apify._actor import Actor
from apify._configuration import Configuration
Expand All @@ -15,6 +23,12 @@
'Actor',
'Configuration',
'Event',
'EventAbortingData',
'EventExitData',
'EventListener',
'EventMigratingData',
'EventPersistStateData',
'EventSystemInfoData',
'ProxyConfiguration',
'ProxyInfo',
'Request',
Expand Down
50 changes: 47 additions & 3 deletions src/apify/_actor.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import os
import sys
from datetime import timedelta
from typing import TYPE_CHECKING, Any, Callable, TypeVar, cast
from typing import TYPE_CHECKING, Any, Callable, Literal, TypeVar, cast, overload

from lazy_object_proxy import Proxy
from more_itertools import flatten
Expand All @@ -14,7 +14,15 @@
from apify_shared.consts import ActorEnvVars, ActorExitCodes, ApifyEnvVars
from apify_shared.utils import ignore_docs, maybe_extract_enum_member_value
from crawlee import service_locator
from crawlee.events._types import Event, EventMigratingData, EventPersistStateData
from crawlee.events import (
Event,
EventAbortingData,
EventExitData,
EventListener,
EventMigratingData,
EventPersistStateData,
EventSystemInfoData,
)

from apify._configuration import Configuration
from apify._consts import EVENT_LISTENERS_TIMEOUT
Expand Down Expand Up @@ -498,7 +506,30 @@ async def set_value(
key_value_store = await self.open_key_value_store()
return await key_value_store.set_value(key, value, content_type=content_type)

def on(self, event_name: Event, listener: Callable) -> Callable:
@overload
def on(
self, event_name: Literal[Event.PERSIST_STATE], listener: EventListener[EventPersistStateData]
) -> EventListener[EventPersistStateData]: ...
@overload
def on(
self, event_name: Literal[Event.SYSTEM_INFO], listener: EventListener[EventSystemInfoData]
) -> EventListener[EventSystemInfoData]: ...
@overload
def on(
self, event_name: Literal[Event.MIGRATING], listener: EventListener[EventMigratingData]
) -> EventListener[EventMigratingData]: ...
@overload
def on(
self, event_name: Literal[Event.ABORTING], listener: EventListener[EventAbortingData]
) -> EventListener[EventAbortingData]: ...
@overload
def on(
self, event_name: Literal[Event.EXIT], listener: EventListener[EventExitData]
) -> EventListener[EventExitData]: ...
@overload
def on(self, event_name: Event, listener: EventListener[None]) -> EventListener[Any]: ...

def on(self, event_name: Event, listener: EventListener[Any]) -> EventListener[Any]:
"""Add an event listener to the Actor's event manager.

The following events can be emitted:
Expand Down Expand Up @@ -527,6 +558,19 @@ def on(self, event_name: Event, listener: Callable) -> Callable:
self._event_manager.on(event=event_name, listener=listener)
return listener

@overload
def off(self, event_name: Literal[Event.PERSIST_STATE], listener: EventListener[EventPersistStateData]) -> None: ...
@overload
def off(self, event_name: Literal[Event.SYSTEM_INFO], listener: EventListener[EventSystemInfoData]) -> None: ...
@overload
def off(self, event_name: Literal[Event.MIGRATING], listener: EventListener[EventMigratingData]) -> None: ...
@overload
def off(self, event_name: Literal[Event.ABORTING], listener: EventListener[EventAbortingData]) -> None: ...
@overload
def off(self, event_name: Literal[Event.EXIT], listener: EventListener[EventExitData]) -> None: ...
@overload
def off(self, event_name: Event, listener: EventListener[None]) -> None: ...

def off(self, event_name: Event, listener: Callable | None = None) -> None:
"""Remove a listener, or all listeners, from an Actor event.

Expand Down
Loading