mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-18 05:12:45 +01:00
Code Issues Projects Releases Wiki Activity

pyln: Adds type annotations to zbase32 functions

Browse Source
This commit is contained in:
Sergi Delgado Segura 2020-10-21 18:15:36 +02:00 committed by Christian Decker
parent 3779c0b6ee
commit 9de5f438c4
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
contrib/pyln-proto/pyln/proto/zbase32.py
View File

@ -1,4 +1,5 @@
import bitstring # type: ignore import bitstring # type: ignore
from typing import Union
zbase32_chars = b'ybndrfg8ejkmcpqxot1uwisza345h769' zbase32_chars = b'ybndrfg8ejkmcpqxot1uwisza345h769'
@ -23,7 +24,7 @@ zbase32_revchars = [
] ]
def _message_to_bitarray(message): def _message_to_bitarray(message: bytes) -> bitstring.ConstBitStream:
"""Encodes a message as a bitarray with length multiple of 5.""" """Encodes a message as a bitarray with length multiple of 5."""
barr = bitstring.ConstBitStream(message) barr = bitstring.ConstBitStream(message)
padding_len = 5 - (len(barr) % 5) padding_len = 5 - (len(barr) % 5)
@ -42,7 +43,7 @@ def _bitarray_to_message(barr):
return barr.bytes return barr.bytes
def _bitarray_to_u5(barr): def _bitarray_to_u5(barr: bitstring.ConstBitStream) -> list:
"""Converts a bitarray in a list of uint5.""" """Converts a bitarray in a list of uint5."""
ret = [] ret = []
while barr.pos != barr.len: while barr.pos != barr.len:
@ -50,7 +51,7 @@ def _bitarray_to_u5(barr):
return ret return ret
def _u5_to_bitarray(arr): def _u5_to_bitarray(arr: list) -> bitstring.BitArray:
"""Converts a list of uint5 values to a bitarray.""" """Converts a list of uint5 values to a bitarray."""
ret = bitstring.BitArray() ret = bitstring.BitArray()
for a in arr: for a in arr:
@ -58,7 +59,7 @@ def _u5_to_bitarray(arr):
return ret return ret
def is_zbase32_encoded(message): def is_zbase32_encoded(message: Union[str, bytes]) -> bool:
"""Checks if a message is zbase32 encoded.""" """Checks if a message is zbase32 encoded."""
if isinstance(message, str): if isinstance(message, str):
message = message.encode("ASCII") message = message.encode("ASCII")
@ -67,7 +68,7 @@ def is_zbase32_encoded(message):
return set(message).issubset(zbase32_chars) return set(message).issubset(zbase32_chars)
def encode(message): def encode(message: Union[str, bytes]) -> bytes:
"""Encodes a message (str or bytes) to zbase32.""" """Encodes a message (str or bytes) to zbase32."""
if isinstance(message, str): if isinstance(message, str):
message = message.encode('ASCII') message = message.encode('ASCII')
@ -80,7 +81,7 @@ def encode(message):
return bytes(res) return bytes(res)
def decode(message): def decode(message: Union[str, bytes]) -> bytes:
"""Decodes a message (str or bytes) from zbase32.""" """Decodes a message (str or bytes) from zbase32."""
if isinstance(message, str): if isinstance(message, str):
message = message.encode('ASCII') message = message.encode('ASCII')