support `text_signature` on `#[new]` #2980

davidhewitt · 2023-02-22T21:04:51Z

This is a breaking change for 0.19.0, because it starts autogenerating text_signature for #[new]. This could affect runtime behaviour if the user is relying on the class docs at runtime for some reason.

Guide & tests all updated accordingly.

#[pyclass(text_signature = "...")] is deprecated by this PR, however if it's set, it will be used in preference to #[new].

(The signature / text_signature from #[new] will simply be ignored in this case. I figure that when users fix their deprecation warnings by removing #[pyclass(text_signature = "...")] then the #[new] signatures will start flowing properly, and this is good enough.)

pyo3-macros-backend/src/pyclass.rs

guide/src/class.md

davidhewitt · 2023-04-18T20:06:16Z

@adamreichold I've just rebased this, and I think (assuming CI passes) it might be ready to merge.

src/pyclass/create_type_object.rs

adamreichold

Single nit. Please feel free to merge after resolving this.

davidhewitt · 2023-04-19T21:16:58Z

bors r=adamreichold

2980: support `text_signature` on `#[new]` r=adamreichold a=davidhewitt Closes #2866 This is a breaking change for 0.19.0, because it starts autogenerating `text_signature` for `#[new]`. This could affect runtime behaviour if the user is relying on the class docs at runtime for some reason. Guide & tests all updated accordingly. `#[pyclass(text_signature = "...")]` is deprecated by this PR, however if it's set, it will be used in preference to `#[new]`. (The signature / `text_signature` from `#[new]` will simply be ignored in this case. I figure that when users fix their deprecation warnings by removing `#[pyclass(text_signature = "...")]` then the `#[new]` signatures will start flowing properly, and this is good enough.) Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>

bors · 2023-04-19T21:52:52Z

Build failed:

conclusion

adamreichold · 2023-04-20T04:58:04Z

bors retry

2980: support `text_signature` on `#[new]` r=adamreichold a=davidhewitt Closes #2866 This is a breaking change for 0.19.0, because it starts autogenerating `text_signature` for `#[new]`. This could affect runtime behaviour if the user is relying on the class docs at runtime for some reason. Guide & tests all updated accordingly. `#[pyclass(text_signature = "...")]` is deprecated by this PR, however if it's set, it will be used in preference to `#[new]`. (The signature / `text_signature` from `#[new]` will simply be ignored in this case. I figure that when users fix their deprecation warnings by removing `#[pyclass(text_signature = "...")]` then the `#[new]` signatures will start flowing properly, and this is good enough.) Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>

bors · 2023-04-20T05:29:09Z

Build failed:

conclusion

adamreichold · 2023-04-20T05:40:42Z

The nightly warning on non_upper_case_globals seems unrelated but also trivial to fix by adding an #[allow(..)] to the generated code so I'd say we might as well do it here?

The test failure in test_auto_test_signature_method seems real though. During review, I assumed that this would be the automatically generated Python signature based on the actual Rust signature? Does that not work on Python 3.7? (It would be very helpful to have a py_assert_eq to see the actual value in the logs.)

adamreichold · 2023-04-21T15:51:19Z

The nightly warning on non_upper_case_globals seems unrelated but also trivial to fix by adding an #[allow(..)] to the generated code so I'd say we might as well do it here?

Actually, I cannot reproduce this on main. Maybe this does need a reb~~uild~~ase? Probably useful anyway after #3114 lands.

davidhewitt · 2023-05-04T06:16:00Z

Rebased; let's hope things are working again now. Sorry for the gap!

bors r=adamreichold

2980: support `text_signature` on `#[new]` r=adamreichold a=davidhewitt Closes #2866 This is a breaking change for 0.19.0, because it starts autogenerating `text_signature` for `#[new]`. This could affect runtime behaviour if the user is relying on the class docs at runtime for some reason. Guide & tests all updated accordingly. `#[pyclass(text_signature = "...")]` is deprecated by this PR, however if it's set, it will be used in preference to `#[new]`. (The signature / `text_signature` from `#[new]` will simply be ignored in this case. I figure that when users fix their deprecation warnings by removing `#[pyclass(text_signature = "...")]` then the `#[new]` signatures will start flowing properly, and this is good enough.) Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>

bors · 2023-05-04T07:10:18Z

Build failed:

conclusion

adamreichold · 2023-05-04T07:59:53Z

I think

The test failure in test_auto_test_signature_method seems real though. During review, I assumed that this would be the automatically generated Python signature based on the actual Rust signature? Does that not work on Python 3.7? (It would be very helpful to have a py_assert_eq to see the actual value in the logs.)

still applies.

adamreichold · 2023-05-04T16:13:19Z

Sadly, I cannot reproduce the issue locally even using Python 3.7, neither via pyenv (which is 3.7.16 as in GitHub actions) nor using indygreg's standalone builds which stopped at 3.7.9.

adamreichold · 2023-05-04T16:23:24Z

Sadly, I cannot reproduce the issue locally even using Python 3.7, neither via pyenv (which is 3.7.16 as in GitHub actions) nor using indygreg's standalone builds which stopped at 3.7.9.

Sorry, I am an idiot for trying this on the main branch...

…on 3.10 as we do not support it.

adamreichold · 2023-05-04T16:30:37Z

I think this is due to us not being able to set __text_signature__ on classes using the limited API before version 3.10. I hence took the liberty of pushing a commit ignoring that one assertion as we already do for the class_with_signature_no_doc and class_with_docs_and_signature test cases.

bors r+

2980: support `text_signature` on `#[new]` r=adamreichold a=davidhewitt Closes #2866 This is a breaking change for 0.19.0, because it starts autogenerating `text_signature` for `#[new]`. This could affect runtime behaviour if the user is relying on the class docs at runtime for some reason. Guide & tests all updated accordingly. `#[pyclass(text_signature = "...")]` is deprecated by this PR, however if it's set, it will be used in preference to `#[new]`. (The signature / `text_signature` from `#[new]` will simply be ignored in this case. I figure that when users fix their deprecation warnings by removing `#[pyclass(text_signature = "...")]` then the `#[new]` signatures will start flowing properly, and this is good enough.) Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Co-authored-by: Adam Reichold <adam.reichold@t-online.de>

bors · 2023-05-04T16:50:27Z

Build failed:

conclusion

adamreichold · 2023-05-04T16:51:38Z

bors retry

bors · 2023-05-04T17:31:32Z

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

conclusion

davidhewitt · 2023-05-04T17:38:14Z

Thanks 😅

2981: Remove 0.17 deprecations r=adamreichold,davidhewitt a=davidhewitt Since #2980 starts a breaking change for 0.19, let's also clean up all 0.17's deprecations. I've removed `Python::acquire_gil` in its own commit, as that was a reasonably chunky removal. Co-authored-by: Adam Reichold <adam.reichold@t-online.de> Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>

adamreichold reviewed Feb 22, 2023

View reviewed changes

pyo3-macros-backend/src/pyclass.rs Show resolved Hide resolved

adamreichold reviewed Feb 22, 2023

View reviewed changes

guide/src/class.md Show resolved Hide resolved

davidhewitt mentioned this pull request Feb 22, 2023

Remove 0.17 deprecations #2981

Merged

davidhewitt force-pushed the text-signature-new branch 2 times, most recently from 92a88fa to 3c9fbe7 Compare April 18, 2023 20:03

davidhewitt force-pushed the text-signature-new branch from 3c9fbe7 to b0e7dd8 Compare April 19, 2023 06:23

adamreichold reviewed Apr 19, 2023

View reviewed changes

src/pyclass/create_type_object.rs Outdated Show resolved Hide resolved

adamreichold approved these changes Apr 19, 2023

View reviewed changes

davidhewitt force-pushed the text-signature-new branch from b0e7dd8 to 8acb224 Compare April 19, 2023 21:16

support text_signature on #[new]

8bd17f0

davidhewitt force-pushed the text-signature-new branch from 8acb224 to 8bd17f0 Compare May 4, 2023 06:15

Do not assert class text signature using the limited API before versi…

bd4b550

…on 3.10 as we do not support it.

bors bot merged commit 1cdac4f into PyO3:main May 4, 2023
33 checks passed

davidhewitt deleted the text-signature-new branch May 4, 2023 17:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support `text_signature` on `#[new]` #2980

support `text_signature` on `#[new]` #2980

davidhewitt commented Feb 22, 2023 •

edited

davidhewitt commented Apr 18, 2023

adamreichold left a comment

davidhewitt commented Apr 19, 2023

bors bot commented Apr 19, 2023

adamreichold commented Apr 20, 2023

bors bot commented Apr 20, 2023

adamreichold commented Apr 20, 2023

adamreichold commented Apr 21, 2023 •

edited

davidhewitt commented May 4, 2023

bors bot commented May 4, 2023

adamreichold commented May 4, 2023

adamreichold commented May 4, 2023

adamreichold commented May 4, 2023

adamreichold commented May 4, 2023 •

edited

bors bot commented May 4, 2023

adamreichold commented May 4, 2023

bors bot commented May 4, 2023

davidhewitt commented May 4, 2023

support text_signature on #[new] #2980

support text_signature on #[new] #2980

Conversation

davidhewitt commented Feb 22, 2023 • edited

davidhewitt commented Apr 18, 2023

adamreichold left a comment

Choose a reason for hiding this comment

davidhewitt commented Apr 19, 2023

bors bot commented Apr 19, 2023

adamreichold commented Apr 20, 2023

bors bot commented Apr 20, 2023

adamreichold commented Apr 20, 2023

adamreichold commented Apr 21, 2023 • edited

davidhewitt commented May 4, 2023

bors bot commented May 4, 2023

adamreichold commented May 4, 2023

adamreichold commented May 4, 2023

adamreichold commented May 4, 2023

adamreichold commented May 4, 2023 • edited

bors bot commented May 4, 2023

adamreichold commented May 4, 2023

bors bot commented May 4, 2023

davidhewitt commented May 4, 2023

support `text_signature` on `#[new]` #2980

support `text_signature` on `#[new]` #2980

davidhewitt commented Feb 22, 2023 •

edited

adamreichold commented Apr 21, 2023 •

edited

adamreichold commented May 4, 2023 •

edited