Speedups: auto-build on import and build during setup

Author: black-sliver

NetUtils.py

@@ -2,6 +2,7 @@
 
 import typing
 import enum
+import warnings
 from json import JSONEncoder, JSONDecoder
 
 import websockets
@@ -362,7 +363,8 @@ def get_for_player(self, slot: int) -> typing.Dict[int, typing.Set[int]]:
                     all_locations[source_slot].add(location_id)
         return all_locations
 
-    def get_checked(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int):
+    def get_checked(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int
+                    ) -> typing.List[int]:
         checked = state[team, slot]
         if not checked:
             # This optimizes the case where everyone connects to a fresh game at the same time.
@@ -371,7 +373,8 @@ def get_checked(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]
                 location_id in self[slot] if
                 location_id in checked]
 
-    def get_missing(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int):
+    def get_missing(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int
+                    ) -> typing.List[int]:
         checked = state[team, slot]
         if not checked:
             # This optimizes the case where everyone connects to a fresh game at the same time.
@@ -380,7 +383,8 @@ def get_missing(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]
                 location_id in self[slot] if
                 location_id not in checked]
 
-    def get_remaining(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int):
+    def get_remaining(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int
+                      ) -> typing.List[int]:
         checked = state[team, slot]
         player_locations = self[slot]
         return sorted([player_locations[location_id][0] for
@@ -391,7 +395,14 @@ def get_remaining(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[in
 if typing.TYPE_CHECKING:  # type-check with pure python implementation until we have a typing stub
     LocationStore = _LocationStore
 else:
+    try:
+        import pyximport
+        pyximport.install()
+    except ImportError:
+        pyximport = None
     try:
         from _speedups import LocationStore
     except ImportError:
+        warnings.warn("_speedups not available. Falling back to pure python LocationStore. "
+                      "Install a matching C++ compiler for your platform to compile _speedups.")
         LocationStore = _LocationStore

_speedups.pyx

@@ -1,5 +1,5 @@
-# cython: language_level=3
-# distutils: language = c++
+#cython: language_level=3
+#distutils: language = c++
 
 """
 Provides faster implementation of some core parts.

setup.py

@@ -57,6 +57,7 @@
 
 from worlds.LauncherComponents import components, icon_paths
 from Utils import version_tuple, is_windows, is_linux
+from Cython.Build import cythonize
 
 
 # On  Python < 3.10 LogicMixin is not currently supported.
@@ -293,13 +294,18 @@ def run(self):
         sni_thread = threading.Thread(target=download_SNI, name="SNI Downloader")
         sni_thread.start()
 
-        # pre build steps
+        # pre-build steps
         print(f"Outputting to: {self.buildfolder}")
         os.makedirs(self.buildfolder, exist_ok=True)
         import ModuleUpdate
         ModuleUpdate.requirements_files.add(os.path.join("WebHostLib", "requirements.txt"))
         ModuleUpdate.update(yes=self.yes)
 
+        # auto-build cython modules
+        build_ext = self.distribution.get_command_obj("build_ext")
+        build_ext.inplace = True
+        self.run_command("build_ext")
+
         # regular cx build
         self.buildtime = datetime.datetime.utcnow()
         super().run()
@@ -586,10 +592,10 @@ def find_lib(lib, arch, libc):
     version=f"{version_tuple.major}.{version_tuple.minor}.{version_tuple.build}",
     description="Archipelago",
     executables=exes,
-    ext_modules=[],  # required to disable auto-discovery with setuptools>=61
+    ext_modules=cythonize("_speedups.pyx"),
     options={
         "build_exe": {
-            "packages": ["websockets", "worlds", "kivy"],
+            "packages": ["websockets", "worlds", "kivy", "_speedups", "cymem"],
             "includes": [],
             "excludes": ["numpy", "Cython", "PySide2", "PIL",
                          "pandas"],