docs: add `optype.numpy.ctypeslib` reference page by Aniketsy · Pull Request #581 · jorenham/optype

Aniketsy · 2026-04-23T12:20:58Z

fixes #448

Copilot

Pull request overview

Adds a new reference page documenting the optype.numpy.ctypeslib module, which provides typed ctypes constructor reexports and abstract typing aliases for NumPy scalar-like C types (addressing the request in #448 to document this niche-but-existing API surface).

Changes:

Introduces docs/reference/numpy/ctypeslib.md describing the reexported ctypes constructors exposed by optype.numpy.ctypeslib.
Documents the module’s higher-level abstract typing aliases (CType, CScalar, Array, numeric families, etc.).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Aniketsy · 2026-04-27T09:06:20Z

@jorenham could you please re-review request from copilot, so that we can check if anything is missing. Thanks!

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

jorenham

The navigation link is missing (see zensical.toml)

jorenham · 2026-05-04T21:42:53Z

+<tr>
+  <td align="left"><code>CType</code></td>
+  <td align="left"><code>ctypes._SimpleCData[T]</code></td>
+  <td align="left">Scalar-value ctypes base type.</td>
+</tr>
+<tr>
+  <td align="left"><code>CScalar</code></td>
+  <td align="left"><code>ctypes._CData</code></td>
+  <td align="left">Broad base for ctypes objects (scalar, array, pointer, structure, union, ...).</td>
+</tr>
+<tr>
+  <td align="left"><code>Array</code></td>
+  <td align="left"><code>ctypes.Array[CT]</code> (including nested arrays)</td>
+  <td align="left"><code>CT</code> is bound to <code>CType</code>.</td>
+</tr>


You've introduce a ct alias above (line 12), but here you use the full ctypes. module.

jorenham · 2026-05-04T21:44:10Z

+<tr>
+  <td align="left"><code>SignedInteger</code>, <code>UnsignedInteger</code></td>
+  <td align="left">signed and unsigned integer constructor groups</td>
+  <td align="left"></td>
+</tr>


What's a "constructor group"?

jorenham · 2026-05-04T21:44:28Z

+  <td align="left"><code>CT</code> is bound to <code>CType</code>.</td>
+</tr>
+<tr>
+  <td align="left"><code>SignedInteger</code>, <code>UnsignedInteger</code></td>


Let's keep to to one row per type alias, and explicitly describe the (union of) C types.

jorenham · 2026-05-04T21:45:41Z

+</tr>
+<tr>
+  <td align="left"><code>Void</code></td>
+  <td align="left"><code>ctypes.Structure | ctypes.Union</code></td>


Suggested change

<td align="left"><code>ctypes.Structure | ctypes.Union</code></td>

<td align="left"><code>ct.Structure | ct.Union</code></td>

jorenham · 2026-05-04T21:47:23Z

+<tr>
+  <td align="left"><code>Integer</code>, <code>Floating</code>, <code>ComplexFloating</code></td>
+  <td align="left">numeric scalar families</td>
+  <td align="left">Modeled via <code>CScalar</code> for static typing.</td>
+</tr>
+<tr>
+  <td align="left"><code>Inexact</code>, <code>Number</code></td>
+  <td align="left">combined numeric families</td>
+  <td align="left"><code>Inexact = Floating | ComplexFloating</code>, <code>Number = Integer | Floating | ComplexFloating</code>.</td>
+</tr>


These should also be split up and described in terms of their actual union types, as above

jorenham · 2026-05-04T21:51:04Z

+<tr>
+  <th align="left">alias</th>
+  <th align="left">covers</th>
+  <th align="left">notes</th>


I don't think we need this "notes" column. The type definitions speak for itself, and I expect that every reader of this page will understand that union types cannot be instantiated at runtime.

jorenham · 2026-05-04T21:53:32Z

+import ctypes as ct
+```
+
+## Reexported `ctypes` constructors


Suggested change

## Reexported `ctypes` constructors

## Concrete types

jorenham · 2026-05-04T21:57:19Z

+<tr>
+  <td align="left"><code>Int8</code>, <code>UInt8</code>, <code>Int16</code>, <code>UInt16</code>, <code>Int32</code>, <code>UInt32</code>, <code>Int64</code>, <code>UInt64</code></td>
+  <td align="left"><code>c_int8</code>, <code>c_uint8</code>, <code>c_int16</code>, <code>c_uint16</code>, <code>c_int32</code>, <code>c_uint32</code>, <code>c_int64</code>, <code>c_uint64</code></td>
+  <td align="left">fixed-width integers</td>
+  <td align="left"></td>
+</tr>
+<tr>
+  <td align="left"><code>Byte</code>, <code>UByte</code>, <code>Short</code>, <code>UShort</code>, <code>IntC</code>, <code>UIntC</code>, <code>IntP</code>, <code>UIntP</code>, <code>Long</code>, <code>ULong</code>, <code>LongLong</code>, <code>ULongLong</code></td>
+  <td align="left"><code>c_byte</code>, <code>c_ubyte</code>, <code>c_short</code>, <code>c_ushort</code>, <code>c_int</code>, <code>c_uint</code>, <code>c_ssize_t</code>, <code>c_size_t</code>, <code>c_long</code>, <code>c_ulong</code>, <code>c_longlong</code>, <code>c_ulonglong</code></td>
+  <td align="left">platform-width integers</td>
+  <td align="left"><code>UIntP</code> uses <code>c_size_t</code> (<code>c_void_p</code> on NumPy &lt; 2, but almost always equivalent).</td>
+</tr>
+<tr>
+  <td align="left"><code>Float32</code>, <code>Float64</code>, <code>LongDouble</code></td>
+  <td align="left"><code>c_float</code>, <code>c_double</code>, <code>c_longdouble</code></td>
+  <td align="left">floating-point</td>
+  <td align="left"><code>LongDouble</code> is mainly useful as a type annotation target.</td>
+</tr>
+<tr>
+  <td align="left"><code>Complex64</code>, <code>Complex128</code>, <code>CLongDouble</code></td>
+  <td align="left"><code>c_float_complex</code>, <code>c_double_complex</code>, <code>c_longdouble_complex</code></td>
+  <td align="left">complex floating-point</td>
+  <td align="left">Available on Python 3.14+ on non-Windows only; otherwise these aliases are <code>Never</code>.</td>
+</tr>


One row per type would make this easier to read.

yes, this make sense .

Aniketsy · 2026-05-06T10:00:29Z

thanks for the review, this needs lot improvement, i'll take some time for this and update (maybe on sunday)

Aniketsy · 2026-05-18T07:07:33Z

hoping did not miss anything, i'll try to verify once again from my side, as i think this is going to create pain for you to review 🙏 .

docs: add optype.numpy.ctypeslib reference page

58d1cf4

Aniketsy requested a review from jorenham as a code owner April 23, 2026 12:20

jorenham added topic: documentation optype.numpy optional labels Apr 23, 2026

jorenham requested a review from Copilot April 23, 2026 12:22

Copilot started reviewing on behalf of jorenham April 23, 2026 12:23 View session

Copilot AI reviewed Apr 23, 2026

View reviewed changes

Comment thread docs/reference/numpy/ctypeslib.md Outdated

Comment thread docs/reference/numpy/ctypeslib.md Outdated

Comment thread docs/reference/numpy/ctypeslib.md Outdated

Comment thread docs/reference/numpy/ctypeslib.md Outdated

Comment thread docs/reference/numpy/ctypeslib.md Outdated

Aniketsy and others added 3 commits April 23, 2026 22:31

Update docs/reference/numpy/ctypeslib.md

aa2285c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/reference/numpy/ctypeslib.md

fbfed32

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

define ct

13384d7

jorenham requested a review from Copilot April 27, 2026 09:40

Copilot started reviewing on behalf of jorenham April 27, 2026 09:41 View session

Copilot AI reviewed Apr 27, 2026

View reviewed changes

Comment thread docs/reference/numpy/ctypeslib.md

Comment thread docs/reference/numpy/ctypeslib.md Outdated

Comment thread docs/reference/numpy/ctypeslib.md

Comment thread docs/reference/numpy/ctypeslib.md Outdated

improve and address review pointers

afbebbc

Aniketsy commented May 2, 2026

View reviewed changes

Comment thread docs/reference/index.md Outdated

Aniketsy and others added 2 commits May 3, 2026 00:20

Update docs/reference/index.md

2d5cb00

Merge branch 'master' into fix-448

887e631

jorenham requested changes May 4, 2026

View reviewed changes

improve docs and structure

b98c4d7

	<td align="left"><code>ctypes.Structure \| ctypes.Union</code></td>
	<td align="left"><code>ct.Structure \| ct.Union</code></td>

Uh oh!

Conversation

Aniketsy commented Apr 23, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Aniketsy commented Apr 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorenham left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aniketsy commented May 6, 2026

Uh oh!

Aniketsy commented May 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants