Skip to content

gh-141004: Document Py_ARRAY_LENGTH macro #141601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZeroIntensity merged 12 commits into from
Nov 24, 2025
Merged

gh-141004: Document Py_ARRAY_LENGTH macro #141601

Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7c24a14
Document Py_ARRAY_LENGTH macro in intro.rst
Yashp002 Nov 15, 2025
3813ae8
Merge branch 'main' into main
Yashp002 Nov 15, 2025
40acd8f
Update Doc/c-api/intro.rst
Yashp002 Nov 15, 2025
4234c8b
Update Doc/c-api/intro.rst
Yashp002 Nov 15, 2025
8191b69
Update Doc/c-api/intro.rst
Yashp002 Nov 15, 2025
f3a7fb7
Update Doc/c-api/intro.rst
Yashp002 Nov 16, 2025
0301587
Remove “generally equivalent” phrasing as per review feedback
Yashp002 Nov 16, 2025
7f64d0b
Update Doc/c-api/intro.rst
Yashp002 Nov 16, 2025
7962258
Update Doc/c-api/intro.rst
Yashp002 Nov 17, 2025
f27366a
Merge branch 'python:main' into main
Yashp002 Nov 20, 2025
8a9fc39
Address my own comments.
ZeroIntensity Nov 24, 2025
2aadd23
Use better terminology
ZeroIntensity Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,19 @@ complete listing.
PyDoc_VAR(python_doc) = PyDoc_STR("A genus of constricting snakes in the Pythonidae family native "
"to the tropics and subtropics of the Eastern Hemisphere.");

.. c:macro:: Py_ARRAY_LENGTH(array)

Compute the length (number of elements) of a statically allocated C array at
Copy link
Member

@ZeroIntensity ZeroIntensity Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's generally well known that the length is the number of elements.

compile time.

The *array* argument must be a C array with a size known at compile time,
not a pointer. Using this macro with a pointer will produce incorrect results.

This is generally equivalent to::
Copy link
Member

@picnixz picnixz Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the use of "generally" equivalent because it may indicate that it's equivalent to something else. So I would remove the "This is generally equivalent to:: + code"

Copy link
Member

@ZeroIntensity ZeroIntensity Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree, it's helpful to have something rather than nothing, even if it's not 100% true. This is a good example of a lie-to-children.

If you're against "generally", how about saying "this is semantically equivalent to ..."?

Copy link
Member

@picnixz picnixz Nov 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"generally" is inaccurate; if you want to lie a bit, you should say "roughly equivalent to" (which is what we do in academia or in itertools btw). "Generally" means that this would always be the case (at least to me when used like that), but the macro expansion is different.

  • If you want to use "generally" as a synonym of "usually", "roughly" is better.
  • "semantically equivalent" is too verbose IMO.

Copy link
Member

@ZeroIntensity ZeroIntensity Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"roughly equivalent to" is fine with me.


sizeof(array) / sizeof((array)[0])



.. _api-objects:

Expand Down
Loading