microPython的源码解析之 reader.c

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

---

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

---

这段代码是一个用C语言编写的MicroPython读取器的实现，它包括了内存读取器和POSIX文件读取器的创建与使用。代码中包含了详细的注释，解释了每个函数和结构体的用途以及它们的工作方式。这段代码可以用于MicroPython虚拟机中，以便在不同的环境（如内存或文件系统）中读取数据。

#include <stdio.h>
#include <assert.h>

#include "py/runtime.h"
#include "py/mperrno.h"
#include "py/mpthread.h"
#include "py/reader.h"

// 定义一个内存读取器的结构体
typedef struct _mp_reader_mem_t {
   
    size_t free_len; // 如果大于0，那么在关闭时通过m_free(beg, free_len)释放内存
    const byte *beg; // 内存块的开始指针
    const byte *cur; // 当前读取位置的指针
    const byte *end; // 内存块的结束指针
} mp_reader_mem_t;

// 从内存读取器读取一个字节
static mp_uint_t mp_reader_mem_readbyte(void *data) {
   
    mp_reader_mem_t *reader = (mp_reader_mem_t *)data;
    if (reader->cur < reader->end) {
   
        return *reader->cur++; // 如果当前指针小于结束指针，读取当前位置的字节并后移指针
    } else {
   
        return MP_READER_EOF; // 否则返回EOF表示读取结束
    }
}

// 关闭内存读取器并释放内存
static void mp_reader_mem_close(void *data) {
   
    mp_reader_mem_t *reader = (mp_reader_mem_t *)data;
    if (reader->free_len > 0) {
   
        m_del(char, (char *)reader->beg, reader->free_len); // 释放内存
    }
    m_del_obj(mp_reader_mem_t, reader); // 释放读取器对象
}

// 创建一个新的内存读取器
void mp_reader_new_mem(mp_reader_t *reader, const byte *buf, size_t len, size_t free_len) {
   
    mp_reader_mem_t *rm = m_new_obj(mp_reader_mem_t); // 创建内存读取器对象
    rm->free_len = free_len; // 设置释放长度
    rm->beg = buf; // 设置内存块开始指针
    rm->cur = buf; // 初始化当前读取位置指针
    rm->end = buf + len; // 设置内存块结束指针
    reader->data = rm; // 设置读取器的数据指针
    reader->readbyte = mp_reader_mem_readbyte; // 设置读取字节的函数指针
    reader->close = mp_reader_mem_close; // 设置关闭读取器的函数指针
}

#if MICROPY_READER_POSIX

#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>

// 定义一个POSIX系统下的文件读取器的结构体
typedef struct _mp_reader_posix_t {
   
    bool close_fd; // 是否在关闭时关闭文件描述符
    int fd; // 文件描述符
    size_t len; // 文件读取的长度
    size_t pos; // 当前读取的位置
    byte buf[20]; // 读取的缓冲区
} mp_reader_posix_t;

// 从POSIX文件读取器读取一个字节
static mp_uint_t mp_reader_posix_readbyte(void *data) {
   
    mp_reader_posix_t *reader = (mp_reader_posix_t *)data;
    if (reader->pos >= reader->len) {
    // 如果当前位置大于或等于文件长度
        if (reader->len == 0) {
   
            return MP_READER_EOF; // 如果文件长度为0，表示读取结束
        } else {
   
            MP_THREAD_GIL_EXIT(); // 退出全局解释器锁
            int n = read(reader->fd, reader->buf, sizeof(reader->buf)); // 从文件描述符读取数据到缓冲区
            MP_THREAD_GIL_ENTER(); // 进入全局解释器锁
            if (n <= 0) {
   
                reader->len = 0; // 如果读取失败，设置文件长度为0
                return MP_READER_EOF; // 表示读取结束
            }
            reader->len = n; // 更新文件长度
            reader->pos = 0