Update PyConfig to align with PEP 587.#586
Conversation
| void pyembed_preinit(JNIEnv*, jint, jint, jint, jint, jint, jint, jint, | ||
| jstring, jstring); | ||
| void pyembed_startup(JNIEnv*, jobjectArray); | ||
| void pyembed_startup(JNIEnv*, jobjectArray, jint, jint,jstring, jint, jstring, |
There was a problem hiding this comment.
Need to add a space between jint,jstring.
| * if called after the Python interpreter is initialized | ||
| * | ||
| * @since 3.7 | ||
| * @deprecated Use {@link PyConfig#setArgv(String...)} instead. |
There was a problem hiding this comment.
How confident are you that this new alternative will have the same behavior?
There was a problem hiding this comment.
For the primary goal of setting sys.argv for shared modules I am confident that the TestSharedArgv classes verifying the behavior is the same. I am not quite as confident that there are no other side effects. Both the old call to PySys_SetArgvEx and the new call to PyConfig_SetBytesArgv have documented optional side affects to set the path or parse the command line for options however in both cases we are setting it up to not do anything extra so as far as I can tell they are doing the same thing.
| * standard Python libraries. | ||
| * | ||
| * @param home | ||
| * the directory tpuse for Python home. |
| @Deprecated | ||
| public PyConfig setNoSiteFlag(int noSiteFlag) { | ||
| this.noSiteFlag = noSiteFlag; | ||
| this.siteImport = (noSiteFlag == 0) ? 1 : 0; |
There was a problem hiding this comment.
Mostly stylistic choice, but I think it might be slightly cleaner if you had these deprecated methods call the new non-deprecated methods to set the values. Just a thought.
There was a problem hiding this comment.
I agree that is nicer, fixed.
The PyConfig Java class is currently used to set Python Global Configuration Variables but this part of the Python c-api has been deprecated since Python 3.12 and is scheduled for removal in 3.14. PEP-587 describes a new mechanism for handling Python Initialization Configuration. This change removes the use of the deprecated variables and switches things over to the new way of doing things. This change should be fully backwards compatible for anyone using Jep, however many public methods in PyConfig are now deprecated.
Now that the Python c-api includes a PyConfig structure I changed our PyConfig class in Java to have fields and setters corresponding to the c-api structure. Making these match up keeps the native code simple and I think this will be easier to document and maintain moving forward but it makes this change confusing because several of the fields were inverted in the transition. As an example there was previously a configuration variable called DontWriteBytecode and it has been replaced with a field called WriteBytecode so if previously DontWriteByteCode was true instead now WriteByteCode should be false. In the java PyConfig class this means the existing
setDontWriteBytecodeFlag()method is deprecated and a newsetWriteBytecode()has been added.