◐ Shell
reader mode source ↗
Skip to content

gh-110964: Remove private _PyArg functions#110966

Merged
vstinner merged 2 commits into
python:mainfrom
vstinner:pycore_modsupport
Oct 17, 2023
Merged

gh-110964: Remove private _PyArg functions#110966
vstinner merged 2 commits into
python:mainfrom
vstinner:pycore_modsupport

Conversation

@vstinner

@vstinner vstinner commented Oct 17, 2023 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

Move the following private functions and structures to pycore_modsupport.h internal C API:

  • _PyArg_BadArgument()
  • _PyArg_CheckPositional()
  • _PyArg_NoKeywords()
  • _PyArg_NoPositional()
  • _PyArg_ParseStack()
  • _PyArg_ParseStackAndKeywords()
  • _PyArg_Parser structure
  • _PyArg_UnpackKeywords()
  • _PyArg_UnpackKeywordsWithVararg()
  • _PyArg_UnpackStack()
  • _Py_ANY_VARARGS()

Changes:

  • Python/getargs.h now includes pycore_modsupport.h to export functions.

  • clinic.py now adds pycore_modsupport.h when one of these functions is used.

  • Add pycore_modsupport.h includes when a C extension uses one of these functions.

  • Define Py_BUILD_CORE_MODULE in C extensions which now include directly or indirectly (via code generated by Argument Clinic) pycore_modsupport.h:

    • _csv
    • _curses_panel
    • _dbm
    • _gdbm
    • _multiprocessing.posixshmem
    • _sqlite.row
    • _statistics
    • grp
    • resource
    • syslog

  • _testcapi: bad_get() no longer uses METH_FASTCALL calling convention but METH_VARARGS. Replace _PyArg_UnpackStack() with PyArg_ParseTuple().

  • _testcapi: add PYTESTCAPI_NEED_INTERNAL_API macro which is defined by _testcapi sub-modules which need the internal C API (pycore_modsupport.h): exceptions.c, float.c, vectorcall.c, watchers.c.

  • Remove Include/cpython/modsupport.h header file. Include/modsupport.h no longer includes the removed header file.

@bedevere-app bedevere-app Bot mentioned this pull request Oct 17, 2023
Closed
@vstinner

vstinner commented Oct 17, 2023

Copy link
Copy Markdown
Member Author

This change is big because it changes 122 files generated by Argument Clinic:

$ git show --stat|grep 'clinic/.*.c.h'|wc -l
122

I prefer to write a single PR to move all private _PyArg functions at once, because each moved function touch many files generated by AC.

This was referenced Oct 17, 2023
Closed
Merged
AlexWaygood
AlexWaygood reviewed Oct 17, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

The AC changes look fine to me! (I'll leave the question of whether the changes are worth making to those more skilled in C.)

@vstinner
pythongh-110964: Remove private _PyArg functions …
46a846d 
Move the following private functions and structures to
pycore_modsupport.h internal C API:

* _PyArg_BadArgument()
* _PyArg_CheckPositional()
* _PyArg_NoKeywords()
* _PyArg_NoPositional()
* _PyArg_ParseStack()
* _PyArg_ParseStackAndKeywords()
* _PyArg_Parser structure
* _PyArg_UnpackKeywords()
* _PyArg_UnpackKeywordsWithVararg()
* _PyArg_UnpackStack()
* _Py_ANY_VARARGS()

Changes:

* Python/getargs.h now includes pycore_modsupport.h to export
  functions.
* clinic.py now adds pycore_modsupport.h when one of these functions
  is used.
* Add pycore_modsupport.h includes when a C extension uses one of
  these functions.
* Define Py_BUILD_CORE_MODULE in C extensions which now include
  directly or indirectly (via code generated by Argument Clinic)
  pycore_modsupport.h:

  * _csv
  * _curses_panel
  * _dbm
  * _gdbm
  * _multiprocessing.posixshmem
  * _sqlite.row
  * _statistics
  * grp
  * resource
  * syslog

* _testcapi: bad_get() no longer uses METH_FASTCALL calling
  convention but METH_VARARGS. Replace _PyArg_UnpackStack() with
  PyArg_ParseTuple().
* _testcapi: add PYTESTCAPI_NEED_INTERNAL_API macro which is defined
  by _testcapi sub-modules which need the internal C API
  (pycore_modsupport.h): exceptions.c, float.c, vectorcall.c,
  watchers.c.
* Remove Include/cpython/modsupport.h header file.
  Include/modsupport.h no longer includes the removed header file.
* Fix mypy clinic.py
@vstinner

vstinner commented Oct 17, 2023

Copy link
Copy Markdown
Member Author

For clinic.py, I was lazy and used the clinic global variable in bad_argument(). The correct fix is to pass a clinic argument to add bad_argument() methods and calling sites. Problem: there are many. Second problem: I wrote such change many times, but I lost my work since the overall change was blocked for different reasons. Also, I tried to keep this PR as small as possible.

In short, clinic.py should be reworked later, once this change lands.

@vstinner vstinner merged commit be5e8a0 into python:main Oct 17, 2023
@vstinner vstinner deleted the pycore_modsupport branch October 17, 2023 12:30
@vstinner

vstinner commented Oct 17, 2023

Copy link
Copy Markdown
Member Author

For clinic.py, I was lazy and used the clinic global variable in bad_argument().

I wrote PR #110984 for that.

@vstinner

vstinner commented Oct 17, 2023

Copy link
Copy Markdown
Member Author

I merged my PR. @AlexWaygood: thanks for reviewing clinic.py changes.

hroncok added a commit to hroncok/pygame that referenced this pull request Jun 18, 2024
@hroncok
Inline _PyArg_NoKeywords from Python 3.13 in case it is missing …
7f36fde 
Python 3.13 made this private:
python/cpython#110966

Fixes pygame#4099
@hroncok hroncok mentioned this pull request Jun 18, 2024
Merged
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@vstinner @Glyphack
pythongh-110964: Remove private _PyArg functions (python#110966) …
2fc8127 
Move the following private functions and structures to
pycore_modsupport.h internal C API:

* _PyArg_BadArgument()
* _PyArg_CheckPositional()
* _PyArg_NoKeywords()
* _PyArg_NoPositional()
* _PyArg_ParseStack()
* _PyArg_ParseStackAndKeywords()
* _PyArg_Parser structure
* _PyArg_UnpackKeywords()
* _PyArg_UnpackKeywordsWithVararg()
* _PyArg_UnpackStack()
* _Py_ANY_VARARGS()

Changes:

* Python/getargs.h now includes pycore_modsupport.h to export
  functions.
* clinic.py now adds pycore_modsupport.h when one of these functions
  is used.
* Add pycore_modsupport.h includes when a C extension uses one of
  these functions.
* Define Py_BUILD_CORE_MODULE in C extensions which now include
  directly or indirectly (via code generated by Argument Clinic)
  pycore_modsupport.h:

  * _csv
  * _curses_panel
  * _dbm
  * _gdbm
  * _multiprocessing.posixshmem
  * _sqlite.row
  * _statistics
  * grp
  * resource
  * syslog

* _testcapi: bad_get() no longer uses METH_FASTCALL calling
  convention but METH_VARARGS. Replace _PyArg_UnpackStack() with
  PyArg_ParseTuple().
* _testcapi: add PYTESTCAPI_NEED_INTERNAL_API macro which is defined
  by _testcapi sub-modules which need the internal C API
  (pycore_modsupport.h): exceptions.c, float.c, vectorcall.c,
  watchers.c.
* Remove Include/cpython/modsupport.h header file.
  Include/modsupport.h no longer includes the removed header file.
* Fix mypy clinic.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood left review comments

@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland erlend-aasland is a code owner

@corona10 corona10 corona10 is a code owner

@ethanfurman ethanfurman Awaiting requested review from ethanfurman

@rhettinger rhettinger Awaiting requested review from rhettinger rhettinger is a code owner

@berkerpeksag berkerpeksag Awaiting requested review from berkerpeksag

@pganssle pganssle Awaiting requested review from pganssle

@abalkin abalkin Awaiting requested review from abalkin

@brettcannon brettcannon Awaiting requested review from brettcannon

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

@ncoghlan ncoghlan

@warsaw warsaw Awaiting requested review from warsaw

@tiran tiran Awaiting requested review from tiran

@iritkatriel iritkatriel Awaiting requested review from iritkatriel

@markshannon markshannon Awaiting requested review from markshannon

@1st1 1st1

@asvetlov asvetlov

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

@kumaraditya303 kumaraditya303 Awaiting requested review from kumaraditya303

@willingc willingc Awaiting requested review from willingc willingc is a code owner

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vstinner @AlexWaygood