feat: support pyclass on tuple enums #4072

newcomertv · 2024-04-12T20:42:25Z

#3748
Based on @mkovaxx 's https://github.com/PyO3/pyo3/pull/3582/files

Adds support for #[pyclass] for enums containing Tuple Variants.

Supports:

Pattern matching
Accessing by field ._id
Accessing by array [id]
Len (elements in the tuple)

This introduces an issue that I didn't know how to solve quickly: Since the fields have no identifiers I need to create them inside the derive macro. Since they need to outlive their context where they are created as FnArg requires a &'a Ident I ended up creating a Box::leak based identifier.

I'm not sure how bad this is in the first place since it is only during the build process (code gen) and extremely small.

Addressing the getitem issue the comments on #4135 were very helpful.
Thanks to @carderne for fixing the doc issues, trying to solve the getitem problem and seeing the value in this PR :) - I had a few busy weeks and didn't get to continue working on this PR until now.

I hope I didn't miss any further documentation requirements or am missing any testcases.

Blocking issues:

@birkenfield suggested refactoring FnArg to take a Cow instead. I don't think this should be part of this PR.
If we need this before this PR gets merged I can open a seperate PR. (Though I'm not keen on it). A tracking issue has been opened within Replace &'a Ident with Cow in FnArg Enum #4156
@Icxolu I'm not sure if __match_args__ needs to be generated as we already support matching through the subclass generation.

guide/src/class.md

pyo3-macros-backend/src/pyclass.rs

pytests/src/enums.rs

Icxolu

Thanks for following on this. Don't worry about being busy, happens to all of us, sometimes there are more important things.

This is already looking very good to me. I left a few comments to simplify the code a bit. Regarding using Cow in FnArg, that was not my suggestion, but I agree with that. While leaking would probably be fine, I think using Cow would be the cleaner solution. If you would like open a separate PR for that, that would be fine with me.

Also just giving @carderne a ping, such that we don't duplicate work.

pyo3-macros-backend/src/pymethod.rs

guide/src/class.md

pyo3-macros-backend/src/pyclass.rs

pytests/tests/test_enums.py

pytests/tests/test_enums_match.py

pyo3-macros-backend/src/pyclass.rs

Icxolu

Thank you very much 🙏 . I think we're getting really close now 🚀.

The slot and __match_args__ handling looks great.

I marked a few spots, where we can reduce some code and some (optional) style nits.
There are two pieces that I would like to address before merge.

For the documentation in the guide I think we should encourage using indexing and tuple match for these tuple variants. This should be a pretty minor change just adapting the examples.

The second point is to also support constructor customization here, which we just landed for struct variants in #4158. This should also be a pretty simple change and I added a note in the corresponding place.

(I hope I'm not putting too much additional work on your table 🙃 )

pyo3-macros-backend/src/pyclass.rs

pytests/tests/test_enums_match.py

guide/src/class.md

pytests/src/enums.rs

newcomertv · 2024-05-14T06:31:46Z

Am I missing anything else or is this ready for final review?

Icxolu

This looks good to me now. clippy-beta is failing right now, but once that's fixed I think this is good to go 🚀 . Thanks again for putting in the effort and pushing this over the line!

davidhewitt · 2024-05-15T00:51:51Z

As conclusion is still green I think this can merge even if clippy beta is unhappy.

carderne · 2024-05-15T07:42:45Z

Nice work @newcomertv, I'm learning a bit going through where I went wrong trying to figure this out.
(And looking forward to using this feature!)

davidhewitt

Looks great to me too, with just a few suggestions...

guide/src/class.md

pyo3-macros-backend/src/pyclass.rs

newcomertv · 2024-05-15T17:51:01Z

Thanks for the review.

I‘m quite busy right now. I‘ll try to take a look and fix those tomorrow or the day after.

…um tuple

- take py from function argument on get_item - make more general slot def implementation - remove unnecessary function arguments - add testcases for uncovered cases including future feature match_args

- clippy beta - better compile error (+related doc and test)

newcomertv · 2024-05-16T21:55:06Z

I hope this fixes the remaining issues. :-)

( gh-pages appears to have failed due to lychee being unable to reach tokio.rs )

davidhewitt

Looks great to me too, thanks again!

Icxolu reviewed Apr 12, 2024

View reviewed changes

guide/src/class.md Outdated Show resolved Hide resolved

birkenfeld reviewed Apr 13, 2024

View reviewed changes

carderne mentioned this pull request Apr 29, 2024

feat: support pyclass on tuple enums (closer but not there yet) #4135

Closed

3 tasks

newcomertv closed this May 1, 2024

newcomertv force-pushed the main branch from 81a25b6 to a454f6e Compare May 1, 2024 19:18

newcomertv reopened this May 1, 2024

Icxolu reviewed May 1, 2024

View reviewed changes

newcomertv force-pushed the main branch from 20f075a to 24c48eb Compare May 4, 2024 10:01

newcomertv mentioned this pull request May 4, 2024

Replace &'a Ident with Cow in FnArg Enum #4156

Closed

Icxolu reviewed May 4, 2024

View reviewed changes

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

Icxolu mentioned this pull request May 4, 2024

store the FnArg ident as a Cow instead of a reference #4157

Merged

newcomertv force-pushed the main branch from b80d755 to 98ce858 Compare May 10, 2024 12:05

Icxolu reviewed May 10, 2024

View reviewed changes

newcomertv commented May 11, 2024

View reviewed changes

pytests/src/enums.rs Outdated Show resolved Hide resolved

newcomertv force-pushed the main branch 2 times, most recently from a85b94b to 160ad27 Compare May 14, 2024 06:30

Icxolu approved these changes May 14, 2024

View reviewed changes

davidhewitt reviewed May 15, 2024

View reviewed changes

guide/src/class.md Outdated Show resolved Hide resolved

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

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

newcomertv and others added 8 commits May 16, 2024 22:59

feat: support pyclass on tuple enums

4960de3

cargo fmt

53c95f6

changelog

e051a5f

ruff format

eaf5265

rebase with adaptation for FnArg refactor

51d434f

fix class.md from pr comments

9c540ed

add enum tuple variant getitem implementation

7b06fe5

fmt

3c48775

newcomertv added 16 commits May 16, 2024 22:59

progress toward getitem and len impl on derive pyclass for complex en…

a2f582c

…um tuple

working getitem and len slots for complex tuple enum pyclass derivation

d72a893

refactor code generation

13aa7a0

address PR concerns

47cd6ce

- take py from function argument on get_item - make more general slot def implementation - remove unnecessary function arguments - add testcases for uncovered cases including future feature match_args

add tracking issue

07710d3

fmt

94da194

ruff

1921898

remove me

41a33ea

support match_args for tuple enum

91c457f

integrate FnArg now takes Cow

9ae0a48

fix empty and single element tuples

73b7a8f

use impl_py_slot_def for cimplex tuple enum slots

5bd5690

reverse erroneous doc change

78d5078

Address latest comments

0761854

formatting suggestion

7dd1a93

fix :

6d7596e

- clippy beta - better compile error (+related doc and test)

newcomertv force-pushed the main branch from 160ad27 to 6d7596e Compare May 16, 2024 21:24

davidhewitt approved these changes May 17, 2024

View reviewed changes

davidhewitt added this pull request to the merge queue May 17, 2024

Merged via the queue into PyO3:main with commit 88f2f6f May 17, 2024
43 checks passed

carderne mentioned this pull request May 20, 2024

basic enum forwarding to python carderne/bean-rs#2

Merged

davidhewitt mentioned this pull request Oct 11, 2024

Consider support for tuple variants in complex enums #3748

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support pyclass on tuple enums #4072

feat: support pyclass on tuple enums #4072

newcomertv commented Apr 12, 2024 •

edited

Loading

Icxolu left a comment

Icxolu left a comment

newcomertv commented May 14, 2024

Icxolu left a comment

davidhewitt commented May 15, 2024

carderne commented May 15, 2024

davidhewitt left a comment

newcomertv commented May 15, 2024

newcomertv commented May 16, 2024

davidhewitt left a comment

feat: support pyclass on tuple enums #4072

feat: support pyclass on tuple enums #4072

Conversation

newcomertv commented Apr 12, 2024 • edited Loading

Icxolu left a comment

Choose a reason for hiding this comment

Icxolu left a comment

Choose a reason for hiding this comment

newcomertv commented May 14, 2024

Icxolu left a comment

Choose a reason for hiding this comment

davidhewitt commented May 15, 2024

carderne commented May 15, 2024

davidhewitt left a comment

Choose a reason for hiding this comment

newcomertv commented May 15, 2024

newcomertv commented May 16, 2024

davidhewitt left a comment

Choose a reason for hiding this comment

newcomertv commented Apr 12, 2024 •

edited

Loading