Skip to content

Commit 33588c7

Browse files
jrtknauerjrtknauer
authored
Add stubs for s2clientprotocol (#10372)
1 parent 49a2371 commit 33588c7

13 files changed

+5653
-0
lines changed

‎stubs/s2clientprotocol/@tests/stubtest_allowlist.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# All modules ending with *_pb2 fail to import
2+
# The error message is "TypeError: Descriptors cannot be create directly"
3+
s2clientprotocol\..+_pb2

‎stubs/s2clientprotocol/METADATA.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
version = "5.*"
2+
requires = ["types-protobuf"]

‎stubs/s2clientprotocol/s2clientprotocol/build.pyi

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from subprocess import _CMD
2+
3+
def game_version() -> str: ...
4+
def git_commit_hash() -> str: ...
5+
def read_command_output(cmd: _CMD) -> list[str]: ...

‎stubs/s2clientprotocol/s2clientprotocol/common_pb2.pyi

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
"""
2+
@generated by mypy-protobuf. Do not edit manually!
3+
isort:skip_file
4+
"""
5+
import builtins
6+
import google.protobuf.descriptor
7+
import google.protobuf.internal.enum_type_wrapper
8+
import google.protobuf.message
9+
import sys
10+
import typing
11+
12+
if sys.version_info >= (3, 10):
13+
import typing as typing_extensions
14+
else:
15+
import typing_extensions
16+
17+
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
18+
19+
class _Race:
20+
ValueType = typing.NewType("ValueType", builtins.int)
21+
V: typing_extensions.TypeAlias = ValueType
22+
23+
class _RaceEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_Race.ValueType], builtins.type):
24+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
25+
NoRace: _Race.ValueType # 0
26+
Terran: _Race.ValueType # 1
27+
Zerg: _Race.ValueType # 2
28+
Protoss: _Race.ValueType # 3
29+
Random: _Race.ValueType # 4
30+
31+
class Race(_Race, metaclass=_RaceEnumTypeWrapper): ...
32+
33+
NoRace: Race.ValueType # 0
34+
Terran: Race.ValueType # 1
35+
Zerg: Race.ValueType # 2
36+
Protoss: Race.ValueType # 3
37+
Random: Race.ValueType # 4
38+
global___Race = Race
39+
40+
@typing_extensions.final
41+
class AvailableAbility(google.protobuf.message.Message):
42+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
43+
44+
ABILITY_ID_FIELD_NUMBER: builtins.int
45+
REQUIRES_POINT_FIELD_NUMBER: builtins.int
46+
ability_id: builtins.int
47+
requires_point: builtins.bool
48+
def __init__(
49+
self,
50+
*,
51+
ability_id: builtins.int | None = ...,
52+
requires_point: builtins.bool | None = ...,
53+
) -> None: ...
54+
def HasField(self, field_name: typing_extensions.Literal["ability_id", b"ability_id", "requires_point", b"requires_point"]) -> builtins.bool: ...
55+
def ClearField(self, field_name: typing_extensions.Literal["ability_id", b"ability_id", "requires_point", b"requires_point"]) -> None: ...
56+
57+
global___AvailableAbility = AvailableAbility
58+
59+
@typing_extensions.final
60+
class ImageData(google.protobuf.message.Message):
61+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
62+
63+
BITS_PER_PIXEL_FIELD_NUMBER: builtins.int
64+
SIZE_FIELD_NUMBER: builtins.int
65+
DATA_FIELD_NUMBER: builtins.int
66+
bits_per_pixel: builtins.int
67+
"""Number of bits per pixel; 8 bits for a byte etc."""
68+
@property
69+
def size(self) -> global___Size2DI:
70+
"""Dimension in pixels."""
71+
data: builtins.bytes
72+
"""Binary data; the size of this buffer in bytes is width * height * bits_per_pixel / 8."""
73+
def __init__(
74+
self,
75+
*,
76+
bits_per_pixel: builtins.int | None = ...,
77+
size: global___Size2DI | None = ...,
78+
data: builtins.bytes | None = ...,
79+
) -> None: ...
80+
def HasField(self, field_name: typing_extensions.Literal["bits_per_pixel", b"bits_per_pixel", "data", b"data", "size", b"size"]) -> builtins.bool: ...
81+
def ClearField(self, field_name: typing_extensions.Literal["bits_per_pixel", b"bits_per_pixel", "data", b"data", "size", b"size"]) -> None: ...
82+
83+
global___ImageData = ImageData
84+
85+
@typing_extensions.final
86+
class PointI(google.protobuf.message.Message):
87+
"""Point on the screen/minimap (e.g., 0..64).
88+
Note: bottom left of the screen is 0, 0.
89+
"""
90+
91+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
92+
93+
X_FIELD_NUMBER: builtins.int
94+
Y_FIELD_NUMBER: builtins.int
95+
x: builtins.int
96+
y: builtins.int
97+
def __init__(
98+
self,
99+
*,
100+
x: builtins.int | None = ...,
101+
y: builtins.int | None = ...,
102+
) -> None: ...
103+
def HasField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y"]) -> builtins.bool: ...
104+
def ClearField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y"]) -> None: ...
105+
106+
global___PointI = PointI
107+
108+
@typing_extensions.final
109+
class RectangleI(google.protobuf.message.Message):
110+
"""Screen space rectangular area."""
111+
112+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
113+
114+
P0_FIELD_NUMBER: builtins.int
115+
P1_FIELD_NUMBER: builtins.int
116+
@property
117+
def p0(self) -> global___PointI: ...
118+
@property
119+
def p1(self) -> global___PointI: ...
120+
def __init__(
121+
self,
122+
*,
123+
p0: global___PointI | None = ...,
124+
p1: global___PointI | None = ...,
125+
) -> None: ...
126+
def HasField(self, field_name: typing_extensions.Literal["p0", b"p0", "p1", b"p1"]) -> builtins.bool: ...
127+
def ClearField(self, field_name: typing_extensions.Literal["p0", b"p0", "p1", b"p1"]) -> None: ...
128+
129+
global___RectangleI = RectangleI
130+
131+
@typing_extensions.final
132+
class Point2D(google.protobuf.message.Message):
133+
"""Point on the game board, 0..255.
134+
Note: bottom left of the screen is 0, 0.
135+
"""
136+
137+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
138+
139+
X_FIELD_NUMBER: builtins.int
140+
Y_FIELD_NUMBER: builtins.int
141+
x: builtins.float
142+
y: builtins.float
143+
def __init__(
144+
self,
145+
*,
146+
x: builtins.float | None = ...,
147+
y: builtins.float | None = ...,
148+
) -> None: ...
149+
def HasField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y"]) -> builtins.bool: ...
150+
def ClearField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y"]) -> None: ...
151+
152+
global___Point2D = Point2D
153+
154+
@typing_extensions.final
155+
class Point(google.protobuf.message.Message):
156+
"""Point on the game board, 0..255.
157+
Note: bottom left of the screen is 0, 0.
158+
"""
159+
160+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
161+
162+
X_FIELD_NUMBER: builtins.int
163+
Y_FIELD_NUMBER: builtins.int
164+
Z_FIELD_NUMBER: builtins.int
165+
x: builtins.float
166+
y: builtins.float
167+
z: builtins.float
168+
def __init__(
169+
self,
170+
*,
171+
x: builtins.float | None = ...,
172+
y: builtins.float | None = ...,
173+
z: builtins.float | None = ...,
174+
) -> None: ...
175+
def HasField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y", "z", b"z"]) -> builtins.bool: ...
176+
def ClearField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y", "z", b"z"]) -> None: ...
177+
178+
global___Point = Point
179+
180+
@typing_extensions.final
181+
class Size2DI(google.protobuf.message.Message):
182+
"""Screen dimensions."""
183+
184+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
185+
186+
X_FIELD_NUMBER: builtins.int
187+
Y_FIELD_NUMBER: builtins.int
188+
x: builtins.int
189+
y: builtins.int
190+
def __init__(
191+
self,
192+
*,
193+
x: builtins.int | None = ...,
194+
y: builtins.int | None = ...,
195+
) -> None: ...
196+
def HasField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y"]) -> builtins.bool: ...
197+
def ClearField(self, field_name: typing_extensions.Literal["x", b"x", "y", b"y"]) -> None: ...
198+
199+
global___Size2DI = Size2DI

0 commit comments

Comments
 (0)