scyjava 1.9.0__tar.gz → 1.10.0__tar.gz

scyjava-1.10.0/MANIFEST.in

@@ -0,0 +1,19 @@
+# Metadata
+include MANIFEST.in
+include Makefile
+include README.md
+include UNLICENSE
+include pyproject.toml
+
+# Conda Environment Files
+include environment.yml
+include dev-environment.yml
+
+# Directory inclusion
+graft src
+graft tests
+graft bin
+
+# File exclusion
+global-exclude __pycache__
+global-exclude *.py[doc]

scyjava-1.10.0/Makefile

@@ -0,0 +1,29 @@
+help:
+	@echo "Available targets:\n\
+		clean - remove build files and directories\n\
+		setup - create mamba developer environment\n\
+		lint  - run code formatters and linters\n\
+		test  - run automated test suite\n\
+		dist  - generate release archives\n\
+	\n\
+	Remember to 'mamba activate scyjava-dev' first!"
+
+clean:
+	bin/clean.sh
+
+setup:
+	bin/setup.sh
+
+check:
+	@bin/check.sh
+
+lint: check
+	bin/lint.sh
+
+test: check
+	bin/test.sh
+
+dist: check clean
+	python -m build
+
+.PHONY: test

{scyjava-1.9.0/src/scyjava.egg-info → scyjava-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scyjava
-Version: 1.9.0
+Version: 1.10.0
 Summary: Supercharged Java access from Python
 Author-email: SciJava developers <ctrueden@wisc.edu>
 License: The Unlicense
@@ -15,7 +15,6 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -27,9 +26,25 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Java Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+Requires-Dist: jpype1>=1.3.0
+Requires-Dist: jgo
 Provides-Extra: dev
+Requires-Dist: autopep8; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: flake8-pyproject; extra == "dev"
+Requires-Dist: flake8-typing-imports; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: jep; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
+Requires-Dist: pandas; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Requires-Dist: validate-pyproject[all]; extra == "dev"
 
 [![build status](https://github.com/scijava/scyjava/actions/workflows/build.yml/badge.svg)](https://github.com/scijava/scyjava/actions/workflows/build.yml)
 [![codecov](https://codecov.io/gh/scijava/scyjava/branch/main/graph/badge.svg?token=NLK3ADZUCU)](https://codecov.io/gh/scijava/scyjava)
@@ -88,7 +103,7 @@ u'1.8.0_152-release'
 
 ```python
 >>> from scyjava import config, jimport
->>> config.add_option('-Djava.awt.headless=true')
+>>> config.enable_headless_mode()
 >>> config.add_repositories({'scijava.public': 'https://maven.scijava.org/content/groups/public'})
 >>> config.endpoints.append('net.imagej:imagej:2.1.0')
 >>> ImageJ = jimport('net.imagej.ImageJ')
@@ -191,6 +206,15 @@ FUNCTIONS
         Add a converter to the list used by to_python.
         :param converter: A Converter from java to python
 
+    available_processors() -> int
+        Get the number of processors available to the JVM.
+
+        This function is a shortcut for Java's
+        Runtime.getRuntime().availableProcessors().
+
+        :return: The number of available processors.
+        :raise RuntimeError: if the JVM has not yet been started.
+
     enable_python_scripting(context)
         Adds a Python script runner object to the ObjectService of the given
         SciJava context. Intended for use in conjunction with
@@ -199,6 +223,13 @@ FUNCTIONS
         :param context: The org.scijava.Context containing the ObjectService
             where the PythonScriptRunner should be injected.
 
+    gc() -> None
+        Do a round of Java garbage collection.
+
+        This function is a shortcut for Java's System.gc().
+
+        :raise RuntimeError: If the JVM has not started yet.
+
     get_version(java_class_or_python_package) -> str
         Return the version of a Java class or Python package.
 
@@ -230,13 +261,13 @@ FUNCTIONS
         those actions via the jpype.setupGuiEnvironment wrapper function;
         see the Troubleshooting section of the scyjava README for details.
 
-    is_jarray(data) -> bool
+    is_jarray(data: Any) -> bool
         Return whether the given data object is a Java array.
 
     is_jvm_headless() -> bool
         Return true iff Java is running in headless mode.
 
-        :raises RuntimeError: If the JVM has not started yet.
+        :raise RuntimeError: If the JVM has not started yet.
 
     is_memoryarraylike(arr: Any) -> bool
         Return True iff the object is memoryarraylike:
@@ -282,33 +313,43 @@ FUNCTIONS
         :param lengths: List of lengths for the array. For example:
         `jarray('z', [3, 7])` is the equivalent of `new boolean[3][7]` in Java.
         You can pass a single integer to make a 1-dimensional array of that length.
-        :returns: The newly allocated array
+        :return: The newly allocated array
 
     jclass(data)
         Obtain a Java class object.
 
-        :param data: The object from which to glean the class.
         Supported types include:
-        A. Name of a class to look up, analogous to
-        Class.forName("java.lang.String");
-        B. A jpype.JClass object analogous to String.class;
-        C. A jpype.JObject instance analogous to o.getClass().
-        :returns: A java.lang.Class object, suitable for use with reflection.
-        :raises TypeError: if the argument is not one of the aforementioned types.
+
+        A. Name of a class to look up -- e.g. "java.lang.String" --
+           which returns the equivalent of Class.forName("java.lang.String").
+
+        B. A static-style class reference -- e.g. String --
+           which returns the equivalent of String.class.
+
+        C. A Java object -- e.g. foo --
+           which returns the equivalent of foo.getClass().
+
+        Note that if you pass a java.lang.Class object, you will get back Class.class,
+        i.e. the Java class for the Class class. :-)
+
+        :param data: The object from which to glean the class.
+        :return: A java.lang.Class object, suitable for use with reflection.
+        :raise TypeError: if the argument is not one of the aforementioned types.
 
     jimport(class_name: str)
         Import a class from Java to Python.
 
         :param class_name: Name of the class to import.
-        :returns: A pointer to the class, which can be used to
-                  e.g. instantiate objects of that class.
+        :return:
+            A pointer to the class, which can be used to
+            e.g. instantiate objects of that class.
 
     jinstance(obj, jtype) -> bool
         Test if the given object is an instance of a particular Java type.
 
         :param obj: The object to check.
         :param jtype: The Java type, as either a jimported class or as a string.
-        :returns: True iff the object is an instance of that Java type.
+        :return: True iff the object is an instance of that Java type.
 
     jstacktrace(exc) -> str
         Extract the Java-side stack trace from a Java exception.
@@ -323,37 +364,82 @@ FUNCTIONS
                 print(jstacktrace(exc))
 
         :param exc: The Java Throwable from which to extract the stack trace.
-        :returns: A multi-line string containing the stack trace, or empty string
+        :return: A multi-line string containing the stack trace, or empty string
         if no stack trace could be extracted.
 
     jvm_started() -> bool
         Return true iff a Java virtual machine (JVM) has been started.
 
     jvm_version() -> str
-        Gets the version of the JVM as a tuple,
-        with each dot-separated digit as one element.
-        Characters in the version string beyond only
-        numbers and dots are ignored, in line
-        with the java.version system property.
+        Gets the version of the JVM as a tuple, with each dot-separated digit
+        as one element. Characters in the version string beyond only numbers
+        and dots are ignored, in line with the java.version system property.
 
         Examples:
         * OpenJDK 17.0.1 -> [17, 0, 1]
         * OpenJDK 11.0.9.1-internal -> [11, 0, 9, 1]
         * OpenJDK 1.8.0_312 -> [1, 8, 0]
 
-        If the JVM is already started,
-        this function should return the equivalent of:
+        If the JVM is already started, this function returns the equivalent of:
            jimport('java.lang.System')
              .getProperty('java.version')
              .split('.')
 
-        In case the JVM is not started yet,a best effort is made to deduce
+        In case the JVM is not started yet, a best effort is made to deduce
         the version from the environment without actually starting up the
         JVM in-process. If the version cannot be deduced, a RuntimeError
         with the cause is raised.
 
+    memory_max() -> int
+        Get the maximum amount of memory that the JVM will attempt to use.
+
+        This number will always be greater than or equal to memory_total().
+
+        In case the JVM was configured with -Xmx flag upon startup (e.g. using
+        the scyjava.config.set_heap_max function), the value will typically
+        correspond approximately, but not exactly, to the configured value.
+
+        This function is a shortcut for Java's Runtime.getRuntime().maxMemory().
+
+        :return: The maximum memory in bytes.
+        :raise RuntimeError: if the JVM has not yet been started.
+
+    memory_total() -> int
+        Get the total amount of memory currently reserved by the JVM.
+
+        This number will always be less than or equal to memory_max().
+
+        In case the JVM was configured with -Xms flag upon startup (e.g. using
+        the scyjava.config.set_heap_min function), the initial value will typically
+        correspond approximately, but not exactly, to the configured value,
+        although it is likely to grow over time as more Java objects are allocated.
+
+        This function is a shortcut for Java's Runtime.getRuntime().totalMemory().
+
+        :return: The total memory in bytes.
+        :raise RuntimeError: if the JVM has not yet been started.
+
+    memory_used() -> int
+        Get the amount of memory currently in use by the JVM.
+
+        This function is a shortcut for
+        Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory().
+
+        :return: The used memory in bytes.
+        :raise RuntimeError: if the JVM has not yet been started.
+
+    numeric_bounds(the_type: type) -> Union[Tuple[int, int], Tuple[float, float], Tuple[NoneType, NoneType]]
+        Get the minimum and maximum values for the given numeric type.
+        For example, a Java long returns (int(Long.MIN_VALUE), int(Long.MAX_VALUE)),
+        whereas a Java double returns (float(-Double.MAX_VALUE), float(Double.MAX_VALUE)).
+
+        :param the_type: The type whose minimum and maximum values are needed.
+        :return:
+            The minimum and maximum values as a two-element tuple of int or float,
+            or a two-element tuple of None if no known bounds.
+
     shutdown_jvm() -> None
-        Shutdown the JVM.
+        Shut down the JVM.
 
         This function makes a best effort to clean up Java resources first.
         In particular, shutdown hooks registered with scyjava.when_jvm_stops
@@ -371,6 +457,8 @@ FUNCTIONS
         Note that if the JVM is not already running, then this function does
         nothing! In particular, shutdown hooks are skipped in this situation.
 
+        :raise RuntimeError: if this method is called while in Jep mode.
+
     start_jvm(options=None) -> None
         Explicitly connect to the Java virtual machine (JVM). Only one JVM can
         be active; does nothing if the JVM has already been started. Calling
@@ -378,8 +466,9 @@ FUNCTIONS
         time a scyjava function needing a JVM is invoked, one is started on the
         fly with the configuration specified via the scijava.config mechanism.
 
-        :param options: List of options to pass to the JVM. For example:
-                        ['-Djava.awt.headless=true', '-Xmx4g']
+        :param options:
+            List of options to pass to the JVM.
+            For example: ['-Dfoo=bar', '-XX:+UnlockExperimentalVMOptions']
 
     to_java(obj: Any, **hints: Dict) -> Any
         Recursively convert a Python object to a Java object.
@@ -422,11 +511,13 @@ FUNCTIONS
         * float values in Double range but outside float range convert to Double
         * float values outside double range convert to BigDecimal
 
-        :param obj: The Python object to convert.
-        :param hints: An optional dictionary of hints, to help scyjava
-                      make decisions about how to do the conversion.
-        :returns: A corresponding Java object with the same contents.
-        :raises TypeError: if the argument is not one of the aforementioned types.
+        :param obj:
+            The Python object to convert.
+        :param hints:
+            An optional dictionary of hints, to help scyjava
+            make decisions about how to do the conversion.
+        :return: A corresponding Java object with the same contents.
+        :raise TypeError: if the argument is not one of the aforementioned types.
 
     to_python(data: Any, gentle: bool = False) -> Any
         Recursively convert a Java object to a Python object.
@@ -443,12 +534,15 @@ FUNCTIONS
         * Iterable -> collections.abc.Iterable
         * Iterator -> collections.abc.Iterator
 
-        :param data: The Java object to convert.
-        :param gentle: If set, and the type cannot be converted, leaves
-                       the data alone rather than raising a TypeError.
-        :returns: A corresponding Python object with the same contents.
-        :raises TypeError: if the argument is not one of the aforementioned types,
-                           and the gentle flag is not set.
+        :param data:
+            The Java object to convert.
+        :param gentle:
+            If set, and the type cannot be converted, leaves
+            the data alone rather than raising a TypeError.
+        :return: A corresponding Python object with the same contents.
+        :raise TypeError:
+            if the argument is not one of the aforementioned types,
+            and the gentle flag is not set.
 
     when_jvm_starts(f) -> None
         Registers a function to be called when the JVM starts (or immediately).
@@ -477,7 +571,7 @@ unless you do one of two things:
 
     ```python
     from scyjava import config, jimport
-    config.add_option('-Djava.awt.headless=true')
+    config.enable_headless_mode()
     ```
 
     In which case, you'll get `java.awt.HeadlessException` instead of a

scyjava-1.9.0/PKG-INFO → scyjava-1.10.0/README.md

@@ -1,36 +1,3 @@
-Metadata-Version: 2.1
-Name: scyjava
-Version: 1.9.0
-Summary: Supercharged Java access from Python
-Author-email: SciJava developers <ctrueden@wisc.edu>
-License: The Unlicense
-Project-URL: homepage, https://github.com/scijava/scyjava
-Project-URL: documentation, https://github.com/scijava/scyjava/blob/main/README.md
-Project-URL: source, https://github.com/scijava/scyjava
-Project-URL: download, https://pypi.org/project/scyjava/
-Project-URL: tracker, https://github.com/scijava/scyjava/issues
-Keywords: java,maven,cross-language
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: Unix
-Classifier: Operating System :: MacOS
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development :: Libraries :: Java Libraries
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-
 [![build status](https://github.com/scijava/scyjava/actions/workflows/build.yml/badge.svg)](https://github.com/scijava/scyjava/actions/workflows/build.yml)
 [![codecov](https://codecov.io/gh/scijava/scyjava/branch/main/graph/badge.svg?token=NLK3ADZUCU)](https://codecov.io/gh/scijava/scyjava)
 
@@ -88,7 +55,7 @@ u'1.8.0_152-release'
 
 ```python
 >>> from scyjava import config, jimport
->>> config.add_option('-Djava.awt.headless=true')
+>>> config.enable_headless_mode()
 >>> config.add_repositories({'scijava.public': 'https://maven.scijava.org/content/groups/public'})
 >>> config.endpoints.append('net.imagej:imagej:2.1.0')
 >>> ImageJ = jimport('net.imagej.ImageJ')
@@ -191,6 +158,15 @@ FUNCTIONS
         Add a converter to the list used by to_python.
         :param converter: A Converter from java to python
 
+    available_processors() -> int
+        Get the number of processors available to the JVM.
+
+        This function is a shortcut for Java's
+        Runtime.getRuntime().availableProcessors().
+
+        :return: The number of available processors.
+        :raise RuntimeError: if the JVM has not yet been started.
+
     enable_python_scripting(context)
         Adds a Python script runner object to the ObjectService of the given
         SciJava context. Intended for use in conjunction with
@@ -199,6 +175,13 @@ FUNCTIONS
         :param context: The org.scijava.Context containing the ObjectService
             where the PythonScriptRunner should be injected.
 
+    gc() -> None
+        Do a round of Java garbage collection.
+
+        This function is a shortcut for Java's System.gc().
+
+        :raise RuntimeError: If the JVM has not started yet.
+
     get_version(java_class_or_python_package) -> str
         Return the version of a Java class or Python package.
 
@@ -230,13 +213,13 @@ FUNCTIONS
         those actions via the jpype.setupGuiEnvironment wrapper function;
         see the Troubleshooting section of the scyjava README for details.
 
-    is_jarray(data) -> bool
+    is_jarray(data: Any) -> bool
         Return whether the given data object is a Java array.
 
     is_jvm_headless() -> bool
         Return true iff Java is running in headless mode.
 
-        :raises RuntimeError: If the JVM has not started yet.
+        :raise RuntimeError: If the JVM has not started yet.
 
     is_memoryarraylike(arr: Any) -> bool
         Return True iff the object is memoryarraylike:
@@ -282,33 +265,43 @@ FUNCTIONS
         :param lengths: List of lengths for the array. For example:
         `jarray('z', [3, 7])` is the equivalent of `new boolean[3][7]` in Java.
         You can pass a single integer to make a 1-dimensional array of that length.
-        :returns: The newly allocated array
+        :return: The newly allocated array
 
     jclass(data)
         Obtain a Java class object.
 
-        :param data: The object from which to glean the class.
         Supported types include:
-        A. Name of a class to look up, analogous to
-        Class.forName("java.lang.String");
-        B. A jpype.JClass object analogous to String.class;
-        C. A jpype.JObject instance analogous to o.getClass().
-        :returns: A java.lang.Class object, suitable for use with reflection.
-        :raises TypeError: if the argument is not one of the aforementioned types.
+
+        A. Name of a class to look up -- e.g. "java.lang.String" --
+           which returns the equivalent of Class.forName("java.lang.String").
+
+        B. A static-style class reference -- e.g. String --
+           which returns the equivalent of String.class.
+
+        C. A Java object -- e.g. foo --
+           which returns the equivalent of foo.getClass().
+
+        Note that if you pass a java.lang.Class object, you will get back Class.class,
+        i.e. the Java class for the Class class. :-)
+
+        :param data: The object from which to glean the class.
+        :return: A java.lang.Class object, suitable for use with reflection.
+        :raise TypeError: if the argument is not one of the aforementioned types.
 
     jimport(class_name: str)
         Import a class from Java to Python.
 
         :param class_name: Name of the class to import.
-        :returns: A pointer to the class, which can be used to
-                  e.g. instantiate objects of that class.
+        :return:
+            A pointer to the class, which can be used to
+            e.g. instantiate objects of that class.
 
     jinstance(obj, jtype) -> bool
         Test if the given object is an instance of a particular Java type.
 
         :param obj: The object to check.
         :param jtype: The Java type, as either a jimported class or as a string.
-        :returns: True iff the object is an instance of that Java type.
+        :return: True iff the object is an instance of that Java type.
 
     jstacktrace(exc) -> str
         Extract the Java-side stack trace from a Java exception.
@@ -323,37 +316,82 @@ FUNCTIONS
                 print(jstacktrace(exc))
 
         :param exc: The Java Throwable from which to extract the stack trace.
-        :returns: A multi-line string containing the stack trace, or empty string
+        :return: A multi-line string containing the stack trace, or empty string
         if no stack trace could be extracted.
 
     jvm_started() -> bool
         Return true iff a Java virtual machine (JVM) has been started.
 
     jvm_version() -> str
-        Gets the version of the JVM as a tuple,
-        with each dot-separated digit as one element.
-        Characters in the version string beyond only
-        numbers and dots are ignored, in line
-        with the java.version system property.
+        Gets the version of the JVM as a tuple, with each dot-separated digit
+        as one element. Characters in the version string beyond only numbers
+        and dots are ignored, in line with the java.version system property.
 
         Examples:
         * OpenJDK 17.0.1 -> [17, 0, 1]
         * OpenJDK 11.0.9.1-internal -> [11, 0, 9, 1]
         * OpenJDK 1.8.0_312 -> [1, 8, 0]
 
-        If the JVM is already started,
-        this function should return the equivalent of:
+        If the JVM is already started, this function returns the equivalent of:
            jimport('java.lang.System')
              .getProperty('java.version')
              .split('.')
 
-        In case the JVM is not started yet,a best effort is made to deduce
+        In case the JVM is not started yet, a best effort is made to deduce
         the version from the environment without actually starting up the
         JVM in-process. If the version cannot be deduced, a RuntimeError
         with the cause is raised.
 
+    memory_max() -> int
+        Get the maximum amount of memory that the JVM will attempt to use.
+
+        This number will always be greater than or equal to memory_total().
+
+        In case the JVM was configured with -Xmx flag upon startup (e.g. using
+        the scyjava.config.set_heap_max function), the value will typically
+        correspond approximately, but not exactly, to the configured value.
+
+        This function is a shortcut for Java's Runtime.getRuntime().maxMemory().
+
+        :return: The maximum memory in bytes.
+        :raise RuntimeError: if the JVM has not yet been started.
+
+    memory_total() -> int
+        Get the total amount of memory currently reserved by the JVM.
+
+        This number will always be less than or equal to memory_max().
+
+        In case the JVM was configured with -Xms flag upon startup (e.g. using
+        the scyjava.config.set_heap_min function), the initial value will typically
+        correspond approximately, but not exactly, to the configured value,
+        although it is likely to grow over time as more Java objects are allocated.
+
+        This function is a shortcut for Java's Runtime.getRuntime().totalMemory().
+
+        :return: The total memory in bytes.
+        :raise RuntimeError: if the JVM has not yet been started.
+
+    memory_used() -> int
+        Get the amount of memory currently in use by the JVM.
+
+        This function is a shortcut for
+        Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory().
+
+        :return: The used memory in bytes.
+        :raise RuntimeError: if the JVM has not yet been started.
+
+    numeric_bounds(the_type: type) -> Union[Tuple[int, int], Tuple[float, float], Tuple[NoneType, NoneType]]
+        Get the minimum and maximum values for the given numeric type.
+        For example, a Java long returns (int(Long.MIN_VALUE), int(Long.MAX_VALUE)),
+        whereas a Java double returns (float(-Double.MAX_VALUE), float(Double.MAX_VALUE)).
+
+        :param the_type: The type whose minimum and maximum values are needed.
+        :return:
+            The minimum and maximum values as a two-element tuple of int or float,
+            or a two-element tuple of None if no known bounds.
+
     shutdown_jvm() -> None
-        Shutdown the JVM.
+        Shut down the JVM.
 
         This function makes a best effort to clean up Java resources first.
         In particular, shutdown hooks registered with scyjava.when_jvm_stops
@@ -371,6 +409,8 @@ FUNCTIONS
         Note that if the JVM is not already running, then this function does
         nothing! In particular, shutdown hooks are skipped in this situation.
 
+        :raise RuntimeError: if this method is called while in Jep mode.
+
     start_jvm(options=None) -> None
         Explicitly connect to the Java virtual machine (JVM). Only one JVM can
         be active; does nothing if the JVM has already been started. Calling
@@ -378,8 +418,9 @@ FUNCTIONS
         time a scyjava function needing a JVM is invoked, one is started on the
         fly with the configuration specified via the scijava.config mechanism.
 
-        :param options: List of options to pass to the JVM. For example:
-                        ['-Djava.awt.headless=true', '-Xmx4g']
+        :param options:
+            List of options to pass to the JVM.
+            For example: ['-Dfoo=bar', '-XX:+UnlockExperimentalVMOptions']
 
     to_java(obj: Any, **hints: Dict) -> Any
         Recursively convert a Python object to a Java object.
@@ -422,11 +463,13 @@ FUNCTIONS
         * float values in Double range but outside float range convert to Double
         * float values outside double range convert to BigDecimal
 
-        :param obj: The Python object to convert.
-        :param hints: An optional dictionary of hints, to help scyjava
-                      make decisions about how to do the conversion.
-        :returns: A corresponding Java object with the same contents.
-        :raises TypeError: if the argument is not one of the aforementioned types.
+        :param obj:
+            The Python object to convert.
+        :param hints:
+            An optional dictionary of hints, to help scyjava
+            make decisions about how to do the conversion.
+        :return: A corresponding Java object with the same contents.
+        :raise TypeError: if the argument is not one of the aforementioned types.
 
     to_python(data: Any, gentle: bool = False) -> Any
         Recursively convert a Java object to a Python object.
@@ -443,12 +486,15 @@ FUNCTIONS
         * Iterable -> collections.abc.Iterable
         * Iterator -> collections.abc.Iterator
 
-        :param data: The Java object to convert.
-        :param gentle: If set, and the type cannot be converted, leaves
-                       the data alone rather than raising a TypeError.
-        :returns: A corresponding Python object with the same contents.
-        :raises TypeError: if the argument is not one of the aforementioned types,
-                           and the gentle flag is not set.
+        :param data:
+            The Java object to convert.
+        :param gentle:
+            If set, and the type cannot be converted, leaves
+            the data alone rather than raising a TypeError.
+        :return: A corresponding Python object with the same contents.
+        :raise TypeError:
+            if the argument is not one of the aforementioned types,
+            and the gentle flag is not set.
 
     when_jvm_starts(f) -> None
         Registers a function to be called when the JVM starts (or immediately).
@@ -477,7 +523,7 @@ unless you do one of two things:
 
     ```python
     from scyjava import config, jimport
-    config.add_option('-Djava.awt.headless=true')
+    config.enable_headless_mode()
     ```
 
     In which case, you'll get `java.awt.HeadlessException` instead of a