Skip to content

Commit

Permalink
[script.module.websocket] 1.6.4 (#2539)
Browse files Browse the repository at this point in the history
  • Loading branch information
L2501 authored Dec 2, 2023
1 parent ea0a09f commit f30218f
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 36 deletions.
2 changes: 1 addition & 1 deletion script.module.websocket/addon.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="script.module.websocket" name="websocket-client" version="1.6.2" provider-name="liris">
<addon id="script.module.websocket" name="websocket-client" version="1.6.4" provider-name="liris">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
Expand Down
2 changes: 1 addition & 1 deletion script.module.websocket/lib/websocket/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
from ._logging import *
from ._socket import *

__version__ = "1.6.2"
__version__ = "1.6.4"
24 changes: 13 additions & 11 deletions script.module.websocket/lib/websocket/_abnf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
import struct
import sys

from threading import Lock
from typing import Callable, Union

from ._exceptions import *
from ._utils import validate_utf8
from threading import Lock

"""
_abnf.py
Expand Down Expand Up @@ -42,9 +44,9 @@ def _mask(_m, _d) -> bytes:

def _mask(mask_value: array.array, data_value: array.array) -> bytes:
datalen = len(data_value)
data_value = int.from_bytes(data_value, native_byteorder)
mask_value = int.from_bytes(mask_value * (datalen // 4) + mask_value[: datalen % 4], native_byteorder)
return (data_value ^ mask_value).to_bytes(datalen, native_byteorder)
int_data_value = int.from_bytes(data_value, native_byteorder)
int_mask_value = int.from_bytes(mask_value * (datalen // 4) + mask_value[: datalen % 4], native_byteorder)
return (int_data_value ^ int_mask_value).to_bytes(datalen, native_byteorder)


__all__ = [
Expand Down Expand Up @@ -132,7 +134,7 @@ class ABNF:
LENGTH_63 = 1 << 63

def __init__(self, fin: int = 0, rsv1: int = 0, rsv2: int = 0, rsv3: int = 0,
opcode: int = OPCODE_TEXT, mask: int = 1, data: str or bytes = "") -> None:
opcode: int = OPCODE_TEXT, mask: int = 1, data: Union[str, bytes] = "") -> None:
"""
Constructor for ABNF. Please check RFC for arguments.
"""
Expand Down Expand Up @@ -187,7 +189,7 @@ def __str__(self) -> str:
+ " data=" + str(self.data)

@staticmethod
def create_frame(data: str, opcode: int, fin: int = 1) -> 'ABNF':
def create_frame(data: Union[bytes, str], opcode: int, fin: int = 1) -> 'ABNF':
"""
Create frame to send text, binary and other data.
Expand Down Expand Up @@ -237,7 +239,7 @@ def format(self) -> bytes:
mask_key = self.get_mask_key(4)
return frame_header + self._get_masked(mask_key)

def _get_masked(self, mask_key: str or bytes) -> bytes:
def _get_masked(self, mask_key: Union[str, bytes]) -> bytes:
s = ABNF.mask(mask_key, self.data)

if isinstance(mask_key, str):
Expand All @@ -246,7 +248,7 @@ def _get_masked(self, mask_key: str or bytes) -> bytes:
return mask_key + s

@staticmethod
def mask(mask_key: str or bytes, data: str or bytes) -> bytes:
def mask(mask_key: Union[str, bytes], data: Union[str, bytes]) -> bytes:
"""
Mask or unmask data. Just do xor for each byte
Expand All @@ -273,7 +275,7 @@ class frame_buffer:
_HEADER_MASK_INDEX = 5
_HEADER_LENGTH_INDEX = 6

def __init__(self, recv_fn: int, skip_utf8_validation: bool) -> None:
def __init__(self, recv_fn: Callable[[int], int], skip_utf8_validation: bool) -> None:
self.recv = recv_fn
self.skip_utf8_validation = skip_utf8_validation
# Buffers over the packets from the layer beneath until desired amount
Expand Down Expand Up @@ -304,7 +306,7 @@ def recv_header(self) -> None:

self.header = (fin, rsv1, rsv2, rsv3, opcode, has_mask, length_bits)

def has_mask(self) -> bool or int:
def has_mask(self) -> Union[bool, int]:
if not self.header:
return False
return self.header[frame_buffer._HEADER_MASK_INDEX]
Expand Down Expand Up @@ -410,7 +412,7 @@ def add(self, frame: ABNF) -> None:
if frame.fin:
self.recving_frames = None

def is_fire(self, frame: ABNF) -> bool or int:
def is_fire(self, frame: ABNF) -> Union[bool, int]:
return frame.fin or self.fire_cont_frame

def extract(self, frame: ABNF) -> list:
Expand Down
10 changes: 5 additions & 5 deletions script.module.websocket/lib/websocket/_app.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import inspect
import selectors
import socket
import sys
import threading
import time
import traceback
import socket

from typing import Callable, Any
from typing import Any, Callable, Optional, Union

from . import _logging
from ._abnf import ABNF
Expand Down Expand Up @@ -139,7 +139,7 @@ class WebSocketApp:
Higher level of APIs are provided. The interface is like JavaScript WebSocket object.
"""

def __init__(self, url: str, header: list or dict or Callable = None,
def __init__(self, url: str, header: Union[list, dict, Callable] = None,
on_open: Callable = None, on_message: Callable = None, on_error: Callable = None,
on_close: Callable = None, on_ping: Callable = None, on_pong: Callable = None,
on_cont_message: Callable = None,
Expand Down Expand Up @@ -289,9 +289,9 @@ def _send_ping(self) -> None:
_logging.debug("Failed to send ping: {err}".format(err=e))

def run_forever(self, sockopt: tuple = None, sslopt: dict = None,
ping_interval: float = 0, ping_timeout: float or None = None,
ping_interval: float = 0, ping_timeout: Optional[float] = None,
ping_payload: str = "",
http_proxy_host: str = None, http_proxy_port: int or str = None,
http_proxy_host: str = None, http_proxy_port: Union[int, str] = None,
http_no_proxy: list = None, http_proxy_auth: tuple = None,
http_proxy_timeout: float = None,
skip_utf8_validation: bool = False,
Expand Down
4 changes: 3 additions & 1 deletion script.module.websocket/lib/websocket/_cookiejar.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import http.cookies

from typing import Optional

"""
_cookiejar.py
websocket - WebSocket client library for Python
Expand All @@ -24,7 +26,7 @@ class SimpleCookieJar:
def __init__(self) -> None:
self.jar = dict()

def add(self, set_cookie: str) -> None:
def add(self, set_cookie: Optional[str]) -> None:
if set_cookie:
simpleCookie = http.cookies.SimpleCookie(set_cookie)

Expand Down
14 changes: 8 additions & 6 deletions script.module.websocket/lib/websocket/_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import threading
import time

from typing import Optional, Union

# websocket modules
from ._abnf import *
from ._exceptions import *
Expand Down Expand Up @@ -144,7 +146,7 @@ def gettimeout(self) -> float:
"""
return self.sock_opt.timeout

def settimeout(self, timeout: float):
def settimeout(self, timeout: Optional[float]):
"""
Set the timeout to the websocket.
Expand Down Expand Up @@ -265,7 +267,7 @@ def connect(self, url, **options):
self.sock = None
raise

def send(self, payload: bytes or str, opcode: int = ABNF.OPCODE_TEXT) -> int:
def send(self, payload: Union[bytes, str], opcode: int = ABNF.OPCODE_TEXT) -> int:
"""
Send the data as string.
Expand Down Expand Up @@ -324,7 +326,7 @@ def send_binary(self, payload: bytes) -> int:
"""
return self.send(payload, ABNF.OPCODE_BINARY)

def ping(self, payload: str or bytes = ""):
def ping(self, payload: Union[str, bytes] = ""):
"""
Send ping data.
Expand All @@ -337,7 +339,7 @@ def ping(self, payload: str or bytes = ""):
payload = payload.encode("utf-8")
self.send(payload, ABNF.OPCODE_PING)

def pong(self, payload: str or bytes = ""):
def pong(self, payload: Union[str, bytes] = ""):
"""
Send pong data.
Expand All @@ -350,7 +352,7 @@ def pong(self, payload: str or bytes = ""):
payload = payload.encode("utf-8")
self.send(payload, ABNF.OPCODE_PONG)

def recv(self) -> str or bytes:
def recv(self) -> Union[str, bytes]:
"""
Receive string data(byte array) from the server.
Expand Down Expand Up @@ -521,7 +523,7 @@ def shutdown(self):
self.sock = None
self.connected = False

def _send(self, data: str or bytes):
def _send(self, data: Union[str, bytes]):
return send(self.sock, data)

def _recv(self, bufsize):
Expand Down
2 changes: 1 addition & 1 deletion script.module.websocket/lib/websocket/_handshake.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
# websocket supported version.
VERSION = 13

SUPPORTED_REDIRECT_STATUSES = (HTTPStatus.MOVED_PERMANENTLY, HTTPStatus.FOUND, HTTPStatus.SEE_OTHER,)
SUPPORTED_REDIRECT_STATUSES = (HTTPStatus.MOVED_PERMANENTLY, HTTPStatus.FOUND, HTTPStatus.SEE_OTHER, HTTPStatus.TEMPORARY_REDIRECT, HTTPStatus.PERMANENT_REDIRECT)
SUCCESS_STATUSES = SUPPORTED_REDIRECT_STATUSES + (HTTPStatus.SWITCHING_PROTOCOLS,)

CookieJar = SimpleCookieJar()
Expand Down
8 changes: 5 additions & 3 deletions script.module.websocket/lib/websocket/_socket.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
import selectors
import socket

from typing import Union

from ._exceptions import *
from ._ssl_compat import *
from ._utils import *
Expand Down Expand Up @@ -53,7 +55,7 @@ def __init__(self, sockopt: list, sslopt: dict) -> None:
self.timeout = None


def setdefaulttimeout(timeout: int or float) -> None:
def setdefaulttimeout(timeout: Union[int, float, None]) -> None:
"""
Set the global timeout setting to connect.
Expand All @@ -66,7 +68,7 @@ def setdefaulttimeout(timeout: int or float) -> None:
_default_timeout = timeout


def getdefaulttimeout() -> int or float:
def getdefaulttimeout() -> Union[int, float, None]:
"""
Get default timeout
Expand Down Expand Up @@ -135,7 +137,7 @@ def recv_line(sock: socket.socket) -> bytes:
return b''.join(line)


def send(sock: socket.socket, data: bytes) -> int:
def send(sock: socket.socket, data: Union[bytes, str]) -> int:
if isinstance(data, str):
data = data.encode('utf-8')

Expand Down
7 changes: 4 additions & 3 deletions script.module.websocket/lib/websocket/_url.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import socket
import struct

from typing import Optional
from urllib.parse import unquote, urlparse

"""
Expand Down Expand Up @@ -101,7 +102,7 @@ def _is_address_in_network(ip: str, net: str) -> bool:
return ipaddr & netmask == netaddr


def _is_no_proxy_host(hostname: str, no_proxy: list) -> bool:
def _is_no_proxy_host(hostname: str, no_proxy: Optional[list]) -> bool:
if not no_proxy:
v = os.environ.get("no_proxy", os.environ.get("NO_PROXY", "")).replace(" ", "")
if v:
Expand All @@ -122,8 +123,8 @@ def _is_no_proxy_host(hostname: str, no_proxy: list) -> bool:


def get_proxy_info(
hostname: str, is_secure: bool, proxy_host: str = None, proxy_port: int = 0, proxy_auth: tuple = None,
no_proxy: list = None, proxy_type: str = 'http') -> tuple:
hostname: str, is_secure: bool, proxy_host: Optional[str] = None, proxy_port: int = 0, proxy_auth: Optional[tuple] = None,
no_proxy: Optional[list] = None, proxy_type: str = 'http') -> tuple:
"""
Try to retrieve proxy host and port from environment
if not provided in options.
Expand Down
10 changes: 6 additions & 4 deletions script.module.websocket/lib/websocket/_utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from typing import Union

"""
_url.py
websocket - WebSocket client library for Python
Expand Down Expand Up @@ -72,7 +74,7 @@ def _decode(state: int, codep: int, ch: int) -> tuple:

return state, codep

def _validate_utf8(utfbytes: str or bytes) -> bool:
def _validate_utf8(utfbytes: Union[str, bytes]) -> bool:
state = _UTF8_ACCEPT
codep = 0
for i in utfbytes:
Expand All @@ -83,7 +85,7 @@ def _validate_utf8(utfbytes: str or bytes) -> bool:
return True


def validate_utf8(utfbytes: str or bytes) -> bool:
def validate_utf8(utfbytes: Union[str, bytes]) -> bool:
"""
validate utf8 byte string.
utfbytes: utf byte string to check.
Expand All @@ -92,13 +94,13 @@ def validate_utf8(utfbytes: str or bytes) -> bool:
return _validate_utf8(utfbytes)


def extract_err_message(exception: Exception) -> str or None:
def extract_err_message(exception: Exception) -> Union[str, None]:
if exception.args:
return exception.args[0]
else:
return None


def extract_error_code(exception: Exception) -> int or None:
def extract_error_code(exception: Exception) -> Union[int, None]:
if exception.args and len(exception.args) > 1:
return exception.args[0] if isinstance(exception.args[0], int) else None

0 comments on commit f30218f

Please sign in to comment.