microPython的源码解析之 objfun.c

MicroPython 是一种适用于微控制器和其他受限环境的 Python 编程语言的实现。它旨在提供与 Python 3 语言的紧密兼容，同时考虑到内存和计算资源的限制。MicroPython 库是这门语言的核心组成部分，提供了一系列的模块和函数，使得开发者能够在硬件上执行各种任务。
下面将通过系列文章,逐一解读microPython,以便让读者了解掌握microPython的整个核心逻辑.,以便读者可以透过这个Python的最小内核,掌握Python解析器的核心实现逻辑,学习世界上最优秀的源码设计之一.

microPython Python最小内核源码解析

#include <string.h>
#include <assert.h>

// 引入MicroPython对象类型定义和运行时环境的头文件
#include "py/objtuple.h"
#include "py/objfun.h"
#include "py/runtime.h"
#include "py/bc.h"
#include "py/stackctrl.h"

// 根据编译时是否开启MICROPY_DEBUG_VERBOSE宏定义，决定是否打印调试信息
#if MICROPY_DEBUG_VERBOSE // 打印调试信息
#define DEBUG_PRINT (1)
#else // 不打印调试信息
#define DEBUG_PRINT (0)
#define DEBUG_printf(...) (void)0
#endif

// 定义内置函数的声明和实现

// 定义一个接受0个参数的内置函数的调用实现
static mp_obj_t fun_builtin_0_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    (void)args; // 未使用的参数，避免编译器警告
    assert(mp_obj_is_type(self_in, &mp_type_fun_builtin_0)); // 断言self_in是mp_type_fun_builtin_0类型
    mp_obj_fun_builtin_fixed_t *self = MP_OBJ_TO_PTR(self_in); // 将对象指针转换为函数指针
    mp_arg_check_num(n_args, n_kw, 0, 0, false); // 检查传入的参数数量是否符合预期
    return self->fun._0(); // 调用函数
}

// 定义一个接受1个参数的内置函数的调用实现
static mp_obj_t fun_builtin_1_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    assert(mp_obj_is_type(self_in, &mp_type_fun_builtin_1)); // 同上
    mp_obj_fun_builtin_fixed_t *self = MP_OBJ_TO_PTR(self_in); // 同上
    mp_arg_check_num(n_args, n_kw, 1, 1, false); // 检查传入的参数数量是否符合预期
    return self->fun._1(args[0]); // 调用函数
}

// 定义一个接受2个参数的内置函数的调用实现
static mp_obj_t fun_builtin_2_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    assert(mp_obj_is_type(self_in, &mp_type_fun_builtin_2)); // 同上
    mp_obj_fun_builtin_fixed_t *self = MP_OBJ_TO_PTR(self_in); // 同上
    mp_arg_check_num(n_args, n_kw, 2, 2, false); // 检查传入的参数数量是否符合预期
    return self->fun._2(args[0], args[1]); // 调用函数
}

// 定义一个接受3个参数的内置函数的调用实现
static mp_obj_t fun_builtin_3_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    assert(mp_obj_is_type(self_in, &mp_type_fun_builtin_3)); // 同上
    mp_obj_fun_builtin_fixed_t *self = MP_OBJ_TO_PTR(self_in); // 同上
    mp_arg_check_num(n_args, n_kw, 3, 3, false); // 检查传入的参数数量是否符合预期
    return self->fun._3(args[0], args[1], args[2]); // 调用函数
}

// 定义一个接受可变参数数量的内置函数的调用实现
static mp_obj_t fun_builtin_var_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    assert(mp_obj_is_type(self_in, &mp_type_fun_builtin_var)); // 同上
    mp_obj_fun_builtin_var_t *self = MP_OBJ_TO_PTR(self_in); // 将对象指针转换为函数指针

    // 检查传入的参数数量是否符合预期
    mp_arg_check_num_sig(n_args, n_kw, self->sig);

    if (self->sig & 1) {
   
        // 函数允许关键字参数

        // 我们直接从给定的参数数组创建一个映射
        mp_map_t kw_args;
        mp_map_init_fixed_table(&kw_args, n_kw, args + n_args);

        return self->fun.kw(n_args, args, &kw_args); // 调用支持关键字的函数

    } else {
   
        // 函数接受可变数量的参数，但不接受关键字参数

        return self->fun.var(n_args, args); // 调用函数
    }
}

// 定义字节码函数的实现

// 获取函数对象的名称
qstr mp_obj_fun_get_name(mp_const_obj_t fun_in) {
   
    const mp_obj_fun_bc_t *fun = MP_OBJ_TO_PTR(fun_in); // 将对象指针转换为函数指针
    const byte *bc = fun->bytecode; // 获取函数的字节码

    #if MICROPY_EMIT_NATIVE
    // 如果函数是本地函数或者包装了本地生成的函数，则获取其前缀
    if (fun->base.type == &mp_type_fun_native || fun->base.type == &mp_type_native_gen_wrap) {
   
        bc = mp_obj_fun_native_get_prelude_ptr(fun);
    }
    #endif

    // 解码函数的前缀信息，包括签名和大小
    MP_BC_PRELUDE_SIG_DECODE(bc);
    MP_BC_PRELUDE_SIZE_DECODE(bc);

    mp_uint_t name = mp_decode_uint_value(bc); // 解码函数名称的索引
    #if MICROPY_EMIT_BYTECODE_USES_QSTR_TABLE
    // 根据索引获取实际的函数名称
    name = fun->context->constants.qstr_table[name];
    #endif

    return name; // 返回函数名称
}

#if MICROPY_CPYTHON_COMPAT
// 为了与CPython兼容，重写函数对象的打印方法
static void fun_bc_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
   
    (void)kind; // 未使用的参数
    mp_obj_fun_bc_t *o = MP_OBJ_TO_PTR(o_in); // 将对象指针转换为函数指针
    mp_printf(print, "<function %q at 0x%p>", mp_obj_fun_get_name(o_in), o); // 打印函数名称和地址
}
#endif

#if DEBUG_PRINT
// 调试时打印参数的辅助函数
static void dump_args(const mp_obj_t *a, size_t sz) {
   
    DEBUG_printf("%p: ", a);
    for (size_t i = 0; i < sz; i++) {
   
        DEBUG_printf("%p ", a[i]);
    }
    DEBUG_printf("\n");
}