swig/Examples/python/import_packages/module_is_init
William S Fulton 51dadaeacd Add example to test the Python module being renamed to __init__.py
This examples tests the SWIG generated module being placed into a directory and
then renamed __init__.py to convert the module into a package. This ability
stopped working in swig-3.0.9. However, only Python 2.7 or 3.3 and later work. If
Python 3.2 support is needed, use moduleimport in %module to customise the import
code.

Issue #1282
2018-12-08 22:31:26 +00:00
..
pkg1 Add example to test the Python module being renamed to __init__.py 2018-12-08 22:31:26 +00:00
Makefile Add example to test the Python module being renamed to __init__.py 2018-12-08 22:31:26 +00:00
README Add example to test the Python module being renamed to __init__.py 2018-12-08 22:31:26 +00:00
runme.py Add example to test the Python module being renamed to __init__.py 2018-12-08 22:31:26 +00:00

This example tests renaming the generated SWIG pure Python module to __init__.py
to turn the module into a Python package.

Use 'python runme.py' to run the test.

Overview:
---------

SWIG generates a pure Python module foo.py from the input interface file foo.i.
The foo.py file is generated within the pkg1 directory and is then renamed __init__.py.
This results in everything in the SWIG generated module being available in the Python
pkg1 package.

This approach of turning the SWIG generated module into a package worked in versions
of SWIG up to swig-3.0.8, but stopped working from swig-3.0.9 until it was
re-instated in swig-4.0.0. However, Python 2.7 or 3.3 and later are needed to
work out of the box. Python 3.2 does not work as this version of Python does
not set __package__ in __init__.py.