Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,38 +1,29 @@
|
||||
<!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="Executes the provided closure with an embedded Python interpreter."><meta name="keywords" content="rust, rustlang, rust-lang, with_embedded_python_interpreter"><title>with_embedded_python_interpreter 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 fn"><!--[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="with_embedded_python_interpreter" data-ty="fn" 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">Function <a href="index.html">pyo3</a>::<wbr><a class="fn" href="">with_embedded_python_interpreter</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/gil.rs.html#142-179" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub unsafe fn with_embedded_python_interpreter<F, R>(f: F) -> R <span class="where fmt-newline">where<br> F: for<'p> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>) -> R, </span></pre><div class="docblock"><p>Executes the provided closure with an embedded Python interpreter.</p>
|
||||
<p>This function intializes the Python interpreter, executes the provided closure, and then
|
||||
<!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="Executes the provided closure with an embedded Python interpreter."><title>with_embedded_python_interpreter in pyo3 - 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 fn"><!--[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"><section id="rustdoc-toc"><h2 class="location"><a href="#">with_<wbr>embedded_<wbr>python_<wbr>interpreter</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate pyo3</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></span><h1>Function <span class="fn">with_embedded_python_interpreter</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/gil.rs.html#109-136">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn with_embedded_python_interpreter<F, R>(f: F) -> R<div class="where">where
|
||||
F: for<'p> <a class="trait" href="https://doc.rust-lang.org/1.85.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="marker/struct.Python.html" title="struct pyo3::marker::Python">Python</a><'p>) -> R,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Executes the provided closure with an embedded Python interpreter.</p>
|
||||
<p>This function initializes the Python interpreter, executes the provided closure, and then
|
||||
finalizes the Python interpreter.</p>
|
||||
<p>After execution all Python resources are cleaned up, and no further Python APIs can be called.
|
||||
Because many Python modules implemented in C do not support multiple Python interpreters in a
|
||||
single process, it is not safe to call this function more than once. (Many such modules will not
|
||||
initialize correctly on the second run.)</p>
|
||||
<h1 id="availability" class="section-header"><a href="#availability">Availability</a></h1>
|
||||
<p>This function is only available when linking against Python distributions that contain a shared
|
||||
library.</p>
|
||||
<p>This function is not available on PyPy.</p>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||||
<ul>
|
||||
<li>If the Python interpreter is already initalized before calling this function.</li>
|
||||
<li>If the Python interpreter is already initialized before calling this function.</li>
|
||||
</ul>
|
||||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||||
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
||||
<ul>
|
||||
<li>This function should only ever be called once per process (usually as part of the <code>main</code>
|
||||
function). It is also not thread-safe.</li>
|
||||
<li>No Python APIs can be used after this function has finished executing.</li>
|
||||
<li>The return value of the closure must not contain any Python value, <em>including</em> <code>PyResult</code>.</li>
|
||||
</ul>
|
||||
<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::prelude</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">unsafe</span> {
|
||||
<span class="ident">pyo3::with_embedded_python_interpreter</span>(<span class="op">|</span><span class="ident">py</span><span class="op">|</span> {
|
||||
<span class="ident">py</span>.<span class="ident">run</span>(<span class="string">"print('Hello World')"</span>, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>)
|
||||
});
|
||||
}
|
||||
}</pre></div>
|
||||
</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>
|
||||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">unsafe </span>{
|
||||
pyo3::with_embedded_python_interpreter(|py| {
|
||||
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = py.run(<span class="macro">pyo3::ffi::c_str!</span>(<span class="string">"print('Hello World')"</span>), <span class="prelude-val">None</span>, <span class="prelude-val">None</span>) {
|
||||
<span class="comment">// We must make sure to not return a `PyErr`!
|
||||
</span>e.print(py);
|
||||
}
|
||||
});
|
||||
}</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user