0x1949 Team - FAZEMRX - MANAGER

Edit File: extending.html

<!DOCTYPE html>

<title>Extending/Embedding FAQ &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Python on Windows FAQ" href="windows.html" />
 <link rel="prev" title="Library and Extension FAQ" href="library.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/faq/extending.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/faq/extending.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="windows.html" title="Python on Windows FAQ"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="library.html" title="Library and Extension FAQ"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python Frequently Asked Questions</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Extending/Embedding FAQ</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="extending-embedding-faq">
<h1><a class="toc-backref" href="#id2">Extending/Embedding FAQ</a><a class="headerlink" href="#extending-embedding-faq" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
Contents
<ul class="simple">
<li><a class="reference internal" href="#extending-embedding-faq" id="id2">Extending/Embedding FAQ</a>
<ul>
<li><a class="reference internal" href="#can-i-create-my-own-functions-in-c" id="id3">Can I create my own functions in C?</a></li>
<li><a class="reference internal" href="#id1" id="id4">Can I create my own functions in C++?</a></li>
<li><a class="reference internal" href="#writing-c-is-hard-are-there-any-alternatives" id="id5">Writing C is hard; are there any alternatives?</a></li>
<li><a class="reference internal" href="#how-can-i-execute-arbitrary-python-statements-from-c" id="id6">How can I execute arbitrary Python statements from C?</a></li>
<li><a class="reference internal" href="#how-can-i-evaluate-an-arbitrary-python-expression-from-c" id="id7">How can I evaluate an arbitrary Python expression from C?</a></li>
<li><a class="reference internal" href="#how-do-i-extract-c-values-from-a-python-object" id="id8">How do I extract C values from a Python object?</a></li>
<li><a class="reference internal" href="#how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length" id="id9">How do I use Py_BuildValue() to create a tuple of arbitrary length?</a></li>
<li><a class="reference internal" href="#how-do-i-call-an-object-s-method-from-c" id="id10">How do I call an object’s method from C?</a></li>
<li><a class="reference internal" href="#how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr" id="id11">How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)?</a></li>
<li><a class="reference internal" href="#how-do-i-access-a-module-written-in-python-from-c" id="id12">How do I access a module written in Python from C?</a></li>
<li><a class="reference internal" href="#how-do-i-interface-to-c-objects-from-python" id="id13">How do I interface to C++ objects from Python?</a></li>
<li><a class="reference internal" href="#i-added-a-module-using-the-setup-file-and-the-make-fails-why" id="id14">I added a module using the Setup file and the make fails; why?</a></li>
<li><a class="reference internal" href="#how-do-i-debug-an-extension" id="id15">How do I debug an extension?</a></li>
<li><a class="reference internal" href="#i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why" id="id16">I want to compile a Python module on my Linux system, but some files are missing. Why?</a></li>
<li><a class="reference internal" href="#what-does-systemerror-pyimport-fixupextension-module-yourmodule-not-loaded-mean" id="id17">What does “SystemError: _PyImport_FixupExtension: module yourmodule not loaded” mean?</a></li>
<li><a class="reference internal" href="#how-do-i-tell-incomplete-input-from-invalid-input" id="id18">How do I tell “incomplete input” from “invalid input”?</a></li>
<li><a class="reference internal" href="#how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual" id="id19">How do I find undefined g++ symbols __builtin_new or __pure_virtual?</a></li>
<li><a class="reference internal" href="#can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance" id="id20">Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)?</a></li>
<li><a class="reference internal" href="#when-importing-module-x-why-do-i-get-undefined-symbol-pyunicodeucs2" id="id21">When importing module X, why do I get “undefined symbol: PyUnicodeUCS2*”?</a></li>
</ul>
</li>
</ul>
</div>
<section id="can-i-create-my-own-functions-in-c">
<h2><a class="toc-backref" href="#id3">Can I create my own functions in C?</a><a class="headerlink" href="#can-i-create-my-own-functions-in-c" title="Permalink to this headline">¶</a></h2>
Yes, you can create built-in modules containing functions, variables, exceptions
and even new types in C. This is explained in the document
<a class="reference internal" href="../extending/index.html#extending-index">Extending and Embedding the Python Interpreter</a>.
Most intermediate or advanced Python books will also cover this topic.
</section>
<section id="id1">
<h2><a class="toc-backref" href="#id4">Can I create my own functions in C++?</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
Yes, using the C compatibility features found in C++. Place <code class="docutils literal notranslate">extern &quot;C&quot; {
... }</code> around the Python include files and put <code class="docutils literal notranslate">extern &quot;C&quot;</code> before each
function that is going to be called by the Python interpreter. Global or static
C++ objects with constructors are probably not a good idea.
</section>
<section id="writing-c-is-hard-are-there-any-alternatives">
<h2><a class="toc-backref" href="#id5">Writing C is hard; are there any alternatives?</a><a class="headerlink" href="#writing-c-is-hard-are-there-any-alternatives" title="Permalink to this headline">¶</a></h2>
There are a number of alternatives to writing your own C extensions, depending
on what you’re trying to do.
If you need more speed, <a class="reference external" href="http://psyco.sourceforge.net/">Psyco</a> generates x86
assembly code from Python bytecode. You can use Psyco to compile the most
time-critical functions in your code, and gain a significant improvement with
very little effort, as long as you’re running on a machine with an
x86-compatible processor.
<a class="reference external" href="http://cython.org">Cython</a> and its relative <a class="reference external" href="https://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/">Pyrex</a> are compilers
that accept a slightly modified form of Python and generate the corresponding
C code. Pyrex makes it possible to write an extension without having to learn
Python’s C API.
If you need to interface to some C or C++ library for which no Python extension
currently exists, you can try wrapping the library’s data types and functions
with a tool such as <a class="reference external" href="http://www.swig.org">SWIG</a>. <a class="reference external" href="https://riverbankcomputing.com/software/sip/intro">SIP</a>, <a class="reference external" href="http://cxx.sourceforge.net/">CXX</a> <a class="reference external" href="http://www.boost.org/libs/python/doc/index.html">Boost</a>, or <a class="reference external" href="https://github.com/scipy/weave">Weave</a> are also
alternatives for wrapping C++ libraries.
</section>
<section id="how-can-i-execute-arbitrary-python-statements-from-c">
<h2><a class="toc-backref" href="#id6">How can I execute arbitrary Python statements from C?</a><a class="headerlink" href="#how-can-i-execute-arbitrary-python-statements-from-c" title="Permalink to this headline">¶</a></h2>
The highest-level function to do this is <a class="reference internal" href="../c-api/veryhigh.html#c.PyRun_SimpleString" title="PyRun_SimpleString"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleString()</code></a> which takes
a single string argument to be executed in the context of the module
<code class="docutils literal notranslate">__main__</code> and returns 0 for success and -1 when an exception occurred
(including <code class="docutils literal notranslate">SyntaxError</code>). If you want more control, use
<a class="reference internal" href="../c-api/veryhigh.html#c.PyRun_String" title="PyRun_String"><code class="xref c c-func docutils literal notranslate">PyRun_String()</code></a>; see the source for <a class="reference internal" href="../c-api/veryhigh.html#c.PyRun_SimpleString" title="PyRun_SimpleString"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleString()</code></a> in
<code class="docutils literal notranslate">Python/pythonrun.c</code>.
</section>
<section id="how-can-i-evaluate-an-arbitrary-python-expression-from-c">
<h2><a class="toc-backref" href="#id7">How can I evaluate an arbitrary Python expression from C?</a><a class="headerlink" href="#how-can-i-evaluate-an-arbitrary-python-expression-from-c" title="Permalink to this headline">¶</a></h2>
Call the function <a class="reference internal" href="../c-api/veryhigh.html#c.PyRun_String" title="PyRun_String"><code class="xref c c-func docutils literal notranslate">PyRun_String()</code></a> from the previous question with the
start symbol <a class="reference internal" href="../c-api/veryhigh.html#c.Py_eval_input" title="Py_eval_input"><code class="xref c c-data docutils literal notranslate">Py_eval_input</code></a>; it parses an expression, evaluates it and
returns its value.
</section>
<section id="how-do-i-extract-c-values-from-a-python-object">
<h2><a class="toc-backref" href="#id8">How do I extract C values from a Python object?</a><a class="headerlink" href="#how-do-i-extract-c-values-from-a-python-object" title="Permalink to this headline">¶</a></h2>
That depends on the object’s type. If it’s a tuple, <a class="reference internal" href="../c-api/tuple.html#c.PyTuple_Size" title="PyTuple_Size"><code class="xref c c-func docutils literal notranslate">PyTuple_Size()</code></a>
returns its length and <a class="reference internal" href="../c-api/tuple.html#c.PyTuple_GetItem" title="PyTuple_GetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_GetItem()</code></a> returns the item at a specified
index. Lists have similar functions, <code class="xref c c-func docutils literal notranslate">PyListSize()</code> and
<a class="reference internal" href="../c-api/list.html#c.PyList_GetItem" title="PyList_GetItem"><code class="xref c c-func docutils literal notranslate">PyList_GetItem()</code></a>.
For strings, <a class="reference internal" href="../c-api/string.html#c.PyString_Size" title="PyString_Size"><code class="xref c c-func docutils literal notranslate">PyString_Size()</code></a> returns its length and
<a class="reference internal" href="../c-api/string.html#c.PyString_AsString" title="PyString_AsString"><code class="xref c c-func docutils literal notranslate">PyString_AsString()</code></a> a pointer to its value. Note that Python strings may
contain null bytes so C’s <code class="xref c c-func docutils literal notranslate">strlen()</code> should not be used.
To test the type of an object, first make sure it isn’t NULL, and then use
<a class="reference internal" href="../c-api/string.html#c.PyString_Check" title="PyString_Check"><code class="xref c c-func docutils literal notranslate">PyString_Check()</code></a>, <a class="reference internal" href="../c-api/tuple.html#c.PyTuple_Check" title="PyTuple_Check"><code class="xref c c-func docutils literal notranslate">PyTuple_Check()</code></a>, <a class="reference internal" href="../c-api/list.html#c.PyList_Check" title="PyList_Check"><code class="xref c c-func docutils literal notranslate">PyList_Check()</code></a>, etc.
There is also a high-level API to Python objects which is provided by the
so-called ‘abstract’ interface – read <code class="docutils literal notranslate">Include/abstract.h</code> for further
details. It allows interfacing with any kind of Python sequence using calls
like <a class="reference internal" href="../c-api/sequence.html#c.PySequence_Length" title="PySequence_Length"><code class="xref c c-func docutils literal notranslate">PySequence_Length()</code></a>, <a class="reference internal" href="../c-api/sequence.html#c.PySequence_GetItem" title="PySequence_GetItem"><code class="xref c c-func docutils literal notranslate">PySequence_GetItem()</code></a>, etc.) as well as
many other useful protocols.
</section>
<section id="how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length">
<h2><a class="toc-backref" href="#id9">How do I use Py_BuildValue() to create a tuple of arbitrary length?</a><a class="headerlink" href="#how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length" title="Permalink to this headline">¶</a></h2>
You can’t. Use <code class="docutils literal notranslate">t = PyTuple_New(n)</code> instead, and fill it with objects using
<code class="docutils literal notranslate">PyTuple_SetItem(t, i, o)</code> – note that this “eats” a reference count of
<code class="docutils literal notranslate">o</code>, so you have to <a class="reference internal" href="../c-api/refcounting.html#c.Py_INCREF" title="Py_INCREF"><code class="xref c c-func docutils literal notranslate">Py_INCREF()</code></a> it. Lists have similar functions
<code class="docutils literal notranslate">PyList_New(n)</code> and <code class="docutils literal notranslate">PyList_SetItem(l, i, o)</code>. Note that you must set all
the tuple items to some value before you pass the tuple to Python code –
<code class="docutils literal notranslate">PyTuple_New(n)</code> initializes them to NULL, which isn’t a valid Python value.
</section>
<section id="how-do-i-call-an-object-s-method-from-c">
<h2><a class="toc-backref" href="#id10">How do I call an object’s method from C?</a><a class="headerlink" href="#how-do-i-call-an-object-s-method-from-c" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="../c-api/object.html#c.PyObject_CallMethod" title="PyObject_CallMethod"><code class="xref c c-func docutils literal notranslate">PyObject_CallMethod()</code></a> function can be used to call an arbitrary
method of an object. The parameters are the object, the name of the method to
call, a format string like that used with <a class="reference internal" href="../c-api/arg.html#c.Py_BuildValue" title="Py_BuildValue"><code class="xref c c-func docutils literal notranslate">Py_BuildValue()</code></a>, and the
argument values:
<div class="highlight-c notranslate"><div class="highlight"><pre>PyObject *
PyObject_CallMethod(PyObject *object, char *method_name,
 char *arg_format, ...);
</pre></div>
</div>
This works for any object that has methods – whether built-in or user-defined.
You are responsible for eventually <a class="reference internal" href="../c-api/refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a>‘ing the return value.
To call, e.g., a file object’s “seek” method with arguments 10, 0 (assuming the
file object pointer is “f”):
<div class="highlight-c notranslate"><div class="highlight"><pre>res = PyObject_CallMethod(f, &quot;seek&quot;, &quot;(ii)&quot;, 10, 0);
if (res == NULL) {
 ... an exception occurred ...
}
else {
 Py_DECREF(res);
}
</pre></div>
</div>
Note that since <a class="reference internal" href="../c-api/object.html#c.PyObject_CallObject" title="PyObject_CallObject"><code class="xref c c-func docutils literal notranslate">PyObject_CallObject()</code></a> always wants a tuple for the
argument list, to call a function without arguments, pass “()” for the format,
and to call a function with one argument, surround the argument in parentheses,
e.g. “(i)”.
</section>
<section id="how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr">
<h2><a class="toc-backref" href="#id11">How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)?</a><a class="headerlink" href="#how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr" title="Permalink to this headline">¶</a></h2>
In Python code, define an object that supports the <code class="docutils literal notranslate">write()</code> method. Assign
this object to <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a> and <a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate">sys.stderr</code></a>. Call print_error, or
just allow the standard traceback mechanism to work. Then, the output will go
wherever your <code class="docutils literal notranslate">write()</code> method sends it.
The easiest way to do this is to use the StringIO class in the standard library.
Sample code and use for catching stdout:
<div class="highlight-pycon notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class StdoutCatcher:
... def __init__(self):
... self.data = &#39;&#39;
... def write(self, stuff):
... self.data = self.data + stuff
...
&gt;&gt;&gt; import sys
&gt;&gt;&gt; sys.stdout = StdoutCatcher()
&gt;&gt;&gt; print &#39;foo&#39;
&gt;&gt;&gt; print &#39;hello world!&#39;
&gt;&gt;&gt; sys.stderr.write(sys.stdout.data)
foo
hello world!
</pre></div>
</div>
</section>
<section id="how-do-i-access-a-module-written-in-python-from-c">
<h2><a class="toc-backref" href="#id12">How do I access a module written in Python from C?</a><a class="headerlink" href="#how-do-i-access-a-module-written-in-python-from-c" title="Permalink to this headline">¶</a></h2>
You can get a pointer to the module object as follows:
<div class="highlight-c notranslate"><div class="highlight"><pre>module = PyImport_ImportModule(&quot;&lt;modulename&gt;&quot;);
</pre></div>
</div>
If the module hasn’t been imported yet (i.e. it is not yet present in
<a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>), this initializes the module; otherwise it simply returns
the value of <code class="docutils literal notranslate">sys.modules[&quot;&lt;modulename&gt;&quot;]</code>. Note that it doesn’t enter the
module into any namespace – it only ensures it has been initialized and is
stored in <a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>.
You can then access the module’s attributes (i.e. any name defined in the
module) as follows:
<div class="highlight-c notranslate"><div class="highlight"><pre>attr = PyObject_GetAttrString(module, &quot;&lt;attrname&gt;&quot;);
</pre></div>
</div>
Calling <a class="reference internal" href="../c-api/object.html#c.PyObject_SetAttrString" title="PyObject_SetAttrString"><code class="xref c c-func docutils literal notranslate">PyObject_SetAttrString()</code></a> to assign to variables in the module
also works.
</section>
<section id="how-do-i-interface-to-c-objects-from-python">
<h2><a class="toc-backref" href="#id13">How do I interface to C++ objects from Python?</a><a class="headerlink" href="#how-do-i-interface-to-c-objects-from-python" title="Permalink to this headline">¶</a></h2>
Depending on your requirements, there are many approaches. To do this manually,
begin by reading <a class="reference internal" href="../extending/index.html#extending-index">the “Extending and Embedding” document</a>. Realize that for the Python run-time system, there isn’t a
whole lot of difference between C and C++ – so the strategy of building a new
Python type around a C structure (pointer) type will also work for C++ objects.
For C++ libraries, see <a class="reference internal" href="#c-wrapper-software">Writing C is hard; are there any alternatives?</a>.
</section>
<section id="i-added-a-module-using-the-setup-file-and-the-make-fails-why">
<h2><a class="toc-backref" href="#id14">I added a module using the Setup file and the make fails; why?</a><a class="headerlink" href="#i-added-a-module-using-the-setup-file-and-the-make-fails-why" title="Permalink to this headline">¶</a></h2>
Setup must end in a newline, if there is no newline there, the build process
fails. (Fixing this requires some ugly shell script hackery, and this bug is so
minor that it doesn’t seem worth the effort.)
</section>
<section id="how-do-i-debug-an-extension">
<h2><a class="toc-backref" href="#id15">How do I debug an extension?</a><a class="headerlink" href="#how-do-i-debug-an-extension" title="Permalink to this headline">¶</a></h2>
When using GDB with dynamically loaded extensions, you can’t set a breakpoint in
your extension until your extension is loaded.
In your <code class="docutils literal notranslate">.gdbinit</code> file (or interactively), add the command:
<div class="highlight-none notranslate"><div class="highlight"><pre>br _PyImport_LoadDynamicModule
</pre></div>
</div>
Then, when you run GDB:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ gdb /local/bin/python
gdb) run myscript.py
gdb) continue # repeat until your extension is loaded
gdb) finish # so that your extension is loaded
gdb) br myfunction.c:50
gdb) continue
</pre></div>
</div>
</section>
<section id="i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why">
<h2><a class="toc-backref" href="#id16">I want to compile a Python module on my Linux system, but some files are missing. Why?</a><a class="headerlink" href="#i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why" title="Permalink to this headline">¶</a></h2>
Most packaged versions of Python don’t include the
<code class="file docutils literal notranslate">/usr/lib/python2.x/config/</code> directory, which contains various files
required for compiling Python extensions.
For Red Hat, install the python-devel RPM to get the necessary files.
For Debian, run <code class="docutils literal notranslate">apt-get install python-dev</code>.
</section>
<section id="what-does-systemerror-pyimport-fixupextension-module-yourmodule-not-loaded-mean">
<h2><a class="toc-backref" href="#id17">What does “SystemError: _PyImport_FixupExtension: module yourmodule not loaded” mean?</a><a class="headerlink" href="#what-does-systemerror-pyimport-fixupextension-module-yourmodule-not-loaded-mean" title="Permalink to this headline">¶</a></h2>
This means that you have created an extension module named “yourmodule”, but
your module init function does not initialize with that name.
Every module init function will have a line similar to:
<div class="highlight-c notranslate"><div class="highlight"><pre>module = Py_InitModule(&quot;yourmodule&quot;, yourmodule_functions);
</pre></div>
</div>
If the string passed to this function is not the same name as your extension
module, the <code class="xref py py-exc docutils literal notranslate">SystemError</code> exception will be raised.
</section>
<section id="how-do-i-tell-incomplete-input-from-invalid-input">
<h2><a class="toc-backref" href="#id18">How do I tell “incomplete input” from “invalid input”?</a><a class="headerlink" href="#how-do-i-tell-incomplete-input-from-invalid-input" title="Permalink to this headline">¶</a></h2>
Sometimes you want to emulate the Python interactive interpreter’s behavior,
where it gives you a continuation prompt when the input is incomplete (e.g. you
typed the start of an “if” statement or you didn’t close your parentheses or
triple string quotes), but it gives you a syntax error message immediately when
the input is invalid.
In Python you can use the <a class="reference internal" href="../library/codeop.html#module-codeop" title="codeop: Compile (possibly incomplete) Python code."><code class="xref py py-mod docutils literal notranslate">codeop</code></a> module, which approximates the parser’s
behavior sufficiently. IDLE uses this, for example.
The easiest way to do it in C is to call <a class="reference internal" href="../c-api/veryhigh.html#c.PyRun_InteractiveLoop" title="PyRun_InteractiveLoop"><code class="xref c c-func docutils literal notranslate">PyRun_InteractiveLoop()</code></a> (perhaps
in a separate thread) and let the Python interpreter handle the input for
you. You can also set the <code class="xref c c-func docutils literal notranslate">PyOS_ReadlineFunctionPointer()</code> to point at your
custom input function. See <code class="docutils literal notranslate">Modules/readline.c</code> and <code class="docutils literal notranslate">Parser/myreadline.c</code>
for more hints.
However sometimes you have to run the embedded Python interpreter in the same
thread as your rest application and you can’t allow the
<a class="reference internal" href="../c-api/veryhigh.html#c.PyRun_InteractiveLoop" title="PyRun_InteractiveLoop"><code class="xref c c-func docutils literal notranslate">PyRun_InteractiveLoop()</code></a> to stop while waiting for user input. The one
solution then is to call <code class="xref c c-func docutils literal notranslate">PyParser_ParseString()</code> and test for <code class="docutils literal notranslate">e.error</code>
equal to <code class="docutils literal notranslate">E_EOF</code>, which means the input is incomplete. Here’s a sample code
fragment, untested, inspired by code from Alex Farber:
<div class="highlight-c notranslate"><div class="highlight"><pre>#include &lt;Python.h&gt;
#include &lt;node.h&gt;
#include &lt;errcode.h&gt;
#include &lt;grammar.h&gt;
#include &lt;parsetok.h&gt;
#include &lt;compile.h&gt;

int testcomplete(char *code)
 /* code should end in \n */
 /* return -1 for error, 0 for incomplete, 1 for complete */
{
 node *n;
 perrdetail e;

n = PyParser_ParseString(code, &amp;_PyParser_Grammar,
 Py_file_input, &amp;e);
 if (n == NULL) {
 if (e.error == E_EOF)
 return 0;
 return -1;
 }

PyNode_Free(n);
 return 1;
}
</pre></div>
</div>
Another solution is trying to compile the received string with
<a class="reference internal" href="../c-api/veryhigh.html#c.Py_CompileString" title="Py_CompileString"><code class="xref c c-func docutils literal notranslate">Py_CompileString()</code></a>. If it compiles without errors, try to execute the
returned code object by calling <a class="reference internal" href="../c-api/veryhigh.html#c.PyEval_EvalCode" title="PyEval_EvalCode"><code class="xref c c-func docutils literal notranslate">PyEval_EvalCode()</code></a>. Otherwise save the
input for later. If the compilation fails, find out if it’s an error or just
more input is required - by extracting the message string from the exception
tuple and comparing it to the string “unexpected EOF while parsing”. Here is a
complete example using the GNU readline library (you may want to ignore
SIGINT while calling readline()):
<div class="highlight-c notranslate"><div class="highlight"><pre>#include &lt;stdio.h&gt;
#include &lt;readline.h&gt;

#include &lt;Python.h&gt;
#include &lt;object.h&gt;
#include &lt;compile.h&gt;
#include &lt;eval.h&gt;

int main (int argc, char* argv[])
{
 int i, j, done = 0; /* lengths of line, code */
 char ps1[] = &quot;&gt;&gt;&gt; &quot;;
 char ps2[] = &quot;... &quot;;
 char *prompt = ps1;
 char *msg, *line, *code = NULL;
 PyObject *src, *glb, *loc;
 PyObject *exc, *val, *trb, *obj, *dum;

Py_Initialize ();
 loc = PyDict_New ();
 glb = PyDict_New ();
 PyDict_SetItemString (glb, &quot;__builtins__&quot;, PyEval_GetBuiltins ());

while (!done)
 {
 line = readline (prompt);

if (i &gt; 0)
 add_history (line); /* save non-empty lines */

code = realloc (code, i + j + 2);
 if (NULL == code) /* out of memory */
 exit (1);

if (0 == j) /* code was empty, so */
 code[0] = &#39;\0&#39;; /* keep strncat happy */

strncat (code, line, i); /* append line to code */
 code[i + j] = &#39;\n&#39;; /* append &#39;\n&#39; to code */
 code[i + j + 1] = &#39;\0&#39;;

src = Py_CompileString (code, &quot;&lt;stdin&gt;&quot;, Py_single_input);

if (NULL != src) /* compiled just fine - */
 {
 if (ps1 == prompt || /* &quot;&gt;&gt;&gt; &quot; or */
 &#39;\n&#39; == code[i + j - 1]) /* &quot;... &quot; and double &#39;\n&#39; */
 { /* so execute it */
 dum = PyEval_EvalCode ((PyCodeObject *)src, glb, loc);
 Py_XDECREF (dum);
 Py_XDECREF (src);
 free (code);
 code = NULL;
 if (PyErr_Occurred ())
 PyErr_Print ();
 prompt = ps1;
 }
 } /* syntax error or E_EOF? */
 else if (PyErr_ExceptionMatches (PyExc_SyntaxError))
 {
 PyErr_Fetch (&amp;exc, &amp;val, &amp;trb); /* clears exception! */

if (PyArg_ParseTuple (val, &quot;sO&quot;, &amp;msg, &amp;obj) &amp;&amp;
 !strcmp (msg, &quot;unexpected EOF while parsing&quot;)) /* E_EOF */
 {
 Py_XDECREF (exc);
 Py_XDECREF (val);
 Py_XDECREF (trb);
 prompt = ps2;
 }
 else /* some other syntax error */
 {
 PyErr_Restore (exc, val, trb);
 PyErr_Print ();
 free (code);
 code = NULL;
 prompt = ps1;
 }
 }
 else /* some non-syntax error */
 {
 PyErr_Print ();
 free (code);
 code = NULL;
 prompt = ps1;
 }

free (line);
 }
 }

Py_XDECREF(glb);
 Py_XDECREF(loc);
 Py_Finalize();
 exit(0);
}
</pre></div>
</div>
</section>
<section id="how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual">
<h2><a class="toc-backref" href="#id19">How do I find undefined g++ symbols __builtin_new or __pure_virtual?</a><a class="headerlink" href="#how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual" title="Permalink to this headline">¶</a></h2>
To dynamically load g++ extension modules, you must recompile Python, relink it
using g++ (change LINKCC in the Python Modules Makefile), and link your
extension module using g++ (e.g., <code class="docutils literal notranslate">g++ -shared -o mymodule.so mymodule.o</code>).
</section>
<section id="can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance">
<h2><a class="toc-backref" href="#id20">Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)?</a><a class="headerlink" href="#can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance" title="Permalink to this headline">¶</a></h2>
Yes, you can inherit from built-in classes such as <a class="reference internal" href="../library/functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>, <code class="xref py py-class docutils literal notranslate">list</code>,
<a class="reference internal" href="../library/stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate">dict</code></a>, etc.
The Boost Python Library (BPL, <a class="reference external" href="http://www.boost.org/libs/python/doc/index.html">http://www.boost.org/libs/python/doc/index.html</a>)
provides a way of doing this from C++ (i.e. you can inherit from an extension
class written in C++ using the BPL).
</section>
<section id="when-importing-module-x-why-do-i-get-undefined-symbol-pyunicodeucs2">
<h2><a class="toc-backref" href="#id21">When importing module X, why do I get “undefined symbol: PyUnicodeUCS2*”?</a><a class="headerlink" href="#when-importing-module-x-why-do-i-get-undefined-symbol-pyunicodeucs2" title="Permalink to this headline">¶</a></h2>
You are using a version of Python that uses a 4-byte representation for Unicode
characters, but some C extension module you are importing was compiled using a
Python that uses a 2-byte representation for Unicode characters (the default).
If instead the name of the undefined symbol starts with <code class="docutils literal notranslate">PyUnicodeUCS4</code>, the
problem is the reverse: Python was built using 2-byte Unicode characters, and
the extension module was compiled using a Python with 4-byte Unicode characters.
This can easily occur when using pre-built extension packages. RedHat Linux
7.x, in particular, provided a “python2” binary that is compiled with 4-byte
Unicode. This only causes the link failure if the extension uses any of the
<code class="docutils literal notranslate">PyUnicode_*()</code> functions. It is also a problem if an extension uses any of
the Unicode-related format specifiers for <a class="reference internal" href="../c-api/arg.html#c.Py_BuildValue" title="Py_BuildValue"><code class="xref c c-func docutils literal notranslate">Py_BuildValue()</code></a> (or similar) or
parameter specifications for <a class="reference internal" href="../c-api/arg.html#c.PyArg_ParseTuple" title="PyArg_ParseTuple"><code class="xref c c-func docutils literal notranslate">PyArg_ParseTuple()</code></a>.
You can check the size of the Unicode character a Python interpreter is using by
checking the value of sys.maxunicode:
<div class="highlight-pycon notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import sys
&gt;&gt;&gt; if sys.maxunicode &gt; 65535:
... print &#39;UCS4 build&#39;
... else:
... print &#39;UCS2 build&#39;
</pre></div>
</div>
The only way to solve this problem is to use extension modules compiled with a
Python binary built using the same size for Unicode characters.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Extending/Embedding FAQ</a><ul>
<li><a class="reference internal" href="#can-i-create-my-own-functions-in-c">Can I create my own functions in C?</a></li>
<li><a class="reference internal" href="#id1">Can I create my own functions in C++?</a></li>
<li><a class="reference internal" href="#writing-c-is-hard-are-there-any-alternatives">Writing C is hard; are there any alternatives?</a></li>
<li><a class="reference internal" href="#how-can-i-execute-arbitrary-python-statements-from-c">How can I execute arbitrary Python statements from C?</a></li>
<li><a class="reference internal" href="#how-can-i-evaluate-an-arbitrary-python-expression-from-c">How can I evaluate an arbitrary Python expression from C?</a></li>
<li><a class="reference internal" href="#how-do-i-extract-c-values-from-a-python-object">How do I extract C values from a Python object?</a></li>
<li><a class="reference internal" href="#how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length">How do I use Py_BuildValue() to create a tuple of arbitrary length?</a></li>
<li><a class="reference internal" href="#how-do-i-call-an-object-s-method-from-c">How do I call an object’s method from C?</a></li>
<li><a class="reference internal" href="#how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr">How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)?</a></li>
<li><a class="reference internal" href="#how-do-i-access-a-module-written-in-python-from-c">How do I access a module written in Python from C?</a></li>
<li><a class="reference internal" href="#how-do-i-interface-to-c-objects-from-python">How do I interface to C++ objects from Python?</a></li>
<li><a class="reference internal" href="#i-added-a-module-using-the-setup-file-and-the-make-fails-why">I added a module using the Setup file and the make fails; why?</a></li>
<li><a class="reference internal" href="#how-do-i-debug-an-extension">How do I debug an extension?</a></li>
<li><a class="reference internal" href="#i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why">I want to compile a Python module on my Linux system, but some files are missing. Why?</a></li>
<li><a class="reference internal" href="#what-does-systemerror-pyimport-fixupextension-module-yourmodule-not-loaded-mean">What does “SystemError: _PyImport_FixupExtension: module yourmodule not loaded” mean?</a></li>
<li><a class="reference internal" href="#how-do-i-tell-incomplete-input-from-invalid-input">How do I tell “incomplete input” from “invalid input”?</a></li>
<li><a class="reference internal" href="#how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual">How do I find undefined g++ symbols __builtin_new or __pure_virtual?</a></li>
<li><a class="reference internal" href="#can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance">Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)?</a></li>
<li><a class="reference internal" href="#when-importing-module-x-why-do-i-get-undefined-symbol-pyunicodeucs2">When importing module X, why do I get “undefined symbol: PyUnicodeUCS2*”?</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="library.html"
 title="previous chapter">Library and Extension FAQ</a>
 <h4>Next topic</h4>
 <a href="windows.html"
 title="next chapter">Python on Windows FAQ</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/faq/extending.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="windows.html" title="Python on Windows FAQ"
 >next</a> |</li>
 <li class="right" >
 <a href="library.html" title="Library and Extension FAQ"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python Frequently Asked Questions</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Extending/Embedding FAQ</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on November 21, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>