Nav apraksta

blueloveTH 0caa14172d fix `++` for `global` names		2 gadi atpakaļ
.github	85eefaab5d Do not compile on docs change	2 gadi atpakaļ
3rd	cf7dc098a3 remove `windows.h`	2 gadi atpakaļ
benchmarks	51cf6d42e8 ...	2 gadi atpakaļ
c_bindings	a810973f65 fix c binding test	2 gadi atpakaļ
docs	e26ea4a95c ...	2 gadi atpakaļ
dylib	4c63694485 ...	2 gadi atpakaļ
include	e26f389182 fix `assert` message won't be evaluated on true cond	2 gadi atpakaļ
plugins	f0a2ea215e remove `-fno-rtti`	2 gadi atpakaļ
python	098b85f89b ...	2 gadi atpakaļ
scripts	12e955624e ...	2 gadi atpakaļ
src	0caa14172d fix `++` for `global` names	2 gadi atpakaļ
src2	cf7dc098a3 remove `windows.h`	2 gadi atpakaļ
tests	0caa14172d fix `++` for `global` names	2 gadi atpakaļ
web	db2492829b ...	2 gadi atpakaļ
.gitattributes	0891000a46 init	3 gadi atpakaļ
.gitignore	e9b4734004 ...	2 gadi atpakaļ
CMakeLists.txt	59b1c13f35 Update CMakeLists.txt	2 gadi atpakaļ
LICENSE	271718332a ...	2 gadi atpakaļ
README.md	3478ddeeb0 change `clang++` into `clang`	2 gadi atpakaļ
README_zh.md	2b72428931 Use emojis in feature list (zh)	2 gadi atpakaļ
__hidden_xmake.lua	4c63694485 ...	2 gadi atpakaļ
amalgamate.py	e6b89a1206 fix box2d	2 gadi atpakaļ
build.ps1	c18821fc42 Powershell-ify build.ps1	2 gadi atpakaļ
build.sh	3478ddeeb0 change `clang++` into `clang`	2 gadi atpakaļ
build_web.sh	f0a2ea215e remove `-fno-rtti`	2 gadi atpakaļ
compile_flags.txt	7e1a5e9a6b add `box2d` as builtin modules (WIP)	2 gadi atpakaļ
prebuild.py	656d1d7291 ...	2 gadi atpakaļ
run_c_binding_test.sh	16d710640a ...	2 gadi atpakaļ
run_profile.sh	f0a2ea215e remove `-fno-rtti`	2 gadi atpakaļ
run_tests.sh	162c597093 Revert "test benchmarks"	2 gadi atpakaļ

pocketpy: python interpreter in 1 file

English | 简体中文

pkpy is a lightweight(~14K LOC) Python interpreter for game scripting, built on C++17 with STL.

It aims to be an alternative to lua for game scripting, with elegant syntax, powerful features and competitive performance. pkpy is extremely easy to embed via a single header file pocketpy.h, without external dependencies.

Please see https://pocketpy.dev for details or try Live Demo.

Supported Platforms

pkpy should work on any platform with a C++17 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

Quick Start

Download the pocketpy.h on our GitHub Release page. And #include it in your project.

You can also use cmake to build it from source. See CMakeLists.txt for details. These variables can be set to control the build process:

PK_BUILD_STATIC_LIB - Build the static library
PK_BUILD_SHARED_LIB - Build the shared library

Compile Flags

To compile it with your project, these flags must be set:

--std=c++17 flag must be set
Exception must be enabled
For MSVC, /utf-8 flag must be set

For development build on Linux, use this snippet.

# prerequisites
sudo apt-get install libc++-dev libc++abi-dev clang
# build the repo
bash build.sh
# unittest
python scripts/run_tests.py

Example

#include "pocketpy.h"

using namespace pkpy;

int main(){
    // Create a virtual machine
    VM* vm = new VM();

    // Hello world!
    vm->exec("print('Hello world!')");

    // Create a list
    vm->exec("a = [1, 2, 3]");

    // Eval the sum of the list
    PyObject* result = vm->eval("sum(a)");
    std::cout << py_cast<int>(vm, result);   // 6

    // Bindings
    vm->bind(vm->_main, "add(a: int, b: int)",
      [](VM* vm, ArgsView args){
        int a = py_cast<int>(vm, args[0]);
        int b = py_cast<int>(vm, args[1]);
        return py_var(vm, a + b);
      });

    // Call the function
    PyObject* f_add = vm->_main->attr("add");
    result = vm->call(f_add, py_var(vm, 3), py_var(vm, 7));
    std::cout << py_cast<int>(vm, result);   // 10

    // Dispose the virtual machine
    delete vm;
    return 0;
}

Features

Check this Cheatsheet for a quick overview of the supported features.

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..catch`	✅
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`	✅