microPython的源码解析之 objnamedtuple.c

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

---

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

---

这段代码是MicroPython中实现namedtuple类型的源代码。它提供了创建、打印、属性访问等功能。通过定义新的类型和方法，这段代码扩展了MicroPython的面向对象编程能力，使得用户可以定义具有固定字段的自定义数据类型，类似于Python中的namedtuple。

#include <string.h>

// 引入Python对象类型和运行时环境的头文件
#include "py/objtuple.h"
#include "py/runtime.h"
#include "py/objstr.h"
#include "py/objnamedtuple.h"

// 条件编译，只有在MICROPY_PY_COLLECTIONS被定义时才编译以下代码
#if MICROPY_PY_COLLECTIONS

// 根据namedtuple类型和字段名查找字段的索引，如果找不到返回-1
size_t mp_obj_namedtuple_find_field(const mp_obj_namedtuple_type_t *type, qstr name) {
   
    for (size_t i = 0; i < type->n_fields; i++) {
   
        if (type->fields[i] == name) {
   
            return i;
        }
    }
    return (size_t)-1;
}

// 如果MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT被定义，则提供将namedtuple转换为有序字典的功能
#if MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
// 实现namedtuple的asdict方法，将namedtuple转换为一个有序字典
static mp_obj_t namedtuple_asdict(mp_obj_t self_in) {
   
    mp_obj_namedtuple_t *self = MP_OBJ_TO_PTR(self_in); // 将输入的对象转换为namedtuple对象指针
    const qstr *fields = ((mp_obj_namedtuple_type_t *)self->tuple.base.type)->fields; // 获取字段名数组
    mp_obj_t dict = mp_obj_new_dict(self->tuple.len); // 创建一个新的字典对象
    mp_obj_dict_t *dictObj = MP_OBJ_TO_PTR(dict); // 获取字典对象的指针
    dictObj->base.type = &mp_type_ordereddict; // 设置字典类型为有序字典
    dictObj->map.is_ordered = 1; // 标记字典为有序
    for (size_t i = 0; i < self->tuple.len; ++i) {
   
        mp_obj_dict_store(dict, MP_OBJ_NEW_QSTR(fields[i]), self->tuple.items[i]); // 将字段名和对应的值存储到字典中
    }
    return dict;
}
MP_DEFINE_CONST_FUN_OBJ_1(namedtuple_asdict_obj, namedtuple_asdict); // 定义常量函数对象
#endif

// 实现namedtuple的打印功能
static void namedtuple_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
   
    (void)kind; // 忽略打印类型，因为我们只关心对象
    mp_obj_namedtuple_t *o = MP_OBJ_TO_PTR(o_in); // 将输入的对象转换为namedtuple对象指针
    mp_printf(print, "%q", o->tuple.base.type->name); // 打印namedtuple的类型名
    const qstr *fields = ((mp_obj_namedtuple_type_t *)o->tuple.base.type)->fields; // 获取字段名数组
    mp_obj_attrtuple_print_helper(print, fields, &o->tuple); // 调用辅助函数打印字段名和值
}

// 实现namedtuple的属性访问功能
static void namedtuple_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
   
    if (dest[0] == MP_OBJ_NULL) {
   
        // 属性加载
        mp_obj_namedtuple_t *self = MP_OBJ_TO_PTR(self_in); // 将输入的对象转换为namedtuple对象指针
        #if MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
        if (attr == MP_QSTR__asdict) {
   
            dest[0] = MP_OBJ_FROM_PTR(&namedtuple_asdict_obj); // 将asdict方法的函数对象赋值给属性
            dest[1] = self_in; // 将self对象赋值给属性
            return;
        }
        #endif
        size_t id = mp_obj_namedtuple_find_field((mp_obj_namedtuple_type_t *)self->tuple.base.type, attr); // 查找字段索引
        if (id == (size_t)-1) {
   
            return; // 如果字段不存在，则不执行任何操作
        }
        dest[0] = self->tuple.items[id]; // 将找到的字段值赋值给属性
    } else {
   
        // 属性删除/赋值
        // 提供比直接返回更详细的错误信息
        mp_raise_msg(&mp_type_AttributeError, MP_ERROR_TEXT("can't set attribute")); // 抛出属性设置错误
    }
}

// 实现namedtuple的构造函数
static mp_obj_t namedtuple_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    const mp_obj_namedtuple_type_t *type = (const mp_obj_namedtuple_type_t *)type_in; // 将输入的类型指针转换为namedtuple类型指针
    size_t num_fields = type->n_fields; // 获取字段数量
    if (n_args + n_kw != num_fields) {
   
        // 参数数量检查，如果提供的参数数量与字段数量不匹配，则抛出错误
        #if MICROPY_ERROR_REPORTING <= MICROPY_ERROR_REPORTING_TERSE
        mp_arg_error_terse_mismatch(); // 抛出简洁的错误信息
        #elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_NORMAL
        mp_raise_msg_varg(&mp_type_TypeError,
            MP_ERROR_TEXT("function takes %d positional arguments but %d were given"),
            num_fields, n_args + n_kw); // 抛出详细的错误信息
        #elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
        mp_raise_msg_varg(&mp_type_TypeError,
            MP_ERROR_TEXT("%q() takes %d positional arguments but %d were given"),
            ((mp_obj_type_t *)&type->base)->name, num_fields, n_args + n_kw); // 抛出包含类型的详细错误信息
        #endif
    }

    // 创建一个新的namedtuple对象，使用显式malloc
    mp_obj_tuple_t *tuple = mp_obj_malloc_var(mp_obj_tuple_t, items, mp_obj_t, num_fields, type_in);
    tuple->len = num_fields; // 设置元组长度为字段数量

    // 将位置参数复制到namedtuple的前num_fields个槽位
    memcpy(&tuple->items[0], args, sizeof(mp_obj_t) * n_args);

    // 用关键字参数填充剩余的槽位
    memset(&tuple->items[n_args], 0, sizeof(mp_obj_t) * n_kw);
    for (size_t i = n_args; i < n_args + 2 * n_kw; i += 2) {
   
        qstr kw = mp_obj_str_get_qstr(args[i]); // 获取关键字参数的字段名
        size_t id = mp_obj_namedtuple_find_field(type, kw); // 查找字段索引
        if (id == (size_t)-1) {
   
            // 如果字段不存在，则抛出错误
            #if MICROPY_ERROR_REPORTING <= MICROPY_ERROR_REPORTING_TERSE
            mp_arg_error_terse_mismatch(); // 抛出简洁的错误信息
            #else
            mp_raise_msg_varg(&mp_type_TypeError, MP_ERROR_TEXT("unexpected keyword argument '%q'"),