mirror of
https://github.com/godotengine/godot.git
synced 2025-10-25 18:54:43 +00:00
SCons: Format buildsystem files with psf/black
Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted.
This commit is contained in:
Rémi Verschelde
parent
0168709978
commit
cd4e46ee65
198 changed files with 4216 additions and 3446 deletions
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
import os
|
||||
|
||||
|
||||
|
|
@ -8,35 +7,38 @@ verbose = False
|
|||
def find_nuget_unix():
|
||||
import os
|
||||
|
||||
if 'NUGET_PATH' in os.environ:
|
||||
hint_path = os.environ['NUGET_PATH']
|
||||
if "NUGET_PATH" in os.environ:
|
||||
hint_path = os.environ["NUGET_PATH"]
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
hint_path = os.path.join(hint_path, 'nuget')
|
||||
hint_path = os.path.join(hint_path, "nuget")
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
|
||||
import os.path
|
||||
import sys
|
||||
|
||||
hint_dirs = ['/opt/novell/mono/bin']
|
||||
if sys.platform == 'darwin':
|
||||
hint_dirs = ['/Library/Frameworks/Mono.framework/Versions/Current/bin', '/usr/local/var/homebrew/linked/mono/bin'] + hint_dirs
|
||||
hint_dirs = ["/opt/novell/mono/bin"]
|
||||
if sys.platform == "darwin":
|
||||
hint_dirs = [
|
||||
"/Library/Frameworks/Mono.framework/Versions/Current/bin",
|
||||
"/usr/local/var/homebrew/linked/mono/bin",
|
||||
] + hint_dirs
|
||||
|
||||
for hint_dir in hint_dirs:
|
||||
hint_path = os.path.join(hint_dir, 'nuget')
|
||||
hint_path = os.path.join(hint_dir, "nuget")
|
||||
if os.path.isfile(hint_path):
|
||||
return hint_path
|
||||
elif os.path.isfile(hint_path + '.exe'):
|
||||
return hint_path + '.exe'
|
||||
elif os.path.isfile(hint_path + ".exe"):
|
||||
return hint_path + ".exe"
|
||||
|
||||
for hint_dir in os.environ['PATH'].split(os.pathsep):
|
||||
for hint_dir in os.environ["PATH"].split(os.pathsep):
|
||||
hint_dir = hint_dir.strip('"')
|
||||
hint_path = os.path.join(hint_dir, 'nuget')
|
||||
hint_path = os.path.join(hint_dir, "nuget")
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
if os.path.isfile(hint_path + '.exe') and os.access(hint_path + '.exe', os.X_OK):
|
||||
return hint_path + '.exe'
|
||||
if os.path.isfile(hint_path + ".exe") and os.access(hint_path + ".exe", os.X_OK):
|
||||
return hint_path + ".exe"
|
||||
|
||||
return None
|
||||
|
||||
|
|
@ -44,30 +46,30 @@ def find_nuget_unix():
|
|||
def find_nuget_windows(env):
|
||||
import os
|
||||
|
||||
if 'NUGET_PATH' in os.environ:
|
||||
hint_path = os.environ['NUGET_PATH']
|
||||
if "NUGET_PATH" in os.environ:
|
||||
hint_path = os.environ["NUGET_PATH"]
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
hint_path = os.path.join(hint_path, 'nuget.exe')
|
||||
hint_path = os.path.join(hint_path, "nuget.exe")
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
|
||||
from . mono_reg_utils import find_mono_root_dir
|
||||
from .mono_reg_utils import find_mono_root_dir
|
||||
|
||||
mono_root = env['mono_prefix'] or find_mono_root_dir(env['bits'])
|
||||
mono_root = env["mono_prefix"] or find_mono_root_dir(env["bits"])
|
||||
|
||||
if mono_root:
|
||||
mono_bin_dir = os.path.join(mono_root, 'bin')
|
||||
nuget_mono = os.path.join(mono_bin_dir, 'nuget.bat')
|
||||
mono_bin_dir = os.path.join(mono_root, "bin")
|
||||
nuget_mono = os.path.join(mono_bin_dir, "nuget.bat")
|
||||
|
||||
if os.path.isfile(nuget_mono):
|
||||
return nuget_mono
|
||||
|
||||
# Standalone NuGet
|
||||
|
||||
for hint_dir in os.environ['PATH'].split(os.pathsep):
|
||||
for hint_dir in os.environ["PATH"].split(os.pathsep):
|
||||
hint_dir = hint_dir.strip('"')
|
||||
hint_path = os.path.join(hint_dir, 'nuget.exe')
|
||||
hint_path = os.path.join(hint_dir, "nuget.exe")
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
|
||||
|
|
@ -78,52 +80,55 @@ def find_msbuild_unix(filename):
|
|||
import os.path
|
||||
import sys
|
||||
|
||||
hint_dirs = ['/opt/novell/mono/bin']
|
||||
if sys.platform == 'darwin':
|
||||
hint_dirs = ['/Library/Frameworks/Mono.framework/Versions/Current/bin', '/usr/local/var/homebrew/linked/mono/bin'] + hint_dirs
|
||||
hint_dirs = ["/opt/novell/mono/bin"]
|
||||
if sys.platform == "darwin":
|
||||
hint_dirs = [
|
||||
"/Library/Frameworks/Mono.framework/Versions/Current/bin",
|
||||
"/usr/local/var/homebrew/linked/mono/bin",
|
||||
] + hint_dirs
|
||||
|
||||
for hint_dir in hint_dirs:
|
||||
hint_path = os.path.join(hint_dir, filename)
|
||||
if os.path.isfile(hint_path):
|
||||
return hint_path
|
||||
elif os.path.isfile(hint_path + '.exe'):
|
||||
return hint_path + '.exe'
|
||||
elif os.path.isfile(hint_path + ".exe"):
|
||||
return hint_path + ".exe"
|
||||
|
||||
for hint_dir in os.environ['PATH'].split(os.pathsep):
|
||||
for hint_dir in os.environ["PATH"].split(os.pathsep):
|
||||
hint_dir = hint_dir.strip('"')
|
||||
hint_path = os.path.join(hint_dir, filename)
|
||||
if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
|
||||
return hint_path
|
||||
if os.path.isfile(hint_path + '.exe') and os.access(hint_path + '.exe', os.X_OK):
|
||||
return hint_path + '.exe'
|
||||
if os.path.isfile(hint_path + ".exe") and os.access(hint_path + ".exe", os.X_OK):
|
||||
return hint_path + ".exe"
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def find_msbuild_windows(env):
|
||||
from . mono_reg_utils import find_mono_root_dir, find_msbuild_tools_path_reg
|
||||
from .mono_reg_utils import find_mono_root_dir, find_msbuild_tools_path_reg
|
||||
|
||||
mono_root = env['mono_prefix'] or find_mono_root_dir(env['bits'])
|
||||
mono_root = env["mono_prefix"] or find_mono_root_dir(env["bits"])
|
||||
|
||||
if not mono_root:
|
||||
raise RuntimeError('Cannot find mono root directory')
|
||||
raise RuntimeError("Cannot find mono root directory")
|
||||
|
||||
mono_bin_dir = os.path.join(mono_root, 'bin')
|
||||
msbuild_mono = os.path.join(mono_bin_dir, 'msbuild.bat')
|
||||
mono_bin_dir = os.path.join(mono_root, "bin")
|
||||
msbuild_mono = os.path.join(mono_bin_dir, "msbuild.bat")
|
||||
|
||||
msbuild_tools_path = find_msbuild_tools_path_reg()
|
||||
|
||||
if msbuild_tools_path:
|
||||
return (os.path.join(msbuild_tools_path, 'MSBuild.exe'), {})
|
||||
return (os.path.join(msbuild_tools_path, "MSBuild.exe"), {})
|
||||
|
||||
if os.path.isfile(msbuild_mono):
|
||||
# The (Csc/Vbc/Fsc)ToolExe environment variables are required when
|
||||
# building with Mono's MSBuild. They must point to the batch files
|
||||
# in Mono's bin directory to make sure they are executed with Mono.
|
||||
mono_msbuild_env = {
|
||||
'CscToolExe': os.path.join(mono_bin_dir, 'csc.bat'),
|
||||
'VbcToolExe': os.path.join(mono_bin_dir, 'vbc.bat'),
|
||||
'FscToolExe': os.path.join(mono_bin_dir, 'fsharpc.bat')
|
||||
"CscToolExe": os.path.join(mono_bin_dir, "csc.bat"),
|
||||
"VbcToolExe": os.path.join(mono_bin_dir, "vbc.bat"),
|
||||
"FscToolExe": os.path.join(mono_bin_dir, "fsharpc.bat"),
|
||||
}
|
||||
return (msbuild_mono, mono_msbuild_env)
|
||||
|
||||
|
|
@ -132,7 +137,7 @@ def find_msbuild_windows(env):
|
|||
|
||||
def run_command(command, args, env_override=None, name=None):
|
||||
def cmd_args_to_str(cmd_args):
|
||||
return ' '.join([arg if not ' ' in arg else '"%s"' % arg for arg in cmd_args])
|
||||
return " ".join([arg if not " " in arg else '"%s"' % arg for arg in cmd_args])
|
||||
|
||||
args = [command] + args
|
||||
|
||||
|
|
@ -143,6 +148,7 @@ def run_command(command, args, env_override=None, name=None):
|
|||
print("Running '%s': %s" % (name, cmd_args_to_str(args)))
|
||||
|
||||
import subprocess
|
||||
|
||||
try:
|
||||
if env_override is None:
|
||||
subprocess.check_call(args)
|
||||
|
|
@ -154,61 +160,61 @@ def run_command(command, args, env_override=None, name=None):
|
|||
|
||||
def nuget_restore(env, *args):
|
||||
global verbose
|
||||
verbose = env['verbose']
|
||||
verbose = env["verbose"]
|
||||
|
||||
# Find NuGet
|
||||
nuget_path = find_nuget_windows(env) if os.name == 'nt' else find_nuget_unix()
|
||||
nuget_path = find_nuget_windows(env) if os.name == "nt" else find_nuget_unix()
|
||||
if nuget_path is None:
|
||||
raise RuntimeError('Cannot find NuGet executable')
|
||||
raise RuntimeError("Cannot find NuGet executable")
|
||||
|
||||
print('NuGet path: ' + nuget_path)
|
||||
print("NuGet path: " + nuget_path)
|
||||
|
||||
# Do NuGet restore
|
||||
run_command(nuget_path, ['restore'] + list(args), name='nuget restore')
|
||||
run_command(nuget_path, ["restore"] + list(args), name="nuget restore")
|
||||
|
||||
|
||||
def build_solution(env, solution_path, build_config, extra_msbuild_args=[]):
|
||||
global verbose
|
||||
verbose = env['verbose']
|
||||
verbose = env["verbose"]
|
||||
|
||||
msbuild_env = os.environ.copy()
|
||||
|
||||
# Needed when running from Developer Command Prompt for VS
|
||||
if 'PLATFORM' in msbuild_env:
|
||||
del msbuild_env['PLATFORM']
|
||||
if "PLATFORM" in msbuild_env:
|
||||
del msbuild_env["PLATFORM"]
|
||||
|
||||
# Find MSBuild
|
||||
if os.name == 'nt':
|
||||
if os.name == "nt":
|
||||
msbuild_info = find_msbuild_windows(env)
|
||||
if msbuild_info is None:
|
||||
raise RuntimeError('Cannot find MSBuild executable')
|
||||
raise RuntimeError("Cannot find MSBuild executable")
|
||||
msbuild_path = msbuild_info[0]
|
||||
msbuild_env.update(msbuild_info[1])
|
||||
else:
|
||||
msbuild_path = find_msbuild_unix('msbuild')
|
||||
msbuild_path = find_msbuild_unix("msbuild")
|
||||
if msbuild_path is None:
|
||||
xbuild_fallback = env['xbuild_fallback']
|
||||
xbuild_fallback = env["xbuild_fallback"]
|
||||
|
||||
if xbuild_fallback and os.name == 'nt':
|
||||
print('Option \'xbuild_fallback\' not supported on Windows')
|
||||
if xbuild_fallback and os.name == "nt":
|
||||
print("Option 'xbuild_fallback' not supported on Windows")
|
||||
xbuild_fallback = False
|
||||
|
||||
if xbuild_fallback:
|
||||
print('Cannot find MSBuild executable, trying with xbuild')
|
||||
print('Warning: xbuild is deprecated')
|
||||
print("Cannot find MSBuild executable, trying with xbuild")
|
||||
print("Warning: xbuild is deprecated")
|
||||
|
||||
msbuild_path = find_msbuild_unix('xbuild')
|
||||
msbuild_path = find_msbuild_unix("xbuild")
|
||||
|
||||
if msbuild_path is None:
|
||||
raise RuntimeError('Cannot find xbuild executable')
|
||||
raise RuntimeError("Cannot find xbuild executable")
|
||||
else:
|
||||
raise RuntimeError('Cannot find MSBuild executable')
|
||||
raise RuntimeError("Cannot find MSBuild executable")
|
||||
|
||||
print('MSBuild path: ' + msbuild_path)
|
||||
print("MSBuild path: " + msbuild_path)
|
||||
|
||||
# Build solution
|
||||
|
||||
msbuild_args = [solution_path, '/p:Configuration=' + build_config]
|
||||
msbuild_args = [solution_path, "/p:Configuration=" + build_config]
|
||||
msbuild_args += extra_msbuild_args
|
||||
|
||||
run_command(msbuild_path, msbuild_args, env_override=msbuild_env, name='msbuild')
|
||||
run_command(msbuild_path, msbuild_args, env_override=msbuild_env, name="msbuild")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue