Açıklama Yok

blueloveTH e097313c8f ... 2 yıl önce
.github d3eb97459f ... 2 yıl önce
3rd d4a90c9788 ... 2 yıl önce
benchmarks 51cf6d42e8 ... 2 yıl önce
c_bindings 874c009072 ... 2 yıl önce
docs 2c68dd63a5 ... 2 yıl önce
dylib 4c63694485 ... 2 yıl önce
include dd6e8fab9b reimpl `goto` 2 yıl önce
plugins f0a2ea215e remove `-fno-rtti` 2 yıl önce
python 2c68dd63a5 ... 2 yıl önce
scripts 12e955624e ... 2 yıl önce
src e097313c8f ... 2 yıl önce
src2 2a7f503890 ... 2 yıl önce
tests ffbb9af45e ... 2 yıl önce
web db2492829b ... 2 yıl önce
.gitattributes 0891000a46 init 3 yıl önce
.gitignore e9b4734004 ... 2 yıl önce
CMakeLists.txt 7e1a5e9a6b add `box2d` as builtin modules (WIP) 2 yıl önce
LICENSE 271718332a ... 2 yıl önce
README.md 5e11b9bf53 ... 2 yıl önce
README_zh.md 506e799866 ... 2 yıl önce
__hidden_xmake.lua 4c63694485 ... 2 yıl önce
amalgamate.py 0644c403ee ... 2 yıl önce
build.ps1 bd351b055f fix a bug of reading CRLF file on win32 2 yıl önce
build.sh f0a2ea215e remove `-fno-rtti` 2 yıl önce
build_web.sh f0a2ea215e remove `-fno-rtti` 2 yıl önce
compile_flags.txt 7e1a5e9a6b add `box2d` as builtin modules (WIP) 2 yıl önce
prebuild.py 656d1d7291 ... 2 yıl önce
run_c_binding_test.sh 16d710640a ... 2 yıl önce
run_profile.sh f0a2ea215e remove `-fno-rtti` 2 yıl önce
run_tests.sh 162c597093 Revert "test benchmarks" 2 yıl önce

README.md

pocketpy: python interpreter in 1 file

GitHub GitHub release Website

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

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

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 << CAST(int, result);   // 6

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

    // Call the function
    PyObject* f_add = vm->_main->attr("add");
    result = vm->call(f_add, VAR(3), VAR(7));
    std::cout << CAST(int, 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 YES
Loop for/while/break/continue YES
Function def f(x,*args,y=1): YES
Subclass class A(B): YES
List [1, 2, 'a'] YES
ListComp [i for i in range(5)] YES
Slice a[1:2], a[:2], a[1:] YES
Tuple (1, 2, 'a') YES
Dict {'a': 1, 'b': 2} YES
F-String f'value is {x}' YES
Unpacking a, b = 1, 2 YES
Star Unpacking a, *b = [1, 2, 3] YES
Exception raise/try..catch YES
Dynamic Code eval()/exec() YES
Reflection hasattr()/getattr()/setattr() YES
Import import/from..import YES
Context Block with <expr> as <id>: YES
Type Annotation def f(a:int, b:float=1) YES
Generator yield i YES
Decorator @cache YES

Contribution

All kinds of contributions are welcome.

  • Submit a Pull Request
    • fix a bug
    • add a new feature
  • Open an Issue
    • any suggestions
    • any questions

Check our Coding Style Guide if you want to contribute C++ code.

Reference

The official implementation of Python programming language.

An excellent learning material. It illustrates how Python's virtual machine works.

The world's best 2D physics engine, written by Erin Catto. box2d now becomes a built-in module in pkpy v1.1.3 and later.

Star History

Star History Chart

License

MIT License