[issue11253] autodocument first appearance of ctypes.wintypes constants
New submission from anatoly techtonik <techtonik@gmail.com>: I've just noticed that my application is incompatible with Python 2.5, because ctypes.wintypes is missing SHORT constants. However, I can't find the information when these symbols were introduced first. To prevent such confusion in future it would be nice to extract symbol information for each Python release and automatically include the version of the first appearance in documentation. ---------- assignee: docs@python components: Documentation messages: 128893 nosy: docs@python, techtonik priority: normal severity: normal status: open title: autodocument first appearance of ctypes.wintypes constants versions: Python 2.5, Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
Amaury Forgeot d'Arc <amauryfa@gmail.com> added the comment: Can you provide a patch, or show how to do it concretely? ---------- nosy: +amaury.forgeotdarc _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
Changes by Éric Araujo <merwok@netwok.org>: ---------- versions: -Python 2.5, Python 2.6, Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
Mark Mc Mahon <mtnbikingmark@gmail.com> added the comment: This mostly a documentation concern - correct? ctypes.wintypes is sparsely documented - in 2.7 the help for it seems to be: "The ctypes.wintypes module provides quite some other Windows specific data types, for example HWND, WPARAM, or DWORD. Some useful structures like MSG or RECT are also defined." How about the following solution: First of all get the previous release information - hg log / hg revert / import wintypes / dir(wintypes) Future changes have to be updated manually (which probably is not a big deal as it is a reasonably stable module) In fact I went and got the revision when each attribute was added... (some of those are just ctypes leakage) {36899: ['ARRAY', 'MSG', 'ArgumentError', 'OLESTR', 'Array', 'OleDLL', 'BOOL', 'POINT', 'BYTE', 'POINTER', 'BigEndianStructure', 'POINTL', 'DEFAULT_MODE', 'PYFUNCTYPE', 'DWORD', 'PyDLL', 'FILETIME', 'RECT', 'FormatError', 'RECTL', 'GetLastError', 'RGB', 'HANDLE', 'RTLD_GLOBAL', 'HDC', 'RTLD_LOCAL', 'HGDIOBJ', 'SIZE', 'HINSTANCE', 'SIZEL', 'HKEY', 'SetPointerType', 'HMENU', 'Structure', 'HMODULE', 'ULARGE_INTEGER', 'HPEN', 'ULONG', 'HRESULT', 'Union', 'HRGN', 'VARIANT_BOOL', 'HTASK', 'WIN32_FIND_DATAA', 'HWND', 'WIN32_FIND_DATAW', 'LARGE_INTEGER', 'WINFUNCTYPE', 'LCID', 'WORD', 'LONG', 'WPARAM', 'LPARAM', 'WinDLL', 'LPCOLESTR', 'WinError', 'LPCSTR', 'alignment', 'LPCWSTR', 'get_errno', 'LPOLESTR', 'get_last_error', 'LPSTR', 'resize', 'LPWSTR', 'set_conversion_mode', 'LibraryLoader', 'set_errno', 'LittleEndianStructure', 'set_last_error', 'MAX_PATH',] 38788: ['ATOM', 'HRSRC', 'BOOLEAN', 'HSTR', 'COLORREF', 'HWINSTA', 'HACCEL', 'LANGID', 'HBITMAP', 'LCTYPE', 'HBRUSH', 'LGRPID', 'HCOLORSPACE', 'SC_HANDLE', 'HDESK', 'SERVICE_STATUS_HANDLE', 'HDWP', 'SMALL_RECT', 'HENHMETAFILE', '_COORD', 'HFONT', '_FILETIME', 'HGLOBAL', '_POINTL', 'HHOOK', '_RECTL', 'HICON', '_SMALL_RECT', 'HKL', 'tagMSG', 'HLOCAL', 'tagPOINT', 'HMETAFILE', 'tagRECT', 'HMONITOR', 'tagSIZE', 'HPALETTE',] 38830: ['DOUBLE', 'UINT', 'WCHAR', '_LARGE_INTEGER', '_SimpleCData', '_ULARGE_INTEGER', '__all__'], 48320: ['FLOAT', 'INT', 'LPCVOID', 'LPVOID', 'SHORT', 'USHORT']} 48320 -> 2.7? 38830 -> 2.5? 38788 -> 2.5? 36899 -> 2.4? So we need a doc patch? Should we update the older 'What's new in Python 2.x' for added attribs? ---------- nosy: +markm _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
Senthil Kumaran <senthil@uthcode.com> added the comment: On Sun, Jun 26, 2011 at 10:44:59AM +0000, Mark Mc Mahon wrote:
So we need a doc patch? Should we update the older 'What's new in Python 2.x' for added attribs?
The Documentation patch may be applied only 2.7 and 3.2/3.3 releases now. What's new is updated for the upcoming release only. So, if documenting those constants will help in 2.7.x and 3.2.x and 3.3, it would be helpful to provide patches against those lines and it can be applied. As you said, the future version can be updated, but we cannot go back with updating the documentation of the already released versions. ---------- nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
anatoly techtonik <techtonik@gmail.com> added the comment: On Mon, Jun 27, 2011 at 12:18 AM, Senthil Kumaran <report@bugs.python.org> wrote:
As you said, the future version can be updated, but we cannot go back with updating the documentation of the already released versions.
Why? -- anatoly t. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
Senthil Kumaran <senthil@uthcode.com> added the comment: What's new docs are usually for what is coming up new in the upcoming releases. It is not updated once the release is done. Bug fixes and related docs are updated in documentation. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11253> _______________________________________
Change by Berker Peksag <berker.peksag@gmail.com>: ---------- stage: -> needs patch title: autodocument first appearance of ctypes.wintypes constants -> Document ctypes.wintypes constants type: -> enhancement versions: +Python 3.6, Python 3.7 -Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11253> _______________________________________
participants (6)
-
Amaury Forgeot d'Arc -
anatoly techtonik
-
Berker Peksag
-
Mark Mc Mahon
-
Senthil Kumaran
-
Éric Araujo