Files
grpc/tools/distrib/python/grpcio_tools/_spawn_patch.py
Esun Kim ea16833187 [C++] Fix python build script to handle C and C++ std options properly for MSVC (#38410)
This PR makes necessary changes to Python build scripts for C++17 support, which were missed in #37919

- Fixed handling of C and C++ standard options for MSVC.
  - Previously, a workaround relied on a specific method, `_compiler` found in the compiler class. [unixcompiler](ff11eed0c3/distutils/unixccompiler.py (L191)) has it but [msvccompiler](ff11eed0c3/distutils/_msvccompiler.py (L367)) doesn't. Therefore this won't work for MSVC even though it's supposed to work across all compilers.
  - To resolve this, a new workaround has been implemented. This involves adding logic directly into the `_commandfile_spawn` function, which is considered the most suitable location for this fix. Although not ideal, this ensures that C and C++ standard options are managed correctly for MSVC.
- Removed `compiler_ok_with_extra_std function` as isolating C and C++ standard options is always recommended.
- Updated comments to correctly refer to C++17.

Closes #38410

PiperOrigin-RevId: 713442384
2025-01-08 15:48:59 -08:00

73 lines
2.8 KiB
Python

# Copyright 2016 gRPC authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Patches the spawn() command for windows compilers.
Windows has an 8191 character command line limit, but some compilers
support an @command_file directive where command_file is a file
containing the full command line.
"""
from distutils import ccompiler
import os
import os.path
import shutil
import sys
import tempfile
MAX_COMMAND_LENGTH = 8191
_classic_spawn = ccompiler.CCompiler.spawn
def _commandfile_spawn(self, command, **kwargs):
if os.name == "nt":
if any(arg.startswith("/Tc") for arg in command):
# Remove /std:c++17 option if this is a MSVC C complation
command = [arg for arg in command if arg != "/std:c++17"]
elif any(arg.startswith("/Tp") for arg in command):
# Remove /std:c11 option if this is a MSVC C++ complation
command = [arg for arg in command if arg != "/std:c11"]
command_length = sum([len(arg) for arg in command])
if os.name == "nt" and command_length > MAX_COMMAND_LENGTH:
# Even if this command doesn't support the @command_file, it will
# fail as is so we try blindly
print("Command line length exceeded, using command file")
print(" ".join(command))
temporary_directory = tempfile.mkdtemp()
command_filename = os.path.abspath(
os.path.join(temporary_directory, "command")
)
with open(command_filename, "w") as command_file:
escaped_args = [
'"' + arg.replace("\\", "\\\\") + '"' for arg in command[1:]
]
# add each arg on a separate line to avoid hitting the
# "line in command file contains 131071 or more characters" error
# (can happen for extra long link commands)
command_file.write(" \n".join(escaped_args))
modified_command = command[:1] + ["@{}".format(command_filename)]
try:
_classic_spawn(self, modified_command, **kwargs)
finally:
shutil.rmtree(temporary_directory)
else:
_classic_spawn(self, command, **kwargs)
def monkeypatch_spawn():
"""Monkeypatching is dumb, but it's either that or we become maintainers of
something much, much bigger."""
ccompiler.CCompiler.spawn = _commandfile_spawn