当前位置:

首页 > 编程开发 > Python虚拟机集合set实现原理是什么

Python虚拟机集合set实现原理是什么

深入理解Python虚拟机:集合(set)的实现原理及源码剖析数据结构介绍typedefstruct{PyObject_HEADPy_ssize_tfill;/*Numberactiveanddummyentries*/Py_ssize_tused;/*Numberactiveentries*//*Thetablecontainsmask+1slots,andthat'sapowerof2.*Westorethemaskinsteadofthesizebecausethemaskismore*fr

本文目录

    深入理解 Python 虚拟机:集合(set)的实现原理及源码剖析

    数据结构介绍

    typedef struct {
        PyObject_HEAD
        Py_ssize_t fill;            /* Number active and dummy entries*/
        Py_ssize_t used;            /* Number active entries */
        /* The table contains mask + 1 slots, and that's a power of 2.
         * We store the mask instead of the size because the mask is more
         * frequently needed.
         */
        Py_ssize_t mask;
        /* The table points to a fixed-size smalltable for small tables
         * or to additional malloc'ed memory for bigger tables.
         * The table pointer is never NULL which saves us from repeated
         * runtime null-tests.
         */
        setentry *table;
        Py_hash_t hash;             /* Only used by frozenset objects */
        Py_ssize_t finger;          /* Search finger for pop() */
        setentry smalltable[PySet_MINSIZE]; // #define PySet_MINSIZE 8
        PyObject *weakreflist;      /* List of weak references */
    } PySetObject;
    typedef struct {
        PyObject *key;
        Py_hash_t hash;             /* Cached hash code of the key */
    } setentry;
    static PyObject _dummy_struct;
    #define dummy (&_dummy_struct)

    上面的数据结果用图示如下图所示:

    Python虚拟机集合set实现原理是什么

    上面各个字段的含义如下所示:

    • dummy entries :如果在哈希表当中的数组原来有一个数据,如果我们删除这个 entry 的时候,对应的位置就会被赋值成 dummy,与 dummy 有关的定义在上面的代码当中已经给出,dummy 对象的哈希值等于 -1。

    • 明白 dummy 的含义之后,fill 和 used 这两个字段的含义就比较容易理解了,used 就是数组当中真实有效的对象的个数,fill 还需要加上 dummy 对象的个数。

    • mask,数组的长度等于 2n2^n2n,mask 的值等于 2n−12^n - 12n−1 。

    • table,实际保存 entry 对象的数组。

    • hash,这个值对 frozenset 有用,保存计算出来的哈希值。如果你的数组很大的话,计算哈希值其实也是一个比较大的开销,因此可以将计算出来的哈希值保存下来,以便下一次求的时候可以将哈希值直接返回,这也印证了在 python 当中为什么只有 immutable 对象才能够放入到集合和字典当中,因为哈希值计算一次保存下来了,如果再加入对象对象的哈希值也会变化,这样做就会发生错误了。

    • finger,主要是用于记录下一个开始寻找被删除对象的下标。

    • smalltable,默认的小数组,cpython 设置的一半的集合对象不会超过这个大小(8),因此在申请一个集合对象的时候直接就申请了这个小数组的内存大小。

    • weakrelist,这个字段主要和垃圾回收有关,这里暂时不进行详细说明。

    创建集合对象

    首先先了解一下创建一个集合对象的过程,和前面其他的对象是一样的,首先先申请内存空间,然后进行相关的初始化操作。

    这个函数有两个参数,使用第一个参数申请内存空间,然后后面一个参数如果不为 NULL 而且是一个可迭代对象的话,就将这里面的对象加入到集合当中。

    static PyObject *
    make_new_set(PyTypeObject *type, PyObject *iterable)
    {
        PySetObject *so = NULL;
        /* create PySetObject structure */
        so = (PySetObject *)type->tp_alloc(type, 0);
        if (so == NULL)
            return NULL;
        // 集合当中目前没有任何对象,因此 fill 和 used 都是 0
        so->fill = 0;
        so->used = 0;
        // 初始化哈希表当中的数组长度为 PySet_MINSIZE 因此 mask = PySet_MINSIZE - 1
        so->mask = PySet_MINSIZE - 1;
        // 让 table 指向存储 entry 的数组
        so->table = so->smalltable;
        // 将哈希值设置成 -1 表示还没有进行计算
        so->hash = -1;
        so->finger = 0;
        so->weakreflist = NULL;
        // 如果 iterable 不等于 NULL 则需要将它指向的对象当中所有的元素加入到集合当中
        if (iterable != NULL) {
            // 调用函数 set_update_internal 将对象 iterable 当中的元素加入到集合当中
            if (set_update_internal(so, iterable)) {
                Py_DECREF(so);
                return NULL;
            }
        }
        return (PyObject *)so;
    }

    往集合当中加入数据

    首先我们先大致理清楚往集合当中插入数据的流程:

    • 首先根据对象的哈希值,计算需要将对象放在哪个位置,也就是对应数组的下标。

    • 查看对应下标的位置是否存在对象,如果不存在对象则将数据保存在对应下标的位置。

    • 如果对应的位置存在对象,则查看是否和当前要插入的对象相等,则返回。

    • 如果不相等,则使用类似于线性探测的方式去寻找下一个要插入的位置(具体的实现可以查看相关代码,具体的操作为线性探测法 + 开放地址法)。

    static PyObject *
    set_add(PySetObject *so, PyObject *key)
    {
        if (set_add_key(so, key))
            return NULL;
        Py_RETURN_NONE;
    }
    static int
    set_add_key(PySetObject *so, PyObject *key)
    {
        setentry entry;
        Py_hash_t hash;
        // 这里就查看一下是否是字符串,如果是字符串直接拿到哈希值
        if (!PyUnicode_CheckExact(key) ||
            (hash = ((PyASCIIObject *) key)->hash) == -1) {
          	// 如果不是字符串则需要调用对象自己的哈希函数求得对应的哈希值
            hash = PyObject_Hash(key);
            if (hash == -1)
                return -1;
        }
        // 创建一个 entry 对象将这个对象加入到哈希表当中
        entry.key = key;
        entry.hash = hash;
        return set_add_entry(so, &entry);
    }
    static int
    set_add_entry(PySetObject *so, setentry *entry)
    {
        Py_ssize_t n_used;
        PyObject *key = entry->key;
        Py_hash_t hash = entry->hash;
        assert(so->fill <= so->mask);  /* at least one empty slot */
        n_used = so->used;
        Py_INCREF(key);
        // 调用函数 set_insert_key 将对象插入到数组当中
        if (set_insert_key(so, key, hash)) {
            Py_DECREF(key);
            return -1;
        }
        // 这里就是哈希表的核心的扩容机制
        if (!(so->used > n_used && so->fill*3 >= (so->mask+1)*2))
            return 0;
        // 这是扩容大小的逻辑
        return set_table_resize(so, so->used>50000 ? so->used*2 : so->used*4);
    }
    static int
    set_insert_key(PySetObject *so, PyObject *key, Py_hash_t hash)
    {
        setentry *entry;
        // set_lookkey 这个函数便是插入的核心的逻辑的实现对应的实现函数在下方
        entry = set_lookkey(so, key, hash);
        if (entry == NULL)
            return -1;
        if (entry->key == NULL) {
            /* UNUSED */
            entry->key = key;
            entry->hash = hash;
            so->fill++;
            so->used++;
        } else if (entry->key == dummy) {
            /* DUMMY */
            entry->key = key;
            entry->hash = hash;
            so->used++;
        } else {
            /* ACTIVE */
            Py_DECREF(key);
        }
        return 0;
    }
    // 下面的代码就是在执行我们在前面所谈到的逻辑,直到找到相同的 key 或者空位置才退出 while 循环
    static setentry *
    set_lookkey(PySetObject *so, PyObject *key, Py_hash_t hash)
    {
        setentry *table = so->table;
        setentry *freeslot = NULL;
        setentry *entry;
        size_t perturb = hash;
        size_t mask = so->mask;
        size_t i = (size_t)hash & mask; /* Unsigned for defined overflow behavior */
        size_t j;
        int cmp;
        entry = &table[i];
        if (entry->key == NULL)
            return entry;
        while (1) {
            if (entry->hash == hash) {
                PyObject *startkey = entry->key;
                /* startkey cannot be a dummy because the dummy hash field is -1 */
                assert(startkey != dummy);
                if (startkey == key)
                    return entry;
                if (PyUnicode_CheckExact(startkey)
                    && PyUnicode_CheckExact(key)
                    && unicode_eq(startkey, key))
                    return entry;
                Py_INCREF(startkey);
                // returning -1 for error, 0 for false, 1 for true
                cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);
                Py_DECREF(startkey);
                if (cmp < 0)                                          /* unlikely */
                    return NULL;
                if (table != so->table || entry->key != startkey)     /* unlikely */
                    return set_lookkey(so, key, hash);
                if (cmp > 0)                                          /* likely */
                    return entry;
                mask = so->mask;                 /* help avoid a register spill */
            }
            if (entry->hash == -1 && freeslot == NULL)
                freeslot = entry;
            if (i + LINEAR_PROBES <= mask) {
                for (j = 0 ; j < LINEAR_PROBES ; j++) {
                    entry++;
                    if (entry->key == NULL)
                        goto found_null;
                    if (entry->hash == hash) {
                        PyObject *startkey = entry->key;
                        assert(startkey != dummy);
                        if (startkey == key)
                            return entry;
                        if (PyUnicode_CheckExact(startkey)
                            && PyUnicode_CheckExact(key)
                            && unicode_eq(startkey, key))
                            return entry;
                        Py_INCREF(startkey);
                        // returning -1 for error, 0 for false, 1 for true
                        cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);
                        Py_DECREF(startkey);
                        if (cmp < 0)
                            return NULL;
                        if (table != so->table || entry->key != startkey)
                            return set_lookkey(so, key, hash);
                        if (cmp > 0)
                            return entry;
                        mask = so->mask;
                    }
                    if (entry->hash == -1 && freeslot == NULL)
                        freeslot = entry;
                }
            }
            perturb >>= PERTURB_SHIFT; // #define PERTURB_SHIFT 5
            i = (i * 5 + 1 + perturb) & mask;
            entry = &table[i];
            if (entry->key == NULL)
                goto found_null;
        }
      found_null:
        return freeslot == NULL ? entry : freeslot;
    }

    哈希表数组扩容

    在 cpython 当中对于给哈希表数组扩容的操作,很多情况下都是用下面这行代码,从下面的代码来看对应扩容后数组的大小并不简单,当你的哈希表当中的元素个数大于 50000 时,新数组的大小是原数组的两倍,而如果你哈希表当中的元素个数小于等于 50000,那么久扩大为原来长度的四倍,这个主要是怕后面如果继续扩大四倍的话,可能会浪费很多内存空间。

    set_table_resize(so, so->used>50000 ? so->used*2 : so->used*4);

    首先需要了解一下扩容机制,当哈希表需要扩容的时候,主要有以下两个步骤:

    • 创建新的数组,用于存储哈希表的键。

    • 遍历原来的哈希表,将原来哈希表当中的数据加入到新的申请的数组当中。

    这里需要注意的是因为数组的长度发生了变化,但是 key 的哈希值却没有发生变化,因此在新的数组当中数据对应的下标位置也会发生变化,因此需重新将所有的对象重新进行一次插入操作,下面的整个操作相对来说比较简单,这里不再进行说明了。

    static int
    set_table_resize(PySetObject *so, Py_ssize_t minused)
    {
        Py_ssize_t newsize;
        setentry *oldtable, *newtable, *entry;
        Py_ssize_t oldfill = so->fill;
        Py_ssize_t oldused = so->used;
        int is_oldtable_malloced;
        setentry small_copy[PySet_MINSIZE];
        assert(minused >= 0);
        /* Find the smallest table size > minused. */
        /* XXX speed-up with intrinsics */
        for (newsize = PySet_MINSIZE;
             newsize <= minused && newsize > 0;
             newsize <<= 1)
            ;
        if (newsize <= 0) {
            PyErr_NoMemory();
            return -1;
        }
        /* Get space for a new table. */
        oldtable = so->table;
        assert(oldtable != NULL);
        is_oldtable_malloced = oldtable != so->smalltable;
        if (newsize == PySet_MINSIZE) {
            /* A large table is shrinking, or we can't get any smaller. */
            newtable = so->smalltable;
            if (newtable == oldtable) {
                if (so->fill == so->used) {
                    /* No dummies, so no point doing anything. */
                    return 0;
                }
                /* We're not going to resize it, but rebuild the
                   table anyway to purge old dummy entries.
                   Subtle:  This is *necessary* if fill==size,
                   as set_lookkey needs at least one virgin slot to
                   terminate failing searches.  If fill < size, it's
                   merely desirable, as dummies slow searches. */
                assert(so->fill > so->used);
                memcpy(small_copy, oldtable, sizeof(small_copy));
                oldtable = small_copy;
            }
        }
        else {
            newtable = PyMem_NEW(setentry, newsize);
            if (newtable == NULL) {
                PyErr_NoMemory();
                return -1;
            }
        }
        /* Make the set empty, using the new table. */
        assert(newtable != oldtable);
        memset(newtable, 0, sizeof(setentry) * newsize);
        so->fill = 0;
        so->used = 0;
        so->mask = newsize - 1;
        so->table = newtable;
        /* Copy the data over; this is refcount-neutral for active entries;
           dummy entries aren't copied over, of course */
        if (oldfill == oldused) {
            for (entry = oldtable; oldused > 0; entry++) {
                if (entry->key != NULL) {
                    oldused--;
                    set_insert_clean(so, entry->key, entry->hash);
                }
            }
        } else {
            for (entry = oldtable; oldused > 0; entry++) {
                if (entry->key != NULL && entry->key != dummy) {
                    oldused--;
                    set_insert_clean(so, entry->key, entry->hash);
                }
            }
        }
        if (is_oldtable_malloced)
            PyMem_DEL(oldtable);
        return 0;
    }
    static void
    set_insert_clean(PySetObject *so, PyObject *key, Py_hash_t hash)
    {
        setentry *table = so->table;
        setentry *entry;
        size_t perturb = hash;
        size_t mask = (size_t)so->mask;
        size_t i = (size_t)hash & mask;
        size_t j;
        // #define LINEAR_PROBES 9
        while (1) {
            entry = &table[i];
            if (entry->key == NULL)
                goto found_null;
            if (i + LINEAR_PROBES <= mask) {
                for (j = 0; j < LINEAR_PROBES; j++) {
                    entry++;
                    if (entry->key == NULL)
                        goto found_null;
                }
            }
            perturb >>= PERTURB_SHIFT;
            i = (i * 5 + 1 + perturb) & mask;
        }
      found_null:
        entry->key = key;
        entry->hash = hash;
        so->fill++;
        so->used++;
    }

    从集合当中删除元素 pop

    从集合当中删除元素的代码如下所示:

    static PyObject *
    set_pop(PySetObject *so)
    {
        /* Make sure the search finger is in bounds */
        Py_ssize_t i = so->finger & so->mask;
        setentry *entry;
        PyObject *key;
        assert (PyAnySet_Check(so));
        if (so->used == 0) {
            PyErr_SetString(PyExc_KeyError, "pop from an empty set");
            return NULL;
        }
        while ((entry = &so->table[i])->key == NULL || entry->key==dummy) {
            i++;
            if (i > so->mask)
                i = 0;
        }
        key = entry->key;
        entry->key = dummy;
        entry->hash = -1;
        so->used--;
        so->finger = i + 1;         /* next place to start */
        return key;
    }

    上面的代码相对来说也比较清晰,从 finger 开始寻找存在的元素,并且删除他。我们在前面提到过,当一个元素被删除之后他会被赋值成 dummy 而且哈希值为 -1 。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Python
    相关文章 更多
    python删除一个列表里的重复元素的方法与代码示例
    python删除一个列表里的重复元素的方法与代码示例

    学习如何使用Python高效删除列表中的重复元素。本文提供5种常见方法的代码示例,涵盖保持顺序与不保持顺序的场景,适合初学者和进阶开发者参考。

    Python写接口的步骤及完整代码示例
    Python写接口的步骤及完整代码示例

    详细讲解使用Python编写Web接口的核心步骤与完整代码示例,涵盖环境准备、路由定义、数据校验、服务启动及调试测试方法。

    codex怎么读取word文档及docx文件操作教程
    codex怎么读取word文档及docx文件操作教程

    介绍如何利用编程工具读取和解析Word文档(docx格式),涵盖基础文本提取代码示例、结构化数据处理逻辑,以及处理复杂排版时的技术局限与替代方案。

    怎么在Python中调用C语言代码提升性能
    怎么在Python中调用C语言代码提升性能

    详细讲解在Python中调用C语言代码提升性能的完整实践指南,包含原理分析、编译步骤、ctypes与CFFI具体实现、性能对比及常见陷阱。

    Python与C语言的性能差异及底层原理
    Python与C语言的性能差异及底层原理

    深入解析Python与C语言在执行效率上的数量级差异,从编译机制、变量内存布局、动态类型推断到GIL锁,系统阐明底层核心原理。

    Python和C语言哪个更适合编程入门
    Python和C语言哪个更适合编程入门

    客观对比Python与C语言在心智负担、底层机制与学习反馈上的核心差异,提供清晰有据的选择标准与切实的入门学习路径。

    selenium上传文件教程本地文件路径设置方法
    selenium上传文件教程本地文件路径设置方法

    深入解析Selenium处理文件上传的技术细节,涵盖标准HTML控件的路径直接注入法与非标准控件的系统级模拟方案,提供Windows与Linux环境下的路径设置最佳实践及常见异常排查。

    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景
    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景

    针对大数据工程场景,系统对比Java、Scala与Python在执行性能、生态结合、开发效率和维护成本上的核心差异,给出清晰的架构选型依据与落地方案。

    langgraph python guide中文入门教程详解
    langgraph python guide中文入门教程详解

    本篇LangGraph Python中文入门教程详解,系统梳理StateGraph状态机定义、节点编写、边与条件路由、检查点持久化(MemorySaver)等核心机制,提供从环境安装到完整循环智能体构建的代码示例与实操指导。

    Windows 安装 Python:从官方入口到虚拟环境的可复现实践
    Windows 安装 Python:从官方入口到虚拟环境的可复现实践

    面向后端开发者,基于 Python 官方文档说明如何在 Windows 上安装 Python、创建 venv 虚拟环境及使用 pip 管理依赖。包含可复制命令、验证方法及工具选择边界,避免常见配置误区。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。