github-actions[bot]
19 lines
4.7 KiB
HTML
19 lines
4.7 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A proc macro used to implement Python modules."><title>pymodule in pyo3::prelude - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc attr"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3/index.html">pyo3</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3::<wbr>prelude</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3</a>::<wbr><a href="index.html">prelude</a></span><h1>Attribute Macro <span class="attr">pymodule</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_macros/lib.rs.html#40">Source</a> </span></div><pre class="rust item-decl"><code>#[pymodule]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A proc macro used to implement Python modules.</p>
|
|
<p>The name of the module will be taken from the function name, unless <code>#[pyo3(name = "my_name")]</code>
|
|
is also annotated on the function to override the name. <strong>Important</strong>: the module name should
|
|
match the <code>lib.name</code> setting in <code>Cargo.toml</code>, so that Python is able to import the module
|
|
without needing a custom import loader.</p>
|
|
<p>Functions annotated with <code>#[pymodule]</code> can also be annotated with the following:</p>
|
|
<div><table><thead><tr><th style="text-align: left">Annotation</th><th style="text-align: left">Description</th></tr></thead><tbody>
|
|
<tr><td style="text-align: left"><code>#[pyo3(name = "...")]</code></td><td style="text-align: left">Defines the name of the module in Python.</td></tr>
|
|
<tr><td style="text-align: left"><code>#[pyo3(submodule)]</code></td><td style="text-align: left">Skips adding a <code>PyInit_</code> FFI symbol to the compiled binary.</td></tr>
|
|
<tr><td style="text-align: left"><code>#[pyo3(module = "...")]</code></td><td style="text-align: left">Defines the Python <code>dotted.path</code> to the parent module for use in introspection.</td></tr>
|
|
<tr><td style="text-align: left"><code>#[pyo3(crate = "pyo3")]</code></td><td style="text-align: left">Defines the path to PyO3 to use code generated by the macro.</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<p>For more on creating Python modules see the <a href="https://pyo3.rs/v0.24.1/module.html">module section of the guide</a>.</p>
|
|
<p>Due to technical limitations on how <code>#[pymodule]</code> is implemented, a function marked
|
|
<code>#[pymodule]</code> cannot have a module with the same name in the same scope. (The
|
|
<code>#[pymodule]</code> implementation generates a hidden module with the same name containing
|
|
metadata about the module, which is used by <code>wrap_pymodule!</code>).</p>
|
|
</div></details></section></div></main></body></html> |