code.rst 1.63 KB
Newer Older
1 2 3 4
.. highlightlang:: c

.. _codeobjects:

5 6
.. index:: object; code, code object

7 8 9 10 11 12 13 14 15
Code Objects
------------

.. sectionauthor:: Jeffrey Yasskin <jyasskin@gmail.com>

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.

16
.. c:type:: PyCodeObject
17 18 19 20 21

   The C structure of the objects used to describe code objects.  The
   fields of this type are subject to change at any time.


22
.. c:var:: PyTypeObject PyCode_Type
23

24
   This is an instance of :c:type:`PyTypeObject` representing the Python
25 26 27
   :class:`code` type.


28
.. c:function:: int PyCode_Check(PyObject *co)
29

30
   Return true if *co* is a :class:`code` object.
31

32
.. c:function:: int PyCode_GetNumFree(PyCodeObject *co)
33 34 35

   Return the number of free variables in *co*.

36
.. 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)
37 38

   Return a new code object.  If you need a dummy code object to
39 40
   create a frame, use :c:func:`PyCode_NewEmpty` instead.  Calling
   :c:func:`PyCode_New` directly can bind you to a precise Python
41 42 43
   version since the definition of the bytecode changes often.


44
.. c:function:: PyCodeObject* PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)
45 46 47

   Return a new empty code object with the specified filename,
   function name, and first line number.  It is illegal to
48
   :func:`exec` or :func:`eval` the resulting code object.