Document and add utilities for taking ownership of returned proxies #502
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
When passing proxies to and from tasks executed on remote processes (e.g., via
ProcessPoolExecutor, Parsl, Dask, etc.), returning anOwnedProxyfrom the task may not have the intended effect. Intuitively, you might think that this yields ownership from the invoked task that's creating theOwnedProxyto the client which is receiving the result of the task. However, when the invoked task's result gets serialized and then goes out of scope, the destructor of theOwnedProxywill evict the associated data. That means that when the client receives theOwnedProxy, it is now invalid.The workaround is to return a
Proxy, and then convert it to anOwnedProxyviainto_owned()on the client side. This PR adds this helper function and documents this edge case insubmit().Fixes N/A
Type of Change
Testing
Added new tests.
Pull Request Checklist
Please confirm the PR meets the following requirements.
pre-commit(e.g., mypy, ruff, etc.).