hacks to get jar into site-packages and a proper properties file.

Author: voutilad

jpyutil.py

@@ -81,7 +81,8 @@ def _add_paths_if_exists(path_list, *paths):
     return path_list
 
 
-def _get_module_path(name, fail=False):
+def _get_module_path(name, fail=False, install_path=None):
+    """ Find the path to the jpy jni modules. """
     import imp
 
     module = imp.find_module(name)
@@ -90,6 +91,10 @@ def _get_module_path(name, fail=False):
     path = module[1]
     if not path and fail:
         raise RuntimeError("module '" + name + "' is missing a file path")
+    
+    if install_path:
+        return os.path.join(install_path, os.path.split(path)[1])
+
     return path
 
 
@@ -104,10 +109,10 @@ def _find_file(search_dirs, *filenames):
     return None
 
 
-def _get_java_api_properties(fail=False):
+def _get_java_api_properties(fail=False, path=None):
     jpy_config = Properties()
-    jpy_config.set_property('jpy.jpyLib', _get_module_path('jpy', fail=fail))
-    jpy_config.set_property('jpy.jdlLib', _get_module_path('jdl', fail=fail))
+    jpy_config.set_property('jpy.jpyLib', _get_module_path('jpy', fail=fail, install_path=path))
+    jpy_config.set_property('jpy.jdlLib', _get_module_path('jdl', fail=fail, install_path=path))
     jpy_config.set_property('jpy.pythonLib', _find_python_dll_file(fail=fail))
     jpy_config.set_property('jpy.pythonPrefix', sys.prefix)
     jpy_config.set_property('jpy.pythonExecutable', sys.executable)
@@ -512,6 +517,7 @@ def _execute_python_scripts(scripts, **kwargs):
 def write_config_files(out_dir='.',
                        java_home_dir=None,
                        jvm_dll_file=None,
+                       install_dir=None,
                        req_java_api_conf=True,
                        req_py_api_conf=True):
     """
@@ -520,6 +526,7 @@ def write_config_files(out_dir='.',
     :param out_dir: output directory, must exist
     :param java_home_dir: optional home directory of the Java JRE or JDK installation
     :param jvm_dll_file: optional file to JVM shared library file
+    :param install_dir: optional path to where to searfh for modules
     :param req_java_api_conf: whether to write the jpy configuration file 'jpyconfig.properties' for Java
     :param req_py_api_conf: whether to write the jpy configuration file 'jpyconfig.py' for Python
     :return: zero on success, otherwise an error code
@@ -561,7 +568,7 @@ def write_config_files(out_dir='.',
 
     try:
         java_api_config_file = os.path.join(out_dir, java_api_config_basename)
-        java_api_properties = _get_java_api_properties(fail=req_java_api_conf)
+        java_api_properties = _get_java_api_properties(fail=req_java_api_conf, path=install_dir)
         java_api_properties.store(java_api_config_file, comments=[
             "Created by '%s' tool on %s" % (tool_name, str(datetime.datetime.now())),
             "This file is read by the jpy Java API (org.jpy.PyLib class) in order to find shared libraries"])
@@ -596,6 +603,7 @@ def _main():
                         help="Require that Java API configuration succeeds.")
     parser.add_argument("-p", "--req_py", action='store_true', default=False,
                         help="Require that Python API configuration succeeds.")
+    parser.add_argument("--install_dir", action='store', default=None, help="Optional. Used during pip install of JPY")
     args = parser.parse_args()
 
     log_level = getattr(logging, args.log_level.upper(), None)
@@ -614,7 +622,8 @@ def _main():
                                      java_home_dir=args.java_home,
                                      jvm_dll_file=args.jvm_dll,
                                      req_java_api_conf=args.req_java,
-                                     req_py_api_conf=args.req_py)
+                                     req_py_api_conf=args.req_py,
+                                     install_dir=args.install_dir)
     except:
         logging.exception("Configuration failed")
         retcode = 100

setup.py

@@ -24,9 +24,12 @@
 
 from setuptools import setup
 from setuptools.command.test import test
+from setuptools.command.build_ext import build_ext
 from setuptools.command.install import install
+from setuptools.command.install_lib import install_lib
 from setuptools.extension import Extension
 from distutils.cmd import Command
+from distutils.util import get_platform
 from distutils import log
 
 import jpyutil
@@ -36,10 +39,11 @@
 __license__ = jpyutil.__license__
 __version__ = jpyutil.__version__
 
-base_dir = os.path.dirname(os.path.abspath(__file__))
+base_dir = os.path.dirname(os.path.relpath(__file__))
 src_main_c_dir = os.path.join(base_dir, 'src', 'main', 'c')
 src_test_py_dir = os.path.join(base_dir, 'src', 'test', 'python')
-
+# src_main_c_dir = 'src/main/c'
+# src_test_py_dir = 'src/test/python'
 
 do_maven = False
 if '--maven' in sys.argv:
@@ -120,6 +124,7 @@
 include_dirs = [src_main_c_dir, os.path.join(jdk_home_dir, 'include')]
 library_dirs = [jvm_dll_dir]
 libraries = [jpyutil.JVM_LIB_NAME]
+
 define_macros = []
 extra_link_args = []
 extra_compile_args = []
@@ -137,7 +142,14 @@
     library_dirs += [os.path.join(sys.exec_prefix, 'lib')]
     extra_link_args += ['-Xlinker', '-rpath', jvm_dll_dir]
 
+
+
 # ----------- Functions -------------
+def _build_dir():
+    #return os.path.join(base_dir, 'build/lib.macosx-10.12-x86_64-3.6')
+    # this is hacky, but use distutils logic to get build dir. see: distutils.command.build
+    plat = ".%s-%d.%d" % (get_platform(), *sys.version_info[:2])
+    return os.path.join('build', 'lib' + plat)
 
 def package_maven():
     """ Run maven package lifecycle """
@@ -168,18 +180,16 @@ def package_maven():
         log.error('Maven did not generate any JAR artifacts')
         exit(1)
     for jar_file in jar_files:
-        log.info("Copying " + jar_file + " -> " + lib_dir + "")
-        shutil.copy(jar_file, lib_dir)
+        build_dir = _build_dir()
+        log.info("Copying " + jar_file + " -> " + build_dir + "")
+        shutil.copy(jar_file, build_dir)
 
 
 def _read(filename):
     """ Helper function for reading in project files """
     with open(filename) as file:
         return file.read()
 
-def _build_dir():
-    # TODO: figure out logic for dynamically getting this at runtime
-    return os.path.join(base_dir, 'build/lib.macosx-10.12-x86_64-3.6')
 
 def test_python_java_rt():
     """ Run Python test cases against Java runtime classes. """
@@ -204,32 +214,37 @@ def test_maven():
     code = subprocess.call(['mvn', 'test', mvn_args], shell=platform.system() == 'Windows')
     return code == 0
 
-def _write_jpy_config(target_dir=None):
+def _write_jpy_config(target_dir=None, install_dir=None):
     """
     Write out a well-formed jpyconfig.properties file for easier Java
     integration in a given location.
     """
     if not target_dir:
         target_dir = _build_dir()
-    log.info('Writing jpy configuration to ' + target_dir)
-    return subprocess.call([sys.executable,
-                            os.path.join(target_dir, 'jpyutil.py'),
-                            '--jvm_dll', jvm_dll_file,
-                            '--java_home', jdk_home_dir,
-                            '--log_level', 'DEBUG',
-                            '--req_java',
-                            '--req_py'])
+    
+    args = [sys.executable,
+            os.path.join(target_dir, 'jpyutil.py'),
+            '--jvm_dll', jvm_dll_file,
+            '--java_home', jdk_home_dir,
+            '--log_level', 'DEBUG',
+            '--req_java',
+            '--req_py']
+    if install_dir:
+        args.append('--install_dir')
+        args.append(install_dir)
+
+    log.info('Writing jpy configuration to %s using install_dir %s' % (target_dir, install_dir))
+    return subprocess.call(args)
 
 def _copy_jpyutil():
-    src = os.path.abspath(jpyutil.__file__)
+    src = os.path.relpath(jpyutil.__file__)
     dest = _build_dir()
     log.info('Copying %s to %s' % (src, dest))
     shutil.copy(src, dest)
 
 def _build_jpy():
     package_maven()
     _copy_jpyutil()
-    _write_jpy_config()
 
 
 def test_suite():
@@ -253,7 +268,7 @@ def test_java(self):
 class MavenBuildCommand(Command):
     """ Custom JPY Maven builder command """
     description = 'run Maven to generate JPY jar'
-    user_options = []
+    user_options = [] # do not remove, needs to be stubbed out!
 
     def initialize_options(self):
         pass
@@ -264,7 +279,7 @@ def finalize_options(self):
     def run(self):
         self.announce('Building JPY')
         _build_jpy()
-        
+
 
 class JpyBuildBeforeTest(test):
     """ Customization of SetupTools Install command for JPY """
@@ -275,6 +290,13 @@ def run(self):
 
         test.run(self)
 
+class JpyInstallLib(install_lib):
+    """ Custom install_lib command for getting install_dir """
+    
+    def run(self):
+        _write_jpy_config(install_dir=self.install_dir)
+        install_lib.run(self)
+
 
 class JpyInstall(install):
     """ Custom install command to trigger Maven steps """
@@ -298,7 +320,6 @@ def run(self):
       url='https://github.com/bcdev/jpy',
       download_url='https://pypi.python.org/pypi/jpy/' + __version__,
       py_modules=['jpyutil'],
-      package_data={'': [jpy_jar_file]},
       ext_modules=[Extension('jpy',
                              sources=sources,
                              depends=headers,
@@ -322,7 +343,8 @@ def run(self):
       cmdclass={
           'maven': MavenBuildCommand,
           'test': JpyBuildBeforeTest,
-          'install': JpyInstall
+          'install': JpyInstall,
+          'install_lib': JpyInstallLib
       },
       classifiers=['Development Status :: 4 - Beta',
                    # Indicate who your project is intended for
@@ -337,4 +359,5 @@ def run(self):
                    'Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 3',
                    'Programming Language :: Python :: 3.3',
-                   'Programming Language :: Python :: 3.4'])
+                   'Programming Language :: Python :: 3.4',
+                   'Programming Language :: Python :: 3.5'])