gh-95065: Argument Clinic: Add functional tests of deprecated positionals

[erlend-aasland]

Move the "deprecated positinal" tests from clinic.test.c to
_testclinic.c. Mock PY_VERSION_HEX in order to prevent the generated
compiler warnings/errors to trigger. Put clinic code for deprecated
positionals in Modules/clinic/_testclinic_depr_star.c.h for easy
inspection of the generated code.

• Issue: Argument Clinic: add support for deprecating positional use of parameters #95065

[erlend-aasland]

The big diff is caused by moving the generated clinic code.

[erlend-aasland]

@serhiy-storchaka, IMO this is better than visual inspection of the generated code. We want to prevent regressions because of future refactorings, features and bugfixes.

[AlexWaygood]

The CI currently isn't running on this PR due to merge conflicts -- I tried building with it locally, but it causes build failures on Windows:

Build FAILED.
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(11,1): error C2133: 'deprecate_positional_pos0_len1__doc__': unknown size [C:\Users\
alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(98,1): error C2133: 'deprecate_positional_pos0_len2__doc__': unknown size [C:\Users\
alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(188,1): error C2133: 'deprecate_positional_pos0_len3_with_kwd__doc__': unknown size
[C:\Users\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(287,1): error C2133: 'deprecate_positional_pos1_len1_optional__doc__': unknown size
[C:\Users\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(383,1): error C2133: 'deprecate_positional_pos1_len1__doc__': unknown size [C:\Users
\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(473,1): error C2133: 'deprecate_positional_pos1_len2_with_kwd__doc__': unknown size
[C:\Users\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(572,1): error C2133: 'deprecate_positional_pos2_len1__doc__': unknown size [C:\Users
\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(664,1): error C2133: 'deprecate_positional_pos2_len2__doc__': unknown size [C:\Users
\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
C:\Users\alexw\coding\cpython\Modules\clinic\_testclinic_depr_star.c.h(758,1): error C2133: 'deprecate_positional_pos2_len3_with_kwd__doc__': unknown size
[C:\Users\alexw\coding\cpython\PCbuild\_testclinic.vcxproj]
0 Warning(s)
9 Error(s)

[erlend-aasland]

The CI currently isn't running on this PR due to merge conflicts -- I tried building with it locally, but it causes build failures on Windows:

Does it still happen?

[erlend-aasland]

The output directive has a bug that prevents us from specifying the stack index. We should fix that in a separate PR.

[AlexWaygood]

The CI currently isn't running on this PR due to merge conflicts -- I tried building with it locally, but it causes build failures on Windows:

Does it still happen?

Nope! Builds fine locally now :)

[serhiy-storchaka]

Would not be better to use version like 100.200 to avoid rewriting tests every year?

[erlend-aasland]

Would not be better to use version like 100.200 to avoid rewriting tests every year?

No need, we mock the version.

[serhiy-storchaka]

Do the test fail if change the stacklevel argument in PyErr_WarnEx() from 1 to 2?

[erlend-aasland]

Do the test fail if change the stacklevel argument in PyErr_WarnEx() from 1 to 2?

They do not. The same filename is produced for both stack levels.

[serhiy-storchaka]

And wrong stacklevel is a common error. Even your original code did have it wrong initially. Therefore, I think it is important to check it using one of the methods I suggested above.

[erlend-aasland]

Note: we will get merge conflicts from #107808.

[AlexWaygood]

I agree with Serhiy that explicitly testing the stacklevel would be good. Other than that, this is looking much better now, thanks! The readabiliy is much improved :)

[AlexWaygood]

I'm happy if Serhiy's happy!

[serhiy-storchaka]

Few nitpicks and LGTM.

[erlend-aasland]

Thank you Serhiy and Alex; this PR is in much better shape now! With this, we've got a nice framework for similar tests in place. I'll start working on what's left in clinic.test.c.