cpython/Doc/c-api/code.rst

51 lines
1.6 KiB
ReStructuredText
Raw Normal View History

.. highlightlang:: c
.. _codeobjects:
Code Objects
------------
.. sectionauthor:: Jeffrey Yasskin <jyasskin@gmail.com>
.. index::
object: code
Code objects are a low-level detail of the CPython implementation.
Each one represents a chunk of executable code that hasn't yet been
bound into a function.
2012-01-14 11:42:02 -04:00
.. c:type:: PyCodeObject
The C structure of the objects used to describe code objects. The
fields of this type are subject to change at any time.
2012-01-14 11:42:02 -04:00
.. c:var:: PyTypeObject PyCode_Type
2012-01-14 11:42:02 -04:00
This is an instance of :c:type:`PyTypeObject` representing the Python
:class:`code` type.
2012-01-14 11:42:02 -04:00
.. c:function:: int PyCode_Check(PyObject *co)
Return true if *co* is a :class:`code` object
2012-01-14 11:42:02 -04:00
.. c:function:: int PyCode_GetNumFree(PyObject *co)
Return the number of free variables in *co*.
2012-01-14 11:42:02 -04:00
.. c:function:: PyCodeObject *PyCode_New(int argcount, 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
2012-01-14 11:42:02 -04:00
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.
2012-01-14 11:42:02 -04:00
.. c:function:: int PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)
Return a new empty code object with the specified filename,
function name, and first line number. It is illegal to
:keyword:`exec` or :func:`eval` the resulting code object.