Commit20b7c79

authored

gh-104922: Doc: add note about PY_SSIZE_T_CLEAN (#106314)

Add note about PY_SSIZE_T_CLEAN in extending and embedding document.

1 parent5950e7d commit20b7c79Copy full SHA for 20b7c79

File tree

+11

-2

lines changed

+11

-2

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,13 @@ perform some operation on a file. ::`
`87`	`87`	`Py_ExitStatusException(status);`
`88`	`88`	`}`
`89`	`89`
	`90`	`+..note::`
	`91`	`+`
	`92`	+ ``#define PY_SSIZE_T_CLEAN`` was used to indicate that ``Py_ssize_t`` should be
	`93`	+ used in some APIs instead of ``int``.
	`94`	`+ It is not necessary since Python 3.13, but we keep it here for backward compatibility.`
	`95`	+ See:ref:`arg-parsing-string-and-buffers` for a description of this macro.
	`96`	`+`
`90`	`97`	Setting:c:member:`PyConfig.program_name` should be called before
`91`	`98`	:c:func:`Py_InitializeFromConfig` to inform the interpreter about paths to Python run-time
`92`	`99`	`libraries. Next, the Python interpreter is initialized with`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -69,8 +69,10 @@ the module and a copyright notice if you like).`
`69`	`69`	headers on some systems, you must include:file:`Python.h` before any standard
`70`	`70`	`headers are included.`
`71`	`71`
`72`		- It is recommended to always define ``PY_SSIZE_T_CLEAN`` before including
`73`		- ``Python.h``. See:ref:`arg-parsing-string-and-buffers` for a description of this macro.
	`72`	+ ``#define PY_SSIZE_T_CLEAN`` was used to indicate that ``Py_ssize_t`` should be
	`73`	+ used in some APIs instead of ``int``.
	`74`	`+ It is not necessary since Python 3.13, but we keep it here for backward compatibility.`
	`75`	+ See:ref:`arg-parsing-string-and-buffers` for a description of this macro.
`74`	`76`
`75`	`77`	All user-visible symbols defined by:file:`Python.h` have a prefix of ``Py`` or
`76`	`78`	``PY``, except those defined in standard header files. For convenience, and

Comments

(0)