jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed SF bug #1297 (Python imports)

Browse source 
This changeset resolves several issues related to python imports.
For example, it's possible now to import modules having same module
names, but belonging to different packages.

From the user's viewpoint, this patch gives a little bit more control on
import directives generated by swig. The user may choose to use relative
or absolute imports (docs are provided in separate PR).

Some details:
  - we (still) generate import directives in form 'import a.b.c' which
    corresponds to absolute imports in python3 and (the only available)
    ambiguous one in python2.
  - added -relativeimport option to use explicit relative import syntax
    (python3),

Tests are under Examples/python, these are in fact regression tests but
with the current swig testing framework it seems to be impossible to put
appropriate tests under test-suite.

Closes #7
This commit is contained in:
Paweł Tomulik 2013-05-28 05:33:56 +02:00 • committed by William S Fulton
commit 5562deec62
146 changed files with 1676 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Examples/python/import_packages/relativeimport2/Makefile Normal file
View file

@ -0,0 +1,25 @@
TOP = ../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
PY3 =
ifeq (,$(PY3))
PKG1DIR = "py2"
else
PKG1DIR = "py3"
endif
check: build
$(MAKE) -f $(TOP)/Makefile python_run
build:
cd $(PKG1DIR) && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT) -relativeimport' LIBS='$(LIBS)' build
static:
cd $(PKG1DIR) && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT) -relativeimport' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile python_clean
cd py2 && $(MAKE) clean
cd py3 && $(MAKE) clean

22
Examples/python/import_packages/relativeimport2/README Normal file
View file

@ -0,0 +1,22 @@
This example tests the %import directive and -relativeimport option.
Use 'python runme.py' to run a test.
Overview:
---------
The example defines 2 different extension modules--each wrapping a separate C++
class.
pyX/pkg2/pkg3/pkg4/foo.i - Pkg4_Foo class
pyX/pkg2/bar.i - Pkg2_Bar class derived from Pkg4_Foo
The difference between this ('relativeimport2') case and the case
'relativeimport1' is the "distance" between importer and importee.
If everything works well, the package pyX.pkg2 shall load properly.
Unix:
-----
- Run make
- Run the test as described above

14
Examples/python/import_packages/relativeimport2/py2/Makefile Normal file
View file

@ -0,0 +1,14 @@
TOP = ../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
cd pkg2 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' build
static:
cd pkg2 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile python_clean
cd pkg2 && $(MAKE) clean

0
Examples/python/import_packages/relativeimport2/py2/__init__.py Normal file
View file

18
Examples/python/import_packages/relativeimport2/py2/pkg2/Makefile Normal file
View file

@ -0,0 +1,18 @@
TOP = ../../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='bar' INTERFACE='bar.i' python_cpp
cd pkg3 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' build
static:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='bar' INTERFACE='bar.i' python_cpp
cd pkg3 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile TARGET='bar' python_clean
cd pkg3 && $(MAKE) clean

0
Examples/python/import_packages/relativeimport2/py2/pkg2/__init__.py Normal file
View file

5
Examples/python/import_packages/relativeimport2/py2/pkg2/bar.hpp Normal file
View file

@ -0,0 +1,5 @@
#ifndef PY2_PKG2_HPP
#define PY2_PKG2_HPP
#include "../../py2/pkg2/pkg3/pkg4/foo.hpp"
struct Pkg2_Bar : Pkg4_Foo {};
#endif /* PY2_PKG2_HPP */

6
Examples/python/import_packages/relativeimport2/py2/pkg2/bar.i Normal file
View file

@ -0,0 +1,6 @@
%module(package="py2.pkg2") bar
%{
#include "../../py2/pkg2/bar.hpp"
%}
%import "../../py2/pkg2/pkg3/pkg4/foo.i"
%include "../../py2/pkg2/bar.hpp"

14
Examples/python/import_packages/relativeimport2/py2/pkg2/pkg3/Makefile Normal file
View file

@ -0,0 +1,14 @@
TOP = ../../../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
cd pkg4 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' build
static:
cd pkg4 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile python_clean
cd pkg4 && $(MAKE) clean

0
Examples/python/import_packages/relativeimport2/py2/pkg2/pkg3/__init__.py Normal file
View file

15
Examples/python/import_packages/relativeimport2/py2/pkg2/pkg3/pkg4/Makefile Normal file
View file

@ -0,0 +1,15 @@
TOP = ../../../../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='foo' INTERFACE='foo.i' python_cpp
static:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='foo' INTERFACE='foo.i' python_cpp_static
clean:
$(MAKE) -f $(TOP)/Makefile TARGET='foo' python_clean

0
Examples/python/import_packages/relativeimport2/py2/pkg2/pkg3/pkg4/__init__.py Normal file
View file

4
Examples/python/import_packages/relativeimport2/py2/pkg2/pkg3/pkg4/foo.hpp Normal file
View file

@ -0,0 +1,4 @@
#ifndef PY2_PKG2_PKG3_PKG4
#define PY2_PKG2_PKG3_PKG4
struct Pkg4_Foo {};
#endif /* PY2_PKG2_PKG3_PKG4 */

5
Examples/python/import_packages/relativeimport2/py2/pkg2/pkg3/pkg4/foo.i Normal file
View file

@ -0,0 +1,5 @@
%module(package="py2.pkg2.pkg3.pkg4") foo
%{
#include "../../../../py2/pkg2/pkg3/pkg4/foo.hpp"
%}
%include "../../../../py2/pkg2/pkg3/pkg4/foo.hpp"

14
Examples/python/import_packages/relativeimport2/py3/Makefile Normal file
View file

@ -0,0 +1,14 @@
TOP = ../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
cd pkg2 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' build
static:
cd pkg2 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile python_clean
cd pkg2 && $(MAKE) clean

0
Examples/python/import_packages/relativeimport2/py3/__init__.py Normal file
View file

18
Examples/python/import_packages/relativeimport2/py3/pkg2/Makefile Normal file
View file

@ -0,0 +1,18 @@
TOP = ../../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='bar' INTERFACE='bar.i' python_cpp
cd pkg3 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' build
static:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='bar' INTERFACE='bar.i' python_cpp
cd pkg3 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile TARGET='bar' python_clean
cd pkg3 && $(MAKE) clean

0
Examples/python/import_packages/relativeimport2/py3/pkg2/__init__.py Normal file
View file

5
Examples/python/import_packages/relativeimport2/py3/pkg2/bar.hpp Normal file
View file

@ -0,0 +1,5 @@
#ifndef PY3_PKG2_HPP
#define PY3_PKG2_HPP
#include "../../py3/pkg2/pkg3/pkg4/foo.hpp"
struct Pkg2_Bar : Pkg4_Foo {};
#endif /* PY3_PKG2_HPP */

6
Examples/python/import_packages/relativeimport2/py3/pkg2/bar.i Normal file
View file

@ -0,0 +1,6 @@
%module(package="py3.pkg2") bar
%{
#include "../../py3/pkg2/bar.hpp"
%}
%import "../../py3/pkg2/pkg3/pkg4/foo.i"
%include "../../py3/pkg2/bar.hpp"

14
Examples/python/import_packages/relativeimport2/py3/pkg2/pkg3/Makefile Normal file
View file

@ -0,0 +1,14 @@
TOP = ../../../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
cd pkg4 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' build
static:
cd pkg4 && $(MAKE) SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' LIBS='$(LIBS)' static
clean:
$(MAKE) -f $(TOP)/Makefile python_clean
cd pkg4 && $(MAKE) clean

0
Examples/python/import_packages/relativeimport2/py3/pkg2/pkg3/__init__.py Normal file
View file

15
Examples/python/import_packages/relativeimport2/py3/pkg2/pkg3/pkg4/Makefile Normal file
View file

@ -0,0 +1,15 @@
TOP = ../../../../../../..
SWIG = $(realpath $(TOP)/../preinst-swig)
SWIGOPT =
LIBS =
build:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='foo' INTERFACE='foo.i' python_cpp
static:
$(MAKE) -f $(TOP)/Makefile SWIG='$(SWIG)' SWIGOPT='$(SWIGOPT)' \
LIBS='$(LIBS)' TARGET='foo' INTERFACE='foo.i' python_cpp_static
clean:
$(MAKE) -f $(TOP)/Makefile TARGET='foo' python_clean

0
Examples/python/import_packages/relativeimport2/py3/pkg2/pkg3/pkg4/__init__.py Normal file
View file

4
Examples/python/import_packages/relativeimport2/py3/pkg2/pkg3/pkg4/foo.hpp Normal file
View file

@ -0,0 +1,4 @@
#ifndef PY3_PKG2_PKG3_PKG4
#define PY3_PKG2_PKG3_PKG4
struct Pkg4_Foo {};
#endif /* PY3_PKG2_PKG3_PKG4 */

5
Examples/python/import_packages/relativeimport2/py3/pkg2/pkg3/pkg4/foo.i Normal file
View file

@ -0,0 +1,5 @@
%module(package="py3.pkg2.pkg3.pkg4") foo
%{
#include "../../../../py3/pkg2/pkg3/pkg4/foo.hpp"
%}
%include "../../../../py3/pkg2/pkg3/pkg4/foo.hpp"

9
Examples/python/import_packages/relativeimport2/runme.py Normal file
View file

@ -0,0 +1,9 @@
# Test import of modules content from within __init__.py
print "Testing %module(package=...) + python 'import' in __init__.py"
import sys
if sys.version_info < (3,0):
import py2.pkg2.bar
print " Finished importing py2.pkg2.bar"
else:
import py3.pkg2.bar
print " Finished importing py3.pkg2.bar"

9
Examples/python/import_packages/relativeimport2/runme3.py Normal file
View file

@ -0,0 +1,9 @@
# Test import of modules content from within __init__.py
print("Testing %module(package=...) + python 'import' in __init__.py")
import sys
if sys.version_info < (3, 0):
import py2.pkg2.bar
print(" Finished importing py2.pkg2.bar")
else:
import py3.pkg2.bar
print(" Finished importing py3.pkg2.bar")