Skip to content

Commit b914c84

Browse files
jakkdljakkdl
authored
Merge pull request #3151 from A5rocks/finish-ruffs-job
Get rid of using `__` for positional only arguments
2 parents a2c6bcd + 1fa8e53 commit b914c84

File tree

2 files changed

+69
-66
lines changed

2 files changed

+69
-66
lines changed

‎newsfragments/3094.misc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Switch to using PEP570 for positional-only arguments for `~trio.socket.SocketType`'s methods.

‎src/trio/_socket.py

Lines changed: 68 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# ruff: noqa: PYI063 # Several cases throughout file where
2-
# argument names with __ used because of typeshed, see comment for recv in _SocketType
3-
41
from __future__ import annotations
52

63
import os
@@ -567,27 +564,25 @@ def getsockname(self) -> AddressFormat:
567564
raise NotImplementedError
568565

569566
@overload
570-
def getsockopt(self, /, level: int, optname: int) -> int: ...
567+
def getsockopt(self, level: int, optname: int) -> int: ...
571568

572569
@overload
573-
def getsockopt(self, /, level: int, optname: int, buflen: int) -> bytes: ...
570+
def getsockopt(self, level: int, optname: int, buflen: int) -> bytes: ...
574571

575572
def getsockopt(
576573
self,
577-
/,
578574
level: int,
579575
optname: int,
580576
buflen: int | None = None,
581577
) -> int | bytes:
582578
raise NotImplementedError
583579

584580
@overload
585-
def setsockopt(self, /, level: int, optname: int, value: int | Buffer) -> None: ...
581+
def setsockopt(self, level: int, optname: int, value: int | Buffer) -> None: ...
586582

587583
@overload
588584
def setsockopt(
589585
self,
590-
/,
591586
level: int,
592587
optname: int,
593588
value: None,
@@ -596,15 +591,14 @@ def setsockopt(
596591

597592
def setsockopt(
598593
self,
599-
/,
600594
level: int,
601595
optname: int,
602596
value: int | Buffer | None,
603597
optlen: int | None = None,
604598
) -> None:
605599
raise NotImplementedError
606600

607-
def listen(self, /, backlog: int = min(_stdlib_socket.SOMAXCONN, 128)) -> None:
601+
def listen(self, backlog: int = min(_stdlib_socket.SOMAXCONN, 128)) -> None:
608602
raise NotImplementedError
609603

610604
def get_inheritable(self) -> bool:
@@ -617,7 +611,7 @@ def set_inheritable(self, inheritable: bool) -> None:
617611
not TYPE_CHECKING and hasattr(_stdlib_socket.socket, "share")
618612
):
619613

620-
def share(self, /, process_id: int) -> bytes:
614+
def share(self, process_id: int) -> bytes:
621615
raise NotImplementedError
622616

623617
def __enter__(self) -> Self:
@@ -677,11 +671,11 @@ async def accept(self) -> tuple[SocketType, AddressFormat]:
677671
async def connect(self, address: AddressFormat) -> None:
678672
raise NotImplementedError
679673

680-
def recv(__self, __buflen: int, __flags: int = 0) -> Awaitable[bytes]:
674+
def recv(self, buflen: int, flags: int = 0, /) -> Awaitable[bytes]:
681675
raise NotImplementedError
682676

683677
def recv_into(
684-
__self,
678+
self,
685679
buffer: Buffer,
686680
nbytes: int = 0,
687681
flags: int = 0,
@@ -690,15 +684,16 @@ def recv_into(
690684

691685
# return type of socket.socket.recvfrom in typeshed is tuple[bytes, Any]
692686
def recvfrom(
693-
__self,
694-
__bufsize: int,
695-
__flags: int = 0,
687+
self,
688+
bufsize: int,
689+
flags: int = 0,
690+
/,
696691
) -> Awaitable[tuple[bytes, AddressFormat]]:
697692
raise NotImplementedError
698693

699694
# return type of socket.socket.recvfrom_into in typeshed is tuple[bytes, Any]
700695
def recvfrom_into(
701-
__self,
696+
self,
702697
buffer: Buffer,
703698
nbytes: int = 0,
704699
flags: int = 0,
@@ -710,10 +705,11 @@ def recvfrom_into(
710705
):
711706

712707
def recvmsg(
713-
__self,
714-
__bufsize: int,
715-
__ancbufsize: int = 0,
716-
__flags: int = 0,
708+
self,
709+
bufsize: int,
710+
ancbufsize: int = 0,
711+
flags: int = 0,
712+
/,
717713
) -> Awaitable[tuple[bytes, list[tuple[int, int, bytes]], int, object]]:
718714
raise NotImplementedError
719715

@@ -722,29 +718,32 @@ def recvmsg(
722718
):
723719

724720
def recvmsg_into(
725-
__self,
726-
__buffers: Iterable[Buffer],
727-
__ancbufsize: int = 0,
728-
__flags: int = 0,
721+
self,
722+
buffers: Iterable[Buffer],
723+
ancbufsize: int = 0,
724+
flags: int = 0,
725+
/,
729726
) -> Awaitable[tuple[int, list[tuple[int, int, bytes]], int, object]]:
730727
raise NotImplementedError
731728

732-
def send(__self, __bytes: Buffer, __flags: int = 0) -> Awaitable[int]:
729+
def send(self, bytes: Buffer, flags: int = 0, /) -> Awaitable[int]:
733730
raise NotImplementedError
734731

735732
@overload
736733
async def sendto(
737734
self,
738-
__data: Buffer,
739-
__address: tuple[object, ...] | str | Buffer,
735+
data: Buffer,
736+
address: tuple[object, ...] | str | Buffer,
737+
/,
740738
) -> int: ...
741739

742740
@overload
743741
async def sendto(
744742
self,
745-
__data: Buffer,
746-
__flags: int,
747-
__address: tuple[object, ...] | str | Buffer,
743+
data: Buffer,
744+
flags: int,
745+
address: tuple[object, ...] | str | Buffer,
746+
/,
748747
) -> int: ...
749748

750749
async def sendto(self, *args: object) -> int:
@@ -757,10 +756,11 @@ async def sendto(self, *args: object) -> int:
757756
@_wraps(_stdlib_socket.socket.sendmsg, assigned=(), updated=())
758757
async def sendmsg(
759758
self,
760-
__buffers: Iterable[Buffer],
761-
__ancdata: Iterable[tuple[int, int, Buffer]] = (),
762-
__flags: int = 0,
763-
__address: AddressFormat | None = None,
759+
buffers: Iterable[Buffer],
760+
ancdata: Iterable[tuple[int, int, Buffer]] = (),
761+
flags: int = 0,
762+
address: AddressFormat | None = None,
763+
/,
764764
) -> int:
765765
raise NotImplementedError
766766

@@ -810,14 +810,13 @@ def getsockname(self) -> AddressFormat:
810810
return self._sock.getsockname()
811811

812812
@overload
813-
def getsockopt(self, /, level: int, optname: int) -> int: ...
813+
def getsockopt(self, level: int, optname: int) -> int: ...
814814

815815
@overload
816-
def getsockopt(self, /, level: int, optname: int, buflen: int) -> bytes: ...
816+
def getsockopt(self, level: int, optname: int, buflen: int) -> bytes: ...
817817

818818
def getsockopt(
819819
self,
820-
/,
821820
level: int,
822821
optname: int,
823822
buflen: int | None = None,
@@ -827,12 +826,11 @@ def getsockopt(
827826
return self._sock.getsockopt(level, optname, buflen)
828827

829828
@overload
830-
def setsockopt(self, /, level: int, optname: int, value: int | Buffer) -> None: ...
829+
def setsockopt(self, level: int, optname: int, value: int | Buffer) -> None: ...
831830

832831
@overload
833832
def setsockopt(
834833
self,
835-
/,
836834
level: int,
837835
optname: int,
838836
value: None,
@@ -841,7 +839,6 @@ def setsockopt(
841839

842840
def setsockopt(
843841
self,
844-
/,
845842
level: int,
846843
optname: int,
847844
value: int | Buffer | None,
@@ -862,7 +859,7 @@ def setsockopt(
862859
# four parameters.
863860
return self._sock.setsockopt(level, optname, value, optlen)
864861

865-
def listen(self, /, backlog: int = min(_stdlib_socket.SOMAXCONN, 128)) -> None:
862+
def listen(self, backlog: int = min(_stdlib_socket.SOMAXCONN, 128)) -> None:
866863
return self._sock.listen(backlog)
867864

868865
def get_inheritable(self) -> bool:
@@ -875,7 +872,7 @@ def set_inheritable(self, inheritable: bool) -> None:
875872
not TYPE_CHECKING and hasattr(_stdlib_socket.socket, "share")
876873
):
877874

878-
def share(self, /, process_id: int) -> bytes:
875+
def share(self, process_id: int) -> bytes:
879876
return self._sock.share(process_id)
880877

881878
def __enter__(self) -> Self:
@@ -1118,11 +1115,8 @@ async def connect(self, address: AddressFormat) -> None:
11181115
# complain about AmbiguousType
11191116
if TYPE_CHECKING:
11201117

1121-
def recv(__self, __buflen: int, __flags: int = 0) -> Awaitable[bytes]: ...
1118+
def recv(self, buflen: int, flags: int = 0, /) -> Awaitable[bytes]: ...
11221119

1123-
# _make_simple_sock_method_wrapper is typed, so this checks that the above is correct
1124-
# this requires that we refrain from using `/` to specify pos-only
1125-
# args, or mypy thinks the signature differs from typeshed.
11261120
recv = _make_simple_sock_method_wrapper(
11271121
_stdlib_socket.socket.recv,
11281122
_core.wait_readable,
@@ -1135,7 +1129,8 @@ def recv(__self, __buflen: int, __flags: int = 0) -> Awaitable[bytes]: ...
11351129
if TYPE_CHECKING:
11361130

11371131
def recv_into(
1138-
__self,
1132+
self,
1133+
/,
11391134
buffer: Buffer,
11401135
nbytes: int = 0,
11411136
flags: int = 0,
@@ -1153,9 +1148,10 @@ def recv_into(
11531148
if TYPE_CHECKING:
11541149
# return type of socket.socket.recvfrom in typeshed is tuple[bytes, Any]
11551150
def recvfrom(
1156-
__self,
1157-
__bufsize: int,
1158-
__flags: int = 0,
1151+
self,
1152+
bufsize: int,
1153+
flags: int = 0,
1154+
/,
11591155
) -> Awaitable[tuple[bytes, AddressFormat]]: ...
11601156

11611157
recvfrom = _make_simple_sock_method_wrapper(
@@ -1170,7 +1166,8 @@ def recvfrom(
11701166
if TYPE_CHECKING:
11711167
# return type of socket.socket.recvfrom_into in typeshed is tuple[bytes, Any]
11721168
def recvfrom_into(
1173-
__self,
1169+
self,
1170+
/,
11741171
buffer: Buffer,
11751172
nbytes: int = 0,
11761173
flags: int = 0,
@@ -1191,10 +1188,11 @@ def recvfrom_into(
11911188
if TYPE_CHECKING:
11921189

11931190
def recvmsg(
1194-
__self,
1195-
__bufsize: int,
1196-
__ancbufsize: int = 0,
1197-
__flags: int = 0,
1191+
self,
1192+
bufsize: int,
1193+
ancbufsize: int = 0,
1194+
flags: int = 0,
1195+
/,
11981196
) -> Awaitable[tuple[bytes, list[tuple[int, int, bytes]], int, object]]: ...
11991197

12001198
recvmsg = _make_simple_sock_method_wrapper(
@@ -1213,10 +1211,11 @@ def recvmsg(
12131211
if TYPE_CHECKING:
12141212

12151213
def recvmsg_into(
1216-
__self,
1217-
__buffers: Iterable[Buffer],
1218-
__ancbufsize: int = 0,
1219-
__flags: int = 0,
1214+
self,
1215+
buffers: Iterable[Buffer],
1216+
ancbufsize: int = 0,
1217+
flags: int = 0,
1218+
/,
12201219
) -> Awaitable[tuple[int, list[tuple[int, int, bytes]], int, object]]: ...
12211220

12221221
recvmsg_into = _make_simple_sock_method_wrapper(
@@ -1231,7 +1230,7 @@ def recvmsg_into(
12311230

12321231
if TYPE_CHECKING:
12331232

1234-
def send(__self, __bytes: Buffer, __flags: int = 0) -> Awaitable[int]: ...
1233+
def send(self, bytes: Buffer, flags: int = 0, /) -> Awaitable[int]: ...
12351234

12361235
send = _make_simple_sock_method_wrapper(
12371236
_stdlib_socket.socket.send,
@@ -1245,16 +1244,18 @@ def send(__self, __bytes: Buffer, __flags: int = 0) -> Awaitable[int]: ...
12451244
@overload
12461245
async def sendto(
12471246
self,
1248-
__data: Buffer,
1249-
__address: tuple[object, ...] | str | Buffer,
1247+
data: Buffer,
1248+
address: tuple[object, ...] | str | Buffer,
1249+
/,
12501250
) -> int: ...
12511251

12521252
@overload
12531253
async def sendto(
12541254
self,
1255-
__data: Buffer,
1256-
__flags: int,
1257-
__address: tuple[object, ...] | str | Buffer,
1255+
data: Buffer,
1256+
flags: int,
1257+
address: tuple[object, ...] | str | Buffer,
1258+
/,
12581259
) -> int: ...
12591260

12601261
@_wraps(_stdlib_socket.socket.sendto, assigned=(), updated=())
@@ -1287,6 +1288,7 @@ async def sendmsg(
12871288
ancdata: Iterable[tuple[int, int, Buffer]] = (),
12881289
flags: int = 0,
12891290
address: AddressFormat | None = None,
1291+
/,
12901292
) -> int:
12911293
"""Similar to :meth:`socket.socket.sendmsg`, but async.
12921294

0 commit comments

Comments
 (0)