Merge pull request #877 from altendky/pyinstaller_hook

Add PyInstaller hook

.azure/scripts/test.yml

@@ -26,6 +26,14 @@ steps:
     python -m pytest -v --junit-xml=build/test/test.xml test/jpypetest --checkjni  
   displayName: 'Test JDK 11'
 
+# presence of jpype/ seems to confuse entry_points so `cd` elsewhere
+- script: |
+    pip install .
+    mkdir empty
+    cd empty
+    python -m PyInstaller.utils.run_tests --include_only jpype._pyinstaller.
+  displayName: 'Test PyInstaller result'
+
 - task: PublishTestResults@2
   condition: succeededOrFailed()
   inputs:

doc/userguide.rst

@@ -3285,3 +3285,12 @@ resulting in unusual behavior with certain windows calls. The path
 separator for Cygwin does not match that of the Java DLL, thus specification
 of class paths must account for this.  Threading between the Cygwin libraries
 and the JVM was often unstable.
+
+.. _freezing:
+
+Freezing
+========
+
+JPype supports freezing and deployment with
+`PyInstaller <https://pyinstaller.readthedocs.io/>`_.  The hook is included
+with JPype installations and no extra configuration should be needed.

jpype/_pyinstaller/entry_points.py

@@ -0,0 +1,16 @@
+import os
+from pathlib import Path
+
+
+fspath = getattr(os, 'fspath', str)
+
+
+_pyinstaller_path = Path(__file__).parent
+
+
+def get_hook_dirs():
+    return [fspath(_pyinstaller_path)]
+
+
+def get_PyInstaller_tests():
+    return [fspath(_pyinstaller_path)]

jpype/_pyinstaller/example.py

@@ -0,0 +1,5 @@
+import jpype
+
+print('+++ about to start JVM')
+jpype.startJVM()
+print('+++ JVM started')

jpype/_pyinstaller/hook-jpype.py

@@ -0,0 +1,11 @@
+import os
+from pathlib import Path
+
+import jpype
+
+
+fspath = getattr(os, 'fspath', str)
+
+jar_path = Path(jpype.__file__).parent.parent.joinpath('org.jpype.jar')
+
+datas = [[fspath(jar_path), '.']]

jpype/_pyinstaller/test_jpype_pyinstaller.py

@@ -0,0 +1,31 @@
+import os
+from pathlib import Path
+from subprocess import run
+
+import jpype
+import PyInstaller.__main__
+
+
+fspath = getattr(os, 'fspath', str)
+
+
+example_path = Path(__file__).parent.joinpath('example.py')
+
+
+def test_start_and_stop(tmp_path):
+    name = 'e'
+    dist = tmp_path.joinpath('dist')
+    work = tmp_path.joinpath('build')
+    result = dist.joinpath(name, name)
+
+    PyInstaller.__main__.run([
+        '--name',
+        name,
+        '--distpath',
+        fspath(dist),
+        '--workpath',
+        fspath(work),
+        fspath(example_path),
+    ])
+
+    run([fspath(result)], check=True, cwd=fspath(tmp_path))

setup.cfg

@@ -3,4 +3,6 @@ test=pytest
 
 [tool:pytest]
 addopts = --verbose
-testpaths = test
+testpaths =
+    test
+    jpype/_pyinstaller

setup.py

@@ -77,7 +77,7 @@
         'Topic :: Software Development',
         'Topic :: Scientific/Engineering',
     ],
-    packages=['jpype'],
+    packages=['jpype', 'jpype._pyinstaller'],
     package_dir={'jpype': 'jpype', },
     install_requires=['typing_extensions ; python_version< "3.8"'],
     tests_require=['pytest'],
@@ -90,5 +90,11 @@
     zip_safe=False,
     ext_modules=[jpypeJar, jpypeLib, ],
     distclass=setupext.dist.Distribution,
+    entry_points={
+        'pyinstaller40': [
+            'hook-dirs = jpype._pyinstaller.entry_points:get_hook_dirs',
+            'tests = jpype._pyinstaller.entry_points:get_PyInstaller_tests',
+        ],
+    },
 )
 

test-requirements.txt

@@ -1,2 +1,3 @@
 pytest==4.6.9
+pyinstaller==4.0
 jedi==0.17.0