python: Add typing to RPC server and Messenger #4639
Merged
+223
−181
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
…hey would be released when unlocked (RuntimeError: release unlocked lock)
… c_library_server
…it is a multiprocessing.Connection object obtained from multiprocessing.Pipe
…Connection object obtained from multiprocessing.Pipe
…connection.Connection object obtained from multiprocessing.Pipe
… message_server()
…the variable is used
github-actions
bot
added
Python
ninsbl
approved these changes
Nov 2, 2024
Merged
a0x8o
pushed a commit
to a0x8o/grass
that referenced
this pull request
Nov 11, 2024
* grass.pygrass.rpc.base: Add typing annotations for lock and conn * grass.pygrass.rpc.base: Use context manager for lock in dummy_server * grass.pygrass.rpc.base: Use context manager for threadLock in RPCServerBase * grass.pygrass.rpc.base: Remove release lock in context manager * grass.pygrass.rpc.base: Add more typing annotations * grass.pygrass.rpc.base: Check for None to satisfy mypy type checking * grass.pygrass.rpc.base: Remove release lock in context managers, as they would be released when unlocked (RuntimeError: release unlocked lock) * grass.pygrass.rpc.base: Sort imports * grass.temporal.c_libraries_interface: Use context manager for lock in c_library_server * grass.temporal.c_libraries_interface: Add typing annotations for lock and conn * grass.pygrass.rpc.base: Change date of file header * grass.pygrass.rpc.base: Update docs of conn argument to mention that it is a multiprocessing.Connection object obtained from multiprocessing.Pipe * grass.temporal.c_libraries_interface: Change date of file header * grass.pygrass.rpc: Sort imports * grass.temporal.c_libraries_interface: Sort imports * Update docs of conn argument to mention that it is a multiprocessing.Connection object obtained from multiprocessing.Pipe * grass.pygrass.messages: Sort imports * Update docs of conn argument to mention that it is a multiprocessing.connection.Connection object obtained from multiprocessing.Pipe * grass.pygrass.rpc: Use context manager to acquire and release the lock * Fix typo in python/grass/pygrass/messages/testsuite/test_pygrass_messages_doctests.py * grass.pygrass.messages: Fix typo in message_server * grass.pygrass.messages: Missing "IMPORTANT" message type in message_server * grass.pygrass.messages: Add return type to get_msgr * grass.pygrass.messages: Add types to signatures in Messenger class and rest of file * grass.pygrass.messages: Use context manager for acquiring the lock in message_server() * grass.pygrass.messages: Add types to message_types to track missing conditions * grass.pygrass.messages: Extract message only for message_types where the variable is used * grass.pygrass.messages: Add parameter descriptions to percent(self, n, d, s) * grass.pygrass.messages: Initialize Messenger fields without setting them to None * grass.pygrass.messages: Fix typo * grass.pygrass.messages: Change date of file header
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 common denominator here were all places that used connection objects from
multiprocessing.Pipe. The documentation comment was wrong, as it isn't the pipe that is used, but one of the two Connection objects.For the
multiprocessing.Lockobjects used, theacquire()andrelease()were changed to use a context manager, making sure (to the extents possible) that the resource is released even on errors. This was tested more than a month ago, in the same work where for the PR that did some profiling and benchmarking with hyperfine. (I was trying alternatives to this kind of RPC server, but I wasn't satisfied with what I got). However, the context manager and locks are a good practice that is valuable to include.While I did try to completely type the messages class and file, I reverted it as it wasn't that much clearer, only correctly understood with very new Python syntax, and changed lists to tuples. Nevertheless, type checking of the possible data received highlighted the fact that the docs (which I wrote the typing from) didn't include the "INFORMATION" level, as it was "unused". That is what is nice when type checking and using
Literal[]for expected values. So the docstring is updated in consequence.