Python Starter Bot (#5)

* Python bot init talks with server

* Python talk with server up to started match

* Python starter bot client done

* - Fixed socket read buffer
- Named tuple XY and BotInfo

* - Revert back to dataclasses (faster)

* - Socket - skip server round data to stay in sync

* - README
- bot comments
- optimized Socket performance

Author: Rush-iam

build.md

@@ -1,10 +1,10 @@
-##Структура проекта
+## Структура проекта
 
 - `common` - модуль с общими классами, используемыми и на стороне сервера, и на стороне бота
 - `server` - модуль с кодом сервера. Дорабатывается исключительно администраторами.
 - `starter-bot` - модуль-заготовка для бота. Он же - простейший пример. Можно брать за основу для работы над ботом.
 
-##Сборка и запуск проекта
+## Сборка и запуск проекта
 
 Сборка проекта осуществляется с помощью [Maven](https://ru.wikipedia.org/wiki/Apache_Maven).
 Шаги сборки:

starter-bot-python/README.md

@@ -0,0 +1,12 @@
+## 🐍 Python Starter bot
+
+### Как использовать
+
+[`main.py`](main.py) - настройки подключения к серверу
+
+[`bot.py`](bot.py) - код бота и его параметры
+
+Требования: **Python 3.10+**
+
+---
+_[Артем **nGragas** Корников](https://t.me/Rush_iam) для [Croc Bot Battle](https://brainz.croc.ru/hello-work)_

starter-bot-python/bot.py

@@ -0,0 +1,38 @@
+from client.bot_base import BotBase
+from client.message.extra_types import Mode
+from client.message.messages import MatchStarted, Update
+
+# Параметры регистрации бота на сервере
+bot_name = 'SuperStarter'
+bot_secret = ''
+mode = Mode.FRIENDLY
+
+
+class Bot(BotBase):
+    # Старт
+    def on_match_start(self, match_info: MatchStarted):
+        # Правила матча
+        self.match_info = match_info
+        self.id = match_info.your_id
+        print(match_info)
+        print(f'Матч стартовал! Бот <{self.name}> готов')
+
+    # Каждый ход
+    def on_update(self, update: Update) -> tuple[int, int]:
+        # Данные раунда: что бот "видит"
+        round_number = update.round
+        coins = update.coin
+        blocks = update.block
+        my_bot = next((bot for bot in update.bot if bot.id == self.id), None)
+        opponents = [bot for bot in update.bot if bot.id != self.id]
+
+        # Выбираем направление движения
+        import random
+        dx = random.choice([-1, 0, 1])
+        dy = random.choice([-1, 0, 1])
+
+        return dx, dy  # Отправляем ход серверу
+
+    # Конец матча
+    def on_match_over(self) -> None:
+        print('Матч окончен')

starter-bot-python/client/__init__.py

@@ -0,0 +1,26 @@
+from dataclasses import dataclass, field
+from typing import TypeVar
+
+from client.message.extra_types import Mode
+from client.message.messages import MatchStarted, Update
+
+
+BotImpl = TypeVar('BotImpl', bound='BotBase')
+
+
+@dataclass
+class BotBase:
+    name: str
+    secret: str = None
+    mode: Mode = Mode.FRIENDLY
+    match_info: MatchStarted = field(init=False)
+    id: int = field(init=False)
+
+    def on_match_start(self, match_info: MatchStarted):
+        raise NotImplementedError
+
+    def on_update(self, update: Update) -> tuple[int, int]:
+        raise NotImplementedError
+
+    def on_match_over(self) -> None:
+        raise NotImplementedError

starter-bot-python/client/bot_base.py

@@ -0,0 +1,21 @@
+from .bot_base import BotImpl
+from .client import HypernullClient
+from .message import messages
+
+
+class BotMatchRunner:
+    def __init__(self, bot: BotImpl, client: HypernullClient):
+        self.bot = bot
+        self.client = client
+
+    def run(self) -> None:
+        self.client.register(self.bot)
+
+        match_info: messages.MatchStarted = self.client.get()
+        self.bot.on_match_start(match_info)
+
+        while update := self.client.get_update():
+            dx, dy = self.bot.on_update(update)
+            self.client.move(dx, dy)
+
+        self.bot.on_match_over()

starter-bot-python/client/bot_match_runner.py

@@ -0,0 +1,48 @@
+from .bot_base import BotImpl
+from .socket_session import SocketSession
+from .message import factory, messages, extra_types
+
+
+class HypernullClient:
+    version: int = 1
+
+    def __init__(self, host: str = 'localhost', port: int = 2021):
+        self.session = SocketSession(host, port)
+        msg = self.get()
+        if not isinstance(msg, messages.Hello):
+            raise Exception(
+                f'Wanted message {messages.Hello.__name__}, got: {type(msg)}'
+            )
+
+        if msg.protocol_version != self.version:
+            raise Exception(
+                f'Client v{self.version}, but Server v{msg.protocol_version}'
+            )
+
+    def get(self) -> factory.Message:
+        data = self.session.read()
+        return factory.MessageFactory.load(data)
+
+    def send(self, msg: messages.MessageBase) -> None:
+        data = msg.dump()
+        self.session.write(data)
+
+    def register(self, bot: BotImpl) -> None:
+        register = messages.Register(
+            bot_name=bot.name,
+            bot_secret=bot.secret,
+            mode=bot.mode,
+        )
+        self.send(register)
+
+    def get_update(self) -> messages.Update | None:
+        update: messages.Update | messages.MatchOver = self.get()
+        if isinstance(update, messages.MatchOver):
+            return None
+        return update
+
+    def move(self, dx: int, dy: int) -> None:
+        move = messages.Move(
+            offset=extra_types.XY(dx, dy)
+        )
+        self.send(move)

starter-bot-python/client/client.py

@@ -0,0 +1,18 @@
+from dataclasses import dataclass, asdict
+
+
+@dataclass
+class MessageBase:
+    @classmethod
+    def type(cls) -> str:
+        return cls.__name__.lower()
+
+    def dump(self) -> str:
+        command = self.type()
+        params = '\n'.join(
+            f'{k} {" ".join(map(str, v.values())) if isinstance(v, dict) else v}'
+            for k, v in asdict(self).items() if v not in [None, '']
+        )
+        return f'{command}\n' \
+               f'{params}\n' \
+               f'end\n'

starter-bot-python/client/message/__init__.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass
+from enum import Enum
+
+
+class Mode(str, Enum):
+    FRIENDLY = 'FRIENDLY'
+    DEATHMATCH = 'DEATHMATCH'
+
+
+@dataclass
+class XY:
+    x: int
+    y: int
+
+
+@dataclass
+class BotInfo(XY):
+    coins: int
+    id: int