mirror of
https://github.com/pocketpy/pocketpy
synced 2025-10-20 03:20:18 +00:00
72 lines
1.6 KiB
Markdown
72 lines
1.6 KiB
Markdown
---
|
|
icon: dot
|
|
label: 'Call Python Function'
|
|
order: 70
|
|
---
|
|
|
|
pkpy uses a variant of the [Vectorcall](https://peps.python.org/pep-0590/) protocol (PEP 590).
|
|
|
|
You can use `call` to invoke any python callable object,
|
|
including functions, methods, classes, etc.
|
|
For methods, `call_method` can be used.
|
|
|
|
+ `PyVar call(PyVar obj, ...)`
|
|
+ `PyVar call_method(PyVar obj, StrName name, ...)`
|
|
|
|
### Example
|
|
|
|
Let's create a `dict` object and set a key-value pair,
|
|
which equals to the following python snippet.
|
|
|
|
```python
|
|
obj = {} # declare a `dict`
|
|
obj["a"] = 5 # set a key-value pair
|
|
print(obj["a"]) # print the value
|
|
```
|
|
|
|
First, create an empty dict object,
|
|
|
|
```cpp
|
|
PyVar tp = vm->builtins->attr("dict");
|
|
PyVar obj = vm->call(tp); // this is a `dict`
|
|
```
|
|
|
|
And set a key-value pair,
|
|
|
|
```cpp
|
|
PyVar _0 = py_var(vm, "a");
|
|
PyVar _1 = py_var(vm, 5);
|
|
vm->call_method(obj, "__setitem__", _0, _1);
|
|
```
|
|
|
|
And get the value,
|
|
|
|
```cpp
|
|
PyVar ret = vm->call_method(obj, "__getitem__", _0);
|
|
std::cout << py_cast<int>(vm, i64);
|
|
```
|
|
|
|
If you want to call with dynamic number of arguments,
|
|
you should use `vm->vectorcall`. This is a low-level, stack-based API.
|
|
|
|
1. First push the callable object to the stack.
|
|
2. Push the `self` object to the stack. If there is no `self`, push `PY_NULL`.
|
|
3. Push the arguments to the stack.
|
|
4. Call `vm->vectorcall` with the number of arguments.
|
|
|
|
```cpp
|
|
PyVar f_sum = vm->builtins->attr("sum");
|
|
|
|
List args(N); // a list of N arguments
|
|
|
|
vm->s_data.push_back(f_sum);
|
|
vm->s_data.push_back(PY_NULL); // self
|
|
|
|
for(PyVar arg : args) {
|
|
vm->s_data.push_back(arg);
|
|
}
|
|
|
|
PyVar ret = vm->vectorcall(args.size());
|
|
```
|
|
|