summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorPablo Galindo <Pablogsal@gmail.com>2019-07-01 10:35:05 (GMT)
committerPetr Viktorin <pviktori@redhat.com>2019-07-01 10:35:05 (GMT)
commit4a2edc34a405150d0b23ecfdcb401e7cf59f4650 (patch)
treed4d88459768f103b76ce92536ba047b305ae0d24 /Doc
parentfc1fbe6099e826e8304eadf781af7c10d739fc40 (diff)
downloadcpython-4a2edc34a405150d0b23ecfdcb401e7cf59f4650.zip
cpython-4a2edc34a405150d0b23ecfdcb401e7cf59f4650.tar.gz
cpython-4a2edc34a405150d0b23ecfdcb401e7cf59f4650.tar.bz2
bpo-37221: Add PyCode_NewWithPosOnlyArgs to be used internally and set PyCode_New as a compatibility wrapper (GH-13959)
Add PyCode_NewEx to be used internally and set PyCode_New as a compatibility wrapper
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/code.rst21
-rw-r--r--Doc/data/refcounts.dat19
-rw-r--r--Doc/whatsnew/3.8.rst5
3 files changed, 34 insertions, 11 deletions
diff --git a/Doc/c-api/code.rst b/Doc/c-api/code.rst
index 7353df5..3c4f669 100644
--- a/Doc/c-api/code.rst
+++ b/Doc/c-api/code.rst
@@ -33,20 +33,21 @@ bound into a function.
Return the number of free variables in *co*.
-.. c:function:: PyCodeObject* PyCode_New(int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *lnotab)
+.. c:function:: PyCodeObject* PyCode_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *lnotab)
- Return a new code object. If you need a dummy code object to
- create a frame, use :c:func:`PyCode_NewEmpty` instead. Calling
- :c:func:`PyCode_New` directly can bind you to a precise Python
- version since the definition of the bytecode changes often.
-
- .. versionchanged:: 3.8
- An extra parameter is required (*posonlyargcount*) to support :PEP:`570`.
- The first parameter (*argcount*) now represents the total number of positional arguments,
- including positional-only.
+ Return a new code object. If you need a dummy code object to create a frame,
+ use :c:func:`PyCode_NewEmpty` instead. Calling :c:func:`PyCode_New` directly
+ can bind you to a precise Python version since the definition of the bytecode
+ changes often.
.. audit-event:: code.__new__ code,filename,name,argcount,posonlyargcount,kwonlyargcount,nlocals,stacksize,flags c.PyCode_New
+.. c:function:: PyCodeObject* PyCode_NewWithPosOnlyArgs(int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *lnotab)
+
+ Similar to :c:func:`PyCode_New`, but with an extra "posonlyargcount" for positonal-only arguments.
+
+ .. versionadded:: 3.8
+
.. c:function:: PyCodeObject* PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)
Return a new empty code object with the specified filename,
diff --git a/Doc/data/refcounts.dat b/Doc/data/refcounts.dat
index aca57a1..fda347e 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -234,9 +234,26 @@ PyCode_Check:PyObject*:co:0:
PyCode_GetNumFree:int:::
PyCode_GetNumFree:PyCodeObject*:co:0:
+PyCode_NewWithPosOnlyArgs:PyCodeObject*::+1:
+PyCode_NewWithPosOnlyArgs:int:argcount::
+PyCode_NewWithPosOnlyArgs:int:posonlyargcount::
+PyCode_NewWithPosOnlyArgs:int:kwonlyargcount::
+PyCode_NewWithPosOnlyArgs:int:nlocals::
+PyCode_NewWithPosOnlyArgs:int:stacksize::
+PyCode_NewWithPosOnlyArgs:int:flags::
+PyCode_NewWithPosOnlyArgs:PyObject*:code:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:consts:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:names:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:varnames:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:freevars:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:cellvars:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:filename:0:
+PyCode_NewWithPosOnlyArgs:PyObject*:name:0:
+PyCode_NewWithPosOnlyArgs:int:firstlineno::
+PyCode_NewWithPosOnlyArgs:PyObject*:lnotab:0:
+
PyCode_New:PyCodeObject*::+1:
PyCode_New:int:argcount::
-PyCode_New:int:posonlyargcount::
PyCode_New:int:kwonlyargcount::
PyCode_New:int:nlocals::
PyCode_New:int:stacksize::
diff --git a/Doc/whatsnew/3.8.rst b/Doc/whatsnew/3.8.rst
index 46e531f..5aab191 100644
--- a/Doc/whatsnew/3.8.rst
+++ b/Doc/whatsnew/3.8.rst
@@ -1045,6 +1045,11 @@ Build and C API Changes
allocation or deallocation may need to be adjusted.
(Contributed by Eddie Elizondo in :issue:`35810`.)
+* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create
+ code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
+ parameter for indicating the number of positional-only arguments.
+ (Contributed by Pablo Galindo in :issue:`37221`.)
+
Deprecated
==========