Zxc200611/pocketpy
1
0
Fork 0
mirror of https://github.com/pocketpy/pocketpy synced 2025-10-21 20:10:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

...

Browse Source
This commit is contained in:
blueloveTH 2023-05-21 16:03:28 +08:00
parent f6865aa595
commit e72d6d0d4d
2 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/quick-start/exec.md
View File

@ -4,14 +4,16 @@ label: 'Execute Python code'
order: 93
---
### Simple execution
Once you have a `VM` instance, you can execute python code by calling `exec` method.
### `PyObject* exec(Str source, Str filename, CompileMode mode, PyObject* _module=nullptr)`
#### `PyObject* exec(Str source, Str filename, CompileMode mode, PyObject* _module=nullptr)`
+ `source`, the python source code to be executed
+ `filename`, the filename of the source code. This is used for error reporting
+ `mode`, the compile mode. See below for details
+ `module`, the module to be executed. If `nullptr`, the code will be executed in the `__main__` module
+ `module`, the module where the code will be executed. If `nullptr`, the code will be executed in the `__main__` module
`exec` handles possible exceptions and returns a `PyObject*`.
If the execution is not successful, e.g. a syntax error or a runtime exception,
@ -22,8 +24,8 @@ the return value will be `nullptr`.
The `mode` parameter controls how the source code is compiled. There are 4 possible values:
+ `EXEC_MODE`, this is the default mode. Just do normal execution.
+ `EVAL_MODE`, this mode is used for evaluating a single expression. The `source` should be a single expression. It cannot contain any statements.
+ `REPL_MODE`, this mode is used for REPL. It is similar to `EXEC_MODE`, but generates `PRINT_EXPR` bytecode for global expressions.
+ `JSON_MODE`, this mode is used for JSON parsing. It is similar to `EVAL_MODE`, but uses a lexing rule designed for JSON. For example, `true` will be parsed as `True`.
+ `REPL_MODE`, this mode is used for REPL. It is similar to `EXEC_MODE`, but generates `PRINT_EXPR` opcode when necessary.
+ `JSON_MODE`, this mode is used for JSON parsing. It is similar to `EVAL_MODE`, but uses a lexing rule designed for JSON.
### Fine-grained execution
@ -35,5 +37,6 @@ These two methods are provided for this purpose:
+ `PyObject* _exec(CodeObject_ co, PyObject* _module)`
`compile` compiles the source code into a `CodeObject_` instance.
`_exec` executes the `CodeObject_` instance.
It does not handle exceptions, so you may need to use `try..catch` manually.
`_exec` executes the `CodeObject_` instance. Leave `unknown_global_scope` to `false` if you are not sure.
It does not handle exceptions, you need to use `try..catch` manually.

13
docs/quick-start/installation.md
View File

@ -15,10 +15,6 @@ To compile it with your project, these flags must be set:
+ Exception must be enabled
+ RTTI is not required
!!!
For maximum performance, we recommend to use `clang++` with `-O2` flag.
!!!
### Example
```cpp
@ -48,9 +44,12 @@ int main(){
pkpy's C++ interfaces are organized in an object-oriented way.
All classes are located in `pkpy` namespace.
The most important class is the `VM` class. A `VM` instance is a python virtual machine which holds all necessary runtime states, including callstacks, modules, variables, etc.
The most important class is the `VM` class. A `VM` instance is a python virtual machine which holds all necessary runtime states, including callstack, modules, variables, etc.
A process can have multiple `VM` instances. Each `VM` instance is independent from each other.
You need to use the C++ `new` operator to create a `VM` instance.
Do not declare it on the stack.
```cpp
VM* vm = new VM();
@ -60,9 +59,9 @@ The constructor can take 1 extra parameters.
#### `VM(bool enable_os=true)`
+ `enable_os`, whether to enable OS-related features or not. This setting controls the availability of some priviledged modules such os `io` and `os` as well as builtin function `open`.
+ `enable_os`, whether to enable OS-related features or not. This setting controls the availability of priviledged modules such os `io` and `os` as well as builtin function `open`.
When you are done with the `VM` instance, you need to use the C++ `delete` operator to free the memory.
When you are done with the `VM` instance, use `delete` operator to dispose it.
```cpp
delete vm;