Skip to content

adding shutting_down parameter to update() to signal when is the last… #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

adding shutting_down parameter to update() to signal when is the last… #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions pyzmp/node.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,10 +319,11 @@ def withholds(self, service_name):
# Careful : this is NOT the same usage as "run()" from Process :
# it is called inside a loop that it does not directly control...
# TOOD : think about it and improve (Entity System integration ? Pool + Futures integration ?)
def update(self, *args, **kwargs):
def update(self, shutting_down, *args, **kwargs):
"""
Runs at every update cycle in the node process/thread.
Usually you want to override this method to extend the behavior of the node in your implementation
:param shutting_down will be True when it will be the last update call. This allows update function to do some cleanup.
:return: integer as exitcode to stop the node, or None to keep looping...
"""
# TODO : Check which way is better (can also be used to run external process, other functions, like Process)
Expand Down Expand Up @@ -350,7 +351,7 @@ def run(self, *args, **kwargs):
A children class can override this method, but it needs to call super().run(*args, **kwargs)
for the node to start properly and call update() as expected.
:param args: arguments to pass to update()
:param kwargs: eyword arguments to pass to update()
:param kwargs: keyword arguments to pass to update()
:return: last exitcode returned by update()
"""
# TODO : make use of the arguments ? since run is now the target for Process...
Expand Down Expand Up @@ -434,6 +435,8 @@ def run(self, *args, **kwargs):
if self._target:
# bwcompat
kwargs['timedelta'] = timedelta
# adding cleanup on shutdown capabilities
kwargs['shutting_down'] = False

# TODO : use return code to determine when/how we need to run this the next time...
# Also we need to keep the exit status to be able to call external process as an update...
Expand All @@ -453,7 +456,18 @@ def run(self, *args, **kwargs):
# in the not so special case where we started, we didnt get exit code and we exited,
# this is expected as a normal result and we set an exitcode here of 0
# As 0 is the conventional success for unix process successful run
exitstatus = 0

# adding cleanup on shutdown capabilities
kwargs['shutting_down'] = True

logging.debug(
"[{self.name}] FINAL call {self._target.__name__} with args {args} and kwargs {kwargs}.".format(
**locals()))
exitstatus = self._target(*args, **kwargs)
# Note this exit status will be ignored by python process anyway.
# But the user might want to have different behavior on it depending on the target here.
# The target can be a python function, also can be a shell script, or something else...
# => Where is the best place for this usecase ?

logging.debug("[{self.name}] Node stopped.".format(**locals()))
return exitstatus # returning last exit status from the update function
Expand Down