List socket.SO_*, SCM_*, MSG_*, IPPROTO_* symbols

[vadmium]

BPO	27409
Nosy	@giampaolo, @vadmium
Files	socket-const.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2016-06-29.02:54:56.890>
labels = ['docs']
title = 'List socket.SO_*, SCM_*, MSG_*, IPPROTO_* symbols'
updated_at = <Date 2019-05-03.16:44:31.642>
user = 'https://github.com/vadmium'

bugs.python.org fields:

activity = <Date 2019-05-03.16:44:31.642>
actor = 'zach.ware'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2016-06-29.02:54:56.890>
creator = 'martin.panter'
dependencies = []
files = ['43573']
hgrepos = []
issue_num = 27409
keywords = ['patch']
message_count = 1.0
messages = ['269460']
nosy_count = 4.0
nosy_names = ['giampaolo.rodola', 'docs@python', 'martin.panter', 'Martha Simons']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue27409'
versions = ['Python 3.5', 'Python 3.6']

[vadmium]

The documentation just says that SO_* etc constants are defined. However when people add new ones, they add them as new features to a specific version (not backported as bug fixes), but do not alter the documentation at all. IMO it is silly adding undocumented features. E.g. bpo-26907 was opened to add (among others) SO_PASSCRED, which was already added, undocumented, as part of bpo-6560.

This patch attempts to indicate which symbols are defined by Python (depending on OS availability), and therefore one can deduce if Python does not define a particular symbol. It could be adapted to the 2.7 documentation, but I am not really motivated for that on my own.

I also remove a redundant definition in the module, and removed a conditional because SO_REUSEADDR is required to always be defined according to the test suite. These specific changes should only be applied to 3.6.

I also found bpo-1732367, which has a patch documenting each AF_* symbol in a little more detail. That patch was never updated nor comitted, but it sounds like this kind of addition might be acceptable.