Skip to content
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

gh-107805: Fix signatures of module-level generated functions in turtle #107807

Merged
merged 7 commits into from
Sep 1, 2023
Merged

gh-107805: Fix signatures of module-level generated functions in turtle #107807

merged 7 commits into from
Sep 1, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Aug 9, 2023 •
edited by bedevere-bot
Loading

Now we are using inspect.signature which works correct for all possible parameter types.
There are no / params to test it, but it uses the same branch as regular pos-or-keyword params, so it should be fine.

Related #103974

@bedevere-bot bedevere-bot mentioned this pull request Aug 9, 2023
Closed
@sobolevn
Copy link
Member Author

sobolevn commented Aug 9, 2023

I think that this can go into rc2, because it fixes a bug which makes turtle.teleport unusable.

@gpshead gpshead added type-bug An unexpected behavior, bug, or error needs backport to 3.12 bug and security fixes release-blocker labels Aug 10, 2023
@gpshead gpshead self-assigned this Aug 10, 2023
gpshead
gpshead requested changes Aug 10, 2023
View reviewed changes
Copy link
Member

@gpshead gpshead left a comment

Choose a reason for hiding this comment

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

likely good, but i'll take a closer look tomorrow. one suggestion added.

Lib/turtle.py Outdated Show resolved Hide resolved
@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

gpshead
gpshead reviewed Aug 18, 2023
View reviewed changes
Lib/test/test_turtle.py Outdated
'pen': '(pen=None, **pendict)',
}

for name in turtle.__all__:
Copy link
Member

Choose a reason for hiding this comment

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

The purpose of this test is only to verify known signatures, correct?

In that case, looping over known_signatures.items() rather than turtle.__all__ makes more sense. Otherwise a typo in a known_signatures name key would go silently unnoticed and we're otherwise creating subtests for all names in turtle even though most of them don't test anything.

serhiy-storchaka
serhiy-storchaka requested changes Aug 18, 2023
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Well, I think that it would be nice to add also tests for the original issue:

  • Call teleport() without arguments.
  • Call teleport() with three positional arguments (it should fail).

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@sobolevn
Copy link
Member Author

I've addressed @gpshead comments about the test case, but I don't think that I can actually test these functions:

  1. Nothing similar is tested in test_turtle, it simply does not have any Turtle class tests at all
  2. I don't know anything about tkinter
  3. I don't really think that we should add test foundation for it in this specific PR
  4. inspect works with real python function signature, so it is at least something

If anyone wants to contribute some tkinter-based tests for Turtle class, I would be happy to include teleport test there 👍

serhiy-storchaka
serhiy-storchaka approved these changes Aug 27, 2023
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Well, testing module-level turtle function is a non-trivial task.

gpshead
gpshead approved these changes Sep 1, 2023
View reviewed changes
Copy link
Member

@gpshead gpshead left a comment

Choose a reason for hiding this comment

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

I manually tested that turtle.Turtle() appears to work and that Turtle.teleport works.

@gpshead gpshead merged commit 044b8b3 into python:main Sep 1, 2023
23 of 24 checks passed
@miss-islington
Copy link
Contributor

Thanks @sobolevn for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 1, 2023
@sobolevn @AlexWaygood @miss-islington
pythongh-107805: Fix signatures of module-level generated functions i…
712dede 
…n `turtle` (pythonGH-107807)

(cherry picked from commit 044b8b3)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot
Copy link

GH-108749 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Sep 1, 2023
Yhg1s pushed a commit that referenced this pull request Sep 1, 2023
@miss-islington @sobolevn @AlexWaygood
[3.12] gh-107805: Fix signatures of module-level generated functions …
5668309 
…in `turtle` (GH-107807) (#108749)

gh-107805: Fix signatures of module-level generated functions in `turtle` (GH-107807)
(cherry picked from commit 044b8b3)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gpshead gpshead gpshead approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@terryjreedy terryjreedy Awaiting requested review from terryjreedy

Assignees

@gpshead gpshead

Labels
release-blocker type-bug An unexpected behavior, bug, or error
Projects
Release and Deferred blockers 🚫
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@sobolevn @bedevere-bot @miss-islington @gpshead @serhiy-storchaka @AlexWaygood