Last active
July 11, 2020 19:48
-
-
Save matham/a0da3beae05834a3607a8fdc9a6aacd4 to your computer and use it in GitHub Desktop.
github action rc crash
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"""distutils._msvccompiler | |
Contains MSVCCompiler, an implementation of the abstract CCompiler class | |
for Microsoft Visual Studio 2015. | |
The module is compatible with VS 2015 and later. You can find legacy support | |
for older versions in distutils.msvc9compiler and distutils.msvccompiler. | |
""" | |
# Written by Perry Stoll | |
# hacked by Robin Becker and Thomas Heller to do a better job of | |
# finding DevStudio (through the registry) | |
# ported to VS 2005 and VS 2008 by Christian Heimes | |
# ported to VS 2015 by Steve Dower | |
import os | |
import subprocess | |
import winreg | |
from distutils.errors import DistutilsExecError, DistutilsPlatformError, \ | |
CompileError, LibError, LinkError | |
from distutils.ccompiler import CCompiler, gen_lib_options | |
from distutils import log | |
from distutils.util import get_platform | |
from itertools import count | |
import traceback | |
traces = {} | |
def _find_vc2015(): | |
try: | |
key = winreg.OpenKeyEx( | |
winreg.HKEY_LOCAL_MACHINE, | |
r"Software\Microsoft\VisualStudio\SxS\VC7", | |
access=winreg.KEY_READ | winreg.KEY_WOW64_32KEY | |
) | |
except OSError: | |
log.debug("Visual C++ is not registered") | |
return None, None | |
best_version = 0 | |
best_dir = None | |
with key: | |
for i in count(): | |
try: | |
v, vc_dir, vt = winreg.EnumValue(key, i) | |
except OSError: | |
break | |
if v and vt == winreg.REG_SZ and os.path.isdir(vc_dir): | |
try: | |
version = int(float(v)) | |
except (ValueError, TypeError): | |
continue | |
if version >= 14 and version > best_version: | |
best_version, best_dir = version, vc_dir | |
return best_version, best_dir | |
def _find_vc2017(): | |
"""Returns "15, path" based on the result of invoking vswhere.exe | |
If no install is found, returns "None, None" | |
The version is returned to avoid unnecessarily changing the function | |
result. It may be ignored when the path is not None. | |
If vswhere.exe is not available, by definition, VS 2017 is not | |
installed. | |
""" | |
root = os.environ.get("ProgramFiles(x86)") or os.environ.get("ProgramFiles") | |
if not root: | |
return None, None | |
try: | |
path = subprocess.check_output([ | |
os.path.join(root, "Microsoft Visual Studio", "Installer", "vswhere.exe"), | |
"-latest", | |
"-prerelease", | |
"-requires", "Microsoft.VisualStudio.Component.VC.Tools.x86.x64", | |
"-property", "installationPath", | |
"-products", "*", | |
], encoding="mbcs", errors="strict").strip() | |
except (subprocess.CalledProcessError, OSError, UnicodeDecodeError): | |
return None, None | |
path = os.path.join(path, "VC", "Auxiliary", "Build") | |
if os.path.isdir(path): | |
return 15, path | |
return None, None | |
PLAT_SPEC_TO_RUNTIME = { | |
'x86' : 'x86', | |
'x86_amd64' : 'x64', | |
'x86_arm' : 'arm', | |
'x86_arm64' : 'arm64' | |
} | |
def _find_vcvarsall(plat_spec): | |
# bpo-38597: Removed vcruntime return value | |
_, best_dir = _find_vc2017() | |
if not best_dir: | |
best_version, best_dir = _find_vc2015() | |
if not best_dir: | |
log.debug("No suitable Visual C++ version found") | |
return None, None | |
vcvarsall = os.path.join(best_dir, "vcvarsall.bat") | |
if not os.path.isfile(vcvarsall): | |
log.debug("%s cannot be found", vcvarsall) | |
return None, None | |
return vcvarsall, None | |
def _get_vc_env(plat_spec): | |
if os.getenv("DISTUTILS_USE_SDK"): | |
return { | |
key.lower(): value | |
for key, value in os.environ.items() | |
} | |
vcvarsall, _ = _find_vcvarsall(plat_spec) | |
if not vcvarsall: | |
raise 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: | |
log.error(exc.output) | |
raise DistutilsPlatformError("Error executing {}" | |
.format(exc.cmd)) | |
env = { | |
key.lower(): value | |
for key, _, value in | |
(line.partition('=') for line in out.splitlines()) | |
if key and value | |
} | |
return env | |
def _find_exe(exe, paths=None): | |
"""Return path to an MSVC executable program. | |
Tries to find the program in several places: first, one of the | |
MSVC program search paths from the registry; next, the directories | |
in the PATH environment variable. If any of those work, return an | |
absolute path that is known to exist. If none of them work, just | |
return the original program name, 'exe'. | |
""" | |
if not paths: | |
paths = os.getenv('path').split(os.pathsep) | |
for p in paths: | |
fn = os.path.join(os.path.abspath(p), exe) | |
if os.path.isfile(fn): | |
return fn | |
return exe | |
# A map keyed by get_platform() return values to values accepted by | |
# 'vcvarsall.bat'. Always cross-compile from x86 to work with the | |
# lighter-weight MSVC installs that do not include native 64-bit tools. | |
PLAT_TO_VCVARS = { | |
'win32' : 'x86', | |
'win-amd64' : 'x86_amd64', | |
'win-arm32' : 'x86_arm', | |
'win-arm64' : 'x86_arm64' | |
} | |
class MSVCCompiler(CCompiler) : | |
"""Concrete class that implements an interface to Microsoft Visual C++, | |
as defined by the CCompiler abstract class.""" | |
compiler_type = 'msvc' | |
# Just set this so CCompiler's constructor doesn't barf. We currently | |
# don't use the 'set_executables()' bureaucracy provided by CCompiler, | |
# as it really isn't necessary for this sort of single-compiler class. | |
# Would be nice to have a consistent interface with UnixCCompiler, | |
# though, so it's worth thinking about. | |
executables = {} | |
# Private class data (need to distinguish C from C++ source for compiler) | |
_c_extensions = ['.c'] | |
_cpp_extensions = ['.cc', '.cpp', '.cxx'] | |
_rc_extensions = ['.rc'] | |
_mc_extensions = ['.mc'] | |
# Needed for the filename generation methods provided by the | |
# base class, CCompiler. | |
src_extensions = (_c_extensions + _cpp_extensions + | |
_rc_extensions + _mc_extensions) | |
res_extension = '.res' | |
obj_extension = '.obj' | |
static_lib_extension = '.lib' | |
shared_lib_extension = '.dll' | |
static_lib_format = shared_lib_format = '%s%s' | |
exe_extension = '.exe' | |
def __init__(self, verbose=0, dry_run=0, force=0): | |
CCompiler.__init__ (self, verbose, dry_run, force) | |
# target platform (.plat_name is consistent with 'bdist') | |
self.plat_name = None | |
self.initialized = False | |
def initialize(self, plat_name=None): | |
# multi-init means we would need to check platform same each time... | |
assert not self.initialized, "don't init multiple times" | |
if plat_name is None: | |
plat_name = get_platform() | |
# sanity check for platforms to prevent obscure errors later. | |
if plat_name not in PLAT_TO_VCVARS: | |
raise DistutilsPlatformError("--plat-name must be one of {}" | |
.format(tuple(PLAT_TO_VCVARS))) | |
# Get the vcvarsall.bat spec for the requested platform. | |
plat_spec = PLAT_TO_VCVARS[plat_name] | |
vc_env = _get_vc_env(plat_spec) | |
if not vc_env: | |
raise DistutilsPlatformError("Unable to find a compatible " | |
"Visual Studio installation.") | |
self._paths = vc_env.get('path', '') | |
paths = self._paths.split(os.pathsep) | |
self.cc = _find_exe("cl.exe", paths) | |
self.linker = _find_exe("link.exe", paths) | |
self.lib = _find_exe("lib.exe", paths) | |
self.rc = _find_exe("rc.exe", paths) # resource compiler | |
self.mc = _find_exe("mc.exe", paths) # message compiler | |
self.mt = _find_exe("mt.exe", paths) # message compiler | |
for dir in vc_env.get('include', '').split(os.pathsep): | |
if dir: | |
self.add_include_dir(dir.rstrip(os.sep)) | |
for dir in vc_env.get('lib', '').split(os.pathsep): | |
if dir: | |
self.add_library_dir(dir.rstrip(os.sep)) | |
self.preprocess_options = None | |
# bpo-38597: Always compile with dynamic linking | |
# Future releases of Python 3.x will include all past | |
# versions of vcruntime*.dll for compatibility. | |
self.compile_options = [ | |
'/nologo', '/Ox', '/W3', '/GL', '/DNDEBUG', '/MD' | |
] | |
self.compile_options_debug = [ | |
'/nologo', '/Od', '/MDd', '/Zi', '/W3', '/D_DEBUG' | |
] | |
ldflags = [ | |
'/nologo', '/INCREMENTAL:NO', '/LTCG' | |
] | |
ldflags_debug = [ | |
'/nologo', '/INCREMENTAL:NO', '/LTCG', '/DEBUG:FULL' | |
] | |
self.ldflags_exe = [*ldflags, '/MANIFEST:EMBED,ID=1'] | |
self.ldflags_exe_debug = [*ldflags_debug, '/MANIFEST:EMBED,ID=1'] | |
self.ldflags_shared = [*ldflags, '/DLL', '/MANIFEST:EMBED,ID=2', '/MANIFESTUAC:NO'] | |
self.ldflags_shared_debug = [*ldflags_debug, '/DLL', '/MANIFEST:EMBED,ID=2', '/MANIFESTUAC:NO'] | |
self.ldflags_static = [*ldflags] | |
self.ldflags_static_debug = [*ldflags_debug] | |
self._ldflags = { | |
(CCompiler.EXECUTABLE, None): self.ldflags_exe, | |
(CCompiler.EXECUTABLE, False): self.ldflags_exe, | |
(CCompiler.EXECUTABLE, True): self.ldflags_exe_debug, | |
(CCompiler.SHARED_OBJECT, None): self.ldflags_shared, | |
(CCompiler.SHARED_OBJECT, False): self.ldflags_shared, | |
(CCompiler.SHARED_OBJECT, True): self.ldflags_shared_debug, | |
(CCompiler.SHARED_LIBRARY, None): self.ldflags_static, | |
(CCompiler.SHARED_LIBRARY, False): self.ldflags_static, | |
(CCompiler.SHARED_LIBRARY, True): self.ldflags_static_debug, | |
} | |
self.initialized = True | |
# -- Worker methods ------------------------------------------------ | |
def object_filenames(self, | |
source_filenames, | |
strip_dir=0, | |
output_dir=''): | |
ext_map = { | |
**{ext: self.obj_extension for ext in self.src_extensions}, | |
**{ext: self.res_extension for ext in self._rc_extensions + self._mc_extensions}, | |
} | |
output_dir = output_dir or '' | |
def make_out_path(p): | |
base, ext = os.path.splitext(p) | |
if strip_dir: | |
base = os.path.basename(base) | |
else: | |
_, base = os.path.splitdrive(base) | |
if base.startswith((os.path.sep, os.path.altsep)): | |
base = base[1:] | |
try: | |
# XXX: This may produce absurdly long paths. We should check | |
# the length of the result and trim base until we fit within | |
# 260 characters. | |
return os.path.join(output_dir, base + ext_map[ext]) | |
except LookupError: | |
# Better to raise an exception instead of silently continuing | |
# and later complain about sources and targets having | |
# different lengths | |
raise CompileError("Don't know how to compile {}".format(p)) | |
return list(map(make_out_path, source_filenames)) | |
def compile(self, sources, | |
output_dir=None, macros=None, include_dirs=None, debug=0, | |
extra_preargs=None, extra_postargs=None, depends=None): | |
if not self.initialized: | |
self.initialize() | |
compile_info = self._setup_compile(output_dir, macros, include_dirs, | |
sources, depends, extra_postargs) | |
macros, objects, extra_postargs, pp_opts, build = compile_info | |
compile_opts = extra_preargs or [] | |
compile_opts.append('/c') | |
if debug: | |
compile_opts.extend(self.compile_options_debug) | |
else: | |
compile_opts.extend(self.compile_options) | |
add_cpp_opts = False | |
for obj in objects: | |
try: | |
src, ext = build[obj] | |
except KeyError: | |
continue | |
if debug: | |
# pass the full pathname to MSVC in debug mode, | |
# this allows the debugger to find the source file | |
# without asking the user to browse for it | |
src = os.path.abspath(src) | |
if ext in self._c_extensions: | |
input_opt = "/Tc" + src | |
elif ext in self._cpp_extensions: | |
input_opt = "/Tp" + src | |
add_cpp_opts = True | |
elif ext in self._rc_extensions: | |
# compile .RC to .RES file | |
input_opt = src | |
output_opt = "/fo" + obj | |
try: | |
self.spawn([self.rc] + pp_opts + [output_opt, input_opt]) | |
except DistutilsExecError as msg: | |
raise CompileError(msg) | |
continue | |
elif ext in self._mc_extensions: | |
# Compile .MC to .RC file to .RES file. | |
# * '-h dir' specifies the directory for the | |
# generated include file | |
# * '-r dir' specifies the target directory of the | |
# generated RC file and the binary message resource | |
# it includes | |
# | |
# For now (since there are no options to change this), | |
# we use the source-directory for the include file and | |
# the build directory for the RC file and message | |
# resources. This works at least for win32all. | |
h_dir = os.path.dirname(src) | |
rc_dir = os.path.dirname(obj) | |
try: | |
# first compile .MC to .RC and .H file | |
self.spawn([self.mc, '-h', h_dir, '-r', rc_dir, src]) | |
base, _ = os.path.splitext(os.path.basename (src)) | |
rc_file = os.path.join(rc_dir, base + '.rc') | |
# then compile .RC to .RES file | |
self.spawn([self.rc, "/fo" + obj, rc_file]) | |
except DistutilsExecError as msg: | |
raise CompileError(msg) | |
continue | |
else: | |
# how to handle this file? | |
raise CompileError("Don't know how to compile {} to {}" | |
.format(src, obj)) | |
args = [self.cc] + compile_opts + pp_opts | |
if add_cpp_opts: | |
args.append('/EHsc') | |
args.append(input_opt) | |
args.append("/Fo" + obj) | |
args.extend(extra_postargs) | |
try: | |
self.spawn(args) | |
except DistutilsExecError as msg: | |
raise CompileError(msg) | |
return objects | |
def create_static_lib(self, | |
objects, | |
output_libname, | |
output_dir=None, | |
debug=0, | |
target_lang=None): | |
if not self.initialized: | |
self.initialize() | |
objects, output_dir = self._fix_object_args(objects, output_dir) | |
output_filename = self.library_filename(output_libname, | |
output_dir=output_dir) | |
if self._need_link(objects, output_filename): | |
lib_args = objects + ['/OUT:' + output_filename] | |
if debug: | |
pass # XXX what goes here? | |
try: | |
log.debug('Executing "%s" %s', self.lib, ' '.join(lib_args)) | |
self.spawn([self.lib] + lib_args) | |
except DistutilsExecError as msg: | |
raise LibError(msg) | |
else: | |
log.debug("skipping %s (up-to-date)", output_filename) | |
def link(self, | |
target_desc, | |
objects, | |
output_filename, | |
output_dir=None, | |
libraries=None, | |
library_dirs=None, | |
runtime_library_dirs=None, | |
export_symbols=None, | |
debug=0, | |
extra_preargs=None, | |
extra_postargs=None, | |
build_temp=None, | |
target_lang=None): | |
if not self.initialized: | |
self.initialize() | |
objects, output_dir = self._fix_object_args(objects, output_dir) | |
fixed_args = self._fix_lib_args(libraries, library_dirs, | |
runtime_library_dirs) | |
libraries, library_dirs, runtime_library_dirs = fixed_args | |
if runtime_library_dirs: | |
self.warn("I don't know what to do with 'runtime_library_dirs': " | |
+ str(runtime_library_dirs)) | |
lib_opts = gen_lib_options(self, | |
library_dirs, runtime_library_dirs, | |
libraries) | |
if output_dir is not None: | |
output_filename = os.path.join(output_dir, output_filename) | |
if self._need_link(objects, output_filename): | |
ldflags = self._ldflags[target_desc, debug] | |
export_opts = ["/EXPORT:" + sym for sym in (export_symbols or [])] | |
ld_args = (ldflags + lib_opts + export_opts + | |
objects + ['/OUT:' + output_filename]) | |
# The MSVC linker generates .lib and .exp files, which cannot be | |
# suppressed by any linker switches. The .lib files may even be | |
# needed! Make sure they are generated in the temporary build | |
# directory. Since they have different names for debug and release | |
# builds, they can go into the same directory. | |
build_temp = os.path.dirname(objects[0]) | |
if export_symbols is not None: | |
(dll_name, dll_ext) = os.path.splitext( | |
os.path.basename(output_filename)) | |
implib_file = os.path.join( | |
build_temp, | |
self.library_filename(dll_name)) | |
ld_args.append ('/IMPLIB:' + implib_file) | |
if extra_preargs: | |
ld_args[:0] = extra_preargs | |
if extra_postargs: | |
ld_args.extend(extra_postargs) | |
output_dir = os.path.dirname(os.path.abspath(output_filename)) | |
self.mkpath(output_dir) | |
try: | |
log.debug('Executing "%s" %s', self.linker, ' '.join(ld_args)) | |
self.spawn([self.linker] + ld_args) | |
except DistutilsExecError as msg: | |
raise LinkError(msg) | |
else: | |
log.debug("skipping %s (up-to-date)", output_filename) | |
def spawn(self, cmd): | |
old_path = os.getenv('path') | |
try: | |
os.environ['path'] = self._paths | |
print('path is: _msvccompiler - new os.environ[path]', [os.getpid(), cmd, os.environ['path']]) | |
obj = object() | |
traces[obj] = [' '.join(cmd), '\n\n'] + traceback.format_stack() | |
if len(traces) > 1: | |
print('found dupps:') | |
print(''.join(l for lines in traces.values() for l in lines)) | |
return super().spawn(cmd) | |
except Exception as e: | |
print('error iss', e) | |
raise | |
finally: | |
del traces[obj] | |
print('path is: _msvccompiler - finally os.environ[path]', [os.getpid(), cmd, os.environ['path']]) | |
os.environ['path'] = old_path | |
# -- Miscellaneous methods ----------------------------------------- | |
# These are all used by the 'gen_lib_options() function, in | |
# ccompiler.py. | |
def library_dir_option(self, dir): | |
return "/LIBPATH:" + dir | |
def runtime_library_dir_option(self, dir): | |
raise DistutilsPlatformError( | |
"don't know how to set runtime library search path for MSVC") | |
def library_option(self, lib): | |
return self.library_filename(lib) | |
def find_library_file(self, dirs, lib, debug=0): | |
# Prefer a debugging library if found (and requested), but deal | |
# with it if we don't have one. | |
if debug: | |
try_names = [lib + "_d", lib] | |
else: | |
try_names = [lib] | |
for dir in dirs: | |
for name in try_names: | |
libfile = os.path.join(dir, self.library_filename(name)) | |
if os.path.isfile(libfile): | |
return libfile | |
else: | |
# Oops, didn't find it in *any* of 'dirs' | |
return None |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"""distutils.msvc9compiler | |
Contains MSVCCompiler, an implementation of the abstract CCompiler class | |
for the Microsoft Visual Studio 2008. | |
The module is compatible with VS 2005 and VS 2008. You can find legacy support | |
for older versions of VS in distutils.msvccompiler. | |
""" | |
# Written by Perry Stoll | |
# hacked by Robin Becker and Thomas Heller to do a better job of | |
# finding DevStudio (through the registry) | |
# ported to VS2005 and VS 2008 by Christian Heimes | |
import os | |
import subprocess | |
import sys | |
import re | |
from distutils.errors import DistutilsExecError, DistutilsPlatformError, \ | |
CompileError, LibError, LinkError | |
from distutils.ccompiler import CCompiler, gen_lib_options | |
from distutils import log | |
from distutils.util import get_platform | |
import winreg | |
RegOpenKeyEx = winreg.OpenKeyEx | |
RegEnumKey = winreg.EnumKey | |
RegEnumValue = winreg.EnumValue | |
RegError = winreg.error | |
HKEYS = (winreg.HKEY_USERS, | |
winreg.HKEY_CURRENT_USER, | |
winreg.HKEY_LOCAL_MACHINE, | |
winreg.HKEY_CLASSES_ROOT) | |
NATIVE_WIN64 = (sys.platform == 'win32' and sys.maxsize > 2**32) | |
if NATIVE_WIN64: | |
# Visual C++ is a 32-bit application, so we need to look in | |
# the corresponding registry branch, if we're running a | |
# 64-bit Python on Win64 | |
VS_BASE = r"Software\Wow6432Node\Microsoft\VisualStudio\%0.1f" | |
WINSDK_BASE = r"Software\Wow6432Node\Microsoft\Microsoft SDKs\Windows" | |
NET_BASE = r"Software\Wow6432Node\Microsoft\.NETFramework" | |
else: | |
VS_BASE = r"Software\Microsoft\VisualStudio\%0.1f" | |
WINSDK_BASE = r"Software\Microsoft\Microsoft SDKs\Windows" | |
NET_BASE = r"Software\Microsoft\.NETFramework" | |
# A map keyed by get_platform() return values to values accepted by | |
# 'vcvarsall.bat'. Note a cross-compile may combine these (eg, 'x86_amd64' is | |
# the param to cross-compile on x86 targeting amd64.) | |
PLAT_TO_VCVARS = { | |
'win32' : 'x86', | |
'win-amd64' : 'amd64', | |
} | |
class Reg: | |
"""Helper class to read values from the registry | |
""" | |
def get_value(cls, path, key): | |
for base in HKEYS: | |
d = cls.read_values(base, path) | |
if d and key in d: | |
return d[key] | |
raise KeyError(key) | |
get_value = classmethod(get_value) | |
def read_keys(cls, base, key): | |
"""Return list of registry keys.""" | |
try: | |
handle = RegOpenKeyEx(base, key) | |
except RegError: | |
return None | |
L = [] | |
i = 0 | |
while True: | |
try: | |
k = RegEnumKey(handle, i) | |
except RegError: | |
break | |
L.append(k) | |
i += 1 | |
return L | |
read_keys = classmethod(read_keys) | |
def read_values(cls, base, key): | |
"""Return dict of registry keys and values. | |
All names are converted to lowercase. | |
""" | |
try: | |
handle = RegOpenKeyEx(base, key) | |
except RegError: | |
return None | |
d = {} | |
i = 0 | |
while True: | |
try: | |
name, value, type = RegEnumValue(handle, i) | |
except RegError: | |
break | |
name = name.lower() | |
d[cls.convert_mbcs(name)] = cls.convert_mbcs(value) | |
i += 1 | |
return d | |
read_values = classmethod(read_values) | |
def convert_mbcs(s): | |
dec = getattr(s, "decode", None) | |
if dec is not None: | |
try: | |
s = dec("mbcs") | |
except UnicodeError: | |
pass | |
return s | |
convert_mbcs = staticmethod(convert_mbcs) | |
class MacroExpander: | |
def __init__(self, version): | |
self.macros = {} | |
self.vsbase = VS_BASE % version | |
self.load_macros(version) | |
def set_macro(self, macro, path, key): | |
self.macros["$(%s)" % macro] = Reg.get_value(path, key) | |
def load_macros(self, version): | |
self.set_macro("VCInstallDir", self.vsbase + r"\Setup\VC", "productdir") | |
self.set_macro("VSInstallDir", self.vsbase + r"\Setup\VS", "productdir") | |
self.set_macro("FrameworkDir", NET_BASE, "installroot") | |
try: | |
if version >= 8.0: | |
self.set_macro("FrameworkSDKDir", NET_BASE, | |
"sdkinstallrootv2.0") | |
else: | |
raise KeyError("sdkinstallrootv2.0") | |
except KeyError: | |
raise DistutilsPlatformError( | |
"""Python was built with Visual Studio 2008; | |
extensions must be built with a compiler than can generate compatible binaries. | |
Visual Studio 2008 was not found on this system. If you have Cygwin installed, | |
you can try compiling with MingW32, by passing "-c mingw32" to setup.py.""") | |
if version >= 9.0: | |
self.set_macro("FrameworkVersion", self.vsbase, "clr version") | |
self.set_macro("WindowsSdkDir", WINSDK_BASE, "currentinstallfolder") | |
else: | |
p = r"Software\Microsoft\NET Framework Setup\Product" | |
for base in HKEYS: | |
try: | |
h = RegOpenKeyEx(base, p) | |
except RegError: | |
continue | |
key = RegEnumKey(h, 0) | |
d = Reg.get_value(base, r"%s\%s" % (p, key)) | |
self.macros["$(FrameworkVersion)"] = d["version"] | |
def sub(self, s): | |
for k, v in self.macros.items(): | |
s = s.replace(k, v) | |
return s | |
def get_build_version(): | |
"""Return the version of MSVC that was used to build Python. | |
For Python 2.3 and up, the version number is included in | |
sys.version. For earlier versions, assume the compiler is MSVC 6. | |
""" | |
prefix = "MSC v." | |
i = sys.version.find(prefix) | |
if i == -1: | |
return 6 | |
i = i + len(prefix) | |
s, rest = sys.version[i:].split(" ", 1) | |
majorVersion = int(s[:-2]) - 6 | |
if majorVersion >= 13: | |
# v13 was skipped and should be v14 | |
majorVersion += 1 | |
minorVersion = int(s[2:3]) / 10.0 | |
# I don't think paths are affected by minor version in version 6 | |
if majorVersion == 6: | |
minorVersion = 0 | |
if majorVersion >= 6: | |
return majorVersion + minorVersion | |
# else we don't know what version of the compiler this is | |
return None | |
def normalize_and_reduce_paths(paths): | |
"""Return a list of normalized paths with duplicates removed. | |
The current order of paths is maintained. | |
""" | |
# Paths are normalized so things like: /a and /a/ aren't both preserved. | |
reduced_paths = [] | |
for p in paths: | |
np = os.path.normpath(p) | |
# XXX(nnorwitz): O(n**2), if reduced_paths gets long perhaps use a set. | |
if np not in reduced_paths: | |
reduced_paths.append(np) | |
return reduced_paths | |
def removeDuplicates(variable): | |
"""Remove duplicate values of an environment variable. | |
""" | |
oldList = variable.split(os.pathsep) | |
newList = [] | |
for i in oldList: | |
if i not in newList: | |
newList.append(i) | |
newVariable = os.pathsep.join(newList) | |
return newVariable | |
def find_vcvarsall(version): | |
"""Find the vcvarsall.bat file | |
At first it tries to find the productdir of VS 2008 in the registry. If | |
that fails it falls back to the VS90COMNTOOLS env var. | |
""" | |
vsbase = VS_BASE % version | |
try: | |
productdir = Reg.get_value(r"%s\Setup\VC" % vsbase, | |
"productdir") | |
except KeyError: | |
log.debug("Unable to find productdir in registry") | |
productdir = None | |
if not productdir or not os.path.isdir(productdir): | |
toolskey = "VS%0.f0COMNTOOLS" % version | |
toolsdir = os.environ.get(toolskey, None) | |
if toolsdir and os.path.isdir(toolsdir): | |
productdir = os.path.join(toolsdir, os.pardir, os.pardir, "VC") | |
productdir = os.path.abspath(productdir) | |
if not os.path.isdir(productdir): | |
log.debug("%s is not a valid directory" % productdir) | |
return None | |
else: | |
log.debug("Env var %s is not set or invalid" % toolskey) | |
if not productdir: | |
log.debug("No productdir found") | |
return None | |
vcvarsall = os.path.join(productdir, "vcvarsall.bat") | |
if os.path.isfile(vcvarsall): | |
return vcvarsall | |
log.debug("Unable to find vcvarsall.bat") | |
return None | |
def query_vcvarsall(version, arch="x86"): | |
"""Launch vcvarsall.bat and read the settings from its environment | |
""" | |
vcvarsall = find_vcvarsall(version) | |
interesting = {"include", "lib", "libpath", "path"} | |
result = {} | |
if vcvarsall is None: | |
raise DistutilsPlatformError("Unable to find vcvarsall.bat") | |
log.debug("Calling 'vcvarsall.bat %s' (version=%s)", arch, version) | |
popen = subprocess.Popen('"%s" %s & set' % (vcvarsall, arch), | |
stdout=subprocess.PIPE, | |
stderr=subprocess.PIPE) | |
try: | |
stdout, stderr = popen.communicate() | |
if popen.wait() != 0: | |
raise DistutilsPlatformError(stderr.decode("mbcs")) | |
stdout = stdout.decode("mbcs") | |
for line in stdout.split("\n"): | |
line = Reg.convert_mbcs(line) | |
if '=' not in line: | |
continue | |
line = line.strip() | |
key, value = line.split('=', 1) | |
key = key.lower() | |
if key in interesting: | |
if value.endswith(os.pathsep): | |
value = value[:-1] | |
result[key] = removeDuplicates(value) | |
finally: | |
popen.stdout.close() | |
popen.stderr.close() | |
if len(result) != len(interesting): | |
raise ValueError(str(list(result.keys()))) | |
return result | |
# More globals | |
VERSION = get_build_version() | |
if VERSION < 8.0: | |
raise DistutilsPlatformError("VC %0.1f is not supported by this module" % VERSION) | |
# MACROS = MacroExpander(VERSION) | |
class MSVCCompiler(CCompiler) : | |
"""Concrete class that implements an interface to Microsoft Visual C++, | |
as defined by the CCompiler abstract class.""" | |
compiler_type = 'msvc' | |
# Just set this so CCompiler's constructor doesn't barf. We currently | |
# don't use the 'set_executables()' bureaucracy provided by CCompiler, | |
# as it really isn't necessary for this sort of single-compiler class. | |
# Would be nice to have a consistent interface with UnixCCompiler, | |
# though, so it's worth thinking about. | |
executables = {} | |
# Private class data (need to distinguish C from C++ source for compiler) | |
_c_extensions = ['.c'] | |
_cpp_extensions = ['.cc', '.cpp', '.cxx'] | |
_rc_extensions = ['.rc'] | |
_mc_extensions = ['.mc'] | |
# Needed for the filename generation methods provided by the | |
# base class, CCompiler. | |
src_extensions = (_c_extensions + _cpp_extensions + | |
_rc_extensions + _mc_extensions) | |
res_extension = '.res' | |
obj_extension = '.obj' | |
static_lib_extension = '.lib' | |
shared_lib_extension = '.dll' | |
static_lib_format = shared_lib_format = '%s%s' | |
exe_extension = '.exe' | |
def __init__(self, verbose=0, dry_run=0, force=0): | |
CCompiler.__init__ (self, verbose, dry_run, force) | |
self.__version = VERSION | |
self.__root = r"Software\Microsoft\VisualStudio" | |
# self.__macros = MACROS | |
self.__paths = [] | |
# target platform (.plat_name is consistent with 'bdist') | |
self.plat_name = None | |
self.__arch = None # deprecated name | |
self.initialized = False | |
def initialize(self, plat_name=None): | |
# multi-init means we would need to check platform same each time... | |
assert not self.initialized, "don't init multiple times" | |
if plat_name is None: | |
plat_name = get_platform() | |
# sanity check for platforms to prevent obscure errors later. | |
ok_plats = 'win32', 'win-amd64' | |
if plat_name not in ok_plats: | |
raise DistutilsPlatformError("--plat-name must be one of %s" % | |
(ok_plats,)) | |
if "DISTUTILS_USE_SDK" in os.environ and "MSSdk" in os.environ and self.find_exe("cl.exe"): | |
# Assume that the SDK set up everything alright; don't try to be | |
# smarter | |
self.cc = "cl.exe" | |
self.linker = "link.exe" | |
self.lib = "lib.exe" | |
self.rc = "rc.exe" | |
self.mc = "mc.exe" | |
else: | |
# On x86, 'vcvars32.bat amd64' creates an env that doesn't work; | |
# to cross compile, you use 'x86_amd64'. | |
# On AMD64, 'vcvars32.bat amd64' is a native build env; to cross | |
# compile use 'x86' (ie, it runs the x86 compiler directly) | |
if plat_name == get_platform() or plat_name == 'win32': | |
# native build or cross-compile to win32 | |
plat_spec = PLAT_TO_VCVARS[plat_name] | |
else: | |
# cross compile from win32 -> some 64bit | |
plat_spec = PLAT_TO_VCVARS[get_platform()] + '_' + \ | |
PLAT_TO_VCVARS[plat_name] | |
vc_env = query_vcvarsall(VERSION, plat_spec) | |
self.__paths = vc_env['path'].split(os.pathsep) | |
os.environ['lib'] = vc_env['lib'] | |
os.environ['include'] = vc_env['include'] | |
if len(self.__paths) == 0: | |
raise DistutilsPlatformError("Python was built with %s, " | |
"and extensions need to be built with the same " | |
"version of the compiler, but it isn't installed." | |
% self.__product) | |
self.cc = self.find_exe("cl.exe") | |
self.linker = self.find_exe("link.exe") | |
self.lib = self.find_exe("lib.exe") | |
self.rc = self.find_exe("rc.exe") # resource compiler | |
self.mc = self.find_exe("mc.exe") # message compiler | |
#self.set_path_env_var('lib') | |
#self.set_path_env_var('include') | |
# extend the MSVC path with the current path | |
try: | |
for p in os.environ['path'].split(';'): | |
self.__paths.append(p) | |
except KeyError: | |
pass | |
self.__paths = normalize_and_reduce_paths(self.__paths) | |
print('path is: msvc9compiler - old os.environ[path]', [os.environ['path']]) | |
os.environ['path'] = ";".join(self.__paths) | |
print('path is: msvc9compiler - new os.environ[path]', [os.environ['path']]) | |
self.preprocess_options = None | |
if self.__arch == "x86": | |
self.compile_options = [ '/nologo', '/Ox', '/MD', '/W3', | |
'/DNDEBUG'] | |
self.compile_options_debug = ['/nologo', '/Od', '/MDd', '/W3', | |
'/Z7', '/D_DEBUG'] | |
else: | |
# Win64 | |
self.compile_options = [ '/nologo', '/Ox', '/MD', '/W3', '/GS-' , | |
'/DNDEBUG'] | |
self.compile_options_debug = ['/nologo', '/Od', '/MDd', '/W3', '/GS-', | |
'/Z7', '/D_DEBUG'] | |
self.ldflags_shared = ['/DLL', '/nologo', '/INCREMENTAL:NO'] | |
if self.__version >= 7: | |
self.ldflags_shared_debug = [ | |
'/DLL', '/nologo', '/INCREMENTAL:no', '/DEBUG' | |
] | |
self.ldflags_static = [ '/nologo'] | |
self.initialized = True | |
# -- Worker methods ------------------------------------------------ | |
def object_filenames(self, | |
source_filenames, | |
strip_dir=0, | |
output_dir=''): | |
# Copied from ccompiler.py, extended to return .res as 'object'-file | |
# for .rc input file | |
if output_dir is None: output_dir = '' | |
obj_names = [] | |
for src_name in source_filenames: | |
(base, ext) = os.path.splitext (src_name) | |
base = os.path.splitdrive(base)[1] # Chop off the drive | |
base = base[os.path.isabs(base):] # If abs, chop off leading / | |
if ext not in self.src_extensions: | |
# Better to raise an exception instead of silently continuing | |
# and later complain about sources and targets having | |
# different lengths | |
raise CompileError ("Don't know how to compile %s" % src_name) | |
if strip_dir: | |
base = os.path.basename (base) | |
if ext in self._rc_extensions: | |
obj_names.append (os.path.join (output_dir, | |
base + self.res_extension)) | |
elif ext in self._mc_extensions: | |
obj_names.append (os.path.join (output_dir, | |
base + self.res_extension)) | |
else: | |
obj_names.append (os.path.join (output_dir, | |
base + self.obj_extension)) | |
return obj_names | |
def compile(self, sources, | |
output_dir=None, macros=None, include_dirs=None, debug=0, | |
extra_preargs=None, extra_postargs=None, depends=None): | |
if not self.initialized: | |
self.initialize() | |
compile_info = self._setup_compile(output_dir, macros, include_dirs, | |
sources, depends, extra_postargs) | |
macros, objects, extra_postargs, pp_opts, build = compile_info | |
compile_opts = extra_preargs or [] | |
compile_opts.append ('/c') | |
if debug: | |
compile_opts.extend(self.compile_options_debug) | |
else: | |
compile_opts.extend(self.compile_options) | |
for obj in objects: | |
try: | |
src, ext = build[obj] | |
except KeyError: | |
continue | |
if debug: | |
# pass the full pathname to MSVC in debug mode, | |
# this allows the debugger to find the source file | |
# without asking the user to browse for it | |
src = os.path.abspath(src) | |
if ext in self._c_extensions: | |
input_opt = "/Tc" + src | |
elif ext in self._cpp_extensions: | |
input_opt = "/Tp" + src | |
elif ext in self._rc_extensions: | |
# compile .RC to .RES file | |
input_opt = src | |
output_opt = "/fo" + obj | |
try: | |
self.spawn([self.rc] + pp_opts + | |
[output_opt] + [input_opt]) | |
except DistutilsExecError as msg: | |
raise CompileError(msg) | |
continue | |
elif ext in self._mc_extensions: | |
# Compile .MC to .RC file to .RES file. | |
# * '-h dir' specifies the directory for the | |
# generated include file | |
# * '-r dir' specifies the target directory of the | |
# generated RC file and the binary message resource | |
# it includes | |
# | |
# For now (since there are no options to change this), | |
# we use the source-directory for the include file and | |
# the build directory for the RC file and message | |
# resources. This works at least for win32all. | |
h_dir = os.path.dirname(src) | |
rc_dir = os.path.dirname(obj) | |
try: | |
# first compile .MC to .RC and .H file | |
self.spawn([self.mc] + | |
['-h', h_dir, '-r', rc_dir] + [src]) | |
base, _ = os.path.splitext (os.path.basename (src)) | |
rc_file = os.path.join (rc_dir, base + '.rc') | |
# then compile .RC to .RES file | |
self.spawn([self.rc] + | |
["/fo" + obj] + [rc_file]) | |
except DistutilsExecError as msg: | |
raise CompileError(msg) | |
continue | |
else: | |
# how to handle this file? | |
raise CompileError("Don't know how to compile %s to %s" | |
% (src, obj)) | |
output_opt = "/Fo" + obj | |
try: | |
self.spawn([self.cc] + compile_opts + pp_opts + | |
[input_opt, output_opt] + | |
extra_postargs) | |
except DistutilsExecError as msg: | |
raise CompileError(msg) | |
return objects | |
def create_static_lib(self, | |
objects, | |
output_libname, | |
output_dir=None, | |
debug=0, | |
target_lang=None): | |
if not self.initialized: | |
self.initialize() | |
(objects, output_dir) = self._fix_object_args(objects, output_dir) | |
output_filename = self.library_filename(output_libname, | |
output_dir=output_dir) | |
if self._need_link(objects, output_filename): | |
lib_args = objects + ['/OUT:' + output_filename] | |
if debug: | |
pass # XXX what goes here? | |
try: | |
self.spawn([self.lib] + lib_args) | |
except DistutilsExecError as msg: | |
raise LibError(msg) | |
else: | |
log.debug("skipping %s (up-to-date)", output_filename) | |
def link(self, | |
target_desc, | |
objects, | |
output_filename, | |
output_dir=None, | |
libraries=None, | |
library_dirs=None, | |
runtime_library_dirs=None, | |
export_symbols=None, | |
debug=0, | |
extra_preargs=None, | |
extra_postargs=None, | |
build_temp=None, | |
target_lang=None): | |
if not self.initialized: | |
self.initialize() | |
(objects, output_dir) = self._fix_object_args(objects, output_dir) | |
fixed_args = self._fix_lib_args(libraries, library_dirs, | |
runtime_library_dirs) | |
(libraries, library_dirs, runtime_library_dirs) = fixed_args | |
if runtime_library_dirs: | |
self.warn ("I don't know what to do with 'runtime_library_dirs': " | |
+ str (runtime_library_dirs)) | |
lib_opts = gen_lib_options(self, | |
library_dirs, runtime_library_dirs, | |
libraries) | |
if output_dir is not None: | |
output_filename = os.path.join(output_dir, output_filename) | |
if self._need_link(objects, output_filename): | |
if target_desc == CCompiler.EXECUTABLE: | |
if debug: | |
ldflags = self.ldflags_shared_debug[1:] | |
else: | |
ldflags = self.ldflags_shared[1:] | |
else: | |
if debug: | |
ldflags = self.ldflags_shared_debug | |
else: | |
ldflags = self.ldflags_shared | |
export_opts = [] | |
for sym in (export_symbols or []): | |
export_opts.append("/EXPORT:" + sym) | |
ld_args = (ldflags + lib_opts + export_opts + | |
objects + ['/OUT:' + output_filename]) | |
# The MSVC linker generates .lib and .exp files, which cannot be | |
# suppressed by any linker switches. The .lib files may even be | |
# needed! Make sure they are generated in the temporary build | |
# directory. Since they have different names for debug and release | |
# builds, they can go into the same directory. | |
build_temp = os.path.dirname(objects[0]) | |
if export_symbols is not None: | |
(dll_name, dll_ext) = os.path.splitext( | |
os.path.basename(output_filename)) | |
implib_file = os.path.join( | |
build_temp, | |
self.library_filename(dll_name)) | |
ld_args.append ('/IMPLIB:' + implib_file) | |
self.manifest_setup_ldargs(output_filename, build_temp, ld_args) | |
if extra_preargs: | |
ld_args[:0] = extra_preargs | |
if extra_postargs: | |
ld_args.extend(extra_postargs) | |
self.mkpath(os.path.dirname(output_filename)) | |
try: | |
self.spawn([self.linker] + ld_args) | |
except DistutilsExecError as msg: | |
raise LinkError(msg) | |
# embed the manifest | |
# XXX - this is somewhat fragile - if mt.exe fails, distutils | |
# will still consider the DLL up-to-date, but it will not have a | |
# manifest. Maybe we should link to a temp file? OTOH, that | |
# implies a build environment error that shouldn't go undetected. | |
mfinfo = self.manifest_get_embed_info(target_desc, ld_args) | |
if mfinfo is not None: | |
mffilename, mfid = mfinfo | |
out_arg = '-outputresource:%s;%s' % (output_filename, mfid) | |
try: | |
self.spawn(['mt.exe', '-nologo', '-manifest', | |
mffilename, out_arg]) | |
except DistutilsExecError as msg: | |
raise LinkError(msg) | |
else: | |
log.debug("skipping %s (up-to-date)", output_filename) | |
def manifest_setup_ldargs(self, output_filename, build_temp, ld_args): | |
# If we need a manifest at all, an embedded manifest is recommended. | |
# See MSDN article titled | |
# "How to: Embed a Manifest Inside a C/C++ Application" | |
# (currently at http://msdn2.microsoft.com/en-us/library/ms235591(VS.80).aspx) | |
# Ask the linker to generate the manifest in the temp dir, so | |
# we can check it, and possibly embed it, later. | |
temp_manifest = os.path.join( | |
build_temp, | |
os.path.basename(output_filename) + ".manifest") | |
ld_args.append('/MANIFESTFILE:' + temp_manifest) | |
def manifest_get_embed_info(self, target_desc, ld_args): | |
# If a manifest should be embedded, return a tuple of | |
# (manifest_filename, resource_id). Returns None if no manifest | |
# should be embedded. See http://bugs.python.org/issue7833 for why | |
# we want to avoid any manifest for extension modules if we can) | |
for arg in ld_args: | |
if arg.startswith("/MANIFESTFILE:"): | |
temp_manifest = arg.split(":", 1)[1] | |
break | |
else: | |
# no /MANIFESTFILE so nothing to do. | |
return None | |
if target_desc == CCompiler.EXECUTABLE: | |
# by default, executables always get the manifest with the | |
# CRT referenced. | |
mfid = 1 | |
else: | |
# Extension modules try and avoid any manifest if possible. | |
mfid = 2 | |
temp_manifest = self._remove_visual_c_ref(temp_manifest) | |
if temp_manifest is None: | |
return None | |
return temp_manifest, mfid | |
def _remove_visual_c_ref(self, manifest_file): | |
try: | |
# Remove references to the Visual C runtime, so they will | |
# fall through to the Visual C dependency of Python.exe. | |
# This way, when installed for a restricted user (e.g. | |
# runtimes are not in WinSxS folder, but in Python's own | |
# folder), the runtimes do not need to be in every folder | |
# with .pyd's. | |
# Returns either the filename of the modified manifest or | |
# None if no manifest should be embedded. | |
manifest_f = open(manifest_file) | |
try: | |
manifest_buf = manifest_f.read() | |
finally: | |
manifest_f.close() | |
pattern = re.compile( | |
r"""<assemblyIdentity.*?name=("|')Microsoft\."""\ | |
r"""VC\d{2}\.CRT("|').*?(/>|</assemblyIdentity>)""", | |
re.DOTALL) | |
manifest_buf = re.sub(pattern, "", manifest_buf) | |
pattern = r"<dependentAssembly>\s*</dependentAssembly>" | |
manifest_buf = re.sub(pattern, "", manifest_buf) | |
# Now see if any other assemblies are referenced - if not, we | |
# don't want a manifest embedded. | |
pattern = re.compile( | |
r"""<assemblyIdentity.*?name=(?:"|')(.+?)(?:"|')""" | |
r""".*?(?:/>|</assemblyIdentity>)""", re.DOTALL) | |
if re.search(pattern, manifest_buf) is None: | |
return None | |
manifest_f = open(manifest_file, 'w') | |
try: | |
manifest_f.write(manifest_buf) | |
return manifest_file | |
finally: | |
manifest_f.close() | |
except OSError: | |
pass | |
# -- Miscellaneous methods ----------------------------------------- | |
# These are all used by the 'gen_lib_options() function, in | |
# ccompiler.py. | |
def library_dir_option(self, dir): | |
return "/LIBPATH:" + dir | |
def runtime_library_dir_option(self, dir): | |
raise DistutilsPlatformError( | |
"don't know how to set runtime library search path for MSVC++") | |
def library_option(self, lib): | |
return self.library_filename(lib) | |
def find_library_file(self, dirs, lib, debug=0): | |
# Prefer a debugging library if found (and requested), but deal | |
# with it if we don't have one. | |
if debug: | |
try_names = [lib + "_d", lib] | |
else: | |
try_names = [lib] | |
for dir in dirs: | |
for name in try_names: | |
libfile = os.path.join(dir, self.library_filename (name)) | |
if os.path.exists(libfile): | |
return libfile | |
else: | |
# Oops, didn't find it in *any* of 'dirs' | |
return None | |
# Helper methods for using the MSVC registry settings | |
def find_exe(self, exe): | |
"""Return path to an MSVC executable program. | |
Tries to find the program in several places: first, one of the | |
MSVC program search paths from the registry; next, the directories | |
in the PATH environment variable. If any of those work, return an | |
absolute path that is known to exist. If none of them work, just | |
return the original program name, 'exe'. | |
""" | |
for p in self.__paths: | |
fn = os.path.join(os.path.abspath(p), exe) | |
if os.path.isfile(fn): | |
return fn | |
# didn't find it; try existing path | |
for p in os.environ['Path'].split(';'): | |
fn = os.path.join(os.path.abspath(p),exe) | |
if os.path.isfile(fn): | |
return fn | |
return exe |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment