Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
run Command",id:"run-command",level:2},{value:"start command",id:"start-command",level:2},{value:"Overwrite an environment",id:"overwrite-an-environment",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"virtual-environment",children:"Virtual Environment"}),"\n",(0,r.jsxs)(n.h2,{id:"run-command",children:[(0,r.jsx)(n.code,{children:"run"})," Command"]}),"\n",(0,r.jsx)(n.p,{children:"When using dora with the run command, all python environment will be handled by the current environment."}),"\n",(0,r.jsx)(n.p,{children:"You should activate the right env before running dora."}),"\n",(0,r.jsx)(n.p,{children:"You can make sure"}),"\n",(0,r.jsxs)(n.h2,{id:"start-command",children:[(0,r.jsx)(n.code,{children:"start"})," command"]}),"\n",(0,r.jsx)(n.p,{children:"When using dora start, you have to make sure that the daemon is running within the right environement."}),"\n",(0,r.jsxs)(n.p,{children:["It is the one that is handled within the ",(0,r.jsx)(n.code,{children:"dora up"})," command."]}),"\n",(0,r.jsxs)(n.p,{children:["In case of confusion, you can use ",(0,r.jsx)(n.code,{children:"dora destroy && dora up"})," in the env, you want to be."]}),"\n",(0,r.jsx)(n.h2,{id:"overwrite-an-environment",children:"Overwrite an environment"}),"\n",(0,r.jsx)(n.p,{children:"You can overwrite an environment using, the following tricks:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Using predefined python"}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- id: dora-vad\n path: ../.venv/bin/python\n args: my_script.py\n"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Using shell"}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- id: dora-vad\n path: shell\n args: conda activate base && python my_script.py\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>d});var r=t(96540);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdora_rs_github_io=self.webpackChunkdora_rs_github_io||[]).push([[6638],{60243:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>d,toc:()=>l});var r=t(74848),i=t(28453);const o={},s="Virtual Environment",d={id:"guides/Development/virtual-environment",title:"Virtual Environment",description:"run Command",source:"@site/docs/guides/Development/virtual-environment.md",sourceDirName:"guides/Development",slug:"/guides/Development/virtual-environment",permalink:"/docs/guides/Development/virtual-environment",draft:!1,unlisted:!1,editUrl:"https://github.com/dora-rs/dora-rs.github.io/edit/main/docs/guides/Development/virtual-environment.md",tags:[],version:"current",frontMatter:{},sidebar:"guides",previous:{title:"Hot Reloading",permalink:"/docs/guides/Development/hot-reload"},next:{title:"Logs",permalink:"/docs/guides/Debugging/logs"}},a={},l=[{value:"run Command",id:"run-command",level:2},{value:"start command",id:"start-command",level:2},{value:"Overwrite an environment",id:"overwrite-an-environment",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"virtual-environment",children:"Virtual Environment"}),"\n",(0,r.jsxs)(n.h2,{id:"run-command",children:[(0,r.jsx)(n.code,{children:"run"})," Command"]}),"\n",(0,r.jsx)(n.p,{children:"When using dora with the run command, all python environment will be handled by the current environment."}),"\n",(0,r.jsx)(n.p,{children:"You should activate the right env before running dora."}),"\n",(0,r.jsx)(n.p,{children:"You can make sure"}),"\n",(0,r.jsxs)(n.h2,{id:"start-command",children:[(0,r.jsx)(n.code,{children:"start"})," command"]}),"\n",(0,r.jsx)(n.p,{children:"When using dora start, you have to make sure that the daemon is running within the right environement."}),"\n",(0,r.jsxs)(n.p,{children:["It is the one that is handled within the ",(0,r.jsx)(n.code,{children:"dora up"})," command."]}),"\n",(0,r.jsxs)(n.p,{children:["In case of confusion, you can use ",(0,r.jsx)(n.code,{children:"dora destroy && dora up"})," in the env, you want to be."]}),"\n",(0,r.jsx)(n.h2,{id:"overwrite-an-environment",children:"Overwrite an environment"}),"\n",(0,r.jsx)(n.p,{children:"You can overwrite an environment using, the following tricks:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Using predefined python"}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- id: dora-vad\n path: ../.venv/bin/python\n args: my_script.py\n"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Using shell"}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- id: dora-vad\n path: shell\n args: /path/to/python my_script.py\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>d});var r=t(96540);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1c4ae0dc.a35f9c17.js b/assets/js/1c4ae0dc.dbe45109.js
similarity index 99%
rename from assets/js/1c4ae0dc.a35f9c17.js
rename to assets/js/1c4ae0dc.dbe45109.js
index a8e84f51..5c17ba03 100644
--- a/assets/js/1c4ae0dc.a35f9c17.js
+++ b/assets/js/1c4ae0dc.dbe45109.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdora_rs_github_io=self.webpackChunkdora_rs_github_io||[]).push([[8902],{3321:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var r=t(74848),a=t(28453);const s={authors:"haixuan",title:"Rust-Python FFI",description:"Rust-Python FFI."},i=void 0,o={permalink:"/blog/rust-python",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/rust-python.md",source:"@site/blog/rust-python.md",title:"Rust-Python FFI",description:"Rust-Python FFI.",date:"2025-02-03T14:15:00.000Z",tags:[],readingTime:10.8,hasTruncateMarker:!1,authors:[{name:"Haixuan Xavier Tao",title:"Maintainer of dora-rs",url:"https://github.com/haixuantao",imageURL:"https://github.com/haixuantao.png",key:"haixuan"}],frontMatter:{authors:"haixuan",title:"Rust-Python FFI",description:"Rust-Python FFI."},unlisted:!1},l={authorsImageUrls:[void 0]},c=[{value:"Foreign Function Interface",id:"foreign-function-interface",level:2},{value:"Interfacing Arrays",id:"interfacing-arrays",level:2},{value:"Implementation 1: Default",id:"implementation-1-default",level:3},{value:"> Calling create_list for a very large list like: value = [1] * 100_000_000 is going to return in 2.27s \ud83d\ude9c",id:"-calling-create_list-for-a-very-large-list-like-value--1--100_000_000--is-going-to-return-in-227s-tractor",level:4},{value:"Implementation 2: PyBytes",id:"implementation-2-pybytes",level:3},{value:"> For the same list input, create_list_bytes returns in 78 milliseconds. That's 30x better \ud83d\udc0e",id:"-for-the-same-list-input-create_list_bytes-returns-in-78-milliseconds-thats-30x-better-racehorse",level:4},{value:"Implementation 3: Apache Arrow",id:"implementation-3-apache-arrow",level:3},{value:"> Same list returns in 33 milliseconds . That's 2x better than PyBytes \ud83d\udc0e\ud83d\udc0e",id:"-same-list-returns-in-33-milliseconds--thats-2x-better-than-pybytes-racehorseracehorse",level:4},{value:"Debugging",id:"debugging",level:2},{value:".unwrap()",id:"unwrap",level:3},{value:"> Example error:",id:"-example-error",level:4},{value:"eyre",id:"eyre",level:3},{value:"> Same error as above but with eyre which gives a better looking error message:",id:"-same-error-as-above-but-with-eyre-which-gives-a-better-looking-error-message",level:4},{value:"Python traceback with eyre",id:"python-traceback-with-eyre",level:3},{value:"> Example error with no custom traceback:",id:"-example-error-with-no-custom-traceback",level:4},{value:"> Better errors with custom traceback:",id:"-better-errors-with-custom-traceback",level:4},{value:"Memory management",id:"memory-management",level:2},{value:"> Calling this function will consume 440MB of memory. \ud83d\udc4e",id:"-calling-this-function-will-consume-440mb-of-memory--1",level:4},{value:"> Calling this function will consume 80MB of memory. :thumbsup:",id:"-calling-this-function-will-consume-80mb-of-memory-thumbsup",level:4},{value:"Race condition",id:"race-condition",level:2},{value:"> This threaded print was printed after 10.0s. \ud83d\ude22",id:"-this-threaded-print-was-printed-after-100s-cry",level:4},{value:"> "1" was printed after 32\xb5s and "2" was printed after 80\xb5s, so there was no race condition. \ud83d\ude04",id:"-1-was-printed-after-32\xb5s-and-2-was-printed-after-80\xb5s-so-there-was-no-race-condition-smile",level:4},{value:"Tracing",id:"tracing",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Writing a rust library that is usable in multiple languages is not easy..."}),"\n",(0,r.jsxs)(n.p,{children:["This blogpost recollects things I have encountered while building ",(0,r.jsx)(n.a,{href:"https://github.com/webonnx/wonnx",children:"wonnx"})," and ",(0,r.jsx)(n.a,{href:"https://github.com/dora-rs/dora",children:"dora-rs"}),". I am going to use Rust-Python FFI through ",(0,r.jsx)(n.code,{children:"pyo3"})," as an example. You can then extrapolate those issues to other languages FFI."]}),"\n",(0,r.jsx)(n.h2,{id:"foreign-function-interface",children:"Foreign Function Interface"}),"\n",(0,r.jsx)(n.p,{children:"A foreign function interface (FFI) is an interface used to share data from different languages."}),"\n",(0,r.jsxs)(n.p,{children:["By default, python might not know what a Rust ",(0,r.jsx)(n.code,{children:"u16"})," is, so an interface is needed to make the two languages communicate."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{src:"https://hackmd.io/_uploads/S1qiK8hRh.png",alt:""})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["Image from ",(0,r.jsx)(n.a,{href:"https://hacks.mozilla.org/2019/08/webassembly-interface-types/",children:"WebAssembly Interface Types: Interoperate with All the Things!"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Building interfaces is not easy. Most of the time, we have to use the C-ABI to build our FFI as it is the common denominator between languages."}),"\n",(0,r.jsx)(n.p,{children:"Thankfully, there are FFI libraries that create interfaces for us and we can just focus on the important stuff such as the logic, algorithm, and so on."}),"\n",(0,r.jsx)(n.p,{children:"However, those FFI libraries might have limitations. This is what we're going to discuss."}),"\n",(0,r.jsxs)(n.p,{children:["One example of such FFI library is ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})}),". ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})})," is one of the most used Rust-Python binding and creates FFIs for you. All we have to do is wrap our function with a ",(0,r.jsx)(n.code,{children:"#[pyfunction]"})," and that will make it usable in Python."]}),"\n",(0,r.jsx)(n.h2,{id:"interfacing-arrays",children:"Interfacing Arrays"}),"\n",(0,r.jsxs)(n.p,{children:["In this blog post, I'm going to build a toy Rust-Python project with ",(0,r.jsx)(n.code,{children:"pyo3"})," to illustrate the issues I have faced."]}),"\n",(0,r.jsxs)(n.p,{children:["You can try this blogpost at home by forking the ",(0,r.jsx)(n.a,{href:"https://github.com/haixuanTao/blogpost_ffi",children:"blogpost repository"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"If you want to start from scratch, you can create a new project with:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"mkdir blogpost_ffi\nmaturin init # pyo3\n"})}),"\n",(0,r.jsx)(n.p,{children:"The default project will looks like this:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-rust",children:"use pyo3::prelude::*;\n\n/// Formats the sum of two numbers as string.\n#[pyfunction]\nfn sum_as_string(a: usize, b: usize) -> PyResultcreate_list for a very large list like: value = [1] * 100_000_000 is going to return in 2.27s \ud83d\ude9c",id:"-calling-create_list-for-a-very-large-list-like-value--1--100_000_000--is-going-to-return-in-227s-tractor",level:4},{value:"Implementation 2: PyBytes",id:"implementation-2-pybytes",level:3},{value:"> For the same list input, create_list_bytes returns in 78 milliseconds. That's 30x better \ud83d\udc0e",id:"-for-the-same-list-input-create_list_bytes-returns-in-78-milliseconds-thats-30x-better-racehorse",level:4},{value:"Implementation 3: Apache Arrow",id:"implementation-3-apache-arrow",level:3},{value:"> Same list returns in 33 milliseconds . That's 2x better than PyBytes \ud83d\udc0e\ud83d\udc0e",id:"-same-list-returns-in-33-milliseconds--thats-2x-better-than-pybytes-racehorseracehorse",level:4},{value:"Debugging",id:"debugging",level:2},{value:".unwrap()",id:"unwrap",level:3},{value:"> Example error:",id:"-example-error",level:4},{value:"eyre",id:"eyre",level:3},{value:"> Same error as above but with eyre which gives a better looking error message:",id:"-same-error-as-above-but-with-eyre-which-gives-a-better-looking-error-message",level:4},{value:"Python traceback with eyre",id:"python-traceback-with-eyre",level:3},{value:"> Example error with no custom traceback:",id:"-example-error-with-no-custom-traceback",level:4},{value:"> Better errors with custom traceback:",id:"-better-errors-with-custom-traceback",level:4},{value:"Memory management",id:"memory-management",level:2},{value:"> Calling this function will consume 440MB of memory. \ud83d\udc4e",id:"-calling-this-function-will-consume-440mb-of-memory--1",level:4},{value:"> Calling this function will consume 80MB of memory. :thumbsup:",id:"-calling-this-function-will-consume-80mb-of-memory-thumbsup",level:4},{value:"Race condition",id:"race-condition",level:2},{value:"> This threaded print was printed after 10.0s. \ud83d\ude22",id:"-this-threaded-print-was-printed-after-100s-cry",level:4},{value:"> "1" was printed after 32\xb5s and "2" was printed after 80\xb5s, so there was no race condition. \ud83d\ude04",id:"-1-was-printed-after-32\xb5s-and-2-was-printed-after-80\xb5s-so-there-was-no-race-condition-smile",level:4},{value:"Tracing",id:"tracing",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Writing a rust library that is usable in multiple languages is not easy..."}),"\n",(0,r.jsxs)(n.p,{children:["This blogpost recollects things I have encountered while building ",(0,r.jsx)(n.a,{href:"https://github.com/webonnx/wonnx",children:"wonnx"})," and ",(0,r.jsx)(n.a,{href:"https://github.com/dora-rs/dora",children:"dora-rs"}),". I am going to use Rust-Python FFI through ",(0,r.jsx)(n.code,{children:"pyo3"})," as an example. You can then extrapolate those issues to other languages FFI."]}),"\n",(0,r.jsx)(n.h2,{id:"foreign-function-interface",children:"Foreign Function Interface"}),"\n",(0,r.jsx)(n.p,{children:"A foreign function interface (FFI) is an interface used to share data from different languages."}),"\n",(0,r.jsxs)(n.p,{children:["By default, python might not know what a Rust ",(0,r.jsx)(n.code,{children:"u16"})," is, so an interface is needed to make the two languages communicate."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{src:"https://hackmd.io/_uploads/S1qiK8hRh.png",alt:""})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["Image from ",(0,r.jsx)(n.a,{href:"https://hacks.mozilla.org/2019/08/webassembly-interface-types/",children:"WebAssembly Interface Types: Interoperate with All the Things!"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Building interfaces is not easy. Most of the time, we have to use the C-ABI to build our FFI as it is the common denominator between languages."}),"\n",(0,r.jsx)(n.p,{children:"Thankfully, there are FFI libraries that create interfaces for us and we can just focus on the important stuff such as the logic, algorithm, and so on."}),"\n",(0,r.jsx)(n.p,{children:"However, those FFI libraries might have limitations. This is what we're going to discuss."}),"\n",(0,r.jsxs)(n.p,{children:["One example of such FFI library is ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})}),". ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})})," is one of the most used Rust-Python binding and creates FFIs for you. All we have to do is wrap our function with a ",(0,r.jsx)(n.code,{children:"#[pyfunction]"})," and that will make it usable in Python."]}),"\n",(0,r.jsx)(n.h2,{id:"interfacing-arrays",children:"Interfacing Arrays"}),"\n",(0,r.jsxs)(n.p,{children:["In this blog post, I'm going to build a toy Rust-Python project with ",(0,r.jsx)(n.code,{children:"pyo3"})," to illustrate the issues I have faced."]}),"\n",(0,r.jsxs)(n.p,{children:["You can try this blogpost at home by forking the ",(0,r.jsx)(n.a,{href:"https://github.com/haixuanTao/blogpost_ffi",children:"blogpost repository"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"If you want to start from scratch, you can create a new project with:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"mkdir blogpost_ffi\nmaturin init # pyo3\n"})}),"\n",(0,r.jsx)(n.p,{children:"The default project will looks like this:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-rust",children:"use pyo3::prelude::*;\n\n/// Formats the sum of two numbers as string.\n#[pyfunction]\nfn sum_as_string(a: usize, b: usize) -> PyResultcreate_list for a very large list like: value = [1] * 100_000_000 is going to return in 2.27s \ud83d\ude9c",id:"-calling-create_list-for-a-very-large-list-like-value--1--100_000_000--is-going-to-return-in-227s-tractor",level:4},{value:"Implementation 2: PyBytes",id:"implementation-2-pybytes",level:3},{value:"> For the same list input, create_list_bytes returns in 78 milliseconds. That's 30x better \ud83d\udc0e",id:"-for-the-same-list-input-create_list_bytes-returns-in-78-milliseconds-thats-30x-better-racehorse",level:4},{value:"Implementation 3: Apache Arrow",id:"implementation-3-apache-arrow",level:3},{value:"> Same list returns in 33 milliseconds . That's 2x better than PyBytes \ud83d\udc0e\ud83d\udc0e",id:"-same-list-returns-in-33-milliseconds--thats-2x-better-than-pybytes-racehorseracehorse",level:4},{value:"Debugging",id:"debugging",level:2},{value:".unwrap()",id:"unwrap",level:3},{value:"> Example error:",id:"-example-error",level:4},{value:"eyre",id:"eyre",level:3},{value:"> Same error as above but with eyre which gives a better looking error message:",id:"-same-error-as-above-but-with-eyre-which-gives-a-better-looking-error-message",level:4},{value:"Python traceback with eyre",id:"python-traceback-with-eyre",level:3},{value:"> Example error with no custom traceback:",id:"-example-error-with-no-custom-traceback",level:4},{value:"> Better errors with custom traceback:",id:"-better-errors-with-custom-traceback",level:4},{value:"Memory management",id:"memory-management",level:2},{value:"> Calling this function will consume 440MB of memory. \ud83d\udc4e",id:"-calling-this-function-will-consume-440mb-of-memory--1",level:4},{value:"> Calling this function will consume 80MB of memory. :thumbsup:",id:"-calling-this-function-will-consume-80mb-of-memory-thumbsup",level:4},{value:"Race condition",id:"race-condition",level:2},{value:"> This threaded print was printed after 10.0s. \ud83d\ude22",id:"-this-threaded-print-was-printed-after-100s-cry",level:4},{value:"> "1" was printed after 32\xb5s and "2" was printed after 80\xb5s, so there was no race condition. \ud83d\ude04",id:"-1-was-printed-after-32\xb5s-and-2-was-printed-after-80\xb5s-so-there-was-no-race-condition-smile",level:4},{value:"Tracing",id:"tracing",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Writing a rust library that is usable in multiple languages is not easy..."}),"\n",(0,r.jsxs)(n.p,{children:["This blogpost recollects things I have encountered while building ",(0,r.jsx)(n.a,{href:"https://github.com/webonnx/wonnx",children:"wonnx"})," and ",(0,r.jsx)(n.a,{href:"https://github.com/dora-rs/dora",children:"dora-rs"}),". I am going to use Rust-Python FFI through ",(0,r.jsx)(n.code,{children:"pyo3"})," as an example. You can then extrapolate those issues to other languages FFI."]}),"\n",(0,r.jsx)(n.h2,{id:"foreign-function-interface",children:"Foreign Function Interface"}),"\n",(0,r.jsx)(n.p,{children:"A foreign function interface (FFI) is an interface used to share data from different languages."}),"\n",(0,r.jsxs)(n.p,{children:["By default, python might not know what a Rust ",(0,r.jsx)(n.code,{children:"u16"})," is, so an interface is needed to make the two languages communicate."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{src:"https://hackmd.io/_uploads/S1qiK8hRh.png",alt:""})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["Image from ",(0,r.jsx)(n.a,{href:"https://hacks.mozilla.org/2019/08/webassembly-interface-types/",children:"WebAssembly Interface Types: Interoperate with All the Things!"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Building interfaces is not easy. Most of the time, we have to use the C-ABI to build our FFI as it is the common denominator between languages."}),"\n",(0,r.jsx)(n.p,{children:"Thankfully, there are FFI libraries that create interfaces for us and we can just focus on the important stuff such as the logic, algorithm, and so on."}),"\n",(0,r.jsx)(n.p,{children:"However, those FFI libraries might have limitations. This is what we're going to discuss."}),"\n",(0,r.jsxs)(n.p,{children:["One example of such FFI library is ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})}),". ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})})," is one of the most used Rust-Python binding and creates FFIs for you. All we have to do is wrap our function with a ",(0,r.jsx)(n.code,{children:"#[pyfunction]"})," and that will make it usable in Python."]}),"\n",(0,r.jsx)(n.h2,{id:"interfacing-arrays",children:"Interfacing Arrays"}),"\n",(0,r.jsxs)(n.p,{children:["In this blog post, I'm going to build a toy Rust-Python project with ",(0,r.jsx)(n.code,{children:"pyo3"})," to illustrate the issues I have faced."]}),"\n",(0,r.jsxs)(n.p,{children:["You can try this blogpost at home by forking the ",(0,r.jsx)(n.a,{href:"https://github.com/haixuanTao/blogpost_ffi",children:"blogpost repository"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"If you want to start from scratch, you can create a new project with:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"mkdir blogpost_ffi\nmaturin init # pyo3\n"})}),"\n",(0,r.jsx)(n.p,{children:"The default project will looks like this:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-rust",children:"use pyo3::prelude::*;\n\n/// Formats the sum of two numbers as string.\n#[pyfunction]\nfn sum_as_string(a: usize, b: usize) -> PyResultcreate_list for a very large list like: value = [1] * 100_000_000 is going to return in 2.27s \ud83d\ude9c",id:"-calling-create_list-for-a-very-large-list-like-value--1--100_000_000--is-going-to-return-in-227s-tractor",level:4},{value:"Implementation 2: PyBytes",id:"implementation-2-pybytes",level:3},{value:"> For the same list input, create_list_bytes returns in 78 milliseconds. That's 30x better \ud83d\udc0e",id:"-for-the-same-list-input-create_list_bytes-returns-in-78-milliseconds-thats-30x-better-racehorse",level:4},{value:"Implementation 3: Apache Arrow",id:"implementation-3-apache-arrow",level:3},{value:"> Same list returns in 33 milliseconds . That's 2x better than PyBytes \ud83d\udc0e\ud83d\udc0e",id:"-same-list-returns-in-33-milliseconds--thats-2x-better-than-pybytes-racehorseracehorse",level:4},{value:"Debugging",id:"debugging",level:2},{value:".unwrap()",id:"unwrap",level:3},{value:"> Example error:",id:"-example-error",level:4},{value:"eyre",id:"eyre",level:3},{value:"> Same error as above but with eyre which gives a better looking error message:",id:"-same-error-as-above-but-with-eyre-which-gives-a-better-looking-error-message",level:4},{value:"Python traceback with eyre",id:"python-traceback-with-eyre",level:3},{value:"> Example error with no custom traceback:",id:"-example-error-with-no-custom-traceback",level:4},{value:"> Better errors with custom traceback:",id:"-better-errors-with-custom-traceback",level:4},{value:"Memory management",id:"memory-management",level:2},{value:"> Calling this function will consume 440MB of memory. \ud83d\udc4e",id:"-calling-this-function-will-consume-440mb-of-memory--1",level:4},{value:"> Calling this function will consume 80MB of memory. :thumbsup:",id:"-calling-this-function-will-consume-80mb-of-memory-thumbsup",level:4},{value:"Race condition",id:"race-condition",level:2},{value:"> This threaded print was printed after 10.0s. \ud83d\ude22",id:"-this-threaded-print-was-printed-after-100s-cry",level:4},{value:"> "1" was printed after 32\xb5s and "2" was printed after 80\xb5s, so there was no race condition. \ud83d\ude04",id:"-1-was-printed-after-32\xb5s-and-2-was-printed-after-80\xb5s-so-there-was-no-race-condition-smile",level:4},{value:"Tracing",id:"tracing",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Writing a rust library that is usable in multiple languages is not easy..."}),"\n",(0,r.jsxs)(n.p,{children:["This blogpost recollects things I have encountered while building ",(0,r.jsx)(n.a,{href:"https://github.com/webonnx/wonnx",children:"wonnx"})," and ",(0,r.jsx)(n.a,{href:"https://github.com/dora-rs/dora",children:"dora-rs"}),". I am going to use Rust-Python FFI through ",(0,r.jsx)(n.code,{children:"pyo3"})," as an example. You can then extrapolate those issues to other languages FFI."]}),"\n",(0,r.jsx)(n.h2,{id:"foreign-function-interface",children:"Foreign Function Interface"}),"\n",(0,r.jsx)(n.p,{children:"A foreign function interface (FFI) is an interface used to share data from different languages."}),"\n",(0,r.jsxs)(n.p,{children:["By default, python might not know what a Rust ",(0,r.jsx)(n.code,{children:"u16"})," is, so an interface is needed to make the two languages communicate."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{src:"https://hackmd.io/_uploads/S1qiK8hRh.png",alt:""})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["Image from ",(0,r.jsx)(n.a,{href:"https://hacks.mozilla.org/2019/08/webassembly-interface-types/",children:"WebAssembly Interface Types: Interoperate with All the Things!"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Building interfaces is not easy. Most of the time, we have to use the C-ABI to build our FFI as it is the common denominator between languages."}),"\n",(0,r.jsx)(n.p,{children:"Thankfully, there are FFI libraries that create interfaces for us and we can just focus on the important stuff such as the logic, algorithm, and so on."}),"\n",(0,r.jsx)(n.p,{children:"However, those FFI libraries might have limitations. This is what we're going to discuss."}),"\n",(0,r.jsxs)(n.p,{children:["One example of such FFI library is ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})}),". ",(0,r.jsx)(n.a,{href:"https://github.com/PyO3/pyo3",children:(0,r.jsx)(n.code,{children:"pyo3"})})," is one of the most used Rust-Python binding and creates FFIs for you. All we have to do is wrap our function with a ",(0,r.jsx)(n.code,{children:"#[pyfunction]"})," and that will make it usable in Python."]}),"\n",(0,r.jsx)(n.h2,{id:"interfacing-arrays",children:"Interfacing Arrays"}),"\n",(0,r.jsxs)(n.p,{children:["In this blog post, I'm going to build a toy Rust-Python project with ",(0,r.jsx)(n.code,{children:"pyo3"})," to illustrate the issues I have faced."]}),"\n",(0,r.jsxs)(n.p,{children:["You can try this blogpost at home by forking the ",(0,r.jsx)(n.a,{href:"https://github.com/haixuanTao/blogpost_ffi",children:"blogpost repository"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"If you want to start from scratch, you can create a new project with:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"mkdir blogpost_ffi\nmaturin init # pyo3\n"})}),"\n",(0,r.jsx)(n.p,{children:"The default project will looks like this:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-rust",children:"use pyo3::prelude::*;\n\n/// Formats the sum of two numbers as string.\n#[pyfunction]\nfn sum_as_string(a: usize, b: usize) -> PyResultYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\nYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n