gh-106320: Remove private _PyLong_FileDescriptor_Converter() (#108503)

Move the private _PyLong converter functions to the internal C API * _PyLong_FileDescriptor_Converter(): moved to pycore_fileutils.h * _PyLong_Size_t_Converter(): moved to pycore_long.h Argument Clinic now emits includes for pycore_fileutils.h and pycore_long.h when these functions are used.
python · Aug 26, 2023 · 6353c21 · 6353c21
1 parent 713afb8
commit 6353c21
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 10 deletions.
diff --git a/Include/cpython/fileobject.h b/Include/cpython/fileobject.h
@@ -15,5 +15,3 @@ typedef PyObject * (*Py_OpenCodeHookFunction)(PyObject *, void *);
 PyAPI_FUNC(PyObject *) PyFile_OpenCode(const char *utf8path);
 PyAPI_FUNC(PyObject *) PyFile_OpenCodeObject(PyObject *path);
 PyAPI_FUNC(int) PyFile_SetOpenCodeHook(Py_OpenCodeHookFunction hook, void *userData);
-
-PyAPI_FUNC(int) _PyLong_FileDescriptor_Converter(PyObject *, void *);
diff --git a/Include/cpython/longobject.h b/Include/cpython/longobject.h
@@ -2,8 +2,6 @@
 #  error "this header file must not be included directly"
 #endif
 
-PyAPI_FUNC(int) _PyLong_Size_t_Converter(PyObject *, void *);
-
 PyAPI_FUNC(PyObject*) PyLong_FromUnicodeObject(PyObject *u, int base);
 
 /* _PyLong_Sign.  Return 0 if v is 0, -1 if v < 0, +1 if v > 0.

diff --git a/Include/internal/pycore_fileutils.h b/Include/internal/pycore_fileutils.h
@@ -312,6 +312,9 @@ extern HRESULT PathCchSkipRoot(const wchar_t *pszPath, const wchar_t **ppszRootE
 #  define _Py_END_SUPPRESS_IPH
 #endif /* _MSC_VER >= 1900 */
 
+// Export for 'select' shared extension (Argument Clinic code)
+PyAPI_FUNC(int) _PyLong_FileDescriptor_Converter(PyObject *, void *);
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/Include/internal/pycore_long.h b/Include/internal/pycore_long.h
@@ -187,11 +187,21 @@ extern char* _PyLong_FormatBytesWriter(
     int alternate);
 
 // Argument converters used by Argument Clinic
+
+// Export for 'select' shared extension (Argument Clinic code)
 PyAPI_FUNC(int) _PyLong_UnsignedShort_Converter(PyObject *, void *);
+
+// Export for '_testclinic' shared extension (Argument Clinic code)
 PyAPI_FUNC(int) _PyLong_UnsignedInt_Converter(PyObject *, void *);
+
+// Export for '_blake2' shared extension (Argument Clinic code)
 PyAPI_FUNC(int) _PyLong_UnsignedLong_Converter(PyObject *, void *);
+
+// Export for '_blake2' shared extension (Argument Clinic code)
 PyAPI_FUNC(int) _PyLong_UnsignedLongLong_Converter(PyObject *, void *);
 
+// Export for '_testclinic' shared extension (Argument Clinic code)
+PyAPI_FUNC(int) _PyLong_Size_t_Converter(PyObject *, void *);
 
 /* Long value tag bits:
  * 0-1: Sign bits value = (1-sign), ie. negative=2, positive=0, zero=1.

diff --git a/Modules/clinic/_winapi.c.h b/Modules/clinic/_winapi.c.h
diff --git a/Modules/clinic/fcntlmodule.c.h b/Modules/clinic/fcntlmodule.c.h
diff --git a/Modules/clinic/posixmodule.c.h b/Modules/clinic/posixmodule.c.h
diff --git a/Modules/clinic/selectmodule.c.h b/Modules/clinic/selectmodule.c.h
diff --git a/Modules/clinic/termios.c.h b/Modules/clinic/termios.c.h
diff --git a/Modules/fcntlmodule.c b/Modules/fcntlmodule.c
@@ -1,5 +1,9 @@
 /* fcntl module */
 
+#ifndef Py_BUILD_CORE_BUILTIN
+#  define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "Python.h"
 
 #ifdef HAVE_SYS_FILE_H

diff --git a/Modules/termios.c b/Modules/termios.c
@@ -1,5 +1,9 @@
 /* termios.c -- POSIX terminal I/O module implementation.  */
 
+#ifndef Py_BUILD_CORE_BUILTIN
+#  define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "Python.h"
 
 /* Apparently, on SGI, termios.h won't define CTRL if _XOPEN_SOURCE

diff --git a/Tools/c-analyzer/c_parser/preprocessor/gcc.py b/Tools/c-analyzer/c_parser/preprocessor/gcc.py
@@ -12,13 +12,16 @@
     'multibytecodec.h',
     'socketmodule.h',
 
-    # Argument Clinic ".c.h" files
+    # Argument Clinic ".c.h" header files
     '_testclinic.c.h',
     '_testclinic_depr.c.h',
+    '_winapi.c.h',
+    'fcntlmodule.c.h',
     'overlapped.c.h',
     'posixmodule.c.h',
     'selectmodule.c.h',
     'sha3module.c.h',
+    'termios.c.h',
 }
 
 TOOL = 'gcc'

diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
@@ -3835,6 +3835,10 @@ class size_t_converter(CConverter):
     converter = '_PyLong_Size_t_Converter'
     c_ignored_default = "0"
 
+    def converter_init(self, *, accept: TypeSet = {int, NoneType}) -> None:
+        self.add_include('pycore_long.h',
+                         '_PyLong_Size_t_Converter()')
+
     def parse_arg(self, argname: str, displayname: str) -> str | None:
         if self.format_unit == 'n':
             return """
@@ -3850,6 +3854,10 @@ class fildes_converter(CConverter):
     type = 'int'
     converter = '_PyLong_FileDescriptor_Converter'
 
+    def converter_init(self, *, accept: TypeSet = {int, NoneType}) -> None:
+        self.add_include('pycore_fileutils.h',
+                         '_PyLong_FileDescriptor_Converter()')
+
     def _parse_arg(self, argname: str, displayname: str) -> str | None:
         return """
             {paramname} = PyObject_AsFileDescriptor({argname});