gugdun
/
pocketpy
mirror of https://github.com/pocketpy/pocketpy


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555
							<!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.3.0.827133044009">

    <!-- See retype.com -->
    <meta name="generator" content="Retype 4.3.0">

    <!-- 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">

    <!-- Canonical -->
    <link rel="canonical" href="https://pocketpy.dev/bindings-cpp/">

    <!-- 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">
    <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">

    <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.3.0.827133044009" rel="stylesheet">

    <script data-cfasync="false" src="../resources/js/config.js?v=4.3.0.827133044009" data-turbo-eval="false" defer></script>
    <script data-cfasync="false" src="../resources/js/retype.js?v=4.3.0" data-turbo-eval="false" defer></script>
    <script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=4.3.0.827133044009" data-turbo-eval="false" defer></script>
    <script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=4.3.0.827133044009" 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 dark:hidden md:inline-block" src="../static/logo.png" alt="" width="512" height="512">
                            <img class="max-h-10 hidden dark:inline-block" src="../static/logo.png" alt="" width="512" height="512">
                        </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.8</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" href="">
                                <svg xmlns="http://www.w3.org/2000/svg" class="mb-px 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="mb-px 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="mb-px 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="mb-px mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
                                    <path d="M10.303 16.652c-2.837-.344-4.835-2.385-4.835-5.028 0-1.074.387-2.235 1.031-3.008-.279-.709-.236-2.214.086-2.837.86-.107 2.02.344 2.708.967.816-.258 1.676-.386 2.728-.386 1.053 0 1.913.128 2.686.365.666-.602 1.848-1.053 2.708-.946.3.581.344 2.085.064 2.815.688.817 1.053 1.913 1.053 3.03 0 2.643-1.998 4.641-4.877 5.006.73.473 1.224 1.504 1.224 2.686v2.235c0 .644.537 1.01 1.182.752 3.889-1.483 6.94-5.372 6.94-10.185 0-6.081-4.942-11.044-11.022-11.044-6.081 0-10.98 4.963-10.98 11.044a10.84 10.84 0 0 0 7.112 10.206c.58.215 1.139-.172 1.139-.752v-1.719a2.768 2.768 0 0 1-1.032.215c-1.418 0-2.256-.773-2.857-2.213-.237-.58-.495-.924-.989-.988-.258-.022-.344-.129-.344-.258 0-.258.43-.451.86-.451.623 0 1.16.386 1.719 1.181.43.623.881.903 1.418.903.537 0 .881-.194 1.375-.688.365-.365.645-.687.903-.902Z"/>
                                </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="mb-px 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" href="">
                                        <svg xmlns="http://www.w3.org/2000/svg" class="mb-px 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="mb-px 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="mb-px 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="mb-px mr-1.5" width="18" height="18" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" focusable="false">
                                            <path d="M10.303 16.652c-2.837-.344-4.835-2.385-4.835-5.028 0-1.074.387-2.235 1.031-3.008-.279-.709-.236-2.214.086-2.837.86-.107 2.02.344 2.708.967.816-.258 1.676-.386 2.728-.386 1.053 0 1.913.128 2.686.365.666-.602 1.848-1.053 2.708-.946.3.581.344 2.085.064 2.815.688.817 1.053 1.913 1.053 3.03 0 2.643-1.998 4.641-4.877 5.006.73.473 1.224 1.504 1.224 2.686v2.235c0 .644.537 1.01 1.182.752 3.889-1.483 6.94-5.372 6.94-10.185 0-6.081-4.942-11.044-11.022-11.044-6.081 0-10.98 4.963-10.98 11.044a10.84 10.84 0 0 0 7.112 10.206c.58.215 1.139-.172 1.139-.752v-1.719a2.768 2.768 0 0 1-1.032.215c-1.418 0-2.256-.773-2.857-2.213-.237-.58-.495-.924-.989-.988-.258-.022-.344-.129-.344-.258 0-.258.43-.451.86-.451.623 0 1.16.386 1.719 1.181.43.623.881.903 1.418.903.537 0 .881-.194 1.375-.688.365-.365.645-.687.903-.902Z"/>
                                        </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="mb-px 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="retype-markdown" id="retype-content">
                <!-- Rendered if sidebar right is enabled -->
                <div id="retype-sidebar-right-toggle"></div>
                <!-- 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 &lt;pybind11/pybind11.h&gt;
namespace py = pybind11;

PYBIND11_EMBEDDED_MODULE(example, m) {
    m.def(&quot;add&quot;, [](int a, int b) {
        return a + b;
    });

    auto math = m.def_submodule(&quot;math&quot;);
}</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_&amp; m)
{
    m.def(&quot;add&quot;, py::overload_cast&lt;int, int&gt;(&amp;add));

    // support function overload
    m.def(&quot;add&quot;, py::overload_cast&lt;int, int, int&gt;(&amp;add));

    // bind with default arguments
    m.def(&quot;sub&quot;, [](int a, int b) { 
        return a - b; 
    }, py::arg(&quot;a&quot;) = 1, py::arg(&quot;b&quot;) = 2);

    // bind *args
    m.def(&quot;add&quot;, [](py::args args) {
        int sum = 0;
        for (auto&amp; arg : args) {
            sum += arg.cast&lt;int&gt;();
        }
        return sum;
    });

    // bind **kwargs
    m.def(&quot;add&quot;, [](py::kwargs kwargs) {
        int sum = 0;
        for (auto item : kwargs) {
            sum += item.second.cast&lt;int&gt;();
        }
        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&amp; p) : x(p.x), y(p.y) {}

    std::string stringfy() const { 
        return &quot;(&quot; + std::to_string(x) + &quot;, &quot; + std::to_string(y) + &quot;)&quot;; 
    }
};

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-&gt;z = z; }
};

void bind_class(py::module_&amp; m)
{
    py::class_&lt;Point&gt;(m, &quot;Point&quot;)
        .def(py::init&lt;&gt;())
        .def(py::init&lt;int, int&gt;())
        .def(py::init&lt;const Point&amp;&gt;())
        .def_readonly(&quot;x&quot;, &amp;Point::x)
        .def_readwrite(&quot;y&quot;, &amp;Point::y)
        .def(&quot;__str__&quot;, &amp;Point::stringfy);

    // only support single inheritance
    py::class_&lt;Point3D, Point&gt;(m, &quot;Point3D&quot;, py::dynamic_attr())
        .def(py::init&lt;int, int, int&gt;())
        .def_property(&quot;z&quot;, &amp;Point3D::get_z, &amp;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 &lt;pybind11/operators.h&gt;
namespace py = pybind11;

struct Int {
    int value;

    Int(int value) : value(value) {}

    Int operator+(const Int&amp; other) const {
        return Int(value + other.value);
    }

    Int operator-(const Int&amp; other) const {
        return Int(value - other.value);
    }

    bool operator==(const Int&amp; other) const {
        return value == other.value;
    }

    bool operator!=(const Int&amp; other) const {
        return value != other.value;
    }
};

void bind_operators(py::module_&amp; m)
{
    py::class_&lt;Int&gt;(m, &quot;Int&quot;)
        .def(py::init&lt;int&gt;())
        .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(&quot;x&quot;); // 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&lt;T&gt;; // cast to C++ type

py::type::of(obj); // get type of obj
py::type::of&lt;T&gt;(); // 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 = {&quot;hello&quot;};
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() &gt;&gt; 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, hasMermaid: false, hasMath: false, tocDepth: 23 }</script>
</body>
</html>