-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathconfig.py
More file actions
482 lines (379 loc) · 14.4 KB
/
Copy pathconfig.py
File metadata and controls
482 lines (379 loc) · 14.4 KB
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
from __future__ import annotations
import enum as _enum
import logging as _logging
import os as _os
from collections.abc import Sequence
from pathlib import Path
import jpype as _jpype
_SCIJAVA_PUBLIC = "https://maven.scijava.org/content/groups/public"
_logger = _logging.getLogger(__name__)
# Constraints on the Java installation to be used.
_fetch_java: str = "always"
_java_vendor: str = "zulu-jre"
_java_version: str = "11"
endpoints: list[str] = []
_repositories = {"scijava.public": _SCIJAVA_PUBLIC}
_verbose = 0
_manage_deps = True
_cache_dir = Path.home() / ".jgo"
_m2_repo = Path.home() / ".m2" / "repository"
_options = []
_kwargs = {"interrupt": True}
_shortcuts = {}
class Mode(_enum.Enum):
JEP = "jep"
JPYPE = "jpype"
try:
import jep # noqa: F401
mode = Mode.JEP
except ImportError:
mode = Mode.JPYPE
def set_java_constraints(
fetch: str | bool | None = None,
vendor: str | None = None,
version: str | None = None,
maven_url: str | None = None,
maven_sha: str | None = None,
) -> None:
"""
Set constraints on the version of Java to be used.
:return:
"always" to download (or retrieve from cache) a suitable JDK/JRE;
"never" to rely only on an existing "system Java" installation
(discovered via the JAVA_HOME environment variable or system path);
"auto" to prefer system Java, but download one if no existing JVM is found.
:param fetch:
If "always" (default), a suitable JDK/JRE will be downloaded (or retrieved from
cache if previously downloaded) ignoring any system Java installations;
if "never", only an already-available JDK/JRE will be used,
discovered via the JAVA_HOME environment variable or system path;
If "auto", a suitable JDK/JRE will be downloaded and cached only when an
existing JDK/JRE cannot be located on the system.
:param vendor:
The vendor of the JDK/JRE distribution to download and cache.
Defaults to "zulu-jre". Does not constrain matching of system JDK/JREs.
:param version:
Expression defining the Java version to download and cache.
Defaults to "11". Does not constrain matching of system JDK/JREs.
:param maven_url:
DEPRECATED: scyjava no longer uses Maven to resolve dependencies.
:param maven_sha:
DEPRECATED: scyjava no longer uses Maven to resolve dependencies.
"""
global _fetch_java, _java_vendor, _java_version
if fetch is not None:
if isinstance(fetch, bool):
# Be nice and allow boolean values as a convenience.
fetch = "always" if fetch else "never"
expected = ["auto", "always", "never"]
if fetch not in expected:
raise ValueError(f"Fetch mode {fetch} is not one of {expected}")
_fetch_java = fetch
if vendor is not None:
_java_vendor = vendor
if version is not None:
_java_version = version
if maven_url is not None:
_logger.warning(
"Deprecated argument: scyjava.config.set_java_constraints(maven_url). "
"scyjava no longer uses Maven to resolve dependencies."
)
_maven_url = maven_url
if maven_sha is not None:
_logger.warning(
"Deprecated argument: scyjava.config.set_java_constraints(maven_sha). "
"scyjava no longer uses Maven to resolve dependencies."
)
_maven_sha = maven_sha
def get_fetch_java() -> str:
"""
Get whether to download (or retrieve from local cache if previously downloaded)
a JDK/JRE distribution and set up the JVM.
To set this value, see set_java_constraints.
:return:
"always" to download (or retrieve from cache) a suitable JDK/JRE;
"never" to fully rely on an existing installation
(discovered via the JAVA_HOME environment variable or system path);
"auto" to prefer system Java, but download one if no existing JVM is found.
"""
return _fetch_java
def get_java_vendor() -> str:
"""
Vendor of the Java installation to download and cache. Does not
constrain matching of system JDK/JREs, only those fetched and cached.
To set this value, see set_java_constraints.
:return: String defining the desired JDK/JRE vendor for downloaded JDK/JREs.
"""
return _java_vendor
def get_java_version() -> str:
"""
Expression defining the Java version to download and cache. Does not
constrain matching of system JDK/JREs, only those fetched and cached.
To set this value, see set_java_constraints.
:return: String defining the desired JDK/JRE version for downloaded JDK/JREs.
"""
return _java_version
def add_repositories(*args, **kwargs) -> None:
"""
Add one or more Maven repositories to be used by jgo for downloading dependencies.
See the jgo documentation for details.
"""
for arg in args:
_logger.debug("Adding repositories %s to %s", arg, _repositories)
_repositories.update(arg)
_logger.debug("Adding repositories %s to %s", kwargs, _repositories)
_repositories.update(kwargs)
def get_repositories() -> dict[str, str]:
"""
Get the Maven repositories jgo will use for downloading dependencies.
See the jgo documentation for details.
"""
return _repositories
def set_verbose(level: int) -> None:
"""
Set the level of verbosity for logging environment construction details.
:param level:
0 for quiet (default), 1 for verbose, 2 for extra verbose.
"""
global _verbose
_logger.debug("Setting verbose level to %d (was %d)", level, _verbose)
_verbose = level
def get_verbose() -> int:
"""
Get the level of verbosity for logging environment construction details.
"""
_logger.debug("Getting verbose level: %d", _verbose)
return _verbose
def set_manage_deps(manage: bool) -> None:
"""
Set whether jgo will resolve dependencies in managed mode.
See the jgo documentation for details.
"""
global _manage_deps
_logger.debug("Setting manage deps to %d (was %d)", manage, _manage_deps)
_manage_deps = manage
def get_manage_deps() -> bool:
"""
Get whether jgo will resolve dependencies in managed mode.
See the jgo documentation for details.
"""
return _manage_deps
def set_cache_dir(cache_dir: Path | str) -> None:
"""
Set the location to use for the jgo environment cache.
See the jgo documentation for details.
"""
global _cache_dir
_logger.debug("Setting cache dir to %s (was %s)", cache_dir, _cache_dir)
_cache_dir = cache_dir
def get_cache_dir() -> Path:
"""
Get the location to use for the jgo environment cache.
See the jgo documentation for details.
"""
return _cache_dir
def set_m2_repo(repo_dir: Path | str) -> None:
"""
Set the location to use for the local Maven repository cache.
"""
global _m2_repo
_logger.debug("Setting m2 repo dir to %s (was %s)", repo_dir, _m2_repo)
_m2_repo = repo_dir
def get_m2_repo() -> Path:
"""
Get the location to use for the local Maven repository cache.
"""
return _m2_repo
def add_classpath(*path) -> None:
"""
Add elements to the Java class path.
See also find_jars, which can be combined with add_classpath to
add all the JARs beneath a given directory to the class path, a la:
add_classpath(*find_jars('/path/to/folder-of-jars'))
:param path:
One or more file paths to add to the Java class path.
A valid Java class path element is typically either a .jar file or a
directory. When a class needs to be loaded, the Java runtime looks
beneath each class path element for the .class file, nested in a folder
structure matching the class's package name. For example, when loading
a class foo.bar.Fubar, if a directory /home/jdoe/classes is included as
a class path element, the class file at
/home/jdoe/classes/foo/bar/Fubar.class will be used. It works the same
for JAR files, except that the class files are loaded from the
directory structure inside the JAR; in this example, a JAR file
/home/jdoe/jars/fubar.jar on the class path containing file
foo/bar/Fubar.class inside would be another way to provide the class
foo.bar.Fubar.
"""
for p in path:
_jpype.addClassPath(p)
def find_jars(directory: Path | str) -> list[str]:
"""
Find .jar files beneath a given directory.
:param directory: the folder to be searched
:return: a list of JAR files
"""
jars = []
for root, _, files in _os.walk(directory):
for f in files:
if f.lower().endswith(".jar"):
path = _os.path.join(root, f)
jars.append(path)
return jars
def get_classpath() -> str:
"""
Get the classpath to be passed to the JVM at startup.
"""
return _jpype.getClassPath()
def set_heap_min(mb: int | None = None, gb: int | None = None) -> None:
"""
Set the initial amount of memory to allocate to the Java heap.
Either mb or gb, but not both, must be given.
Shortcut for passing -Xms###m or -Xms###g to Java.
:param mb:
The ### of megabytes of memory Java should start with.
:param gb:
The ### of gigabytes of memory Java should start with.
:raise ValueError: If exactly one of mb or gb is not given.
"""
add_option(f"-Xms{_mem_value(mb, gb)}")
def set_heap_max(mb: int | None = None, gb: int | None = None) -> None:
"""
Shortcut for passing -Xmx###m or -Xmx###g to Java.
Either mb or gb, but not both, must be given.
:param mb:
The maximum ### of megabytes of memory Java is allowed to use.
:param gb:
The maximum ### of gigabytes of memory Java is allowed to use.
:raise ValueError: If exactly one of mb or gb is not given.
"""
add_option(f"-Xmx{_mem_value(mb, gb)}")
def _mem_value(mb: int | None = None, gb: int | None = None) -> str:
# fmt: off
if mb is not None and gb is None: return f"{mb}m"
if gb is not None and mb is None: return f"{gb}g"
# fmt: on
raise ValueError("Exactly one of mb or gb must be given.")
def enable_headless_mode() -> None:
"""
Enable headless mode, for running Java without a display.
This mode prevents any graphical elements from popping up.
Shortcut for passing -Djava.awt.headless=true to Java.
"""
add_option("-Djava.awt.headless=true")
def enable_remote_debugging(port: int = 8000, suspend: bool = False):
"""
Enable the JDWP debugger, listening on the given port of localhost.
Shortcut for -agentlib:jdwp=transport=dt_socket,address=localhost:<port>.
:param port:
The port to listen on for client debuggers (e.g. IDEs).
:param suspend:
If True, pause when starting up the JVM until a client debugger connects.
"""
jdwp_args = {
"transport": "dt_socket",
"server": "y",
"suspend": "y" if suspend else "n",
"address": f"localhost:{port}",
}
arg_string = ",".join(f"{k}={v}" for k, v in jdwp_args.items())
add_option(f"-agentlib:jdwp={arg_string}")
def add_option(option: str) -> None:
"""
Add an option to pass at JVM startup. Examples:
-Djava.awt.headless=true
-Xmx10g
--add-opens=java.base/java.lang=ALL-UNNAMED
-XX:+UnlockExperimentalVMOptions
:param option:
The option to add.
"""
_options.append(option)
def add_options(options: str | Sequence) -> None:
"""
Add one or more options to pass at JVM startup.
:param options:
Sequence of options to add, or single string to pass as an individual option.
"""
if isinstance(options, str):
_options.append(options)
else:
_options.extend(options)
def get_options() -> list[str]:
"""
Get the list of options to be passed at JVM startup.
"""
return _options
def add_kwargs(**kwargs) -> None:
"""
Add keyword arguments to be passed to JPype at JVM startup. Examples:
jvmpath = "/path/to/my_jvm"
ignoreUnrecognized = True
convertStrings = True
interrupt = True
"""
_kwargs.update(kwargs)
def get_kwargs() -> dict[str, str]:
"""
Get the keyword arguments to be passed to JPype at JVM startup.
"""
return _kwargs
def add_shortcut(k: str, v: str):
"""
Add a shortcut key/value to be used by jgo for evaluating endpoints.
See the jgo documentation for details.
"""
_shortcuts[k] = v
def get_shortcuts() -> dict[str, str]:
"""
Get the dictionary of shorts that jgo will use for evaluating endpoints.
See the jgo documentation for details.
"""
return _shortcuts
def add_endpoints(*new_endpoints):
"""
DEPRECATED since v1.2.1
Please modify the endpoints field directly instead.
"""
_logger.warning(
"Deprecated method call: scyjava.config.add_endpoints(). "
"Please modify scyjava.config.endpoints directly instead."
)
_logger.debug("Adding endpoints %s to %s", new_endpoints, endpoints)
endpoints.extend(new_endpoints)
def get_endpoints():
"""
DEPRECATED since v1.2.1
Please access the endpoints field directly instead.
"""
_logger.warning(
"Deprecated method call: scyjava.config.get_endpoints(). "
"Please access scyjava.config.endpoints directly instead."
)
return endpoints
_maven_url: str = "tgz+https://archive.apache.org/dist/maven/maven-3/3.9.9/binaries/apache-maven-3.9.9-bin.tar.gz"
_maven_sha: str = "a555254d6b53d267965a3404ecb14e53c3827c09c3b94b5678835887ab404556bfaf78dcfe03ba76fa2508649dca8531c74bca4d5846513522404d48e8c4ac8b"
def get_maven_url() -> str:
"""
DEPRECATED since v1.12.3
scyjava no longer uses Maven to resolve dependencies,
but rather jgo v2's pure-Python dependency resolver.
:return: Path to Maven 3.9.9 download (for backwards compatibility).
"""
_logger.warning(
"Deprecated method call: scyjava.config.get_maven_url(). "
"scyjava no longer uses Maven to resolve dependencies."
)
return _maven_url
def get_maven_sha() -> str:
"""
DEPRECATED since v1.12.3
scyjava no longer uses Maven to resolve dependencies,
but rather jgo v2's pure-Python dependency resolver.
:return: Hash of Maven 3.9.9 download (for backwards compatibility).
"""
_logger.warning(
"Deprecated method call: scyjava.config.get_maven_sha(). "
"scyjava no longer uses Maven to resolve dependencies."
)
return _maven_sha