gh-104683: Rework Argument Clinic error handling by erlend-aasland · Pull Request #107551 · python/cpython

erlend-aasland · 2023-08-01T23:18:38Z

Introduce ClinicError and ClinicWarning:

fail() raises ClinicError
warn() uses warnings.warn(msg, ClinicWarning)

In main(), catch ClinicError, format the error message,
print to stderr, and exit with an error. Adapt the test
suite accordingly.

Issue: Modernise code in Tools/clinic/ #104683

- Introduce ClinicError and ClinicWarning - fail() raises ClinicError - warn() uses warnings.warn(msg, ClinicWarning) - the CLI runs main(), catches ClinicError, formats the error message prints to stderr and exits with an error - adapt the test suite to work with ClinicError

This reverts commit 7b631a3.

erlend-aasland · 2023-08-02T14:59:50Z

Ready for a new round of review! Finally, all (or most) line number are now correct. If I introduce an error in Lib/test/clinic.test.c, I now get an accurate line number. Yay! I'm not sure why some of the tests are off by one, though. Perhaps it has to do with FakeClinic.

erlend-aasland · 2023-08-02T15:01:27Z

+ try:
+ self.state(line)
+ except ClinicError as exc:
+ raise ClinicError(str(exc), filename=exc.filename, lineno=line_number)


IMO, this is a workaround! We should ensure that line numbers are correctly updated in the state machine. Let's create an issue about this.

I'd like to keep the workaround for now; it really helps to have accurate line numbers when debugging.

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

AlexWaygood · 2023-08-02T15:43:08Z

I had an idea for how to deduplicate some code between warn_and_fail() and the main() function -- made a PR to your branch at erlend-aasland#49

AlexWaygood

One last suggestion to help future maintainers -- looks great to me otherwise!

AlexWaygood

Thanks! :D

erlend-aasland · 2023-08-02T23:40:13Z

Great, thank you; this PR is in a lot better shape now 😄

erlend-aaslandand others added 10 commits July 30, 2023 00:33

Merge branch 'main' into clinic/warn-and-fail
9cb2ce9

Adapt new test
789f5ee

Pull in main
15a246b

Pull in main
e32d221

Align with Alex's changes
4350ecc

Address review: pass iso. ellipse
ad5181a

Address review: add return annotation
545e7b6

Address review: re.escape
c978a6d

Address review: fix test
33b038c

erlend-aasland requested a review from AlexWaygood as a code owner August 1, 2023 23:18

bedevere-bot added the awaiting core review label Aug 1, 2023

bedevere-bot mentioned this pull request Aug 1, 2023
Modernise code in Tools/clinic/#104683
Closed
7 tasks

erlend-aasland added the skip news label Aug 1, 2023

AlexWaygood reviewed Aug 1, 2023
View reviewed changes

Comment threadTools/clinic/clinic.py Outdated

AlexWaygood reviewed Aug 1, 2023
View reviewed changes

Comment threadLib/test/test_clinic.py

erlend-aasland added 4 commits August 2, 2023 01:46

Refactor: extract method parse_parameter_name()
7b631a3

Address review: re.escape better
553cb6e

Address review: UserWarning iso. Warning
1514f63

Revert "Refactor: extract method parse_parameter_name()"
d3daef7
This reverts commit 7b631a3.

AlexWaygood reviewed Aug 2, 2023
View reviewed changes

Comment threadLib/test/test_clinic.py Outdated

Pull in main
aa38570

AlexWaygood reviewed Aug 2, 2023
View reviewed changes

Comment threadTools/clinic/clinic.py Outdated

Print debug stuff to stderr
8f3750b

AlexWaygood reviewed Aug 2, 2023
View reviewed changes

Comment threadTools/clinic/clinic.py Outdated

erlend-aasland added 5 commits August 2, 2023 12:02

Adapt test
e8b8d7e

Print to stdout instead of using warnings.warn
79b9859

Final touches
57eff9d

Pull in main
5b8dea9

Fix merge
6f5cfae

bedevere-bot removed the awaiting core review label Aug 2, 2023

AlexWaygood reviewed Aug 2, 2023
View reviewed changes

Comment threadLib/test/test_clinic.py Outdated
Comment threadLib/test/test_clinic.py Outdated
Comment threadLib/test/test_clinic.py Outdated
Comment threadLib/test/test_clinic.py Outdated

AlexWaygood reviewed Aug 2, 2023
View reviewed changes

Comment threadTools/clinic/clinic.py

erlend-aasland added 4 commits August 2, 2023 16:03

Try to produce correct line numbers in error messages
3081729

Fixup CLI error formatting
716bda8

Fix reraise of ClinicError in parse()
af79481

Adjust tests again
d109b63

erlend-aasland marked this pull request as ready for review August 2, 2023 14:58

bedevere-bot added the awaiting core review label Aug 2, 2023

erlend-aasland commented Aug 2, 2023
View reviewed changes

Remove unused import
ecbfe2c

AlexWaygood reviewed Aug 2, 2023
View reviewed changes

Comment threadTools/clinic/clinic.py Outdated

Mutate the exception
90e1bc9
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

AlexWaygoodand others added 2 commits August 2, 2023 18:06

Share more code between thewarn()andfail()branches (#49)
7766c3d

Pull in main
3d9d6c6

erlend-aasland mentioned this pull request Aug 2, 2023
Argument Clinic reports incorrect line numbers on error #107570
Open

AlexWaygood approved these changes Aug 2, 2023
View reviewed changes

Comment threadLib/test/test_clinic.py

bedevere-bot added awaiting merge and removed awaiting core review labels Aug 2, 2023

erlend-aasland added 2 commits August 3, 2023 01:22

Pull in main
8573928

Add docstring to _expect_failure
fcd4721

AlexWaygood approved these changes Aug 2, 2023
View reviewed changes

erlend-aasland enabled auto-merge (squash) August 2, 2023 23:39

erlend-aasland merged commit 1cd479c into python:mainAug 3, 2023

bedevere-bot removed the awaiting merge label Aug 3, 2023

erlend-aasland deleted the clinic/warn-and-fail branch August 3, 2023 07:26

AlexWaygood mentioned this pull request Aug 4, 2023
[3.12] gh-107609: Fix duplicate module check in Argument Clinic (GH-107610) #107612
Closed

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Aug 1, 2023• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Aug 2, 2023

Uh oh!

erlend-aaslandAug 2, 2023

Choose a reason for hiding this comment

Uh oh!

erlend-aaslandAug 2, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AlexWaygood commented Aug 2, 2023

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Aug 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

erlend-aasland commented Aug 1, 2023•
edited by bedevere-bot
Loading