hyperpy/simple-message-channels
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add missing docstrings

Browse Source
This commit is contained in:
Luke Murphy 2020-08-05 07:00:41 +02:00
parent 39107505c2
commit 7312a1710e
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
simple_message_channels/smc.py
View File

@ -60,7 +60,11 @@ class SimpleMessageChannel:
self._read_msg(data, offset)
def _read_msg(self, data: bytes, offset: int) -> int:
"""TODO."""
"""Read a message chunk.
:param data: the message data
:param offset: the bytes offset
"""
free = len(data) - offset
if free >= self.length:
@ -79,7 +83,11 @@ class SimpleMessageChannel:
return len(data)
def _read_varint(self, data: bytes, offset: int) -> int:
"""TODO."""
"""Read a varint from a byte stream.
:param data: the message data
:param offset: the bytes offset
"""
while offset < len(data):
self.varint += (data[offset] & 127) * self.factor
self.consumed += 1
@ -96,7 +104,11 @@ class SimpleMessageChannel:
return len(data)
def _next_state(self, data: bytes, offset: int) -> bool:
"""TODO."""
"""Calculate the next state.
:param data: the message data
:param offset: the bytes offset
"""
if self.state == 0:
self.state = 1
self.factor = 1