index.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. <!DOCTYPE html>
  2. <html lang="en" class="h-full">
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="color-scheme" content="light dark">
  7. <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="4.3.0.827133044009">
  8. <!-- See retype.com -->
  9. <meta name="generator" content="Retype 4.3.0">
  10. <!-- Primary Meta Tags -->
  11. <title>Debugging | Portable Python 3.x Interpreter in Modern C</title>
  12. <meta name="title" content="Debugging | Portable Python 3.x Interpreter in Modern C">
  13. <meta name="description" content="To debug a pocketpy program, you need to install our VSCode extension first:">
  14. <!-- Canonical -->
  15. <link rel="canonical" href="https://pocketpy.dev/features/debugging/">
  16. <!-- Open Graph -->
  17. <meta property="og:type" content="website">
  18. <meta property="og:url" content="https://pocketpy.dev/features/debugging/">
  19. <meta property="og:title" content="Debugging | Portable Python 3.x Interpreter in Modern C">
  20. <meta property="og:description" content="To debug a pocketpy program, you need to install our VSCode extension first:">
  21. <meta property="og:image" content="https://pocketpy.dev/static/debugger/launch_json.png">
  22. <meta property="og:image:width" content="1200">
  23. <meta property="og:image:height" content="630">
  24. <meta property="og:image:alt" content="Debugging | Portable Python 3.x Interpreter in Modern C">
  25. <meta property="og:site_name" content="pocketpy">
  26. <meta property="og:locale" content="en_US">
  27. <!-- Twitter -->
  28. <meta name="twitter:card" content="summary_large_image">
  29. <meta name="twitter:url" content="https://pocketpy.dev/features/debugging/">
  30. <meta name="twitter:title" content="Debugging | Portable Python 3.x Interpreter in Modern C">
  31. <meta name="twitter:description" content="To debug a pocketpy program, you need to install our VSCode extension first:">
  32. <meta name="twitter:image" content="https://pocketpy.dev/static/debugger/launch_json.png">
  33. <meta name="twitter:image:alt" content="Debugging | Portable Python 3.x Interpreter in Modern C">
  34. <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>
  35. <link id="retype-favicon" rel="icon" href="../../static/logo.png" />
  36. <link href="../../resources/css/retype.css?v=4.3.0.827133044009" rel="stylesheet">
  37. <script data-cfasync="false" src="../../resources/js/config.js?v=4.3.0.827133044009" data-turbo-eval="false" defer></script>
  38. <script data-cfasync="false" src="../../resources/js/retype.js?v=4.3.0" data-turbo-eval="false" defer></script>
  39. <script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=4.3.0.827133044009" data-turbo-eval="false" defer></script>
  40. <script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=4.3.0.827133044009" defer></script>
  41. </head>
  42. <body>
  43. <div id="retype-app" class="relative text-base antialiased text-base-text bg-base-bg font-body">
  44. <div class="absolute bottom-0 left-0" style="top: 5rem; right: 50%"></div>
  45. <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">
  46. <div class="container relative flex items-center justify-between pr-6 grow md:justify-start">
  47. <!-- Mobile menu button skeleton -->
  48. <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>
  49. <div v-cloak id="retype-sidebar-left-toggle-button"></div>
  50. <!-- Logo -->
  51. <div class="flex items-center justify-between h-full py-2 md:w-75">
  52. <div class="flex items-center px-2 md:px-6">
  53. <a id="retype-branding-logo" href="https://pocketpy.dev/" class="flex items-center leading-snug text-2xl">
  54. <span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
  55. <img class="max-h-10 dark:hidden md:inline-block" src="../../static/logo.png" alt="" width="512" height="512">
  56. <img class="max-h-10 hidden dark:inline-block" src="../../static/logo.png" alt="" width="512" height="512">
  57. </span>
  58. <span class="dark:text-white font-bold line-clamp-1 md:line-clamp-2">pocketpy</span>
  59. </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>
  60. </div>
  61. <span class="hidden h-8 border-r md:inline-block border-base-border"></span>
  62. </div>
  63. <div class="flex justify-between md:grow">
  64. <!-- Top Nav -->
  65. <nav id="retype-header-nav" class="hidden md:flex">
  66. <ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center">
  67. <li class="mr-6">
  68. <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="">
  69. <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">
  70. <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"/>
  71. </svg>
  72. <span>Home</span>
  73. </a>
  74. </li>
  75. <li class="mr-6">
  76. <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">
  77. <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">
  78. <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"/>
  79. </svg>
  80. <span>Live Demo</span>
  81. </a>
  82. </li>
  83. <li class="mr-6">
  84. <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">
  85. <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">
  86. <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"/>
  87. </svg>
  88. <span>Live Examples</span>
  89. </a>
  90. </li>
  91. <li class="mr-6">
  92. <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">
  93. <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">
  94. <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"/>
  95. </svg>
  96. <span>Github</span>
  97. </a>
  98. </li>
  99. <li class="mr-6">
  100. <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">
  101. <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">
  102. <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"/>
  103. </svg>
  104. <span>Discord</span>
  105. </a>
  106. </li>
  107. </ul>
  108. </nav>
  109. <div v-cloak class="flex justify-end grow">
  110. <div id="retype-mobile-search-button"></div>
  111. <doc-search-desktop></doc-search-desktop>
  112. <doc-theme-switch class="lg:ml-2"></doc-theme-switch>
  113. <doc-history></doc-history>
  114. </div>
  115. </div>
  116. </div>
  117. </header>
  118. <div id="retype-container" class="container relative flex bg-white">
  119. <!-- Sidebar Skeleton -->
  120. <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">
  121. <div class="flex items-center h-16 px-6">
  122. <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">
  123. </div>
  124. <div class="pl-6 mt-1 mb-4">
  125. <div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  126. <div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  127. <div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  128. <div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  129. <div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  130. <div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  131. </div>
  132. <div class="shrink-0 mt-auto bg-transparent dark:border-base-border">
  133. <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">
  134. <span class="text-xs whitespace-nowrap">Powered by</span>
  135. <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>
  136. </a>
  137. </div>
  138. </div>
  139. <!-- Sidebar component -->
  140. <doc-sidebar v-cloak>
  141. <template #sidebar-footer>
  142. <div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-base-border">
  143. <div class="py-3 px-6 md:hidden border-b dark:border-base-border">
  144. <nav>
  145. <ul class="flex flex-wrap justify-center items-center">
  146. <li class="mr-6">
  147. <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="">
  148. <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">
  149. <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"/>
  150. </svg>
  151. <span>Home</span>
  152. </a>
  153. </li>
  154. <li class="mr-6">
  155. <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">
  156. <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">
  157. <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"/>
  158. </svg>
  159. <span>Live Demo</span>
  160. </a>
  161. </li>
  162. <li class="mr-6">
  163. <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">
  164. <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">
  165. <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"/>
  166. </svg>
  167. <span>Live Examples</span>
  168. </a>
  169. </li>
  170. <li class="mr-6">
  171. <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">
  172. <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">
  173. <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"/>
  174. </svg>
  175. <span>Github</span>
  176. </a>
  177. </li>
  178. <li class="mr-6">
  179. <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">
  180. <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">
  181. <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"/>
  182. </svg>
  183. <span>Discord</span>
  184. </a>
  185. </li>
  186. </ul>
  187. </nav>
  188. </div>
  189. <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">
  190. <span class="text-xs whitespace-nowrap">Powered by</span>
  191. <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>
  192. </a>
  193. </div>
  194. </template>
  195. </doc-sidebar>
  196. <div class="grow min-w-0 bg-body-bg">
  197. <!-- Render "toolbar" template here on api pages --><!-- Render page content -->
  198. <div class="flex">
  199. <div id="retype-main" class="min-w-0 p-4 grow md:px-16">
  200. <main class="relative pb-12 lg:pt-2">
  201. <div class="retype-markdown" id="retype-content">
  202. <!-- Rendered if sidebar right is enabled -->
  203. <div id="retype-sidebar-right-toggle"></div>
  204. <!-- Page content -->
  205. <h1 id="debugging">Debugging</h1>
  206. <h2 id="install-vscode-extension">Install VSCode Extension</h2>
  207. <p>To debug a pocketpy program, you need to install our VSCode extension first:</p>
  208. <p><a href="https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy">https://marketplace.visualstudio.com/items?itemName=pocketpy.pocketpy</a></p>
  209. <div class="flex mb-6">
  210. <div class="shrink-0 w-1.5 rounded-tl-lg rounded-bl-lg bg-callout-primary"></div>
  211. <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">
  212. <div class="flex items-center ml-4 h-7">
  213. <svg xmlns="http://www.w3.org/2000/svg" class="mb-px text-callout-primary" width="22" height="22" viewBox="0 0 24 24" role="presentation">
  214. <g fill="currentColor"><g>
  215. <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>
  216. <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>
  217. <path fill="none" d="M0 0h24v24H0z"></path>
  218. </g></g>
  219. </svg>
  220. </div>
  221. <div class="pr-5 ml-3 w-full">
  222. <p>The VSCode extension requires pocketpy version &gt;= <code translate="no" v-pre>2.1.1</code></p>
  223. </div>
  224. </div>
  225. </div>
  226. <h2 id="create-a-launchjson-file">Create a <code translate="no" v-pre>launch.json</code> file</h2>
  227. <p>Navigate to the Debug view in VSCode, and click on &quot;create a launch.json file&quot; link.
  228. In the dropdown menu, select &quot;pocketpy&quot;.</p>
  229. <p><figure class="content-center">
  230. <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" />
  231. <figcaption class="caption">launch_json</figcaption>
  232. </figure>
  233. </p>
  234. <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
  235. with a sample pocketpy debug configuration.</p>
  236. <h2 id="how-does-it-work">How does it work?</h2>
  237. <p>pocketpy provides a C-API <code translate="no" v-pre>py_debugger_waitforattach</code>,
  238. which starts a debug server and waits for the VSCode extension to attach.
  239. When the debugger is attached, the program will continue to run.</p>
  240. <ul>
  241. <li>If you are using pocketpy&#x27;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(&quot;127.0.0.1&quot;, 6110)</code> before running your program.</li>
  242. <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>
  243. </ul>
  244. <h2 id="configuration">Configuration</h2>
  245. <ul>
  246. <li><code translate="no" v-pre>type</code>: must be <code translate="no" v-pre>pocketpy</code></li>
  247. <li><code translate="no" v-pre>request</code>: can be <code translate="no" v-pre>attach</code> or <code translate="no" v-pre>launch</code></li>
  248. <li><code translate="no" v-pre>name</code>: the name of this configuration</li>
  249. <li><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></li>
  250. <li><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></li>
  251. <li><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,
  252. 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.</li>
  253. <li><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>.</li>
  254. <li><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>.</li>
  255. <li><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>.</li>
  256. </ul>
  257. <h3 id="for-attach-mode">For attach mode</h3>
  258. <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.
  259. After the program starts, you can let VSCode attach to the debug server.</p>
  260. <div id="for-attach-mode-code-1" class="codeblock-wrapper"><doc-codeblock>
  261. <pre translate="no" class="language-json"><code v-pre class="language-json">{
  262. &quot;type&quot;: &quot;pocketpy&quot;,
  263. &quot;request&quot;: &quot;attach&quot;,
  264. &quot;name&quot;: &quot;Attach to pocketpy program&quot;,
  265. &quot;port&quot;: 6110,
  266. &quot;host&quot;: &quot;localhost&quot;,
  267. &quot;sourceFolder&quot;: &quot;${workspaceFolder}&quot;
  268. }</code></pre>
  269. </doc-codeblock></div>
  270. <h3 id="for-launch-mode">For launch mode</h3>
  271. <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>.
  272. After the program starts, VSCode attempts to attach to the debug server automatically.</p>
  273. <div id="for-launch-mode-code-1" class="codeblock-wrapper"><doc-codeblock>
  274. <pre translate="no" class="language-json"><code v-pre class="language-json">{
  275. &quot;type&quot;: &quot;pocketpy&quot;,
  276. &quot;request&quot;: &quot;launch&quot;,
  277. &quot;name&quot;: &quot;Launch pocketpy program&quot;,
  278. &quot;port&quot;: 6110,
  279. &quot;host&quot;: &quot;localhost&quot;,
  280. &quot;sourceFolder&quot;: &quot;${workspaceFolder}&quot;,
  281. &quot;program&quot;: &quot;${workspaceFolder}/pocketpy/main.exe&quot;,
  282. &quot;args&quot;: [
  283. &quot;--debug&quot;
  284. ],
  285. &quot;cwd&quot;: &quot;${workspaceFolder}&quot;
  286. }</code></pre>
  287. </doc-codeblock></div>
  288. <h2 id="showcase">Showcase</h2>
  289. <p><figure class="content-center">
  290. <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" />
  291. <figcaption class="caption">debugger_demo</figcaption>
  292. </figure>
  293. </p>
  294. <!-- Required only on API pages -->
  295. <doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results>
  296. </div>
  297. <footer id="retype-content-footer" class="clear-both">
  298. <nav id="retype-nextprev" class="print:hidden flex mt-14">
  299. <div class="w-1/2">
  300. <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/">
  301. <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>
  302. <span>
  303. <span class="block text-xs font-normal text-base-text-muted">Previous</span>
  304. <span class="block mt-1">Deploy Bytecodes</span>
  305. </span>
  306. </a>
  307. </div>
  308. <div class="w-1/2">
  309. <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/">
  310. <span>
  311. <span class="block text-xs font-normal text-right text-base-text-muted">Next</span>
  312. <span class="block mt-1">Profiling</span>
  313. </span>
  314. <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>
  315. </a>
  316. </div>
  317. </nav>
  318. </footer>
  319. </main>
  320. <div id="retype-page-footer" class="print:border-none border-t border-base-border pt-6 mb-8">
  321. <footer class="flex flex-wrap items-center justify-between print:justify-center">
  322. <div id="retype-footer-links" class="print:hidden">
  323. <ul class="flex flex-wrap items-center text-sm">
  324. </ul>
  325. </div>
  326. <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>
  327. </footer>
  328. </div>
  329. </div>
  330. <!-- Rendered if sidebar right is enabled -->
  331. <!-- Sidebar right skeleton-->
  332. <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">
  333. <div class="pl-5">
  334. <div class="w-32 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  335. <div class="w-48 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  336. <div class="w-40 h-3 mb-4 bg-skeleton-bg rounded-full loading"></div>
  337. </div>
  338. </div>
  339. <!-- User should be able to hide sidebar right -->
  340. <doc-sidebar-right v-cloak></doc-sidebar-right>
  341. </div>
  342. </div>
  343. </div>
  344. <doc-search-mobile></doc-search-mobile>
  345. <doc-back-to-top></doc-back-to-top>
  346. </div>
  347. <div id="retype-overlay-target"></div>
  348. <script data-cfasync="false">window.__DOCS__ = { "title": "Debugging", level: 2, icon: "file", hasPrism: true, hasMermaid: false, hasMath: false, tocDepth: 23 }</script>
  349. </body>
  350. </html>