fix: correct typing on signal handler #664
Merged
Conversation
This file contains 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
Bogdanp
requested changes
Nov 13, 2024
dramatiq/cli.py
Outdated
| except OSError: # pragma: no cover | ||
| if proc.exitcode is None: | ||
| logger.warning("Failed to send %r to PID %d.", signum.name, proc.pid) | ||
| logger.warning(f"Failed to send {signum.name} to PID {proc.pid}.") |
There was a problem hiding this comment.
I would prefer to keep the format strings as they were since f-strings format eagerly, but loggers format lazily.
There was a problem hiding this comment.
The linter should reject that anyway with W1203.
dramatiq/cli.py
Outdated
| reload_process = signum == getattr(signal, "SIGHUP", None) | ||
| if signum == signal.SIGINT: | ||
| signum = signal.SIGTERM | ||
|
|
||
| logger.info("Sending signal %r to subprocesses...", getattr(signum, "name", signum)) | ||
| logger.info(f"Sending signal {signum.name} to subprocesses...") |
the `signum` received in the signal handler is an `int`, not a `Signals`
object. this leads to errors like so:
```
[2024-11-12 16:49:05,288] [PID 151] [MainThread] [dramatiq.ForkProcess(0)] [INFO] Stopping fork process...
res = self._popen.wait(timeout)
File "/usr/local/lib/python3.10/multiprocessing/popen_fork.py", line 43, in wait
return self.poll(os.WNOHANG if timeout == 0.0 else 0)
File "/usr/local/lib/python3.10/multiprocessing/popen_fork.py", line 27, in poll
pid, sts = os.waitpid(self.pid, flag)
File "/usr/local/lib/python3.10/site-packages/dramatiq/cli.py", line 579, in sighandler
logger.info("Sending signal %r to subprocesses...", getattr(signum, "name", signum))
File "/usr/local/lib/python3.10/logging/__init__.py", line 1477, in info
self._log(INFO, msg, args, **kwargs)
File "/usr/local/lib/python3.10/logging/__init__.py", line 1624, in _log
self.handle(record)
File "/usr/local/lib/python3.10/logging/__init__.py", line 1634, in handle
self.callHandlers(record)
File "/usr/local/lib/python3.10/logging/__init__.py", line 1696, in callHandlers
hdlr.handle(record)
File "/usr/local/lib/python3.10/logging/__init__.py", line 966, in handle
self.acquire()
File "/usr/local/lib/python3.10/logging/__init__.py", line 917, in acquire
self.lock.acquire()
File "/usr/local/lib/python3.10/site-packages/dramatiq/cli.py", line 580, in sighandler
stop_subprocesses(signum)
File "/usr/local/lib/python3.10/site-packages/dramatiq/cli.py", line 571, in stop_subprocesses
logger.warning("Failed to send %r to PID %d.", signum.name, proc.pid)
AttributeError: 'int' object has no attribute 'name'
```
here, we correctly type the signal handler functions, and also convert
the `int` to a `Signals` for consistency
|
addressed |
|
Forgot to say thanks. So, thanks! |
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.
the
signumreceived in the signal handler is anint, not aSignalsobject. this leads to errors like so:here, we correctly type the signal handler functions, and also convert the
intto aSignalsfor consistency