PyO3でPythonのObjectのReferenceを格納したい

Question

RustのStructにPythonのObjectのReferenceを格納したいです。

以下に簡略化したコードで書きました。ただし、PyObjRef, to_py_ref, to_py_objは実際には存在しないメソッド・ストラクトです。名前からこのような機能を有しているのを推測してもらう為に書きました。

#[pyclass]
pub struct PythonStore {
    // store python object reference
    obj: Vec<PyObjRef>,
}

#[pymethods]
impl PythonStore {
    #[new]
    fn new() -> Self {
        PythonStore {obj: Vec::new()}
    }

    // push python object reference to vec
    fn push(&mut self, obj: &PyAny) {
        self.obj.push(obj.to_py_ref());
    }

    // return last inserted object
    fn get(&mut self, py: Python) -> PyObject {
        match self.obj.pop() {
            Some(obj) => obj.to_py_obj(py),
            None => py.None(),
        }
    }
}

PyO3内でObjectの操作は考えていません、内部に格納し搬出するだけです。ただPyO3のサイトを見てみましたがやり方がわかりませんでした。
何かわかる方は回答の方をよろしくお願いします。

Answer 1

#[pyclass]
struct PythonStore {
    // store python object reference
    obj: Vec<PyObject>,
}

#[pymethods]
impl PythonStore {
    #[new]
    fn new() -> Self {
        PythonStore { obj: Vec::new() }
    }

    // push python object reference to vec
    fn push(&mut self, py: Python, obj: &PyAny) {
        self.obj.push(obj.to_object(py));
    }

    // return last inserted object
    fn get(&mut self, py: Python) -> PyObject {
        match self.obj.pop() {
            Some(obj) => obj,
            None => py.None(),
        }
    }
}

これでできます。
&'py PyAnyから「ライフタイムを消した」ものがPyObjectだと思ってもらえればいいです。

同様に &'py PyDict等については Py<PyDict> などが「ライフタイムを消した」型に相当します。
詳細はObject typesなどを参照してください。

Comments

[namuyan]

回答ありがとうございます。
ただ参照カウントについて疑問が生じました。上記の`get()`であればRustの手から離れてPythonに移るので問題はなさそうです。`to_object`により参照カウントが１増えるのはわかるのですが、`PythonStore`オブジェクトをdelした時、参照カウントが減らずメモリリークが生じませんか？

[kngwyu]

基本的には`PyObject`はdropした後に「GILGuardがdropしたら参照カウントが減る」ようなフックを仕込むので問題ないですが、この場合はメモリリークするバグがあるかもしれません。
修正できたら ~またコメントします~ githubでmentionします