Merge pull request #26827 from otieno-juma/ai-examples-ctypeslib-as-ctypes

charris · web-flow · commit c8ed7e9835cc · 2024-07-18T13:44:50.000-07:00
DOC: AI-Gen examples ctypeslib.as_ctypes_types
diff --git a/numpy/ctypeslib.py b/numpy/ctypeslib.py
@@ -499,6 +499,22 @@ def as_ctypes_type(dtype):
           `ctypes.Structure`\ s
         - insert padding fields
 
+        Examples
+        --------
+        Converting a simple dtype:
+
+        >>> dt = np.dtype('i4')
+        >>> ctype = np.ctypeslib.as_ctypes_type(dt)
+        >>> ctype
+        <class 'ctypes.c_int32'>
+
+        Converting a structured dtype:
+
+        >>> dt = np.dtype([('x', 'i4'), ('y', 'f4')])
+        >>> ctype = np.ctypeslib.as_ctypes_type(dt)
+        >>> ctype
+        <class 'ctypes.Structure'>
+
         """
         return _ctype_from_dtype(_dtype(dtype))
 
