`multiprocessing.managers.BaseProxy` can not be unpickled when using a custom `authkey`
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 35.9k
- PR 合併指標
- PR 指標待擷取
描述
Bug report
Bug description:
The problem, simplified
When using a Manager with a custom authkey, a pickled proxy object can not be unpickled:
from multiprocessing.managers import BaseManager, BaseProxy
class MyManager(BaseManager):
pass
class MyObject:
def __init__(self):
self.value = 42
def get_value(self):
return self.value
def set_value(self, new_value):
self.value = new_value
class MyProxy(BaseProxy):
_exposed_ = ("get_value", "set_value")
def get_value(self):
return self._callmethod("get_value")
def set_value(self, new_value):
return self._callmethod("set_value", (new_value,))
_my_object = MyObject()
def _get_my_object():
return _my_object
def test_proxy_unpickle():
MyManager.register("get_my_object", callable=_get_my_object, proxytype=MyProxy)
manager = MyManager(
address=("", 0),
authkey=b"customkey", # <--- CUSTOM AUTHKEY
)
manager.start()
proxy_object = manager.get_my_object()
assert isinstance(proxy_object, MyProxy)
assert proxy_object.get_value() == 42
# We simulate pickling...
rebuild_proxy, args = proxy_object.__reduce__()
# ... and unpickling in a child process
# Fails with: multiprocessing.context.AuthenticationError: digest sent was rejected
rebuild_proxy(*args)
(It works when no custom authkey is passed to MyManager.)
This is because When a proxy is pickled the authkey is deliberately dropped. Accordingly, BaseProxy.__init__ uses process.current_process().authkey and fails to connect to the manager.
Actually, there is one condition where an authkey is passed:
class BaseProxy:
def __reduce__(self):
kwds = {}
if get_spawning_popen() is not None:
kwds['authkey'] = self._authkey
(So only while spawning a new process, but not at any other time later.)
This makes me wonder why the authkey parameter of BaseManager was introduced at all if it does not work in all cases but the default process.current_process().authkey does...
The documentation says:
An important feature of proxy objects is that they are picklable so they can be passed between processes.
As shown above, this is not unconditionally true. I have the feeling that the implementation can not be changed, so I would suggest to make the documentation more precise.
The context
I'm using dask_jobqueue.SLURMCluster to start worker processes on a distributed system. I want to use a multiprocessing Manager to enable communication between the main process and it's workers for progress reporting. (I already have it running for "regular" multiprocessing and I'm hesitant to switch to another means of IPC just because of this problem...)
I see two ways how I could make this work:
- Do
multiprocessing.process.current_process().authkey = b"customkey"during the initialization of the Dask worker. - Override
BaseProxy.__reduce__to unconditionally setkwds['authkey'] = bytes(self._authkey).
In both cases, I potentially expose authkey to the outside world... Any advice?
CPython versions tested on:
3.13
Operating systems tested on:
Linux
Linked PRs
- gh-144311
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 multiprocessing.managers.BaseProxy.reduce 和 BaseProxy.init 開始,使用 issue 中的重現來追蹤 proxy 反序列化期間如何處理自訂 authkey。檢閱 proxy 物件文件和連結的 PR gh-144311;當文件描述的行為與使用自訂 authkey 的重現結果一致時,即視為完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- distributed-systems
- Issue 類型
- 缺陷
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100