Differences between revisions 8 and 9
Revision 8 as of 2004-11-30 11:13:54
Size: 2832
Editor: DavidBoddie
Comment: Trivial typo correction.
Revision 9 as of 2007-12-16 16:05:10
Size: 2848
Editor: DavidBoddie
Comment: Updated links and tidied the description a little.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= sip = = SIP =
Line 3: Line 3:
Sip is a tool for quickly writing Python modules that interface with C++ and C libraries. It's home page is at [http://riverbankcomputing.co.uk/sip/]. It was written by Phil Thompson who is still actively maintaining it. SIP is a tool for quickly writing Python modules that interface with C++ and C libraries. It's home page is at [http://riverbankcomputing.co.uk/sip/]. It was written by Phil Thompson who is still actively maintaining it.
Line 5: Line 5:
Full documentation can be found at [http://www.river-bank.demon.co.uk/docs/sip/sipref.html]. Full documentation can be found at [http://www.riverbankcomputing.com/Docs/sip4/sipref.html].
Line 7: Line 7:
Sip is used principally to support PyQt and ["PyKDE"]. Without it, it would be near impossible to manage the vast APIs these libraries provide. SIP is used principally to support PyQt and ["PyKDE"]. Without it, it would be near impossible to manage the vast APIs these libraries provide.
Line 9: Line 9:
Since v4.0 Sip can be used to interface with C libraries. Since v4.0 SIP can be used to interface Python with C libraries.
Line 11: Line 11:
For earlier version of Sip, a simple wrapper written in C++ was usually necessary. A proof of concept can be found with Jonathan Gardner's ["sipPQ"], a python module that interfaces directly with libpq, which is the C library used to interface with PostgreSQL. You can find this at [http://sourceforge.net/project/showfiles.php?group_id=61057]. For earlier versions of SIP, a simple wrapper written in C++ was usually necessary. A proof of concept can be found with Jonathan Gardner's ["sipPQ"], a python module that interfaces directly with libpq, which is the C library used to interface with PostgreSQL. You can find this at [http://sourceforge.net/project/showfiles.php?group_id=61057].
Line 16: Line 16:
Sip is really the combination of four components. SIP is really the combination of four components.
Line 18: Line 18:
 1. A scripting language that roughly resembles C++ that describes how the Python module will interface with the C++ library.  1. A template language resembling C++ class declarations that describes how the Python module will interface with the C++ library.
Line 20: Line 20:
 1. A module to support the resulting Python modules and allow the programmer access to some of the Sip internals for special cases.  1. A module to support the resulting Python modules and allow the programmer access to some of the SIP internals for special cases.
Line 48: Line 48:
 * [http://www.river-bank.demon.co.uk/docs/sip/sipref.html Official Documentation]  * [http://www.riverbankcomputing.com/Docs/sip4/sipref.html Official Documentation]

SIP

SIP is a tool for quickly writing Python modules that interface with C++ and C libraries. It's home page is at [http://riverbankcomputing.co.uk/sip/]. It was written by Phil Thompson who is still actively maintaining it.

Full documentation can be found at [http://www.riverbankcomputing.com/Docs/sip4/sipref.html].

SIP is used principally to support PyQt and ["PyKDE"]. Without it, it would be near impossible to manage the vast APIs these libraries provide.

Since v4.0 SIP can be used to interface Python with C libraries.

For earlier versions of SIP, a simple wrapper written in C++ was usually necessary. A proof of concept can be found with Jonathan Gardner's ["sipPQ"], a python module that interfaces directly with libpq, which is the C library used to interface with PostgreSQL. You can find this at [http://sourceforge.net/project/showfiles.php?group_id=61057].


More Details

SIP is really the combination of four components.

  1. A template language resembling C++ class declarations that describes how the Python module will interface with the C++ library.
  2. A tool to convert the script into C++ code and Python modules.
  3. A module to support the resulting Python modules and allow the programmer access to some of the SIP internals for special cases.
  4. A pure Python build system that supports dozens of platform/compiler combinations.


Excerpt from [http://pegasus.rutgers.edu/~elflord/unix/siptute/ Programming With Sip]:

Introduction

This is by no means an authoritative discussion about SIP. Rather, it is a chronicle of the adventures and misadventures of a bumbling newbie trying to learn to use a great tool with little documentation. Some references that are essential in conjunction to this include:

  • PyQt: an implementation of Python bindings for Qt. Reading the Sip files for these classes is instructive.

  • [http://www.controlvideo.de/sip/ Sip documentation]. This is by no means complete, but it is currently the best available

A Note About Versions

sip has changed from version to version. I'm using python 2.2 and sip 3.0pre7. Depending on the verion you're using, sip will behave a little differently. The most notable addition to the new version of sip is support for classes that are wrapped inside namespaces.


ViM Syntax Script

Jonathan Gardner has written an incomplete sip syntax script. You can use it when you are writing a sip script with the ViM editor.

[http://vim.sourceforge.net/scripts/script.php?script_id=659]

Tutorials & additional docs staff

Googling the web on SIP tutorials brought up

SIP (last edited 2012-02-21 17:38:01 by Alan Trick)

Unable to edit the page? See the FrontPage for instructions.