Documentation
The documentation of socket.AF_PACKET says that the value of proto in the address representation must be in network-byte-order:
https://github.com/python/cpython/blame/v3.12.0a3/Doc/library/socket.rst#L196
Value must be in network-byte-order.
This is incorrect. It is true that the corresponding Linux field sll_protocol is in network byte order (see packet(7)), but Python automatically converts to/from host byte order:
https://github.com/python/cpython/blob/v3.12.0a3/Modules/socketmodule.c#L1483
https://github.com/python/cpython/blob/v3.12.0a3/Modules/socketmodule.c#L2104
Note: This applies to addresses passed to socket.bind() and returned from socket.recvfrom(), but does not apply to the proto parameter of socket.socket() -- Python doesn't automatically convert it, so the user must supply a value in network byte order (when using AF_PACKET). It might be a good idea to document this, e.g. the documentation of ETH_P_ALL could mention that it needs to be converted using socket.htons() before passing to socket.socket().
Bonus typo:
https://github.com/python/cpython/blame/v3.12.0a3/Doc/library/socket.rst#L188
The packets are represented by the tuple
"packets" is inaccurate and should be changed to "addresses" or "sockets".
Linked PRs
Documentation
The documentation of socket.AF_PACKET says that the value of
protoin the address representation must be in network-byte-order:https://github.com/python/cpython/blame/v3.12.0a3/Doc/library/socket.rst#L196
This is incorrect. It is true that the corresponding Linux field
sll_protocolis in network byte order (see packet(7)), but Python automatically converts to/from host byte order:https://github.com/python/cpython/blob/v3.12.0a3/Modules/socketmodule.c#L1483
https://github.com/python/cpython/blob/v3.12.0a3/Modules/socketmodule.c#L2104
Note: This applies to addresses passed to
socket.bind()and returned fromsocket.recvfrom(), but does not apply to theprotoparameter ofsocket.socket()-- Python doesn't automatically convert it, so the user must supply a value in network byte order (when using AF_PACKET). It might be a good idea to document this, e.g. the documentation of ETH_P_ALL could mention that it needs to be converted usingsocket.htons()before passing tosocket.socket().Bonus typo:
https://github.com/python/cpython/blame/v3.12.0a3/Doc/library/socket.rst#L188
"packets" is inaccurate and should be changed to "addresses" or "sockets".
Linked PRs