mirror
/
Yepoleb.python-a2s
mirror of https://github.com/Yepoleb/python-a2s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Improve accuracy of type hints

typing
Gabriel Huber 2 years ago
parent
1ddf149e50
commit
af7f7cf9d0
2 changed files with 32 additions and 27 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 53
      a2s/info.py
  2. 6
      a2s/players.py

53
a2s/info.py
View File

@ -1,6 +1,6 @@
from __future__ import annotations from __future__ import annotations
from typing import Optional, Tuple, Union from typing import Optional, Tuple, Union, TypeAlias
from a2s.a2s_async import request_async from a2s.a2s_async import request_async
from a2s.a2s_sync import request_sync from a2s.a2s_sync import request_sync
@ -14,22 +14,24 @@ from .byteio import ByteReader
A2S_INFO_RESPONSE = 0x49 A2S_INFO_RESPONSE = 0x49
A2S_INFO_RESPONSE_LEGACY = 0x6D A2S_INFO_RESPONSE_LEGACY = 0x6D
StrOrBytes: TypeAlias = Union[str, bytes]
class SourceInfo(metaclass=DataclsMeta): class SourceInfo(metaclass=DataclsMeta):
protocol: int protocol: int
"""Protocol version used by the server""" """Protocol version used by the server"""
server_name: Union[str, bytes] server_name: StrOrBytes
"""Display name of the server""" """Display name of the server"""
map_name: Union[str, bytes] map_name: StrOrBytes
"""The currently loaded map""" """The currently loaded map"""
folder: Union[str, bytes] folder: StrOrBytes
"""Name of the game directory""" """Name of the game directory"""
game: Union[str, bytes] game: StrOrBytes
"""Name of the game""" """Name of the game"""
app_id: int app_id: int
@ -44,13 +46,13 @@ class SourceInfo(metaclass=DataclsMeta):
bot_count: int bot_count: int
"""Number of bots on the server""" """Number of bots on the server"""
server_type: Union[str, bytes] server_type: StrOrBytes
"""Type of the server: """Type of the server:
'd': Dedicated server 'd': Dedicated server
'l': Non-dedicated server 'l': Non-dedicated server
'p': SourceTV relay (proxy)""" 'p': SourceTV relay (proxy)"""
platform: Union[str, bytes] platform: StrOrBytes
"""Operating system of the server """Operating system of the server
'l', 'w', 'm' for Linux, Windows, macOS""" 'l', 'w', 'm' for Linux, Windows, macOS"""
@ -60,7 +62,7 @@ class SourceInfo(metaclass=DataclsMeta):
vac_enabled: bool vac_enabled: bool
"""Server has VAC enabled""" """Server has VAC enabled"""
version: Union[str, bytes] version: StrOrBytes
"""Version of the server software""" """Version of the server software"""
# Optional: # Optional:
@ -68,22 +70,22 @@ class SourceInfo(metaclass=DataclsMeta):
"""Extra data field, used to indicate if extra values are """Extra data field, used to indicate if extra values are
included in the response""" included in the response"""
port: int port: Optional[int]
"""Port of the game server.""" """Port of the game server."""
steam_id: int steam_id: Optional[int]
"""Steam ID of the server""" """Steam ID of the server"""
stv_port: int stv_port: Optional[int]
"""Port of the SourceTV server""" """Port of the SourceTV server"""
stv_name: Union[str, bytes] stv_name: Optional[StrOrBytes]
"""Name of the SourceTV server""" """Name of the SourceTV server"""
keywords: Union[str, bytes] keywords: Optional[StrOrBytes]
"""Tags that describe the gamemode being played""" """Tags that describe the gamemode being played"""
game_id: int game_id: Optional[int]
"""Game ID for games that have an app ID too high for 16bit.""" """Game ID for games that have an app ID too high for 16bit."""
# Client determined values: # Client determined values:
@ -112,19 +114,19 @@ class SourceInfo(metaclass=DataclsMeta):
class GoldSrcInfo(metaclass=DataclsMeta): class GoldSrcInfo(metaclass=DataclsMeta):
address: Union[str, bytes] address: StrOrBytes
"""IP Address and port of the server""" """IP Address and port of the server"""
server_name: Union[str, bytes] server_name: StrOrBytes
"""Display name of the server""" """Display name of the server"""
map_name: Union[str, bytes] map_name: StrOrBytes
"""The currently loaded map""" """The currently loaded map"""
folder: Union[str, bytes] folder: StrOrBytes
"""Name of the game directory""" """Name of the game directory"""
game: Union[str, bytes] game: StrOrBytes
"""Name of the game""" """Name of the game"""
player_count: int player_count: int
@ -136,13 +138,13 @@ class GoldSrcInfo(metaclass=DataclsMeta):
protocol: int protocol: int
"""Protocol version used by the server""" """Protocol version used by the server"""
server_type: Union[str, bytes] server_type: StrOrBytes
"""Type of the server: """Type of the server:
'd': Dedicated server 'd': Dedicated server
'l': Non-dedicated server 'l': Non-dedicated server
'p': SourceTV relay (proxy)""" 'p': SourceTV relay (proxy)"""
platform: Union[str, bytes] platform: StrOrBytes
"""Operating system of the server """Operating system of the server
'l', 'w' for Linux and Windows""" 'l', 'w' for Linux and Windows"""
@ -159,16 +161,16 @@ class GoldSrcInfo(metaclass=DataclsMeta):
"""Number of bots on the server""" """Number of bots on the server"""
# Optional: # Optional:
mod_website: Union[str, bytes] mod_website: Optional[StrOrBytes]
"""URL to the mod website""" """URL to the mod website"""
mod_download: Union[str, bytes] mod_download: Optional[StrOrBytes]
"""URL to download the mod""" """URL to download the mod"""
mod_version: int mod_version: Optional[int]
"""Version of the mod installed on the server""" """Version of the mod installed on the server"""
mod_size: int mod_size: Optional[int]
"""Size in bytes of the mod""" """Size in bytes of the mod"""
multiplayer_only: bool = False multiplayer_only: bool = False
@ -216,6 +218,7 @@ class InfoProtocol(A2SProtocol):
def deserialize_response( def deserialize_response(
reader: ByteReader, response_type: int, ping: Optional[float] reader: ByteReader, response_type: int, ping: Optional[float]
) -> Union[SourceInfo, GoldSrcInfo]: ) -> Union[SourceInfo, GoldSrcInfo]:
resp: Union[SourceInfo, GoldSrcInfo]
if response_type == A2S_INFO_RESPONSE: if response_type == A2S_INFO_RESPONSE:
resp = parse_source(reader) resp = parse_source(reader)
elif response_type == A2S_INFO_RESPONSE_LEGACY: elif response_type == A2S_INFO_RESPONSE_LEGACY:

6
a2s/players.py
View File

@ -1,4 +1,4 @@
from typing import List, Optional, Tuple from typing import List, Optional, Tuple, Union, TypeAlias
from a2s.a2s_async import request_async from a2s.a2s_async import request_async
from a2s.a2s_protocol import A2SProtocol from a2s.a2s_protocol import A2SProtocol
@ -9,12 +9,14 @@ from a2s.defaults import DEFAULT_ENCODING, DEFAULT_TIMEOUT
A2S_PLAYER_RESPONSE = 0x44 A2S_PLAYER_RESPONSE = 0x44
StrOrBytes: TypeAlias = Union[str, bytes]
class Player(metaclass=DataclsMeta): class Player(metaclass=DataclsMeta):
index: int index: int
"""Apparently an entry index, but seems to be always 0""" """Apparently an entry index, but seems to be always 0"""
name: str name: StrOrBytes
"""Name of the player""" """Name of the player"""
score: int score: int

Write Preview
Loading…
Cancel
Save