-
Notifications
You must be signed in to change notification settings - Fork 18
/
jpyutil.py
734 lines (597 loc) · 27.9 KB
/
jpyutil.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
863
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
"""
The main usage of this module is to configure jpy with respect to a given Java version and Python version.
The module can also be used as tool. For usage, type:
python jpyutil.py --help
The function being invoked here is `write_config_files()` which may also be directly used from your Python code.
It will create a file 'jpyconfig.py' and/or a 'jpyconfig.properties' in the given output directory which is usually
the one in which the jpy module is installed.
To programmatically configure the Java Virtual machine, the `init_jvm()` function can be used:
import jpyutil
jpyutil.init_jvm(jvm_maxmem='512M', jvm_classpath=['target/test-classes'])
# Without the former call, the following jpy import would create a JVM with default settings
import jpy
The `init_jvm()` can also be called with 'config_file' or 'config' arguments instead. If they are omitted,
default configuration values will inferred by first trying to import the module 'jpyconfig.py' (which must
therefore be detectable by the Python sys.path). Secondly, the environment variable 'JPY_PY_CONFIG' may point to
such a Python configuration file.
"""
import sys
import sysconfig
import os
import os.path
import platform
import ctypes
import ctypes.util
import logging
import subprocess
__author__ = "Norman Fomferra (Brockmann Consult GmbH) and contributors"
__copyright__ = "Copyright 2015-2018 Brockmann Consult GmbH and contributors"
__license__ = "Apache 2.0"
__version__ = "0.20.0.dev0"
# Setup a dedicated logger for jpyutil.
# This way importing jpyutil does not interfere with logging in other modules
logger = logging.getLogger('jpyutil')
# Get log level from environment variable JPY_LOG_LEVEL. Default to INFO
log_level = os.getenv('JPY_LOG_LEVEL', 'INFO')
try:
logger.setLevel(getattr(logging, log_level))
except AttributeError as ex:
print('JPY_LOG_LEVEL must be DEBUG, INFO, WARNING, ERROR or CRITICAL')
raise ex
ch = logging.StreamHandler()
ch.setLevel(getattr(logging, log_level))
formatter = logging.Formatter('%(name)s - %(levelname)s: %(message)s')
ch.setFormatter(formatter)
logger.addHandler(ch)
JDK_HOME_VARS = ('JPY_JAVA_HOME', 'JPY_JDK_HOME', 'JAVA_HOME', 'JDK_HOME',)
JRE_HOME_VARS = ('JPY_JAVA_HOME', 'JPY_JDK_HOME', 'JPY_JRE_HOME', 'JAVA_HOME', 'JDK_HOME', 'JRE_HOME', 'JAVA_JRE')
JVM_LIB_NAME = 'jvm'
def _get_python_lib_name():
try:
abiflags = sys.abiflags
except AttributeError:
abiflags = ''
version = sysconfig.get_config_var('VERSION')
if not version:
version = ''
return 'python' version abiflags
PYTHON_64BIT = sys.maxsize > 2 ** 32
PYTHON_LIB_NAME = _get_python_lib_name()
PYTHON_LIB_DIR_CONFIG_VAR_NAMES = ('LDLIBRARYDIR', 'srcdir',
'BINDIR', 'DESTLIB', 'DESTSHARED',
'BINLIBDEST', 'LIBDEST', 'LIBDIR',)
def _get_unique_config_values(names):
values = []
for name in names:
value = sysconfig.get_config_var(name)
if value and value not in values:
values.append(value)
return values
def _add_paths_if_exists(path_list, *paths):
for path in paths:
if os.path.exists(path) and path not in path_list:
path_list.append(path)
return path_list
def _find_loadable_spec_origin(name):
import importlib.util
spec = importlib.util.find_spec(name)
return spec.origin if spec and spec.has_location else None
def _get_module_path(name, fail=False, install_path=None):
""" Find the path to the jpy jni modules. """
spec_origin = _find_loadable_spec_origin(name)
if not spec_origin:
if fail:
raise ImportError("module '{}' not found, or is not loadable".format(name))
return None
return spec_origin if not install_path else os.path.join(install_path, os.path.split(spec_origin)[1])
def _find_file(search_dirs, *filenames):
for filename in filenames:
for dir_ in search_dirs:
path = os.path.normpath(os.path.join(dir_, filename))
path_exists = os.path.exists(path)
logger.debug("Exists '%s'? %s" % (path, "yes" if path_exists else "no"))
if path_exists:
return path
return None
def _get_java_api_properties(fail=False, path=None):
jpy_config = Properties()
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)
return jpy_config
def find_jdk_home_dir():
"""
Try to detect the JDK home directory from Maven, if available, or use
dedicated environment variables.
:return: pathname if found, else None
"""
def is_jdk_dir(path):
rst = os.path.exists(os.path.join(path, 'include')) and os.path.exists(os.path.join(path, 'lib'))
logger.debug(f'Checking {path} for JDK...: {"yes" if rst else "no"}')
return rst
def walk_to_jdk(path):
if is_jdk_dir(path):
return path
for root, dir_names, file_names in os.walk(path):
for d in dir_names:
p = os.path.join(root, d)
if p and is_jdk_dir(p):
return p
return None
for name in JDK_HOME_VARS:
jdk_home_dir = os.environ.get(name, None)
if jdk_home_dir:
logger.debug(f'JAVA_HOME set by environment variable to {jdk_home_dir}')
if is_jdk_dir(jdk_home_dir):
return jdk_home_dir
jdk_dir = walk_to_jdk(jdk_home_dir)
if jdk_dir:
logger.error(f'JAVA_HOME set by environment variable to {jdk_home_dir} but no no "include" or "lib" directory found. Possibly you meant {jdk_dir}?')
else:
logger.error(f'JAVA_HOME set by environment variable to {jdk_home_dir} but no no "include" or "lib" directory found. Does not appear to be a JDK directory.')
exit(1)
logger.debug('Checking Maven for JAVA_HOME...')
try:
output = subprocess.check_output(['mvn', '-v'])
if isinstance(output, bytes) and not isinstance(output, str):
# In Python 3, byte arrays must be explicitly converted into strings.
output = output.decode('utf-8')
for part in output.split('\n'):
if part.startswith('Java home:'):
path = part.split(':')[1].strip()
if path.endswith('jre'):
java_home = path[0:-3]
logger.debug(f'JAVA_HOME set by maven to {java_home}')
return java_home
except Exception:
# maven probably isn't installed or not on PATH
logger.debug('Maven not found on PATH. No JAVA_HOME found.')
return None
def _java_process_java_home():
logger.debug('Checking Java for JAVA_HOME...')
try:
from java_utilities import lookup_property
return lookup_property('java.home', use_env=False)
except ImportError:
logger.debug("java_utilities not found, skipping java process check")
except Exception as e:
logger.debug(e, exc_info=True)
return None
def find_jvm_dll_file(java_home_dir=None, fail=False):
"""
Try to detect the JVM's shared library file.
:param java_home_dir: The Java JRE or JDK installation directory to be used for searching.
:param fail: Controls behaviour when library file cannot be found. If False, use a fallback. If True, raise
a runtime error.
:return: pathname if found, else None
"""
logger.debug("Searching for JVM shared library file")
if java_home_dir:
jvm_dll_path = _find_jvm_dll_file(java_home_dir)
if jvm_dll_path:
return jvm_dll_path
jvm_dll_path = os.environ.get('JPY_JVM_DLL', None)
if jvm_dll_path:
return jvm_dll_path
for name in JRE_HOME_VARS:
java_home_dir = os.environ.get(name, None)
if java_home_dir:
jvm_dll_path = _find_jvm_dll_file(java_home_dir)
if jvm_dll_path:
return jvm_dll_path
java_home_dir = _java_process_java_home()
if java_home_dir:
jvm_dll_path = _find_jvm_dll_file(java_home_dir)
if jvm_dll_path:
return jvm_dll_path
jvm_dll_path = ctypes.util.find_library(JVM_LIB_NAME)
if jvm_dll_path:
logger.debug("No JVM shared library file found in all search paths. Using fallback %s" % repr(jvm_dll_path))
elif fail:
raise RuntimeError("can't find any JVM shared library")
return jvm_dll_path
def _get_jvm_lib_dirs(java_home_dir):
machine = platform.machine()
arch_dir_name = 'aarch64' if machine == 'aarch64' else 'amd64' if PYTHON_64BIT else 'i386'
return (os.path.join(java_home_dir, 'bin'),
os.path.join(java_home_dir, 'bin', 'server'),
os.path.join(java_home_dir, 'bin', 'client'),
os.path.join(java_home_dir, 'bin', 'zero'),
os.path.join(java_home_dir, 'bin', arch_dir_name),
os.path.join(java_home_dir, 'bin', arch_dir_name, 'server'),
os.path.join(java_home_dir, 'bin', arch_dir_name, 'client'),
os.path.join(java_home_dir, 'bin', arch_dir_name, 'zero'),
os.path.join(java_home_dir, 'lib'),
os.path.join(java_home_dir, 'lib', 'server'),
os.path.join(java_home_dir, 'lib', 'client'),
os.path.join(java_home_dir, 'lib', 'zero'),
os.path.join(java_home_dir, 'lib', arch_dir_name),
os.path.join(java_home_dir, 'lib', arch_dir_name, 'server'),
os.path.join(java_home_dir, 'lib', arch_dir_name, 'client'),
os.path.join(java_home_dir, 'lib', arch_dir_name, 'zero'),
)
def _get_existing_subdirs(dirs, subdirname):
new_dirs = []
for dir_ in dirs:
new_dir = os.path.join(dir_, subdirname)
if os.path.isdir(new_dir):
new_dirs.append(new_dir)
return new_dirs
def _find_jvm_dll_file(java_home_dir):
logger.debug("Searching for JVM shared library file in %s" % repr(java_home_dir))
if not os.path.exists(java_home_dir):
return None
search_dirs = []
jre_home_dir = os.path.join(java_home_dir, 'jre')
if os.path.exists(jre_home_dir):
search_dirs = _get_jvm_lib_dirs(jre_home_dir)
search_dirs = _get_jvm_lib_dirs(java_home_dir)
search_dirs = _add_paths_if_exists([], *search_dirs)
if platform.system() == 'Windows':
return _find_file(search_dirs, 'jvm.dll')
elif platform.system() == 'Darwin':
return _find_file(search_dirs, 'libjvm.dylib')
# 'Window' and 'Darwin' did not succeed, try 'libjvm.so' on remaining platforms
return _find_file(search_dirs, 'libjvm.so')
def _find_python_dll_file(fail=False):
logger.debug("Searching for Python shared library file")
# Prepare list of search directories
search_dirs = [sys.prefix]
# installed_base/lib needs to be added to the search path for Python 3.13t files
installed_base = sysconfig.get_config_var('installed_base')
if installed_base:
search_dirs.append(os.path.join(installed_base, "lib"))
extra_search_dirs = [sysconfig.get_config_var(name) for name in PYTHON_LIB_DIR_CONFIG_VAR_NAMES]
for extra_dir in extra_search_dirs:
if extra_dir and extra_dir not in search_dirs and os.path.exists(extra_dir):
search_dirs.append(extra_dir)
if platform.system() == 'Windows':
extra_search_dirs = _get_existing_subdirs(search_dirs, "DLLs")
search_dirs = extra_search_dirs search_dirs
multi_arch_sub_dir = sysconfig.get_config_var('multiarchsubdir')
if multi_arch_sub_dir:
while multi_arch_sub_dir.startswith('/'):
multi_arch_sub_dir = multi_arch_sub_dir[1:]
extra_search_dirs = _get_existing_subdirs(search_dirs, multi_arch_sub_dir)
search_dirs = extra_search_dirs search_dirs
logger.debug("Potential Python shared library search dirs: %s" % repr(search_dirs))
# Prepare list of possible library file names
# account for Python debug builds
debug_build = sysconfig.get_config_var('Py_DEBUG')
# account for Python 3.13 with GIL disabled
dll_suffix = ''
if sys.version_info >= (3, 13):
if not sys._is_gil_enabled():
dll_suffix = 't'
dll_suffix = 'd' if debug_build else ''
vmaj = str(sys.version_info.major)
vmin = str(sys.version_info.minor)
if platform.system() == 'Windows':
versions = (vmaj vmin, vmaj, vmaj vmin dll_suffix, '')
file_names = ['python' v '.dll' for v in versions]
elif platform.system() == 'Darwin':
versions = (vmaj "." vmin, vmaj, vmaj "." vmin dll_suffix, '')
file_names = ['libpython' v '.dylib' for v in versions] \
['libpython' v '.so' for v in versions]
else:
versions = (vmaj "." vmin, vmaj, vmaj "." vmin dll_suffix, '')
file_names = ['libpython' v '.so' for v in versions]
logger.debug("Potential Python shared library file names: %s" % repr(file_names))
python_dll_path = _find_file(search_dirs, *file_names)
if python_dll_path:
return python_dll_path
python_dll_path = ctypes.util.find_library(PYTHON_LIB_NAME)
if python_dll_path:
logger.debug(
"No Python shared library file found in all search paths. Using fallback %s" % repr(python_dll_path))
elif fail:
raise RuntimeError("can't find any Python shared library")
return python_dll_path
def _read_config(config_file):
config = Config()
config.load(config_file)
return config
def _get_python_api_config(config_file=None):
if config_file:
# 1. Try argument, if any
return _read_config(config_file)
try:
# 2. Try Python import machinery
import jpyconfig
return jpyconfig
except ImportError:
# 3. Try 'JPY_PY_CONFIG' environment variable, if any
config_file = os.environ.get('JPY_PY_CONFIG', None)
if config_file:
return _read_config(config_file)
return None
def preload_jvm_dll(jvm_dll_file=None,
java_home_dir=None,
config_file=None,
config=None,
fail=True):
# if jvm_dll_file is unknown, try getting it from config
if not jvm_dll_file:
if not config:
config = _get_python_api_config(config_file=config_file)
if config:
jvm_dll_file = getattr(config, 'jvm_dll', None)
if not java_home_dir:
java_home_dir = getattr(config, 'java_home', None)
# if jvm_dll_file is still unknown, try searching it using java_home_dir
if not jvm_dll_file:
jvm_dll_file = find_jvm_dll_file(java_home_dir=java_home_dir, fail=fail)
if jvm_dll_file:
logger.debug('Preloading JVM shared library %s' % repr(jvm_dll_file))
return ctypes.CDLL(jvm_dll_file, mode=ctypes.RTLD_GLOBAL)
else:
logger.warning('Failed to preload JVM shared library. No shared library found.')
return None
def get_jvm_options(jvm_maxmem=None,
jvm_classpath=None,
jvm_properties=None,
jvm_options=None,
config=None):
if config:
if not jvm_maxmem:
jvm_maxmem = getattr(config, 'jvm_maxmem', None)
if not jvm_classpath:
jvm_classpath = getattr(config, 'jvm_classpath', None)
if not jvm_properties:
jvm_properties = getattr(config, 'jvm_properties', None)
if not jvm_options:
jvm_options = getattr(config, 'jvm_options', None)
jvm_cp = None
if jvm_classpath and len(jvm_classpath) > 0:
jvm_cp = os.pathsep.join(jvm_classpath)
if not jvm_cp:
jvm_cp = os.environ.get('JPY_JVM_CLASSPATH', None)
if not jvm_maxmem:
jvm_maxmem = os.environ.get('JPY_JVM_MAXMEM', None)
java_api_properties = _get_java_api_properties().values
if jvm_properties:
# Overwrite jpy_config
jvm_properties = dict(list(java_api_properties.items()) list(jvm_properties.items()))
else:
jvm_properties = java_api_properties
options = []
if jvm_maxmem:
options.append('-Xmx' jvm_maxmem)
if jvm_cp:
options.append('-Djava.class.path=' jvm_cp)
if jvm_properties:
for key in jvm_properties:
value = jvm_properties[key]
options.append('-D' key '=' value)
if jvm_options:
options = jvm_options
return options
def init_jvm(java_home=None,
jvm_dll=None,
jvm_maxmem=None,
jvm_classpath=None,
jvm_properties=None,
jvm_options=None,
config_file=None,
config=None):
"""
Creates a configured Java virtual machine which will be used by jpy.
:param java_home: The Java JRE or JDK home directory used to search JVM shared library, if 'jvm_dll' is omitted.
:param jvm_dll: The JVM shared library file. My be inferred from 'java_home'.
:param jvm_maxmem: The JVM maximum heap space, e.g. '400M', '8G'. Refer to the java executable '-Xmx' option.
:param jvm_classpath: The JVM search paths for Java class files. Separated by colons (Unix) or semicolons
(Windows). Refer to the java executable '-cp' option.
:param jvm_properties: A dictionary of key -> value pairs passed to the JVM as Java system properties.
Refer to the java executable '-D' option.
:param jvm_options: A list of extra options for the JVM. Refer to the java executable options.
:param config_file: Extra configuration file (e.g. 'jpyconfig.py') to be loaded if 'config' parameter is omitted.
:param config: An optional default configuration object providing default attributes
for the 'jvm_maxmem', 'jvm_classpath', 'jvm_properties', 'jvm_options' parameters.
:return: a tuple (cdll, actual_jvm_options) on success, None otherwise.
"""
if not config:
config = _get_python_api_config(config_file=config_file)
cdll = preload_jvm_dll(jvm_dll_file=jvm_dll,
java_home_dir=java_home,
config_file=config_file,
config=config,
fail=False)
import jpy
if not jpy.has_jvm():
jvm_options = get_jvm_options(jvm_maxmem=jvm_maxmem,
jvm_classpath=jvm_classpath,
jvm_properties=jvm_properties,
jvm_options=jvm_options,
config=config)
logger.debug('Creating JVM with options %s' % repr(jvm_options))
jpy.create_jvm(options=jvm_options)
try:
py_lib_initializer = jpy.get_type('org.jpy.PyLibInitializer')
py_lib_initializer.initPyLib(
_find_python_dll_file(fail=True),
_get_module_path('jpy', fail=True),
_get_module_path('jdl', fail=True)
)
except ValueError:
# It's valid to not have jpy.jar on the classpath if you don't expect java to call into python
logger.debug("Unable to find org.jpy.PyLibInitializer on classpath")
pass
else:
jvm_options = None
# print('jvm_dll =', jvm_dll)
# print('jvm_options =', jvm_options)
return cdll, jvm_options
class Config:
def load(self, path):
"""
Read Python file from 'path', execute it and return object that stores all variables of the
Python code as attributes.
:param path:
:return:
"""
with open(path) as f:
code = f.read()
exec(code, {}, self.__dict__)
class Properties:
def __init__(self, values=None):
if values:
self.keys = values.keys()
self.values = values.copy()
else:
self.keys = []
self.values = {}
def set_property(self, key, value):
if value:
if key not in self.keys:
self.keys.append(key)
self.values[key] = value
else:
if key in self.keys:
self.keys.remove(key)
self.values.pop(key)
def get_property(self, key, default_value=None):
return self.values[key] if key in self.values else default_value
def store(self, path, comments=()):
with open(path, 'w') as f:
for comment in comments:
f.write('# ' str(comment).replace('\\', '\\\\') '\n')
for key in self.keys:
value = self.get_property(key)
if value:
f.write(str(key) ' = ' str(value).replace('\\', '\\\\') '\n')
else:
f.write(str(key) ' =\n')
def load(self, path):
self.__init__()
with open(path) as f:
lines = f.readlines()
for line in lines:
if line and len(line) > 0 and not line.startswith('#'):
tokens = line.split('=')
if len(tokens) == 2:
self.set_property(tokens[0].strip(), tokens[1].strip().replace('\\\\', '\\'))
else:
raise ValueError('illegal Java properties format ' line)
def _execute_python_scripts(scripts, **kwargs):
import subprocess
failures = 0
for script in scripts:
exit_code = subprocess.call([sys.executable, script], **kwargs)
if exit_code:
failures = 1
return failures
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,
jvm_properties=None,
jvm_options=None):
"""
Writes the jpy configuration files for Java and/or Python.
: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
"""
import datetime
retcode = 0
tool_name = os.path.basename(__file__)
py_api_config_basename = 'jpyconfig.py'
java_api_config_basename = 'jpyconfig.properties'
if not jvm_dll_file:
jvm_dll_file = find_jvm_dll_file(java_home_dir=java_home_dir)
if jvm_dll_file:
py_api_config_file = os.path.join(out_dir, py_api_config_basename)
try:
with open(py_api_config_file, 'w') as f:
f.write("# Created by '%s' tool on %s\n" % (tool_name, str(datetime.datetime.now())))
f.write(
"# This file is read by the 'jpyutil' module in order to load and configure the JVM from Python\n")
if java_home_dir:
f.write('java_home = %s\n' % repr(java_home_dir))
f.write('jvm_dll = %s\n' % repr(jvm_dll_file))
f.write('jvm_maxmem = None\n')
f.write('jvm_classpath = []\n')
if jvm_properties is None:
f.write('jvm_properties = {}\n')
else:
f.write('jvm_properties = ' str(jvm_properties) '\n')
if jvm_options is None:
f.write('jvm_options = []\n')
else:
f.write('jvm_options = [\'' jvm_options '\']\n')
logger.info("jpy Python API configuration written to '%s'" % py_api_config_file)
except Exception:
logger.exception("Error while writing Python API configuration")
if req_py_api_conf:
retcode = 1
else:
logger.error("Can't determine any JVM shared library")
if req_py_api_conf:
retcode = 2
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, 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"])
logger.info("jpy Java API configuration written to '%s'" % java_api_config_file)
except Exception:
logger.exception("Error while writing Java API configuration")
if req_java_api_conf:
retcode = 3
return retcode
def _main():
import argparse
out_default = os.path.dirname(os.path.abspath(__file__))
parser = argparse.ArgumentParser(description='Generate configuration files for the jpy Python API (jpyconfig.py)\n'
'and the jpy Java API (jpyconfig.properties).')
parser.add_argument("-o", "--out", action='store', default=out_default,
help="Output directory for the generated configuration files. Defaults to " out_default)
parser.add_argument("--java_home", action='store', default=None, help="Java JDK or JRE home directory. Can also be "
"set using one of the environment variables "
" | ".join(JRE_HOME_VARS) ".")
parser.add_argument("--jvm_dll", action='store', default=None, help="Java JVM shared library file. Usually inferred"
" from java_home option. Can also be set "
"using environment variable JPY_JVM_DLL.")
parser.add_argument("--log_file", action='store', default=None, help="Optional log file.")
parser.add_argument("--log_level", action='store', default='INFO',
help="Possible values: DEBUG, INFO, WARNING, ERROR. Default is INFO.")
parser.add_argument("-j", "--req_java", action='store_true', default=False,
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()
# Using _ suffix to avoid shadowing global log_level variable
log_level_ = getattr(logging, args.log_level.upper(), None)
if not isinstance(log_level_, int):
raise ValueError('Invalid log level: %s' % log_level_)
log_format = '%(levelname)s: %(message)s'
log_file = args.log_file
if log_file:
logging.basicConfig(format=log_format, level=log_level_, filename=log_file, filemode='w')
else:
logging.basicConfig(format=log_format, level=log_level_)
try:
retcode = write_config_files(out_dir=args.out,
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,
install_dir=args.install_dir)
except:
logger.exception("Configuration failed")
retcode = 100
if retcode == 0:
logger.info("Configuration completed successfully")
exit(retcode)
if __name__ == '__main__':
_main()