[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
This commit is contained in:
pre-commit-ci[bot] 2024-04-13 00:00:18 +00:00
parent 72ad6dc953
commit f4cd1ba0d6
813 changed files with 66015 additions and 58839 deletions

View file

@ -6,38 +6,39 @@ 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
from __future__ import annotations
import contextlib
import os
import subprocess
import contextlib
import warnings
import unittest.mock
import warnings
with contextlib.suppress(ImportError):
import winreg
from distutils.errors import DistutilsExecError, DistutilsPlatformError, \
CompileError, LibError, LinkError
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
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
r'Software\Microsoft\VisualStudio\SxS\VC7',
access=winreg.KEY_READ | winreg.KEY_WOW64_32KEY,
)
except OSError:
log.debug("Visual C++ is not registered")
log.debug('Visual C++ is not registered')
return None, None
best_version = 0
@ -57,6 +58,7 @@ def _find_vc2015():
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"
@ -67,35 +69,39 @@ def _find_vc2017():
If vswhere.exe is not available, by definition, VS 2017 is not
installed.
"""
root = os.environ.get("ProgramFiles(x86)") or os.environ.get("ProgramFiles")
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()
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")
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'
'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()
@ -104,18 +110,19 @@ def _find_vcvarsall(plat_spec):
best_version, best_dir = _find_vc2015()
if not best_dir:
log.debug("No suitable Visual C++ version found")
log.debug('No suitable Visual C++ version found')
return None, None
vcvarsall = os.path.join(best_dir, "vcvarsall.bat")
vcvarsall = os.path.join(best_dir, 'vcvarsall.bat')
if not os.path.isfile(vcvarsall):
log.debug("%s cannot be found", 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"):
if os.getenv('DISTUTILS_USE_SDK'):
return {
key.lower(): value
for key, value in os.environ.items()
@ -123,17 +130,19 @@ def _get_vc_env(plat_spec):
vcvarsall, _ = _find_vcvarsall(plat_spec)
if not vcvarsall:
raise DistutilsPlatformError("Unable to find vcvarsall.bat")
raise DistutilsPlatformError('Unable to find vcvarsall.bat')
try:
out = subprocess.check_output(
'cmd /u /c "{}" {} && set'.format(vcvarsall, plat_spec),
f'cmd /u /c "{vcvarsall}" {plat_spec} && set',
stderr=subprocess.STDOUT,
).decode('utf-16le', errors='replace')
except subprocess.CalledProcessError as exc:
log.error(exc.output)
raise DistutilsPlatformError("Error executing {}"
.format(exc.cmd))
raise DistutilsPlatformError(
'Error executing {}'
.format(exc.cmd),
)
env = {
key.lower(): value
@ -144,6 +153,7 @@ def _get_vc_env(plat_spec):
return env
def _find_exe(exe, paths=None):
"""Return path to an MSVC executable program.
@ -161,17 +171,19 @@ def _find_exe(exe, paths=None):
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'
'win32': 'x86',
'win-amd64': 'x86_amd64',
'win-arm32': 'x86_arm',
'win-arm64': 'x86_arm64',
}
class MSVCCompiler(CCompiler) :
class MSVCCompiler(CCompiler):
"""Concrete class that implements an interface to Microsoft Visual C++,
as defined by the CCompiler abstract class."""
@ -192,8 +204,10 @@ class MSVCCompiler(CCompiler) :
# Needed for the filename generation methods provided by the
# base class, CCompiler.
src_extensions = (_c_extensions + _cpp_extensions +
_rc_extensions + _mc_extensions)
src_extensions = (
_c_extensions + _cpp_extensions +
_rc_extensions + _mc_extensions
)
res_extension = '.res'
obj_extension = '.obj'
static_lib_extension = '.lib'
@ -201,9 +215,8 @@ class MSVCCompiler(CCompiler) :
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)
CCompiler.__init__(self, verbose, dry_run, force)
# target platform (.plat_name is consistent with 'bdist')
self.plat_name = None
self.initialized = False
@ -215,25 +228,29 @@ class MSVCCompiler(CCompiler) :
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)))
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.")
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
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:
@ -248,19 +265,19 @@ class MSVCCompiler(CCompiler) :
# Future releases of Python 3.x will include all past
# versions of vcruntime*.dll for compatibility.
self.compile_options = [
'/nologo', '/O2', '/W3', '/GL', '/DNDEBUG', '/MD'
'/nologo', '/O2', '/W3', '/GL', '/DNDEBUG', '/MD',
]
self.compile_options_debug = [
'/nologo', '/Od', '/MDd', '/Zi', '/W3', '/D_DEBUG'
'/nologo', '/Od', '/MDd', '/Zi', '/W3', '/D_DEBUG',
]
ldflags = [
'/nologo', '/INCREMENTAL:NO', '/LTCG'
'/nologo', '/INCREMENTAL:NO', '/LTCG',
]
ldflags_debug = [
'/nologo', '/INCREMENTAL:NO', '/LTCG', '/DEBUG:FULL'
'/nologo', '/INCREMENTAL:NO', '/LTCG', '/DEBUG:FULL',
]
self.ldflags_exe = [*ldflags, '/MANIFEST:EMBED,ID=1']
@ -286,10 +303,12 @@ class MSVCCompiler(CCompiler) :
# -- Worker methods ------------------------------------------------
def object_filenames(self,
source_filenames,
strip_dir=0,
output_dir=''):
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},
@ -314,19 +333,22 @@ class MSVCCompiler(CCompiler) :
# 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))
raise CompileError(f"Don't know how to compile {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):
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)
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 []
@ -336,7 +358,6 @@ class MSVCCompiler(CCompiler) :
else:
compile_opts.extend(self.compile_options)
add_cpp_opts = False
for obj in objects:
@ -351,14 +372,14 @@ class MSVCCompiler(CCompiler) :
src = os.path.abspath(src)
if ext in self._c_extensions:
input_opt = "/Tc" + src
input_opt = '/Tc' + src
elif ext in self._cpp_extensions:
input_opt = "/Tp" + src
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
output_opt = '/fo' + obj
try:
self.spawn([self.rc] + pp_opts + [output_opt, input_opt])
except DistutilsExecError as msg:
@ -381,24 +402,26 @@ class MSVCCompiler(CCompiler) :
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))
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])
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))
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.append('/Fo' + obj)
args.extend(extra_postargs)
try:
@ -408,72 +431,84 @@ class MSVCCompiler(CCompiler) :
return objects
def create_static_lib(self,
objects,
output_libname,
output_dir=None,
debug=0,
target_lang=None):
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)
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?
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)
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):
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)
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))
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)
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 [])]
export_opts = ['/EXPORT:' + sym for sym in (export_symbols or [])]
ld_args = (ldflags + lib_opts + export_opts +
objects + ['/OUT:' + output_filename])
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
@ -483,11 +518,13 @@ class MSVCCompiler(CCompiler) :
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))
os.path.basename(output_filename),
)
implib_file = os.path.join(
build_temp,
self.library_filename(dll_name))
ld_args.append ('/IMPLIB:' + implib_file)
self.library_filename(dll_name),
)
ld_args.append('/IMPLIB:' + implib_file)
if extra_preargs:
ld_args[:0] = extra_preargs
@ -502,7 +539,7 @@ class MSVCCompiler(CCompiler) :
except DistutilsExecError as msg:
raise LinkError(msg)
else:
log.debug("skipping %s (up-to-date)", output_filename)
log.debug('skipping %s (up-to-date)', output_filename)
def spawn(self, cmd):
env = dict(os.environ, PATH=self._paths)
@ -526,7 +563,8 @@ class MSVCCompiler(CCompiler) :
else:
return
warnings.warn(
"Fallback spawn triggered. Please update distutils monkeypatch.")
'Fallback spawn triggered. Please update distutils monkeypatch.',
)
with unittest.mock.patch('os.environ', env):
bag.value = super().spawn(cmd)
@ -535,11 +573,12 @@ class MSVCCompiler(CCompiler) :
# ccompiler.py.
def library_dir_option(self, dir):
return "/LIBPATH:" + 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")
"don't know how to set runtime library search path for MSVC",
)
def library_option(self, lib):
return self.library_filename(lib)
@ -548,7 +587,7 @@ class MSVCCompiler(CCompiler) :
# 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]
try_names = [lib + '_d', lib]
else:
try_names = [lib]
for dir in dirs: