上文简单分析python的setuptools查找vcvarsall.bat过程

实际上有一个似乎是更常见的报错为Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools": https://visualstudio.microsoft.com/visual-cpp-build-tools/。在这个文章中我会分析这个信息的发生过程(虽然主要篇幅实际上在上一篇文章)。

继上文，我们从_msvc14_find_vcvarsall返回，得到vcvarsall.bat的路径和vcruntime (例如vcruntime140.dll)，然后进入了 _msvc14_get_vc_env函数 函数

def _msvc14_get_vc_env(plat_spec):
    """Python 3.8 "distutils/_msvccompiler.py" backport"""
    if "DISTUTILS_USE_SDK" in environ:
        return {
            key.lower(): value
            for key, value in environ.items()
        }

    vcvarsall, vcruntime = _msvc14_find_vcvarsall(plat_spec)
    if not vcvarsall:
        raise distutils.errors.DistutilsPlatformError(
            "Unable to find vcvarsall.bat"
        )

    try:
        out = subprocess.check_output(
            'cmd /u /c "{}" {} && set'.format(vcvarsall, plat_spec),
            stderr=subprocess.STDOUT,
        ).decode('utf-16le', errors='replace')
    except subprocess.CalledProcessError as exc:
        raise distutils.errors.DistutilsPlatformError(
            "Error executing {}".format(exc.cmd)
        ) from exc

    env = {
        key.lower(): value
        for key, _, value in
        (line.partition('=') for line in out.splitlines())
        if key and value
    }

    if vcruntime:
        env['py_vcruntime_redist'] = vcruntime
    return env

从调用_msvc14_find_vcvarsall开始往下分析，上边的先不考虑。

可以清楚地看到接下来的流程是执行cmd /u /c "[vcvarsall.bat的路径]" [架构] && set (其中架构应该是指编译时目标架构。)并获取输出，这句的作用是调用vcvarsall.bat设置编译的环境变量，并向标准输出中写入。out变量获取到了这些输出。用于接下来从out中读取并格式化环境变量，存入env中。

env变量保存了配置过msvc编译环境的环境变量，然后返回。

通过简单且粗糙的搜索，我们发现_msvc14_get_vc_env被msvc14_get_vc_env函数调用。这个不带前下划线的函数是其对应名称的包装函数，对这个函数进行了包装和错误处理。而这里的错误处理就是我们需要重点关注的地方。

def msvc14_get_vc_env(plat_spec):
    """
    Patched "distutils._msvccompiler._get_vc_env" for support extra
    Microsoft Visual C++ 14.X compilers.
    Set environment without use of "vcvarsall.bat".
    Parameters
    ----------
    plat_spec: str
        Target architecture.
    Return
    ------
    dict
        environment
    """

    # Always use backport from CPython 3.8
    try:
        return _msvc14_get_vc_env(plat_spec)
    except distutils.errors.DistutilsPlatformError as exc:
        _augment_exception(exc, 14.0)
        raise

可以看到如果_msvc14_get_vc_env能被成功执行，此包装函数则返回_msvc14_get_vc_env返回的存储环境变量的变量，但是当捕获到distutils.errors.DistutilsPlatformError异常时，执行_augment_exception异常函数setuptools/msvc.py#L216

def _augment_exception(exc, version, arch=''):
    """
    Add details to the exception message to help guide the user
    as to what action will resolve it.
    """
    # Error if MSVC++ directory not found or environment not set
    message = exc.args[0]

    if "vcvarsall" in message.lower() or "visual c" in message.lower():
        # Special error message if MSVC++ not installed
        tmpl = 'Microsoft Visual C++ {version:0.1f} or greater is required.'
        message = tmpl.format(**locals())
        msdownload = 'www.microsoft.com/download/details.aspx?id=%d'
        if version == 9.0:
            if arch.lower().find('ia64') > -1:
                # For VC++ 9.0, if IA64 support is needed, redirect user
                # to Windows SDK 7.0.
                # Note: No download link available from Microsoft.
                message += ' Get it with "Microsoft Windows SDK 7.0"'
            else:
                # For VC++ 9.0 redirect user to Vc++ for Python 2.7 :
                # This redirection link is maintained by Microsoft.
                # Contact vspython@microsoft.com if it needs updating.
                message += ' Get it from http://aka.ms/vcpython27'
        elif version == 10.0:
            # For VC++ 10.0 Redirect user to Windows SDK 7.1
            message += ' Get it with "Microsoft Windows SDK 7.1": '
            message += msdownload % 8279
        elif version >= 14.0:
            # For VC++ 14.X Redirect user to latest Visual C++ Build Tools
            message += (' Get it with "Microsoft C++ Build Tools": '
                        r'https://visualstudio.microsoft.com'
                        r'/visual-cpp-build-tools/')

    exc.args = (message, )

通过简单的查看，我们可以发现这个函数可能会raise一个错误，信息为Microsoft Visual C++ {version:0.1f} or greater is required.或者就我所知更为常见的Microsoft Visual C++ 14.0 or greater is required.

其中,version变量为_augment_exception的第二个参数，在msvc14_get_vc_env中会主动传入14.0.

总结

对msvc14的查找过程，大致如下

1. 续上一篇描述，进入_msvc14_get_vc_env函数，参数plat_spec为调用此函数的函数传入，我们不用考虑这个参数
2. 开启子进程，运行cmd /u /c "/path/vcvarsall.bat" [目标架构]来初始化环境变量，对环境变量进行处理，生成更容易访问的格式的变量，并返回这个变量
3. 进入msvc14_get_vc_env包装函数，检查这个过程中是否有raise distutils.errors.DistutilsPlatformError，有的话就捕获并调用_augment_exception函数。
4. 进入_augment_exception函数进行错误处理，然后就获得了非常心脏骤停的Microsoft Visual C++ 14.0 or greater is required.

当然，这个过程能抛出distutils.errors.DistutilsPlatformError异常的地方有很多，但是都有异常的message，所以几乎并不需要考虑出现了什么意外情况。

由此，根据setuptools寻找msvc的过程分析，我们可以简单得到以下信息

setuptools通过调用vs installer根目录下的vswhere.exe来获取vs所在路径，通过路径拼接取得用于配置msvc编译环境的vcvarsall.bat路径，运行它以获得msvc的环境变量。并用作setuptools使用。