[issue44261] SocketType documentation misleading
New submission from Sebastian Rittau <srittau@rittau.biz>: The documentation of socket.SocketType (https://docs.python.org/3/library/socket.html?highlight=sockettype#socket.So...) is misleading. It states: This is a Python type object that represents the socket object type. It is the same as type(socket(...)). This is untrue. socket.SocketType is in reality re-exported from _socket, where it is an alias for class _socket.socket, a super type of class socket.socket. I think that either the documentation should be fixed, or SocketType should be moved to socket and made an alias of socket.socket. ---------- assignee: docs@python components: Documentation messages: 394665 nosy: docs@python, srittau priority: normal severity: normal status: open title: SocketType documentation misleading _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue44261> _______________________________________
Jelle Zijlstra <jelle.zijlstra@gmail.com> added the comment: I propose to deprecate socket.SocketType. There's no reason to publicly expose _socket.socket separately from socket.socket, the only type that moat users should care about. SocketType isn't needed for type checking; socket.socket is itself a class and can be used in type annotations. ---------- nosy: +Jelle Zijlstra _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue44261> _______________________________________
participants (2)
-
Jelle Zijlstra
-
Sebastian Rittau