microPython的源码解析之 objmap.c

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

---

microPython Python最小内核源码解析
NI-motion运动控制c语言示例代码解析
python编程示例系列 python编程示例系列二
python的Web神器Streamlit

---

代码是一个用C语言编写的MicroPython对象类型实现，具体来说，它定义了一个map对象，该对象可以将一个函数应用于多个迭代器产生的元素序列。

• map_make_new函数是map对象的构造函数，它接收一个函数对象和一系列迭代器作为参数，创建一个新的map对象。
• map_iternext函数是map对象的迭代器下一个元素的获取函数，它遍历map对象中存储的所有迭代器，获取每个迭代器的下一个元素，并将这些元素作为参数传给map对象中存储的函数，然后返回函数的调用结果。
• 最后，MP_DEFINE_CONST_OBJ_TYPE宏用于定义map对象的类型，设置了对象的构造函数和迭代器的next方法。

这段代码是MicroPython运行时系统的一部分，用于支持类似于Python中map函数的功能。

#include <stdlib.h>  // 引入标准库，提供内存分配等函数
#include <assert.h> // 引入断言库，用于程序调试

// 引入MicroPython运行时环境的头文件
#include "py/runtime.h"

// 定义一个名为mp_obj_map_t的结构体，用于表示map对象
typedef struct _mp_obj_map_t {
   
    mp_obj_base_t base; // 继承自基础对象
    size_t n_iters;    // 迭代器的数量
    mp_obj_t fun;      // 存储要应用的函数对象
    mp_obj_t iters[];   // 存储迭代器的数组
} mp_obj_map_t;

// 定义map对象的构造函数
static mp_obj_t map_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    // 检查传入的参数数量和关键字参数数量是否符合要求
    mp_arg_check_num(n_args, n_kw, 2, MP_OBJ_FUN_ARGS_MAX, false);
    // 根据参数数量动态分配内存，并创建map对象
    mp_obj_map_t *o = mp_obj_malloc_var(mp_obj_map_t, iters, mp_obj_t, n_args - 1, type);
    o->n_iters = n_args - 1; // 设置迭代器数量
    o->fun = args[0];       // 设置要应用的函数对象
    // 遍历参数，获取每个参数的迭代器，并存储到迭代器数组中
    for (size_t i = 0; i < n_args - 1; i++) {
   
        o->iters[i] = mp_getiter(args[i + 1], NULL);
    }
    // 返回创建好的map对象
    return MP_OBJ_FROM_PTR(o);
}

// 定义map对象的迭代器下一个元素的获取函数
static mp_obj_t map_iternext(mp_obj_t self_in) {
   
    // 检查self_in是否为map类型的对象
    mp_check_self(mp_obj_is_type(self_in, &mp_type_map));
    // 将传入的对象转换为mp_obj_map_t类型的指针
    mp_obj_map_t *self = MP_OBJ_TO_PTR(self_in);
    // 创建一个数组，用于存储每个迭代器的下一个元素
    mp_obj_t *nextses = m_new(mp_obj_t, next, self->n_iters);

    // 遍历每个迭代器，获取其下一个元素
    for (size_t i = 0; i < self->n_iters; i++) {
   
        mp_obj_t next = mp_iternext(self->iters[i]);
        // 如果某个迭代器已经没有更多元素，则清理已分配的数组并返回停止迭代的标志
        if (next == MP_OBJ_STOP_ITERATION) {
   
            m_del(mp_obj_t, nextses, self->n_iters);
            return MP_OBJ_STOP_ITERATION;
        }
        // 存储获取到的元素
        nextses[i] = next;
    }
    // 调用存储的函数对象，并传入获取到的元素数组作为参数
    return mp_call_function_n_kw(self->fun, self->n_iters, 0, nextses);
}

// 定义map对象的类型，并设置其构造函数和迭代器函数
MP_DEFINE_CONST_OBJ_TYPE(
    mp_type_map,             // 定义的类型名称
    MP_QSTR_map,             // 类型的名称字符串
    MP_TYPE_FLAG_ITER_IS_ITERNEXT, // 迭代器使用iternext方法
    make_new, map_make_new, // 对象创建函数
    iter, map_iternext       // 迭代器next方法
);

代码中定义了两个主要的函数和一个宏，下面是它们的功能及执行逻辑的解读：

1. map_make_new - 这是map对象的构造函数，用于创建一个新的map对象。

   • 功能：接收一个函数对象和一系列迭代器作为参数，创建一个新的map对象，并初始化其内部状态。
   • 执行逻辑：
     • 首先，检查传入的参数数量是否符合预期（至少2个参数，其中第一个参数是函数对象，其余是迭代器）。
     • 动态分配内存以创建map对象，内存大小取决于迭代器的数量。
     • 将传入的函数对象存储在map对象的fun成员中。
     • 遍历剩余的参数（迭代器），获取每个迭代器的下一个元素，并存储在map对象的iters数组中。
     • 返回创建好的map对象的指针。

2. map_iternext - 这是map对象的迭代器下一个元素的获取函数，用于获取迭代器序列中的下一个元素。

   • 功能：遍历map对象中存储的所有迭代器，获取每个迭代器的下一个元素，并调用存储的函数对象。
   • 执行逻辑：
     • 首先，验证传入的对象是否为map类型的对象。
     • 创建一个数组，用于存储每个迭代