expand the py docs a bit

see https://github.com/jcupitt/libvips/issues/302
This commit is contained in:
John Cupitt 2015-05-29 16:48:36 +01:00
parent 98e80903e0
commit 2f4c0da6eb

View File

@ -48,7 +48,66 @@ im = im.conv(mask)
im.write_to_file(sys.argv[2])
</programlisting>
Reading this example, the first line loads the input file. You can append
Reading this example, here's what happens when Python executes the
import line. Skip this list unless it's not working for you or you're
curious about the details:
</para>
<orderedlist>
<listitem>
<para>
It searches for a file called <code>Vips-x.y.typelib</code>. This
is a binary file generated automatically during libvips build
by introspection of the libvips shared library plus scanning
of the C headers. It lists all the API entry points, all the
types the library uses, and has an extra set of hints for object
ownership and reference counting. The typelib is searched for
in <code>/usr/lib/gi-repository-1.0</code> and along the path
in the environment variable <code>GI_TYPELIB_PATH</code>.
</para>
</listitem>
<listitem>
<para>
It uses the typelib to make a basic binding for libvips. It's
just the C API with a little very light mangling, so for
example the enum member <code>VIPS_FORMAT_UCHAR</code>
of the enum <code>VipsBandFormat</code> becomes
<code>Vips.BandFormat.UCHAR</code>.
</para>
</listitem>
<listitem>
<para>
The binding you get can be rather unfriendly, so it also
loads a set of overrides from <code>Vips.py</code> in
<code>/usr/lib/python2.7/dist-packages/gi/overrides</code>
(on my system at least). If you're using python3, it's
<code>/usr/lib/python3/dist-packages/gi/overrides</code>.
Unfortunately, as far as I know, there is no way to extend
this search using environment variables. You MUST have
<code>Vips.py</code> in exactly this directory. If you install
vips via a package manager this will happen automatically,
since vips and pygobject will have been built to the same
prefix, but if you are installing vips from source and the
prefix does not match, it will not be installed for you,
you will need to copy it.
</para>
</listitem>
<listitem>
<para>
Finally, <code>Vips.py</code> makes the rest of the binding. In
fact, <code>Vips.py</code> makes almost all the binding: it
defines <code>__getattr__</code> on <code>Vips.Image</code>
and binds at runtime by searching libvips for an operation of
that name.
</para>
</listitem>
</orderedlist>
<para>
The next line loads the input file. You can append
load options to the argument list as keyword arguments, for example:
<programlisting language="Python">
@ -102,29 +161,14 @@ im = im.similarity(scale = 0.9, interpolate = Vips.Interpolate.new("bicubic"))
<refsect3 id="python-basics">
<title><code>pyvips8</code> basics</title>
<para>
The Python interface comes in two main parts. First, the C source code
to libvips has been marked up with special comments describing the
interface in a standard way. These comments are read by
gobject-introspection when libvips is compiled and used to generate a
typelib, a description of how to call the library. When your Python
program starts, the import line:
<programlisting language="Python">
from gi.repository import Vips
</programlisting>
loads the typelib and creates Python classes for all the objects and
all the functions in the library. You can then call these functions
from your code, and they will call into libvips for you. C functions
become Python functions in an obvious way: vips_operation_new(),
for example, the constructor for the class #VipsOperation, becomes
<code>Vips.Operation.new()</code>. See the C API docs for details.
As noted above, the Python interface comes in two main parts,
an automatically generated binding based on the vips typelib,
plus a set of extra features provided by overrides.
</para>
<para>
Using libvips like this is possible, but a bit painful. To make the API
seem more pythonesque, vips includes a set of overrides which form a
layer over the bare functions created by gobject-introspection.
The rest of this chapter runs through the features provided by the
overrides.
</para>
</refsect3>