optional signal_shutdown argument to Worker.run#1629
Open
DawidBudzynsky wants to merge 1 commit into
Open
Conversation
|
Dawid Budzyński seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
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
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.
What was changed
Added an optional, keyword-only
signal_shutdownargument toWorker.run:When set, the listed OS signals initiate the same graceful shutdown as calling
Worker.shutdown(). Handlers are installed for the duration of therun()call and removed on exit (including whenrun()exits via a fatal worker error).Implementation notes:
loop.add_signal_handlerwhere available; the handler sets the existing internal_shutdown_event, i.e. the exact same triggershutdown()uses.signal.signalon platforms whereadd_signal_handleris unsupported (e.g. Windows), scheduling the shutdown vialoop.call_soon_threadsafeso a blocked event loop is still woken.Noneprevious handler (whichsignal.signalwould otherwise reject).signal_shutdownargument (or an empty sequence), no handlers are installed.Why?
Workers commonly run in containers/orchestrators (Kubernetes, systemd, etc.) that signal
SIGTERM/SIGINTto request shutdown. Previously, translating those signals into a gracefulWorker.shutdown()was left entirely to the caller's own boilerplate. This makes the common case a one-line opt-in while keeping the explicitshutdown()path fully working and the default behavior untouched.Checklist
Added 7 tests in
tests/worker/test_worker.py(all passing locally against adev server):
run()returns cleanlyrun()returnsshutdown()still works whensignal_shutdownis registeredrun()exits via a fatal worker errorThe new argument is documented in the
Worker.rundocstring, and a entry was added toCHANGELOG.md. Nodocs.temporal.io changes required.