Skip to content

Commit 508c913

Browse files
committed
Update __ws_client.py
1 parent a6b202d commit 508c913

1 file changed

Lines changed: 23 additions & 2 deletions

File tree

src/mistapi/websockets/__ws_client.py

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@
2929
class _HeaderRedactFilter(logging.Filter):
3030
"""Redact Authorization and Cookie values from websocket-client log output."""
3131

32-
_REDACT = re.compile(r"((?:Authorization|Cookie):\s*)\S+", re.IGNORECASE)
32+
_REDACT = re.compile(r"((?:Authorization|Cookie):\s*).+", re.IGNORECASE)
3333

3434
def filter(self, record: logging.LogRecord) -> bool:
3535
rendered = record.getMessage()
3636
redacted = self._REDACT.sub(r"\1****", rendered)
3737
if redacted != rendered:
3838
record.msg = redacted
39-
record.args = None
39+
record.args = ()
4040
return True
4141

4242

@@ -48,6 +48,25 @@ def filter(self, record: logging.LogRecord) -> bool:
4848
from mistapi import APISession
4949

5050

51+
#: Shared parameter documentation for all WebSocket channel subclasses.
52+
_COMMON_WS_PARAMS_DOC = """\
53+
ping_interval : int, default 30
54+
Interval in seconds to send WebSocket ping frames (keep-alive).
55+
ping_timeout : int, default 10
56+
Time in seconds to wait for a ping response before considering the connection dead.
57+
auto_reconnect : bool, default False
58+
Automatically reconnect on unexpected disconnections using exponential backoff.
59+
max_reconnect_attempts : int, default 5
60+
Maximum number of reconnect attempts before giving up.
61+
reconnect_backoff : float, default 2.0
62+
Base backoff delay in seconds. Doubles after each failed attempt.
63+
queue_maxsize : int, default 0
64+
Maximum number of messages buffered in the internal queue for the
65+
``receive()`` generator. ``0`` means unbounded. When set,
66+
incoming messages are dropped with a warning when the queue is
67+
full, preventing memory growth on high-frequency streams."""
68+
69+
5170
class _MistWebsocket:
5271
"""
5372
Base class for Mist API WebSocket channels.
@@ -280,6 +299,8 @@ def connect(self, run_in_background: bool = True) -> None:
280299
target=self._run_forever_safe, daemon=True
281300
)
282301
self._thread.start()
302+
else:
303+
self._thread = None
283304
if not run_in_background:
284305
self._run_forever_safe()
285306

0 commit comments

Comments
 (0)