384 lines
14 KiBLFS
HTML
384 lines
14 KiBLFS
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Search — Python 3.12.4 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
|
|
<link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?v=bb723527" />
|
|
<link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="_static/pygments_dark.css?v=b20cc3f5" />
|
|
|
|
|
|
<script src="_static/documentation_options.js?v=e70b10b9"></script>
|
|
<script src="_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
|
<script src="_static/sidebar.js"></script>
|
|
|
|
<script src="_static/searchtools.js"></script>
|
|
<script src="_static/language_data.js"></script>
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|
title="Search within Python 3.12.4 documentation"
|
|
href="_static/opensearch.xml"/>
|
|
<link rel="author" title="About these documents" href="about.html" />
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="#" />
|
|
<link rel="copyright" title="Copyright" href="copyright.html" />
|
|
|
|
<script src="searchindex.js" defer="defer"></script>
|
|
<meta name="robots" content="noindex" />
|
|
|
|
<link rel="canonical" href="https://docs.python.org/3/search.html" />
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
@media only screen {
|
|
table.full-width-table {
|
|
width: 100%;
|
|
}
|
|
}
|
|
</style>
|
|
<link rel="stylesheet" href="_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
|
|
<link rel="shortcut icon" type="image/png" href="_static/py.svg" />
|
|
<script type="text/javascript" src="_static/copybutton.js"></script>
|
|
<script type="text/javascript" src="_static/menu.js"></script>
|
|
<script type="text/javascript" src="_static/search-focus.js"></script>
|
|
<script type="text/javascript" src="_static/themetoggle.js"></script>
|
|
<meta name="readthedocs-addons-api-version" content="1">
|
|
<script type="text/javascript">
|
|
function onSwitch(event) {
|
|
const option = event.target.selectedIndex;
|
|
const item = event.target.options[option];
|
|
window.location.href = item.dataset.url;
|
|
}
|
|
|
|
document.addEventListener("readthedocs-addons-data-ready", function(event) {
|
|
const config = event.detail.data()
|
|
|
|
// Add some mocked hardcoded versions pointing to the official
|
|
// documentation while migrating to Read the Docs.
|
|
// These are only for testing purposes.
|
|
// TODO: remove them when managing all the versions on Read the Docs,
|
|
// since all the "active, built and not hidden" versions will be shown automatically.
|
|
let versions = config.versions.active.concat([
|
|
{
|
|
slug: "dev (3.13)",
|
|
urls: {
|
|
documentation: "https://docs.python.org/3.13/",
|
|
}
|
|
},
|
|
{
|
|
slug: "3.12",
|
|
urls: {
|
|
documentation: "https://docs.python.org/3.12/",
|
|
}
|
|
},
|
|
{
|
|
slug: "3.11",
|
|
urls: {
|
|
documentation: "https://docs.python.org/3.11/",
|
|
}
|
|
},
|
|
]);
|
|
|
|
const versionSelect = `
|
|
<select id="version_select">
|
|
${ versions.map(
|
|
(version) => `
|
|
<option
|
|
value="${ version.slug }"
|
|
${ config.versions.current.slug === version.slug ? 'selected="selected"' : '' }
|
|
data-url="${ version.urls.documentation }">
|
|
${ version.slug }
|
|
</option>`
|
|
).join("\n") }
|
|
</select>
|
|
`;
|
|
|
|
// Prepend the current language to the options on the selector
|
|
let languages = config.projects.translations.concat(config.projects.current);
|
|
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
|
|
|
|
const languageSelect = `
|
|
<select id="language_select">
|
|
${ languages.map(
|
|
(translation) => `
|
|
<option
|
|
value="${ translation.slug }"
|
|
${ config.projects.current.slug === translation.slug ? 'selected="selected"' : '' }
|
|
data-url="${ translation.urls.documentation }">
|
|
${ translation.language.name }
|
|
</option>`
|
|
).join("\n") }
|
|
</select>
|
|
`;
|
|
|
|
// Query all the placeholders because there are different ones for Desktop/Mobile
|
|
const versionPlaceholders = document.querySelectorAll(".version_switcher_placeholder");
|
|
for (placeholder of versionPlaceholders) {
|
|
placeholder.innerHTML = versionSelect;
|
|
let selectElement = placeholder.querySelector("select");
|
|
selectElement.addEventListener("change", onSwitch);
|
|
}
|
|
|
|
const languagePlaceholders = document.querySelectorAll(".language_switcher_placeholder");
|
|
for (placeholder of languagePlaceholders) {
|
|
placeholder.innerHTML = languageSelect;
|
|
let selectElement = placeholder.querySelector("select");
|
|
selectElement.addEventListener("change", onSwitch);
|
|
}
|
|
});
|
|
</script>
|
|
|
|
|
|
<meta name="robots" content="noindex">
|
|
<script type="text/javascript">
|
|
const GLOSSARY_PAGE = 'glossary.html';
|
|
|
|
document.addEventListener('DOMContentLoaded', function() {
|
|
fetch('_static/glossary.json')
|
|
.then(function(response) {
|
|
if (response.ok) {
|
|
return response.json();
|
|
} else {
|
|
throw new Error('Failed to fetch glossary.json');
|
|
}
|
|
})
|
|
.then(function(glossary) {
|
|
const RESULT_TEMPLATE = '<div style="display: none" class="admonition seealso" id="glossary-result">' +
|
|
' <p class="topic-title">' +
|
|
' <a class="glossary-title" href="#"></a>' +
|
|
' </p>' +
|
|
' <div class="glossary-body"></div>' +
|
|
'</div>';
|
|
let searchResults = document.getElementById('search-results');
|
|
searchResults.insertAdjacentHTML('afterbegin', RESULT_TEMPLATE);
|
|
|
|
const params = new URLSearchParams(document.location.search).get("q");
|
|
if (params) {
|
|
const searchParam = params.toLowerCase();
|
|
const glossaryItem = glossary[searchParam];
|
|
if (glossaryItem) {
|
|
let resultDiv = document.getElementById('glossary-result');
|
|
|
|
// set up the title text with a link to the glossary page
|
|
let glossaryTitle = resultDiv.querySelector('.glossary-title');
|
|
glossaryTitle.textContent = 'Glossary: ' + glossaryItem.title;
|
|
const linkTarget = searchParam.replace(/ /g, '-');
|
|
glossaryTitle.href = GLOSSARY_PAGE + '#term-' + linkTarget;
|
|
|
|
// rewrite any anchor links (to other glossary terms)
|
|
// to have a full reference to the glossary page
|
|
let body = document.createElement('div');
|
|
body.innerHTML = glossaryItem.body;
|
|
const anchorLinks = body.querySelectorAll('a[href^="#"]');
|
|
anchorLinks.forEach(function(link) {
|
|
const currentUrl = link.getAttribute('href');
|
|
link.href = GLOSSARY_PAGE + currentUrl;
|
|
});
|
|
resultDiv.querySelector('.glossary-body').appendChild(body);
|
|
|
|
resultDiv.style.display = '';
|
|
} else {
|
|
document.getElementById('glossary-result').style.display = 'none';
|
|
}
|
|
}
|
|
})
|
|
.catch(function(error) {
|
|
console.error(error);
|
|
});
|
|
});
|
|
</script>
|
|
|
|
</head>
|
|
<body>
|
|
<div class="mobile-nav">
|
|
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
|
|
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
|
|
<nav class="nav-content" role="navigation">
|
|
<label for="menuToggler" class="toggler__label">
|
|
<span></span>
|
|
</label>
|
|
<span class="nav-items-wrapper">
|
|
<a href="https://www.python.org/" class="nav-logo">
|
|
<img src="_static/py.svg" alt="Python logo"/>
|
|
</a>
|
|
<span class="version_switcher_placeholder"></span>
|
|
</span>
|
|
</nav>
|
|
<div class="menu-wrapper">
|
|
<nav class="menu" role="navigation" aria-label="main navigation">
|
|
<div class="language_switcher_placeholder"></div>
|
|
|
|
<label class="theme-selector-label">
|
|
Theme
|
|
<select class="theme-selector" oninput="activateTheme(this.value)">
|
|
<option value="auto" selected>Auto</option>
|
|
<option value="light">Light</option>
|
|
<option value="dark">Dark</option>
|
|
</select>
|
|
</label>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
|
|
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
<li class="switchers">
|
|
<div class="language_switcher_placeholder"></div>
|
|
<div class="version_switcher_placeholder"></div>
|
|
</li>
|
|
<li>
|
|
|
|
</li>
|
|
<li id="cpython-language-and-version">
|
|
<a href="index.html">3.12.4 Documentation</a> »
|
|
</li>
|
|
|
|
<li class="nav-item nav-item-this"><a href="">Search</a></li>
|
|
<li class="right">
|
|
<label class="theme-selector-label">
|
|
Theme
|
|
<select class="theme-selector" oninput="activateTheme(this.value)">
|
|
<option value="auto" selected>Auto</option>
|
|
<option value="light">Light</option>
|
|
<option value="dark">Dark</option>
|
|
</select>
|
|
</label> |</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1 id="search-documentation">Search</h1>
|
|
|
|
<noscript>
|
|
<div class="admonition warning">
|
|
<p>
|
|
Please activate JavaScript to enable the search
|
|
functionality.
|
|
</p>
|
|
</div>
|
|
</noscript>
|
|
|
|
|
|
<p>
|
|
Searching for multiple words only shows matches that contain
|
|
all words.
|
|
</p>
|
|
|
|
|
|
<form action="" method="get">
|
|
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="search" />
|
|
<span id="search-progress" style="padding-left: 10px"></span>
|
|
</form>
|
|
|
|
|
|
<div id="search-results"></div>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
</div>
|
|
<div id="sidebarbutton" title="Collapse sidebar">
|
|
<span>«</span>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
|
|
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
<li class="switchers">
|
|
<div class="language_switcher_placeholder"></div>
|
|
<div class="version_switcher_placeholder"></div>
|
|
</li>
|
|
<li>
|
|
|
|
</li>
|
|
<li id="cpython-language-and-version">
|
|
<a href="index.html">3.12.4 Documentation</a> »
|
|
</li>
|
|
|
|
<li class="nav-item nav-item-this"><a href="">Search</a></li>
|
|
<li class="right">
|
|
<label class="theme-selector-label">
|
|
Theme
|
|
<select class="theme-selector" oninput="activateTheme(this.value)">
|
|
<option value="auto" selected>Auto</option>
|
|
<option value="light">Light</option>
|
|
<option value="dark">Dark</option>
|
|
</select>
|
|
</label> |</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
©
|
|
<a href="copyright.html">
|
|
|
|
Copyright
|
|
|
|
</a>
|
|
2001-2024, Python Software Foundation.
|
|
<br />
|
|
This page is licensed under the Python Software Foundation License Version 2.
|
|
<br />
|
|
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
|
|
<br />
|
|
|
|
See <a href="/license.html">History and License</a> for more information.<br />
|
|
|
|
|
|
<br />
|
|
|
|
The Python Software Foundation is a non-profit corporation.
|
|
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
|
<br />
|
|
<br />
|
|
Last updated on Jun 06, 2024 (19:11 UTC).
|
|
|
|
<a href="/bugs.html">Found a bug</a>?
|
|
|
|
<br />
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
|
|
</div>
|
|
|
|
</body>
|
|
</html> |