Merge pull request #228 from an-swe/feat/add-type-stubs

add type stubs for static type checking support

Author: BurnySc2

.github/workflows/docker-ci.yml

@@ -111,6 +111,7 @@ jobs:
           docker cp pyproject.toml test_container:/root/python-sc2/
           docker cp uv.lock test_container:/root/python-sc2/
           docker cp sc2 test_container:/root/python-sc2/sc2
+          docker cp s2clientprotocol test_container:/root/python-sc2/s2clientprotocol
           docker cp test test_container:/root/python-sc2/test
           docker cp examples test_container:/root/python-sc2/examples
           docker exec -i test_container bash -c "pip install uv \

dockerfiles/test_docker_image.sh

@@ -46,6 +46,7 @@ docker cp uv.lock test_container:/root/python-sc2/
 docker exec -i test_container bash -c "pip install uv && cd python-sc2 && uv sync --no-cache --no-install-project"
 
 docker cp sc2 test_container:/root/python-sc2/sc2
+docker cp s2clientprotocol test_container:/root/python-sc2/s2clientprotocol
 docker cp test test_container:/root/python-sc2/test
 
 # Run various test bots

examples/arcade_bot.py

@@ -42,7 +42,7 @@ async def on_start(self):
         await self.chat_send("Edit this message for automatic chat commands.")
         self.client.game_step = 2
 
-    async def on_step(self, iteration):
+    async def on_step(self, iteration: int):
         # do marine micro vs zerglings
         for unit in self.units(UnitTypeId.MARINE):
             if self.enemy_units:

examples/competitive/bot.py

@@ -7,7 +7,7 @@ async def on_start(self):
         print("Game started")
         # Do things here before the game starts
 
-    async def on_step(self, iteration):
+    async def on_step(self, iteration: int):
         # Populate this function with whatever your bot should do!
         pass
 

examples/distributed_workers.py

@@ -8,7 +8,7 @@
 
 
 class TerranBot(BotAI):
-    async def on_step(self, iteration):
+    async def on_step(self, iteration: int):
         await self.distribute_workers()
         await self.build_supply()
         await self.build_workers()

examples/fastreload.py

@@ -4,11 +4,14 @@
 from sc2 import maps
 from sc2.data import Difficulty, Race
 from sc2.main import _host_game_iter
-from sc2.player import Bot, Computer
+from sc2.player import AbstractPlayer, Bot, Computer
 
 
 def main():
-    player_config = [Bot(Race.Zerg, zerg_rush.ZergRushBot()), Computer(Race.Terran, Difficulty.Medium)]
+    player_config: list[AbstractPlayer] = [
+        Bot(Race.Zerg, zerg_rush.ZergRushBot()),
+        Computer(Race.Terran, Difficulty.Medium),
+    ]
 
     gen = _host_game_iter(maps.get("Abyssal Reef LE"), player_config, realtime=False)
 

examples/host_external_norestart.py

@@ -1,13 +1,13 @@
-import sc2
 from examples.zerg.zerg_rush import ZergRushBot
 from sc2 import maps
 from sc2.data import Race
 from sc2.main import _host_game_iter
 from sc2.player import Bot
+from sc2.portconfig import Portconfig
 
 
 def main():
-    portconfig = sc2.portconfig.Portconfig()
+    portconfig: Portconfig = Portconfig()
     print(portconfig.as_json)
 
     player_config = [Bot(Race.Zerg, ZergRushBot()), Bot(Race.Zerg, None)]

examples/protoss/cannon_rush.py

@@ -9,7 +9,7 @@
 
 
 class CannonRushBot(BotAI):
-    async def on_step(self, iteration):
+    async def on_step(self, iteration: int):
         if iteration == 0:
             await self.chat_send("(probe)(pylon)(cannon)(cannon)(gg)")
 

examples/protoss/find_adept_shades.py

@@ -13,7 +13,7 @@
 class FindAdeptShadesBot(BotAI):
     def __init__(self):
         self.shaded = False
-        self.shades_mapping = {}
+        self.shades_mapping: dict[int, int] = {}
 
     async def on_start(self):
         self.client.game_step = 2

examples/protoss/threebase_voidray.py

@@ -9,7 +9,7 @@
 
 
 class ThreebaseVoidrayBot(BotAI):
-    async def on_step(self, iteration):
+    async def on_step(self, iteration: int):
         target_base_count = 3
         target_stargate_count = 3