github-actions[bot]
18 lines
5.9 KiB
HTML
18 lines
5.9 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 expose methods to Python."><title>pymethods 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">pymethods</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#114">Source</a> </span></div><pre class="rust item-decl"><code>#[pymethods]</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 expose methods to Python.</p>
|
||
<p>Methods within a <code>#[pymethods]</code> block can be annotated with as well as 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"><a href="https://pyo3.rs/v0.24.1/class.html#constructor"><code>#[new]</code></a></td><td style="text-align: left">Defines the class constructor, like Python’s <code>__new__</code> method.</td></tr>
|
||
<tr><td style="text-align: left"><a href="https://pyo3.rs/v0.24.1/class.html#object-properties-using-getter-and-setter"><code>#[getter]</code></a> and <a href="https://pyo3.rs/v0.24.1/class.html#object-properties-using-getter-and-setter"><code>#[setter]</code></a></td><td style="text-align: left">These define getters and setters, similar to Python’s <code>@property</code> decorator. This is useful for getters/setters that require computation or side effects; if that is not the case consider using <a href="https://pyo3.rs/v0.24.1/class.html#object-properties-using-pyo3get-set"><code>#[pyo3(get, set)]</code></a> on the struct’s field(s).</td></tr>
|
||
<tr><td style="text-align: left"><a href="https://pyo3.rs/v0.24.1/class.html#static-methods"><code>#[staticmethod]</code></a></td><td style="text-align: left">Defines the method as a staticmethod, like Python’s <code>@staticmethod</code> decorator.</td></tr>
|
||
<tr><td style="text-align: left"><a href="https://pyo3.rs/v0.24.1/class.html#class-methods"><code>#[classmethod]</code></a></td><td style="text-align: left">Defines the method as a classmethod, like Python’s <code>@classmethod</code> decorator.</td></tr>
|
||
<tr><td style="text-align: left"><a href="https://pyo3.rs/v0.24.1/class.html#class-attributes"><code>#[classattr]</code></a></td><td style="text-align: left">Defines a class variable.</td></tr>
|
||
<tr><td style="text-align: left"><a href="https://pyo3.rs/v0.24.1/class.html#method-arguments"><code>#[args]</code></a></td><td style="text-align: left">Deprecated way to define a method’s default arguments and allows the function to receive <code>*args</code> and <code>**kwargs</code>. Use <code>#[pyo3(signature = (...))]</code> instead.</td></tr>
|
||
<tr><td style="text-align: left"><nobr>[<code>#[pyo3(<option> = <value>)</code>][pyo3-method-options]</nobr></td><td style="text-align: left">Any of the <code>#[pyo3]</code> options supported on <a href="../attr.pyfunction.html" title="attr pyo3::pyfunction"><code>pyfunction</code></a>.</td></tr>
|
||
</tbody></table>
|
||
</div>
|
||
<p>For more on creating class methods,
|
||
see the <a href="https://pyo3.rs/v0.24.1/class.html#instance-methods">class section of the guide</a>.</p>
|
||
<p>If the <a href="https://pyo3.rs/v0.24.1/features.html#multiple-pymethods"><code>multiple-pymethods</code></a> feature is enabled, it is possible to implement
|
||
multiple <code>#[pymethods]</code> blocks for a single <code>#[pyclass]</code>.
|
||
This will add a transitive dependency on the <a href="https://docs.rs/inventory/"><code>inventory</code></a> crate.</p>
|
||
</div></details></section></div></main></body></html> |