Auto Generated Documentation
This commit is contained in:
github-actions[bot]
+15
-15
@@ -1,19 +1,19 @@
|
||||
<!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 convenient macro to execute a Python code snippet, with some local variables set."><meta name="keywords" content="rust, rustlang, rust-lang, py_run"><title>pyo3::py_run - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<!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 convenient macro to execute a Python code snippet, with some local variables set."><meta name="keywords" content="rust, rustlang, rust-lang, py_run"><title>py_run in pyo3 - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../pyo3/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">pyo3</a></p><div id="sidebar-vars" data-name="py_run" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">pyo3</a>::<wbr><a class="macro" href="">py_run</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/pyo3/lib.rs.html#330-337" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">py_run</span> {
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../pyo3/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">pyo3</a></p><div id="sidebar-vars" data-name="py_run" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">pyo3</a>::<wbr><a class="macro" href="">py_run</a><button id="copy-path" onclick="copy_path(this)">⎘</button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/pyo3/lib.rs.html#330-337" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules!</span> <span class="ident">py_run</span> {
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">py</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">ident</span>)<span class="op">+</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">code</span>:<span class="ident">literal</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">py</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">ident</span>)<span class="op">+</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">code</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><div class="docblock"><p>A convenient macro to execute a Python code snippet, with some local variables set.</p>
|
||||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">pyo3</span>::{<span class="ident">prelude</span>::<span class="kw-2">*</span>, <span class="ident">py_run</span>, <span class="ident">types</span>::<span class="ident">PyList</span>};
|
||||
<span class="kw">let</span> <span class="ident">gil</span> <span class="op">=</span> <span class="ident">Python</span>::<span class="ident">acquire_gil</span>();
|
||||
<span class="kw">use</span> <span class="ident">pyo3</span>::{<span class="ident">prelude</span>::<span class="kw-2">*</span>, <span class="ident">py_run</span>, <span class="ident">types::PyList</span>};
|
||||
<span class="kw">let</span> <span class="ident">gil</span> <span class="op">=</span> <span class="ident">Python::acquire_gil</span>();
|
||||
<span class="kw">let</span> <span class="ident">py</span> <span class="op">=</span> <span class="ident">gil</span>.<span class="ident">python</span>();
|
||||
<span class="kw">let</span> <span class="ident">list</span> <span class="op">=</span> <span class="ident">PyList</span>::<span class="ident">new</span>(<span class="ident">py</span>, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);
|
||||
<span class="macro">py_run</span><span class="macro">!</span>(<span class="ident">py</span>, <span class="ident">list</span>, <span class="string">"assert list == [1, 2, 3]"</span>);</pre></div>
|
||||
<span class="kw">let</span> <span class="ident">list</span> <span class="op">=</span> <span class="ident">PyList::new</span>(<span class="ident">py</span>, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);
|
||||
<span class="macro">py_run!</span>(<span class="ident">py</span>, <span class="ident">list</span>, <span class="string">"assert list == [1, 2, 3]"</span>);</pre></div>
|
||||
<p>You can use this macro to test pyfunctions or pyclasses quickly.</p>
|
||||
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
@@ -28,7 +28,7 @@
|
||||
<span class="attribute">#[<span class="ident">pymethods</span>]</span>
|
||||
<span class="kw">impl</span> <span class="ident">Time</span> {
|
||||
<span class="kw">fn</span> <span class="ident">repl_japanese</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{}時{}分{}秒"</span>, <span class="self">self</span>.<span class="ident">hour</span>, <span class="self">self</span>.<span class="ident">minute</span>, <span class="self">self</span>.<span class="ident">second</span>)
|
||||
<span class="macro">format!</span>(<span class="string">"{}時{}分{}秒"</span>, <span class="self">self</span>.<span class="ident">hour</span>, <span class="self">self</span>.<span class="ident">minute</span>, <span class="self">self</span>.<span class="ident">second</span>)
|
||||
}
|
||||
<span class="attribute">#[<span class="ident">getter</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">hour</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u32</span> {
|
||||
@@ -38,18 +38,18 @@
|
||||
(<span class="self">self</span>.<span class="ident">hour</span>, <span class="self">self</span>.<span class="ident">minute</span>, <span class="self">self</span>.<span class="ident">second</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">let</span> <span class="ident">gil</span> <span class="op">=</span> <span class="ident">Python</span>::<span class="ident">acquire_gil</span>();
|
||||
<span class="kw">let</span> <span class="ident">gil</span> <span class="op">=</span> <span class="ident">Python::acquire_gil</span>();
|
||||
<span class="kw">let</span> <span class="ident">py</span> <span class="op">=</span> <span class="ident">gil</span>.<span class="ident">python</span>();
|
||||
<span class="kw">let</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">PyCell</span>::<span class="ident">new</span>(<span class="ident">py</span>, <span class="ident">Time</span> {<span class="ident">hour</span>: <span class="number">8</span>, <span class="ident">minute</span>: <span class="number">43</span>, <span class="ident">second</span>: <span class="number">16</span>}).<span class="ident">unwrap</span>();
|
||||
<span class="kw">let</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">PyCell::new</span>(<span class="ident">py</span>, <span class="ident">Time</span> {<span class="ident">hour</span>: <span class="number">8</span>, <span class="ident">minute</span>: <span class="number">43</span>, <span class="ident">second</span>: <span class="number">16</span>}).<span class="ident">unwrap</span>();
|
||||
<span class="kw">let</span> <span class="ident">time_as_tuple</span> <span class="op">=</span> (<span class="number">8</span>, <span class="number">43</span>, <span class="number">16</span>);
|
||||
<span class="macro">py_run</span><span class="macro">!</span>(<span class="ident">py</span>, <span class="ident">time</span> <span class="ident">time_as_tuple</span>, <span class="string">r#"
|
||||
<span class="macro">py_run!</span>(<span class="ident">py</span>, <span class="ident">time</span> <span class="ident">time_as_tuple</span>, <span class="string">r#"
|
||||
assert time.hour == 8
|
||||
assert time.repl_japanese() == "8時43分16秒"
|
||||
assert time.as_tuple() == time_as_tuple
|
||||
"#</span>);</pre></div>
|
||||
<p><strong>Note</strong>
|
||||
Since this macro is intended to use for testing, it <strong>causes panic</strong> when
|
||||
<a href="../pyo3/prelude/struct.Python.html#method.run" title="Python::run">Python::run</a> returns <code>Err</code> internally.
|
||||
If you need to handle failures, please use <a href="../pyo3/prelude/struct.Python.html#method.run" title="Python::run">Python::run</a> directly.</p>
|
||||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="pyo3" data-search-js="../search-index.js"></div>
|
||||
<a href="prelude/struct.Python.html#method.run" title="Python::run">Python::run</a> returns <code>Err</code> internally.
|
||||
If you need to handle failures, please use <a href="prelude/struct.Python.html#method.run" title="Python::run">Python::run</a> directly.</p>
|
||||
</div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="pyo3" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
Reference in New Issue
Block a user