`socket.AddressFamily` and `socket.SocketKind` are undocumented

[remcohaszing]

Documentation

The socket.AddressFamily and socket.SocketKind values are not documented. As a result, (inter)Sphinx can generate mappings to it. This is visible in the official documentation at socket constants and in my project at wakeonlan.send_magic_packet.

It looks like this was previously reported in #64888, and some fixes are linked in #64888 (comment). However, the documentation is still absent.

[sabasiddique1]

Hi @remcohaszing, I'd be interested in contributing a fix for this. Would it be okay for me to work on it?

[serhiy-storchaka]

What exactly do you mean? The AF_* and SOCK_* constants are documented.

[remcohaszing]

All of those constants, which are just the enum values re-exported, are documented. However, the enums themselves are not.

If a function accepts such an enum as a value, you would write the following type annotation:

import socket


def fn(family: socket.AddressFamily) -> None:
    ...

But if you then render the documentation for this function with Sphinx, it can’t resolve the type. My project uses nitpicky, so the build would fail if not for the nitpick_ignore array. For the Python project, Sphinx silently fails to render links to these enums.

[picnixz]

Considering they are exported in __all__, I agree we should just have a simple .. class:: AddressFamily entry.