Skip to content

gh-109218: Deprecate weird cases in the complex() constructor #119620

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
serhiy-storchaka merged 13 commits into from
May 30, 2024
Merged

gh-109218: Deprecate weird cases in the complex() constructor #119620

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9035969
gh-109218: Deprecate weird cases in the complex() constructor
serhiy-storchaka May 27, 2024
c35779b
gh-109218: Refactor tests for the complex() constructor
serhiy-storchaka May 27, 2024
607e2d5
Merge branch 'main' into complex-constructor-tests
serhiy-storchaka May 28, 2024
d7b2c2f
Merge branch 'main' into complex-constructor
serhiy-storchaka May 28, 2024
d7a9120
Merge branch 'complex-constructor-tests' into complex-constructor
serhiy-storchaka May 28, 2024
537cc4e
Address review comments.
serhiy-storchaka May 28, 2024
e8b6ba9
Add more tests.
serhiy-storchaka May 28, 2024
ddfed7b
Merge branch 'complex-constructor-tests' into complex-constructor
serhiy-storchaka May 28, 2024
9e66399
Simplify some code.
serhiy-storchaka May 28, 2024
573b2cd
Add comments.
serhiy-storchaka May 28, 2024
14598f0
Polishing.
serhiy-storchaka May 29, 2024
90029cf
Rename Mock to With.
serhiy-storchaka May 30, 2024
2a60cc8
Merge branch 'main' into complex-constructor
serhiy-storchaka May 30, 2024
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
Prev Previous commit
Next Next commit
Add comments.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed May 28, 2024
commit 573b2cddf98fbb3928c0369c992002e3f38a08da
13 changes: 13 additions & 0 deletions Objects/complexobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -905,6 +905,16 @@ complex_subtype_from_string(PyTypeObject *type, PyObject *v)
return result;
}

/* The constructor should only accept a string as a positional argument,
* not as by the 'real' keyword. But Argument Clinic does not allow
* to distinguish between argument passed positionally and by keyword.
* So the constructor must be split into two parts: actual_complex_new()
* handles the case of no arguments and one positional argument, and calls
* complex_new(), implemented with Argument Clinic, to handle the remaining
* cases: 'real' and 'imag' arguments. This separation is well suited
* for different constructor roles: convering a string or number to a complex
* number and constructing a complex number from real and imaginary parts.
*/
static PyObject *
Copy link
Member

@mdickinson mdickinson May 28, 2024

Choose a reason for hiding this comment

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

Would it be worth adding a comment above this function explaining the purpose (and explaining why this is different from complex_new)?

actual_complex_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
{
Expand Down Expand Up @@ -993,6 +1003,8 @@ complex_new_impl(PyTypeObject *type, PyObject *r, PyObject *i)
}
PyObject *orig_r = r;

/* DEPRECATED: The call of try_complex_special_method() for the "real"
* part will be dropped after the end of the deprecation period. */
tmp = try_complex_special_method(r);
Copy link
Contributor

@skirpichev skirpichev May 28, 2024

Choose a reason for hiding this comment

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

IIUIC, this logic will be dropped after a deprecation period as well. I'm not sure if this is obvious, maybe worth a comment.

if (tmp) {
Copy link
Contributor

@skirpichev skirpichev May 28, 2024

Choose a reason for hiding this comment

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

else if (PyErr_Occurred()) branch is not tested.

r = tmp;
Expand Down Expand Up @@ -1033,6 +1045,7 @@ complex_new_impl(PyTypeObject *type, PyObject *r, PyObject *i)
both be treated as numbers, and the constructor should return a
complex number equal to (real + imag*1j).

The following is DEPRECATED:
Note that we do NOT assume the input to already be in canonical
form; the "real" and "imag" parts might themselves be complex
numbers, which slightly complicates the code below. */
Expand Down