mirror of
https://github.com/pocketpy/pocketpy
synced 2026-05-06 18:23:38 +00:00
Deploy to GitHub pages
This commit is contained in:
github-actions[bot]
GitHub
commit
2cae24ad2c
234
404.html
Normal file
234
404.html
Normal file
@ -0,0 +1,234 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Not Found | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Not Found | Portable Python 3.x Interpreter in Modern C">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/404.html">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/404.html">
|
||||
<meta property="og:title" content="Not Found | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/404.html">
|
||||
<meta name="twitter:title" content="Not Found | Portable Python 3.x Interpreter in Modern C">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="/static/logo.png" />
|
||||
<link href="/resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="/resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="/resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="/static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="max-w-lg mx-auto mt-20 text-center px-6 sm:px-16 md:px-8">
|
||||
<div class="px-8 md:p-0 text-gray-300 dark:text-dark-650">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mx-auto mb-6" style="max-width: 313px" fill="currentColor" viewBox="0 0 313 164"><path d="M156.17 0c-22.28 0-48.83 10.93-48.83 63.03 0 52.36 26.55 63.35 48.83 63.35 22.28 0 48.83-10.99 48.83-63.35C205 10.93 178.45 0 156.17 0zm0 118.38c-27.47 0-40.83-18.1-40.83-55.35C115.35 26 128.7 8 156.17 8 183.65 8 197 26 197 63.03c0 37.24-13.35 55.35-40.83 55.35z"/><path d="M156.17 25.53c-22.03 0-22.03 24.4-22.03 37.5 0 13.22 0 37.82 22.03 37.82s22.03-24.6 22.03-37.82c0-13.11 0-37.5-22.03-37.5zm0 67.32c-10.49 0-14.03-7.53-14.03-29.82 0-21.78 3.67-29.5 14.03-29.5s14.03 7.72 14.03 29.5c0 22.3-3.54 29.82-14.03 29.82zM58.05 37.48a5.95 5.95 0 00-6.73 2.44l-20.51 31a5.986 5.986 0 00-.28 6.15 5.992 5.992 0 005.29 3.16h20.5c3.31 0 6-2.69 6-6v-31a5.95 5.95 0 00-4.27-5.75zm-3.72 34.75H39.54l14.78-22.35v22.35z"/><path d="M93.95 72.23h-6.8v-63c0-3.31-2.69-6-6-6H54.37c-1.96 0-3.8.96-4.92 2.56L1.08 74.98A5.946 5.946 0 000 78.42v18.91c0 3.31 2.69 6 6 6h46.45v14.29c0 3.31 2.69 6 6 6h22.69c3.31 0 6-2.69 6-6v-14.29h6.8c3.31 0 6-2.69 6-6v-19.1c.01-3.31-2.68-6-5.99-6zm-2 23.1h-6.8c-3.31 0-6 2.69-6 6v14.29h-18.7v-14.29c0-3.31-2.69-6-6-6H8V79.05l47.41-67.82h23.73v63c0 3.31 2.69 6 6 6h6.8v15.1zM306.95 72.23h-6.8v-63c0-3.31-2.69-6-6-6h-26.77c-1.96 0-3.8.96-4.92 2.56l-48.37 69.19a5.946 5.946 0 00-1.08 3.44v18.91c0 3.31 2.69 6 6 6h46.45v14.29c0 3.31 2.69 6 6 6h22.69c3.31 0 6-2.69 6-6v-14.29h6.8c3.31 0 6-2.69 6-6v-19.1c0-3.31-2.69-6-6-6zm-2 23.1h-6.8c-3.31 0-6 2.69-6 6v14.29h-18.69v-14.29c0-3.31-2.69-6-6-6H221V79.05l47.41-67.82h23.73v63c0 3.31 2.69 6 6 6h6.8v15.1z"/><path d="M271.05 37.48a5.95 5.95 0 00-6.73 2.44l-20.51 31a5.986 5.986 0 00-.28 6.15 5.992 5.992 0 005.29 3.16h20.5c3.31 0 6-2.69 6-6v-31a5.95 5.95 0 00-4.27-5.75zm-3.72 34.75h-14.78l14.78-22.35v22.35z"/><g><ellipse cx="158.97" cy="158.2" rx="36.9" ry="5.95"/></g></svg>
|
||||
</div>
|
||||
<h1 class="mb-6 text-2xl font-bold leading-tight text-gray-900 dark:text-white md:text-4xl">Oops! The page you’re looking for doesn’t exist.</h1>
|
||||
<p class="mb-10 text-gray-600 dark:text-dark-350 md:text-lg md:px-4">You may have mistyped the address or the page may have been moved.</p>
|
||||
<a href="/" class="inline-flex items-center justify-center h-12 px-4 text-sm leading-none text-button-primary-text bg-button-primary rounded shadow-xl focus:outline-hidden hover:bg-button-primary-hover transition-all duration-100 ease-linear">Go to homepage</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = null</script>
|
||||
</body>
|
||||
</html>
|
||||
283
bindings-cpp.md
Normal file
283
bindings-cpp.md
Normal file
@ -0,0 +1,283 @@
|
||||
## Quick Start
|
||||
|
||||
pkpy provides a [pybind11](https://pybind11.readthedocs.io/en/stable/) compatible layer which allows users to do convenient bindings.
|
||||
Header files are located in the `include/pybind11` directory. Make sure you have added `-Iinclude` to your compiler flags.
|
||||
|
||||
To begin with, use `py::scoped_interpreter guard{}` to start the interpreter before using any Python objects.
|
||||
Or explicitly call `py::interpreter::initialize()` and `py::interpreter::finalize()`.
|
||||
|
||||
### module
|
||||
|
||||
```cpp
|
||||
#include <pybind11/pybind11.h>
|
||||
namespace py = pybind11;
|
||||
|
||||
PYBIND11_EMBEDDED_MODULE(example, m) {
|
||||
m.def("add", [](int a, int b) {
|
||||
return a + b;
|
||||
});
|
||||
|
||||
auto math = m.def_submodule("math");
|
||||
}
|
||||
```
|
||||
|
||||
### function
|
||||
|
||||
```cpp
|
||||
int add(int a, int b) { return a + b; }
|
||||
|
||||
int add(int a, int b, int c) { return a + b + c; }
|
||||
|
||||
void register_function(py::module_& m)
|
||||
{
|
||||
m.def("add", py::overload_cast<int, int>(&add));
|
||||
|
||||
// support function overload
|
||||
m.def("add", py::overload_cast<int, int, int>(&add));
|
||||
|
||||
// bind with default arguments
|
||||
m.def("sub", [](int a, int b) {
|
||||
return a - b;
|
||||
}, py::arg("a") = 1, py::arg("b") = 2);
|
||||
|
||||
// bind *args
|
||||
m.def("add", [](py::args args) {
|
||||
int sum = 0;
|
||||
for (auto& arg : args) {
|
||||
sum += arg.cast<int>();
|
||||
}
|
||||
return sum;
|
||||
});
|
||||
|
||||
// bind **kwargs
|
||||
m.def("add", [](py::kwargs kwargs) {
|
||||
int sum = 0;
|
||||
for (auto item : kwargs) {
|
||||
sum += item.second.cast<int>();
|
||||
}
|
||||
return sum;
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### class
|
||||
|
||||
```cpp
|
||||
struct Point
|
||||
{
|
||||
const int x;
|
||||
int y;
|
||||
|
||||
public:
|
||||
Point() : x(0), y(0) {}
|
||||
|
||||
Point(int x, int y) : x(x), y(y) {}
|
||||
|
||||
Point(const Point& p) : x(p.x), y(p.y) {}
|
||||
|
||||
std::string stringfy() const {
|
||||
return "(" + std::to_string(x) + ", " + std::to_string(y) + ")";
|
||||
}
|
||||
};
|
||||
|
||||
struct Point3D : Point
|
||||
{
|
||||
private:
|
||||
int z;
|
||||
|
||||
public:
|
||||
Point3D(int x, int y, int z) : Point(x, y), z(z) {}
|
||||
|
||||
int get_z() const { return z; }
|
||||
|
||||
void set_z(int z) { this->z = z; }
|
||||
};
|
||||
|
||||
void bind_class(py::module_& m)
|
||||
{
|
||||
py::class_<Point>(m, "Point")
|
||||
.def(py::init<>())
|
||||
.def(py::init<int, int>())
|
||||
.def(py::init<const Point&>())
|
||||
.def_readonly("x", &Point::x)
|
||||
.def_readwrite("y", &Point::y)
|
||||
.def("__str__", &Point::stringfy);
|
||||
|
||||
// only support single inheritance
|
||||
py::class_<Point3D, Point>(m, "Point3D", py::dynamic_attr())
|
||||
.def(py::init<int, int, int>())
|
||||
.def_property("z", &Point3D::get_z, &Point3D::set_z);
|
||||
|
||||
// dynamic_attr will enable the dict of bound class
|
||||
}
|
||||
```
|
||||
|
||||
### operators
|
||||
|
||||
```cpp
|
||||
#include <pybind11/operators.h>
|
||||
namespace py = pybind11;
|
||||
|
||||
struct Int {
|
||||
int value;
|
||||
|
||||
Int(int value) : value(value) {}
|
||||
|
||||
Int operator+(const Int& other) const {
|
||||
return Int(value + other.value);
|
||||
}
|
||||
|
||||
Int operator-(const Int& other) const {
|
||||
return Int(value - other.value);
|
||||
}
|
||||
|
||||
bool operator==(const Int& other) const {
|
||||
return value == other.value;
|
||||
}
|
||||
|
||||
bool operator!=(const Int& other) const {
|
||||
return value != other.value;
|
||||
}
|
||||
};
|
||||
|
||||
void bind_operators(py::module_& m)
|
||||
{
|
||||
py::class_<Int>(m, "Int")
|
||||
.def(py::init<int>())
|
||||
.def(py::self + py::self)
|
||||
.def(py::self - py::self)
|
||||
.def(py::self == py::self)
|
||||
.def(py::self != py::self);
|
||||
// other operators are similar
|
||||
}
|
||||
```
|
||||
|
||||
### py::object
|
||||
|
||||
`py::object` is just simple wrapper around `PyVar`. It supports some convenient methods to interact with Python objects.
|
||||
|
||||
here are some common methods:
|
||||
|
||||
```cpp
|
||||
obj.attr("x"); // access attribute
|
||||
obj[1]; // access item
|
||||
|
||||
obj.is_none(); // same as obj is None in Python
|
||||
obj.is(obj2); // same as obj is obj2 in Python
|
||||
|
||||
// operators
|
||||
obj + obj2; // same as obj + obj2 in Python
|
||||
// ...
|
||||
obj == obj2; // same as obj == obj2 in Python
|
||||
// ...
|
||||
|
||||
obj(...); // same as obj.__call__(...)
|
||||
|
||||
py::cast(obj); // cast to Python object
|
||||
obj.cast<T>; // cast to C++ type
|
||||
|
||||
py::type::of(obj); // get type of obj
|
||||
py::type::of<T>(); // get type of T, if T is registered
|
||||
```
|
||||
|
||||
you can also create some builtin objects with their according wrappers:
|
||||
|
||||
```cpp
|
||||
py::bool_ b = {true};
|
||||
py::int_ i = {1};
|
||||
py::float_ f = {1.0};
|
||||
py::str s = {"hello"};
|
||||
py::list l = {1, 2, 3};
|
||||
py::tuple t = {1, 2, 3};
|
||||
// ...
|
||||
```
|
||||
|
||||
## More Examples
|
||||
|
||||
More examples please see the test [folder](https://github.com/pocketpy/gsoc-2024-dev/tree/main/pybind11/tests) in the GSoC repository. All tested features are supported.
|
||||
|
||||
## Limits and Comparison
|
||||
|
||||
This is a feature list of pybind11 for pocketpy. It lists all completed and pending features. It also lists the features that cannot be implemented in the current version of pocketpy.
|
||||
|
||||
### [Function](https://pybind11.readthedocs.io/en/stable/advanced/functions.html)
|
||||
|
||||
- [x] Function overloading
|
||||
- [x] Return value policy
|
||||
- [x] is_prepend
|
||||
- [x] `*args` and `**kwargs`
|
||||
- [ ] Keep-alive
|
||||
- [ ] Call Guard
|
||||
- [x] Default arguments
|
||||
- [ ] Keyword-Only arguments
|
||||
- [ ] Positional-Only arguments
|
||||
- [ ] Allow/Prohibiting None arguments
|
||||
|
||||
### [Class](https://pybind11.readthedocs.io/en/stable/classes.html)
|
||||
|
||||
- [x] Creating bindings for a custom type
|
||||
- [x] Binding lambda functions
|
||||
- [x] Dynamic attributes
|
||||
- [x] Inheritance and automatic downcasting
|
||||
- [x] Enumerations and internal types
|
||||
- [ ] Instance and static fields
|
||||
|
||||
> Binding static fields may never be implemented in pocketpy because it requires a metaclass, which is a heavy and infrequently used feature.
|
||||
|
||||
### [Exceptions](https://pybind11.readthedocs.io/en/stable/advanced/exceptions.html)
|
||||
|
||||
Need further discussion.
|
||||
|
||||
### [Smart pointers](https://pybind11.readthedocs.io/en/stable/advanced/smart_ptrs.html)
|
||||
|
||||
- [ ] std::shared_ptr
|
||||
- [ ] std::unique_ptr
|
||||
- [ ] Custom smart pointers
|
||||
|
||||
### [Type conversions](https://pybind11.readthedocs.io/en/stable/advanced/cast/index.html)
|
||||
|
||||
- [x] Python built-in types
|
||||
- [x] STL Containers
|
||||
- [ ] Functional
|
||||
- [ ] Chrono
|
||||
|
||||
### [Python C++ interface](https://pybind11.readthedocs.io/en/stable/advanced/pycpp/object.html)
|
||||
|
||||
Need further discussion.
|
||||
|
||||
- [x] `object`
|
||||
- [x] `none`
|
||||
- [x] `type`
|
||||
- [x] `bool_`
|
||||
- [x] `int_`
|
||||
- [x] `float_`
|
||||
- [x] `str`
|
||||
- [ ] `bytes`
|
||||
- [ ] `bytearray`
|
||||
- [x] `tuple`
|
||||
- [x] `list`
|
||||
- [ ] `set`
|
||||
- [x] `dict`
|
||||
- [ ] `slice`
|
||||
- [x] `iterable`
|
||||
- [x] `iterator`
|
||||
- [ ] `function`
|
||||
- [ ] `buffer`
|
||||
- [ ] `memoryview`
|
||||
- [x] `capsule`
|
||||
|
||||
### [Miscellaneous](https://pybind11.readthedocs.io/en/stable/advanced/misc.html)
|
||||
|
||||
- [ ] Global Interpreter Lock (GIL)
|
||||
- [ ] Binding sequence data types, iterators, the slicing protocol, etc.
|
||||
- [x] Convenient operators binding
|
||||
|
||||
### Differences between CPython and pocketpy
|
||||
|
||||
- only `add`, `sub` and `mul` have corresponding right versions in pocketpy. So if you bind `int() >> py::self`, it will has no effect in pocketpy.
|
||||
|
||||
- `__new__` and `__del__` are not supported in pocketpy.
|
||||
|
||||
- in-place operators, such as `+=`, `-=`, `*=`, etc., are not supported in pocketpy.
|
||||
|
||||
- the return value of `globals` is immutable in pocketpy.
|
||||
564
bindings-cpp/index.html
Normal file
564
bindings-cpp/index.html
Normal file
@ -0,0 +1,564 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Write C++ Bindings | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Write C++ Bindings | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="pkpy provides a pybind11 compatible layer which allows users to do convenient bindings. Header files are located in the include/pybind11 directory. Make sure you have added -Iinclude to your compiler flags.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/bindings-cpp/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/bindings-cpp/">
|
||||
<meta property="og:title" content="Write C++ Bindings | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="pkpy provides a pybind11 compatible layer which allows users to do convenient bindings. Header files are located in the include/pybind11 directory. Make sure you have added -Iinclude to your compiler flags.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/bindings-cpp/">
|
||||
<meta name="twitter:title" content="Write C++ Bindings | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="pkpy provides a pybind11 compatible layer which allows users to do convenient bindings. Header files are located in the include/pybind11 directory. Make sure you have added -Iinclude to your compiler flags.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/bindings-cpp.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../static/logo.png" />
|
||||
<link href="../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="write-c-bindings">Write C++ Bindings</h1>
|
||||
<h2 id="quick-start">Quick Start</h2>
|
||||
<p>pkpy provides a <a href="https://pybind11.readthedocs.io/en/stable/">pybind11</a> compatible layer which allows users to do convenient bindings.
|
||||
Header files are located in the <code translate="no" v-pre>include/pybind11</code> directory. Make sure you have added <code translate="no" v-pre>-Iinclude</code> to your compiler flags.</p>
|
||||
<p>To begin with, use <code translate="no" v-pre>py::scoped_interpreter guard{}</code> to start the interpreter before using any Python objects.
|
||||
Or explicitly call <code translate="no" v-pre>py::interpreter::initialize()</code> and <code translate="no" v-pre>py::interpreter::finalize()</code>.</p>
|
||||
<h3 id="module">module</h3>
|
||||
<div id="module-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-cpp"><code v-pre class="language-cpp">#include <pybind11/pybind11.h>
|
||||
namespace py = pybind11;
|
||||
|
||||
PYBIND11_EMBEDDED_MODULE(example, m) {
|
||||
m.def("add", [](int a, int b) {
|
||||
return a + b;
|
||||
});
|
||||
|
||||
auto math = m.def_submodule("math");
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="function">function</h3>
|
||||
<div id="function-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-cpp"><code v-pre class="language-cpp">int add(int a, int b) { return a + b; }
|
||||
|
||||
int add(int a, int b, int c) { return a + b + c; }
|
||||
|
||||
void register_function(py::module_& m)
|
||||
{
|
||||
m.def("add", py::overload_cast<int, int>(&add));
|
||||
|
||||
// support function overload
|
||||
m.def("add", py::overload_cast<int, int, int>(&add));
|
||||
|
||||
// bind with default arguments
|
||||
m.def("sub", [](int a, int b) {
|
||||
return a - b;
|
||||
}, py::arg("a") = 1, py::arg("b") = 2);
|
||||
|
||||
// bind *args
|
||||
m.def("add", [](py::args args) {
|
||||
int sum = 0;
|
||||
for (auto& arg : args) {
|
||||
sum += arg.cast<int>();
|
||||
}
|
||||
return sum;
|
||||
});
|
||||
|
||||
// bind **kwargs
|
||||
m.def("add", [](py::kwargs kwargs) {
|
||||
int sum = 0;
|
||||
for (auto item : kwargs) {
|
||||
sum += item.second.cast<int>();
|
||||
}
|
||||
return sum;
|
||||
});
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="class">class</h3>
|
||||
<div id="class-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-cpp"><code v-pre class="language-cpp">struct Point
|
||||
{
|
||||
const int x;
|
||||
int y;
|
||||
|
||||
public:
|
||||
Point() : x(0), y(0) {}
|
||||
|
||||
Point(int x, int y) : x(x), y(y) {}
|
||||
|
||||
Point(const Point& p) : x(p.x), y(p.y) {}
|
||||
|
||||
std::string stringfy() const {
|
||||
return "(" + std::to_string(x) + ", " + std::to_string(y) + ")";
|
||||
}
|
||||
};
|
||||
|
||||
struct Point3D : Point
|
||||
{
|
||||
private:
|
||||
int z;
|
||||
|
||||
public:
|
||||
Point3D(int x, int y, int z) : Point(x, y), z(z) {}
|
||||
|
||||
int get_z() const { return z; }
|
||||
|
||||
void set_z(int z) { this->z = z; }
|
||||
};
|
||||
|
||||
void bind_class(py::module_& m)
|
||||
{
|
||||
py::class_<Point>(m, "Point")
|
||||
.def(py::init<>())
|
||||
.def(py::init<int, int>())
|
||||
.def(py::init<const Point&>())
|
||||
.def_readonly("x", &Point::x)
|
||||
.def_readwrite("y", &Point::y)
|
||||
.def("__str__", &Point::stringfy);
|
||||
|
||||
// only support single inheritance
|
||||
py::class_<Point3D, Point>(m, "Point3D", py::dynamic_attr())
|
||||
.def(py::init<int, int, int>())
|
||||
.def_property("z", &Point3D::get_z, &Point3D::set_z);
|
||||
|
||||
// dynamic_attr will enable the dict of bound class
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="operators">operators</h3>
|
||||
<div id="operators-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-cpp"><code v-pre class="language-cpp">#include <pybind11/operators.h>
|
||||
namespace py = pybind11;
|
||||
|
||||
struct Int {
|
||||
int value;
|
||||
|
||||
Int(int value) : value(value) {}
|
||||
|
||||
Int operator+(const Int& other) const {
|
||||
return Int(value + other.value);
|
||||
}
|
||||
|
||||
Int operator-(const Int& other) const {
|
||||
return Int(value - other.value);
|
||||
}
|
||||
|
||||
bool operator==(const Int& other) const {
|
||||
return value == other.value;
|
||||
}
|
||||
|
||||
bool operator!=(const Int& other) const {
|
||||
return value != other.value;
|
||||
}
|
||||
};
|
||||
|
||||
void bind_operators(py::module_& m)
|
||||
{
|
||||
py::class_<Int>(m, "Int")
|
||||
.def(py::init<int>())
|
||||
.def(py::self + py::self)
|
||||
.def(py::self - py::self)
|
||||
.def(py::self == py::self)
|
||||
.def(py::self != py::self);
|
||||
// other operators are similar
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="pyobject">py::object</h3>
|
||||
<p><code translate="no" v-pre>py::object</code> is just simple wrapper around <code translate="no" v-pre>PyVar</code>. It supports some convenient methods to interact with Python objects.</p>
|
||||
<p>here are some common methods:</p>
|
||||
<div id="pyobject-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-cpp"><code v-pre class="language-cpp">obj.attr("x"); // access attribute
|
||||
obj[1]; // access item
|
||||
|
||||
obj.is_none(); // same as obj is None in Python
|
||||
obj.is(obj2); // same as obj is obj2 in Python
|
||||
|
||||
// operators
|
||||
obj + obj2; // same as obj + obj2 in Python
|
||||
// ...
|
||||
obj == obj2; // same as obj == obj2 in Python
|
||||
// ...
|
||||
|
||||
obj(...); // same as obj.__call__(...)
|
||||
|
||||
py::cast(obj); // cast to Python object
|
||||
obj.cast<T>; // cast to C++ type
|
||||
|
||||
py::type::of(obj); // get type of obj
|
||||
py::type::of<T>(); // get type of T, if T is registered</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>you can also create some builtin objects with their according wrappers:</p>
|
||||
<div id="pyobject-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-cpp"><code v-pre class="language-cpp">py::bool_ b = {true};
|
||||
py::int_ i = {1};
|
||||
py::float_ f = {1.0};
|
||||
py::str s = {"hello"};
|
||||
py::list l = {1, 2, 3};
|
||||
py::tuple t = {1, 2, 3};
|
||||
// ...</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="more-examples">More Examples</h2>
|
||||
<p>More examples please see the test <a href="https://github.com/pocketpy/gsoc-2024-dev/tree/main/pybind11/tests">folder</a> in the GSoC repository. All tested features are supported.</p>
|
||||
<h2 id="limits-and-comparison">Limits and Comparison</h2>
|
||||
<p>This is a feature list of pybind11 for pocketpy. It lists all completed and pending features. It also lists the features that cannot be implemented in the current version of pocketpy.</p>
|
||||
<h3 id="function-1"><a href="https://pybind11.readthedocs.io/en/stable/advanced/functions.html">Function</a></h3>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Function overloading</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Return value policy</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> is_prepend</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>*args</code> and <code translate="no" v-pre>**kwargs</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Keep-alive</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Call Guard</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Default arguments</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Keyword-Only arguments</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Positional-Only arguments</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Allow/Prohibiting None arguments</li>
|
||||
</ul>
|
||||
<h3 id="class-1"><a href="https://pybind11.readthedocs.io/en/stable/classes.html">Class</a></h3>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Creating bindings for a custom type</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Binding lambda functions</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Dynamic attributes</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Inheritance and automatic downcasting</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Enumerations and internal types</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Instance and static fields</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p>Binding static fields may never be implemented in pocketpy because it requires a metaclass, which is a heavy and infrequently used feature.</p>
|
||||
</blockquote>
|
||||
<h3 id="exceptions"><a href="https://pybind11.readthedocs.io/en/stable/advanced/exceptions.html">Exceptions</a></h3>
|
||||
<p>Need further discussion.</p>
|
||||
<h3 id="smart-pointers"><a href="https://pybind11.readthedocs.io/en/stable/advanced/smart_ptrs.html">Smart pointers</a></h3>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> std::shared_ptr</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> std::unique_ptr</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Custom smart pointers</li>
|
||||
</ul>
|
||||
<h3 id="type-conversions"><a href="https://pybind11.readthedocs.io/en/stable/advanced/cast/index.html">Type conversions</a></h3>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Python built-in types</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> STL Containers</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Functional</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Chrono</li>
|
||||
</ul>
|
||||
<h3 id="python-c-interface"><a href="https://pybind11.readthedocs.io/en/stable/advanced/pycpp/object.html">Python C++ interface</a></h3>
|
||||
<p>Need further discussion.</p>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>object</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>none</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>type</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>bool_</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>int_</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>float_</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>str</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>bytes</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>bytearray</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>tuple</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>list</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>set</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>dict</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>slice</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>iterable</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>iterator</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>function</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>buffer</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>memoryview</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>capsule</code></li>
|
||||
</ul>
|
||||
<h3 id="miscellaneous"><a href="https://pybind11.readthedocs.io/en/stable/advanced/misc.html">Miscellaneous</a></h3>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Global Interpreter Lock (GIL)</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> Binding sequence data types, iterators, the slicing protocol, etc.</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> Convenient operators binding</li>
|
||||
</ul>
|
||||
<h3 id="differences-between-cpython-and-pocketpy">Differences between CPython and pocketpy</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<p>only <code translate="no" v-pre>add</code>, <code translate="no" v-pre>sub</code> and <code translate="no" v-pre>mul</code> have corresponding right versions in pocketpy. So if you bind <code translate="no" v-pre>int() >> py::self</code>, it will has no effect in pocketpy.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>__new__</code> and <code translate="no" v-pre>__del__</code> are not supported in pocketpy.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>in-place operators, such as <code translate="no" v-pre>+=</code>, <code translate="no" v-pre>-=</code>, <code translate="no" v-pre>*=</code>, etc., are not supported in pocketpy.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>the return value of <code translate="no" v-pre>globals</code> is immutable in pocketpy.</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../bindings/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Write C Bindings</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../features/basic/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Basic Features</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Write C++ Bindings", level: 1, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/bindings-cpp.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
62
bindings.md
Normal file
62
bindings.md
Normal file
@ -0,0 +1,62 @@
|
||||
In order to use a C/C++ library in python, you need to write bindings for it.
|
||||
|
||||
pkpy uses an universal signature to wrap a C function pointer as a python function or method, i.e `py_CFunction`.
|
||||
|
||||
```c
|
||||
typedef bool (*py_CFunction)(int argc, py_Ref argv);
|
||||
```
|
||||
+ `argc` is the number of arguments passed to the function.
|
||||
+ `argv` is the pointer to the first argument.
|
||||
|
||||
If successful, the function should return `true` and set the return value in `py_retval()`. In case there is no return value, you should use `py_newnone(py_retval())`.
|
||||
If an error occurs, the function should raise an exception and return `false`.
|
||||
|
||||
## Steps
|
||||
|
||||
Say you have a function `add` that takes two integers and returns their sum.
|
||||
```c
|
||||
int add(int a, int b) {
|
||||
return a + b;
|
||||
}
|
||||
```
|
||||
|
||||
Here is how you can write the binding for it:
|
||||
```c
|
||||
// 1. Define a wrapper function with the signature `py_CFunction`.
|
||||
bool py_add(int argc, py_Ref argv) {
|
||||
// 2. Check the number of arguments.
|
||||
PY_CHECK_ARGC(2);
|
||||
// 3. Check the type of arguments.
|
||||
PY_CHECK_ARG_TYPE(0, tp_int);
|
||||
PY_CHECK_ARG_TYPE(1, tp_int);
|
||||
// 4. Convert the arguments into C types.
|
||||
int _0 = py_toint(py_arg(0));
|
||||
int _1 = py_toint(py_arg(1));
|
||||
// 5. Call the original function.
|
||||
int res = add(_0, _1);
|
||||
// 6. Set the return value.
|
||||
py_newint(py_retval(), res);
|
||||
// 7. Return `true`.
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
Once you have the wrapper function, you can bind it to a python module via `py_bindfunc`.
|
||||
```c
|
||||
py_GlobalRef mod = py_getmodule("__main__");
|
||||
py_bindfunc(mod, "add", py_add);
|
||||
```
|
||||
|
||||
Alternatively, you can use `py_bind` with a signature, which allows you to specify some default values.
|
||||
```c
|
||||
py_GlobalRef mod = py_getmodule("__main__");
|
||||
py_bind(mod, "add(a, b=1)", py_add);
|
||||
```
|
||||
|
||||
See also:
|
||||
+ [`py_bind`](/c-api/functions/#py_bind)
|
||||
+ [`py_bindmethod`](/c-api/functions/#py_bindmethod)
|
||||
+ [`py_bindfunc`](/c-api/functions/#py_bindfunc)
|
||||
+ [`py_bindproperty`](/c-api/functions/#py_bindproperty)
|
||||
+ [`py_newmodule`](/c-api/functions/#py_newmodule)
|
||||
+ [`py_newtype`](/c-api/functions/#py_newtype)
|
||||
355
bindings/index.html
Normal file
355
bindings/index.html
Normal file
@ -0,0 +1,355 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Write C Bindings | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Write C Bindings | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="In order to use a C/C++ library in python, you need to write bindings for it.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/bindings/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/bindings/">
|
||||
<meta property="og:title" content="Write C Bindings | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="In order to use a C/C++ library in python, you need to write bindings for it.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/bindings/">
|
||||
<meta name="twitter:title" content="Write C Bindings | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="In order to use a C/C++ library in python, you need to write bindings for it.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/bindings.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../static/logo.png" />
|
||||
<link href="../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="write-c-bindings">Write C Bindings</h1>
|
||||
<p>In order to use a C/C++ library in python, you need to write bindings for it.</p>
|
||||
<p>pkpy uses an universal signature to wrap a C function pointer as a python function or method, i.e <code translate="no" v-pre>py_CFunction</code>.</p>
|
||||
<div id="write-c-bindings-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">typedef bool (*py_CFunction)(int argc, py_Ref argv);</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>argc</code> is the number of arguments passed to the function.</li>
|
||||
<li><code translate="no" v-pre>argv</code> is the pointer to the first argument.</li>
|
||||
</ul>
|
||||
<p>If successful, the function should return <code translate="no" v-pre>true</code> and set the return value in <code translate="no" v-pre>py_retval()</code>. In case there is no return value, you should use <code translate="no" v-pre>py_newnone(py_retval())</code>.
|
||||
If an error occurs, the function should raise an exception and return <code translate="no" v-pre>false</code>.</p>
|
||||
<h2 id="steps">Steps</h2>
|
||||
<p>Say you have a function <code translate="no" v-pre>add</code> that takes two integers and returns their sum.</p>
|
||||
<div id="steps-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">int add(int a, int b) {
|
||||
return a + b;
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>Here is how you can write the binding for it:</p>
|
||||
<div id="steps-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">// 1. Define a wrapper function with the signature `py_CFunction`.
|
||||
bool py_add(int argc, py_Ref argv) {
|
||||
// 2. Check the number of arguments.
|
||||
PY_CHECK_ARGC(2);
|
||||
// 3. Check the type of arguments.
|
||||
PY_CHECK_ARG_TYPE(0, tp_int);
|
||||
PY_CHECK_ARG_TYPE(1, tp_int);
|
||||
// 4. Convert the arguments into C types.
|
||||
int _0 = py_toint(py_arg(0));
|
||||
int _1 = py_toint(py_arg(1));
|
||||
// 5. Call the original function.
|
||||
int res = add(_0, _1);
|
||||
// 6. Set the return value.
|
||||
py_newint(py_retval(), res);
|
||||
// 7. Return `true`.
|
||||
return true;
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>Once you have the wrapper function, you can bind it to a python module via <code translate="no" v-pre>py_bindfunc</code>.</p>
|
||||
<div id="steps-code-3" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">py_GlobalRef mod = py_getmodule("__main__");
|
||||
py_bindfunc(mod, "add", py_add);</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>Alternatively, you can use <code translate="no" v-pre>py_bind</code> with a signature, which allows you to specify some default values.</p>
|
||||
<div id="steps-code-4" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">py_GlobalRef mod = py_getmodule("__main__");
|
||||
py_bind(mod, "add(a, b=1)", py_add);</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>See also:</p>
|
||||
<ul>
|
||||
<li><a href="../c-api/functions/#py_bind"><code translate="no" v-pre>py_bind</code></a></li>
|
||||
<li><a href="../c-api/functions/#py_bindmethod"><code translate="no" v-pre>py_bindmethod</code></a></li>
|
||||
<li><a href="../c-api/functions/#py_bindfunc"><code translate="no" v-pre>py_bindfunc</code></a></li>
|
||||
<li><a href="../c-api/functions/#py_bindproperty"><code translate="no" v-pre>py_bindproperty</code></a></li>
|
||||
<li><a href="../c-api/functions/#py_newmodule"><code translate="no" v-pre>py_newmodule</code></a></li>
|
||||
<li><a href="../c-api/functions/#py_newtype"><code translate="no" v-pre>py_newtype</code></a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../quick-start/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Quick Start</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../bindings-cpp/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Write C++ Bindings</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Write C Bindings", level: 1, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/bindings.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
1514
c-api/functions.md
Normal file
1514
c-api/functions.md
Normal file
File diff suppressed because it is too large
Load Diff
1816
c-api/functions/index.html
Normal file
1816
c-api/functions/index.html
Normal file
File diff suppressed because it is too large
Load Diff
55
c-api/introduction.md
Normal file
55
c-api/introduction.md
Normal file
@ -0,0 +1,55 @@
|
||||
All public functions in the C API are prefixed with `py_` in [pocketpy.h](https://github.com/pocketpy/pocketpy/blob/main/include/pocketpy/pocketpy.h).
|
||||
|
||||
## Overview
|
||||
|
||||
pocketpy works with opaque references. `py_Ref` is used to reference objects in the virtual machine. It is your responsibility to ensure a reference is valid before using it. See following reference types:
|
||||
|
||||
```c
|
||||
/// A generic reference to a python object.
|
||||
typedef py_TValue* py_Ref;
|
||||
/// A reference which has the same lifespan as the python object.
|
||||
typedef py_TValue* py_ObjectRef;
|
||||
/// A global reference which has the same lifespan as the VM.
|
||||
typedef py_TValue* py_GlobalRef;
|
||||
/// A specific location in the value stack of the VM.
|
||||
typedef py_TValue* py_StackRef;
|
||||
/// An item reference to a container object. It invalidates when the container is modified.
|
||||
typedef py_TValue* py_ItemRef;
|
||||
/// An output reference for returning a value.
|
||||
typedef py_TValue* py_OutRef;
|
||||
```
|
||||
|
||||
You can store python objects into "stack" or "register".
|
||||
We provide 8 registers and you can get references to them by `py_reg()`.
|
||||
Also, `py_retval()` is a special register that is used to store the return value of a `py_CFunction`.
|
||||
Registers are shared so they could be overwritten easily.
|
||||
If you want to store python objects across function calls, you should store them into the stack via `py_push()` and `py_pop()`.
|
||||
|
||||
## Data Types
|
||||
|
||||
You can do conversions between C types and python objects using the following functions:
|
||||
|
||||
| C type | Python type | C to Python | Python to C |
|
||||
| ------------------- | ----------- | --------------- | -------------------------------- |
|
||||
| char,short,int,long | int | `py_newint()` | `py_toint()` |
|
||||
| float,double | float | `py_newfloat()` | `py_tofloat()`, `py_castfloat()` |
|
||||
| bool | bool | `py_newbool()` | `py_tobool()` |
|
||||
| const char* | str | `py_newstr()` | `py_tostr()` |
|
||||
| void*,intptr_t | int | `py_newint()` | `(void*)py_toint()` |
|
||||
|
||||
---
|
||||
|
||||
### `PY_RAISE` macro
|
||||
|
||||
Mark a function that can raise an exception on failure.
|
||||
|
||||
+ If the function returns `bool`, then `false` means an exception is raised.
|
||||
+ If the function returns `int`, then `-1` means an exception is raised.
|
||||
|
||||
### `PY_RETURN` macro
|
||||
|
||||
Mark a function that can store a value in `py_retval()` on success.
|
||||
|
||||
### `PY_MAYBENULL` macro
|
||||
|
||||
Mark a variable or callback function that may be `NULL`.
|
||||
377
c-api/introduction/index.html
Normal file
377
c-api/introduction/index.html
Normal file
@ -0,0 +1,377 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Introduction | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Introduction | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="All public functions in the C API are prefixed with py_ in pocketpy.h.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/c-api/introduction/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/c-api/introduction/">
|
||||
<meta property="og:title" content="Introduction | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="All public functions in the C API are prefixed with py_ in pocketpy.h.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/c-api/introduction/">
|
||||
<meta name="twitter:title" content="Introduction | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="All public functions in the C API are prefixed with py_ in pocketpy.h.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/c-api/introduction.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="introduction">Introduction</h1>
|
||||
<p>All public functions in the C API are prefixed with <code translate="no" v-pre>py_</code> in <a href="https://github.com/pocketpy/pocketpy/blob/main/include/pocketpy/pocketpy.h">pocketpy.h</a>.</p>
|
||||
<h2 id="overview">Overview</h2>
|
||||
<p>pocketpy works with opaque references. <code translate="no" v-pre>py_Ref</code> is used to reference objects in the virtual machine. It is your responsibility to ensure a reference is valid before using it. See following reference types:</p>
|
||||
<div id="overview-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">/// A generic reference to a python object.
|
||||
typedef py_TValue* py_Ref;
|
||||
/// A reference which has the same lifespan as the python object.
|
||||
typedef py_TValue* py_ObjectRef;
|
||||
/// A global reference which has the same lifespan as the VM.
|
||||
typedef py_TValue* py_GlobalRef;
|
||||
/// A specific location in the value stack of the VM.
|
||||
typedef py_TValue* py_StackRef;
|
||||
/// An item reference to a container object. It invalidates when the container is modified.
|
||||
typedef py_TValue* py_ItemRef;
|
||||
/// An output reference for returning a value.
|
||||
typedef py_TValue* py_OutRef;</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>You can store python objects into "stack" or "register".
|
||||
We provide 8 registers and you can get references to them by <code translate="no" v-pre>py_reg()</code>.
|
||||
Also, <code translate="no" v-pre>py_retval()</code> is a special register that is used to store the return value of a <code translate="no" v-pre>py_CFunction</code>.
|
||||
Registers are shared so they could be overwritten easily.
|
||||
If you want to store python objects across function calls, you should store them into the stack via <code translate="no" v-pre>py_push()</code> and <code translate="no" v-pre>py_pop()</code>.</p>
|
||||
<h2 id="data-types">Data Types</h2>
|
||||
<p>You can do conversions between C types and python objects using the following functions:</p>
|
||||
<div class="table-wrapper scrollbar overflow-hidden">
|
||||
<table class="comfortable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>C type</th>
|
||||
<th>Python type</th>
|
||||
<th>C to Python</th>
|
||||
<th>Python to C</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>char,short,int,long</td>
|
||||
<td>int</td>
|
||||
<td><code translate="no" v-pre>py_newint()</code></td>
|
||||
<td><code translate="no" v-pre>py_toint()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>float,double</td>
|
||||
<td>float</td>
|
||||
<td><code translate="no" v-pre>py_newfloat()</code></td>
|
||||
<td><code translate="no" v-pre>py_tofloat()</code>, <code translate="no" v-pre>py_castfloat()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>bool</td>
|
||||
<td>bool</td>
|
||||
<td><code translate="no" v-pre>py_newbool()</code></td>
|
||||
<td><code translate="no" v-pre>py_tobool()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>const char*</td>
|
||||
<td>str</td>
|
||||
<td><code translate="no" v-pre>py_newstr()</code></td>
|
||||
<td><code translate="no" v-pre>py_tostr()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>void*,intptr_t</td>
|
||||
<td>int</td>
|
||||
<td><code translate="no" v-pre>py_newint()</code></td>
|
||||
<td><code translate="no" v-pre>(void*)py_toint()</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<hr>
|
||||
<h3 id="py_raise-macro"><code translate="no" v-pre>PY_RAISE</code> macro</h3>
|
||||
<p>Mark a function that can raise an exception on failure.</p>
|
||||
<ul>
|
||||
<li>If the function returns <code translate="no" v-pre>bool</code>, then <code translate="no" v-pre>false</code> means an exception is raised.</li>
|
||||
<li>If the function returns <code translate="no" v-pre>int</code>, then <code translate="no" v-pre>-1</code> means an exception is raised.</li>
|
||||
</ul>
|
||||
<h3 id="py_return-macro"><code translate="no" v-pre>PY_RETURN</code> macro</h3>
|
||||
<p>Mark a function that can store a value in <code translate="no" v-pre>py_retval()</code> on success.</p>
|
||||
<h3 id="py_maybenull-macro"><code translate="no" v-pre>PY_MAYBENULL</code> macro</h3>
|
||||
<p>Mark a variable or callback function that may be <code translate="no" v-pre>NULL</code>.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/ub/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Undefined Behaviour</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../c-api/functions/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Functions</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Introduction", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/c-api/introduction.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
215
coding-style-guide.md
Normal file
215
coding-style-guide.md
Normal file
@ -0,0 +1,215 @@
|
||||
## Indentation
|
||||
|
||||
Use four spaces for indentation. Do not use `TAB`.
|
||||
|
||||
## Strings
|
||||
|
||||
```python
|
||||
# Prefer single quotes for strings
|
||||
s = 'this is a string'
|
||||
|
||||
# Use double quotes only if the string itself contains a single quote
|
||||
s = "this ' is single quote"
|
||||
```
|
||||
|
||||
## Docstrings
|
||||
|
||||
Always use triple quotes for docstrings.
|
||||
|
||||
```python
|
||||
def f():
|
||||
"""This is a multi-line docstring.
|
||||
|
||||
Here is some content. Docstrings partially support Markdown.
|
||||
"""
|
||||
|
||||
def g():
|
||||
"""This is a single-line docstring."""
|
||||
```
|
||||
|
||||
Use natural language to describe the function's purpose. Do not enumerate each parameter and return value.
|
||||
|
||||
```python
|
||||
# Correct
|
||||
def add(a: int, b: int):
|
||||
"""Add two integers `a` and `b`."""
|
||||
|
||||
# Incorrect
|
||||
def add(a: int, b: int):
|
||||
"""
|
||||
@param a, the first argument
|
||||
@param b, the second argument
|
||||
@return, the result of a + b
|
||||
"""
|
||||
```
|
||||
|
||||
## Spaces
|
||||
|
||||
```python
|
||||
# Add a space after `,` or `:`
|
||||
a, b = 1, 2
|
||||
c = [1, 2, 3]
|
||||
d = {'key': 'value'}
|
||||
|
||||
# Spaces may be added around operators
|
||||
res = 1 + 2
|
||||
if res < 2: pass
|
||||
# Spaces can also be selectively added to indicate operator precedence
|
||||
x = x * 2 - 1
|
||||
hypot2 = x * x + y * y
|
||||
c = (a + b) * (a - b)
|
||||
|
||||
# Add a space after `:` in type annotations
|
||||
def f(a: int, b: float): ...
|
||||
def g() -> int: ...
|
||||
|
||||
# Add spaces around `=` when specifying default values in function parameters
|
||||
def f(a: int = 1, b: int | None = None): ...
|
||||
# However, omit spaces if the parameter has no type annotation
|
||||
def f(a=1, b=2): pass
|
||||
|
||||
# Do not add spaces in keyword arguments when calling functions
|
||||
print(1, 2, 3, end='', sep=',')
|
||||
f(a=10, b=20)
|
||||
```
|
||||
|
||||
## Naming Conventions
|
||||
|
||||
+ Classes: `CapitalizedWords`
|
||||
+ Functions and variables: `lower_case_with_underscores`
|
||||
+ Constants and enums: `UPPER_CASE_WITH_UNDERSCORES` or `CapitalizedWords`
|
||||
+ Anonymous ordered variables: `_0`, `_1`, `_2`
|
||||
+ Discarded variables: `_`
|
||||
+ Some standard library functions: `lowercase`
|
||||
|
||||
Here are some commonly used naming conventions:
|
||||
+ `self`: The first parameter of an instance method
|
||||
+ `cls`: The first parameter of class methods and `__new__`
|
||||
|
||||
### Using Abbreviations
|
||||
|
||||
Use abbreviations only for temporary variables and internal implementations.
|
||||
|
||||
Abbreviations should be well-established, include key syllables of the original word, and be immediately recognizable.
|
||||
|
||||
* `context` -> `ctx` (✔)
|
||||
* `temporary` -> `tmp` (✔)
|
||||
* `distribution` -> `dist` (✔)
|
||||
* `visited` -> `vis` (❌)
|
||||
|
||||
```python
|
||||
# Incorrect: Using abbreviations in public function parameters
|
||||
def some_pub_fn(ctx, req_id, data):
|
||||
pass
|
||||
|
||||
# Correct
|
||||
def some_public_function(context, request_id, data):
|
||||
pass
|
||||
```
|
||||
|
||||
### Using Precise Terminology
|
||||
|
||||
Naming should convey precise meanings, especially when multiple synonyms exist.
|
||||
|
||||
For example, `count`, `size`, and `length` all relate to quantity, but they have different nuances:
|
||||
|
||||
+ `count`: Represents a counted value
|
||||
+ `length`: Represents the number of elements in a container
|
||||
+ `size`: Represents the byte size of an object
|
||||
|
||||
```python
|
||||
s = 'aaabc⭐'
|
||||
count = s.count('a')
|
||||
length = len(s)
|
||||
size = len(s.encode())
|
||||
|
||||
print(f"{s!r} has a length of {length}, a size of {size} bytes, and contains {count} occurrences of 'a'")
|
||||
# 'aaabc⭐' has a length of 6, a size of 8 bytes, and contains 3 occurrences of 'a'
|
||||
```
|
||||
|
||||
### Using Professional Terminology
|
||||
|
||||
+ For item quantities in a game: `quantity` is better than `item_count`
|
||||
+ For grid counts: `area` (meaning surface area) is better than `grid_count`
|
||||
|
||||
### Avoiding Built-in Names
|
||||
|
||||
```python
|
||||
# Incorrect: Overwriting `builtins.map`
|
||||
map = [[1, 2, 3], [4, 5, 6]]
|
||||
# Incorrect: Overwriting `builtins.type`
|
||||
type = some_thing.type
|
||||
```
|
||||
|
||||
### Internal Functions and Classes
|
||||
|
||||
Use a single underscore `_` as a prefix for internal functions. Never use a double underscore `__` (except for magic methods).
|
||||
|
||||
```python
|
||||
def _internal_func():
|
||||
"""This is an internal function."""
|
||||
|
||||
class _InternalClass:
|
||||
def _internal_f(self): pass
|
||||
```
|
||||
|
||||
## Importing Modules
|
||||
|
||||
1. Import standard library modules first.
|
||||
2. Then import third-party dependencies.
|
||||
3. Finally, import project-specific modules.
|
||||
|
||||
```python
|
||||
from typing import Any
|
||||
from collections import deque
|
||||
|
||||
from array2d import array2d
|
||||
|
||||
from ..utils import logger
|
||||
```
|
||||
|
||||
## Coding Practices
|
||||
|
||||
Use `is not` when checking for `None`. Do not explicitly compare with `True` or `False`.
|
||||
|
||||
```python
|
||||
# Correct
|
||||
if x is not None: pass
|
||||
|
||||
# Incorrect
|
||||
if x != None: pass
|
||||
|
||||
# Correct
|
||||
x = True
|
||||
if x: pass
|
||||
if not x: pass
|
||||
|
||||
# Incorrect
|
||||
if x == True: pass
|
||||
if x is True: pass
|
||||
if x != False: pass
|
||||
```
|
||||
|
||||
The `if` statement implicitly calls `bool()`, so it can be used to check if a container is empty.
|
||||
|
||||
```python
|
||||
not_empty_list = [1]
|
||||
not_empty_string = '1'
|
||||
truth = True
|
||||
|
||||
if not_empty_list:
|
||||
print('true value')
|
||||
|
||||
if not_empty_string:
|
||||
print('true value')
|
||||
|
||||
if truth:
|
||||
print('true value')
|
||||
|
||||
# Explicitly checking for emptiness is also valid
|
||||
if len(not_empty_list) > 0: pass
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
[PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/)
|
||||
485
coding-style-guide/index.html
Normal file
485
coding-style-guide/index.html
Normal file
@ -0,0 +1,485 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Coding Style Guide | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Coding Style Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Use four spaces for indentation. Do not use TAB.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/coding-style-guide/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/coding-style-guide/">
|
||||
<meta property="og:title" content="Coding Style Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Use four spaces for indentation. Do not use TAB.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/coding-style-guide/">
|
||||
<meta name="twitter:title" content="Coding Style Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Use four spaces for indentation. Do not use TAB.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/coding-style-guide.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../static/logo.png" />
|
||||
<link href="../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="coding-style-guide">Coding Style Guide</h1>
|
||||
<h2 id="indentation">Indentation</h2>
|
||||
<p>Use four spaces for indentation. Do not use <code translate="no" v-pre>TAB</code>.</p>
|
||||
<h2 id="strings">Strings</h2>
|
||||
<div id="strings-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Prefer single quotes for strings
|
||||
s = 'this is a string'
|
||||
|
||||
# Use double quotes only if the string itself contains a single quote
|
||||
s = "this ' is single quote"</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="docstrings">Docstrings</h2>
|
||||
<p>Always use triple quotes for docstrings.</p>
|
||||
<div id="docstrings-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">def f():
|
||||
"""This is a multi-line docstring.
|
||||
|
||||
Here is some content. Docstrings partially support Markdown.
|
||||
"""
|
||||
|
||||
def g():
|
||||
"""This is a single-line docstring."""</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>Use natural language to describe the function's purpose. Do not enumerate each parameter and return value.</p>
|
||||
<div id="docstrings-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Correct
|
||||
def add(a: int, b: int):
|
||||
"""Add two integers `a` and `b`."""
|
||||
|
||||
# Incorrect
|
||||
def add(a: int, b: int):
|
||||
"""
|
||||
@param a, the first argument
|
||||
@param b, the second argument
|
||||
@return, the result of a + b
|
||||
"""</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="spaces">Spaces</h2>
|
||||
<div id="spaces-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Add a space after `,` or `:`
|
||||
a, b = 1, 2
|
||||
c = [1, 2, 3]
|
||||
d = {'key': 'value'}
|
||||
|
||||
# Spaces may be added around operators
|
||||
res = 1 + 2
|
||||
if res < 2: pass
|
||||
# Spaces can also be selectively added to indicate operator precedence
|
||||
x = x * 2 - 1
|
||||
hypot2 = x * x + y * y
|
||||
c = (a + b) * (a - b)
|
||||
|
||||
# Add a space after `:` in type annotations
|
||||
def f(a: int, b: float): ...
|
||||
def g() -> int: ...
|
||||
|
||||
# Add spaces around `=` when specifying default values in function parameters
|
||||
def f(a: int = 1, b: int | None = None): ...
|
||||
# However, omit spaces if the parameter has no type annotation
|
||||
def f(a=1, b=2): pass
|
||||
|
||||
# Do not add spaces in keyword arguments when calling functions
|
||||
print(1, 2, 3, end='', sep=',')
|
||||
f(a=10, b=20)</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="naming-conventions">Naming Conventions</h2>
|
||||
<ul>
|
||||
<li>Classes: <code translate="no" v-pre>CapitalizedWords</code></li>
|
||||
<li>Functions and variables: <code translate="no" v-pre>lower_case_with_underscores</code></li>
|
||||
<li>Constants and enums: <code translate="no" v-pre>UPPER_CASE_WITH_UNDERSCORES</code> or <code translate="no" v-pre>CapitalizedWords</code></li>
|
||||
<li>Anonymous ordered variables: <code translate="no" v-pre>_0</code>, <code translate="no" v-pre>_1</code>, <code translate="no" v-pre>_2</code></li>
|
||||
<li>Discarded variables: <code translate="no" v-pre>_</code></li>
|
||||
<li>Some standard library functions: <code translate="no" v-pre>lowercase</code></li>
|
||||
</ul>
|
||||
<p>Here are some commonly used naming conventions:</p>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>self</code>: The first parameter of an instance method</li>
|
||||
<li><code translate="no" v-pre>cls</code>: The first parameter of class methods and <code translate="no" v-pre>__new__</code></li>
|
||||
</ul>
|
||||
<h3 id="using-abbreviations">Using Abbreviations</h3>
|
||||
<p>Use abbreviations only for temporary variables and internal implementations.</p>
|
||||
<p>Abbreviations should be well-established, include key syllables of the original word, and be immediately recognizable.</p>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>context</code> -> <code translate="no" v-pre>ctx</code> (✔)</li>
|
||||
<li><code translate="no" v-pre>temporary</code> -> <code translate="no" v-pre>tmp</code> (✔)</li>
|
||||
<li><code translate="no" v-pre>distribution</code> -> <code translate="no" v-pre>dist</code> (✔)</li>
|
||||
<li><code translate="no" v-pre>visited</code> -> <code translate="no" v-pre>vis</code> (<span class="docs-emoji">❌</span>)</li>
|
||||
</ul>
|
||||
<div id="using-abbreviations-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Incorrect: Using abbreviations in public function parameters
|
||||
def some_pub_fn(ctx, req_id, data):
|
||||
pass
|
||||
|
||||
# Correct
|
||||
def some_public_function(context, request_id, data):
|
||||
pass</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="using-precise-terminology">Using Precise Terminology</h3>
|
||||
<p>Naming should convey precise meanings, especially when multiple synonyms exist.</p>
|
||||
<p>For example, <code translate="no" v-pre>count</code>, <code translate="no" v-pre>size</code>, and <code translate="no" v-pre>length</code> all relate to quantity, but they have different nuances:</p>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>count</code>: Represents a counted value</li>
|
||||
<li><code translate="no" v-pre>length</code>: Represents the number of elements in a container</li>
|
||||
<li><code translate="no" v-pre>size</code>: Represents the byte size of an object</li>
|
||||
</ul>
|
||||
<div id="using-precise-terminology-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">s = 'aaabc⭐'
|
||||
count = s.count('a')
|
||||
length = len(s)
|
||||
size = len(s.encode())
|
||||
|
||||
print(f"{s!r} has a length of {length}, a size of {size} bytes, and contains {count} occurrences of 'a'")
|
||||
# 'aaabc⭐' has a length of 6, a size of 8 bytes, and contains 3 occurrences of 'a'</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="using-professional-terminology">Using Professional Terminology</h3>
|
||||
<ul>
|
||||
<li>For item quantities in a game: <code translate="no" v-pre>quantity</code> is better than <code translate="no" v-pre>item_count</code></li>
|
||||
<li>For grid counts: <code translate="no" v-pre>area</code> (meaning surface area) is better than <code translate="no" v-pre>grid_count</code></li>
|
||||
</ul>
|
||||
<h3 id="avoiding-built-in-names">Avoiding Built-in Names</h3>
|
||||
<div id="avoiding-built-in-names-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Incorrect: Overwriting `builtins.map`
|
||||
map = [[1, 2, 3], [4, 5, 6]]
|
||||
# Incorrect: Overwriting `builtins.type`
|
||||
type = some_thing.type</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="internal-functions-and-classes">Internal Functions and Classes</h3>
|
||||
<p>Use a single underscore <code translate="no" v-pre>_</code> as a prefix for internal functions. Never use a double underscore <code translate="no" v-pre>__</code> (except for magic methods).</p>
|
||||
<div id="internal-functions-and-classes-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">def _internal_func():
|
||||
"""This is an internal function."""
|
||||
|
||||
class _InternalClass:
|
||||
def _internal_f(self): pass</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="importing-modules">Importing Modules</h2>
|
||||
<ol>
|
||||
<li>Import standard library modules first.</li>
|
||||
<li>Then import third-party dependencies.</li>
|
||||
<li>Finally, import project-specific modules.</li>
|
||||
</ol>
|
||||
<div id="importing-modules-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from typing import Any
|
||||
from collections import deque
|
||||
|
||||
from array2d import array2d
|
||||
|
||||
from ..utils import logger</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="coding-practices">Coding Practices</h2>
|
||||
<p>Use <code translate="no" v-pre>is not</code> when checking for <code translate="no" v-pre>None</code>. Do not explicitly compare with <code translate="no" v-pre>True</code> or <code translate="no" v-pre>False</code>.</p>
|
||||
<div id="coding-practices-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Correct
|
||||
if x is not None: pass
|
||||
|
||||
# Incorrect
|
||||
if x != None: pass
|
||||
|
||||
# Correct
|
||||
x = True
|
||||
if x: pass
|
||||
if not x: pass
|
||||
|
||||
# Incorrect
|
||||
if x == True: pass
|
||||
if x is True: pass
|
||||
if x != False: pass</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>The <code translate="no" v-pre>if</code> statement implicitly calls <code translate="no" v-pre>bool()</code>, so it can be used to check if a container is empty.</p>
|
||||
<div id="coding-practices-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">not_empty_list = [1]
|
||||
not_empty_string = '1'
|
||||
truth = True
|
||||
|
||||
if not_empty_list:
|
||||
print('true value')
|
||||
|
||||
if not_empty_string:
|
||||
print('true value')
|
||||
|
||||
if truth:
|
||||
print('true value')
|
||||
|
||||
# Explicitly checking for emptiness is also valid
|
||||
if len(not_empty_list) > 0: pass</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="references">References</h2>
|
||||
<p><a href="https://peps.python.org/pep-0008/">PEP 8 – Style Guide for Python Code</a></p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../gsoc2024/ideas/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Project Ideas</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../performance/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Performance</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Coding Style Guide", level: 1, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/coding-style-guide.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
83
features/basic.md
Normal file
83
features/basic.md
Normal file
@ -0,0 +1,83 @@
|
||||
The following table shows the basic features of pkpy with respect to [cpython](https://github.com/python/cpython).
|
||||
|
||||
| Name | Example | Supported |
|
||||
| --------------- | ------------------------------- | --------- |
|
||||
| If Else | `if..else..elif` | ✅ |
|
||||
| Loop | `for/while/break/continue` | ✅ |
|
||||
| Function | `def f(x,*args,y=1):` | ✅ |
|
||||
| Subclass | `class A(B):` | ✅ |
|
||||
| List | `[1, 2, 'a']` | ✅ |
|
||||
| ListComp | `[i for i in range(5)]` | ✅ |
|
||||
| Slice | `a[1:2], a[:2], a[1:]` | ✅ |
|
||||
| Tuple | `(1, 2, 'a')` | ✅ |
|
||||
| Dict | `{'a': 1, 'b': 2}` | ✅ |
|
||||
| F-String | `f'value is {x}'` | ✅ |
|
||||
| Unpacking | `a, b = 1, 2` | ✅ |
|
||||
| Star Unpacking | `a, *b = [1, 2, 3]` | ✅ |
|
||||
| Exception | `raise/try..except..` | ✅ |
|
||||
| Dynamic Code | `eval()/exec()` | ✅ |
|
||||
| Reflection | `hasattr()/getattr()/setattr()` | ✅ |
|
||||
| Import | `import/from..import` | ✅ |
|
||||
| Context Block | `with <expr> as <id>:` | ✅ |
|
||||
| Type Annotation | `def f(a:int, b:float=1)` | ✅ |
|
||||
| Generator | `yield i` | ✅ |
|
||||
| Decorator | `@cache` | ✅ |
|
||||
| Match Case | `match code: case 200:` | ✅ |
|
||||
|
||||
## Supported magic methods
|
||||
|
||||
#### Unary operators
|
||||
|
||||
+ `__repr__`
|
||||
+ `__str__`
|
||||
+ `__hash__`
|
||||
+ `__len__`
|
||||
+ `__iter__`
|
||||
+ `__next__`
|
||||
+ `__neg__`
|
||||
|
||||
#### Logical operators
|
||||
|
||||
+ `__eq__`
|
||||
+ `__lt__`
|
||||
+ `__le__`
|
||||
+ `__gt__`
|
||||
+ `__ge__`
|
||||
+ `__contains__`
|
||||
|
||||
#### Binary operators
|
||||
|
||||
+ `__add__`
|
||||
+ `__radd__`
|
||||
+ `__sub__`
|
||||
+ `__rsub__`
|
||||
+ `__mul__`
|
||||
+ `__rmul__`
|
||||
+ `__truediv__`
|
||||
+ `__floordiv__`
|
||||
+ `__mod__`
|
||||
+ `__pow__`
|
||||
+ `__matmul__`
|
||||
+ `__lshift__`
|
||||
+ `__rshift__`
|
||||
+ `__and__`
|
||||
+ `__or__`
|
||||
+ `__xor__`
|
||||
+ `__invert__`
|
||||
|
||||
#### Indexer
|
||||
|
||||
+ `__getitem__`
|
||||
+ `__setitem__`
|
||||
+ `__delitem__`
|
||||
|
||||
#### Specials
|
||||
|
||||
+ `__new__`
|
||||
+ `__init__`
|
||||
+ `__call__`
|
||||
+ `__divmod__`
|
||||
+ `__enter__`
|
||||
+ `__exit__`
|
||||
+ `__name__`
|
||||
+ `__all__`
|
||||
473
features/basic/index.html
Normal file
473
features/basic/index.html
Normal file
@ -0,0 +1,473 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Basic Features | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Basic Features | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="The following table shows the basic features of pkpy with respect to cpython.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/basic/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/basic/">
|
||||
<meta property="og:title" content="Basic Features | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="The following table shows the basic features of pkpy with respect to cpython.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/basic/">
|
||||
<meta name="twitter:title" content="Basic Features | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="The following table shows the basic features of pkpy with respect to cpython.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/basic.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="basic-features">Basic Features</h1>
|
||||
<p>The following table shows the basic features of pkpy with respect to <a href="https://github.com/python/cpython">cpython</a>.</p>
|
||||
<div class="table-wrapper scrollbar overflow-hidden">
|
||||
<table class="comfortable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Example</th>
|
||||
<th>Supported</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>If Else</td>
|
||||
<td><code translate="no" v-pre>if..else..elif</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Loop</td>
|
||||
<td><code translate="no" v-pre>for/while/break/continue</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Function</td>
|
||||
<td><code translate="no" v-pre>def f(x,*args,y=1):</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Subclass</td>
|
||||
<td><code translate="no" v-pre>class A(B):</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>List</td>
|
||||
<td><code translate="no" v-pre>[1, 2, 'a']</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ListComp</td>
|
||||
<td><code translate="no" v-pre>[i for i in range(5)]</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Slice</td>
|
||||
<td><code translate="no" v-pre>a[1:2], a[:2], a[1:]</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Tuple</td>
|
||||
<td><code translate="no" v-pre>(1, 2, 'a')</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dict</td>
|
||||
<td><code translate="no" v-pre>{'a': 1, 'b': 2}</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>F-String</td>
|
||||
<td><code translate="no" v-pre>f'value is {x}'</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Unpacking</td>
|
||||
<td><code translate="no" v-pre>a, b = 1, 2</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Star Unpacking</td>
|
||||
<td><code translate="no" v-pre>a, *b = [1, 2, 3]</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Exception</td>
|
||||
<td><code translate="no" v-pre>raise/try..except..</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dynamic Code</td>
|
||||
<td><code translate="no" v-pre>eval()/exec()</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Reflection</td>
|
||||
<td><code translate="no" v-pre>hasattr()/getattr()/setattr()</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Import</td>
|
||||
<td><code translate="no" v-pre>import/from..import</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Context Block</td>
|
||||
<td><code translate="no" v-pre>with <expr> as <id>:</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Type Annotation</td>
|
||||
<td><code translate="no" v-pre>def f(a:int, b:float=1)</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Generator</td>
|
||||
<td><code translate="no" v-pre>yield i</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Decorator</td>
|
||||
<td><code translate="no" v-pre>@cache</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Match Case</td>
|
||||
<td><code translate="no" v-pre>match code: case 200:</code></td>
|
||||
<td><span class="docs-emoji">✅</span></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<h2 id="supported-magic-methods">Supported magic methods</h2>
|
||||
<h4 id="unary-operators">Unary operators</h4>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>__repr__</code></li>
|
||||
<li><code translate="no" v-pre>__str__</code></li>
|
||||
<li><code translate="no" v-pre>__hash__</code></li>
|
||||
<li><code translate="no" v-pre>__len__</code></li>
|
||||
<li><code translate="no" v-pre>__iter__</code></li>
|
||||
<li><code translate="no" v-pre>__next__</code></li>
|
||||
<li><code translate="no" v-pre>__neg__</code></li>
|
||||
</ul>
|
||||
<h4 id="logical-operators">Logical operators</h4>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>__eq__</code></li>
|
||||
<li><code translate="no" v-pre>__lt__</code></li>
|
||||
<li><code translate="no" v-pre>__le__</code></li>
|
||||
<li><code translate="no" v-pre>__gt__</code></li>
|
||||
<li><code translate="no" v-pre>__ge__</code></li>
|
||||
<li><code translate="no" v-pre>__contains__</code></li>
|
||||
</ul>
|
||||
<h4 id="binary-operators">Binary operators</h4>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>__add__</code></li>
|
||||
<li><code translate="no" v-pre>__radd__</code></li>
|
||||
<li><code translate="no" v-pre>__sub__</code></li>
|
||||
<li><code translate="no" v-pre>__rsub__</code></li>
|
||||
<li><code translate="no" v-pre>__mul__</code></li>
|
||||
<li><code translate="no" v-pre>__rmul__</code></li>
|
||||
<li><code translate="no" v-pre>__truediv__</code></li>
|
||||
<li><code translate="no" v-pre>__floordiv__</code></li>
|
||||
<li><code translate="no" v-pre>__mod__</code></li>
|
||||
<li><code translate="no" v-pre>__pow__</code></li>
|
||||
<li><code translate="no" v-pre>__matmul__</code></li>
|
||||
<li><code translate="no" v-pre>__lshift__</code></li>
|
||||
<li><code translate="no" v-pre>__rshift__</code></li>
|
||||
<li><code translate="no" v-pre>__and__</code></li>
|
||||
<li><code translate="no" v-pre>__or__</code></li>
|
||||
<li><code translate="no" v-pre>__xor__</code></li>
|
||||
<li><code translate="no" v-pre>__invert__</code></li>
|
||||
</ul>
|
||||
<h4 id="indexer">Indexer</h4>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>__getitem__</code></li>
|
||||
<li><code translate="no" v-pre>__setitem__</code></li>
|
||||
<li><code translate="no" v-pre>__delitem__</code></li>
|
||||
</ul>
|
||||
<h4 id="specials">Specials</h4>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>__new__</code></li>
|
||||
<li><code translate="no" v-pre>__init__</code></li>
|
||||
<li><code translate="no" v-pre>__call__</code></li>
|
||||
<li><code translate="no" v-pre>__divmod__</code></li>
|
||||
<li><code translate="no" v-pre>__enter__</code></li>
|
||||
<li><code translate="no" v-pre>__exit__</code></li>
|
||||
<li><code translate="no" v-pre>__name__</code></li>
|
||||
<li><code translate="no" v-pre>__all__</code></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../bindings-cpp/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Write C++ Bindings</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../features/differences/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Comparison with CPython</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Basic Features", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/features/basic.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
82
features/debugging.md
Normal file
82
features/debugging.md
Normal file
@ -0,0 +1,82 @@
|
||||
## Install VSCode Extension
|
||||
|
||||
To debug a pocketpy program, you need to install our VSCode extension first:
|
||||
|
||||
https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy
|
||||
|
||||
!!!
|
||||
The VSCode extension requires pocketpy version >= `2.1.1`
|
||||
!!!
|
||||
|
||||
## Create a `launch.json` file
|
||||
|
||||
Navigate to the Debug view in VSCode, and click on "create a launch.json file" link.
|
||||
In the dropdown menu, select "pocketpy".
|
||||
|
||||
|
||||
|
||||
Then a default `launch.json` file will be created in the `.vscode` folder
|
||||
with a sample pocketpy debug configuration.
|
||||
|
||||
## How does it work?
|
||||
|
||||
pocketpy provides a C-API `py_debugger_waitforattach`,
|
||||
which starts a debug server and waits for the VSCode extension to attach.
|
||||
When the debugger is attached, the program will continue to run.
|
||||
|
||||
+ If you are using pocketpy's standalone executable `main.exe`, you can pass `--debug` flag to it. This will automatically call `py_debugger_waitforattach("127.0.0.1", 6110)` before running your program.
|
||||
+ If you are embedding pocketpy as a library, you need to call `py_debugger_waitforattach` manually in your C/C++ code.
|
||||
|
||||
## Configuration
|
||||
|
||||
+ `type`: must be `pocketpy`
|
||||
+ `request`: can be `attach` or `launch`
|
||||
+ `name`: the name of this configuration
|
||||
+ `port`: the port number of the debug server, must match the one in `py_debugger_waitforattach`
|
||||
+ `host`: the host of the debug server, must match the one in `py_debugger_waitforattach`
|
||||
+ `sourceFolder`: the root folder of your python source code, default to `${workspaceFolder}`. However,
|
||||
sometimes you may run your program from a subfolder, in this case you need to set `sourceFolder` to the correct path. If this is not set correctly, breakpoints will not be hit.
|
||||
+ `program`: (for launch mode only) the path to the executable file which calls `py_debugger_waitforattach`, e.g. the pocketpy standalone executable `main.exe`.
|
||||
+ `args`: (for launch mode only) the arguments to pass to the executable file, e.g. `--debug` and the script path if you are using `main.exe`.
|
||||
+ `cwd`: (for launch mode only) the working directory to launch the executable file, default to `${workspaceFolder}`.
|
||||
|
||||
### For attach mode
|
||||
|
||||
In this mode, you need to start your pocketpy program manually which must call `py_debugger_waitforattach` first.
|
||||
After the program starts, you can let VSCode attach to the debug server.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "pocketpy",
|
||||
"request": "attach",
|
||||
"name": "Attach to pocketpy program",
|
||||
"port": 6110,
|
||||
"host": "localhost",
|
||||
"sourceFolder": "${workspaceFolder}"
|
||||
}
|
||||
```
|
||||
|
||||
### For launch mode
|
||||
|
||||
In this mode, VSCode will start your program with the specified `program`, `args` and `cwd`.
|
||||
After the program starts, VSCode attempts to attach to the debug server automatically.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "pocketpy",
|
||||
"request": "launch",
|
||||
"name": "Launch pocketpy program",
|
||||
"port": 6110,
|
||||
"host": "localhost",
|
||||
"sourceFolder": "${workspaceFolder}",
|
||||
"program": "${workspaceFolder}/pocketpy/main.exe",
|
||||
"args": [
|
||||
"--debug"
|
||||
],
|
||||
"cwd": "${workspaceFolder}"
|
||||
}
|
||||
```
|
||||
|
||||
## Showcase
|
||||
|
||||
|
||||
408
features/debugging/index.html
Normal file
408
features/debugging/index.html
Normal file
@ -0,0 +1,408 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Debugging | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Debugging | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="To debug a pocketpy program, you need to install our VSCode extension first:">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/debugging/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/debugging/">
|
||||
<meta property="og:title" content="Debugging | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="To debug a pocketpy program, you need to install our VSCode extension first:">
|
||||
<meta property="og:image" content="https://pocketpy.dev/static/debugger/launch_json.png">
|
||||
<meta property="og:image:width" content="1200">
|
||||
<meta property="og:image:height" content="630">
|
||||
<meta property="og:image:alt" content="Debugging | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/debugging/">
|
||||
<meta name="twitter:title" content="Debugging | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="To debug a pocketpy program, you need to install our VSCode extension first:">
|
||||
<meta name="twitter:image" content="https://pocketpy.dev/static/debugger/launch_json.png">
|
||||
<meta name="twitter:image:alt" content="Debugging | Portable Python 3.x Interpreter in Modern C">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/debugging.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="debugging">Debugging</h1>
|
||||
<h2 id="install-vscode-extension">Install VSCode Extension</h2>
|
||||
<p>To debug a pocketpy program, you need to install our VSCode extension first:</p>
|
||||
<p><a href="https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy">https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy</a></p>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>The VSCode extension requires pocketpy version >= <code translate="no" v-pre>2.1.1</code></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h2 id="create-a-launchjson-file">Create a <code translate="no" v-pre>launch.json</code> file</h2>
|
||||
<p>Navigate to the Debug view in VSCode, and click on "create a launch.json file" link.
|
||||
In the dropdown menu, select "pocketpy".</p>
|
||||
<figure class="content-center">
|
||||
<img src="../../static/debugger/launch_json.png" alt="launch_json" class="max-w-full h-auto rounded-image-rounded border-image-border border-image-border-width" width="1654" height="630" />
|
||||
<figcaption class="caption">launch_json</figcaption>
|
||||
</figure>
|
||||
<p>Then a default <code translate="no" v-pre>launch.json</code> file will be created in the <code translate="no" v-pre>.vscode</code> folder
|
||||
with a sample pocketpy debug configuration.</p>
|
||||
<h2 id="how-does-it-work">How does it work?</h2>
|
||||
<p>pocketpy provides a C-API <code translate="no" v-pre>py_debugger_waitforattach</code>,
|
||||
which starts a debug server and waits for the VSCode extension to attach.
|
||||
When the debugger is attached, the program will continue to run.</p>
|
||||
<ul>
|
||||
<li>If you are using pocketpy's standalone executable <code translate="no" v-pre>main.exe</code>, you can pass <code translate="no" v-pre>--debug</code> flag to it. This will automatically call <code translate="no" v-pre>py_debugger_waitforattach("127.0.0.1", 6110)</code> before running your program.</li>
|
||||
<li>If you are embedding pocketpy as a library, you need to call <code translate="no" v-pre>py_debugger_waitforattach</code> manually in your C/C++ code.</li>
|
||||
</ul>
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>type</code>: must be <code translate="no" v-pre>pocketpy</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>request</code>: can be <code translate="no" v-pre>attach</code> or <code translate="no" v-pre>launch</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>name</code>: the name of this configuration</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>port</code>: the port number of the debug server, must match the one in <code translate="no" v-pre>py_debugger_waitforattach</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>host</code>: the host of the debug server, must match the one in <code translate="no" v-pre>py_debugger_waitforattach</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>sourceFolder</code>: the root folder of your python source code, default to <code translate="no" v-pre>${workspaceFolder}</code>. However,
|
||||
sometimes you may run your program from a subfolder, in this case you need to set <code translate="no" v-pre>sourceFolder</code> to the correct path. If this is not set correctly, breakpoints will not be hit.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>program</code>: (for launch mode only) the path to the executable file which calls <code translate="no" v-pre>py_debugger_waitforattach</code>, e.g. the pocketpy standalone executable <code translate="no" v-pre>main.exe</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>args</code>: (for launch mode only) the arguments to pass to the executable file, e.g. <code translate="no" v-pre>--debug</code> and the script path if you are using <code translate="no" v-pre>main.exe</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code translate="no" v-pre>cwd</code>: (for launch mode only) the working directory to launch the executable file, default to <code translate="no" v-pre>${workspaceFolder}</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="for-attach-mode">For attach mode</h3>
|
||||
<p>In this mode, you need to start your pocketpy program manually which must call <code translate="no" v-pre>py_debugger_waitforattach</code> first.
|
||||
After the program starts, you can let VSCode attach to the debug server.</p>
|
||||
<div id="for-attach-mode-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-json"><code v-pre class="language-json">{
|
||||
"type": "pocketpy",
|
||||
"request": "attach",
|
||||
"name": "Attach to pocketpy program",
|
||||
"port": 6110,
|
||||
"host": "localhost",
|
||||
"sourceFolder": "${workspaceFolder}"
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="for-launch-mode">For launch mode</h3>
|
||||
<p>In this mode, VSCode will start your program with the specified <code translate="no" v-pre>program</code>, <code translate="no" v-pre>args</code> and <code translate="no" v-pre>cwd</code>.
|
||||
After the program starts, VSCode attempts to attach to the debug server automatically.</p>
|
||||
<div id="for-launch-mode-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-json"><code v-pre class="language-json">{
|
||||
"type": "pocketpy",
|
||||
"request": "launch",
|
||||
"name": "Launch pocketpy program",
|
||||
"port": 6110,
|
||||
"host": "localhost",
|
||||
"sourceFolder": "${workspaceFolder}",
|
||||
"program": "${workspaceFolder}/pocketpy/main.exe",
|
||||
"args": [
|
||||
"--debug"
|
||||
],
|
||||
"cwd": "${workspaceFolder}"
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="showcase">Showcase</h2>
|
||||
<figure class="content-center">
|
||||
<img src="../../static/debugger/debugger_demo.png" alt="debugger_demo" class="max-w-full h-auto rounded-image-rounded border-image-border border-image-border-width" width="2560" height="1440" />
|
||||
<figcaption class="caption">debugger_demo</figcaption>
|
||||
</figure>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/deploy/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Deploy Bytecodes</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../features/profiling/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Profiling</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Debugging", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/features/debugging.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
46
features/deploy.md
Normal file
46
features/deploy.md
Normal file
@ -0,0 +1,46 @@
|
||||
!!!
|
||||
The feature requires pocketpy version >= `2.1.7`
|
||||
!!!
|
||||
|
||||
You can deploy your pocketpy program as `.pyc` files, which are compiled bytecodes with necessary metadata.
|
||||
This slightly improves the loading speed of your program.
|
||||
|
||||
It also makes your users unable to get your source code directly, unless they do expensive reverse engineering.
|
||||
|
||||
To compile a `.py` file into a `.pyc` bytecode file, you need the command-line executable `main`,
|
||||
which can be simply built by running `python cmake_build.py` in the repository root.
|
||||
|
||||
## Example
|
||||
|
||||
Once you have `main` executable, you can run the following command to compile `input_file.py`:
|
||||
|
||||
```sh
|
||||
./main --compile input_file.py output_file.pyc
|
||||
```
|
||||
|
||||
Alternatively, you can invoke the `compileall.py` script in the repository root.
|
||||
It compiles all `.py` files in the specified directory into `.pyc` files.
|
||||
|
||||
```sh
|
||||
python compileall.py ./main input_path output_path
|
||||
```
|
||||
|
||||
## Running `.pyc` files
|
||||
|
||||
The command-line executable `main` can run `.pyc` files directly:
|
||||
|
||||
```sh
|
||||
./main output_file.pyc
|
||||
```
|
||||
|
||||
If you are using C-APIs, you can use the `py_execo()` function.
|
||||
|
||||
```c
|
||||
/// Run a compiled code object.
|
||||
PK_API bool py_execo(const void* data, int size, const char* filename, py_Ref module) PY_RAISE PY_RETURN;
|
||||
```
|
||||
|
||||
## Trackback Support
|
||||
|
||||
Since `.pyc` files do not contain raw sources,
|
||||
trackbacks will show line numbers but not the actual source code lines.
|
||||
343
features/deploy/index.html
Normal file
343
features/deploy/index.html
Normal file
@ -0,0 +1,343 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Deploy Bytecodes | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Deploy Bytecodes | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="The feature requires pocketpy version >= 2.1.7">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/deploy/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/deploy/">
|
||||
<meta property="og:title" content="Deploy Bytecodes | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="The feature requires pocketpy version >= 2.1.7">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/deploy/">
|
||||
<meta name="twitter:title" content="Deploy Bytecodes | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="The feature requires pocketpy version >= 2.1.7">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/deploy.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="deploy-bytecodes">Deploy Bytecodes</h1>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>The feature requires pocketpy version >= <code translate="no" v-pre>2.1.7</code></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p>You can deploy your pocketpy program as <code translate="no" v-pre>.pyc</code> files, which are compiled bytecodes with necessary metadata.
|
||||
This slightly improves the loading speed of your program.</p>
|
||||
<p>It also makes your users unable to get your source code directly, unless they do expensive reverse engineering.</p>
|
||||
<p>To compile a <code translate="no" v-pre>.py</code> file into a <code translate="no" v-pre>.pyc</code> bytecode file, you need the command-line executable <code translate="no" v-pre>main</code>,
|
||||
which can be simply built by running <code translate="no" v-pre>python cmake_build.py</code> in the repository root.</p>
|
||||
<h2 id="example">Example</h2>
|
||||
<p>Once you have <code translate="no" v-pre>main</code> executable, you can run the following command to compile <code translate="no" v-pre>input_file.py</code>:</p>
|
||||
<div id="example-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-bash"><code v-pre class="language-bash">./main --compile input_file.py output_file.pyc</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>Alternatively, you can invoke the <code translate="no" v-pre>compileall.py</code> script in the repository root.
|
||||
It compiles all <code translate="no" v-pre>.py</code> files in the specified directory into <code translate="no" v-pre>.pyc</code> files.</p>
|
||||
<div id="example-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-bash"><code v-pre class="language-bash">python compileall.py ./main input_path output_path</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="running-pyc-files">Running <code translate="no" v-pre>.pyc</code> files</h2>
|
||||
<p>The command-line executable <code translate="no" v-pre>main</code> can run <code translate="no" v-pre>.pyc</code> files directly:</p>
|
||||
<div id="running-pyc-files-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-bash"><code v-pre class="language-bash">./main output_file.pyc</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>If you are using C-APIs, you can use the <code translate="no" v-pre>py_execo()</code> function.</p>
|
||||
<div id="running-pyc-files-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">/// Run a compiled code object.
|
||||
PK_API bool py_execo(const void* data, int size, const char* filename, py_Ref module) PY_RAISE PY_RETURN;</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="trackback-support">Trackback Support</h2>
|
||||
<p>Since <code translate="no" v-pre>.pyc</code> files do not contain raw sources,
|
||||
trackbacks will show line numbers but not the actual source code lines.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/differences/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Comparison with CPython</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../features/debugging/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Debugging</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Deploy Bytecodes", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/features/deploy.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
33
features/differences.md
Normal file
33
features/differences.md
Normal file
@ -0,0 +1,33 @@
|
||||
[cpython](https://github.com/python/cpython) is the reference implementation of the Python programming language. It is written in C and is the most widely used implementation of Python.
|
||||
|
||||
## The design goal
|
||||
|
||||
**pkpy aims to be an alternative to lua for
|
||||
game scripting, not cpython for general purpose programming.**
|
||||
|
||||
+ For syntax and semantics, pkpy is designed to be as close to cpython as possible.
|
||||
+ For ecosystem and others, pkpy is not compatible with cpython.
|
||||
|
||||
pkpy supports most of the syntax and semantics of python.
|
||||
For performance and simplicity, some features are not implemented, or behave differently.
|
||||
The easiest way to test a feature is to [try it on your browser](https://pocketpy.dev/static/web/).
|
||||
|
||||
## Unimplemented features
|
||||
|
||||
1. Descriptor protocol `__get__` and `__set__`. However, `@property` is implemented.
|
||||
2. `__slots__` in class definition.
|
||||
3. `else` and `finally` clause in try..except.
|
||||
4. Inplace methods like `__iadd__` and `__imul__`.
|
||||
5. `__del__` in class definition.
|
||||
6. Multiple inheritance.
|
||||
|
||||
## Different behaviors
|
||||
|
||||
1. positional and keyword arguments are strictly evaluated.
|
||||
2. `bool` does not derive from `int`. They are independent types.
|
||||
3. `int` is 64-bit.
|
||||
4. Raw string cannot have boundary quotes in it, even escaped. See [#55](https://github.com/pocketpy/pocketpy/issues/55).
|
||||
5. In a starred unpacked assignment, e.g. `a, b, *c = x`, the starred variable can only be presented in the last position. `a, *b, c = x` is not supported.
|
||||
6. A `Tab` is equivalent to 4 spaces. You can mix `Tab` and spaces in indentation, but it is not recommended.
|
||||
7. A return, break, continue in try/except/with block will make the finally block not executed.
|
||||
8. `match` is a keyword and `match..case` is equivalent to `if..elif..else`.
|
||||
328
features/differences/index.html
Normal file
328
features/differences/index.html
Normal file
@ -0,0 +1,328 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Comparison with CPython | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Comparison with CPython | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="cpython is the reference implementation of the Python programming language. It is written in C and is the most widely used implementation of Python.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/differences/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/differences/">
|
||||
<meta property="og:title" content="Comparison with CPython | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="cpython is the reference implementation of the Python programming language. It is written in C and is the most widely used implementation of Python.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/differences/">
|
||||
<meta name="twitter:title" content="Comparison with CPython | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="cpython is the reference implementation of the Python programming language. It is written in C and is the most widely used implementation of Python.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/differences.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="comparison-with-cpython">Comparison with CPython</h1>
|
||||
<p><a href="https://github.com/python/cpython">cpython</a> is the reference implementation of the Python programming language. It is written in C and is the most widely used implementation of Python.</p>
|
||||
<h2 id="the-design-goal">The design goal</h2>
|
||||
<p><strong>pkpy aims to be an alternative to lua for
|
||||
game scripting, not cpython for general purpose programming.</strong></p>
|
||||
<ul>
|
||||
<li>For syntax and semantics, pkpy is designed to be as close to cpython as possible.</li>
|
||||
<li>For ecosystem and others, pkpy is not compatible with cpython.</li>
|
||||
</ul>
|
||||
<p>pkpy supports most of the syntax and semantics of python.
|
||||
For performance and simplicity, some features are not implemented, or behave differently.
|
||||
The easiest way to test a feature is to <a href="https://pocketpy.dev/static/web/">try it on your browser</a>.</p>
|
||||
<h2 id="unimplemented-features">Unimplemented features</h2>
|
||||
<ol>
|
||||
<li>Descriptor protocol <code translate="no" v-pre>__get__</code> and <code translate="no" v-pre>__set__</code>. However, <code translate="no" v-pre>@property</code> is implemented.</li>
|
||||
<li><code translate="no" v-pre>__slots__</code> in class definition.</li>
|
||||
<li><code translate="no" v-pre>else</code> and <code translate="no" v-pre>finally</code> clause in try..except.</li>
|
||||
<li>Inplace methods like <code translate="no" v-pre>__iadd__</code> and <code translate="no" v-pre>__imul__</code>.</li>
|
||||
<li><code translate="no" v-pre>__del__</code> in class definition.</li>
|
||||
<li>Multiple inheritance.</li>
|
||||
</ol>
|
||||
<h2 id="different-behaviors">Different behaviors</h2>
|
||||
<ol>
|
||||
<li>positional and keyword arguments are strictly evaluated.</li>
|
||||
<li><code translate="no" v-pre>bool</code> does not derive from <code translate="no" v-pre>int</code>. They are independent types.</li>
|
||||
<li><code translate="no" v-pre>int</code> is 64-bit.</li>
|
||||
<li>Raw string cannot have boundary quotes in it, even escaped. See <a href="https://github.com/pocketpy/pocketpy/issues/55">#55</a>.</li>
|
||||
<li>In a starred unpacked assignment, e.g. <code translate="no" v-pre>a, b, *c = x</code>, the starred variable can only be presented in the last position. <code translate="no" v-pre>a, *b, c = x</code> is not supported.</li>
|
||||
<li>A <code translate="no" v-pre>Tab</code> is equivalent to 4 spaces. You can mix <code translate="no" v-pre>Tab</code> and spaces in indentation, but it is not recommended.</li>
|
||||
<li>A return, break, continue in try/except/with block will make the finally block not executed.</li>
|
||||
<li><code translate="no" v-pre>match</code> is a keyword and <code translate="no" v-pre>match..case</code> is equivalent to <code translate="no" v-pre>if..elif..else</code>.</li>
|
||||
</ol>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/basic/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Basic Features</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../features/deploy/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Deploy Bytecodes</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Comparison with CPython", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/features/differences.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
23
features/profiling.md
Normal file
23
features/profiling.md
Normal file
@ -0,0 +1,23 @@
|
||||
To profile your pocketpy program, you can run `main.exe` with `--profile` flag.
|
||||
|
||||
For example, to profile `test/test_math.py`, run
|
||||
|
||||
```
|
||||
main.exe --profile test/test_math.py
|
||||
```
|
||||
|
||||
This will output a JSON report file named `profile_report.json` in the current directory,
|
||||
which records the time spent for each line. To visualize the report, please install our VSCode extension.
|
||||
|
||||
https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy
|
||||
|
||||
!!!
|
||||
The VSCode extension requires pocketpy version >= `2.1.1`
|
||||
!!!
|
||||
|
||||
With pocketpy VSCode extension, press `F1` and type `pocketpy: Load Line Profiler Report`,
|
||||
select **1. the `profile_report.json` file; 2. the source root of the program**. Then you will see a nice visualization of the profiling result.
|
||||
|
||||
|
||||
|
||||
Press `ESC` to exit the report view.
|
||||
335
features/profiling/index.html
Normal file
335
features/profiling/index.html
Normal file
@ -0,0 +1,335 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Profiling | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Profiling | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="To profile your pocketpy program, you can run main.exe with --profile flag.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/profiling/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/profiling/">
|
||||
<meta property="og:title" content="Profiling | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="To profile your pocketpy program, you can run main.exe with --profile flag.">
|
||||
<meta property="og:image" content="https://pocketpy.dev/static/profiler_demo.png">
|
||||
<meta property="og:image:width" content="1200">
|
||||
<meta property="og:image:height" content="630">
|
||||
<meta property="og:image:alt" content="Profiling | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/profiling/">
|
||||
<meta name="twitter:title" content="Profiling | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="To profile your pocketpy program, you can run main.exe with --profile flag.">
|
||||
<meta name="twitter:image" content="https://pocketpy.dev/static/profiler_demo.png">
|
||||
<meta name="twitter:image:alt" content="Profiling | Portable Python 3.x Interpreter in Modern C">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/profiling.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="profiling">Profiling</h1>
|
||||
<p>To profile your pocketpy program, you can run <code translate="no" v-pre>main.exe</code> with <code translate="no" v-pre>--profile</code> flag.</p>
|
||||
<p>For example, to profile <code translate="no" v-pre>test/test_math.py</code>, run</p>
|
||||
<div id="profiling-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">main.exe --profile test/test_math.py</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>This will output a JSON report file named <code translate="no" v-pre>profile_report.json</code> in the current directory,
|
||||
which records the time spent for each line. To visualize the report, please install our VSCode extension.</p>
|
||||
<p><a href="https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy">https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy</a></p>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>The VSCode extension requires pocketpy version >= <code translate="no" v-pre>2.1.1</code></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p>With pocketpy VSCode extension, press <code translate="no" v-pre>F1</code> and type <code translate="no" v-pre>pocketpy: Load Line Profiler Report</code>,
|
||||
select <strong>1. the <code translate="no" v-pre>profile_report.json</code> file; 2. the source root of the program</strong>. Then you will see a nice visualization of the profiling result.</p>
|
||||
<figure class="content-center">
|
||||
<img src="../../static/profiler_demo.png" alt="profiler_report" class="max-w-full h-auto rounded-image-rounded border-image-border border-image-border-width" width="1424" height="734" />
|
||||
<figcaption class="caption">profiler_report</figcaption>
|
||||
</figure>
|
||||
<p>Press <code translate="no" v-pre>ESC</code> to exit the report view.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/debugging/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Debugging</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../features/threading/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Compute Threads</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Profiling", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/features/profiling.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
148
features/threading.md
Normal file
148
features/threading.md
Normal file
@ -0,0 +1,148 @@
|
||||
pocketpy organizes its state by `VM` structure.
|
||||
Users can have at maximum 16 `VM` instances (index from 0 to 15).
|
||||
Each `VM` instance can only be accessed by exactly one thread at a time.
|
||||
If you are trying to run two python scripts in parallel refering the same `VM` instance,
|
||||
you will crash it definitely.
|
||||
|
||||
However, there are two ways to achieve multi-threading in pocketpy.
|
||||
|
||||
One way is to use a native threading library such as `pthread`.
|
||||
You can wrap the multi-threading logic into a C function and bind it to pocketpy.
|
||||
Be careful and not to access the same `VM` instance from multiple threads at the same time.
|
||||
You need to lock critical resources or perform a deep copy of all needed data.
|
||||
|
||||
## ComputeThread
|
||||
|
||||
The other way is to use `pkpy.ComputeThread`.
|
||||
It is like an isolate in Dart language.
|
||||
`ComputeThread` is a true multi-threading model to allow you run python scripts in parallel without lock,
|
||||
backed by a separate `VM` instance.
|
||||
|
||||
`ComputeThread` is highly designed for computational intensive tasks in games.
|
||||
For example, you can run game logic in main thread (VM 0) and run world generation in another thread (e.g. VM 1).
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
subgraph Main Thread
|
||||
A[Game Start]
|
||||
B[Submit WorldGen Job]
|
||||
C[Frame 1]
|
||||
D[Frame 2]
|
||||
E[Frame 3]
|
||||
F[...]
|
||||
G[Get WorldGen Result]
|
||||
H[Render World]
|
||||
end
|
||||
subgraph WorldGen Thread
|
||||
O[Generate Biomes]
|
||||
P[Generate Terrain]
|
||||
Q[Generate Creatures]
|
||||
R[Dump Result]
|
||||
end
|
||||
A --> B
|
||||
B --> C
|
||||
C --> D
|
||||
D --> E
|
||||
E --> F
|
||||
F --> G
|
||||
G --> H
|
||||
|
||||
O --> P
|
||||
P --> Q
|
||||
Q --> R
|
||||
|
||||
B --> O
|
||||
R --> G
|
||||
```
|
||||
|
||||
#### `main.py`
|
||||
```python
|
||||
import time
|
||||
from pkpy import ComputeThread
|
||||
|
||||
thread = ComputeThread(1)
|
||||
print("Game Start")
|
||||
|
||||
# import worldgen.py
|
||||
thread.exec('from worldgen import gen_world')
|
||||
|
||||
print("Submit WorldGen Job")
|
||||
thread.submit_call('gen_world', 3, (100, 100), 10)
|
||||
|
||||
# wait for worldgen to finish
|
||||
for i in range(1, 100000):
|
||||
print('Frame:', i)
|
||||
time.sleep(1)
|
||||
if thread.is_done:
|
||||
break
|
||||
|
||||
error = thread.last_error()
|
||||
if error is not None:
|
||||
print("Error:", error)
|
||||
else:
|
||||
retval = thread.last_retval()
|
||||
biomes = retval['biomes']
|
||||
terrain = retval['terrain']
|
||||
creatures = retval['creatures']
|
||||
print("World Generation Complete", len(biomes), len(terrain), len(creatures))
|
||||
```
|
||||
|
||||
#### `worldgen.py`
|
||||
```python
|
||||
import time
|
||||
import random
|
||||
|
||||
def gen_world(biome_count: int, terrain_size: tuple[int, int], creature_count: int) -> dict:
|
||||
# simulate a long computation
|
||||
time.sleep(3)
|
||||
|
||||
# generate world data
|
||||
all_biomes = ["forest", "desert", "ocean", "mountain", "swamp"]
|
||||
all_creatures = ["wolf", "bear", "fish", "bird", "lizard"]
|
||||
|
||||
width, height = terrain_size
|
||||
|
||||
terrain_data = [
|
||||
random.randint(1, 10)
|
||||
for _ in range(width * height)
|
||||
]
|
||||
|
||||
creatures = [
|
||||
{
|
||||
"name": random.choice(all_creatures),
|
||||
"x": random.randint(0, width - 1),
|
||||
"y": random.randint(0, height - 1),
|
||||
}
|
||||
for i in range(creature_count)
|
||||
]
|
||||
|
||||
return {
|
||||
"biomes": all_biomes[:biome_count],
|
||||
"terrain": terrain_data,
|
||||
"creatures": creatures,
|
||||
}
|
||||
```
|
||||
|
||||
Run `main.py` and you will see the result like this:
|
||||
```
|
||||
Game Start
|
||||
Submit WorldGen Job
|
||||
Frame: 1
|
||||
Frame: 2
|
||||
Frame: 3
|
||||
Frame: 4
|
||||
World Generation Complete 3 10000 10
|
||||
```
|
||||
|
||||
`ComputeThread` uses `pickle` module to serialize the data between threads.
|
||||
Parameters and return values must be supported by `pickle`.
|
||||
See [pickle](https://pocketpy.dev/modules/pickle/) for more details.
|
||||
|
||||
Since `ComputeThread` is backed by a separate `VM` instance,
|
||||
it does not share any state with the main thread
|
||||
except for the parameters you pass to it.
|
||||
Therefore, common python modules will be imported twice in each thread.
|
||||
|
||||
If you want to identify which VM instance the module is running in,
|
||||
you can call `pkpy.currentvm` or let your `ComputeThread` set some special flags
|
||||
before importing these modules.
|
||||
433
features/threading/index.html
Normal file
433
features/threading/index.html
Normal file
@ -0,0 +1,433 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Compute Threads | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Compute Threads | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="pocketpy organizes its state by VM structure. Users can have at maximum 16 VM instances (index from 0 to 15). Each VM instance can only be accessed by exactly one thread at a time.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/threading/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/threading/">
|
||||
<meta property="og:title" content="Compute Threads | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="pocketpy organizes its state by VM structure. Users can have at maximum 16 VM instances (index from 0 to 15). Each VM instance can only be accessed by exactly one thread at a time.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/threading/">
|
||||
<meta name="twitter:title" content="Compute Threads | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="pocketpy organizes its state by VM structure. Users can have at maximum 16 VM instances (index from 0 to 15). Each VM instance can only be accessed by exactly one thread at a time.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/threading.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
<script id="mermaid-js" data-cfasync="false" src="../../resources/js/mermaid.js?v=4.5.3" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="compute-threads">Compute Threads</h1>
|
||||
<p>pocketpy organizes its state by <code translate="no" v-pre>VM</code> structure.
|
||||
Users can have at maximum 16 <code translate="no" v-pre>VM</code> instances (index from 0 to 15).
|
||||
Each <code translate="no" v-pre>VM</code> instance can only be accessed by exactly one thread at a time.
|
||||
If you are trying to run two python scripts in parallel refering the same <code translate="no" v-pre>VM</code> instance,
|
||||
you will crash it definitely.</p>
|
||||
<p>However, there are two ways to achieve multi-threading in pocketpy.</p>
|
||||
<p>One way is to use a native threading library such as <code translate="no" v-pre>pthread</code>.
|
||||
You can wrap the multi-threading logic into a C function and bind it to pocketpy.
|
||||
Be careful and not to access the same <code translate="no" v-pre>VM</code> instance from multiple threads at the same time.
|
||||
You need to lock critical resources or perform a deep copy of all needed data.</p>
|
||||
<h2 id="computethread">ComputeThread</h2>
|
||||
<p>The other way is to use <code translate="no" v-pre>pkpy.ComputeThread</code>.
|
||||
It is like an isolate in Dart language.
|
||||
<code translate="no" v-pre>ComputeThread</code> is a true multi-threading model to allow you run python scripts in parallel without lock,
|
||||
backed by a separate <code translate="no" v-pre>VM</code> instance.</p>
|
||||
<p><code translate="no" v-pre>ComputeThread</code> is highly designed for computational intensive tasks in games.
|
||||
For example, you can run game logic in main thread (VM 0) and run world generation in another thread (e.g. VM 1).</p>
|
||||
<div class="overflow-hidden mb-6 py-4 dark:px-5 dark:bg-white rounded-md"><pre translate="no" class="mermaid w-full">graph TD
|
||||
subgraph Main Thread
|
||||
A[Game Start]
|
||||
B[Submit WorldGen Job]
|
||||
C[Frame 1]
|
||||
D[Frame 2]
|
||||
E[Frame 3]
|
||||
F[...]
|
||||
G[Get WorldGen Result]
|
||||
H[Render World]
|
||||
end
|
||||
subgraph WorldGen Thread
|
||||
O[Generate Biomes]
|
||||
P[Generate Terrain]
|
||||
Q[Generate Creatures]
|
||||
R[Dump Result]
|
||||
end
|
||||
A --> B
|
||||
B --> C
|
||||
C --> D
|
||||
D --> E
|
||||
E --> F
|
||||
F --> G
|
||||
G --> H
|
||||
|
||||
O --> P
|
||||
P --> Q
|
||||
Q --> R
|
||||
|
||||
B --> O
|
||||
R --> G</pre></div>
|
||||
<h4 id="mainpy"><code translate="no" v-pre>main.py</code></h4>
|
||||
<div id="mainpy-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">import time
|
||||
from pkpy import ComputeThread
|
||||
|
||||
thread = ComputeThread(1)
|
||||
print("Game Start")
|
||||
|
||||
# import worldgen.py
|
||||
thread.exec('from worldgen import gen_world')
|
||||
|
||||
print("Submit WorldGen Job")
|
||||
thread.submit_call('gen_world', 3, (100, 100), 10)
|
||||
|
||||
# wait for worldgen to finish
|
||||
for i in range(1, 100000):
|
||||
print('Frame:', i)
|
||||
time.sleep(1)
|
||||
if thread.is_done:
|
||||
break
|
||||
|
||||
error = thread.last_error()
|
||||
if error is not None:
|
||||
print("Error:", error)
|
||||
else:
|
||||
retval = thread.last_retval()
|
||||
biomes = retval['biomes']
|
||||
terrain = retval['terrain']
|
||||
creatures = retval['creatures']
|
||||
print("World Generation Complete", len(biomes), len(terrain), len(creatures))</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h4 id="worldgenpy"><code translate="no" v-pre>worldgen.py</code></h4>
|
||||
<div id="worldgenpy-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">import time
|
||||
import random
|
||||
|
||||
def gen_world(biome_count: int, terrain_size: tuple[int, int], creature_count: int) -> dict:
|
||||
# simulate a long computation
|
||||
time.sleep(3)
|
||||
|
||||
# generate world data
|
||||
all_biomes = ["forest", "desert", "ocean", "mountain", "swamp"]
|
||||
all_creatures = ["wolf", "bear", "fish", "bird", "lizard"]
|
||||
|
||||
width, height = terrain_size
|
||||
|
||||
terrain_data = [
|
||||
random.randint(1, 10)
|
||||
for _ in range(width * height)
|
||||
]
|
||||
|
||||
creatures = [
|
||||
{
|
||||
"name": random.choice(all_creatures),
|
||||
"x": random.randint(0, width - 1),
|
||||
"y": random.randint(0, height - 1),
|
||||
}
|
||||
for i in range(creature_count)
|
||||
]
|
||||
|
||||
return {
|
||||
"biomes": all_biomes[:biome_count],
|
||||
"terrain": terrain_data,
|
||||
"creatures": creatures,
|
||||
}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>Run <code translate="no" v-pre>main.py</code> and you will see the result like this:</p>
|
||||
<div id="worldgenpy-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">Game Start
|
||||
Submit WorldGen Job
|
||||
Frame: 1
|
||||
Frame: 2
|
||||
Frame: 3
|
||||
Frame: 4
|
||||
World Generation Complete 3 10000 10</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p><code translate="no" v-pre>ComputeThread</code> uses <code translate="no" v-pre>pickle</code> module to serialize the data between threads.
|
||||
Parameters and return values must be supported by <code translate="no" v-pre>pickle</code>.
|
||||
See <a href="https://pocketpy.dev/modules/pickle/">pickle</a> for more details.</p>
|
||||
<p>Since <code translate="no" v-pre>ComputeThread</code> is backed by a separate <code translate="no" v-pre>VM</code> instance,
|
||||
it does not share any state with the main thread
|
||||
except for the parameters you pass to it.
|
||||
Therefore, common python modules will be imported twice in each thread.</p>
|
||||
<p>If you want to identify which VM instance the module is running in,
|
||||
you can call <code translate="no" v-pre>pkpy.currentvm</code> or let your <code translate="no" v-pre>ComputeThread</code> set some special flags
|
||||
before importing these modules.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/profiling/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Profiling</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../features/ub/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Undefined Behaviour</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Compute Threads", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: true, hasMath: false, tocDepth: 23, "md": "/features/threading.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
6
features/ub.md
Normal file
6
features/ub.md
Normal file
@ -0,0 +1,6 @@
|
||||
These are the undefined behaviours of pkpy. The behaviour of pkpy is undefined if you do the following things.
|
||||
|
||||
1. Delete a builtin object. For example, `del int.__add__`.
|
||||
2. Call an unbound method with the wrong type of `self`. For example, `int.__add__('1', 2)`.
|
||||
3. Type `T`'s `__new__` returns an object that is not an instance of `T`.
|
||||
4. Call `__new__` with a type that is not a subclass of `type`.
|
||||
304
features/ub/index.html
Normal file
304
features/ub/index.html
Normal file
@ -0,0 +1,304 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Undefined Behaviour | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Undefined Behaviour | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="These are the undefined behaviours of pkpy. The behaviour of pkpy is undefined if you do the following things.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/features/ub/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/features/ub/">
|
||||
<meta property="og:title" content="Undefined Behaviour | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="These are the undefined behaviours of pkpy. The behaviour of pkpy is undefined if you do the following things.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/features/ub/">
|
||||
<meta name="twitter:title" content="Undefined Behaviour | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="These are the undefined behaviours of pkpy. The behaviour of pkpy is undefined if you do the following things.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/features/ub.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="undefined-behaviour">Undefined Behaviour</h1>
|
||||
<p>These are the undefined behaviours of pkpy. The behaviour of pkpy is undefined if you do the following things.</p>
|
||||
<ol>
|
||||
<li>Delete a builtin object. For example, <code translate="no" v-pre>del int.__add__</code>.</li>
|
||||
<li>Call an unbound method with the wrong type of <code translate="no" v-pre>self</code>. For example, <code translate="no" v-pre>int.__add__('1', 2)</code>.</li>
|
||||
<li>Type <code translate="no" v-pre>T</code>'s <code translate="no" v-pre>__new__</code> returns an object that is not an instance of <code translate="no" v-pre>T</code>.</li>
|
||||
<li>Call <code translate="no" v-pre>__new__</code> with a type that is not a subclass of <code translate="no" v-pre>type</code>.</li>
|
||||
</ol>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../features/threading/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Compute Threads</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../c-api/introduction/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Introduction</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Undefined Behaviour", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/features/ub.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
52
gsoc2024/guide.md
Normal file
52
gsoc2024/guide.md
Normal file
@ -0,0 +1,52 @@
|
||||
Before starting, please read the [Ideas](./ideas.md) page and choose a project you are interested in.
|
||||
Set up a C++ compiler, clone pocketpy sources from github and try to build.
|
||||
This helps you confirm that your skills and experience match the requirements of the project.
|
||||
|
||||
### Build guide for beginners
|
||||
|
||||
First, you need to install these tools:
|
||||
|
||||
1. Python(>= 3.8), I am sure you already have it.
|
||||
2. A C++ compiler, such as GCC, Clang or MSVC. If you are on Linux, `gcc` and `g++` are already installed. If you are on Windows, you can install Visual Studio with C++ development tools.
|
||||
3. CMake(>= 3.10), a cross-platform build tool. You can use `pip install cmake` to install it.
|
||||
|
||||
Then, clone pocketpy sources from github and try to build:
|
||||
```bash
|
||||
git clone https://github.com/pocketpy/pocketpy
|
||||
cd pocketpy
|
||||
|
||||
python cmake_build.py
|
||||
```
|
||||
|
||||
If everything goes well, you will get a `main` executable (`main.exe` on Windows) in the root directory of pocketpy.
|
||||
Simply run it and you will enter pocketpy's REPL.
|
||||
```txt
|
||||
pocketpy 1.4.0 (Jan 24 2024, 12:39:13) [32 bit] on emscripten
|
||||
https://github.com/pocketpy/pocketpy
|
||||
Type "exit()" to exit.
|
||||
>>>
|
||||
>>> "Hello, world"
|
||||
'Hello, world'
|
||||
```
|
||||
|
||||
### Application guide
|
||||
|
||||
**Your need to send an email to `blueloveth@foxmail.com` with the following information:**
|
||||
|
||||
1. A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.
|
||||
2. A technical proposal for the project you are interested in working on, including:
|
||||
+ Your understanding of the project.
|
||||
+ The technical approach/architecture you will adopt.
|
||||
+ The challenges you might face and how you will overcome them.
|
||||
3. A timeline for the project, including the milestones and deliverables.
|
||||
4. Other information required by the Google Summer of Code program.
|
||||
|
||||
### Coding style guide
|
||||
|
||||
See [Coding Style Guide](../coding-style-guide.md).
|
||||
|
||||
### Contact us
|
||||
|
||||
If you have any questions, you can join our [Discord](https://discord.gg/WWaq72GzXv)
|
||||
or contact me via email.
|
||||
We are glad to help you with your application.
|
||||
345
gsoc2024/guide/index.html
Normal file
345
gsoc2024/guide/index.html
Normal file
@ -0,0 +1,345 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Application Guide | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Before starting, please read the Ideas page and choose a project you are interested in. Set up a C++ compiler, clone pocketpy sources from github and try to build.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/gsoc2024/guide/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/gsoc2024/guide/">
|
||||
<meta property="og:title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Before starting, please read the Ideas page and choose a project you are interested in. Set up a C++ compiler, clone pocketpy sources from github and try to build.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/gsoc2024/guide/">
|
||||
<meta name="twitter:title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Before starting, please read the Ideas page and choose a project you are interested in. Set up a C++ compiler, clone pocketpy sources from github and try to build.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/gsoc2024/guide.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="application-guide">Application Guide</h1>
|
||||
<p>Before starting, please read the <a href="../ideas/">Ideas</a> page and choose a project you are interested in.
|
||||
Set up a C++ compiler, clone pocketpy sources from github and try to build.
|
||||
This helps you confirm that your skills and experience match the requirements of the project.</p>
|
||||
<h3 id="build-guide-for-beginners">Build guide for beginners</h3>
|
||||
<p>First, you need to install these tools:</p>
|
||||
<ol>
|
||||
<li>Python(>= 3.8), I am sure you already have it.</li>
|
||||
<li>A C++ compiler, such as GCC, Clang or MSVC. If you are on Linux, <code translate="no" v-pre>gcc</code> and <code translate="no" v-pre>g++</code> are already installed. If you are on Windows, you can install Visual Studio with C++ development tools.</li>
|
||||
<li>CMake(>= 3.10), a cross-platform build tool. You can use <code translate="no" v-pre>pip install cmake</code> to install it.</li>
|
||||
</ol>
|
||||
<p>Then, clone pocketpy sources from github and try to build:</p>
|
||||
<div id="build-guide-for-beginners-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-bash"><code v-pre class="language-bash">git clone https://github.com/pocketpy/pocketpy
|
||||
cd pocketpy
|
||||
|
||||
python cmake_build.py</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>If everything goes well, you will get a <code translate="no" v-pre>main</code> executable (<code translate="no" v-pre>main.exe</code> on Windows) in the root directory of pocketpy.
|
||||
Simply run it and you will enter pocketpy's REPL.</p>
|
||||
<div id="build-guide-for-beginners-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">pocketpy 1.4.0 (Jan 24 2024, 12:39:13) [32 bit] on emscripten
|
||||
https://github.com/pocketpy/pocketpy
|
||||
Type "exit()" to exit.
|
||||
>>>
|
||||
>>> "Hello, world"
|
||||
'Hello, world'</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="application-guide-1">Application guide</h3>
|
||||
<p><strong>Your need to send an email to <code translate="no" v-pre>blueloveth@foxmail.com</code> with the following information:</strong></p>
|
||||
<ol>
|
||||
<li>A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.</li>
|
||||
<li>A technical proposal for the project you are interested in working on, including:
|
||||
<ul>
|
||||
<li>Your understanding of the project.</li>
|
||||
<li>The technical approach/architecture you will adopt.</li>
|
||||
<li>The challenges you might face and how you will overcome them.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>A timeline for the project, including the milestones and deliverables.</li>
|
||||
<li>Other information required by the Google Summer of Code program.</li>
|
||||
</ol>
|
||||
<h3 id="coding-style-guide">Coding style guide</h3>
|
||||
<p>See <a href="../../coding-style-guide/">Coding Style Guide</a>.</p>
|
||||
<h3 id="contact-us">Contact us</h3>
|
||||
<p>If you have any questions, you can join our <a href="https://discord.gg/WWaq72GzXv">Discord</a>
|
||||
or contact me via email.
|
||||
We are glad to help you with your application.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2025/ideas/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Project Ideas</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2024/ideas/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Project Ideas</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Application Guide", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/gsoc2024/guide.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
38
gsoc2024/ideas.md
Normal file
38
gsoc2024/ideas.md
Normal file
@ -0,0 +1,38 @@
|
||||
### Implement pybind11 for bindings
|
||||
|
||||
+ Difficulty Level: 5/5 (Hard)
|
||||
+ Skill: Advanced C++ with metaprogramming; Python
|
||||
+ Project Length: Medium (175 hours)
|
||||
|
||||
> https://summerofcode.withgoogle.com/archive/2024/projects/Ji2Mi97o
|
||||
|
||||
pocketpy has provided a low-level API for creating bindings. It is fast, lightweight and easy to debug.
|
||||
However, it still requires a lot of boilerplate code to create bindings for complex C++ classes.
|
||||
The community has long expected a high-level API for creating bindings.
|
||||
|
||||
[pybind11](https://github.com/pybind/pybind11)
|
||||
is the most popular C++ library for creating Python bindings for CPython. A bunch of Python libraries are using it. pybind11 adopts a template metaprogramming approach to automatically generate bindings for C++ classes.
|
||||
|
||||
Our goal is to introduce a pybind11 compatible solution to pocketpy as an alternative way to create bindings
|
||||
for functions and classes.
|
||||
You can use C\+\+17 features to implement it, instead of C++11 used in pybind11.
|
||||
|
||||
See https://github.com/pocketpy/pocketpy/issues/216 for more details.
|
||||
|
||||
### Add `numpy` module
|
||||
|
||||
+ Difficulty Level: 4/5 (Intermediate)
|
||||
+ Skill: Intermediate C++; Python; Linear Algebra
|
||||
+ Project Length: Medium (175 hours)
|
||||
|
||||
> https://summerofcode.withgoogle.com/archive/2024/projects/sJLuASSP
|
||||
|
||||
Though pocketpy is designed for game scripting,
|
||||
some people are using it for scientific computing.
|
||||
It would be nice to have a `numpy` module in pocketpy.
|
||||
|
||||
`numpy` is a huge project.
|
||||
Our goal is to implement a most commonly used subset of `numpy` in pocketpy.
|
||||
You can mix C++ and Python code to simplify the overall workloads.
|
||||
|
||||
See https://github.com/pocketpy/pocketpy/issues/202 for more details.
|
||||
331
gsoc2024/ideas/index.html
Normal file
331
gsoc2024/ideas/index.html
Normal file
@ -0,0 +1,331 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Project Ideas | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Difficulty Level: 5/5 (Hard)">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/gsoc2024/ideas/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/gsoc2024/ideas/">
|
||||
<meta property="og:title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Difficulty Level: 5/5 (Hard)">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/gsoc2024/ideas/">
|
||||
<meta name="twitter:title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Difficulty Level: 5/5 (Hard)">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/gsoc2024/ideas.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="project-ideas">Project Ideas</h1>
|
||||
<h3 id="implement-pybind11-for-bindings">Implement pybind11 for bindings</h3>
|
||||
<ul>
|
||||
<li>Difficulty Level: 5/5 (Hard)</li>
|
||||
<li>Skill: Advanced C++ with metaprogramming; Python</li>
|
||||
<li>Project Length: Medium (175 hours)</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><a href="https://summerofcode.withgoogle.com/archive/2024/projects/Ji2Mi97o">https://summerofcode.withgoogle.com/archive/2024/projects/Ji2Mi97o</a></p>
|
||||
</blockquote>
|
||||
<p>pocketpy has provided a low-level API for creating bindings. It is fast, lightweight and easy to debug.
|
||||
However, it still requires a lot of boilerplate code to create bindings for complex C++ classes.
|
||||
The community has long expected a high-level API for creating bindings.</p>
|
||||
<p><a href="https://github.com/pybind/pybind11">pybind11</a>
|
||||
is the most popular C++ library for creating Python bindings for CPython. A bunch of Python libraries are using it. pybind11 adopts a template metaprogramming approach to automatically generate bindings for C++ classes.</p>
|
||||
<p>Our goal is to introduce a pybind11 compatible solution to pocketpy as an alternative way to create bindings
|
||||
for functions and classes.
|
||||
You can use C++17 features to implement it, instead of C++11 used in pybind11.</p>
|
||||
<p>See <a href="https://github.com/pocketpy/pocketpy/issues/216">https://github.com/pocketpy/pocketpy/issues/216</a> for more details.</p>
|
||||
<h3 id="add-numpy-module">Add <code translate="no" v-pre>numpy</code> module</h3>
|
||||
<ul>
|
||||
<li>Difficulty Level: 4/5 (Intermediate)</li>
|
||||
<li>Skill: Intermediate C++; Python; Linear Algebra</li>
|
||||
<li>Project Length: Medium (175 hours)</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><a href="https://summerofcode.withgoogle.com/archive/2024/projects/sJLuASSP">https://summerofcode.withgoogle.com/archive/2024/projects/sJLuASSP</a></p>
|
||||
</blockquote>
|
||||
<p>Though pocketpy is designed for game scripting,
|
||||
some people are using it for scientific computing.
|
||||
It would be nice to have a <code translate="no" v-pre>numpy</code> module in pocketpy.</p>
|
||||
<p><code translate="no" v-pre>numpy</code> is a huge project.
|
||||
Our goal is to implement a most commonly used subset of <code translate="no" v-pre>numpy</code> in pocketpy.
|
||||
You can mix C++ and Python code to simplify the overall workloads.</p>
|
||||
<p>See <a href="https://github.com/pocketpy/pocketpy/issues/202">https://github.com/pocketpy/pocketpy/issues/202</a> for more details.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2024/guide/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Application Guide</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../coding-style-guide/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Coding Style Guide</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Project Ideas", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/gsoc2024/ideas.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
52
gsoc2025/guide.md
Normal file
52
gsoc2025/guide.md
Normal file
@ -0,0 +1,52 @@
|
||||
Before starting, please read the [Ideas](./ideas.md) page and choose a project you are interested in.
|
||||
Set up a C11 compiler, clone pocketpy sources from github and try to build.
|
||||
This helps you confirm that your skills and experience match the requirements of the project.
|
||||
|
||||
### Build guide for beginners
|
||||
|
||||
First, you need to install these tools:
|
||||
|
||||
1. Python(>= 3.8), I am sure you already have it.
|
||||
2. A C11 compiler, such as GCC, Clang or MSVC. If you are on Linux, `gcc` is already installed. If you are on Windows, you can install Visual Studio with C/C++ development tools.
|
||||
3. CMake(>= 3.10), a cross-platform build tool. You can use `pip install cmake` to install it.
|
||||
|
||||
Then, clone pocketpy sources from github and try to build:
|
||||
```bash
|
||||
git clone https://github.com/pocketpy/pocketpy
|
||||
cd pocketpy
|
||||
|
||||
python cmake_build.py
|
||||
```
|
||||
|
||||
If everything goes well, you will get a `main` executable (`main.exe` on Windows) in the root directory of pocketpy.
|
||||
Simply run it and you will enter pocketpy's REPL.
|
||||
```txt
|
||||
pocketpy 2.0.5 (Jan 17 2025, 14:36:15) [64 bit] on darwin
|
||||
https://github.com/pocketpy/pocketpy
|
||||
Type "exit()" to exit.
|
||||
>>>
|
||||
>>> "Hello, world"
|
||||
'Hello, world'
|
||||
```
|
||||
|
||||
### Application guide
|
||||
|
||||
**Your need to send an email to `blueloveth@foxmail.com` with the following information:**
|
||||
|
||||
1. A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.
|
||||
2. A technical proposal for the project you are interested in working on, including:
|
||||
+ Your understanding of the project.
|
||||
+ The technical approach/architecture you will adopt.
|
||||
+ The challenges you might face and how you will overcome them.
|
||||
3. A timeline for the project, including the milestones and deliverables.
|
||||
4. Other information required by the Google Summer of Code program.
|
||||
|
||||
### Coding style guide
|
||||
|
||||
See [Coding Style Guide](../coding-style-guide.md).
|
||||
|
||||
### Contact us
|
||||
|
||||
If you have any questions, you can join our [Discord](https://discord.gg/WWaq72GzXv)
|
||||
or contact me via email.
|
||||
We are glad to help you with your application.
|
||||
345
gsoc2025/guide/index.html
Normal file
345
gsoc2025/guide/index.html
Normal file
@ -0,0 +1,345 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Application Guide | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Before starting, please read the Ideas page and choose a project you are interested in. Set up a C11 compiler, clone pocketpy sources from github and try to build.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/gsoc2025/guide/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/gsoc2025/guide/">
|
||||
<meta property="og:title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Before starting, please read the Ideas page and choose a project you are interested in. Set up a C11 compiler, clone pocketpy sources from github and try to build.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/gsoc2025/guide/">
|
||||
<meta name="twitter:title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Before starting, please read the Ideas page and choose a project you are interested in. Set up a C11 compiler, clone pocketpy sources from github and try to build.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/gsoc2025/guide.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="application-guide">Application Guide</h1>
|
||||
<p>Before starting, please read the <a href="../ideas/">Ideas</a> page and choose a project you are interested in.
|
||||
Set up a C11 compiler, clone pocketpy sources from github and try to build.
|
||||
This helps you confirm that your skills and experience match the requirements of the project.</p>
|
||||
<h3 id="build-guide-for-beginners">Build guide for beginners</h3>
|
||||
<p>First, you need to install these tools:</p>
|
||||
<ol>
|
||||
<li>Python(>= 3.8), I am sure you already have it.</li>
|
||||
<li>A C11 compiler, such as GCC, Clang or MSVC. If you are on Linux, <code translate="no" v-pre>gcc</code> is already installed. If you are on Windows, you can install Visual Studio with C/C++ development tools.</li>
|
||||
<li>CMake(>= 3.10), a cross-platform build tool. You can use <code translate="no" v-pre>pip install cmake</code> to install it.</li>
|
||||
</ol>
|
||||
<p>Then, clone pocketpy sources from github and try to build:</p>
|
||||
<div id="build-guide-for-beginners-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-bash"><code v-pre class="language-bash">git clone https://github.com/pocketpy/pocketpy
|
||||
cd pocketpy
|
||||
|
||||
python cmake_build.py</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>If everything goes well, you will get a <code translate="no" v-pre>main</code> executable (<code translate="no" v-pre>main.exe</code> on Windows) in the root directory of pocketpy.
|
||||
Simply run it and you will enter pocketpy's REPL.</p>
|
||||
<div id="build-guide-for-beginners-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">pocketpy 2.0.5 (Jan 17 2025, 14:36:15) [64 bit] on darwin
|
||||
https://github.com/pocketpy/pocketpy
|
||||
Type "exit()" to exit.
|
||||
>>>
|
||||
>>> "Hello, world"
|
||||
'Hello, world'</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="application-guide-1">Application guide</h3>
|
||||
<p><strong>Your need to send an email to <code translate="no" v-pre>blueloveth@foxmail.com</code> with the following information:</strong></p>
|
||||
<ol>
|
||||
<li>A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.</li>
|
||||
<li>A technical proposal for the project you are interested in working on, including:
|
||||
<ul>
|
||||
<li>Your understanding of the project.</li>
|
||||
<li>The technical approach/architecture you will adopt.</li>
|
||||
<li>The challenges you might face and how you will overcome them.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>A timeline for the project, including the milestones and deliverables.</li>
|
||||
<li>Other information required by the Google Summer of Code program.</li>
|
||||
</ol>
|
||||
<h3 id="coding-style-guide">Coding style guide</h3>
|
||||
<p>See <a href="../../coding-style-guide/">Coding Style Guide</a>.</p>
|
||||
<h3 id="contact-us">Contact us</h3>
|
||||
<p>If you have any questions, you can join our <a href="https://discord.gg/WWaq72GzXv">Discord</a>
|
||||
or contact me via email.
|
||||
We are glad to help you with your application.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2026/ideas/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Project Ideas</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2025/ideas/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Project Ideas</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Application Guide", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/gsoc2025/guide.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
22
gsoc2025/ideas.md
Normal file
22
gsoc2025/ideas.md
Normal file
@ -0,0 +1,22 @@
|
||||
### VSCode plugin for debugging pocketpy applications
|
||||
|
||||
+ Difficulty Level: 3/5 (Medium)
|
||||
+ Skill: TypeScript; C
|
||||
+ Project Length: Medium
|
||||
|
||||
Community users have reported that there is no convenient way to debug python applications interpreted by pocketpy. Fortunately, VSCode provides a mechanism of [Debugger Extension](https://code.visualstudio.com/api/extension-guides/debugger-extension) that allows us to integrate pocketpy debugger into VSCode UI through Debug Adapter Protocol (DAP).
|
||||
|
||||
This project aims to develop a VSCode plugin like [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy), which implements DAP for pocketpy. With this plugin, users can launch their pocketpy applications in VSCode with breakpoints, call stacks, and variable inspection. Students with experience in TypeScript will be helpful for this project.
|
||||
|
||||
### Develop math operators for `cTensor` library
|
||||
|
||||
+ Difficulty Level: 4/5 (Hard)
|
||||
+ Skill: C; Further Mathematics
|
||||
+ Project Length: Small or Medium
|
||||
|
||||
pocketpy is providing a tensor library `cTensor` for users who want to integrate neural networks into their applications. `cTensor` implements automatic differentiation and dynamic compute graph. It allows users to train and deploy neural networks on client-side devices like mobile phones and microcontrollers (e.g. ESP32-C3). We have a runable prototype located at [pocketpy/cTensor](https://github.com/pocketpy/cTensor). But math operators have not been implemented yet.
|
||||
|
||||
In this project, students will develop forward and backward math operators, as well as basic neural network layers and optimizers (e.g. SGD, Adam). The project is written in C11.
|
||||
We expect students to have a good understanding of further mathematics and C programming.
|
||||
|
||||
> This year we also accept custom project ideas. If you are not interested in the above, you can propose your own idea and contact me via `blueloveth@foxmail.com`. We will discuss the feasibility and mentorship for your idea.
|
||||
317
gsoc2025/ideas/index.html
Normal file
317
gsoc2025/ideas/index.html
Normal file
@ -0,0 +1,317 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Project Ideas | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Difficulty Level: 3/5 (Medium)">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/gsoc2025/ideas/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/gsoc2025/ideas/">
|
||||
<meta property="og:title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Difficulty Level: 3/5 (Medium)">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/gsoc2025/ideas/">
|
||||
<meta name="twitter:title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Difficulty Level: 3/5 (Medium)">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/gsoc2025/ideas.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="project-ideas">Project Ideas</h1>
|
||||
<h3 id="vscode-plugin-for-debugging-pocketpy-applications">VSCode plugin for debugging pocketpy applications</h3>
|
||||
<ul>
|
||||
<li>Difficulty Level: 3/5 (Medium)</li>
|
||||
<li>Skill: TypeScript; C</li>
|
||||
<li>Project Length: Medium</li>
|
||||
</ul>
|
||||
<p>Community users have reported that there is no convenient way to debug python applications interpreted by pocketpy. Fortunately, VSCode provides a mechanism of <a href="https://code.visualstudio.com/api/extension-guides/debugger-extension">Debugger Extension</a> that allows us to integrate pocketpy debugger into VSCode UI through Debug Adapter Protocol (DAP).</p>
|
||||
<p>This project aims to develop a VSCode plugin like <a href="https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy">Python Debugger</a>, which implements DAP for pocketpy. With this plugin, users can launch their pocketpy applications in VSCode with breakpoints, call stacks, and variable inspection. Students with experience in TypeScript will be helpful for this project.</p>
|
||||
<h3 id="develop-math-operators-for-ctensor-library">Develop math operators for <code translate="no" v-pre>cTensor</code> library</h3>
|
||||
<ul>
|
||||
<li>Difficulty Level: 4/5 (Hard)</li>
|
||||
<li>Skill: C; Further Mathematics</li>
|
||||
<li>Project Length: Small or Medium</li>
|
||||
</ul>
|
||||
<p>pocketpy is providing a tensor library <code translate="no" v-pre>cTensor</code> for users who want to integrate neural networks into their applications. <code translate="no" v-pre>cTensor</code> implements automatic differentiation and dynamic compute graph. It allows users to train and deploy neural networks on client-side devices like mobile phones and microcontrollers (e.g. ESP32-C3). We have a runable prototype located at <a href="https://github.com/pocketpy/cTensor">pocketpy/cTensor</a>. But math operators have not been implemented yet.</p>
|
||||
<p>In this project, students will develop forward and backward math operators, as well as basic neural network layers and optimizers (e.g. SGD, Adam). The project is written in C11.
|
||||
We expect students to have a good understanding of further mathematics and C programming.</p>
|
||||
<blockquote>
|
||||
<p>This year we also accept custom project ideas. If you are not interested in the above, you can propose your own idea and contact me via <code translate="no" v-pre>blueloveth@foxmail.com</code>. We will discuss the feasibility and mentorship for your idea.</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2025/guide/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Application Guide</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2024/guide/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Application Guide</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Project Ideas", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/gsoc2025/ideas.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
69
gsoc2026/guide.md
Normal file
69
gsoc2026/guide.md
Normal file
@ -0,0 +1,69 @@
|
||||
Welcome to the Google Summer of Code 2026 application guide for pocketpy.
|
||||
We are recruiting a student who is passionate about vibe coding and mobile game development.
|
||||
|
||||
See [Project Ideas](./ideas.md) for more details about the project.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To apply for this project, you need to satisfy the following prerequisites:
|
||||
|
||||
+ You are a student enrolled in an accredited institution (university, college, etc.) pursuing a degree in computer science or a related field. And this is your first time participating in Google Summer of Code.
|
||||
+ You have interest in vibe coding and mobile game development.
|
||||
+ You are experienced in [Python](https://www.python.org/) and backend technologies, such as [FastAPI](https://fastapi.tiangolo.com/) or [Flask](https://flask.palletsprojects.com/).
|
||||
+ You are glad to learn game engines like [Godot](https://godotengine.org/).
|
||||
|
||||
## Application steps
|
||||
|
||||
### Step 1
|
||||
|
||||
If you think you meet the prerequisites,
|
||||
send an email to `blueloveth@foxmail.com` with the following information.
|
||||
|
||||
1. A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.
|
||||
2. Your understanding of this project and why you are capable of completing it.
|
||||
3. Your free time during the whole GSoC period (From 2026-03-01 to 2026-08-31).
|
||||
|
||||
### Step 2
|
||||
|
||||
After you get a positive reply from us,
|
||||
you need to complete 1~2 pull requests to pocketpy's repository on GitHub.
|
||||
This is mandatory as it demonstrates your coding skills and commitment to the project.
|
||||
We will provide you a few good first issues to work on.
|
||||
|
||||
### Step 3
|
||||
|
||||
Once your pull requests are merged,
|
||||
we will guide you to write a full proposal
|
||||
for the project you are going to work on during GSoC 2026.
|
||||
This proposal will be submitted to Google for review.
|
||||
|
||||
## Build guide for pocketpy
|
||||
|
||||
First, you need to install these tools:
|
||||
|
||||
1. Python(>= 3.8), I am sure you already have it.
|
||||
2. A C11 compiler, such as GCC, Clang or MSVC. If you are on Linux, `gcc` is already installed. If you are on Windows, you can install Visual Studio with C/C++ development tools.
|
||||
3. CMake(>= 3.10), a cross-platform build tool. You can use `pip install cmake` to install it.
|
||||
|
||||
Then, clone pocketpy sources from github and try to build:
|
||||
```bash
|
||||
git clone https://github.com/pocketpy/pocketpy
|
||||
cd pocketpy
|
||||
|
||||
python cmake_build.py
|
||||
```
|
||||
|
||||
If everything goes well, you will get a `main` executable (`main.exe` on Windows) in the root directory of pocketpy.
|
||||
Simply run it and you will enter pocketpy's REPL.
|
||||
```txt
|
||||
pocketpy 2.1.7 (Jan 7 2026, 16:42:45) [64 bit] on darwin
|
||||
https://github.com/pocketpy/pocketpy
|
||||
Type "exit()" to exit.
|
||||
>>>
|
||||
>>> "Hello, world"
|
||||
'Hello, world'
|
||||
```
|
||||
|
||||
## Coding style guide
|
||||
|
||||
See [Coding Style Guide](../coding-style-guide.md).
|
||||
354
gsoc2026/guide/index.html
Normal file
354
gsoc2026/guide/index.html
Normal file
@ -0,0 +1,354 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Application Guide | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Welcome to the Google Summer of Code 2026 application guide for pocketpy. We are recruiting a student who is passionate about vibe coding and mobile game development.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/gsoc2026/guide/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/gsoc2026/guide/">
|
||||
<meta property="og:title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Welcome to the Google Summer of Code 2026 application guide for pocketpy. We are recruiting a student who is passionate about vibe coding and mobile game development.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/gsoc2026/guide/">
|
||||
<meta name="twitter:title" content="Application Guide | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Welcome to the Google Summer of Code 2026 application guide for pocketpy. We are recruiting a student who is passionate about vibe coding and mobile game development.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/gsoc2026/guide.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="application-guide">Application Guide</h1>
|
||||
<p>Welcome to the Google Summer of Code 2026 application guide for pocketpy.
|
||||
We are recruiting a student who is passionate about vibe coding and mobile game development.</p>
|
||||
<p>See <a href="../ideas/">Project Ideas</a> for more details about the project.</p>
|
||||
<h2 id="prerequisites">Prerequisites</h2>
|
||||
<p>To apply for this project, you need to satisfy the following prerequisites:</p>
|
||||
<ul>
|
||||
<li>You are a student enrolled in an accredited institution (university, college, etc.) pursuing a degree in computer science or a related field. And this is your first time participating in Google Summer of Code.</li>
|
||||
<li>You have interest in vibe coding and mobile game development.</li>
|
||||
<li>You are experienced in <a href="https://www.python.org/">Python</a> and backend technologies, such as <a href="https://fastapi.tiangolo.com/">FastAPI</a> or <a href="https://flask.palletsprojects.com/">Flask</a>.</li>
|
||||
<li>You are glad to learn game engines like <a href="https://godotengine.org/">Godot</a>.</li>
|
||||
</ul>
|
||||
<h2 id="application-steps">Application steps</h2>
|
||||
<h3 id="step-1">Step 1</h3>
|
||||
<p>If you think you meet the prerequisites,
|
||||
send an email to <code translate="no" v-pre>blueloveth@foxmail.com</code> with the following information.</p>
|
||||
<ol>
|
||||
<li>A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.</li>
|
||||
<li>Your understanding of this project and why you are capable of completing it.</li>
|
||||
<li>Your free time during the whole GSoC period (From 2026-03-01 to 2026-08-31).</li>
|
||||
</ol>
|
||||
<h3 id="step-2">Step 2</h3>
|
||||
<p>After you get a positive reply from us,
|
||||
you need to complete 1~2 pull requests to pocketpy's repository on GitHub.
|
||||
This is mandatory as it demonstrates your coding skills and commitment to the project.
|
||||
We will provide you a few good first issues to work on.</p>
|
||||
<h3 id="step-3">Step 3</h3>
|
||||
<p>Once your pull requests are merged,
|
||||
we will guide you to write a full proposal
|
||||
for the project you are going to work on during GSoC 2026.
|
||||
This proposal will be submitted to Google for review.</p>
|
||||
<h2 id="build-guide-for-pocketpy">Build guide for pocketpy</h2>
|
||||
<p>First, you need to install these tools:</p>
|
||||
<ol>
|
||||
<li>Python(>= 3.8), I am sure you already have it.</li>
|
||||
<li>A C11 compiler, such as GCC, Clang or MSVC. If you are on Linux, <code translate="no" v-pre>gcc</code> is already installed. If you are on Windows, you can install Visual Studio with C/C++ development tools.</li>
|
||||
<li>CMake(>= 3.10), a cross-platform build tool. You can use <code translate="no" v-pre>pip install cmake</code> to install it.</li>
|
||||
</ol>
|
||||
<p>Then, clone pocketpy sources from github and try to build:</p>
|
||||
<div id="build-guide-for-pocketpy-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-bash"><code v-pre class="language-bash">git clone https://github.com/pocketpy/pocketpy
|
||||
cd pocketpy
|
||||
|
||||
python cmake_build.py</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<p>If everything goes well, you will get a <code translate="no" v-pre>main</code> executable (<code translate="no" v-pre>main.exe</code> on Windows) in the root directory of pocketpy.
|
||||
Simply run it and you will enter pocketpy's REPL.</p>
|
||||
<div id="build-guide-for-pocketpy-code-2" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">pocketpy 2.1.7 (Jan 7 2026, 16:42:45) [64 bit] on darwin
|
||||
https://github.com/pocketpy/pocketpy
|
||||
Type "exit()" to exit.
|
||||
>>>
|
||||
>>> "Hello, world"
|
||||
'Hello, world'</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="coding-style-guide">Coding style guide</h2>
|
||||
<p>See <a href="../../coding-style-guide/">Coding Style Guide</a>.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/vmath/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">vmath</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2026/ideas/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Project Ideas</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Application Guide", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/gsoc2026/guide.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
34
gsoc2026/ideas.md
Normal file
34
gsoc2026/ideas.md
Normal file
@ -0,0 +1,34 @@
|
||||
## Idea Title
|
||||
|
||||
Build a Vibe Coding Agent in Python for Creating Games
|
||||
|
||||
## Project Size
|
||||
|
||||
Medium
|
||||
|
||||
## Related Skills
|
||||
|
||||
- CPython
|
||||
- Agentic Programming
|
||||
- Prompt Engineering
|
||||
- Game Engines
|
||||
|
||||
## Description
|
||||
|
||||
pocketpy is an organization dedicated to creating game development tools in Python language.
|
||||
Nowadays, vibe coding has become a popular approach for rapid game development, allowing developers to create games quickly and efficiently by leveraging language models and agentic programming techniques.
|
||||
|
||||
For Google Summer of Code 2026, we are looking for a student to develop a vibe coding agent that can assist developers in creating games.
|
||||
This agent is composed of two main components,
|
||||
backend and frontend.
|
||||
|
||||
The backend part should be developed in CPython,
|
||||
which is composed of the following modules:
|
||||
|
||||
+ Virtual Container. The agent needs to create a virtual linux container for each vibe coding project. This module provides management for users' sources and assets inside the container.
|
||||
+ AI Service Provider. This module is responsible for communicating with AI service providers, such as OpenAI, to generate code and assets based on user prompts.
|
||||
+ Persistent Memory. This module stores the state of each vibe coding project, including project progress, user preferences, and other relevant information.
|
||||
+ Agentic Core. This module uses Persistent Memory and AI Service Provider to implement the agentic programming logic, enabling the agent to understand user prompts and generate appropriate code and assets.
|
||||
+ Game Engine Integration.
|
||||
|
||||
For more details, we will discuss with the selected student during the community bonding period.
|
||||
324
gsoc2026/ideas/index.html
Normal file
324
gsoc2026/ideas/index.html
Normal file
@ -0,0 +1,324 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Project Ideas | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Build a Vibe Coding Agent in Python for Creating Games">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/gsoc2026/ideas/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/gsoc2026/ideas/">
|
||||
<meta property="og:title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Build a Vibe Coding Agent in Python for Creating Games">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/gsoc2026/ideas/">
|
||||
<meta name="twitter:title" content="Project Ideas | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Build a Vibe Coding Agent in Python for Creating Games">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/gsoc2026/ideas.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="project-ideas">Project Ideas</h1>
|
||||
<h2 id="idea-title">Idea Title</h2>
|
||||
<p>Build a Vibe Coding Agent in Python for Creating Games</p>
|
||||
<h2 id="project-size">Project Size</h2>
|
||||
<p>Medium</p>
|
||||
<h2 id="related-skills">Related Skills</h2>
|
||||
<ul>
|
||||
<li>CPython</li>
|
||||
<li>Agentic Programming</li>
|
||||
<li>Prompt Engineering</li>
|
||||
<li>Game Engines</li>
|
||||
</ul>
|
||||
<h2 id="description">Description</h2>
|
||||
<p>pocketpy is an organization dedicated to creating game development tools in Python language.
|
||||
Nowadays, vibe coding has become a popular approach for rapid game development, allowing developers to create games quickly and efficiently by leveraging language models and agentic programming techniques.</p>
|
||||
<p>For Google Summer of Code 2026, we are looking for a student to develop a vibe coding agent that can assist developers in creating games.
|
||||
This agent is composed of two main components,
|
||||
backend and frontend.</p>
|
||||
<p>The backend part should be developed in CPython,
|
||||
which is composed of the following modules:</p>
|
||||
<ul>
|
||||
<li>Virtual Container. The agent needs to create a virtual linux container for each vibe coding project. This module provides management for users' sources and assets inside the container.</li>
|
||||
<li>AI Service Provider. This module is responsible for communicating with AI service providers, such as OpenAI, to generate code and assets based on user prompts.</li>
|
||||
<li>Persistent Memory. This module stores the state of each vibe coding project, including project progress, user preferences, and other relevant information.</li>
|
||||
<li>Agentic Core. This module uses Persistent Memory and AI Service Provider to implement the agentic programming logic, enabling the agent to understand user prompts and generate appropriate code and assets.</li>
|
||||
<li>Game Engine Integration.</li>
|
||||
</ul>
|
||||
<p>For more details, we will discuss with the selected student during the community bonding period.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2026/guide/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Application Guide</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../gsoc2025/guide/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Application Guide</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Project Ideas", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/gsoc2026/ideas.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
343
index.html
Normal file
343
index.html
Normal file
@ -0,0 +1,343 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>Welcome to pocketpy | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="Welcome to pocketpy | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="pocketpy is a portable Python 3.x interpreter, written in C11. It aims to be an alternative to Lua for game scripting, with elegant syntax, powerful features and competitive performance.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/">
|
||||
<meta property="og:title" content="Welcome to pocketpy | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="pocketpy is a portable Python 3.x interpreter, written in C11. It aims to be an alternative to Lua for game scripting, with elegant syntax, powerful features and competitive performance.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/">
|
||||
<meta name="twitter:title" content="Welcome to pocketpy | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="pocketpy is a portable Python 3.x interpreter, written in C11. It aims to be an alternative to Lua for game scripting, with elegant syntax, powerful features and competitive performance.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/index.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="static/logo.png" />
|
||||
<link href="resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="welcome-to-pocketpy">Welcome to pocketpy</h1>
|
||||
<p>pocketpy is a portable Python 3.x interpreter, written in C11.
|
||||
It aims to be an alternative to Lua for game scripting, with elegant syntax, powerful features and competitive performance.
|
||||
pocketpy has no dependencies other than the C standard library, which can be easily integrated into your C/C++ project.
|
||||
Developers are able to write Python bindings via C-API or pybind11 compatible interfaces.</p>
|
||||
<ul>
|
||||
<li><a href="https://pocketpy.dev/static/web/">Live Python Demo</a>: Run Python code in your browser</li>
|
||||
<li><a href="https://pocketpy.github.io/examples/">Live C Examples</a>: Explore C-APIs in your browser</li>
|
||||
<li><a href="https://github.com/pocketpy/godot-pocketpy">Godot Extension</a>: Use pocketpy in Godot Engine</li>
|
||||
<li><a href="https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy">VSCode Extension</a>: Debug and profile pocketpy scripts in VSCode</li>
|
||||
<li><a href="https://pub.dev/packages/pocketpy">Flutter Plugin</a>: Use pocketpy in Flutter apps</li>
|
||||
<li><a href="https://github.com/pocketpy/raylib-bindings">Raylib Bindings</a>: Use raylib with pocketpy</li>
|
||||
</ul>
|
||||
<h2 id="what-it-looks-like">What it looks like</h2>
|
||||
<div id="what-it-looks-like-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">def is_prime(x):
|
||||
if x < 2:
|
||||
return False
|
||||
for i in range(2, x):
|
||||
if x % i == 0:
|
||||
return False
|
||||
return True
|
||||
|
||||
primes = [i for i in range(2, 20) if is_prime(i)]
|
||||
print(primes)
|
||||
# [2, 3, 5, 7, 11, 13, 17, 19]</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h2 id="supported-platforms">Supported platforms</h2>
|
||||
<p>pkpy should work on any platform with a C11 compiler.
|
||||
These platforms are officially tested.</p>
|
||||
<ul>
|
||||
<li>Windows 64-bit</li>
|
||||
<li>Linux 64-bit / 32-bit</li>
|
||||
<li>macOS 64-bit</li>
|
||||
<li>Android 64-bit / 32-bit</li>
|
||||
<li>iOS 64-bit</li>
|
||||
<li>Emscripten 32-bit</li>
|
||||
<li>Raspberry Pi OS 64-bit</li>
|
||||
<li><a href="https://github.com/LuckfoxTECH/luckfox-pico">Luckfox Pico SDK</a> 32-bit</li>
|
||||
</ul>
|
||||
<p>On Windows platform, only MSVC compiler is officially supported.</p>
|
||||
<h2 id="star-the-repo">Star the repo</h2>
|
||||
<p>If you find pkpy useful, consider <a href="https://github.com/blueloveth/pocketpy">star this repository</a> (●'◡'●)</p>
|
||||
<h2 id="sponsor-this-project">Sponsor this project</h2>
|
||||
<p>You can sponsor this project via these ways.</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/sponsors/blueloveTH">Github Sponsors</a></li>
|
||||
<li><a href="https://www.buymeacoffee.com/blueloveth">Buy me a coffee</a></li>
|
||||
</ul>
|
||||
<p>Your sponsorship will help us develop pkpy continuously.</p>
|
||||
<h2 id="upgrade-to-v20">Upgrade to v2.0</h2>
|
||||
<p>pkpy v2.0 is a C11 project instead of C++17. All your existing code for v1.x won't work anymore.</p>
|
||||
<p>We provide two API sets for v2.0, C-API and pybind11 API (C++17). If you are a C user, use the C-API. If you are a C++ user, use the pybind11 API.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l rounded-r-lg transition-colors duration-150 relative hover:z-5" href="quick-start/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">Quick Start</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "Welcome", isRoot: true, level: 0, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/index.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
64
index.md
Normal file
64
index.md
Normal file
@ -0,0 +1,64 @@
|
||||
# Welcome to pocketpy
|
||||
|
||||
pocketpy is a portable Python 3.x interpreter, written in C11.
|
||||
It aims to be an alternative to Lua for game scripting, with elegant syntax, powerful features and competitive performance.
|
||||
pocketpy has no dependencies other than the C standard library, which can be easily integrated into your C/C++ project.
|
||||
Developers are able to write Python bindings via C-API or pybind11 compatible interfaces.
|
||||
|
||||
+ [Live Python Demo](https://pocketpy.dev/static/web/): Run Python code in your browser
|
||||
+ [Live C Examples](https://pocketpy.github.io/examples/): Explore C-APIs in your browser
|
||||
+ [Godot Extension](https://github.com/pocketpy/godot-pocketpy): Use pocketpy in Godot Engine
|
||||
+ [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy): Debug and profile pocketpy scripts in VSCode
|
||||
+ [Flutter Plugin](https://pub.dev/packages/pocketpy): Use pocketpy in Flutter apps
|
||||
+ [Raylib Bindings](https://github.com/pocketpy/raylib-bindings): Use raylib with pocketpy
|
||||
|
||||
## What it looks like
|
||||
|
||||
```python
|
||||
def is_prime(x):
|
||||
if x < 2:
|
||||
return False
|
||||
for i in range(2, x):
|
||||
if x % i == 0:
|
||||
return False
|
||||
return True
|
||||
|
||||
primes = [i for i in range(2, 20) if is_prime(i)]
|
||||
print(primes)
|
||||
# [2, 3, 5, 7, 11, 13, 17, 19]
|
||||
```
|
||||
|
||||
## Supported platforms
|
||||
|
||||
pkpy should work on any platform with a C11 compiler.
|
||||
These platforms are officially tested.
|
||||
|
||||
+ Windows 64-bit
|
||||
+ Linux 64-bit / 32-bit
|
||||
+ macOS 64-bit
|
||||
+ Android 64-bit / 32-bit
|
||||
+ iOS 64-bit
|
||||
+ Emscripten 32-bit
|
||||
+ Raspberry Pi OS 64-bit
|
||||
+ [Luckfox Pico SDK](https://github.com/LuckfoxTECH/luckfox-pico) 32-bit
|
||||
|
||||
On Windows platform, only MSVC compiler is officially supported.
|
||||
|
||||
## Star the repo
|
||||
|
||||
If you find pkpy useful, consider [star this repository](https://github.com/blueloveth/pocketpy) (●'◡'●)
|
||||
|
||||
## Sponsor this project
|
||||
|
||||
You can sponsor this project via these ways.
|
||||
|
||||
+ [Github Sponsors](https://github.com/sponsors/blueloveTH)
|
||||
+ [Buy me a coffee](https://www.buymeacoffee.com/blueloveth)
|
||||
|
||||
Your sponsorship will help us develop pkpy continuously.
|
||||
|
||||
## Upgrade to v2.0
|
||||
|
||||
pkpy v2.0 is a C11 project instead of C++17. All your existing code for v1.x won't work anymore.
|
||||
|
||||
We provide two API sets for v2.0, C-API and pybind11 API (C\+\+17). If you are a C user, use the C-API. If you are a C\+\+ user, use the pybind11 API.
|
||||
27
license.md
Normal file
27
license.md
Normal file
@ -0,0 +1,27 @@
|
||||
# License
|
||||
|
||||
pkpy is licensed under the [MIT License](http://opensource.org/licenses/MIT).
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 blueloveTH
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
314
license/index.html
Normal file
314
license/index.html
Normal file
@ -0,0 +1,314 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>License | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="License | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="pkpy is licensed under the MIT License.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/license/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/license/">
|
||||
<meta property="og:title" content="License | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="pkpy is licensed under the MIT License.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/license/">
|
||||
<meta name="twitter:title" content="License | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="pkpy is licensed under the MIT License.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/license.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../static/logo.png" />
|
||||
<link href="../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="license">License</h1>
|
||||
<p>pkpy is licensed under the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
||||
<div id="license-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">MIT License
|
||||
|
||||
Copyright (c) 2026 blueloveTH
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../performance/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Performance</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "License", level: 1, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/license.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
73
llms.txt
Normal file
73
llms.txt
Normal file
@ -0,0 +1,73 @@
|
||||
# | Portable Python 3.x Interpreter in Modern C
|
||||
|
||||
> pocketpy is a portable Python 3.x interpreter, written in C11. It aims to be an alternative to Lua for game scripting, with elegant syntax, powerful features and competitive performance.
|
||||
|
||||
- [Welcome to pocketpy](https://pocketpy.dev/index.md): Welcome to pocketpy
|
||||
- [Quick Start](https://pocketpy.dev/quick-start.md): You have two options to integrate pkpy into your project.
|
||||
- [Write C Bindings](https://pocketpy.dev/bindings.md): In order to use a C/C++ library in python, you need to write bindings for it.
|
||||
- [Write C++ Bindings](https://pocketpy.dev/bindings-cpp.md): pkpy provides a pybind11 compatible layer which allows users to do convenient bindings. Header files are located in the include/pybind11 directory. Make sure you have added -Iinclude to your compiler flags.
|
||||
- [Coding Style Guide](https://pocketpy.dev/coding-style-guide.md): Use four spaces for indentation. Do not use TAB.
|
||||
- [Performance](https://pocketpy.dev/performance.md): Currently, pkpy is as fast as cpython 3.9. Performance results for cpython 3.9 are applicable to for pkpy.
|
||||
- [License](https://pocketpy.dev/license.md): pkpy is licensed under the MIT License.
|
||||
|
||||
## Features
|
||||
|
||||
- [Basic Features](https://pocketpy.dev/features/basic.md): The following table shows the basic features of pkpy with respect to cpython.
|
||||
- [Comparison with CPython](https://pocketpy.dev/features/differences.md): cpython is the reference implementation of the Python programming language. It is written in C and is the most widely used implementation of Python.
|
||||
- [Deploy Bytecodes](https://pocketpy.dev/features/deploy.md): The feature requires pocketpy version >= 2.1.7
|
||||
- [Debugging](https://pocketpy.dev/features/debugging.md): To debug a pocketpy program, you need to install our VSCode extension first:
|
||||
- [Profiling](https://pocketpy.dev/features/profiling.md): To profile your pocketpy program, you can run main.exe with --profile flag.
|
||||
- [Compute Threads](https://pocketpy.dev/features/threading.md): pocketpy organizes its state by VM structure. Users can have at maximum 16 VM instances (index from 0 to 15). Each VM instance can only be accessed by exactly one thread at a time.
|
||||
- [Undefined Behaviour](https://pocketpy.dev/features/ub.md): These are the undefined behaviours of pkpy. The behaviour of pkpy is undefined if you do the following things.
|
||||
|
||||
## C-API
|
||||
|
||||
- [Introduction](https://pocketpy.dev/c-api/introduction.md): All public functions in the C API are prefixed with py_ in pocketpy.h.
|
||||
- [Functions](https://pocketpy.dev/c-api/functions.md)
|
||||
|
||||
## Modules
|
||||
|
||||
- [array2d](https://pocketpy.dev/modules/array2d.md): Efficient general-purpose 2D array.
|
||||
- [base64](https://pocketpy.dev/modules/base64.md): Encode bytes-like object b using the standard Base64 alphabet.
|
||||
- [bisect](https://pocketpy.dev/modules/bisect.md): Return the index where to insert item x in list a, assuming a is sorted.
|
||||
- [cmath](https://pocketpy.dev/modules/cmath.md): Mathematical functions for complex numbers.
|
||||
- [collections](https://pocketpy.dev/modules/collections.md): Return a dict containing the counts of each element in iterable.
|
||||
- [cute_png](https://pocketpy.dev/modules/cute_png.md): This module is optional. Set option PK_BUILD_MODULE_CUTE_PNG to ON in your CMakeLists.txt to enable it.
|
||||
- [dataclasses](https://pocketpy.dev/modules/dataclasses.md): A decorator that is used to add special method to classes, including __init__, __repr__ and __eq__.
|
||||
- [datetime](https://pocketpy.dev/modules/datetime.md): Returns the current date and time as a datetime object.
|
||||
- [easing](https://pocketpy.dev/modules/easing.md): Python wrapper for easing functions.
|
||||
- [enum](https://pocketpy.dev/modules/enum.md): Base class for creating enumerated constants.
|
||||
- [functools](https://pocketpy.dev/modules/functools.md): A decorator that caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned, and not re-evaluated.
|
||||
- [gc](https://pocketpy.dev/modules/gc.md): Garbage collection interface module.
|
||||
- [heapq](https://pocketpy.dev/modules/heapq.md): Push the value item onto the heap, maintaining the heap invariant.
|
||||
- [importlib](https://pocketpy.dev/modules/importlib.md): Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter.
|
||||
- [json](https://pocketpy.dev/modules/json.md): JSON serialization and deserialization module.
|
||||
- [lz4](https://pocketpy.dev/modules/lz4.md): This module is optional. Set option PK_BUILD_MODULE_LZ4 to ON in your CMakeLists.txt to enable it.
|
||||
- [math](https://pocketpy.dev/modules/math.md): 3.141592653589793
|
||||
- [msgpack](https://pocketpy.dev/modules/msgpack.md): This module is optional. Set option PK_BUILD_MODULE_MSGPACK to ON in your CMakeLists.txt to enable it.
|
||||
- [operator](https://pocketpy.dev/modules/operator.md): The operator module exports a set of efficient functions corresponding to the intrinsic operators of Python. For example, operator.add(x, y) is equivalent to the expression x+y.
|
||||
- [periphery](https://pocketpy.dev/modules/periphery.md): This module is optional. Set option PK_BUILD_MODULE_PERIPHERY to ON in your CMakeLists.txt to enable it.
|
||||
- [pickle](https://pocketpy.dev/modules/pickle.md): Return the pickled representation of an object as a bytes object.
|
||||
- [pkpy](https://pocketpy.dev/modules/pkpy.md): Provide internal access to the pocketpy interpreter.
|
||||
- [random](https://pocketpy.dev/modules/random.md): Set the random seed.
|
||||
- [sys](https://pocketpy.dev/modules/sys.md): The version of pkpy.
|
||||
- [time](https://pocketpy.dev/modules/time.md): Returns the current time in seconds since the epoch as a floating point number.
|
||||
- [traceback](https://pocketpy.dev/modules/traceback.md): Print the last exception and its traceback.
|
||||
- [typing](https://pocketpy.dev/modules/typing.md): Placeholder module for type hints.
|
||||
- [unicodedata](https://pocketpy.dev/modules/unicodedata.md): Returns the East Asian width of a Unicode character. The width is one of the following values:
|
||||
- [vmath](https://pocketpy.dev/modules/vmath.md): Provide vector math operations.
|
||||
|
||||
## GSoC 2026
|
||||
|
||||
- [Application Guide](https://pocketpy.dev/gsoc2026/guide.md): Welcome to the Google Summer of Code 2026 application guide for pocketpy. We are recruiting a student who is passionate about vibe coding and mobile game development.
|
||||
- [Project Ideas](https://pocketpy.dev/gsoc2026/ideas.md): Build a Vibe Coding Agent in Python for Creating Games
|
||||
|
||||
## GSoC 2025
|
||||
|
||||
- [Application Guide](https://pocketpy.dev/gsoc2025/guide.md): Before starting, please read the Ideas page and choose a project you are interested in. Set up a C11 compiler, clone pocketpy sources from github and try to build.
|
||||
- [Project Ideas](https://pocketpy.dev/gsoc2025/ideas.md): Difficulty Level: 3/5 (Medium)
|
||||
|
||||
## GSoC 2024
|
||||
|
||||
- [Application Guide](https://pocketpy.dev/gsoc2024/guide.md): Before starting, please read the Ideas page and choose a project you are interested in. Set up a C++ compiler, clone pocketpy sources from github and try to build.
|
||||
- [Project Ideas](https://pocketpy.dev/gsoc2024/ideas.md): Difficulty Level: 5/5 (Hard)
|
||||
5
modules/array2d.md
Normal file
5
modules/array2d.md
Normal file
@ -0,0 +1,5 @@
|
||||
Efficient general-purpose 2D array.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/array2d.pyi" :::
|
||||
466
modules/array2d/index.html
Normal file
466
modules/array2d/index.html
Normal file
@ -0,0 +1,466 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>array2d | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="array2d | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Efficient general-purpose 2D array.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/array2d/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/array2d/">
|
||||
<meta property="og:title" content="array2d | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Efficient general-purpose 2D array.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/array2d/">
|
||||
<meta name="twitter:title" content="array2d | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Efficient general-purpose 2D array.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/array2d.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="array2d">array2d</h1>
|
||||
<p>Efficient general-purpose 2D array.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from typing import Callable, Literal, overload, Iterator, Self
|
||||
from vmath import vec2i, color32
|
||||
|
||||
Neighborhood = Literal['Moore', 'von Neumann']
|
||||
|
||||
class array2d_like[T]:
|
||||
@property
|
||||
def n_cols(self) -> int: ...
|
||||
@property
|
||||
def n_rows(self) -> int: ...
|
||||
@property
|
||||
def width(self) -> int: ...
|
||||
@property
|
||||
def height(self) -> int: ...
|
||||
@property
|
||||
def shape(self) -> vec2i: ...
|
||||
@property
|
||||
def numel(self) -> int: ...
|
||||
|
||||
@overload
|
||||
def is_valid(self, col: int, row: int) -> bool: ...
|
||||
@overload
|
||||
def is_valid(self, pos: vec2i) -> bool: ...
|
||||
|
||||
def get[R](self, col: int, row: int, default: R = None) -> T | R:
|
||||
"""Get the value at the given position.
|
||||
|
||||
If the position is out of bounds, returns the default value.
|
||||
"""
|
||||
|
||||
def index(self, value: T) -> vec2i:
|
||||
"""Get the position of the first occurrence of the given value.
|
||||
|
||||
Raises `ValueError` if the value is not found.
|
||||
"""
|
||||
|
||||
def render(self) -> str: ...
|
||||
def render_with_color(self, fg: array2d_like[color32 | None], bg: array2d_like[color32 | None]) -> str: ...
|
||||
|
||||
def all(self: array2d_like[bool]) -> bool: ...
|
||||
def any(self: array2d_like[bool]) -> bool: ...
|
||||
|
||||
def map[R](self, f: Callable[[T], R]) -> array2d[R]: ...
|
||||
def apply(self, f: Callable[[T], T]) -> None: ...
|
||||
def zip_with[R, U](self, other: array2d_like[U], f: Callable[[T, U], R]) -> array2d[R]: ...
|
||||
def copy(self) -> 'array2d[T]': ...
|
||||
def tolist(self) -> list[list[T]]: ...
|
||||
|
||||
def __le__(self, other: T | array2d_like[T]) -> array2d[bool]: ...
|
||||
def __lt__(self, other: T | array2d_like[T]) -> array2d[bool]: ...
|
||||
def __ge__(self, other: T | array2d_like[T]) -> array2d[bool]: ...
|
||||
def __gt__(self, other: T | array2d_like[T]) -> array2d[bool]: ...
|
||||
def __eq__(self, other: T | array2d_like[T]) -> array2d[bool]: ... # type: ignore
|
||||
def __ne__(self, other: T | array2d_like[T]) -> array2d[bool]: ... # type: ignore
|
||||
|
||||
def __add__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __sub__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __mul__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __truediv__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __floordiv__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __mod__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __pow__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
|
||||
def __and__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __or__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __xor__(self, other: T | array2d_like[T]) -> array2d[T]: ...
|
||||
def __invert__(self) -> array2d[T]: ...
|
||||
|
||||
def __iter__(self) -> Iterator[tuple[vec2i, T]]: ...
|
||||
def __repr__(self) -> str: ...
|
||||
|
||||
@overload
|
||||
def __getitem__(self, index: vec2i) -> T: ...
|
||||
@overload
|
||||
def __getitem__(self, index: tuple[int, int]) -> T: ...
|
||||
@overload
|
||||
def __getitem__(self, index: tuple[slice, slice]) -> array2d_view[T]: ...
|
||||
@overload
|
||||
def __getitem__(self, index: tuple[slice, int] | tuple[int, slice]) -> array2d_view[T]: ...
|
||||
@overload
|
||||
def __getitem__(self, mask: array2d_like[bool]) -> list[T]: ...
|
||||
@overload
|
||||
def __setitem__(self, index: vec2i, value: T): ...
|
||||
@overload
|
||||
def __setitem__(self, index: tuple[int, int], value: T): ...
|
||||
@overload
|
||||
def __setitem__(self, index: tuple[slice, slice], value: T | 'array2d_like[T]'): ...
|
||||
@overload
|
||||
def __setitem__(self, index: tuple[slice, int] | tuple[int, slice], value: T | 'array2d_like[T]'): ...
|
||||
@overload
|
||||
def __setitem__(self, mask: array2d_like[bool], value: T): ...
|
||||
|
||||
# algorithms
|
||||
def count(self, value: T) -> int:
|
||||
"""Count the number of cells with the given value."""
|
||||
|
||||
def count_neighbors(self, value: T, neighborhood: Neighborhood) -> array2d[int]:
|
||||
"""Count the number of neighbors with the given value for each cell."""
|
||||
|
||||
def get_bounding_rect(self, value: T) -> tuple[int, int, int, int]:
|
||||
"""Get the bounding rectangle of the given value.
|
||||
|
||||
Returns a tuple `(x, y, width, height)` or raise `ValueError` if the value is not found.
|
||||
"""
|
||||
|
||||
def convolve(self: array2d_like[int], kernel: array2d_like[int], padding: int) -> array2d[int]:
|
||||
"""Convolve the array with the given kernel."""
|
||||
|
||||
def get_connected_components(self, value: T, neighborhood: Neighborhood) -> tuple[array2d[int], int]:
|
||||
"""Get connected components of the grid via BFS algorithm.
|
||||
|
||||
Returns the `visited` array and the number of connected components,
|
||||
where `0` means unvisited, and non-zero means the index of the connected component.
|
||||
"""
|
||||
|
||||
|
||||
class array2d_view[T](array2d_like[T]):
|
||||
@property
|
||||
def origin(self) -> vec2i: ...
|
||||
|
||||
|
||||
class array2d[T](array2d_like[T]):
|
||||
def __new__(
|
||||
cls,
|
||||
n_cols: int,
|
||||
n_rows: int,
|
||||
default: T | Callable[[vec2i], T] | None = None
|
||||
): ...
|
||||
|
||||
@staticmethod
|
||||
def fromlist(data: list[list[T]]) -> array2d[T]: ...
|
||||
|
||||
|
||||
class chunked_array2d[T, TContext]:
|
||||
def __new__(
|
||||
cls,
|
||||
chunk_size: int,
|
||||
default: T | None = None,
|
||||
auto_add_chunk: bool = True,
|
||||
): ...
|
||||
|
||||
@property
|
||||
def chunk_size(self) -> int: ...
|
||||
|
||||
def __getitem__(self, index: vec2i) -> T: ...
|
||||
def __setitem__(self, index: vec2i, value: T): ...
|
||||
def __iter__(self) -> Iterator[tuple[vec2i, TContext]]: ...
|
||||
def __len__(self) -> int: ...
|
||||
|
||||
def clear(self) -> None: ...
|
||||
def copy(self) -> Self: ...
|
||||
|
||||
def world_to_chunk(self, world_pos: vec2i) -> tuple[vec2i, vec2i]:
|
||||
"""Converts world position to chunk position and local position."""
|
||||
|
||||
def add_chunk(self, chunk_pos: vec2i, context: TContext | None) -> None: ...
|
||||
def remove_chunk(self, chunk_pos: vec2i) -> bool: ...
|
||||
def move_chunk(self, src_chunk_pos: vec2i, dst_chunk_pos: vec2i) -> bool: ...
|
||||
def get_context(self, chunk_pos: vec2i) -> TContext | None: ...
|
||||
|
||||
def view(self) -> array2d_view[T]: ...
|
||||
def view_rect(self, pos: vec2i, width: int, height: int) -> array2d_view[T]: ...
|
||||
def view_chunk(self, chunk_pos: vec2i) -> array2d_view[T]: ...
|
||||
def view_chunks(self, chunk_pos: vec2i, width: int, height: int) -> array2d_view[T]: ...</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../c-api/functions/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">Functions</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/base64/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">base64</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "array2d", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/array2d.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
7
modules/base64.md
Normal file
7
modules/base64.md
Normal file
@ -0,0 +1,7 @@
|
||||
### `base64.b64encode(b: bytes) -> bytes`
|
||||
|
||||
Encode bytes-like object `b` using the standard Base64 alphabet.
|
||||
|
||||
### `base64.b64decode(b: str | bytes) -> bytes`
|
||||
|
||||
Decode Base64 encoded bytes-like object `b`.
|
||||
301
modules/base64/index.html
Normal file
301
modules/base64/index.html
Normal file
@ -0,0 +1,301 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>base64 | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="base64 | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Encode bytes-like object b using the standard Base64 alphabet.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/base64/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/base64/">
|
||||
<meta property="og:title" content="base64 | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Encode bytes-like object b using the standard Base64 alphabet.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/base64/">
|
||||
<meta name="twitter:title" content="base64 | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Encode bytes-like object b using the standard Base64 alphabet.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/base64.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="base64">base64</h1>
|
||||
<h3 id="base64b64encodeb-bytes---bytes"><code translate="no" v-pre>base64.b64encode(b: bytes) -> bytes</code></h3>
|
||||
<p>Encode bytes-like object <code translate="no" v-pre>b</code> using the standard Base64 alphabet.</p>
|
||||
<h3 id="base64b64decodeb-str--bytes---bytes"><code translate="no" v-pre>base64.b64decode(b: str | bytes) -> bytes</code></h3>
|
||||
<p>Decode Base64 encoded bytes-like object <code translate="no" v-pre>b</code>.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/array2d/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">array2d</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/bisect/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">bisect</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "base64", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/base64.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
23
modules/bisect.md
Normal file
23
modules/bisect.md
Normal file
@ -0,0 +1,23 @@
|
||||
### `bisect.bisect_left(a, x)`
|
||||
|
||||
Return the index where to insert item `x` in list `a`, assuming `a` is sorted.
|
||||
|
||||
### `bisect.bisect_right(a, x)`
|
||||
|
||||
Return the index where to insert item `x` in list `a`, assuming `a` is sorted.
|
||||
|
||||
### `bisect.insort_left(a, x)`
|
||||
|
||||
Insert item `x` in list `a`, and keep it sorted assuming `a` is sorted.
|
||||
|
||||
If x is already in a, insert it to the left of the leftmost x.
|
||||
|
||||
### `bisect.insort_right(a, x)`
|
||||
|
||||
Insert item `x` in list `a`, and keep it sorted assuming `a` is sorted.
|
||||
|
||||
If x is already in a, insert it to the right of the rightmost x.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/bisect.py" :::
|
||||
383
modules/bisect/index.html
Normal file
383
modules/bisect/index.html
Normal file
@ -0,0 +1,383 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>bisect | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="bisect | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Return the index where to insert item x in list a, assuming a is sorted.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/bisect/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/bisect/">
|
||||
<meta property="og:title" content="bisect | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Return the index where to insert item x in list a, assuming a is sorted.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/bisect/">
|
||||
<meta name="twitter:title" content="bisect | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Return the index where to insert item x in list a, assuming a is sorted.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/bisect.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="bisect">bisect</h1>
|
||||
<h3 id="bisectbisect_lefta-x"><code translate="no" v-pre>bisect.bisect_left(a, x)</code></h3>
|
||||
<p>Return the index where to insert item <code translate="no" v-pre>x</code> in list <code translate="no" v-pre>a</code>, assuming <code translate="no" v-pre>a</code> is sorted.</p>
|
||||
<h3 id="bisectbisect_righta-x"><code translate="no" v-pre>bisect.bisect_right(a, x)</code></h3>
|
||||
<p>Return the index where to insert item <code translate="no" v-pre>x</code> in list <code translate="no" v-pre>a</code>, assuming <code translate="no" v-pre>a</code> is sorted.</p>
|
||||
<h3 id="bisectinsort_lefta-x"><code translate="no" v-pre>bisect.insort_left(a, x)</code></h3>
|
||||
<p>Insert item <code translate="no" v-pre>x</code> in list <code translate="no" v-pre>a</code>, and keep it sorted assuming <code translate="no" v-pre>a</code> is sorted.</p>
|
||||
<p>If x is already in a, insert it to the left of the leftmost x.</p>
|
||||
<h3 id="bisectinsort_righta-x"><code translate="no" v-pre>bisect.insort_right(a, x)</code></h3>
|
||||
<p>Insert item <code translate="no" v-pre>x</code> in list <code translate="no" v-pre>a</code>, and keep it sorted assuming <code translate="no" v-pre>a</code> is sorted.</p>
|
||||
<p>If x is already in a, insert it to the right of the rightmost x.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">"""Bisection algorithms."""
|
||||
|
||||
def insort_right(a, x, lo=0, hi=None):
|
||||
"""Insert item x in list a, and keep it sorted assuming a is sorted.
|
||||
|
||||
If x is already in a, insert it to the right of the rightmost x.
|
||||
|
||||
Optional args lo (default 0) and hi (default len(a)) bound the
|
||||
slice of a to be searched.
|
||||
"""
|
||||
|
||||
lo = bisect_right(a, x, lo, hi)
|
||||
a.insert(lo, x)
|
||||
|
||||
def bisect_right(a, x, lo=0, hi=None):
|
||||
"""Return the index where to insert item x in list a, assuming a is sorted.
|
||||
|
||||
The return value i is such that all e in a[:i] have e <= x, and all e in
|
||||
a[i:] have e > x. So if x already appears in the list, a.insert(x) will
|
||||
insert just after the rightmost x already there.
|
||||
|
||||
Optional args lo (default 0) and hi (default len(a)) bound the
|
||||
slice of a to be searched.
|
||||
"""
|
||||
|
||||
if lo < 0:
|
||||
raise ValueError('lo must be non-negative')
|
||||
if hi is None:
|
||||
hi = len(a)
|
||||
while lo < hi:
|
||||
mid = (lo+hi)//2
|
||||
if x < a[mid]: hi = mid
|
||||
else: lo = mid+1
|
||||
return lo
|
||||
|
||||
def insort_left(a, x, lo=0, hi=None):
|
||||
"""Insert item x in list a, and keep it sorted assuming a is sorted.
|
||||
|
||||
If x is already in a, insert it to the left of the leftmost x.
|
||||
|
||||
Optional args lo (default 0) and hi (default len(a)) bound the
|
||||
slice of a to be searched.
|
||||
"""
|
||||
|
||||
lo = bisect_left(a, x, lo, hi)
|
||||
a.insert(lo, x)
|
||||
|
||||
|
||||
def bisect_left(a, x, lo=0, hi=None):
|
||||
"""Return the index where to insert item x in list a, assuming a is sorted.
|
||||
|
||||
The return value i is such that all e in a[:i] have e < x, and all e in
|
||||
a[i:] have e >= x. So if x already appears in the list, a.insert(x) will
|
||||
insert just before the leftmost x already there.
|
||||
|
||||
Optional args lo (default 0) and hi (default len(a)) bound the
|
||||
slice of a to be searched.
|
||||
"""
|
||||
|
||||
if lo < 0:
|
||||
raise ValueError('lo must be non-negative')
|
||||
if hi is None:
|
||||
hi = len(a)
|
||||
while lo < hi:
|
||||
mid = (lo+hi)//2
|
||||
if a[mid] < x: lo = mid+1
|
||||
else: hi = mid
|
||||
return lo
|
||||
|
||||
# Create aliases
|
||||
bisect = bisect_right
|
||||
insort = insort_right</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/base64/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">base64</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/cmath/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">cmath</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "bisect", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/bisect.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
7
modules/cmath.md
Normal file
7
modules/cmath.md
Normal file
@ -0,0 +1,7 @@
|
||||
Mathematical functions for complex numbers.
|
||||
|
||||
https://docs.python.org/3/library/cmath.html
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/cmath.py" :::
|
||||
490
modules/cmath/index.html
Normal file
490
modules/cmath/index.html
Normal file
@ -0,0 +1,490 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>cmath | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="cmath | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Mathematical functions for complex numbers.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/cmath/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/cmath/">
|
||||
<meta property="og:title" content="cmath | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Mathematical functions for complex numbers.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/cmath/">
|
||||
<meta name="twitter:title" content="cmath | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Mathematical functions for complex numbers.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/cmath.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="cmath">cmath</h1>
|
||||
<p>Mathematical functions for complex numbers.</p>
|
||||
<p><a href="https://docs.python.org/3/library/cmath.html">https://docs.python.org/3/library/cmath.html</a></p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">import math
|
||||
|
||||
class complex:
|
||||
def __init__(self, real, imag=0):
|
||||
self._real = float(real)
|
||||
self._imag = float(imag)
|
||||
|
||||
@property
|
||||
def real(self):
|
||||
return self._real
|
||||
|
||||
@property
|
||||
def imag(self):
|
||||
return self._imag
|
||||
|
||||
def conjugate(self):
|
||||
return complex(self.real, -self.imag)
|
||||
|
||||
def __repr__(self):
|
||||
s = ['(', str(self.real)]
|
||||
s.append('-' if self.imag < 0 else '+')
|
||||
s.append(str(abs(self.imag)))
|
||||
s.append('j)')
|
||||
return ''.join(s)
|
||||
|
||||
def __eq__(self, other):
|
||||
if type(other) is complex:
|
||||
return self.real == other.real and self.imag == other.imag
|
||||
if type(other) in (int, float):
|
||||
return self.real == other and self.imag == 0
|
||||
return NotImplemented
|
||||
|
||||
def __ne__(self, other):
|
||||
res = self == other
|
||||
if res is NotImplemented:
|
||||
return res
|
||||
return not res
|
||||
|
||||
def __add__(self, other):
|
||||
if type(other) is complex:
|
||||
return complex(self.real + other.real, self.imag + other.imag)
|
||||
if type(other) in (int, float):
|
||||
return complex(self.real + other, self.imag)
|
||||
return NotImplemented
|
||||
|
||||
def __radd__(self, other):
|
||||
return self.__add__(other)
|
||||
|
||||
def __sub__(self, other):
|
||||
if type(other) is complex:
|
||||
return complex(self.real - other.real, self.imag - other.imag)
|
||||
if type(other) in (int, float):
|
||||
return complex(self.real - other, self.imag)
|
||||
return NotImplemented
|
||||
|
||||
def __rsub__(self, other):
|
||||
if type(other) is complex:
|
||||
return complex(other.real - self.real, other.imag - self.imag)
|
||||
if type(other) in (int, float):
|
||||
return complex(other - self.real, -self.imag)
|
||||
return NotImplemented
|
||||
|
||||
def __mul__(self, other):
|
||||
if type(other) is complex:
|
||||
return complex(self.real * other.real - self.imag * other.imag,
|
||||
self.real * other.imag + self.imag * other.real)
|
||||
if type(other) in (int, float):
|
||||
return complex(self.real * other, self.imag * other)
|
||||
return NotImplemented
|
||||
|
||||
def __rmul__(self, other):
|
||||
return self.__mul__(other)
|
||||
|
||||
def __truediv__(self, other):
|
||||
if type(other) is complex:
|
||||
denominator = other.real ** 2 + other.imag ** 2
|
||||
real_part = (self.real * other.real + self.imag * other.imag) / denominator
|
||||
imag_part = (self.imag * other.real - self.real * other.imag) / denominator
|
||||
return complex(real_part, imag_part)
|
||||
if type(other) in (int, float):
|
||||
return complex(self.real / other, self.imag / other)
|
||||
return NotImplemented
|
||||
|
||||
def __pow__(self, other: int | float):
|
||||
if type(other) in (int, float):
|
||||
return complex(self.__abs__() ** other * math.cos(other * phase(self)),
|
||||
self.__abs__() ** other * math.sin(other * phase(self)))
|
||||
return NotImplemented
|
||||
|
||||
def __abs__(self) -> float:
|
||||
return math.sqrt(self.real ** 2 + self.imag ** 2)
|
||||
|
||||
def __neg__(self):
|
||||
return complex(-self.real, -self.imag)
|
||||
|
||||
def __hash__(self):
|
||||
return hash((self.real, self.imag))
|
||||
|
||||
|
||||
# Conversions to and from polar coordinates
|
||||
|
||||
def phase(z: complex):
|
||||
return math.atan2(z.imag, z.real)
|
||||
|
||||
def polar(z: complex):
|
||||
return z.__abs__(), phase(z)
|
||||
|
||||
def rect(r: float, phi: float):
|
||||
return r * math.cos(phi) + r * math.sin(phi) * 1j
|
||||
|
||||
# Power and logarithmic functions
|
||||
|
||||
def exp(z: complex):
|
||||
return math.exp(z.real) * rect(1, z.imag)
|
||||
|
||||
def log(z: complex, base=2.718281828459045):
|
||||
return math.log(z.__abs__(), base) + phase(z) * 1j
|
||||
|
||||
def log10(z: complex):
|
||||
return log(z, 10)
|
||||
|
||||
def sqrt(z: complex):
|
||||
return z ** 0.5
|
||||
|
||||
# Trigonometric functions
|
||||
|
||||
def acos(z: complex):
|
||||
return -1j * log(z + sqrt(z * z - 1))
|
||||
|
||||
def asin(z: complex):
|
||||
return -1j * log(1j * z + sqrt(1 - z * z))
|
||||
|
||||
def atan(z: complex):
|
||||
return 1j / 2 * log((1 - 1j * z) / (1 + 1j * z))
|
||||
|
||||
def cos(z: complex):
|
||||
return (exp(1j * z) + exp(-1j * z)) / 2
|
||||
|
||||
def sin(z: complex):
|
||||
return (exp(1j * z) - exp(-1j * z)) / (2 * 1j)
|
||||
|
||||
def tan(z: complex):
|
||||
return sin(z) / cos(z)
|
||||
|
||||
# Hyperbolic functions
|
||||
|
||||
def acosh(z: complex):
|
||||
return log(z + sqrt(z * z - 1))
|
||||
|
||||
def asinh(z: complex):
|
||||
return log(z + sqrt(z * z + 1))
|
||||
|
||||
def atanh(z: complex):
|
||||
return 1 / 2 * log((1 + z) / (1 - z))
|
||||
|
||||
def cosh(z: complex):
|
||||
return (exp(z) + exp(-z)) / 2
|
||||
|
||||
def sinh(z: complex):
|
||||
return (exp(z) - exp(-z)) / 2
|
||||
|
||||
def tanh(z: complex):
|
||||
return sinh(z) / cosh(z)
|
||||
|
||||
# Classification functions
|
||||
|
||||
def isfinite(z: complex):
|
||||
return math.isfinite(z.real) and math.isfinite(z.imag)
|
||||
|
||||
def isinf(z: complex):
|
||||
return math.isinf(z.real) or math.isinf(z.imag)
|
||||
|
||||
def isnan(z: complex):
|
||||
return math.isnan(z.real) or math.isnan(z.imag)
|
||||
|
||||
def isclose(a: complex, b: complex):
|
||||
return math.isclose(a.real, b.real) and math.isclose(a.imag, b.imag)
|
||||
|
||||
# Constants
|
||||
|
||||
pi = math.pi
|
||||
e = math.e
|
||||
tau = 2 * pi
|
||||
inf = math.inf
|
||||
infj = complex(0, inf)
|
||||
nan = math.nan
|
||||
nanj = complex(0, nan)</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/bisect/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">bisect</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/collections/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">collections</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "cmath", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/cmath.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
15
modules/collections.md
Normal file
15
modules/collections.md
Normal file
@ -0,0 +1,15 @@
|
||||
### `collections.Counter(iterable)`
|
||||
|
||||
Return a `dict` containing the counts of each element in `iterable`.
|
||||
|
||||
### `collections.deque`
|
||||
|
||||
A double-ended queue.
|
||||
|
||||
### `collections.defaultdict`
|
||||
|
||||
A dictionary that returns a default value when a key is not found.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/collections.py" :::
|
||||
475
modules/collections/index.html
Normal file
475
modules/collections/index.html
Normal file
@ -0,0 +1,475 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>collections | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="collections | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Return a dict containing the counts of each element in iterable.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/collections/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/collections/">
|
||||
<meta property="og:title" content="collections | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Return a dict containing the counts of each element in iterable.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/collections/">
|
||||
<meta name="twitter:title" content="collections | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Return a dict containing the counts of each element in iterable.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/collections.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="collections">collections</h1>
|
||||
<h3 id="collectionscounteriterable"><code translate="no" v-pre>collections.Counter(iterable)</code></h3>
|
||||
<p>Return a <code translate="no" v-pre>dict</code> containing the counts of each element in <code translate="no" v-pre>iterable</code>.</p>
|
||||
<h3 id="collectionsdeque"><code translate="no" v-pre>collections.deque</code></h3>
|
||||
<p>A double-ended queue.</p>
|
||||
<h3 id="collectionsdefaultdict"><code translate="no" v-pre>collections.defaultdict</code></h3>
|
||||
<p>A dictionary that returns a default value when a key is not found.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from typing import TypeVar, Iterable
|
||||
|
||||
def Counter[T](iterable: Iterable[T]):
|
||||
a: dict[T, int] = {}
|
||||
for x in iterable:
|
||||
if x in a:
|
||||
a[x] += 1
|
||||
else:
|
||||
a[x] = 1
|
||||
return a
|
||||
|
||||
|
||||
class defaultdict(dict):
|
||||
def __init__(self, default_factory, *args):
|
||||
super().__init__(*args)
|
||||
self.default_factory = default_factory
|
||||
|
||||
def __missing__(self, key):
|
||||
self[key] = self.default_factory()
|
||||
return self[key]
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"defaultdict({self.default_factory}, {super().__repr__()})"
|
||||
|
||||
def copy(self):
|
||||
return defaultdict(self.default_factory, self)
|
||||
|
||||
|
||||
class deque[T]:
|
||||
_head: int
|
||||
_tail: int
|
||||
_maxlen: int | None
|
||||
_capacity: int
|
||||
_data: list[T]
|
||||
|
||||
def __init__(self, iterable: Iterable[T] = None, maxlen: int | None = None):
|
||||
if maxlen is not None:
|
||||
assert maxlen > 0
|
||||
|
||||
self._head = 0
|
||||
self._tail = 0
|
||||
self._maxlen = maxlen
|
||||
self._capacity = 8 if maxlen is None else maxlen + 1
|
||||
self._data = [None] * self._capacity # type: ignore
|
||||
|
||||
if iterable is not None:
|
||||
self.extend(iterable)
|
||||
|
||||
@property
|
||||
def maxlen(self) -> int | None:
|
||||
return self._maxlen
|
||||
|
||||
def __resize_2x(self):
|
||||
backup = list(self)
|
||||
self._capacity *= 2
|
||||
self._head = 0
|
||||
self._tail = len(backup)
|
||||
self._data.clear()
|
||||
self._data.extend(backup)
|
||||
self._data.extend([None] * (self._capacity - len(backup)))
|
||||
|
||||
def append(self, x: T):
|
||||
if (self._tail + 1) % self._capacity == self._head:
|
||||
if self._maxlen is None:
|
||||
self.__resize_2x()
|
||||
else:
|
||||
self.popleft()
|
||||
self._data[self._tail] = x
|
||||
self._tail = (self._tail + 1) % self._capacity
|
||||
|
||||
def appendleft(self, x: T):
|
||||
if (self._tail + 1) % self._capacity == self._head:
|
||||
if self._maxlen is None:
|
||||
self.__resize_2x()
|
||||
else:
|
||||
self.pop()
|
||||
self._head = (self._head - 1) % self._capacity
|
||||
self._data[self._head] = x
|
||||
|
||||
def copy(self):
|
||||
return deque(self, maxlen=self.maxlen)
|
||||
|
||||
def count(self, x: T) -> int:
|
||||
n = 0
|
||||
for item in self:
|
||||
if item == x:
|
||||
n += 1
|
||||
return n
|
||||
|
||||
def extend(self, iterable: Iterable[T]):
|
||||
for x in iterable:
|
||||
self.append(x)
|
||||
|
||||
def extendleft(self, iterable: Iterable[T]):
|
||||
for x in iterable:
|
||||
self.appendleft(x)
|
||||
|
||||
def pop(self) -> T:
|
||||
if self._head == self._tail:
|
||||
raise IndexError("pop from an empty deque")
|
||||
self._tail = (self._tail - 1) % self._capacity
|
||||
x = self._data[self._tail]
|
||||
self._data[self._tail] = None
|
||||
return x
|
||||
|
||||
def popleft(self) -> T:
|
||||
if self._head == self._tail:
|
||||
raise IndexError("pop from an empty deque")
|
||||
x = self._data[self._head]
|
||||
self._data[self._head] = None
|
||||
self._head = (self._head + 1) % self._capacity
|
||||
return x
|
||||
|
||||
def clear(self):
|
||||
i = self._head
|
||||
while i != self._tail:
|
||||
self._data[i] = None # type: ignore
|
||||
i = (i + 1) % self._capacity
|
||||
self._head = 0
|
||||
self._tail = 0
|
||||
|
||||
def rotate(self, n: int = 1):
|
||||
if len(self) == 0:
|
||||
return
|
||||
if n > 0:
|
||||
n = n % len(self)
|
||||
for _ in range(n):
|
||||
self.appendleft(self.pop())
|
||||
elif n < 0:
|
||||
n = -n % len(self)
|
||||
for _ in range(n):
|
||||
self.append(self.popleft())
|
||||
|
||||
def __len__(self) -> int:
|
||||
return (self._tail - self._head) % self._capacity
|
||||
|
||||
def __contains__(self, x: object) -> bool:
|
||||
for item in self:
|
||||
if item == x:
|
||||
return True
|
||||
return False
|
||||
|
||||
def __iter__(self):
|
||||
i = self._head
|
||||
while i != self._tail:
|
||||
yield self._data[i]
|
||||
i = (i + 1) % self._capacity
|
||||
|
||||
def __eq__(self, other: object) -> bool:
|
||||
if not isinstance(other, deque):
|
||||
return NotImplemented
|
||||
if len(self) != len(other):
|
||||
return False
|
||||
for x, y in zip(self, other):
|
||||
if x != y:
|
||||
return False
|
||||
return True
|
||||
|
||||
def __ne__(self, other: object) -> bool:
|
||||
if not isinstance(other, deque):
|
||||
return NotImplemented
|
||||
return not self == other
|
||||
|
||||
def __repr__(self) -> str:
|
||||
if self.maxlen is None:
|
||||
return f"deque({list(self)!r})"
|
||||
return f"deque({list(self)!r}, maxlen={self.maxlen})"
|
||||
</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/cmath/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">cmath</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/cute_png/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">cute_png</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "collections", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/collections.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
9
modules/cute_png.md
Normal file
9
modules/cute_png.md
Normal file
@ -0,0 +1,9 @@
|
||||
!!!
|
||||
This module is optional. Set option `PK_BUILD_MODULE_CUTE_PNG` to `ON` in your `CMakeLists.txt` to enable it.
|
||||
!!!
|
||||
|
||||
Wraps [cute_png.h](https://github.com/RandyGaul/cute_headers/blob/master/cute_png.h) for PNG image loading and saving.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/cute_png.pyi" :::
|
||||
348
modules/cute_png/index.html
Normal file
348
modules/cute_png/index.html
Normal file
@ -0,0 +1,348 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>cute_png | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="cute_png | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="This module is optional. Set option PK_BUILD_MODULE_CUTE_PNG to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/cute_png/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/cute_png/">
|
||||
<meta property="og:title" content="cute_png | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="This module is optional. Set option PK_BUILD_MODULE_CUTE_PNG to ON in your CMakeLists.txt to enable it.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/cute_png/">
|
||||
<meta name="twitter:title" content="cute_png | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="This module is optional. Set option PK_BUILD_MODULE_CUTE_PNG to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/cute_png.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="cute_png">cute_png</h1>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>This module is optional. Set option <code translate="no" v-pre>PK_BUILD_MODULE_CUTE_PNG</code> to <code translate="no" v-pre>ON</code> in your <code translate="no" v-pre>CMakeLists.txt</code> to enable it.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p>Wraps <a href="https://github.com/RandyGaul/cute_headers/blob/master/cute_png.h">cute_png.h</a> for PNG image loading and saving.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from array2d import array2d
|
||||
from vmath import color32, vec2i
|
||||
|
||||
class Image:
|
||||
@property
|
||||
def width(self) -> int: ...
|
||||
@property
|
||||
def height(self) -> int: ...
|
||||
|
||||
def __new__(cls, width: int, height: int) -> "Image": ...
|
||||
|
||||
@staticmethod
|
||||
def from_bytes(data: bytes) -> "Image": ...
|
||||
@staticmethod
|
||||
def from_file(path: str) -> "Image": ...
|
||||
|
||||
def setpixel(self, x: int, y: int, color: color32) -> None: ...
|
||||
def getpixel(self, x: int, y: int) -> color32: ...
|
||||
def clear(self, color: color32) -> None: ...
|
||||
|
||||
def paste(self, src_img: "Image", src_pos: vec2i, dst_pos: vec2i, width: int, height: int, fg: color32, bg: color32) -> None: ...
|
||||
|
||||
def to_png_bytes(self) -> bytes: ...
|
||||
def to_png_file(self, path: str) -> int: ...
|
||||
def to_rgb565_file(self, path: str) -> int: ...
|
||||
|
||||
|
||||
def loads(data: bytes) -> array2d[color32]: ...
|
||||
def dumps(image: array2d[color32]) -> bytes: ...</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/collections/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">collections</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/dataclasses/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">dataclasses</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "cute_png", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/cute_png.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
11
modules/dataclasses.md
Normal file
11
modules/dataclasses.md
Normal file
@ -0,0 +1,11 @@
|
||||
### `dataclasses.dataclass`
|
||||
|
||||
A decorator that is used to add special method to classes, including `__init__`, `__repr__` and `__eq__`.
|
||||
|
||||
### `dataclasses.asdict(obj) -> dict`
|
||||
|
||||
Convert a dataclass instance to a dictionary.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/dataclasses.py" :::
|
||||
380
modules/dataclasses/index.html
Normal file
380
modules/dataclasses/index.html
Normal file
@ -0,0 +1,380 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>dataclasses | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="dataclasses | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="A decorator that is used to add special method to classes, including __init__, __repr__ and __eq__.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/dataclasses/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/dataclasses/">
|
||||
<meta property="og:title" content="dataclasses | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="A decorator that is used to add special method to classes, including __init__, __repr__ and __eq__.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/dataclasses/">
|
||||
<meta name="twitter:title" content="dataclasses | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="A decorator that is used to add special method to classes, including __init__, __repr__ and __eq__.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/dataclasses.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="dataclasses">dataclasses</h1>
|
||||
<h3 id="dataclassesdataclass"><code translate="no" v-pre>dataclasses.dataclass</code></h3>
|
||||
<p>A decorator that is used to add special method to classes, including <code translate="no" v-pre>__init__</code>, <code translate="no" v-pre>__repr__</code> and <code translate="no" v-pre>__eq__</code>.</p>
|
||||
<h3 id="dataclassesasdictobj---dict"><code translate="no" v-pre>dataclasses.asdict(obj) -> dict</code></h3>
|
||||
<p>Convert a dataclass instance to a dictionary.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">def _get_annotations(cls: type):
|
||||
inherits = []
|
||||
while cls is not object:
|
||||
inherits.append(cls)
|
||||
cls = cls.__base__
|
||||
inherits.reverse()
|
||||
res = {}
|
||||
for cls in inherits:
|
||||
res.update(cls.__annotations__)
|
||||
return res.keys()
|
||||
|
||||
def _wrapped__init__(self, *args, **kwargs):
|
||||
cls = type(self)
|
||||
cls_d = cls.__dict__
|
||||
fields = _get_annotations(cls)
|
||||
i = 0 # index into args
|
||||
for field in fields:
|
||||
if field in kwargs:
|
||||
setattr(self, field, kwargs.pop(field))
|
||||
else:
|
||||
if i < len(args):
|
||||
setattr(self, field, args[i])
|
||||
i += 1
|
||||
elif field in cls_d: # has default value
|
||||
setattr(self, field, cls_d[field])
|
||||
else:
|
||||
raise TypeError(f"{cls.__name__} missing required argument {field!r}")
|
||||
if len(args) > i:
|
||||
raise TypeError(f"{cls.__name__} takes {len(fields)} positional arguments but {len(args)} were given")
|
||||
if len(kwargs) > 0:
|
||||
raise TypeError(f"{cls.__name__} got an unexpected keyword argument {next(iter(kwargs))!r}")
|
||||
|
||||
def _wrapped__repr__(self):
|
||||
fields = _get_annotations(type(self))
|
||||
obj_d = self.__dict__
|
||||
args: list = [f"{field}={obj_d[field]!r}" for field in fields]
|
||||
return f"{type(self).__name__}({', '.join(args)})"
|
||||
|
||||
def _wrapped__eq__(self, other):
|
||||
if type(self) is not type(other):
|
||||
return False
|
||||
fields = _get_annotations(type(self))
|
||||
for field in fields:
|
||||
if getattr(self, field) != getattr(other, field):
|
||||
return False
|
||||
return True
|
||||
|
||||
def _wrapped__ne__(self, other):
|
||||
return not self.__eq__(other)
|
||||
|
||||
def dataclass(cls: type):
|
||||
assert type(cls) is type
|
||||
cls_d = cls.__dict__
|
||||
if '__init__' not in cls_d:
|
||||
cls.__init__ = _wrapped__init__
|
||||
if '__repr__' not in cls_d:
|
||||
cls.__repr__ = _wrapped__repr__
|
||||
if '__eq__' not in cls_d:
|
||||
cls.__eq__ = _wrapped__eq__
|
||||
if '__ne__' not in cls_d:
|
||||
cls.__ne__ = _wrapped__ne__
|
||||
fields = _get_annotations(cls)
|
||||
has_default = False
|
||||
for field in fields:
|
||||
if field in cls_d:
|
||||
has_default = True
|
||||
else:
|
||||
if has_default:
|
||||
raise TypeError(f"non-default argument {field!r} follows default argument")
|
||||
return cls
|
||||
|
||||
def asdict(obj) -> dict:
|
||||
fields = _get_annotations(type(obj))
|
||||
obj_d = obj.__dict__
|
||||
return {field: obj_d[field] for field in fields}</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/cute_png/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">cute_png</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/datetime/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">datetime</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "dataclasses", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/dataclasses.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
11
modules/datetime.md
Normal file
11
modules/datetime.md
Normal file
@ -0,0 +1,11 @@
|
||||
### `datetime.now()`
|
||||
|
||||
Returns the current date and time as a `datetime` object.
|
||||
|
||||
### `date.today()`
|
||||
|
||||
Returns the current local date as a `date` object.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/datetime.py" :::
|
||||
437
modules/datetime/index.html
Normal file
437
modules/datetime/index.html
Normal file
@ -0,0 +1,437 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>datetime | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="datetime | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Returns the current date and time as a datetime object.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/datetime/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/datetime/">
|
||||
<meta property="og:title" content="datetime | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Returns the current date and time as a datetime object.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/datetime/">
|
||||
<meta name="twitter:title" content="datetime | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Returns the current date and time as a datetime object.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/datetime.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="datetime">datetime</h1>
|
||||
<h3 id="datetimenow"><code translate="no" v-pre>datetime.now()</code></h3>
|
||||
<p>Returns the current date and time as a <code translate="no" v-pre>datetime</code> object.</p>
|
||||
<h3 id="datetoday"><code translate="no" v-pre>date.today()</code></h3>
|
||||
<p>Returns the current local date as a <code translate="no" v-pre>date</code> object.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from time import localtime
|
||||
import operator
|
||||
|
||||
class timedelta:
|
||||
def __init__(self, days=0, seconds=0):
|
||||
self.days = days
|
||||
self.seconds = seconds
|
||||
|
||||
def __repr__(self):
|
||||
return f"datetime.timedelta(days={self.days}, seconds={self.seconds})"
|
||||
|
||||
def __eq__(self, other) -> bool:
|
||||
if not isinstance(other, timedelta):
|
||||
return NotImplemented
|
||||
return (self.days, self.seconds) == (other.days, other.seconds)
|
||||
|
||||
def __ne__(self, other) -> bool:
|
||||
if not isinstance(other, timedelta):
|
||||
return NotImplemented
|
||||
return (self.days, self.seconds) != (other.days, other.seconds)
|
||||
|
||||
|
||||
class date:
|
||||
def __init__(self, year: int, month: int, day: int):
|
||||
self.year = year
|
||||
self.month = month
|
||||
self.day = day
|
||||
|
||||
@staticmethod
|
||||
def today():
|
||||
t = localtime()
|
||||
return date(t.tm_year, t.tm_mon, t.tm_mday)
|
||||
|
||||
def __cmp(self, other, op):
|
||||
if not isinstance(other, date):
|
||||
return NotImplemented
|
||||
if self.year != other.year:
|
||||
return op(self.year, other.year)
|
||||
if self.month != other.month:
|
||||
return op(self.month, other.month)
|
||||
return op(self.day, other.day)
|
||||
|
||||
def __eq__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.eq)
|
||||
|
||||
def __ne__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.ne)
|
||||
|
||||
def __lt__(self, other: 'date') -> bool:
|
||||
return self.__cmp(other, operator.lt)
|
||||
|
||||
def __le__(self, other: 'date') -> bool:
|
||||
return self.__cmp(other, operator.le)
|
||||
|
||||
def __gt__(self, other: 'date') -> bool:
|
||||
return self.__cmp(other, operator.gt)
|
||||
|
||||
def __ge__(self, other: 'date') -> bool:
|
||||
return self.__cmp(other, operator.ge)
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.year}-{self.month:02}-{self.day:02}"
|
||||
|
||||
def __repr__(self):
|
||||
return f"datetime.date({self.year}, {self.month}, {self.day})"
|
||||
|
||||
|
||||
class datetime(date):
|
||||
def __init__(self, year: int, month: int, day: int, hour: int, minute: int, second: int):
|
||||
super().__init__(year, month, day)
|
||||
# Validate and set hour, minute, and second
|
||||
if not 0 <= hour <= 23:
|
||||
raise ValueError("Hour must be between 0 and 23")
|
||||
self.hour = hour
|
||||
if not 0 <= minute <= 59:
|
||||
raise ValueError("Minute must be between 0 and 59")
|
||||
self.minute = minute
|
||||
if not 0 <= second <= 59:
|
||||
raise ValueError("Second must be between 0 and 59")
|
||||
self.second = second
|
||||
|
||||
def date(self) -> date:
|
||||
return date(self.year, self.month, self.day)
|
||||
|
||||
@staticmethod
|
||||
def now():
|
||||
t = localtime()
|
||||
tm_sec = t.tm_sec
|
||||
if tm_sec == 60:
|
||||
tm_sec = 59
|
||||
return datetime(t.tm_year, t.tm_mon, t.tm_mday, t.tm_hour, t.tm_min, tm_sec)
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.year}-{self.month:02}-{self.day:02} {self.hour:02}:{self.minute:02}:{self.second:02}"
|
||||
|
||||
def __repr__(self):
|
||||
return f"datetime.datetime({self.year}, {self.month}, {self.day}, {self.hour}, {self.minute}, {self.second})"
|
||||
|
||||
def __cmp(self, other, op):
|
||||
if not isinstance(other, datetime):
|
||||
return NotImplemented
|
||||
if self.year != other.year:
|
||||
return op(self.year, other.year)
|
||||
if self.month != other.month:
|
||||
return op(self.month, other.month)
|
||||
if self.day != other.day:
|
||||
return op(self.day, other.day)
|
||||
if self.hour != other.hour:
|
||||
return op(self.hour, other.hour)
|
||||
if self.minute != other.minute:
|
||||
return op(self.minute, other.minute)
|
||||
return op(self.second, other.second)
|
||||
|
||||
def __eq__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.eq)
|
||||
|
||||
def __ne__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.ne)
|
||||
|
||||
def __lt__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.lt)
|
||||
|
||||
def __le__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.le)
|
||||
|
||||
def __gt__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.gt)
|
||||
|
||||
def __ge__(self, other) -> bool:
|
||||
return self.__cmp(other, operator.ge)
|
||||
|
||||
</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/dataclasses/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">dataclasses</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/easing/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">easing</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "datetime", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/datetime.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
33
modules/easing.md
Normal file
33
modules/easing.md
Normal file
@ -0,0 +1,33 @@
|
||||
Python wrapper for [easing functions](https://easings.net/).
|
||||
|
||||
+ `easing.Linear(t: float) -> float`
|
||||
+ `easing.InSine(t: float) -> float`
|
||||
+ `easing.OutSine(t: float) -> float`
|
||||
+ `easing.InOutSine(t: float) -> float`
|
||||
+ `easing.InQuad(t: float) -> float`
|
||||
+ `easing.OutQuad(t: float) -> float`
|
||||
+ `easing.InOutQuad(t: float) -> float`
|
||||
+ `easing.InCubic(t: float) -> float`
|
||||
+ `easing.OutCubic(t: float) -> float`
|
||||
+ `easing.InOutCubic(t: float) -> float`
|
||||
+ `easing.InQuart(t: float) -> float`
|
||||
+ `easing.OutQuart(t: float) -> float`
|
||||
+ `easing.InOutQuart(t: float) -> float`
|
||||
+ `easing.InQuint(t: float) -> float`
|
||||
+ `easing.OutQuint(t: float) -> float`
|
||||
+ `easing.InOutQuint(t: float) -> float`
|
||||
+ `easing.InExpo(t: float) -> float`
|
||||
+ `easing.OutExpo(t: float) -> float`
|
||||
+ `easing.InOutExpo(t: float) -> float`
|
||||
+ `easing.InCirc(t: float) -> float`
|
||||
+ `easing.OutCirc(t: float) -> float`
|
||||
+ `easing.InOutCirc(t: float) -> float`
|
||||
+ `easing.InBack(t: float) -> float`
|
||||
+ `easing.OutBack(t: float) -> float`
|
||||
+ `easing.InOutBack(t: float) -> float`
|
||||
+ `easing.InElastic(t: float) -> float`
|
||||
+ `easing.OutElastic(t: float) -> float`
|
||||
+ `easing.InOutElastic(t: float) -> float`
|
||||
+ `easing.InBounce(t: float) -> float`
|
||||
+ `easing.OutBounce(t: float) -> float`
|
||||
+ `easing.InOutBounce(t: float) -> float`
|
||||
331
modules/easing/index.html
Normal file
331
modules/easing/index.html
Normal file
@ -0,0 +1,331 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>easing | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="easing | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Python wrapper for easing functions.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/easing/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/easing/">
|
||||
<meta property="og:title" content="easing | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Python wrapper for easing functions.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/easing/">
|
||||
<meta name="twitter:title" content="easing | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Python wrapper for easing functions.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/easing.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="easing">easing</h1>
|
||||
<p>Python wrapper for <a href="https://easings.net/">easing functions</a>.</p>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>easing.Linear(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InSine(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutSine(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutSine(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InQuad(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutQuad(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutQuad(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InCubic(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutCubic(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutCubic(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InQuart(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutQuart(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutQuart(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InQuint(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutQuint(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutQuint(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InExpo(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutExpo(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutExpo(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InCirc(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutCirc(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutCirc(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InBack(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutBack(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutBack(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InElastic(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutElastic(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutElastic(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InBounce(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.OutBounce(t: float) -> float</code></li>
|
||||
<li><code translate="no" v-pre>easing.InOutBounce(t: float) -> float</code></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/datetime/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">datetime</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/enum/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">enum</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "easing", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/easing.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
18
modules/enum.md
Normal file
18
modules/enum.md
Normal file
@ -0,0 +1,18 @@
|
||||
### `enum.Enum`
|
||||
|
||||
Base class for creating enumerated constants.
|
||||
|
||||
Example:
|
||||
|
||||
```python
|
||||
from enum import Enum
|
||||
|
||||
class Color(Enum):
|
||||
RED = 1
|
||||
GREEN = 2
|
||||
BLUE = 3
|
||||
|
||||
print(Color.RED) # Color.RED
|
||||
print(Color.RED.name) # 'RED'
|
||||
print(Color.RED.value) # 1
|
||||
```
|
||||
313
modules/enum/index.html
Normal file
313
modules/enum/index.html
Normal file
@ -0,0 +1,313 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>enum | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="enum | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Base class for creating enumerated constants.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/enum/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/enum/">
|
||||
<meta property="og:title" content="enum | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Base class for creating enumerated constants.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/enum/">
|
||||
<meta name="twitter:title" content="enum | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Base class for creating enumerated constants.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/enum.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="enum">enum</h1>
|
||||
<h3 id="enumenum"><code translate="no" v-pre>enum.Enum</code></h3>
|
||||
<p>Base class for creating enumerated constants.</p>
|
||||
<p>Example:</p>
|
||||
<div id="enumenum-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from enum import Enum
|
||||
|
||||
class Color(Enum):
|
||||
RED = 1
|
||||
GREEN = 2
|
||||
BLUE = 3
|
||||
|
||||
print(Color.RED) # Color.RED
|
||||
print(Color.RED.name) # 'RED'
|
||||
print(Color.RED.value) # 1</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/easing/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">easing</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/functools/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">functools</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "enum", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/enum.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
19
modules/functools.md
Normal file
19
modules/functools.md
Normal file
@ -0,0 +1,19 @@
|
||||
### `functools.cache`
|
||||
|
||||
A decorator that caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned, and not re-evaluated.
|
||||
|
||||
### `functools.lru_cache(maxsize=128)`
|
||||
|
||||
A decorator that wraps a function with a memoizing callable that saves up to the maxsize most recent calls.
|
||||
|
||||
### `functools.reduce(function, sequence, initial=...)`
|
||||
|
||||
Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, `functools.reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])` calculates `((((1+2)+3)+4)+5)`. The left argument, `x`, is the accumulated value and the right argument, `y`, is the update value from the sequence. If the optional `initial` is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.
|
||||
|
||||
### `functools.partial(f, *args, **kwargs)`
|
||||
|
||||
Return a new partial object which when called will behave like `f` called with the positional arguments `args` and keyword arguments `kwargs`. If more arguments are supplied to the call, they are appended to `args`. If additional keyword arguments are supplied, they extend and override `kwargs`.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/functools.py" :::
|
||||
364
modules/functools/index.html
Normal file
364
modules/functools/index.html
Normal file
@ -0,0 +1,364 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>functools | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="functools | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="A decorator that caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned, and not re-evaluated.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/functools/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/functools/">
|
||||
<meta property="og:title" content="functools | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="A decorator that caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned, and not re-evaluated.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/functools/">
|
||||
<meta name="twitter:title" content="functools | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="A decorator that caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned, and not re-evaluated.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/functools.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="functools">functools</h1>
|
||||
<h3 id="functoolscache"><code translate="no" v-pre>functools.cache</code></h3>
|
||||
<p>A decorator that caches a function's return value each time it is called. If called later with the same arguments, the cached value is returned, and not re-evaluated.</p>
|
||||
<h3 id="functoolslru_cachemaxsize128"><code translate="no" v-pre>functools.lru_cache(maxsize=128)</code></h3>
|
||||
<p>A decorator that wraps a function with a memoizing callable that saves up to the maxsize most recent calls.</p>
|
||||
<h3 id="functoolsreducefunction-sequence-initial"><code translate="no" v-pre>functools.reduce(function, sequence, initial=...)</code></h3>
|
||||
<p>Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, <code translate="no" v-pre>functools.reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])</code> calculates <code translate="no" v-pre>((((1+2)+3)+4)+5)</code>. The left argument, <code translate="no" v-pre>x</code>, is the accumulated value and the right argument, <code translate="no" v-pre>y</code>, is the update value from the sequence. If the optional <code translate="no" v-pre>initial</code> is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.</p>
|
||||
<h3 id="functoolspartialf-args-kwargs"><code translate="no" v-pre>functools.partial(f, *args, **kwargs)</code></h3>
|
||||
<p>Return a new partial object which when called will behave like <code translate="no" v-pre>f</code> called with the positional arguments <code translate="no" v-pre>args</code> and keyword arguments <code translate="no" v-pre>kwargs</code>. If more arguments are supplied to the call, they are appended to <code translate="no" v-pre>args</code>. If additional keyword arguments are supplied, they extend and override <code translate="no" v-pre>kwargs</code>.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">class cache:
|
||||
def __init__(self, f):
|
||||
self.f = f
|
||||
self.cache = {}
|
||||
|
||||
def __call__(self, *args):
|
||||
if args not in self.cache:
|
||||
self.cache[args] = self.f(*args)
|
||||
return self.cache[args]
|
||||
|
||||
class lru_cache:
|
||||
def __init__(self, maxsize=128):
|
||||
self.maxsize = maxsize
|
||||
self.cache = {}
|
||||
|
||||
def __call__(self, f):
|
||||
def wrapped(*args):
|
||||
if args in self.cache:
|
||||
res = self.cache.pop(args)
|
||||
self.cache[args] = res
|
||||
return res
|
||||
|
||||
res = f(*args)
|
||||
if len(self.cache) >= self.maxsize:
|
||||
first_key = next(iter(self.cache))
|
||||
self.cache.pop(first_key)
|
||||
self.cache[args] = res
|
||||
return res
|
||||
return wrapped
|
||||
|
||||
def reduce(function, sequence, initial=...):
|
||||
it = iter(sequence)
|
||||
if initial is ...:
|
||||
try:
|
||||
value = next(it)
|
||||
except StopIteration:
|
||||
raise TypeError("reduce() of empty sequence with no initial value")
|
||||
else:
|
||||
value = initial
|
||||
for element in it:
|
||||
value = function(value, element)
|
||||
return value
|
||||
|
||||
class partial:
|
||||
def __init__(self, f, *args, **kwargs):
|
||||
self.f = f
|
||||
if not callable(f):
|
||||
raise TypeError("the first argument must be callable")
|
||||
self.args = args
|
||||
self.kwargs = kwargs
|
||||
|
||||
def __call__(self, *args, **kwargs):
|
||||
kwargs.update(self.kwargs)
|
||||
return self.f(*self.args, *args, **kwargs)
|
||||
</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/enum/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">enum</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/gc/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">gc</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "functools", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/functools.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
5
modules/gc.md
Normal file
5
modules/gc.md
Normal file
@ -0,0 +1,5 @@
|
||||
Garbage collection interface module.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/gc.pyi" :::
|
||||
329
modules/gc/index.html
Normal file
329
modules/gc/index.html
Normal file
@ -0,0 +1,329 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>gc | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="gc | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Garbage collection interface module.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/gc/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/gc/">
|
||||
<meta property="og:title" content="gc | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Garbage collection interface module.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/gc/">
|
||||
<meta name="twitter:title" content="gc | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Garbage collection interface module.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/gc.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="gc">gc</h1>
|
||||
<p>Garbage collection interface module.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from typing import Callable, Literal
|
||||
|
||||
def isenabled() -> bool:
|
||||
"""Check if automatic garbage collection is enabled."""
|
||||
|
||||
def enable() -> None:
|
||||
"""Enable automatic garbage collection."""
|
||||
|
||||
def disable() -> None:
|
||||
"""Disable automatic garbage collection."""
|
||||
|
||||
def collect() -> int:
|
||||
"""Run a full collection immediately.
|
||||
|
||||
Returns an integer indicating the number of unreachable objects found.
|
||||
"""
|
||||
|
||||
def collect_hint() -> int:
|
||||
"""Hint the garbage collector to run a collection.
|
||||
|
||||
The typical usage scenario for this function is in frame-driven games,
|
||||
where `gc.disable()` is called at the start of the game,
|
||||
and `gc.collect_hint()` is called at the end of each frame.
|
||||
"""
|
||||
|
||||
def setup_debug_callback(cb: Callable[[Literal['start', 'stop'], str], None] | None) -> None:
|
||||
"""Setup a callback that will be triggered at the end of each collection."""</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/functools/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">functools</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/heapq/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">heapq</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "gc", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/gc.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
23
modules/heapq.md
Normal file
23
modules/heapq.md
Normal file
@ -0,0 +1,23 @@
|
||||
### `heapq.heappush(heap, item)`
|
||||
|
||||
Push the value `item` onto the heap, maintaining the heap invariant.
|
||||
|
||||
### `heapq.heappop(heap)`
|
||||
|
||||
Pop and return the smallest item from the heap, maintaining the heap invariant. If the heap is empty, IndexError is raised. To access the smallest item without popping it, use `heap[0]`.
|
||||
|
||||
### `heapq.heapify(x)`
|
||||
|
||||
Transform list `x` into a heap, in-place, in linear time.
|
||||
|
||||
### `heapq.heappushpop(heap, item)`
|
||||
|
||||
Push `item` on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than `heappush()` followed by a separate `heappop()`.
|
||||
|
||||
### `heapq.heapreplace(heap, item)`
|
||||
|
||||
Pop and return the smallest item from the heap, and also push the new item. The heap size doesn’t change. If the heap is empty, IndexError is raised.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/heapq.py" :::
|
||||
397
modules/heapq/index.html
Normal file
397
modules/heapq/index.html
Normal file
@ -0,0 +1,397 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>heapq | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="heapq | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Push the value item onto the heap, maintaining the heap invariant.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/heapq/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/heapq/">
|
||||
<meta property="og:title" content="heapq | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Push the value item onto the heap, maintaining the heap invariant.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/heapq/">
|
||||
<meta name="twitter:title" content="heapq | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Push the value item onto the heap, maintaining the heap invariant.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/heapq.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="heapq">heapq</h1>
|
||||
<h3 id="heapqheappushheap-item"><code translate="no" v-pre>heapq.heappush(heap, item)</code></h3>
|
||||
<p>Push the value <code translate="no" v-pre>item</code> onto the heap, maintaining the heap invariant.</p>
|
||||
<h3 id="heapqheappopheap"><code translate="no" v-pre>heapq.heappop(heap)</code></h3>
|
||||
<p>Pop and return the smallest item from the heap, maintaining the heap invariant. If the heap is empty, IndexError is raised. To access the smallest item without popping it, use <code translate="no" v-pre>heap[0]</code>.</p>
|
||||
<h3 id="heapqheapifyx"><code translate="no" v-pre>heapq.heapify(x)</code></h3>
|
||||
<p>Transform list <code translate="no" v-pre>x</code> into a heap, in-place, in linear time.</p>
|
||||
<h3 id="heapqheappushpopheap-item"><code translate="no" v-pre>heapq.heappushpop(heap, item)</code></h3>
|
||||
<p>Push <code translate="no" v-pre>item</code> on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than <code translate="no" v-pre>heappush()</code> followed by a separate <code translate="no" v-pre>heappop()</code>.</p>
|
||||
<h3 id="heapqheapreplaceheap-item"><code translate="no" v-pre>heapq.heapreplace(heap, item)</code></h3>
|
||||
<p>Pop and return the smallest item from the heap, and also push the new item. The heap size doesn’t change. If the heap is empty, IndexError is raised.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python"># Heap queue algorithm (a.k.a. priority queue)
|
||||
def heappush(heap, item):
|
||||
"""Push item onto heap, maintaining the heap invariant."""
|
||||
heap.append(item)
|
||||
_siftdown(heap, 0, len(heap)-1)
|
||||
|
||||
def heappop(heap):
|
||||
"""Pop the smallest item off the heap, maintaining the heap invariant."""
|
||||
lastelt = heap.pop() # raises appropriate IndexError if heap is empty
|
||||
if heap:
|
||||
returnitem = heap[0]
|
||||
heap[0] = lastelt
|
||||
_siftup(heap, 0)
|
||||
return returnitem
|
||||
return lastelt
|
||||
|
||||
def heapreplace(heap, item):
|
||||
"""Pop and return the current smallest value, and add the new item.
|
||||
|
||||
This is more efficient than heappop() followed by heappush(), and can be
|
||||
more appropriate when using a fixed-size heap. Note that the value
|
||||
returned may be larger than item! That constrains reasonable uses of
|
||||
this routine unless written as part of a conditional replacement:
|
||||
|
||||
if item > heap[0]:
|
||||
item = heapreplace(heap, item)
|
||||
"""
|
||||
returnitem = heap[0] # raises appropriate IndexError if heap is empty
|
||||
heap[0] = item
|
||||
_siftup(heap, 0)
|
||||
return returnitem
|
||||
|
||||
def heappushpop(heap, item):
|
||||
"""Fast version of a heappush followed by a heappop."""
|
||||
if heap and heap[0] < item:
|
||||
item, heap[0] = heap[0], item
|
||||
_siftup(heap, 0)
|
||||
return item
|
||||
|
||||
def heapify(x):
|
||||
"""Transform list into a heap, in-place, in O(len(x)) time."""
|
||||
n = len(x)
|
||||
# Transform bottom-up. The largest index there's any point to looking at
|
||||
# is the largest with a child index in-range, so must have 2*i + 1 < n,
|
||||
# or i < (n-1)/2. If n is even = 2*j, this is (2*j-1)/2 = j-1/2 so
|
||||
# j-1 is the largest, which is n//2 - 1. If n is odd = 2*j+1, this is
|
||||
# (2*j+1-1)/2 = j so j-1 is the largest, and that's again n//2-1.
|
||||
for i in reversed(range(n//2)):
|
||||
_siftup(x, i)
|
||||
|
||||
# 'heap' is a heap at all indices >= startpos, except possibly for pos. pos
|
||||
# is the index of a leaf with a possibly out-of-order value. Restore the
|
||||
# heap invariant.
|
||||
def _siftdown(heap, startpos, pos):
|
||||
newitem = heap[pos]
|
||||
# Follow the path to the root, moving parents down until finding a place
|
||||
# newitem fits.
|
||||
while pos > startpos:
|
||||
parentpos = (pos - 1) >> 1
|
||||
parent = heap[parentpos]
|
||||
if newitem < parent:
|
||||
heap[pos] = parent
|
||||
pos = parentpos
|
||||
continue
|
||||
break
|
||||
heap[pos] = newitem
|
||||
|
||||
def _siftup(heap, pos):
|
||||
endpos = len(heap)
|
||||
startpos = pos
|
||||
newitem = heap[pos]
|
||||
# Bubble up the smaller child until hitting a leaf.
|
||||
childpos = 2*pos + 1 # leftmost child position
|
||||
while childpos < endpos:
|
||||
# Set childpos to index of smaller child.
|
||||
rightpos = childpos + 1
|
||||
if rightpos < endpos and not heap[childpos] < heap[rightpos]:
|
||||
childpos = rightpos
|
||||
# Move the smaller child up.
|
||||
heap[pos] = heap[childpos]
|
||||
pos = childpos
|
||||
childpos = 2*pos + 1
|
||||
# The leaf at pos is empty now. Put newitem there, and bubble it up
|
||||
# to its final resting place (by sifting its parents down).
|
||||
heap[pos] = newitem
|
||||
_siftdown(heap, startpos, pos)</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/gc/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">gc</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/importlib/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">importlib</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "heapq", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/heapq.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
3
modules/importlib.md
Normal file
3
modules/importlib.md
Normal file
@ -0,0 +1,3 @@
|
||||
### `importlib.reload(module)`
|
||||
|
||||
Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter. The return value is the module object (the same as the argument).
|
||||
299
modules/importlib/index.html
Normal file
299
modules/importlib/index.html
Normal file
@ -0,0 +1,299 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>importlib | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="importlib | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/importlib/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/importlib/">
|
||||
<meta property="og:title" content="importlib | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/importlib/">
|
||||
<meta name="twitter:title" content="importlib | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/importlib.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="importlib">importlib</h1>
|
||||
<h3 id="importlibreloadmodule"><code translate="no" v-pre>importlib.reload(module)</code></h3>
|
||||
<p>Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter. The return value is the module object (the same as the argument).</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/heapq/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">heapq</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/json/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">json</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "importlib", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/importlib.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
15
modules/json.md
Normal file
15
modules/json.md
Normal file
@ -0,0 +1,15 @@
|
||||
JSON serialization and deserialization module.
|
||||
|
||||
This module is not safe. You may not want to use it with untrusted data.
|
||||
If you need a safe alternative, consider a 3rd-party library like `cjson`.
|
||||
|
||||
You can override the json functions with:
|
||||
```c
|
||||
py_GlobalRef mod = py_getmodule("json");
|
||||
py_bindfunc(mod, "loads", _safe_json_loads);
|
||||
py_bindfunc(mod, "dumps", _safe_json_dumps);
|
||||
```
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/json.pyi" :::
|
||||
312
modules/json/index.html
Normal file
312
modules/json/index.html
Normal file
@ -0,0 +1,312 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>json | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="json | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="JSON serialization and deserialization module.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/json/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/json/">
|
||||
<meta property="og:title" content="json | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="JSON serialization and deserialization module.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/json/">
|
||||
<meta name="twitter:title" content="json | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="JSON serialization and deserialization module.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/json.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="json">json</h1>
|
||||
<p>JSON serialization and deserialization module.</p>
|
||||
<p>This module is not safe. You may not want to use it with untrusted data.
|
||||
If you need a safe alternative, consider a 3rd-party library like <code translate="no" v-pre>cjson</code>.</p>
|
||||
<p>You can override the json functions with:</p>
|
||||
<div id="json-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-c"><code v-pre class="language-c">py_GlobalRef mod = py_getmodule("json");
|
||||
py_bindfunc(mod, "loads", _safe_json_loads);
|
||||
py_bindfunc(mod, "dumps", _safe_json_dumps);</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">def loads(s: str): ...
|
||||
def dumps(obj, indent=0): ...</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/importlib/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">importlib</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/lz4/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">lz4</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "json", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/json.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
9
modules/lz4.md
Normal file
9
modules/lz4.md
Normal file
@ -0,0 +1,9 @@
|
||||
!!!
|
||||
This module is optional. Set option `PK_BUILD_MODULE_LZ4` to `ON` in your `CMakeLists.txt` to enable it.
|
||||
!!!
|
||||
|
||||
LZ4 compression and decompression.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/lz4.pyi" :::
|
||||
330
modules/lz4/index.html
Normal file
330
modules/lz4/index.html
Normal file
@ -0,0 +1,330 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>lz4 | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="lz4 | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="This module is optional. Set option PK_BUILD_MODULE_LZ4 to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/lz4/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/lz4/">
|
||||
<meta property="og:title" content="lz4 | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="This module is optional. Set option PK_BUILD_MODULE_LZ4 to ON in your CMakeLists.txt to enable it.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/lz4/">
|
||||
<meta name="twitter:title" content="lz4 | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="This module is optional. Set option PK_BUILD_MODULE_LZ4 to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/lz4.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="lz4">lz4</h1>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>This module is optional. Set option <code translate="no" v-pre>PK_BUILD_MODULE_LZ4</code> to <code translate="no" v-pre>ON</code> in your <code translate="no" v-pre>CMakeLists.txt</code> to enable it.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p>LZ4 compression and decompression.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">def compress(data: bytes) -> bytes:
|
||||
"""Compress the given data into LZ4 block format.
|
||||
|
||||
This function is equivalent to `lz4.block.compress` of https://pypi.org/project/lz4/.
|
||||
"""
|
||||
|
||||
def decompress(data: bytes) -> bytes:
|
||||
"""Decompress the given LZ4 block format data produced by `lz4.compress()`.
|
||||
|
||||
This function is equivalent to `lz4.block.decompress` of https://pypi.org/project/lz4/.
|
||||
"""</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/json/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">json</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/math/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">math</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "lz4", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/lz4.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
130
modules/math.md
Normal file
130
modules/math.md
Normal file
@ -0,0 +1,130 @@
|
||||
### `math.pi`
|
||||
|
||||
3.141592653589793
|
||||
|
||||
### `math.e`
|
||||
|
||||
2.718281828459045
|
||||
|
||||
### `math.inf`
|
||||
|
||||
The `inf`.
|
||||
|
||||
### `math.nan`
|
||||
|
||||
The `nan`.
|
||||
|
||||
### `math.ceil(x)`
|
||||
|
||||
Return the ceiling of `x` as a float, the smallest integer value greater than or equal to `x`.
|
||||
|
||||
### `math.fabs(x)`
|
||||
|
||||
Return the absolute value of `x`.
|
||||
|
||||
### `math.floor(x)`
|
||||
|
||||
Return the floor of `x` as a float, the largest integer value less than or equal to `x`.
|
||||
|
||||
### `math.fsum(iterable)`
|
||||
|
||||
Return an accurate floating point sum of values in the iterable. Avoids loss of precision by tracking multiple intermediate partial sums:
|
||||
|
||||
```
|
||||
>>> sum([0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1])
|
||||
0.9999999999999999
|
||||
>>> fsum([0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1])
|
||||
1.0
|
||||
```
|
||||
|
||||
### `math.gcd(a, b)`
|
||||
|
||||
Return the greatest common divisor of the integers `a` and `b`.
|
||||
|
||||
### `math.isfinite(x)`
|
||||
|
||||
Return `True` if `x` is neither an infinity nor a NaN, and `False` otherwise.
|
||||
|
||||
### `math.isinf(x)`
|
||||
|
||||
Return `True` if `x` is a positive or negative infinity, and `False` otherwise.
|
||||
|
||||
### `math.isnan(x)`
|
||||
|
||||
Return `True` if `x` is a NaN (not a number), and `False` otherwise.
|
||||
|
||||
### `math.isclose(a, b)`
|
||||
|
||||
Return `True` if the values `a` and `b` are close to each other and `False` otherwise.
|
||||
|
||||
### `math.exp(x)`
|
||||
|
||||
Return `e` raised to the power of `x`.
|
||||
|
||||
### `math.log(x)`
|
||||
|
||||
Return the natural logarithm of `x` (to base `e`).
|
||||
|
||||
### `math.log2(x)`
|
||||
|
||||
Return the base-2 logarithm of `x`. This is usually more accurate than `log(x, 2)`.
|
||||
|
||||
### `math.log10(x)`
|
||||
|
||||
Return the base-10 logarithm of `x`. This is usually more accurate than `log(x, 10)`.
|
||||
|
||||
### `math.pow(x, y)`
|
||||
|
||||
Return `x` raised to the power `y`.
|
||||
|
||||
### `math.sqrt(x)`
|
||||
|
||||
Return the square root of `x`.
|
||||
|
||||
### `math.acos(x)`
|
||||
|
||||
Return the arc cosine of `x`, in radians.
|
||||
|
||||
### `math.asin(x)`
|
||||
|
||||
Return the arc sine of `x`, in radians.
|
||||
|
||||
### `math.atan(x)`
|
||||
|
||||
Return the arc tangent of `x`, in radians.
|
||||
|
||||
### `math.atan2(y, x)`
|
||||
|
||||
Return `atan(y / x)`, in radians. The result is between `-pi` and `pi`. The vector in the plane from the origin to point `(x, y)` makes this angle with the positive X axis. The point of `atan2()` is that the signs of both inputs are known to it, so it can compute the correct quadrant for the angle. For example, `atan(1)` and `atan2(1, 1)` are both `pi/4`, but `atan2(-1, -1)` is `-3*pi/4`.
|
||||
|
||||
### `math.cos(x)`
|
||||
|
||||
Return the cosine of `x` radians.
|
||||
|
||||
### `math.sin(x)`
|
||||
|
||||
Return the sine of `x` radians.
|
||||
|
||||
### `math.tan(x)`
|
||||
|
||||
Return the tangent of `x` radians.
|
||||
|
||||
### `math.degrees(x)`
|
||||
|
||||
Convert angle `x` from radians to degrees.
|
||||
|
||||
### `math.radians(x)`
|
||||
|
||||
Convert angle `x` from degrees to radians.
|
||||
|
||||
### `math.modf(x)`
|
||||
|
||||
Return the fractional and integer parts of `x`. Both results carry the sign of `x` and are floats.
|
||||
|
||||
### `math.copysign(x, y)`
|
||||
|
||||
Return a float with the magnitude (absolute value) of `x` but the sign of `y`.
|
||||
|
||||
### `math.factorial(x)`
|
||||
|
||||
Return `x` factorial as an integer.
|
||||
365
modules/math/index.html
Normal file
365
modules/math/index.html
Normal file
@ -0,0 +1,365 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>math | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="math | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="3.141592653589793">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/math/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/math/">
|
||||
<meta property="og:title" content="math | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="3.141592653589793">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/math/">
|
||||
<meta name="twitter:title" content="math | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="3.141592653589793">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/math.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="math">math</h1>
|
||||
<h3 id="mathpi"><code translate="no" v-pre>math.pi</code></h3>
|
||||
<p>3.141592653589793</p>
|
||||
<h3 id="mathe"><code translate="no" v-pre>math.e</code></h3>
|
||||
<p>2.718281828459045</p>
|
||||
<h3 id="mathinf"><code translate="no" v-pre>math.inf</code></h3>
|
||||
<p>The <code translate="no" v-pre>inf</code>.</p>
|
||||
<h3 id="mathnan"><code translate="no" v-pre>math.nan</code></h3>
|
||||
<p>The <code translate="no" v-pre>nan</code>.</p>
|
||||
<h3 id="mathceilx"><code translate="no" v-pre>math.ceil(x)</code></h3>
|
||||
<p>Return the ceiling of <code translate="no" v-pre>x</code> as a float, the smallest integer value greater than or equal to <code translate="no" v-pre>x</code>.</p>
|
||||
<h3 id="mathfabsx"><code translate="no" v-pre>math.fabs(x)</code></h3>
|
||||
<p>Return the absolute value of <code translate="no" v-pre>x</code>.</p>
|
||||
<h3 id="mathfloorx"><code translate="no" v-pre>math.floor(x)</code></h3>
|
||||
<p>Return the floor of <code translate="no" v-pre>x</code> as a float, the largest integer value less than or equal to <code translate="no" v-pre>x</code>.</p>
|
||||
<h3 id="mathfsumiterable"><code translate="no" v-pre>math.fsum(iterable)</code></h3>
|
||||
<p>Return an accurate floating point sum of values in the iterable. Avoids loss of precision by tracking multiple intermediate partial sums:</p>
|
||||
<div id="mathfsumiterable-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-none"><code v-pre class="language-none">>>> sum([0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1])
|
||||
0.9999999999999999
|
||||
>>> fsum([0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1])
|
||||
1.0</code></pre>
|
||||
</doc-codeblock></div>
|
||||
<h3 id="mathgcda-b"><code translate="no" v-pre>math.gcd(a, b)</code></h3>
|
||||
<p>Return the greatest common divisor of the integers <code translate="no" v-pre>a</code> and <code translate="no" v-pre>b</code>.</p>
|
||||
<h3 id="mathisfinitex"><code translate="no" v-pre>math.isfinite(x)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>True</code> if <code translate="no" v-pre>x</code> is neither an infinity nor a NaN, and <code translate="no" v-pre>False</code> otherwise.</p>
|
||||
<h3 id="mathisinfx"><code translate="no" v-pre>math.isinf(x)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>True</code> if <code translate="no" v-pre>x</code> is a positive or negative infinity, and <code translate="no" v-pre>False</code> otherwise.</p>
|
||||
<h3 id="mathisnanx"><code translate="no" v-pre>math.isnan(x)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>True</code> if <code translate="no" v-pre>x</code> is a NaN (not a number), and <code translate="no" v-pre>False</code> otherwise.</p>
|
||||
<h3 id="mathisclosea-b"><code translate="no" v-pre>math.isclose(a, b)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>True</code> if the values <code translate="no" v-pre>a</code> and <code translate="no" v-pre>b</code> are close to each other and <code translate="no" v-pre>False</code> otherwise.</p>
|
||||
<h3 id="mathexpx"><code translate="no" v-pre>math.exp(x)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>e</code> raised to the power of <code translate="no" v-pre>x</code>.</p>
|
||||
<h3 id="mathlogx"><code translate="no" v-pre>math.log(x)</code></h3>
|
||||
<p>Return the natural logarithm of <code translate="no" v-pre>x</code> (to base <code translate="no" v-pre>e</code>).</p>
|
||||
<h3 id="mathlog2x"><code translate="no" v-pre>math.log2(x)</code></h3>
|
||||
<p>Return the base-2 logarithm of <code translate="no" v-pre>x</code>. This is usually more accurate than <code translate="no" v-pre>log(x, 2)</code>.</p>
|
||||
<h3 id="mathlog10x"><code translate="no" v-pre>math.log10(x)</code></h3>
|
||||
<p>Return the base-10 logarithm of <code translate="no" v-pre>x</code>. This is usually more accurate than <code translate="no" v-pre>log(x, 10)</code>.</p>
|
||||
<h3 id="mathpowx-y"><code translate="no" v-pre>math.pow(x, y)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>x</code> raised to the power <code translate="no" v-pre>y</code>.</p>
|
||||
<h3 id="mathsqrtx"><code translate="no" v-pre>math.sqrt(x)</code></h3>
|
||||
<p>Return the square root of <code translate="no" v-pre>x</code>.</p>
|
||||
<h3 id="mathacosx"><code translate="no" v-pre>math.acos(x)</code></h3>
|
||||
<p>Return the arc cosine of <code translate="no" v-pre>x</code>, in radians.</p>
|
||||
<h3 id="mathasinx"><code translate="no" v-pre>math.asin(x)</code></h3>
|
||||
<p>Return the arc sine of <code translate="no" v-pre>x</code>, in radians.</p>
|
||||
<h3 id="mathatanx"><code translate="no" v-pre>math.atan(x)</code></h3>
|
||||
<p>Return the arc tangent of <code translate="no" v-pre>x</code>, in radians.</p>
|
||||
<h3 id="mathatan2y-x"><code translate="no" v-pre>math.atan2(y, x)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>atan(y / x)</code>, in radians. The result is between <code translate="no" v-pre>-pi</code> and <code translate="no" v-pre>pi</code>. The vector in the plane from the origin to point <code translate="no" v-pre>(x, y)</code> makes this angle with the positive X axis. The point of <code translate="no" v-pre>atan2()</code> is that the signs of both inputs are known to it, so it can compute the correct quadrant for the angle. For example, <code translate="no" v-pre>atan(1)</code> and <code translate="no" v-pre>atan2(1, 1)</code> are both <code translate="no" v-pre>pi/4</code>, but <code translate="no" v-pre>atan2(-1, -1)</code> is <code translate="no" v-pre>-3*pi/4</code>.</p>
|
||||
<h3 id="mathcosx"><code translate="no" v-pre>math.cos(x)</code></h3>
|
||||
<p>Return the cosine of <code translate="no" v-pre>x</code> radians.</p>
|
||||
<h3 id="mathsinx"><code translate="no" v-pre>math.sin(x)</code></h3>
|
||||
<p>Return the sine of <code translate="no" v-pre>x</code> radians.</p>
|
||||
<h3 id="mathtanx"><code translate="no" v-pre>math.tan(x)</code></h3>
|
||||
<p>Return the tangent of <code translate="no" v-pre>x</code> radians.</p>
|
||||
<h3 id="mathdegreesx"><code translate="no" v-pre>math.degrees(x)</code></h3>
|
||||
<p>Convert angle <code translate="no" v-pre>x</code> from radians to degrees.</p>
|
||||
<h3 id="mathradiansx"><code translate="no" v-pre>math.radians(x)</code></h3>
|
||||
<p>Convert angle <code translate="no" v-pre>x</code> from degrees to radians.</p>
|
||||
<h3 id="mathmodfx"><code translate="no" v-pre>math.modf(x)</code></h3>
|
||||
<p>Return the fractional and integer parts of <code translate="no" v-pre>x</code>. Both results carry the sign of <code translate="no" v-pre>x</code> and are floats.</p>
|
||||
<h3 id="mathcopysignx-y"><code translate="no" v-pre>math.copysign(x, y)</code></h3>
|
||||
<p>Return a float with the magnitude (absolute value) of <code translate="no" v-pre>x</code> but the sign of <code translate="no" v-pre>y</code>.</p>
|
||||
<h3 id="mathfactorialx"><code translate="no" v-pre>math.factorial(x)</code></h3>
|
||||
<p>Return <code translate="no" v-pre>x</code> factorial as an integer.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/lz4/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">lz4</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/msgpack/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">msgpack</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "math", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/math.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
11
modules/msgpack.md
Normal file
11
modules/msgpack.md
Normal file
@ -0,0 +1,11 @@
|
||||
!!!
|
||||
This module is optional. Set option `PK_BUILD_MODULE_MSGPACK` to `ON` in your `CMakeLists.txt` to enable it.
|
||||
!!!
|
||||
|
||||
### `msgpack.loads(data: bytes)`
|
||||
|
||||
Decode a msgpack bytes into a python object.
|
||||
|
||||
### `msgpack.dumps(obj) -> bytes`
|
||||
|
||||
Encode a python object into a msgpack bytes.
|
||||
318
modules/msgpack/index.html
Normal file
318
modules/msgpack/index.html
Normal file
@ -0,0 +1,318 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>msgpack | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="msgpack | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="This module is optional. Set option PK_BUILD_MODULE_MSGPACK to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/msgpack/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/msgpack/">
|
||||
<meta property="og:title" content="msgpack | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="This module is optional. Set option PK_BUILD_MODULE_MSGPACK to ON in your CMakeLists.txt to enable it.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/msgpack/">
|
||||
<meta name="twitter:title" content="msgpack | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="This module is optional. Set option PK_BUILD_MODULE_MSGPACK to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/msgpack.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="msgpack">msgpack</h1>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>This module is optional. Set option <code translate="no" v-pre>PK_BUILD_MODULE_MSGPACK</code> to <code translate="no" v-pre>ON</code> in your <code translate="no" v-pre>CMakeLists.txt</code> to enable it.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h3 id="msgpackloadsdata-bytes"><code translate="no" v-pre>msgpack.loads(data: bytes)</code></h3>
|
||||
<p>Decode a msgpack bytes into a python object.</p>
|
||||
<h3 id="msgpackdumpsobj---bytes"><code translate="no" v-pre>msgpack.dumps(obj) -> bytes</code></h3>
|
||||
<p>Encode a python object into a msgpack bytes.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/math/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">math</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/operator/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">operator</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "msgpack", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/msgpack.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
50
modules/operator.md
Normal file
50
modules/operator.md
Normal file
@ -0,0 +1,50 @@
|
||||
The operator module exports a set of efficient functions corresponding to the intrinsic operators of Python. For example, `operator.add(x, y)` is equivalent to the expression `x+y`. Many function names are those used for special methods, without the double underscores.
|
||||
|
||||
## Mapping Operators to Functions
|
||||
|
||||
| Operation | Syntax | Function |
|
||||
| --- | --- | --- |
|
||||
| Ordering | `a <= b` | `le(a, b)` |
|
||||
| Ordering | `a < b` | `lt(a, b)` |
|
||||
| Ordering | `a >= b` | `ge(a, b)` |
|
||||
| Ordering | `a > b` | `gt(a, b)` |
|
||||
| Equality | `a == b` | `eq(a, b)` |
|
||||
| Equality | `a != b` | `ne(a, b)` |
|
||||
| Bitwise AND | `a & b` | `and_(a, b)` |
|
||||
| Bitwise OR | `a | b` | `or_(a, b)` |
|
||||
| Bitwise XOR | `a ^ b` | `xor(a, b)` |
|
||||
| Bitwise Inversion | `~a` | `invert(a)` |
|
||||
| Left Shift | `a << b` | `lshift(a, b)` |
|
||||
| Right Shift | `a >> b` | `rshift(a, b)` |
|
||||
| Identity | `a is b` | `is_(a, b)` |
|
||||
| Identity | `a is not b` | `is_not(a, b)` |
|
||||
| Negation (Logical) | `not a` | `not_(a)` |
|
||||
| Negation (Arithmetic) | `-a` | `neg(a)` |
|
||||
| Truth Test | `bool(a)` | `truth(a)` |
|
||||
| Containment Test | `b in a` | `contains(a, b)` |
|
||||
| Addition | `a + b` | `add(a, b)` |
|
||||
| Subtraction | `a - b` | `sub(a, b)` |
|
||||
| Multiplication | `a * b` | `mul(a, b)` |
|
||||
| Division | `a / b` | `truediv(a, b)` |
|
||||
| Division | `a // b` | `floordiv(a, b)` |
|
||||
| Modulo | `a % b` | `mod(a, b)` |
|
||||
| Exponentiation | `a ** b` | `pow(a, b)` |
|
||||
| Matrix Multiplication | `a @ b` | `matmul(a, b)` |
|
||||
| Indexing | `a[b]` | `getitem(a, b)` |
|
||||
| Index Assignment | `a[b] = c` | `setitem(a, b, c)` |
|
||||
| Index Deletion | `del a[b]` | `delitem(a, b)` |
|
||||
|
||||
## In-place Operators
|
||||
| Operation | Syntax | Function |
|
||||
| --- | --- | --- |
|
||||
| Addition | `a += b` | `iadd(a, b)` |
|
||||
| Subtraction | `a -= b` | `isub(a, b)` |
|
||||
| Multiplication | `a *= b` | `imul(a, b)` |
|
||||
| Division | `a /= b` | `itruediv(a, b)` |
|
||||
| Division | `a //= b` | `ifloordiv(a, b)` |
|
||||
| Modulo | `a %= b` | `imod(a, b)` |
|
||||
| Bitwise AND | `a &= b` | `iand(a, b)` |
|
||||
| Bitwise OR | `a |= b` | `ior(a, b)` |
|
||||
| Bitwise XOR | `a ^= b` | `ixor(a, b)` |
|
||||
| Left Shift | `a <<= b` | `ilshift(a, b)` |
|
||||
| Right Shift | `a >>= b` | `irshift(a, b)` |
|
||||
526
modules/operator/index.html
Normal file
526
modules/operator/index.html
Normal file
@ -0,0 +1,526 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>operator | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="operator | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="The operator module exports a set of efficient functions corresponding to the intrinsic operators of Python. For example, operator.add(x, y) is equivalent to the expression x+y.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/operator/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/operator/">
|
||||
<meta property="og:title" content="operator | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="The operator module exports a set of efficient functions corresponding to the intrinsic operators of Python. For example, operator.add(x, y) is equivalent to the expression x+y.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/operator/">
|
||||
<meta name="twitter:title" content="operator | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="The operator module exports a set of efficient functions corresponding to the intrinsic operators of Python. For example, operator.add(x, y) is equivalent to the expression x+y.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/operator.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="operator">operator</h1>
|
||||
<p>The operator module exports a set of efficient functions corresponding to the intrinsic operators of Python. For example, <code translate="no" v-pre>operator.add(x, y)</code> is equivalent to the expression <code translate="no" v-pre>x+y</code>. Many function names are those used for special methods, without the double underscores.</p>
|
||||
<h2 id="mapping-operators-to-functions">Mapping Operators to Functions</h2>
|
||||
<div class="table-wrapper scrollbar overflow-hidden">
|
||||
<table class="comfortable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Operation</th>
|
||||
<th>Syntax</th>
|
||||
<th>Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Ordering</td>
|
||||
<td><code translate="no" v-pre>a <= b</code></td>
|
||||
<td><code translate="no" v-pre>le(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ordering</td>
|
||||
<td><code translate="no" v-pre>a < b</code></td>
|
||||
<td><code translate="no" v-pre>lt(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ordering</td>
|
||||
<td><code translate="no" v-pre>a >= b</code></td>
|
||||
<td><code translate="no" v-pre>ge(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ordering</td>
|
||||
<td><code translate="no" v-pre>a > b</code></td>
|
||||
<td><code translate="no" v-pre>gt(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Equality</td>
|
||||
<td><code translate="no" v-pre>a == b</code></td>
|
||||
<td><code translate="no" v-pre>eq(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Equality</td>
|
||||
<td><code translate="no" v-pre>a != b</code></td>
|
||||
<td><code translate="no" v-pre>ne(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise AND</td>
|
||||
<td><code translate="no" v-pre>a & b</code></td>
|
||||
<td><code translate="no" v-pre>and_(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise OR</td>
|
||||
<td><code translate="no" v-pre>a | b</code></td>
|
||||
<td><code translate="no" v-pre>or_(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise XOR</td>
|
||||
<td><code translate="no" v-pre>a ^ b</code></td>
|
||||
<td><code translate="no" v-pre>xor(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise Inversion</td>
|
||||
<td><code translate="no" v-pre>~a</code></td>
|
||||
<td><code translate="no" v-pre>invert(a)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Left Shift</td>
|
||||
<td><code translate="no" v-pre>a << b</code></td>
|
||||
<td><code translate="no" v-pre>lshift(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Right Shift</td>
|
||||
<td><code translate="no" v-pre>a >> b</code></td>
|
||||
<td><code translate="no" v-pre>rshift(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Identity</td>
|
||||
<td><code translate="no" v-pre>a is b</code></td>
|
||||
<td><code translate="no" v-pre>is_(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Identity</td>
|
||||
<td><code translate="no" v-pre>a is not b</code></td>
|
||||
<td><code translate="no" v-pre>is_not(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Negation (Logical)</td>
|
||||
<td><code translate="no" v-pre>not a</code></td>
|
||||
<td><code translate="no" v-pre>not_(a)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Negation (Arithmetic)</td>
|
||||
<td><code translate="no" v-pre>-a</code></td>
|
||||
<td><code translate="no" v-pre>neg(a)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Truth Test</td>
|
||||
<td><code translate="no" v-pre>bool(a)</code></td>
|
||||
<td><code translate="no" v-pre>truth(a)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Containment Test</td>
|
||||
<td><code translate="no" v-pre>b in a</code></td>
|
||||
<td><code translate="no" v-pre>contains(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Addition</td>
|
||||
<td><code translate="no" v-pre>a + b</code></td>
|
||||
<td><code translate="no" v-pre>add(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Subtraction</td>
|
||||
<td><code translate="no" v-pre>a - b</code></td>
|
||||
<td><code translate="no" v-pre>sub(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Multiplication</td>
|
||||
<td><code translate="no" v-pre>a * b</code></td>
|
||||
<td><code translate="no" v-pre>mul(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Division</td>
|
||||
<td><code translate="no" v-pre>a / b</code></td>
|
||||
<td><code translate="no" v-pre>truediv(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Division</td>
|
||||
<td><code translate="no" v-pre>a // b</code></td>
|
||||
<td><code translate="no" v-pre>floordiv(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Modulo</td>
|
||||
<td><code translate="no" v-pre>a % b</code></td>
|
||||
<td><code translate="no" v-pre>mod(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Exponentiation</td>
|
||||
<td><code translate="no" v-pre>a ** b</code></td>
|
||||
<td><code translate="no" v-pre>pow(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Matrix Multiplication</td>
|
||||
<td><code translate="no" v-pre>a @ b</code></td>
|
||||
<td><code translate="no" v-pre>matmul(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Indexing</td>
|
||||
<td><code translate="no" v-pre>a[b]</code></td>
|
||||
<td><code translate="no" v-pre>getitem(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Index Assignment</td>
|
||||
<td><code translate="no" v-pre>a[b] = c</code></td>
|
||||
<td><code translate="no" v-pre>setitem(a, b, c)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Index Deletion</td>
|
||||
<td><code translate="no" v-pre>del a[b]</code></td>
|
||||
<td><code translate="no" v-pre>delitem(a, b)</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<h2 id="in-place-operators">In-place Operators</h2>
|
||||
<div class="table-wrapper scrollbar overflow-hidden">
|
||||
<table class="comfortable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Operation</th>
|
||||
<th>Syntax</th>
|
||||
<th>Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Addition</td>
|
||||
<td><code translate="no" v-pre>a += b</code></td>
|
||||
<td><code translate="no" v-pre>iadd(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Subtraction</td>
|
||||
<td><code translate="no" v-pre>a -= b</code></td>
|
||||
<td><code translate="no" v-pre>isub(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Multiplication</td>
|
||||
<td><code translate="no" v-pre>a *= b</code></td>
|
||||
<td><code translate="no" v-pre>imul(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Division</td>
|
||||
<td><code translate="no" v-pre>a /= b</code></td>
|
||||
<td><code translate="no" v-pre>itruediv(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Division</td>
|
||||
<td><code translate="no" v-pre>a //= b</code></td>
|
||||
<td><code translate="no" v-pre>ifloordiv(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Modulo</td>
|
||||
<td><code translate="no" v-pre>a %= b</code></td>
|
||||
<td><code translate="no" v-pre>imod(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise AND</td>
|
||||
<td><code translate="no" v-pre>a &= b</code></td>
|
||||
<td><code translate="no" v-pre>iand(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise OR</td>
|
||||
<td><code translate="no" v-pre>a |= b</code></td>
|
||||
<td><code translate="no" v-pre>ior(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Bitwise XOR</td>
|
||||
<td><code translate="no" v-pre>a ^= b</code></td>
|
||||
<td><code translate="no" v-pre>ixor(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Left Shift</td>
|
||||
<td><code translate="no" v-pre>a <<= b</code></td>
|
||||
<td><code translate="no" v-pre>ilshift(a, b)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Right Shift</td>
|
||||
<td><code translate="no" v-pre>a >>= b</code></td>
|
||||
<td><code translate="no" v-pre>irshift(a, b)</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/msgpack/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">msgpack</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/periphery/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">periphery</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "operator", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/operator.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
7
modules/periphery.md
Normal file
7
modules/periphery.md
Normal file
@ -0,0 +1,7 @@
|
||||
!!!
|
||||
This module is optional. Set option `PK_BUILD_MODULE_PERIPHERY` to `ON` in your `CMakeLists.txt` to enable it.
|
||||
!!!
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/periphery.pyi" :::
|
||||
901
modules/periphery/index.html
Normal file
901
modules/periphery/index.html
Normal file
@ -0,0 +1,901 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>periphery | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="periphery | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="This module is optional. Set option PK_BUILD_MODULE_PERIPHERY to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/periphery/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/periphery/">
|
||||
<meta property="og:title" content="periphery | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="This module is optional. Set option PK_BUILD_MODULE_PERIPHERY to ON in your CMakeLists.txt to enable it.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/periphery/">
|
||||
<meta name="twitter:title" content="periphery | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="This module is optional. Set option PK_BUILD_MODULE_PERIPHERY to ON in your CMakeLists.txt to enable it.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/periphery.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="periphery">periphery</h1>
|
||||
<div class="flex mb-6">
|
||||
<div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
|
||||
<div class="flex w-full py-4 border border-l-0 rounded-tr-lg rounded-br-lg doc-callout bg-callout-base-bg border-callout-base-border" role="alert">
|
||||
<div class="flex items-center ml-4 h-7">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
|
||||
<g fill="currentColor"><g>
|
||||
<path d="M12 1C5.93 1 1 5.93 1 12s4.93 11 11 11 11-4.93 11-11S18.07 1 12 1zm0 20c-4.96 0-9-4.04-9-9s4.04-9 9-9 9 4.04 9 9-4.04 9-9 9z"></path>
|
||||
<path d="M12 11c-.55 0-1 .45-1 1v4c0 .55.45 1 1 1s1-.45 1-1v-4c0-.55-.45-1-1-1zM12.01 7c-.56 0-1 .45-1 1s.45 1 1 1 1-.45 1-1-.45-1-1-1z"></path>
|
||||
<path fill="none" d="M0 0h24v24H0z"></path>
|
||||
</g></g>
|
||||
</svg>
|
||||
</div>
|
||||
<div class="pr-5 ml-3 w-full">
|
||||
<p>This module is optional. Set option <code translate="no" v-pre>PK_BUILD_MODULE_PERIPHERY</code> to <code translate="no" v-pre>ON</code> in your <code translate="no" v-pre>CMakeLists.txt</code> to enable it.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from typing import overload
|
||||
from stdc import intptr
|
||||
|
||||
class gpio_config:
|
||||
direction: int # (gpio_direction_t)
|
||||
edge: int # (gpio_edge_t)
|
||||
event_clock: int # (gpio_event_clock_t)
|
||||
debounce_us: int # (uint32_t)
|
||||
bias: int # (gpio_bias_t)
|
||||
drive: int # (gpio_drive_t)
|
||||
inverted: bool # (bool)
|
||||
label: str # (const char*)
|
||||
|
||||
@overload
|
||||
def __init__(self): ...
|
||||
@overload
|
||||
def __init__(self, direction: int, edge: int, event_clock: int, debounce_us: int, bias: int, drive: int, inverted: bool, label: str): ...
|
||||
|
||||
class spi_msg:
|
||||
txbuf: intptr # (const uint8_t*)
|
||||
rxbuf: intptr # (uint8_t*)
|
||||
len: int # (size_t)
|
||||
deselect: bool # (bool)
|
||||
deselect_delay_us: int # (uint16_t)
|
||||
word_delay_us: int # (uint8_t)
|
||||
|
||||
@overload
|
||||
def __init__(self): ...
|
||||
@overload
|
||||
def __init__(self, txbuf: intptr, rxbuf: intptr, len: int, deselect: bool, deselect_delay_us: int, word_delay_us: int): ...
|
||||
|
||||
class periphery_version:
|
||||
major: int # (unsigned)
|
||||
minor: int # (unsigned)
|
||||
patch: int # (unsigned)
|
||||
commit_id: str # (const char*)
|
||||
|
||||
@overload
|
||||
def __init__(self): ...
|
||||
@overload
|
||||
def __init__(self, major: int, minor: int, patch: int, commit_id: str): ...
|
||||
|
||||
def gpio_new() -> intptr:
|
||||
"""Wraps `gpio_t* gpio_new()`"""
|
||||
|
||||
def gpio_open(gpio: intptr, path: str, line: int, direction: int, /) -> int:
|
||||
"""Wraps `int gpio_open(gpio_t* gpio, const char* path, unsigned line, gpio_direction_t direction)`"""
|
||||
|
||||
def gpio_open_name(gpio: intptr, path: str, name: str, direction: int, /) -> int:
|
||||
"""Wraps `int gpio_open_name(gpio_t* gpio, const char* path, const char* name, gpio_direction_t direction)`"""
|
||||
|
||||
def gpio_open_advanced(gpio: intptr, path: str, line: int, config: intptr, /) -> int:
|
||||
"""Wraps `int gpio_open_advanced(gpio_t* gpio, const char* path, unsigned line, const gpio_config_t* config)`"""
|
||||
|
||||
def gpio_open_name_advanced(gpio: intptr, path: str, name: str, config: intptr, /) -> int:
|
||||
"""Wraps `int gpio_open_name_advanced(gpio_t* gpio, const char* path, const char* name, const gpio_config_t* config)`"""
|
||||
|
||||
def gpio_open_sysfs(gpio: intptr, line: int, direction: int, /) -> int:
|
||||
"""Wraps `int gpio_open_sysfs(gpio_t* gpio, unsigned line, gpio_direction_t direction)`"""
|
||||
|
||||
def gpio_read(gpio: intptr, value: intptr, /) -> int:
|
||||
"""Wraps `int gpio_read(gpio_t* gpio, bool* value)`"""
|
||||
|
||||
def gpio_write(gpio: intptr, value: bool, /) -> int:
|
||||
"""Wraps `int gpio_write(gpio_t* gpio, bool value)`"""
|
||||
|
||||
def gpio_poll(gpio: intptr, timeout_ms: int, /) -> int:
|
||||
"""Wraps `int gpio_poll(gpio_t* gpio, int timeout_ms)`"""
|
||||
|
||||
def gpio_close(gpio: intptr, /) -> int:
|
||||
"""Wraps `int gpio_close(gpio_t* gpio)`"""
|
||||
|
||||
def gpio_free(gpio: intptr, /) -> None:
|
||||
"""Wraps `void gpio_free(gpio_t* gpio)`"""
|
||||
|
||||
def gpio_read_event(gpio: intptr, edge: intptr, timestamp: intptr, /) -> int:
|
||||
"""Wraps `int gpio_read_event(gpio_t* gpio, gpio_edge_t* edge, uint64_t* timestamp)`"""
|
||||
|
||||
def gpio_poll_multiple(gpios: intptr, count: int, timeout_ms: int, gpios_ready: intptr, /) -> int:
|
||||
"""Wraps `int gpio_poll_multiple(gpio_t** gpios, size_t count, int timeout_ms, bool* gpios_ready)`"""
|
||||
|
||||
def gpio_get_direction(gpio: intptr, direction: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_direction(gpio_t* gpio, gpio_direction_t* direction)`"""
|
||||
|
||||
def gpio_get_edge(gpio: intptr, edge: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_edge(gpio_t* gpio, gpio_edge_t* edge)`"""
|
||||
|
||||
def gpio_get_event_clock(gpio: intptr, event_clock: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_event_clock(gpio_t* gpio, gpio_event_clock_t* event_clock)`"""
|
||||
|
||||
def gpio_get_debounce_us(gpio: intptr, debounce_us: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_debounce_us(gpio_t* gpio, uint32_t* debounce_us)`"""
|
||||
|
||||
def gpio_get_bias(gpio: intptr, bias: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_bias(gpio_t* gpio, gpio_bias_t* bias)`"""
|
||||
|
||||
def gpio_get_drive(gpio: intptr, drive: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_drive(gpio_t* gpio, gpio_drive_t* drive)`"""
|
||||
|
||||
def gpio_get_inverted(gpio: intptr, inverted: intptr, /) -> int:
|
||||
"""Wraps `int gpio_get_inverted(gpio_t* gpio, bool* inverted)`"""
|
||||
|
||||
def gpio_set_direction(gpio: intptr, direction: int, /) -> int:
|
||||
"""Wraps `int gpio_set_direction(gpio_t* gpio, gpio_direction_t direction)`"""
|
||||
|
||||
def gpio_set_edge(gpio: intptr, edge: int, /) -> int:
|
||||
"""Wraps `int gpio_set_edge(gpio_t* gpio, gpio_edge_t edge)`"""
|
||||
|
||||
def gpio_set_event_clock(gpio: intptr, event_clock: int, /) -> int:
|
||||
"""Wraps `int gpio_set_event_clock(gpio_t* gpio, gpio_event_clock_t event_clock)`"""
|
||||
|
||||
def gpio_set_debounce_us(gpio: intptr, debounce_us: int, /) -> int:
|
||||
"""Wraps `int gpio_set_debounce_us(gpio_t* gpio, uint32_t debounce_us)`"""
|
||||
|
||||
def gpio_set_bias(gpio: intptr, bias: int, /) -> int:
|
||||
"""Wraps `int gpio_set_bias(gpio_t* gpio, gpio_bias_t bias)`"""
|
||||
|
||||
def gpio_set_drive(gpio: intptr, drive: int, /) -> int:
|
||||
"""Wraps `int gpio_set_drive(gpio_t* gpio, gpio_drive_t drive)`"""
|
||||
|
||||
def gpio_set_inverted(gpio: intptr, inverted: bool, /) -> int:
|
||||
"""Wraps `int gpio_set_inverted(gpio_t* gpio, bool inverted)`"""
|
||||
|
||||
def gpio_line(gpio: intptr, /) -> int:
|
||||
"""Wraps `unsigned gpio_line(gpio_t* gpio)`"""
|
||||
|
||||
def gpio_fd(gpio: intptr, /) -> int:
|
||||
"""Wraps `int gpio_fd(gpio_t* gpio)`"""
|
||||
|
||||
def gpio_name(gpio: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int gpio_name(gpio_t* gpio, char* str, size_t len)`"""
|
||||
|
||||
def gpio_label(gpio: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int gpio_label(gpio_t* gpio, char* str, size_t len)`"""
|
||||
|
||||
def gpio_chip_fd(gpio: intptr, /) -> int:
|
||||
"""Wraps `int gpio_chip_fd(gpio_t* gpio)`"""
|
||||
|
||||
def gpio_chip_name(gpio: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int gpio_chip_name(gpio_t* gpio, char* str, size_t len)`"""
|
||||
|
||||
def gpio_chip_label(gpio: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int gpio_chip_label(gpio_t* gpio, char* str, size_t len)`"""
|
||||
|
||||
def gpio_tostring(gpio: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int gpio_tostring(gpio_t* gpio, char* str, size_t len)`"""
|
||||
|
||||
def gpio_errno(gpio: intptr, /) -> int:
|
||||
"""Wraps `int gpio_errno(gpio_t* gpio)`"""
|
||||
|
||||
def gpio_errmsg(gpio: intptr, /) -> str:
|
||||
"""Wraps `const char* gpio_errmsg(gpio_t* gpio)`"""
|
||||
|
||||
def led_new() -> intptr:
|
||||
"""Wraps `led_t* led_new()`"""
|
||||
|
||||
def led_open(led: intptr, name: str, /) -> int:
|
||||
"""Wraps `int led_open(led_t* led, const char* name)`"""
|
||||
|
||||
def led_read(led: intptr, value: intptr, /) -> int:
|
||||
"""Wraps `int led_read(led_t* led, bool* value)`"""
|
||||
|
||||
def led_write(led: intptr, value: bool, /) -> int:
|
||||
"""Wraps `int led_write(led_t* led, bool value)`"""
|
||||
|
||||
def led_close(led: intptr, /) -> int:
|
||||
"""Wraps `int led_close(led_t* led)`"""
|
||||
|
||||
def led_free(led: intptr, /) -> None:
|
||||
"""Wraps `void led_free(led_t* led)`"""
|
||||
|
||||
def led_get_brightness(led: intptr, brightness: intptr, /) -> int:
|
||||
"""Wraps `int led_get_brightness(led_t* led, unsigned* brightness)`"""
|
||||
|
||||
def led_get_max_brightness(led: intptr, max_brightness: intptr, /) -> int:
|
||||
"""Wraps `int led_get_max_brightness(led_t* led, unsigned* max_brightness)`"""
|
||||
|
||||
def led_get_trigger(led: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int led_get_trigger(led_t* led, char* str, size_t len)`"""
|
||||
|
||||
def led_get_triggers_entry(led: intptr, index: int, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int led_get_triggers_entry(led_t* led, unsigned index, char* str, size_t len)`"""
|
||||
|
||||
def led_get_triggers_count(led: intptr, count: intptr, /) -> int:
|
||||
"""Wraps `int led_get_triggers_count(led_t* led, unsigned* count)`"""
|
||||
|
||||
def led_set_brightness(led: intptr, brightness: int, /) -> int:
|
||||
"""Wraps `int led_set_brightness(led_t* led, unsigned brightness)`"""
|
||||
|
||||
def led_set_trigger(led: intptr, trigger: str, /) -> int:
|
||||
"""Wraps `int led_set_trigger(led_t* led, const char* trigger)`"""
|
||||
|
||||
def led_name(led: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int led_name(led_t* led, char* str, size_t len)`"""
|
||||
|
||||
def led_tostring(led: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int led_tostring(led_t* led, char* str, size_t len)`"""
|
||||
|
||||
def led_errno(led: intptr, /) -> int:
|
||||
"""Wraps `int led_errno(led_t* led)`"""
|
||||
|
||||
def led_errmsg(led: intptr, /) -> str:
|
||||
"""Wraps `const char* led_errmsg(led_t* led)`"""
|
||||
|
||||
def mmio_new() -> intptr:
|
||||
"""Wraps `mmio_t* mmio_new()`"""
|
||||
|
||||
def mmio_open(mmio: intptr, base: int, size: int, /) -> int:
|
||||
"""Wraps `int mmio_open(mmio_t* mmio, uintptr_t base, size_t size)`"""
|
||||
|
||||
def mmio_open_advanced(mmio: intptr, base: int, size: int, path: str, /) -> int:
|
||||
"""Wraps `int mmio_open_advanced(mmio_t* mmio, uintptr_t base, size_t size, const char* path)`"""
|
||||
|
||||
def mmio_ptr(mmio: intptr, /) -> intptr:
|
||||
"""Wraps `void* mmio_ptr(mmio_t* mmio)`"""
|
||||
|
||||
def mmio_read64(mmio: intptr, offset: int, value: intptr, /) -> int:
|
||||
"""Wraps `int mmio_read64(mmio_t* mmio, uintptr_t offset, uint64_t* value)`"""
|
||||
|
||||
def mmio_read32(mmio: intptr, offset: int, value: intptr, /) -> int:
|
||||
"""Wraps `int mmio_read32(mmio_t* mmio, uintptr_t offset, uint32_t* value)`"""
|
||||
|
||||
def mmio_read16(mmio: intptr, offset: int, value: intptr, /) -> int:
|
||||
"""Wraps `int mmio_read16(mmio_t* mmio, uintptr_t offset, uint16_t* value)`"""
|
||||
|
||||
def mmio_read8(mmio: intptr, offset: int, value: intptr, /) -> int:
|
||||
"""Wraps `int mmio_read8(mmio_t* mmio, uintptr_t offset, uint8_t* value)`"""
|
||||
|
||||
def mmio_read(mmio: intptr, offset: int, buf: intptr, len: int, /) -> int:
|
||||
"""Wraps `int mmio_read(mmio_t* mmio, uintptr_t offset, uint8_t* buf, size_t len)`"""
|
||||
|
||||
def mmio_write64(mmio: intptr, offset: int, value: int, /) -> int:
|
||||
"""Wraps `int mmio_write64(mmio_t* mmio, uintptr_t offset, uint64_t value)`"""
|
||||
|
||||
def mmio_write32(mmio: intptr, offset: int, value: int, /) -> int:
|
||||
"""Wraps `int mmio_write32(mmio_t* mmio, uintptr_t offset, uint32_t value)`"""
|
||||
|
||||
def mmio_write16(mmio: intptr, offset: int, value: int, /) -> int:
|
||||
"""Wraps `int mmio_write16(mmio_t* mmio, uintptr_t offset, uint16_t value)`"""
|
||||
|
||||
def mmio_write8(mmio: intptr, offset: int, value: int, /) -> int:
|
||||
"""Wraps `int mmio_write8(mmio_t* mmio, uintptr_t offset, uint8_t value)`"""
|
||||
|
||||
def mmio_write(mmio: intptr, offset: int, buf: intptr, len: int, /) -> int:
|
||||
"""Wraps `int mmio_write(mmio_t* mmio, uintptr_t offset, const uint8_t* buf, size_t len)`"""
|
||||
|
||||
def mmio_close(mmio: intptr, /) -> int:
|
||||
"""Wraps `int mmio_close(mmio_t* mmio)`"""
|
||||
|
||||
def mmio_free(mmio: intptr, /) -> None:
|
||||
"""Wraps `void mmio_free(mmio_t* mmio)`"""
|
||||
|
||||
def mmio_base(mmio: intptr, /) -> int:
|
||||
"""Wraps `uintptr_t mmio_base(mmio_t* mmio)`"""
|
||||
|
||||
def mmio_size(mmio: intptr, /) -> int:
|
||||
"""Wraps `size_t mmio_size(mmio_t* mmio)`"""
|
||||
|
||||
def mmio_tostring(mmio: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int mmio_tostring(mmio_t* mmio, char* str, size_t len)`"""
|
||||
|
||||
def mmio_errno(mmio: intptr, /) -> int:
|
||||
"""Wraps `int mmio_errno(mmio_t* mmio)`"""
|
||||
|
||||
def mmio_errmsg(mmio: intptr, /) -> str:
|
||||
"""Wraps `const char* mmio_errmsg(mmio_t* mmio)`"""
|
||||
|
||||
def pwm_new() -> intptr:
|
||||
"""Wraps `pwm_t* pwm_new()`"""
|
||||
|
||||
def pwm_open(pwm: intptr, chip: int, channel: int, /) -> int:
|
||||
"""Wraps `int pwm_open(pwm_t* pwm, unsigned chip, unsigned channel)`"""
|
||||
|
||||
def pwm_enable(pwm: intptr, /) -> int:
|
||||
"""Wraps `int pwm_enable(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_disable(pwm: intptr, /) -> int:
|
||||
"""Wraps `int pwm_disable(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_close(pwm: intptr, /) -> int:
|
||||
"""Wraps `int pwm_close(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_free(pwm: intptr, /) -> None:
|
||||
"""Wraps `void pwm_free(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_get_enabled(pwm: intptr, enabled: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_enabled(pwm_t* pwm, bool* enabled)`"""
|
||||
|
||||
def pwm_get_period_ns(pwm: intptr, period_ns: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_period_ns(pwm_t* pwm, uint64_t* period_ns)`"""
|
||||
|
||||
def pwm_get_duty_cycle_ns(pwm: intptr, duty_cycle_ns: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_duty_cycle_ns(pwm_t* pwm, uint64_t* duty_cycle_ns)`"""
|
||||
|
||||
def pwm_get_period(pwm: intptr, period: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_period(pwm_t* pwm, double* period)`"""
|
||||
|
||||
def pwm_get_duty_cycle(pwm: intptr, duty_cycle: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_duty_cycle(pwm_t* pwm, double* duty_cycle)`"""
|
||||
|
||||
def pwm_get_frequency(pwm: intptr, frequency: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_frequency(pwm_t* pwm, double* frequency)`"""
|
||||
|
||||
def pwm_get_polarity(pwm: intptr, polarity: intptr, /) -> int:
|
||||
"""Wraps `int pwm_get_polarity(pwm_t* pwm, pwm_polarity_t* polarity)`"""
|
||||
|
||||
def pwm_set_enabled(pwm: intptr, enabled: bool, /) -> int:
|
||||
"""Wraps `int pwm_set_enabled(pwm_t* pwm, bool enabled)`"""
|
||||
|
||||
def pwm_set_period_ns(pwm: intptr, period_ns: int, /) -> int:
|
||||
"""Wraps `int pwm_set_period_ns(pwm_t* pwm, uint64_t period_ns)`"""
|
||||
|
||||
def pwm_set_duty_cycle_ns(pwm: intptr, duty_cycle_ns: int, /) -> int:
|
||||
"""Wraps `int pwm_set_duty_cycle_ns(pwm_t* pwm, uint64_t duty_cycle_ns)`"""
|
||||
|
||||
def pwm_set_period(pwm: intptr, period: float, /) -> int:
|
||||
"""Wraps `int pwm_set_period(pwm_t* pwm, double period)`"""
|
||||
|
||||
def pwm_set_duty_cycle(pwm: intptr, duty_cycle: float, /) -> int:
|
||||
"""Wraps `int pwm_set_duty_cycle(pwm_t* pwm, double duty_cycle)`"""
|
||||
|
||||
def pwm_set_frequency(pwm: intptr, frequency: float, /) -> int:
|
||||
"""Wraps `int pwm_set_frequency(pwm_t* pwm, double frequency)`"""
|
||||
|
||||
def pwm_set_polarity(pwm: intptr, polarity: int, /) -> int:
|
||||
"""Wraps `int pwm_set_polarity(pwm_t* pwm, pwm_polarity_t polarity)`"""
|
||||
|
||||
def pwm_chip(pwm: intptr, /) -> int:
|
||||
"""Wraps `unsigned pwm_chip(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_channel(pwm: intptr, /) -> int:
|
||||
"""Wraps `unsigned pwm_channel(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_tostring(pwm: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int pwm_tostring(pwm_t* pwm, char* str, size_t len)`"""
|
||||
|
||||
def pwm_errno(pwm: intptr, /) -> int:
|
||||
"""Wraps `int pwm_errno(pwm_t* pwm)`"""
|
||||
|
||||
def pwm_errmsg(pwm: intptr, /) -> str:
|
||||
"""Wraps `const char* pwm_errmsg(pwm_t* pwm)`"""
|
||||
|
||||
def serial_new() -> intptr:
|
||||
"""Wraps `serial_t* serial_new()`"""
|
||||
|
||||
def serial_open(serial: intptr, path: str, baudrate: int, /) -> int:
|
||||
"""Wraps `int serial_open(serial_t* serial, const char* path, uint32_t baudrate)`"""
|
||||
|
||||
def serial_open_advanced(serial: intptr, path: str, baudrate: int, databits: int, parity: int, stopbits: int, xonxoff: bool, rtscts: bool, /) -> int:
|
||||
"""Wraps `int serial_open_advanced(serial_t* serial, const char* path, uint32_t baudrate, unsigned databits, serial_parity_t parity, unsigned stopbits, bool xonxoff, bool rtscts)`"""
|
||||
|
||||
def serial_read(serial: intptr, buf: intptr, len: int, timeout_ms: int, /) -> int:
|
||||
"""Wraps `int serial_read(serial_t* serial, uint8_t* buf, size_t len, int timeout_ms)`"""
|
||||
|
||||
def serial_write(serial: intptr, buf: intptr, len: int, /) -> int:
|
||||
"""Wraps `int serial_write(serial_t* serial, const uint8_t* buf, size_t len)`"""
|
||||
|
||||
def serial_flush(serial: intptr, /) -> int:
|
||||
"""Wraps `int serial_flush(serial_t* serial)`"""
|
||||
|
||||
def serial_input_waiting(serial: intptr, count: intptr, /) -> int:
|
||||
"""Wraps `int serial_input_waiting(serial_t* serial, unsigned* count)`"""
|
||||
|
||||
def serial_output_waiting(serial: intptr, count: intptr, /) -> int:
|
||||
"""Wraps `int serial_output_waiting(serial_t* serial, unsigned* count)`"""
|
||||
|
||||
def serial_poll(serial: intptr, timeout_ms: int, /) -> int:
|
||||
"""Wraps `int serial_poll(serial_t* serial, int timeout_ms)`"""
|
||||
|
||||
def serial_close(serial: intptr, /) -> int:
|
||||
"""Wraps `int serial_close(serial_t* serial)`"""
|
||||
|
||||
def serial_free(serial: intptr, /) -> None:
|
||||
"""Wraps `void serial_free(serial_t* serial)`"""
|
||||
|
||||
def serial_get_baudrate(serial: intptr, baudrate: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_baudrate(serial_t* serial, uint32_t* baudrate)`"""
|
||||
|
||||
def serial_get_databits(serial: intptr, databits: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_databits(serial_t* serial, unsigned* databits)`"""
|
||||
|
||||
def serial_get_parity(serial: intptr, parity: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_parity(serial_t* serial, serial_parity_t* parity)`"""
|
||||
|
||||
def serial_get_stopbits(serial: intptr, stopbits: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_stopbits(serial_t* serial, unsigned* stopbits)`"""
|
||||
|
||||
def serial_get_xonxoff(serial: intptr, xonxoff: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_xonxoff(serial_t* serial, bool* xonxoff)`"""
|
||||
|
||||
def serial_get_rtscts(serial: intptr, rtscts: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_rtscts(serial_t* serial, bool* rtscts)`"""
|
||||
|
||||
def serial_get_vmin(serial: intptr, vmin: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_vmin(serial_t* serial, unsigned* vmin)`"""
|
||||
|
||||
def serial_get_vtime(serial: intptr, vtime: intptr, /) -> int:
|
||||
"""Wraps `int serial_get_vtime(serial_t* serial, float* vtime)`"""
|
||||
|
||||
def serial_set_baudrate(serial: intptr, baudrate: int, /) -> int:
|
||||
"""Wraps `int serial_set_baudrate(serial_t* serial, uint32_t baudrate)`"""
|
||||
|
||||
def serial_set_databits(serial: intptr, databits: int, /) -> int:
|
||||
"""Wraps `int serial_set_databits(serial_t* serial, unsigned databits)`"""
|
||||
|
||||
def serial_set_parity(serial: intptr, parity: int, /) -> int:
|
||||
"""Wraps `int serial_set_parity(serial_t* serial, serial_parity_t parity)`"""
|
||||
|
||||
def serial_set_stopbits(serial: intptr, stopbits: int, /) -> int:
|
||||
"""Wraps `int serial_set_stopbits(serial_t* serial, unsigned stopbits)`"""
|
||||
|
||||
def serial_set_xonxoff(serial: intptr, enabled: bool, /) -> int:
|
||||
"""Wraps `int serial_set_xonxoff(serial_t* serial, bool enabled)`"""
|
||||
|
||||
def serial_set_rtscts(serial: intptr, enabled: bool, /) -> int:
|
||||
"""Wraps `int serial_set_rtscts(serial_t* serial, bool enabled)`"""
|
||||
|
||||
def serial_set_vmin(serial: intptr, vmin: int, /) -> int:
|
||||
"""Wraps `int serial_set_vmin(serial_t* serial, unsigned vmin)`"""
|
||||
|
||||
def serial_set_vtime(serial: intptr, vtime: float, /) -> int:
|
||||
"""Wraps `int serial_set_vtime(serial_t* serial, float vtime)`"""
|
||||
|
||||
def serial_fd(serial: intptr, /) -> int:
|
||||
"""Wraps `int serial_fd(serial_t* serial)`"""
|
||||
|
||||
def serial_tostring(serial: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int serial_tostring(serial_t* serial, char* str, size_t len)`"""
|
||||
|
||||
def serial_errno(serial: intptr, /) -> int:
|
||||
"""Wraps `int serial_errno(serial_t* serial)`"""
|
||||
|
||||
def serial_errmsg(serial: intptr, /) -> str:
|
||||
"""Wraps `const char* serial_errmsg(serial_t* serial)`"""
|
||||
|
||||
def spi_new() -> intptr:
|
||||
"""Wraps `spi_t* spi_new()`"""
|
||||
|
||||
def spi_open(spi: intptr, path: str, mode: int, max_speed: int, /) -> int:
|
||||
"""Wraps `int spi_open(spi_t* spi, const char* path, unsigned mode, uint32_t max_speed)`"""
|
||||
|
||||
def spi_open_advanced(spi: intptr, path: str, mode: int, max_speed: int, bit_order: int, bits_per_word: int, extra_flags: int, /) -> int:
|
||||
"""Wraps `int spi_open_advanced(spi_t* spi, const char* path, unsigned mode, uint32_t max_speed, spi_bit_order_t bit_order, uint8_t bits_per_word, uint8_t extra_flags)`"""
|
||||
|
||||
def spi_open_advanced2(spi: intptr, path: str, mode: int, max_speed: int, bit_order: int, bits_per_word: int, extra_flags: int, /) -> int:
|
||||
"""Wraps `int spi_open_advanced2(spi_t* spi, const char* path, unsigned mode, uint32_t max_speed, spi_bit_order_t bit_order, uint8_t bits_per_word, uint32_t extra_flags)`"""
|
||||
|
||||
def spi_transfer(spi: intptr, txbuf: intptr, rxbuf: intptr, len: int, /) -> int:
|
||||
"""Wraps `int spi_transfer(spi_t* spi, const uint8_t* txbuf, uint8_t* rxbuf, size_t len)`"""
|
||||
|
||||
def spi_transfer_advanced(spi: intptr, msgs: intptr, count: int, /) -> int:
|
||||
"""Wraps `int spi_transfer_advanced(spi_t* spi, const spi_msg_t* msgs, size_t count)`"""
|
||||
|
||||
def spi_close(spi: intptr, /) -> int:
|
||||
"""Wraps `int spi_close(spi_t* spi)`"""
|
||||
|
||||
def spi_free(spi: intptr, /) -> None:
|
||||
"""Wraps `void spi_free(spi_t* spi)`"""
|
||||
|
||||
def spi_get_mode(spi: intptr, mode: intptr, /) -> int:
|
||||
"""Wraps `int spi_get_mode(spi_t* spi, unsigned* mode)`"""
|
||||
|
||||
def spi_get_max_speed(spi: intptr, max_speed: intptr, /) -> int:
|
||||
"""Wraps `int spi_get_max_speed(spi_t* spi, uint32_t* max_speed)`"""
|
||||
|
||||
def spi_get_bit_order(spi: intptr, bit_order: intptr, /) -> int:
|
||||
"""Wraps `int spi_get_bit_order(spi_t* spi, spi_bit_order_t* bit_order)`"""
|
||||
|
||||
def spi_get_bits_per_word(spi: intptr, bits_per_word: intptr, /) -> int:
|
||||
"""Wraps `int spi_get_bits_per_word(spi_t* spi, uint8_t* bits_per_word)`"""
|
||||
|
||||
def spi_get_extra_flags(spi: intptr, extra_flags: intptr, /) -> int:
|
||||
"""Wraps `int spi_get_extra_flags(spi_t* spi, uint8_t* extra_flags)`"""
|
||||
|
||||
def spi_get_extra_flags32(spi: intptr, extra_flags: intptr, /) -> int:
|
||||
"""Wraps `int spi_get_extra_flags32(spi_t* spi, uint32_t* extra_flags)`"""
|
||||
|
||||
def spi_set_mode(spi: intptr, mode: int, /) -> int:
|
||||
"""Wraps `int spi_set_mode(spi_t* spi, unsigned mode)`"""
|
||||
|
||||
def spi_set_max_speed(spi: intptr, max_speed: int, /) -> int:
|
||||
"""Wraps `int spi_set_max_speed(spi_t* spi, uint32_t max_speed)`"""
|
||||
|
||||
def spi_set_bit_order(spi: intptr, bit_order: int, /) -> int:
|
||||
"""Wraps `int spi_set_bit_order(spi_t* spi, spi_bit_order_t bit_order)`"""
|
||||
|
||||
def spi_set_bits_per_word(spi: intptr, bits_per_word: int, /) -> int:
|
||||
"""Wraps `int spi_set_bits_per_word(spi_t* spi, uint8_t bits_per_word)`"""
|
||||
|
||||
def spi_set_extra_flags(spi: intptr, extra_flags: int, /) -> int:
|
||||
"""Wraps `int spi_set_extra_flags(spi_t* spi, uint8_t extra_flags)`"""
|
||||
|
||||
def spi_set_extra_flags32(spi: intptr, extra_flags: int, /) -> int:
|
||||
"""Wraps `int spi_set_extra_flags32(spi_t* spi, uint32_t extra_flags)`"""
|
||||
|
||||
def spi_fd(spi: intptr, /) -> int:
|
||||
"""Wraps `int spi_fd(spi_t* spi)`"""
|
||||
|
||||
def spi_tostring(spi: intptr, str: intptr, len: int, /) -> int:
|
||||
"""Wraps `int spi_tostring(spi_t* spi, char* str, size_t len)`"""
|
||||
|
||||
def spi_errno(spi: intptr, /) -> int:
|
||||
"""Wraps `int spi_errno(spi_t* spi)`"""
|
||||
|
||||
def spi_errmsg(spi: intptr, /) -> str:
|
||||
"""Wraps `const char* spi_errmsg(spi_t* spi)`"""
|
||||
|
||||
def periphery_version() -> str:
|
||||
"""Wraps `const char* periphery_version()`"""
|
||||
|
||||
def periphery_version_info() -> intptr:
|
||||
"""Wraps `const periphery_version_t* periphery_version_info()`"""
|
||||
|
||||
# aliases
|
||||
gpio_direction_t = int
|
||||
gpio_edge_t = int
|
||||
gpio_event_clock_t = int
|
||||
gpio_bias_t = int
|
||||
gpio_drive_t = int
|
||||
pwm_polarity_t = int
|
||||
serial_parity_t = int
|
||||
spi_bit_order_t = int
|
||||
# enums
|
||||
GPIO_ERROR_ARG: int
|
||||
GPIO_ERROR_OPEN: int
|
||||
GPIO_ERROR_NOT_FOUND: int
|
||||
GPIO_ERROR_QUERY: int
|
||||
GPIO_ERROR_CONFIGURE: int
|
||||
GPIO_ERROR_UNSUPPORTED: int
|
||||
GPIO_ERROR_INVALID_OPERATION: int
|
||||
GPIO_ERROR_IO: int
|
||||
GPIO_ERROR_CLOSE: int
|
||||
GPIO_DIR_IN: int
|
||||
GPIO_DIR_OUT: int
|
||||
GPIO_DIR_OUT_LOW: int
|
||||
GPIO_DIR_OUT_HIGH: int
|
||||
GPIO_EDGE_NONE: int
|
||||
GPIO_EDGE_RISING: int
|
||||
GPIO_EDGE_FALLING: int
|
||||
GPIO_EDGE_BOTH: int
|
||||
GPIO_EVENT_CLOCK_REALTIME: int
|
||||
GPIO_EVENT_CLOCK_MONOTONIC: int
|
||||
GPIO_EVENT_CLOCK_HTE: int
|
||||
GPIO_BIAS_DEFAULT: int
|
||||
GPIO_BIAS_PULL_UP: int
|
||||
GPIO_BIAS_PULL_DOWN: int
|
||||
GPIO_BIAS_DISABLE: int
|
||||
GPIO_DRIVE_DEFAULT: int
|
||||
GPIO_DRIVE_OPEN_DRAIN: int
|
||||
GPIO_DRIVE_OPEN_SOURCE: int
|
||||
LED_ERROR_ARG: int
|
||||
LED_ERROR_OPEN: int
|
||||
LED_ERROR_QUERY: int
|
||||
LED_ERROR_IO: int
|
||||
LED_ERROR_CLOSE: int
|
||||
MMIO_ERROR_ARG: int
|
||||
MMIO_ERROR_OPEN: int
|
||||
MMIO_ERROR_CLOSE: int
|
||||
PWM_ERROR_ARG: int
|
||||
PWM_ERROR_OPEN: int
|
||||
PWM_ERROR_QUERY: int
|
||||
PWM_ERROR_CONFIGURE: int
|
||||
PWM_ERROR_CLOSE: int
|
||||
PWM_POLARITY_NORMAL: int
|
||||
PWM_POLARITY_INVERSED: int
|
||||
SERIAL_ERROR_ARG: int
|
||||
SERIAL_ERROR_OPEN: int
|
||||
SERIAL_ERROR_QUERY: int
|
||||
SERIAL_ERROR_CONFIGURE: int
|
||||
SERIAL_ERROR_IO: int
|
||||
SERIAL_ERROR_CLOSE: int
|
||||
PARITY_NONE: int
|
||||
PARITY_ODD: int
|
||||
PARITY_EVEN: int
|
||||
SPI_ERROR_ARG: int
|
||||
SPI_ERROR_OPEN: int
|
||||
SPI_ERROR_QUERY: int
|
||||
SPI_ERROR_CONFIGURE: int
|
||||
SPI_ERROR_TRANSFER: int
|
||||
SPI_ERROR_CLOSE: int
|
||||
SPI_ERROR_UNSUPPORTED: int
|
||||
MSB_FIRST: int
|
||||
LSB_FIRST: int</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/operator/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">operator</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/pickle/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">pickle</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "periphery", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/periphery.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
26
modules/pickle.md
Normal file
26
modules/pickle.md
Normal file
@ -0,0 +1,26 @@
|
||||
### `pickle.dumps(obj) -> bytes`
|
||||
|
||||
Return the pickled representation of an object as a bytes object.
|
||||
|
||||
### `pickle.loads(b: bytes)`
|
||||
|
||||
Return the unpickled object from a bytes object.
|
||||
|
||||
## What can be pickled and unpickled?
|
||||
|
||||
The following types can be pickled:
|
||||
|
||||
- [x] None, True, and False;
|
||||
- [x] integers, floating-point numbers;
|
||||
- [x] strings, bytes;
|
||||
- [x] tuples, lists, sets, and dictionaries containing only picklable objects;
|
||||
- [x] functions (user-defined) accessible from the top level of a module (using def, not lambda);
|
||||
- [x] classes accessible from the top level of a module;
|
||||
- [x] instances of such classes
|
||||
|
||||
The following magic methods are available:
|
||||
|
||||
- [ ] `__getnewargs__`
|
||||
- [ ] `__getstate__`
|
||||
- [ ] `__setstate__`
|
||||
- [x] `__reduce__`
|
||||
319
modules/pickle/index.html
Normal file
319
modules/pickle/index.html
Normal file
@ -0,0 +1,319 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>pickle | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="pickle | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Return the pickled representation of an object as a bytes object.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/pickle/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/pickle/">
|
||||
<meta property="og:title" content="pickle | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Return the pickled representation of an object as a bytes object.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/pickle/">
|
||||
<meta name="twitter:title" content="pickle | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Return the pickled representation of an object as a bytes object.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/pickle.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="pickle">pickle</h1>
|
||||
<h3 id="pickledumpsobj---bytes"><code translate="no" v-pre>pickle.dumps(obj) -> bytes</code></h3>
|
||||
<p>Return the pickled representation of an object as a bytes object.</p>
|
||||
<h3 id="pickleloadsb-bytes"><code translate="no" v-pre>pickle.loads(b: bytes)</code></h3>
|
||||
<p>Return the unpickled object from a bytes object.</p>
|
||||
<h2 id="what-can-be-pickled-and-unpickled">What can be pickled and unpickled?</h2>
|
||||
<p>The following types can be pickled:</p>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> None, True, and False;</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> integers, floating-point numbers;</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> strings, bytes;</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> tuples, lists, sets, and dictionaries containing only picklable objects;</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> functions (user-defined) accessible from the top level of a module (using def, not lambda);</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> classes accessible from the top level of a module;</li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> instances of such classes</li>
|
||||
</ul>
|
||||
<p>The following magic methods are available:</p>
|
||||
<ul class="contains-task-list">
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>__getnewargs__</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>__getstate__</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" /> <code translate="no" v-pre>__setstate__</code></li>
|
||||
<li class="task-list-item"><input disabled="disabled" type="checkbox" checked="checked" /> <code translate="no" v-pre>__reduce__</code></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/periphery/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">periphery</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/pkpy/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">pkpy</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "pickle", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/pickle.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
5
modules/pkpy.md
Normal file
5
modules/pkpy.md
Normal file
@ -0,0 +1,5 @@
|
||||
Provide internal access to the pocketpy interpreter.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../include/typings/pkpy.pyi" :::
|
||||
368
modules/pkpy/index.html
Normal file
368
modules/pkpy/index.html
Normal file
@ -0,0 +1,368 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>pkpy | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="pkpy | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Provide internal access to the pocketpy interpreter.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/pkpy/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/pkpy/">
|
||||
<meta property="og:title" content="pkpy | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Provide internal access to the pocketpy interpreter.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/pkpy/">
|
||||
<meta name="twitter:title" content="pkpy | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Provide internal access to the pocketpy interpreter.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/pkpy.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="pkpy">pkpy</h1>
|
||||
<p>Provide internal access to the pocketpy interpreter.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">from typing import Self, Literal
|
||||
from vmath import vec2, vec2i
|
||||
|
||||
class TValue[T]:
|
||||
def __new__(cls, value: T) -> Self: ...
|
||||
|
||||
@property
|
||||
def value(self) -> T: ...
|
||||
|
||||
# TValue_int = TValue[int]
|
||||
# TValue_float = TValue[float]
|
||||
# TValue_vec2i = TValue[vec2i]
|
||||
# TValue_vec2 = TValue[vec2]
|
||||
|
||||
configmacros: dict[str, int]
|
||||
|
||||
def memory_usage_info() -> str: ...
|
||||
def memory_usage() -> int: ...
|
||||
|
||||
|
||||
def currentvm() -> int:
|
||||
"""Return the current VM index."""
|
||||
|
||||
|
||||
def watchdog_begin(timeout: int):
|
||||
"""Begin the watchdog with `timeout` in milliseconds.
|
||||
|
||||
`PK_ENABLE_WATCHDOG` must be defined to `1` to use this feature.
|
||||
You need to call `watchdog_end()` later.
|
||||
If `timeout` is reached, `TimeoutError` will be raised.
|
||||
"""
|
||||
def watchdog_end() -> None:
|
||||
"""End the watchdog after a call to `watchdog_begin()`."""
|
||||
|
||||
def profiler_begin() -> None: ...
|
||||
def profiler_end() -> None: ...
|
||||
def profiler_reset() -> None: ...
|
||||
def profiler_report() -> dict[str, list[list]]: ...
|
||||
|
||||
class ComputeThread:
|
||||
def __init__(self, vm_index: Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]): ...
|
||||
|
||||
@property
|
||||
def is_done(self) -> bool:
|
||||
"""Check if the current job is done."""
|
||||
|
||||
def wait_for_done(self) -> None:
|
||||
"""Wait for the current job to finish."""
|
||||
|
||||
def last_error(self) -> str | None: ...
|
||||
def last_retval(self): ...
|
||||
|
||||
def submit_exec(self, source: str) -> None:
|
||||
"""Submit a job to execute some source code."""
|
||||
|
||||
def submit_eval(self, source: str) -> None:
|
||||
"""Submit a job to evaluate some source code."""
|
||||
|
||||
def submit_call(self, eval_src: str, *args, **kwargs) -> None:
|
||||
"""Submit a job to call a function with arguments."""
|
||||
|
||||
def exec(self, source: str) -> None:
|
||||
"""Directly execute some source code."""
|
||||
|
||||
def eval(self, source: str):
|
||||
"""Directly evaluate some source code."""</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/pickle/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">pickle</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/random/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">random</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "pkpy", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/pkpy.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
27
modules/random.md
Normal file
27
modules/random.md
Normal file
@ -0,0 +1,27 @@
|
||||
### `random.seed(a)`
|
||||
|
||||
Set the random seed.
|
||||
|
||||
### `random.random()`
|
||||
|
||||
Return a random float number in the range [0.0, 1.0).
|
||||
|
||||
### `random.randint(a, b)`
|
||||
|
||||
Return a random integer in the range [a, b].
|
||||
|
||||
### `random.uniform(a, b)`
|
||||
|
||||
Return a random float number in the range [a, b).
|
||||
|
||||
### `random.choice(seq)`
|
||||
|
||||
Return a random element from a sequence.
|
||||
|
||||
### `random.shuffle(seq)`
|
||||
|
||||
Shuffle a sequence inplace.
|
||||
|
||||
### `random.choices(population, weights=None, k=1)`
|
||||
|
||||
Return a k sized list of elements chosen from the population with replacement.
|
||||
311
modules/random/index.html
Normal file
311
modules/random/index.html
Normal file
@ -0,0 +1,311 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>random | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="random | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Set the random seed.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/random/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/random/">
|
||||
<meta property="og:title" content="random | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Set the random seed.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/random/">
|
||||
<meta name="twitter:title" content="random | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Set the random seed.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/random.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="random">random</h1>
|
||||
<h3 id="randomseeda"><code translate="no" v-pre>random.seed(a)</code></h3>
|
||||
<p>Set the random seed.</p>
|
||||
<h3 id="randomrandom"><code translate="no" v-pre>random.random()</code></h3>
|
||||
<p>Return a random float number in the range [0.0, 1.0).</p>
|
||||
<h3 id="randomrandinta-b"><code translate="no" v-pre>random.randint(a, b)</code></h3>
|
||||
<p>Return a random integer in the range [a, b].</p>
|
||||
<h3 id="randomuniforma-b"><code translate="no" v-pre>random.uniform(a, b)</code></h3>
|
||||
<p>Return a random float number in the range [a, b).</p>
|
||||
<h3 id="randomchoiceseq"><code translate="no" v-pre>random.choice(seq)</code></h3>
|
||||
<p>Return a random element from a sequence.</p>
|
||||
<h3 id="randomshuffleseq"><code translate="no" v-pre>random.shuffle(seq)</code></h3>
|
||||
<p>Shuffle a sequence inplace.</p>
|
||||
<h3 id="randomchoicespopulation-weightsnone-k1"><code translate="no" v-pre>random.choices(population, weights=None, k=1)</code></h3>
|
||||
<p>Return a k sized list of elements chosen from the population with replacement.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/pkpy/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">pkpy</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/sys/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">sys</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "random", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/random.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
25
modules/sys.md
Normal file
25
modules/sys.md
Normal file
@ -0,0 +1,25 @@
|
||||
### `sys.version`
|
||||
|
||||
The version of pkpy.
|
||||
|
||||
### `sys.platform`
|
||||
|
||||
May be one of:
|
||||
+ `win32`
|
||||
+ `linux`
|
||||
+ `darwin`
|
||||
+ `android`
|
||||
+ `ios`
|
||||
+ `emscripten`
|
||||
|
||||
### `sys.argv`
|
||||
|
||||
The command line arguments. Set by `py_sys_setargv`.
|
||||
|
||||
### `sys.setrecursionlimit(limit: int)`
|
||||
|
||||
Set the maximum depth of the Python interpreter stack to `limit`. This limit prevents infinite recursion from causing an overflow of the C stack and crashing the interpreter.
|
||||
|
||||
### `sys.getrecursionlimit() -> int`
|
||||
|
||||
Return the current value of the recursion limit.
|
||||
315
modules/sys/index.html
Normal file
315
modules/sys/index.html
Normal file
@ -0,0 +1,315 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>sys | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="sys | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="The version of pkpy.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/sys/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/sys/">
|
||||
<meta property="og:title" content="sys | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="The version of pkpy.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/sys/">
|
||||
<meta name="twitter:title" content="sys | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="The version of pkpy.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/sys.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="sys">sys</h1>
|
||||
<h3 id="sysversion"><code translate="no" v-pre>sys.version</code></h3>
|
||||
<p>The version of pkpy.</p>
|
||||
<h3 id="sysplatform"><code translate="no" v-pre>sys.platform</code></h3>
|
||||
<p>May be one of:</p>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>win32</code></li>
|
||||
<li><code translate="no" v-pre>linux</code></li>
|
||||
<li><code translate="no" v-pre>darwin</code></li>
|
||||
<li><code translate="no" v-pre>android</code></li>
|
||||
<li><code translate="no" v-pre>ios</code></li>
|
||||
<li><code translate="no" v-pre>emscripten</code></li>
|
||||
</ul>
|
||||
<h3 id="sysargv"><code translate="no" v-pre>sys.argv</code></h3>
|
||||
<p>The command line arguments. Set by <code translate="no" v-pre>py_sys_setargv</code>.</p>
|
||||
<h3 id="syssetrecursionlimitlimit-int"><code translate="no" v-pre>sys.setrecursionlimit(limit: int)</code></h3>
|
||||
<p>Set the maximum depth of the Python interpreter stack to <code translate="no" v-pre>limit</code>. This limit prevents infinite recursion from causing an overflow of the C stack and crashing the interpreter.</p>
|
||||
<h3 id="sysgetrecursionlimit---int"><code translate="no" v-pre>sys.getrecursionlimit() -> int</code></h3>
|
||||
<p>Return the current value of the recursion limit.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/random/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">random</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/time/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">time</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "sys", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/sys.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
11
modules/time.md
Normal file
11
modules/time.md
Normal file
@ -0,0 +1,11 @@
|
||||
### `time.time()`
|
||||
|
||||
Returns the current time in seconds since the epoch as a floating point number.
|
||||
|
||||
### `time.sleep(secs)`
|
||||
|
||||
Suspend execution of the calling thread for the given number of seconds.
|
||||
|
||||
### `time.localtime()`
|
||||
|
||||
Returns the current struct time as a `struct_time` object.
|
||||
303
modules/time/index.html
Normal file
303
modules/time/index.html
Normal file
@ -0,0 +1,303 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>time | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="time | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Returns the current time in seconds since the epoch as a floating point number.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/time/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/time/">
|
||||
<meta property="og:title" content="time | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Returns the current time in seconds since the epoch as a floating point number.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/time/">
|
||||
<meta name="twitter:title" content="time | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Returns the current time in seconds since the epoch as a floating point number.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/time.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="time">time</h1>
|
||||
<h3 id="timetime"><code translate="no" v-pre>time.time()</code></h3>
|
||||
<p>Returns the current time in seconds since the epoch as a floating point number.</p>
|
||||
<h3 id="timesleepsecs"><code translate="no" v-pre>time.sleep(secs)</code></h3>
|
||||
<p>Suspend execution of the calling thread for the given number of seconds.</p>
|
||||
<h3 id="timelocaltime"><code translate="no" v-pre>time.localtime()</code></h3>
|
||||
<p>Returns the current struct time as a <code translate="no" v-pre>struct_time</code> object.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/sys/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">sys</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/traceback/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">traceback</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "time", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/time.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
7
modules/traceback.md
Normal file
7
modules/traceback.md
Normal file
@ -0,0 +1,7 @@
|
||||
### `traceback.print_exc() -> None`
|
||||
|
||||
Print the last exception and its traceback.
|
||||
|
||||
### `traceback.format_exc() -> str`
|
||||
|
||||
Return the last exception and its traceback as a string.
|
||||
301
modules/traceback/index.html
Normal file
301
modules/traceback/index.html
Normal file
@ -0,0 +1,301 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>traceback | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="traceback | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Print the last exception and its traceback.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/traceback/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/traceback/">
|
||||
<meta property="og:title" content="traceback | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Print the last exception and its traceback.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/traceback/">
|
||||
<meta name="twitter:title" content="traceback | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Print the last exception and its traceback.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/traceback.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="traceback">traceback</h1>
|
||||
<h3 id="tracebackprint_exc---none"><code translate="no" v-pre>traceback.print_exc() -> None</code></h3>
|
||||
<p>Print the last exception and its traceback.</p>
|
||||
<h3 id="tracebackformat_exc---str"><code translate="no" v-pre>traceback.format_exc() -> str</code></h3>
|
||||
<p>Return the last exception and its traceback as a string.</p>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/time/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">time</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/typing/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">typing</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "traceback", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/traceback.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
5
modules/typing.md
Normal file
5
modules/typing.md
Normal file
@ -0,0 +1,5 @@
|
||||
Placeholder module for type hints.
|
||||
|
||||
#### Source code
|
||||
|
||||
:::code source="../../python/typing.py" :::
|
||||
368
modules/typing/index.html
Normal file
368
modules/typing/index.html
Normal file
@ -0,0 +1,368 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>typing | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="typing | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Placeholder module for type hints.">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/typing/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/typing/">
|
||||
<meta property="og:title" content="typing | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Placeholder module for type hints.">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/typing/">
|
||||
<meta name="twitter:title" content="typing | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Placeholder module for type hints.">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/typing.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.5.3.830095462161" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="typing">typing</h1>
|
||||
<p>Placeholder module for type hints.</p>
|
||||
<h4 id="source-code">Source code</h4>
|
||||
<div id="source-code-code-1" class="codeblock-wrapper"><doc-codeblock>
|
||||
<pre translate="no" class="language-python"><code v-pre class="language-python">class _Placeholder:
|
||||
def __init__(self, *args, **kwargs):
|
||||
pass
|
||||
def __getitem__(self, *args):
|
||||
return self
|
||||
def __call__(self, *args, **kwargs):
|
||||
return self
|
||||
def __and__(self, other):
|
||||
return self
|
||||
def __or__(self, other):
|
||||
return self
|
||||
def __xor__(self, other):
|
||||
return self
|
||||
|
||||
|
||||
_PLACEHOLDER = _Placeholder()
|
||||
|
||||
Sequence = _PLACEHOLDER
|
||||
List = _PLACEHOLDER
|
||||
Dict = _PLACEHOLDER
|
||||
Tuple = _PLACEHOLDER
|
||||
Set = _PLACEHOLDER
|
||||
Any = _PLACEHOLDER
|
||||
Union = _PLACEHOLDER
|
||||
Optional = _PLACEHOLDER
|
||||
Callable = _PLACEHOLDER
|
||||
Type = _PLACEHOLDER
|
||||
TypeAlias = _PLACEHOLDER
|
||||
NewType = _PLACEHOLDER
|
||||
|
||||
ClassVar = _PLACEHOLDER
|
||||
|
||||
Literal = _PLACEHOLDER
|
||||
LiteralString = _PLACEHOLDER
|
||||
|
||||
Iterable = _PLACEHOLDER
|
||||
Generator = _PLACEHOLDER
|
||||
Iterator = _PLACEHOLDER
|
||||
|
||||
Hashable = _PLACEHOLDER
|
||||
|
||||
TypeVar = _PLACEHOLDER
|
||||
Self = _PLACEHOLDER
|
||||
|
||||
Protocol = object
|
||||
Generic = object
|
||||
Never = object
|
||||
|
||||
TYPE_CHECKING = False
|
||||
|
||||
# decorators
|
||||
overload = lambda x: x
|
||||
override = lambda x: x
|
||||
final = lambda x: x
|
||||
|
||||
# exhaustiveness checking
|
||||
assert_never = lambda x: x
|
||||
|
||||
TypedDict = dict
|
||||
NotRequired = _PLACEHOLDER
|
||||
ReadOnly = _PLACEHOLDER
|
||||
Required = _PLACEHOLDER
|
||||
TypeIs = _PLACEHOLDER
|
||||
TypeGuard = _PLACEHOLDER
|
||||
|
||||
cast = lambda _, val: val</code></pre>
|
||||
</doc-codeblock></div>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/traceback/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">traceback</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/unicodedata/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">unicodedata</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "typing", level: 2, icon: "file", hasPrism: true, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/typing.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
10
modules/unicodedata.md
Normal file
10
modules/unicodedata.md
Normal file
@ -0,0 +1,10 @@
|
||||
### `unicodedata.east_asian_width(char: str) -> str`
|
||||
|
||||
Returns the East Asian width of a Unicode character. The width is one of the following values:
|
||||
|
||||
- `F`: Fullwidth
|
||||
- `H`: Halfwidth
|
||||
- `N`: Neutral
|
||||
- `Na`: Narrow
|
||||
- `W`: Wide
|
||||
- `A`: Ambiguous
|
||||
307
modules/unicodedata/index.html
Normal file
307
modules/unicodedata/index.html
Normal file
@ -0,0 +1,307 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="h-full">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.5.3.830095462161">
|
||||
|
||||
<!-- See retype.com -->
|
||||
<meta name="generator" content="Retype 4.5.3">
|
||||
|
||||
<!-- Primary Meta Tags -->
|
||||
<title>unicodedata | Portable Python 3.x Interpreter in Modern C</title>
|
||||
<meta name="title" content="unicodedata | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="description" content="Returns the East Asian width of a Unicode character. The width is one of the following values:">
|
||||
|
||||
<!-- Canonical -->
|
||||
<link rel="canonical" href="https://pocketpy.dev/modules/unicodedata/">
|
||||
<link rel="sitemap" type="application/xml" title="Sitemap" href="https://pocketpy.dev/sitemap.xml">
|
||||
|
||||
<!-- Open Graph -->
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://pocketpy.dev/modules/unicodedata/">
|
||||
<meta property="og:title" content="unicodedata | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta property="og:description" content="Returns the East Asian width of a Unicode character. The width is one of the following values:">
|
||||
<meta property="og:site_name" content="pocketpy">
|
||||
<meta property="og:locale" content="en_US">
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:url" content="https://pocketpy.dev/modules/unicodedata/">
|
||||
<meta name="twitter:title" content="unicodedata | Portable Python 3.x Interpreter in Modern C">
|
||||
<meta name="twitter:description" content="Returns the East Asian width of a Unicode character. The width is one of the following values:">
|
||||
|
||||
<!-- Alternate Markdown -->
|
||||
<link rel="alternate" type="text/markdown" href="https://pocketpy.dev/modules/unicodedata.md">
|
||||
|
||||
<script data-cfasync="false">(function(){var cl=document.documentElement.classList,ls=localStorage.getItem("retype_scheme"),hd=cl.contains("dark"),hl=cl.contains("light"),wm=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches;if(ls==="dark"||(!ls&&wm&&!hd&&!hl)){cl.remove("light");cl.add("dark")}else if(ls==="light"||(!ls&&!wm&&!hd&&!hl)){cl.remove("dark");cl.add("light")}})();</script>
|
||||
|
||||
<link id="retype-favicon" rel="icon" href="../../static/logo.png" />
|
||||
<link href="../../resources/css/retype.css?v=4.5.3.830095462161" rel="stylesheet">
|
||||
|
||||
<script data-cfasync="false" src="../../resources/js/config.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
<script data-cfasync="false" src="../../resources/js/retype.js?v=4.5.3" data-turbo-eval="false" defer></script>
|
||||
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.5.3.830095462161" data-turbo-eval="false" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
|
||||
<div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
|
||||
|
||||
<header id="retype-header" class="sticky top-0 z-30 flex w-full h-16 bg-header-bg border-b border-header-border md:h-20">
|
||||
<div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
|
||||
<!-- Mobile menu button skeleton -->
|
||||
<button v-cloak class="skeleton retype-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-hidden rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button>
|
||||
<div v-cloak id="retype-sidebar-left-toggle-button"></div>
|
||||
|
||||
<!-- Logo -->
|
||||
<div class="flex items-center justify-between h-full py-2 md:w-75">
|
||||
<div class="flex items-center px-2 md:px-6">
|
||||
<a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
|
||||
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
|
||||
<img class="max-h-10 md:inline-block" src="../../static/logo.png" alt="" width="40" height="40">
|
||||
</span>
|
||||
<span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
|
||||
</a><span id="retype-branding-label" class="inline-flex mt-1 px-2 py-1 ml-4 text-xs font-medium leading-none items-center rounded-md bg-branding-label-bg text-branding-label-text ring-1 ring-branding-label-border ring-inset md:inline-block">v2.1.9</span>
|
||||
</div>
|
||||
|
||||
<span class="hidden h-8 border-r md:inline-block border-base-border"></span>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-between md:grow">
|
||||
<!-- Top Nav -->
|
||||
<nav id="retype-header-nav" class="hidden md:flex">
|
||||
<ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<div v-cloak class="flex justify-end grow">
|
||||
<div id="retype-mobile-search-button"></div>
|
||||
<doc-search-desktop></doc-search-desktop>
|
||||
|
||||
<doc-theme-switch class="lg:ml-2"></doc-theme-switch>
|
||||
<doc-history></doc-history>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="retype-container" class="container relative flex bg-white">
|
||||
<!-- Sidebar Skeleton -->
|
||||
<div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-sidebar-left-bg border-sidebar-left-border sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton">
|
||||
|
||||
<div class="flex items-center h-16 px-6">
|
||||
<input id="retype-filter-input-mock" class="w-full h-10 pl-8 px-3 py-2 transition-colors duration-200 ease-linear bg-filter-bg border border-filter-border rounded-lg shadow-none md:text-sm hover:border-filter-border-hover focus:outline-hidden focus:border-filter-border-focus placeholder-filter-placeholder" type="text">
|
||||
</div>
|
||||
|
||||
<div class="pl-6 mt-1 mb-4">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
|
||||
<div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sidebar component -->
|
||||
<doc-sidebar v-cloak>
|
||||
<template #sidebar-footer>
|
||||
<div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
|
||||
|
||||
<div class="py-3 px-6 md:hidden border-b dark:border-base-border">
|
||||
<nav>
|
||||
<ul class="flex flex-wrap justify-center items-center">
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"/>
|
||||
</svg>
|
||||
<span>Home</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.dev/static/web/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M9.5 15.584V8.416a.5.5 0 0 1 .77-.42l5.576 3.583a.5.5 0 0 1 0 .842l-5.576 3.584a.5.5 0 0 1-.77-.42Z"/><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm11-9.5A9.5 9.5 0 0 0 2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5Z"/>
|
||||
</svg>
|
||||
<span>Live Demo</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://pocketpy.github.io/examples/" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z"/>
|
||||
</svg>
|
||||
<span>Live Examples</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://github.com/blueloveth/pocketpy" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M10.226 17.284c-2.965-.36-5.054-2.493-5.054-5.256 0-1.123.404-2.336 1.078-3.144-.292-.741-.247-2.314.09-2.965.898-.112 2.111.36 2.83 1.01.853-.269 1.752-.404 2.853-.404 1.1 0 1.999.135 2.807.382.696-.629 1.932-1.1 2.83-.988.315.606.36 2.179.067 2.942.72.854 1.101 2 1.101 3.167 0 2.763-2.089 4.852-5.098 5.234.763.494 1.28 1.572 1.28 2.807v2.336c0 .674.561 1.056 1.235.786 4.066-1.55 7.255-5.615 7.255-10.646C23.5 6.188 18.334 1 11.978 1 5.62 1 .5 6.188.5 12.545c0 4.986 3.167 9.12 7.435 10.669.606.225 1.19-.18 1.19-.786V20.63a2.9 2.9 0 0 1-1.078.224c-1.483 0-2.359-.808-2.987-2.313-.247-.607-.517-.966-1.034-1.033-.27-.023-.359-.135-.359-.27 0-.27.45-.471.898-.471.652 0 1.213.404 1.797 1.235.45.651.921.943 1.483.943.561 0 .92-.202 1.437-.719.382-.381.674-.718.944-.943"/>
|
||||
</svg>
|
||||
<span>Github</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="mr-6">
|
||||
<a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-header-text font-header-text hover:text-header-text-hover" href="https://discord.gg/WWaq72GzXv" target="_blank">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="block shrink-0 mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
|
||||
<path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 14.25 14H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 15.543V14H1.75A1.75 1.75 0 0 1 0 12.25v-9.5C0 1.784.784 1 1.75 1ZM1.5 2.75v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Z"/><path d="M22.5 8.75a.25.25 0 0 0-.25-.25h-3.5a.75.75 0 0 1 0-1.5h3.5c.966 0 1.75.784 1.75 1.75v9.5A1.75 1.75 0 0 1 22.25 20H21v1.543a1.457 1.457 0 0 1-2.487 1.03L15.939 20H10.75A1.75 1.75 0 0 1 9 18.25v-1.465a.75.75 0 0 1 1.5 0v1.465c0 .138.112.25.25.25h5.5a.75.75 0 0 1 .53.22l2.72 2.72v-2.19a.75.75 0 0 1 .75-.75h2a.25.25 0 0 0 .25-.25v-9.5Z"/>
|
||||
</svg>
|
||||
<span>Discord</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<a class="flex items-center justify-center flex-nowrap h-16 text-gray-350 dark:text-dark-400 hover:text-gray-600 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener">
|
||||
<span class="text-xs whitespace-nowrap">Powered by</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg>
|
||||
</a>
|
||||
</div>
|
||||
</template>
|
||||
</doc-sidebar>
|
||||
|
||||
<div class="grow min-w-0 bg-body-bg">
|
||||
<!-- Render "toolbar" template here on api pages --><!-- Render page content -->
|
||||
<div class="flex">
|
||||
<div id="retype-main" class="min-w-0 p-4 grow md:px-16">
|
||||
<main class="relative pb-12 lg:pt-2">
|
||||
<div class="relative retype-markdown" id="retype-content">
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<div id="retype-sidebar-right-toggle"></div>
|
||||
<doc-page-actions></doc-page-actions>
|
||||
|
||||
<!-- Page content -->
|
||||
<h1 id="unicodedata">unicodedata</h1>
|
||||
<h3 id="unicodedataeast_asian_widthchar-str---str"><code translate="no" v-pre>unicodedata.east_asian_width(char: str) -> str</code></h3>
|
||||
<p>Returns the East Asian width of a Unicode character. The width is one of the following values:</p>
|
||||
<ul>
|
||||
<li><code translate="no" v-pre>F</code>: Fullwidth</li>
|
||||
<li><code translate="no" v-pre>H</code>: Halfwidth</li>
|
||||
<li><code translate="no" v-pre>N</code>: Neutral</li>
|
||||
<li><code translate="no" v-pre>Na</code>: Narrow</li>
|
||||
<li><code translate="no" v-pre>W</code>: Wide</li>
|
||||
<li><code translate="no" v-pre>A</code>: Ambiguous</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<!-- Required only on API pages -->
|
||||
<doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
|
||||
</div>
|
||||
<footer id="retype-content-footer" class="clear-both">
|
||||
|
||||
<nav id="retype-nextprev" class="print:hidden flex mt-14">
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../modules/typing/">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-base-text-muted">Previous</span>
|
||||
<span class="block mt-1">typing</span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="w-1/2">
|
||||
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-body-link border border-base-border hover:border-base-border-hover rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../modules/vmath/">
|
||||
<span>
|
||||
<span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
|
||||
<span class="block mt-1">vmath</span>
|
||||
</span>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
|
||||
</a>
|
||||
</div>
|
||||
</nav>
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
|
||||
<footer class="flex flex-wrap items-center justify-between print:justify-center">
|
||||
<div id="retype-footer-links" class="print:hidden">
|
||||
<ul class="flex flex-wrap items-center text-sm">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="retype-copyright" class="print:justify-center py-2 text-footer-text font-footer-link text-sm leading-relaxed"><p>© Copyright 2026 - <a href="https://github.com/blueloveTH">blueloveTH</a> - All rights reserved.</p></div>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Rendered if sidebar right is enabled -->
|
||||
<!-- Sidebar right skeleton-->
|
||||
<div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-sidebar-right-bg border-sidebar-right-border lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:translate-x-0 sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton">
|
||||
<div class="pl-5">
|
||||
<div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
<div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- User should be able to hide sidebar right -->
|
||||
<doc-sidebar-right v-cloak></doc-sidebar-right>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<doc-search-mobile></doc-search-mobile>
|
||||
<doc-back-to-top></doc-back-to-top>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="retype-overlay-target"></div>
|
||||
|
||||
<script data-cfasync="false">window.__DOCS__ = { "title": "unicodedata", level: 2, icon: "file", hasPrism: false, hasInstagram: false, hasMermaid: false, hasMath: false, tocDepth: 23, "md": "/modules/unicodedata.md" }</script>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user