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.

2 files changed, 112 insertions, 80 deletions

diff --git a/platform/uwp/SCsub b/platform/uwp/SCsub
index 620d8c3c3a..4358b0eead 100644
--- a/platform/uwp/SCsub
+++ b/platform/uwp/SCsub
@@ -1,21 +1,21 @@
 #!/usr/bin/env python
 
-Import('env')
+Import("env")
 
 files = [
-    'thread_uwp.cpp',
-    '#platform/windows/key_mapping_windows.cpp',
-    '#platform/windows/windows_terminal_logger.cpp',
-    'joypad_uwp.cpp',
-    'context_egl_uwp.cpp',
-    'app.cpp',
-    'os_uwp.cpp',
+    "thread_uwp.cpp",
+    "#platform/windows/key_mapping_windows.cpp",
+    "#platform/windows/windows_terminal_logger.cpp",
+    "joypad_uwp.cpp",
+    "context_egl_uwp.cpp",
+    "app.cpp",
+    "os_uwp.cpp",
 ]
 
 if "build_angle" in env and env["build_angle"]:
-    cmd = env.AlwaysBuild(env.ANGLE('libANGLE.lib', None))
+    cmd = env.AlwaysBuild(env.ANGLE("libANGLE.lib", None))
 
-prog = env.add_program('#bin/godot', files)
+prog = env.add_program("#bin/godot", files)
 
 if "build_angle" in env and env["build_angle"]:
     env.Depends(prog, [cmd])
diff --git a/platform/uwp/detect.py b/platform/uwp/detect.py
index 000bd18e7d..669bfe6814 100644
--- a/platform/uwp/detect.py
+++ b/platform/uwp/detect.py
@@ -12,11 +12,11 @@ def get_name():
 
 
 def can_build():
-    if (os.name == "nt"):
+    if os.name == "nt":
         # building natively on windows!
-        if (os.getenv("VSINSTALLDIR")):
+        if os.getenv("VSINSTALLDIR"):
 
-            if (os.getenv("ANGLE_SRC_PATH") is None):
+            if os.getenv("ANGLE_SRC_PATH") is None:
                 return False
 
             return True
@@ -25,16 +25,16 @@ def can_build():
 
 def get_opts():
     return [
-        ('msvc_version', 'MSVC version to use (ignored if the VCINSTALLDIR environment variable is set)', None),
+        ("msvc_version", "MSVC version to use (ignored if the VCINSTALLDIR environment variable is set)", None),
     ]
 
 
 def get_flags():
 
     return [
-        ('tools', False),
-        ('xaudio2', True),
-        ('builtin_pcre2_with_jit', False),
+        ("tools", False),
+        ("xaudio2", True),
+        ("builtin_pcre2_with_jit", False),
     ]
 
 
@@ -42,45 +42,53 @@ def configure(env):
 
     env.msvc = True
 
-    if (env["bits"] != "default"):
+    if env["bits"] != "default":
         print("Error: bits argument is disabled for MSVC")
-        print("""
+        print(
+            """
             Bits argument is not supported for MSVC compilation. Architecture depends on the Native/Cross Compile Tools Prompt/Developer Console
             (or Visual Studio settings) that is being used to run SCons. As a consequence, bits argument is disabled. Run scons again without bits
             argument (example: scons p=uwp) and SCons will attempt to detect what MSVC compiler will be executed and inform you.
-            """)
+            """
+        )
         sys.exit()
 
     ## Build type
 
-    if (env["target"] == "release"):
-        env.Append(CCFLAGS=['/O2', '/GL'])
-        env.Append(CCFLAGS=['/MD'])
-        env.Append(LINKFLAGS=['/SUBSYSTEM:WINDOWS', '/LTCG'])
+    if env["target"] == "release":
+        env.Append(CCFLAGS=["/O2", "/GL"])
+        env.Append(CCFLAGS=["/MD"])
+        env.Append(LINKFLAGS=["/SUBSYSTEM:WINDOWS", "/LTCG"])
 
-    elif (env["target"] == "release_debug"):
-        env.Append(CCFLAGS=['/O2', '/Zi'])
-        env.Append(CCFLAGS=['/MD'])
-        env.Append(CPPDEFINES=['DEBUG_ENABLED'])
-        env.Append(LINKFLAGS=['/SUBSYSTEM:CONSOLE'])
+    elif env["target"] == "release_debug":
+        env.Append(CCFLAGS=["/O2", "/Zi"])
+        env.Append(CCFLAGS=["/MD"])
+        env.Append(CPPDEFINES=["DEBUG_ENABLED"])
+        env.Append(LINKFLAGS=["/SUBSYSTEM:CONSOLE"])
 
-    elif (env["target"] == "debug"):
-        env.Append(CCFLAGS=['/Zi'])
-        env.Append(CCFLAGS=['/MDd'])
-        env.Append(CPPDEFINES=['DEBUG_ENABLED', 'DEBUG_MEMORY_ENABLED'])
-        env.Append(LINKFLAGS=['/SUBSYSTEM:CONSOLE'])
-        env.Append(LINKFLAGS=['/DEBUG'])
+    elif env["target"] == "debug":
+        env.Append(CCFLAGS=["/Zi"])
+        env.Append(CCFLAGS=["/MDd"])
+        env.Append(CPPDEFINES=["DEBUG_ENABLED", "DEBUG_MEMORY_ENABLED"])
+        env.Append(LINKFLAGS=["/SUBSYSTEM:CONSOLE"])
+        env.Append(LINKFLAGS=["/DEBUG"])
 
     ## Compiler configuration
 
-    env['ENV'] = os.environ
-    vc_base_path = os.environ['VCTOOLSINSTALLDIR'] if "VCTOOLSINSTALLDIR" in os.environ else os.environ['VCINSTALLDIR']
+    env["ENV"] = os.environ
+    vc_base_path = os.environ["VCTOOLSINSTALLDIR"] if "VCTOOLSINSTALLDIR" in os.environ else os.environ["VCINSTALLDIR"]
 
     # ANGLE
     angle_root = os.getenv("ANGLE_SRC_PATH")
-    env.Prepend(CPPPATH=[angle_root + '/include'])
+    env.Prepend(CPPPATH=[angle_root + "/include"])
     jobs = str(env.GetOption("num_jobs"))
-    angle_build_cmd = "msbuild.exe " + angle_root + "/winrt/10/src/angle.sln /nologo /v:m /m:" + jobs + " /p:Configuration=Release /p:Platform="
+    angle_build_cmd = (
+        "msbuild.exe "
+        + angle_root
+        + "/winrt/10/src/angle.sln /nologo /v:m /m:"
+        + jobs
+        + " /p:Configuration=Release /p:Platform="
+    )
 
     if os.path.isfile(str(os.getenv("ANGLE_SRC_PATH")) + "/winrt/10/src/angle.sln"):
         env["build_angle"] = True
@@ -88,49 +96,51 @@ def configure(env):
     ## Architecture
 
     arch = ""
-    if str(os.getenv('Platform')).lower() == "arm":
+    if str(os.getenv("Platform")).lower() == "arm":
 
         print("Compiled program architecture will be an ARM executable. (forcing bits=32).")
 
         arch = "arm"
         env["bits"] = "32"
-        env.Append(LINKFLAGS=['/MACHINE:ARM'])
-        env.Append(LIBPATH=[vc_base_path + 'lib/store/arm'])
+        env.Append(LINKFLAGS=["/MACHINE:ARM"])
+        env.Append(LIBPATH=[vc_base_path + "lib/store/arm"])
 
         angle_build_cmd += "ARM"
 
-        env.Append(LIBPATH=[angle_root + '/winrt/10/src/Release_ARM/lib'])
+        env.Append(LIBPATH=[angle_root + "/winrt/10/src/Release_ARM/lib"])
 
     else:
-        compiler_version_str = methods.detect_visual_c_compiler_version(env['ENV'])
+        compiler_version_str = methods.detect_visual_c_compiler_version(env["ENV"])
 
-        if(compiler_version_str == "amd64" or compiler_version_str == "x86_amd64"):
+        if compiler_version_str == "amd64" or compiler_version_str == "x86_amd64":
             env["bits"] = "64"
             print("Compiled program architecture will be a x64 executable (forcing bits=64).")
-        elif (compiler_version_str == "x86" or compiler_version_str == "amd64_x86"):
+        elif compiler_version_str == "x86" or compiler_version_str == "amd64_x86":
             env["bits"] = "32"
             print("Compiled program architecture will be a x86 executable. (forcing bits=32).")
         else:
-            print("Failed to detect MSVC compiler architecture version... Defaulting to 32-bit executable settings (forcing bits=32). Compilation attempt will continue, but SCons can not detect for what architecture this build is compiled for. You should check your settings/compilation setup.")
+            print(
+                "Failed to detect MSVC compiler architecture version... Defaulting to 32-bit executable settings (forcing bits=32). Compilation attempt will continue, but SCons can not detect for what architecture this build is compiled for. You should check your settings/compilation setup."
+            )
             env["bits"] = "32"
 
-        if (env["bits"] == "32"):
+        if env["bits"] == "32":
             arch = "x86"
 
             angle_build_cmd += "Win32"
 
-            env.Append(LINKFLAGS=['/MACHINE:X86'])
-            env.Append(LIBPATH=[vc_base_path + 'lib/store'])
-            env.Append(LIBPATH=[angle_root + '/winrt/10/src/Release_Win32/lib'])
+            env.Append(LINKFLAGS=["/MACHINE:X86"])
+            env.Append(LIBPATH=[vc_base_path + "lib/store"])
+            env.Append(LIBPATH=[angle_root + "/winrt/10/src/Release_Win32/lib"])
 
         else:
             arch = "x64"
 
             angle_build_cmd += "x64"
 
-            env.Append(LINKFLAGS=['/MACHINE:X64'])
-            env.Append(LIBPATH=[os.environ['VCINSTALLDIR'] + 'lib/store/amd64'])
-            env.Append(LIBPATH=[angle_root + '/winrt/10/src/Release_x64/lib'])
+            env.Append(LINKFLAGS=["/MACHINE:X64"])
+            env.Append(LIBPATH=[os.environ["VCINSTALLDIR"] + "lib/store/amd64"])
+            env.Append(LIBPATH=[angle_root + "/winrt/10/src/Release_x64/lib"])
 
     env["PROGSUFFIX"] = "." + arch + env["PROGSUFFIX"]
     env["OBJSUFFIX"] = "." + arch + env["OBJSUFFIX"]
@@ -138,39 +148,61 @@ def configure(env):
 
     ## Compile flags
 
-    env.Prepend(CPPPATH=['#platform/uwp', '#drivers/windows'])
-    env.Append(CPPDEFINES=['UWP_ENABLED', 'WINDOWS_ENABLED', 'TYPED_METHOD_BIND'])
-    env.Append(CPPDEFINES=['GLES_ENABLED', 'GL_GLEXT_PROTOTYPES', 'EGL_EGLEXT_PROTOTYPES', 'ANGLE_ENABLED'])
-    winver = "0x0602" # Windows 8 is the minimum target for UWP build
-    env.Append(CPPDEFINES=[('WINVER', winver), ('_WIN32_WINNT', winver), 'WIN32'])
-
-    env.Append(CPPDEFINES=['__WRL_NO_DEFAULT_LIB__', ('PNG_ABORT', 'abort')])
-
-    env.Append(CPPFLAGS=['/AI', vc_base_path + 'lib/store/references'])
-    env.Append(CPPFLAGS=['/AI', vc_base_path + 'lib/x86/store/references'])
-
-    env.Append(CCFLAGS='/FS /MP /GS /wd"4453" /wd"28204" /wd"4291" /Zc:wchar_t /Gm- /fp:precise /errorReport:prompt /WX- /Zc:forScope /Gd /EHsc /nologo'.split())
-    env.Append(CPPDEFINES=['_UNICODE', 'UNICODE', ('WINAPI_FAMILY', 'WINAPI_FAMILY_APP')])
-    env.Append(CXXFLAGS=['/ZW'])
-    env.Append(CCFLAGS=['/AI', vc_base_path + '\\vcpackages', '/AI', os.environ['WINDOWSSDKDIR'] + '\\References\\CommonConfiguration\\Neutral'])
+    env.Prepend(CPPPATH=["#platform/uwp", "#drivers/windows"])
+    env.Append(CPPDEFINES=["UWP_ENABLED", "WINDOWS_ENABLED", "TYPED_METHOD_BIND"])
+    env.Append(CPPDEFINES=["GLES_ENABLED", "GL_GLEXT_PROTOTYPES", "EGL_EGLEXT_PROTOTYPES", "ANGLE_ENABLED"])
+    winver = "0x0602"  # Windows 8 is the minimum target for UWP build
+    env.Append(CPPDEFINES=[("WINVER", winver), ("_WIN32_WINNT", winver), "WIN32"])
+
+    env.Append(CPPDEFINES=["__WRL_NO_DEFAULT_LIB__", ("PNG_ABORT", "abort")])
+
+    env.Append(CPPFLAGS=["/AI", vc_base_path + "lib/store/references"])
+    env.Append(CPPFLAGS=["/AI", vc_base_path + "lib/x86/store/references"])
+
+    env.Append(
+        CCFLAGS='/FS /MP /GS /wd"4453" /wd"28204" /wd"4291" /Zc:wchar_t /Gm- /fp:precise /errorReport:prompt /WX- /Zc:forScope /Gd /EHsc /nologo'.split()
+    )
+    env.Append(CPPDEFINES=["_UNICODE", "UNICODE", ("WINAPI_FAMILY", "WINAPI_FAMILY_APP")])
+    env.Append(CXXFLAGS=["/ZW"])
+    env.Append(
+        CCFLAGS=[
+            "/AI",
+            vc_base_path + "\\vcpackages",
+            "/AI",
+            os.environ["WINDOWSSDKDIR"] + "\\References\\CommonConfiguration\\Neutral",
+        ]
+    )
 
     ## Link flags
 
-    env.Append(LINKFLAGS=['/MANIFEST:NO', '/NXCOMPAT', '/DYNAMICBASE', '/WINMD', '/APPCONTAINER', '/ERRORREPORT:PROMPT', '/NOLOGO', '/TLBID:1', '/NODEFAULTLIB:"kernel32.lib"', '/NODEFAULTLIB:"ole32.lib"'])
+    env.Append(
+        LINKFLAGS=[
+            "/MANIFEST:NO",
+            "/NXCOMPAT",
+            "/DYNAMICBASE",
+            "/WINMD",
+            "/APPCONTAINER",
+            "/ERRORREPORT:PROMPT",
+            "/NOLOGO",
+            "/TLBID:1",
+            '/NODEFAULTLIB:"kernel32.lib"',
+            '/NODEFAULTLIB:"ole32.lib"',
+        ]
+    )
 
     LIBS = [
-        'WindowsApp',
-        'mincore',
-        'ws2_32',
-        'libANGLE',
-        'libEGL',
-        'libGLESv2',
-        'bcrypt',
+        "WindowsApp",
+        "mincore",
+        "ws2_32",
+        "libANGLE",
+        "libEGL",
+        "libGLESv2",
+        "bcrypt",
     ]
     env.Append(LINKFLAGS=[p + ".lib" for p in LIBS])
 
     # Incremental linking fix
-    env['BUILDERS']['ProgramOriginal'] = env['BUILDERS']['Program']
-    env['BUILDERS']['Program'] = methods.precious_program
+    env["BUILDERS"]["ProgramOriginal"] = env["BUILDERS"]["Program"]
+    env["BUILDERS"]["Program"] = methods.precious_program
 
-    env.Append(BUILDERS={'ANGLE': env.Builder(action=angle_build_cmd)})
+    env.Append(BUILDERS={"ANGLE": env.Builder(action=angle_build_cmd)})