Teknik berbagi data yang dapat diubah antara Rust dan Python dengan PyO3

Kesimpulan (Conclusion)

Ketidakmampuan PyO3 untuk langsung mengekspos struct yang menggunakan lifetime Rust ke Python mungkin pada awalnya terlihat seperti keterbatasan. Namun, pustaka standar Rust dan PyO3 menyediakan alat-alat yang kuat untuk mengatasi keterbatasan ini. std::mem::take dan std::mem::replace memungkinkan penanganan referensi yang dapat diubah (mutable reference) dan nilai yang dimiliki (owned value) dengan terampil, sementara Arc dan Mutex sangat berguna untuk mengekspos data bersama yang dapat diubah ke Python. Secara khusus, MutexExt dari PyO3 adalah alat penting untuk mencegah deadlock saat menggunakan mutex bersama Python.

---

Ringkasan poin utama

Dokumen ini menjelaskan langkah demi langkah masalah teknis yang ditemui dan proses penyelesaiannya saat berbagi data yang dapat diubah (mutable) antara Rust dan Python dalam proyek yang mengimplementasikan ulang bahasa template Django ke Rust.

• Latar belakang: Bahasa template Django menggunakan objek bernama context untuk menyediakan data dinamis ke template. Dalam implementasi Rust pada proyek ini, context didefinisikan sebagai struct Rust, dan harus diteruskan sebagai referensi yang dapat diubah (&mut Context) saat merender tag template.

• Masalah awal: Referensi yang dapat diubah (&mut Context) dari kode Rust perlu diteruskan ke fungsi Python untuk menjalankan custom tag. Namun, Python tidak memahami lifetime Rust, dan PyO3, pustaka integrasi Rust-Python, memerlukan nilai yang dimiliki (owned value), sehingga meneruskan referensi secara langsung akan memicu error kompilasi.

• Proses penyelesaian:

  1. Menyelesaikan masalah kepemilikan: Menggunakan std::mem::take untuk sementara mengambil kepemilikan dari &mut Context dan membuat objek Context yang dimiliki sehingga bisa diteruskan ke Python. Setelah kode Python dijalankan, dilakukan percobaan untuk mengembalikan Context yang telah diproses ke posisi referensi asal dengan std::mem::replace.
  2. Menyelesaikan error 'Moved Value': Namun dalam proses ini, saat mencoba menggunakan kembali objek Context setelah dipindahkan (move) ke fungsi Python, muncul error kompilasi "use of moved value". Untuk mengatasinya, diperkenalkan Arc (Atomic Reference Count) untuk membungkus Context. Dengan cara ini, referensi hasil salinan (clone) dapat diteruskan ke Python tanpa memindahkan kepemilikan.
  3. Menangani saat Python mempertahankan referensi: Jika Python terus mempertahankan referensi ke Context, pemulihan kepemilikan melalui Arc::try_unwrap bisa gagal. Dalam kasus ini, data Context diduplikasi dengan mengimplementasikan metode fallback seperti clone_ref yang melakukan deep clone pada data internal.
  4. Mengizinkan perubahan data dari Python: Pada akhirnya, agar kode Python tidak hanya membaca Context tetapi juga bisa mengubahnya, diperkenalkan Mutex. Dengan menggunakan struktur Arc<Mutex<Context>>, akses dan modifikasi data dijamin aman di banyak thread. Pada saat ini, untuk mencegah deadlock dengan interpreter Python, digunakan metode lock_py_attached dari MutexExt yang disediakan PyO3.