22import sys
33from struct import Struct , unpack
44import re
5+ from typing import List , Union
6+ from io import BytesIO
57
68reNot0 = re .compile (b"(.*?)\x00 " )
79
@@ -41,13 +43,16 @@ class EndianBinaryReader:
4143 Position : int
4244 BaseOffset : int
4345
44- def __new__ (cls , item , endian = ">" , offset = 0 ):
46+ def __new__ (
47+ cls ,
48+ item : Union [bytes , bytearray , memoryview , BytesIO ],
49+ endian : str = ">" ,
50+ offset : int = 0 ,
51+ ):
4552 if isinstance (item , (bytes , bytearray , memoryview )):
4653 obj = super (EndianBinaryReader , cls ).__new__ (EndianBinaryReader_Memoryview )
4754 else :
48- obj = super (EndianBinaryReader , cls ).__new__ (
49- EndianBinaryReader_Streamable
50- )
55+ obj = super (EndianBinaryReader , cls ).__new__ (EndianBinaryReader_Streamable )
5156 obj .__init__ (item , endian )
5257 return obj
5358
@@ -121,7 +126,7 @@ def read_string_to_null(self, max_length=32767) -> str:
121126 raise ValueError ("Unterminated string: %r" % ret )
122127 return b"" .join (ret ).decode ("utf8" , "surrogateescape" )
123128
124- def read_aligned_string (self ):
129+ def read_aligned_string (self ) -> str :
125130 length = self .read_int ()
126131 if 0 < length <= self .Length - self .Position :
127132 string_data = bytes (self .read_bytes (length ))
@@ -133,89 +138,89 @@ def read_aligned_string(self):
133138 def align_stream (self , alignment = 4 ):
134139 self .Position += (alignment - self .Position % alignment ) % alignment
135140
136- def read_quaternion (self ):
141+ def read_quaternion (self ) -> Quaternion :
137142 return Quaternion (
138143 self .read_float (), self .read_float (), self .read_float (), self .read_float ()
139144 )
140145
141- def read_vector2 (self ):
146+ def read_vector2 (self ) -> Vector2 :
142147 return Vector2 (self .read_float (), self .read_float ())
143148
144- def read_vector3 (self ):
149+ def read_vector3 (self ) -> Vector3 :
145150 return Vector3 (self .read_float (), self .read_float (), self .read_float ())
146151
147- def read_vector4 (self ):
152+ def read_vector4 (self ) -> Vector4 :
148153 return Vector4 (
149154 self .read_float (), self .read_float (), self .read_float (), self .read_float ()
150155 )
151156
152- def read_rectangle_f (self ):
157+ def read_rectangle_f (self ) -> Rectangle :
153158 return Rectangle (
154159 self .read_float (), self .read_float (), self .read_float (), self .read_float ()
155160 )
156161
157- def read_color4 (self ):
162+ def read_color4 (self ) -> Color :
158163 return Color (
159164 self .read_float (), self .read_float (), self .read_float (), self .read_float ()
160165 )
161166
162- def read_byte_array (self ):
167+ def read_byte_array (self ) -> bytes :
163168 return self .read (self .read_int ())
164169
165- def read_matrix (self ):
170+ def read_matrix (self ) -> Matrix4x4 :
166171 return Matrix4x4 (self .read_float_array (16 ))
167172
168- def read_array (self , command , length : int ):
173+ def read_array (self , command , length : int ) -> list :
169174 return [command () for _ in range (length )]
170175
171- def read_array_struct (self , param : str , length : int = None ):
176+ def read_array_struct (self , param : str , length : int = None ) -> list :
172177 if length is None :
173178 length = self .read_int ()
174179 struct = Struct (f"{ self .endian } { length } { param } " )
175180 return struct .unpack (self .read (struct .size ))
176181
177- def read_boolean_array (self , length : int = None ):
182+ def read_boolean_array (self , length : int = None ) -> List [ bool ] :
178183 return self .read_array_struct ("?" , length )
179184
180- def read_u_short_array (self , length : int = None ):
185+ def read_u_short_array (self , length : int = None ) -> List [ int ] :
181186 return self .read_array_struct ("h" , length )
182187
183- def read_short_array (self , length : int = None ):
188+ def read_short_array (self , length : int = None ) -> List [ int ] :
184189 return self .read_array_struct ("H" , length )
185190
186- def read_int_array (self , length : int = None ):
191+ def read_int_array (self , length : int = None ) -> List [ int ] :
187192 return self .read_array_struct ("i" , length )
188193
189- def read_u_int_array (self , length : int = None ):
194+ def read_u_int_array (self , length : int = None ) -> List [ int ] :
190195 return self .read_array_struct ("I" , length )
191196
192- def read_u_int_array_array (self , length : int = None ):
197+ def read_u_int_array_array (self , length : int = None ) -> List [ List [ int ]] :
193198 return self .read_array (
194199 self .read_u_int_array , length if length is not None else self .read_int ()
195200 )
196201
197- def read_float_array (self , length : int = None ):
202+ def read_float_array (self , length : int = None ) -> List [ float ] :
198203 return self .read_array_struct ("f" , length )
199204
200- def read_string_array (self ):
205+ def read_string_array (self ) -> List [ str ] :
201206 return self .read_array (self .read_aligned_string , self .read_int ())
202207
203- def read_vector2_array (self ):
208+ def read_vector2_array (self ) -> List [ Vector2 ] :
204209 return self .read_array (self .read_vector2 , self .read_int ())
205210
206- def read_vector4_array (self ):
211+ def read_vector4_array (self ) -> List [ Vector4 ] :
207212 return self .read_array (self .read_vector4 , self .read_int ())
208213
209- def read_matrix_array (self ):
214+ def read_matrix_array (self ) -> List [ Matrix4x4 ] :
210215 return self .read_array (self .read_matrix , self .read_int ())
211216
212- def real_offset (self ):
217+ def real_offset (self ) -> int :
213218 """Returns offset in the underlying file.
214219 (Not working with unpacked streams.)
215220 """
216221 return self .BaseOffset + self .Position
217222
218- def read_the_rest (self , obj_start , obj_size ) :
223+ def read_the_rest (self , obj_start : int , obj_size : int ) -> bytes :
219224 """Returns the rest of the current reader bytes."""
220225 return self .read_bytes (obj_size - (self .Position - obj_start ))
221226
@@ -235,7 +240,7 @@ def endian(self):
235240 return self ._endian
236241
237242 @endian .setter
238- def endian (self , value ):
243+ def endian (self , value : str ):
239244 if value not in ("<" , ">" ):
240245 raise ValueError ("Invalid endian" )
241246 if value != self ._endian :
0 commit comments