Skip to content

Commit 44607df

Browse files
committed
Specify explicitly the CloseCode type.
1 parent c2bc41b commit 44607df

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

src/websockets/asyncio/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,11 @@ async def send(
616616
else:
617617
raise TypeError("data must be str, bytes, iterable, or async iterable")
618618

619-
async def close(self, code: int = 1000, reason: str = "") -> None:
619+
async def close(
620+
self,
621+
code: CloseCode | int = CloseCode.NORMAL_CLOSURE,
622+
reason: str = "",
623+
) -> None:
620624
"""
621625
Perform the closing handshake.
622626

src/websockets/frames.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ class Close:
360360
361361
"""
362362

363-
code: int
363+
code: CloseCode | int
364364
reason: str
365365

366366
def __str__(self) -> str:

src/websockets/protocol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ def send_binary(self, data: BytesLike, fin: bool = True) -> None:
361361
self.expect_continuation_frame = not fin
362362
self.send_frame(Frame(OP_BINARY, data, fin))
363363

364-
def send_close(self, code: int | None = None, reason: str = "") -> None:
364+
def send_close(self, code: CloseCode | int | None = None, reason: str = "") -> None:
365365
"""
366366
Send a `Close frame`_.
367367
@@ -429,7 +429,7 @@ def send_pong(self, data: BytesLike) -> None:
429429
raise InvalidState(f"connection is {self.state.name.lower()}")
430430
self.send_frame(Frame(OP_PONG, data))
431431

432-
def fail(self, code: int, reason: str = "") -> None:
432+
def fail(self, code: CloseCode | int, reason: str = "") -> None:
433433
"""
434434
`Fail the WebSocket connection`_.
435435

src/websockets/sync/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,11 @@ def send(
568568
else:
569569
raise TypeError("data must be str, bytes, or iterable")
570570

571-
def close(self, code: int = CloseCode.NORMAL_CLOSURE, reason: str = "") -> None:
571+
def close(
572+
self,
573+
code: CloseCode | int = CloseCode.NORMAL_CLOSURE,
574+
reason: str = "",
575+
) -> None:
572576
"""
573577
Perform the closing handshake.
574578

0 commit comments

Comments
 (0)