Skip to content

[3.12] gh-121834: Improve complex C-API docs (GH-121835) #121897

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

Jump to bottom
Merged
merged 3 commits into from
Jul 17, 2024
Merged

[3.12] gh-121834: Improve complex C-API docs (GH-121835) #121897

merged 3 commits into from
Jul 17, 2024
+18 −6

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Jul 17, 2024 •
edited by github-actions bot
Loading

(cherry picked from commit 72dccd6)

Since PyComplex_RealAsDouble uses PyFloat_AsDouble, it can still fail there:

cpython/Objects/complexobject.c

Lines 258 to 267 in a15ed56

double
PyComplex_RealAsDouble(PyObject *op)
{
if (PyComplex_Check(op)) {
return ((PyComplexObject *)op)->cval.real;
}
else {
return PyFloat_AsDouble(op);
}
}

While PyComplex_ImagAsDouble is always successful:

cpython/Objects/complexobject.c

Lines 269 to 278 in a15ed56

double
PyComplex_ImagAsDouble(PyObject *op)
{
if (PyComplex_Check(op)) {
return ((PyComplexObject *)op)->cval.imag;
}
else {
return 0.0;
}
}

📚 Documentation preview 📚: https://cpython-previews--121897.org.readthedocs.build/

@sobolevn @skirpichev @encukou
[3.12] pythongh-121834: Improve complex C-API docs (pythonGH-121835)
e11ca8e 
(cherry picked from commit 72dccd6)

Co-authored-by: sobolevn <mail@sobolevn.me>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
This was referenced Jul 17, 2024
Closed
Merged
@bedevere-app bedevere-app bot added skip news docs Documentation in the Doc dir awaiting core review labels Jul 17, 2024
@sobolevn
Copy link
Member Author

cc @skirpichev

skirpichev
skirpichev reviewed Jul 17, 2024
View reviewed changes
Copy link
Member

@skirpichev skirpichev left a comment

Choose a reason for hiding this comment

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

One remark on PyComplex_ImagAsDouble(). The rest LGTM.

@sobolevn @skirpichev
Update Doc/c-api/complex.rst
f064027 
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
@sobolevn sobolevn enabled auto-merge (squash) July 17, 2024 07:26
@sobolevn sobolevn merged commit 6a19d22 into python:3.12 Jul 17, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skirpichev skirpichev skirpichev left review comments

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sobolevn @skirpichev