DOC: Add direct C-extension testing guide - #20239
Draft
ReemHamraz wants to merge 1 commit into
Draft
Conversation
Contributor
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Hi everyone!!
This PR adds
TESTING_EXTENSIONS.rstto the developer docs and wires it up inindex_dev.rst.Over the course of my GSoC project, I've been writing a lot of tests for our C and Cython extensions. Since establishing this direct test layer is a big prerequisite for safely splitting the low-level layer into a separate package (the APE split), I wanted to put together a proper guide on how to test these compiled modules directly and in pure isolation.
Here is a quick rundown of what the guide covers:
.view()casting.type()checks instead ofisinstance()at the C-boundary, and guidelines for usingnumpy.typing.NDArray.zip(..., strict=True), and handling tricky edge cases like explosive memory allocations andnp.nan.TypeVarand enforcing positional-only arguments.I'd really love to get your thoughts on this! Please let me know if anything feels off, if the tone works, or if there are any sections that need more clarity. Looking forward to any suggested changes or improvements, I'm more than happy to iterate on this to make sure it's as helpful as possible for future contributors.
Related Issues
cc: @neutrinoceros