classification
Title: sysconfig variables introduced by PEP-3149 are currently undocumented
Type: enhancement Stage:
Components: Documentation Versions: Python 3.3
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: barry, docs@python, doko, zaytsev
Priority: normal Keywords:

Created on 2013-11-07 09:42 by zaytsev, last changed 2013-11-07 09:42 by zaytsev.

Messages (1)
msg202321 - (view) Author: Yury V. Zaytsev (zaytsev) Date: 2013-11-07 09:42
PEP-3149 (issue9193) introduces new variables (SO and SOABI) so that one can find out what are the supported extension suffixes.

Quote from the PEP:

>>> sysconfig.get_config_var('SO')
'.cpython-32mu.so'
>>> sysconfig.get_config_var('SOABI')
'cpython-32mu'

Later, in issue16754, doko introduced EXT_SUFFIX & SHLIB_SUFFIX and planned to update the PEP, but this didn't happen. This caused discrepancy in the news (issue11234), and the news item was fixed:

http://docs.python.org/3.4/whatsnew/3.2.html?highlight=soabi

>>> sysconfig.get_config_var('SOABI')       # find the version tag
'cpython-32mu'
>>> sysconfig.get_config_var('EXT_SUFFIX')  # find the full filename extension
'.cpython-32mu.so'

However, the PEP is still not up-to-date and is in conflict with the implementation.

In an IRC discussion with Barry he suggested that PEPs shouldn't be considered documentation, so updating the PEP is not the right way to go.

My proposal is then to document the intent behind SO, SOABI, EXT_SUFFIX & SHLIB_SUFFIX on the sysconfig documentation page and mention that they are platform-specific, and maybe add a link to this page to the PEP.

As of now, I find the situation highly confusing... Any opinions or suggestions please?

Thanks,

Z.
History
Date User Action Args
2013-11-07 09:42:50zaytsevcreate