feat: Add RemainingTime option for timeout argument of Actor.call and Actor.start
#473
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pijukatel
added
enhancement
github-actions
bot
added
the
tested
Pijukatel
requested review from
janbuchar and
vdusek
and removed request for
vdusek
janbuchar
reviewed
May 19, 2025
src/apify/_actor.py
Outdated
| if self.is_at_home() and self.configuration.timeout_at: | ||
| return self.configuration.timeout_at - datetime.now(tz=timezone.utc) | ||
|
|
||
| self.log.warning('Using `RemainingTime` argument for timeout outside of the Apify platform. Returning `None`') |
There was a problem hiding this comment.
Could this be printed out if self.is_at_home() is True, but self.configuration.timeout_at is None? I assume that this is unlikely, but still.
There was a problem hiding this comment.
Expanded the warning
janbuchar
reviewed
May 19, 2025
| async with Actor: | ||
| actor_input = (await Actor.get_input()) or {} | ||
| if actor_input.get('called_from_another_actor', False) is True: | ||
| return |
There was a problem hiding this comment.
So the Actor finishes immediately and you just check that the timeout was configured correctly? I agree that it's fine to trust the platform. Could you add a comment here that explains that?
There was a problem hiding this comment.
Added more comments
vdusek
reviewed
May 19, 2025
Co-authored-by: Vlada Dusek <v.dusek96@gmail.com>
Pijukatel
force-pushed
the
remaining-timeout
branch
from
30ad913 to
31da56f
Compare
Pijukatel
force-pushed
the
remaining-timeout
branch
from
31da56f to
05eed5f
Compare
janbuchar
approved these changes
May 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added convenient way to start another Actor with reasonable timeout to prevent lingering actor runs after main actor shuts down.
Added test.
RemainingTimevalue of the timeout argument is not a default one and has to be explicitly passed by the user. Using this value will calculate remaining time of this actor run and pass it as a timeout to the actor that is being started.Issues
RemainingTimeoption forActor.startandActor.call#472