Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SCons: Change Environment type hints to SConsEnvironment #85322

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions platform/android/detect.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from SCons import Environment
from SCons.Script.SConscript import SConsEnvironment


def get_name():
Expand Down Expand Up @@ -51,7 +51,7 @@ def get_min_sdk_version(platform):
return int(platform.split("-")[1])


def get_android_ndk_root(env):
def get_android_ndk_root(env: "SConsEnvironment"):
return env["ANDROID_HOME"] + "/ndk/" + get_ndk_version()


Expand All @@ -74,7 +74,7 @@ def get_flags():

# Check if Android NDK version is installed
# If not, install it.
def install_ndk_if_needed(env):
def install_ndk_if_needed(env: "SConsEnvironment"):
print("Checking for Android NDK...")
sdk_root = env["ANDROID_HOME"]
if not os.path.exists(get_android_ndk_root(env)):
Expand All @@ -96,7 +96,7 @@ def install_ndk_if_needed(env):
env["ANDROID_NDK_ROOT"] = get_android_ndk_root(env)


def configure(env: "Environment"):
def configure(env: "SConsEnvironment"):
# Validate arch.
supported_arches = ["x86_32", "x86_64", "arm32", "arm64"]
if env["arch"] not in supported_arches:
Expand Down
4 changes: 2 additions & 2 deletions platform/ios/detect.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from SCons import Environment
from SCons.Script.SConscript import SConsEnvironment


def get_name():
Expand Down Expand Up @@ -54,7 +54,7 @@ def get_flags():
]


def configure(env: "Environment"):
def configure(env: "SConsEnvironment"):
# Validate arch.
supported_arches = ["x86_64", "arm64"]
if env["arch"] not in supported_arches:
Expand Down
4 changes: 2 additions & 2 deletions platform/linuxbsd/detect.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from SCons import Environment
from SCons.Script.SConscript import SConsEnvironment


def get_name():
Expand Down Expand Up @@ -70,7 +70,7 @@ def get_flags():
]


def configure(env: "Environment"):
def configure(env: "SConsEnvironment"):
# Validate arch.
supported_arches = ["x86_32", "x86_64", "arm32", "arm64", "rv64", "ppc32", "ppc64"]
if env["arch"] not in supported_arches:
Expand Down
4 changes: 2 additions & 2 deletions platform/macos/detect.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from SCons import Environment
from SCons.Script.SConscript import SConsEnvironment


def get_name():
Expand Down Expand Up @@ -59,7 +59,7 @@ def get_flags():
]


def configure(env: "Environment"):
def configure(env: "SConsEnvironment"):
# Validate arch.
supported_arches = ["x86_64", "arm64"]
if env["arch"] not in supported_arches:
Expand Down
4 changes: 2 additions & 2 deletions platform/web/detect.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from SCons import Environment
from SCons.Script.SConscript import SConsEnvironment


def get_name():
Expand Down Expand Up @@ -81,7 +81,7 @@ def get_flags():
]


def configure(env: "Environment"):
def configure(env: "SConsEnvironment"):
# Validate arch.
supported_arches = ["wasm32"]
if env["arch"] not in supported_arches:
Expand Down
24 changes: 12 additions & 12 deletions platform/windows/detect.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from SCons import Environment
from SCons.Script.SConscript import SConsEnvironment

# To match other platforms
STACK_SIZE = 8388608
Expand Down Expand Up @@ -251,7 +251,7 @@ def get_flags():
]


def build_res_file(target, source, env):
def build_res_file(target, source, env: "SConsEnvironment"):
arch_aliases = {
"x86_32": "pe-i386",
"x86_64": "pe-x86-64",
Expand Down Expand Up @@ -286,7 +286,7 @@ def build_res_file(target, source, env):
return 0


def setup_msvc_manual(env):
def setup_msvc_manual(env: "SConsEnvironment"):
"""Running from VCVARS environment"""

env_arch = detect_build_env_arch()
Expand All @@ -303,7 +303,7 @@ def setup_msvc_manual(env):
print("Found MSVC, arch %s" % (env_arch))


def setup_msvc_auto(env):
def setup_msvc_auto(env: "SConsEnvironment"):
"""Set up MSVC using SCons's auto-detection logic"""

# If MSVC_VERSION is set by SCons, we know MSVC is installed.
Expand Down Expand Up @@ -339,7 +339,7 @@ def setup_msvc_auto(env):
print("Found MSVC version %s, arch %s" % (env["MSVC_VERSION"], env["arch"]))


def setup_mingw(env):
def setup_mingw(env: "SConsEnvironment"):
"""Set up env for use with mingw"""

env_arch = detect_build_env_arch()
Expand Down Expand Up @@ -374,7 +374,7 @@ def setup_mingw(env):
print("Using MinGW, arch %s" % (env["arch"]))


def configure_msvc(env, vcvars_msvc_config):
def configure_msvc(env: "SConsEnvironment", vcvars_msvc_config):
"""Configure env to work with MSVC"""

## Build type
Expand Down Expand Up @@ -417,7 +417,7 @@ def configure_msvc(env, vcvars_msvc_config):

if vcvars_msvc_config: # should be automatic if SCons found it
if os.getenv("WindowsSdkDir") is not None:
env.Prepend(CPPPATH=[os.getenv("WindowsSdkDir") + "/Include"])
env.Prepend(CPPPATH=[str(os.getenv("WindowsSdkDir")) + "/Include"])
else:
print("Missing environment variable: WindowsSdkDir")

Expand Down Expand Up @@ -522,7 +522,7 @@ def configure_msvc(env, vcvars_msvc_config):

if vcvars_msvc_config:
if os.getenv("WindowsSdkDir") is not None:
env.Append(LIBPATH=[os.getenv("WindowsSdkDir") + "/Lib"])
env.Append(LIBPATH=[str(os.getenv("WindowsSdkDir")) + "/Lib"])
else:
print("Missing environment variable: WindowsSdkDir")

Expand All @@ -543,8 +543,8 @@ def configure_msvc(env, vcvars_msvc_config):
env.AppendUnique(LINKFLAGS=["/LTCG"])

if vcvars_msvc_config:
env.Prepend(CPPPATH=[p for p in os.getenv("INCLUDE").split(";")])
env.Append(LIBPATH=[p for p in os.getenv("LIB").split(";")])
env.Prepend(CPPPATH=[p for p in str(os.getenv("INCLUDE")).split(";")])
env.Append(LIBPATH=[p for p in str(os.getenv("LIB")).split(";")])

# Sanitizers
if env["use_asan"]:
Expand All @@ -560,7 +560,7 @@ def configure_msvc(env, vcvars_msvc_config):
env.AppendUnique(LINKFLAGS=["/STACK:" + str(STACK_SIZE)])


def configure_mingw(env):
def configure_mingw(env: "SConsEnvironment"):
# Workaround for MinGW. See:
# https://www.scons.org/wiki/LongCmdLinesOnWin32
env.use_windows_spawn_fix()
Expand Down Expand Up @@ -747,7 +747,7 @@ def configure_mingw(env):
env.Append(BUILDERS={"RES": env.Builder(action=build_res_file, suffix=".o", src_suffix=".rc")})


def configure(env: "Environment"):
def configure(env: "SConsEnvironment"):
# Validate arch.
supported_arches = ["x86_32", "x86_64", "arm32", "arm64"]
if env["arch"] not in supported_arches:
Expand Down
Loading