大师兄的Python源码学习笔记(三十二）: 运行环境初始化(四

大师兄的Python源码学习笔记(三十一）: 运行环境初始化(三)
大师兄的Python源码学习笔记(三十三）: 运行环境初始化(五)

3. 创建__main__ module

• 接着，Python将创建__main__ module，一个非常特殊的module:

Python\pylifecycle.c

_PyInitError
_Py_InitializeMainInterpreter(PyInterpreterState *interp,
                              const _PyMainInterpreterConfig *config)
{
    _PyInitError err;

    ... ...
    err = add_main_module(interp);
    ... ...
}

Python\pylifecycle.c

static _PyInitError
add_main_module(PyInterpreterState *interp)
{
    PyObject *m, *d, *loader, *ann_dict;
    m = PyImport_AddModule("__main__");
    if (m == NULL)
        return _Py_INIT_ERR("can't create __main__ module");

    d = PyModule_GetDict(m);
    ann_dict = PyDict_New();
    if ((ann_dict == NULL) ||
        (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
        return _Py_INIT_ERR("Failed to initialize __main__.__annotations__");
    }
    Py_DECREF(ann_dict);

    if (PyDict_GetItemString(d, "__builtins__") == NULL) {
        PyObject *bimod = PyImport_ImportModule("builtins");
        if (bimod == NULL) {
            return _Py_INIT_ERR("Failed to retrieve builtins module");
        }
        if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
            return _Py_INIT_ERR("Failed to initialize __main__.__builtins__");
        }
        Py_DECREF(bimod);
    }

    /* Main is a little special - imp.is_builtin("__main__") will return
     * False, but BuiltinImporter is still the most appropriate initial
     * setting for its __loader__ attribute. A more suitable value will
     * be set if __main__ gets further initialized later in the startup
     * process.
     */
    loader = PyDict_GetItemString(d, "__loader__");
    if (loader == NULL || loader == Py_None) {
        PyObject *loader = PyObject_GetAttrString(interp->importlib,
                                                  "BuiltinImporter");
        if (loader == NULL) {
            return _Py_INIT_ERR("Failed to retrieve BuiltinImporter");
        }
        if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
            return _Py_INIT_ERR("Failed to initialize __main__.__loader__");
        }
        Py_DECREF(loader);
    }
    return _Py_INIT_OK();
}

• 在上面代码中，首先通过PyImport_AddModule创建了__main__ module，并将其插入了interp->modules中。
• 随后，又通过PyModule_GetDict获取了__main__中的dict。
• 这个__main__就是Python中作为主程序运行中的__main__。

if __name__ == '__main__':

• 在.py文件被当做主程序运行时，Python在沿着名字空间寻找__name__时，最终会在__main__ module中发现__name__其实为__main__。
• 但如果一个.py文件以import方式加载，则__name__不为__main__。
• 从这里，我们可以看出builtins和__builtins__的区别。

>>>print(dir())
>>>print(__name__)
>>>print(__builtins__.__name__)
['A', '__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']
__main__
builtins

4. 设置site-specific的module的搜索路径

• Python的强大来源于第三方库，这些库通常由module提供，用import调用。
• 一般来说，规模较大的第三方库放在%PythonHome%/lib/site-package目录下，若想在程序运行时使用这些库，则需要使这些库位于Python的搜索路径下，也就是将site-packages目录加入到sys.path中。
• 这个动作是由initsite完成的：

Python\pylifecycle.c

_PyInitError
_Py_InitializeMainInterpreter(PyInterpreterState *interp,
                              const _PyMainInterpreterConfig *config)
{
    _PyInitError err;

    if (!Py_NoSiteFlag) {
        err = initsite(); /* Module site */
        if (_Py_INIT_FAILED(err)) {
            return err;
        }
    }
    return _Py_INIT_OK();
}

Python\pylifecycle.c

static _PyInitError
initsite(void)
{
    PyObject *m;
    m = PyImport_ImportModule("site");
    if (m == NULL) {
        return _Py_INIT_USER_ERR("Failed to import the site module");
    }
    Py_DECREF(m);
    return _Py_INIT_OK();
}

• 在initsite中，只调用了PyImport_ImportModule函数，这个函数是Python中import机制的核心。
• 在这里，Python进行了两个动作：

1. 将site-packages路径加入到sys.path中。
2. 处理site-packages目录下的所有.pth文件中的所有路径加入到sys.path中。

• 到此为止，Python中绝大部分重要的初始化动作都已经完成，完成初始化后的环境如下：