PyConfig

java.lang.Object
- jep.PyConfig

```
public class PyConfig
extends java.lang.Object
```
A configuration object for setting Python initialization parameters.

These options map directly to the options documented at https://docs.python.org/3/c-api/init_config.html#pyconfig

This class was rewritten with the introduction of PEP-587. It contains many deprecated methods that reference the Python c-api available before PEP-587 was implemented and newer replacement methods that reference the current configuration c-api described in PEP-587. Although all methods still work the newer methods should be preferred and the deprecated methods will be removed in the future.

Since:

3.6

Constructor Summary

Constructors
Constructor and Description

PyConfig()
Deprecated.
Use python() or isolated instead.

Constructors
Constructor and Description
`PyConfig()` Deprecated. Use `python()` or `isolated` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static PyConfig`	`isolated()` Create a new PyConfig with the default settings to isolate python from the rest of the system.
`static PyConfig`	`python()` Create a new PyConfig with the default settings to behave as the regular Python.
`PyConfig`	`setArgv(java.lang.String... argv)` Set sys.argv for `SharedInterpreter`s and shared modules used by `SubInterpreter`s.
`PyConfig`	`setDontWriteBytecodeFlag(int dontWriteBytecodeFlag)` Deprecated. Use `#setWriteBytecode(int)` instead.
`PyConfig`	`setHashRandomizationFlag(int hashRandomizationFlag)` Deprecated. Use `setHashSeed(int)` and `#setUseHashSeed(int)` instead.
`PyConfig`	`setHashSeed(int hashSeed)` If `setUseHashSeed(boolean)` is false this value is ignored but if it is true this is a fixed seed for generating the hash() of the types covered by the hash randomization.
`PyConfig`	`setHome(java.lang.String home)` Set the default Python "home" directory, that is, the location of the standard Python libraries.
`PyConfig`	`setIgnoreEnvironmentFlag(int ignoreEnvironmentFlag)` Deprecated. Use `#setUseEnvironment(int)` instead.
`PyConfig`	`setNoSiteFlag(int noSiteFlag)` Deprecated. Use `#setSiteImport(int)` instead.
`PyConfig`	`setNoUserSiteDirectory(int noUserSiteDirectory)` Deprecated. Use `#setUserSiteDirectory(int)` instead.
`PyConfig`	`setOptimizationLevel(int optimizationLevel)` Set the compilation optimization level: 0: Peephole optimizer, set __debug__ to True. 1: Level 0, remove assertions, set __debug__ to False. 2: Level 1, strip docstrings.
`PyConfig`	`setOptimizeFlag(int optimizeFlag)` Deprecated. Use `setOptimizationLevel(int)` instead.
`PyConfig`	`setParseArgv(boolean parseArgv)` If true, parse argv the same way the regular Python parses command line arguments, and strip Python arguments from argv.
`PyConfig`	`setProgramName(java.lang.String programName)` Set the program name used to initialize executable and in early error messages during Python initialization.
`PyConfig`	`setPythonHome(java.lang.String pythonHome)` Deprecated. Use `setHome(String)` instead.
`PyConfig`	`setSiteImport(boolean siteImport)` Import the site module at startup? If false, disable the import of the module site and the site-dependent manipulations of sys.path that it entails.
`PyConfig`	`setUseEnvironment(boolean useEnvironment)` Use environment variables? If false, ignore the environment variables.
`PyConfig`	`setUseHashSeed(boolean useHashSeed)` If this is set to true the value of `hashSeed` is used as a fixed seed for generating the hash() of the types covered by the hash randomization.
`PyConfig`	`setUserSiteDirectory(boolean userSiteDirectory)` If true, add the user site directory to sys.path.
`PyConfig`	`setVerbose(int verbose)` Verbose mode.
`PyConfig`	`setVerboseFlag(int verboseFlag)` Deprecated. Use `setVerbose(int)` instead.
`PyConfig`	`setWriteBytecode(boolean writeBytecode)` If false, Python won't try to write .pyc files on the import of source modules.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PyConfig
```
@Deprecated
public PyConfig()
```
    Deprecated. Use python() or isolated instead.
- Method Detail
  - setArgv
```
public PyConfig setArgv(java.lang.String... argv)
```
    Set sys.argv for SharedInterpreters and shared modules used by SubInterpreters.
    
    Parameters:
    
    argv - command line arguments
    
    Returns:
    
    a reference to this PyConfig
    
    See Also:
    
    https://docs.python.org/3/c-api/init_config.html#c.PyConfig_SetArgv
  - setHashSeed
```
public PyConfig setHashSeed(int hashSeed)
```
    If setUseHashSeed(boolean) is false this value is ignored but if it is true this is a fixed seed for generating the hash() of the types covered by the hash randomization.
    
    Parameters:
    
    hashSeed - a fixed seed to use for generating hash() values
    
    Returns:
    
    a reference to this PyConfig
    
    See Also:
    
    https://docs.python.org/3/c-api/init_config.html#c.PyConfig.hash_seed
  - setUseHashSeed
```
public PyConfig setUseHashSeed(boolean useHashSeed)
```
    If this is set to true the value of hashSeed is used as a fixed seed for generating the hash() of the types covered by the hash randomization.
    
    Parameters:
    
    useHashSeed - a boolean to indicate whether a fixed seed should be used.
    
    Returns:
    
    a reference to this PyConfig
    
    See Also:
    
    https://docs.python.org/3/c-api/init_config.html#c.PyConfig.use_hash_seed
  - setHome
```
public PyConfig setHome(java.lang.String home)
```
    Set the default Python "home" directory, that is, the location of the standard Python libraries.
    
    Parameters:
    
    home - the directory to use for Python home.
    
    Returns:
    
    a reference to this PyConfig
    
    See Also:
    
    https://docs.python.org/3/c-api/init_config.html#c.PyConfig.home
  - setOptimizationLevel
```
public PyConfig setOptimizationLevel(int optimizationLevel)
```
    Set the compilation optimization level:
  - 0: Peephole optimizer, set __debug__ to True.
  - 1: Level 0, remove assertions, set __debug__ to False.
  - 2: Level 1, strip docstrings.

Parameters:: optimizationLevel - the optimization level to use.
Returns:: a reference to this PyConfig
See Also:: https://docs.python.org/3/c-api/init_config.html#c.PyConfig.optimization_level

setParseArgv
```
public PyConfig setParseArgv(boolean parseArgv)
```
If true, parse argv the same way the regular Python parses command line arguments, and strip Python arguments from argv.

Parameters:

parseArgv - a boolean to indicate whether python should parse command line arguments

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.parse_argv

setProgramName
```
public PyConfig setProgramName(java.lang.String programName)
```
Set the program name used to initialize executable and in early error messages during Python initialization.

Parameters:

programName - the name of the executable Python program.

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.program_name

setSiteImport
```
public PyConfig setSiteImport(boolean siteImport)
```
Import the site module at startup? If false, disable the import of the module site and the site-dependent manipulations of sys.path that it entails. Also disable these manipulations if the site module is explicitly imported later (call site.main() if you want them to be triggered).

Parameters:

siteImport - whether to enable import of site module.

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.site_import

setUseEnvironment
```
public PyConfig setUseEnvironment(boolean useEnvironment)
```
Use environment variables? If false, ignore the environment variables.

Parameters:

useEnvironment -

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.use_environment

setUserSiteDirectory
```
public PyConfig setUserSiteDirectory(boolean userSiteDirectory)
```
If true, add the user site directory to sys.path.

Parameters:

userSiteDirectory - whether to add user site directory to the path.

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.user_site_directory

setVerbose
```
public PyConfig setVerbose(int verbose)
```
Verbose mode. If greater than 0, print a message each time a module is imported, showing the place (filename or built-in module) from which it is loaded. If greater than or equal to 2, print a message for each file that is checked for when searching for a module. Also provides information on module cleanup at exit.

Parameters:

verbose - the level of verbose

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.verbose

setWriteBytecode
```
public PyConfig setWriteBytecode(boolean writeBytecode)
```
If false, Python won't try to write .pyc files on the import of source modules.

Parameters:

writeBytecode - whether to write bytecode files.

Returns:

a reference to this PyConfig

See Also:

https://docs.python.org/3/c-api/init_config.html#c.PyConfig.write_bytecode

setNoSiteFlag
```
@Deprecated
public PyConfig setNoSiteFlag(int noSiteFlag)
```
Deprecated. Use #setSiteImport(int) instead.

Set the Py_NoSiteFlag variable on the python interpreter. This corresponds to the python "-S" flag and will prevent the "site" module from being automatically loaded.

Parameters:

noSiteFlag - value to pass to Python for Py_NoSiteFlag

Returns:

a reference to this PyConfig

setNoUserSiteDirectory
```
@Deprecated
public PyConfig setNoUserSiteDirectory(int noUserSiteDirectory)
```
Deprecated. Use #setUserSiteDirectory(int) instead.

Set the Py_NoUserSiteDirectory variable on the python interpreter. This corresponds to the python "-s" flag and will prevent the user's local python site directory from being added to sys.path.

Parameters:

noUserSiteDirectory - value to pass to Python for Py_NoUserSiteDirectory

Returns:

a reference to this PyConfig

setIgnoreEnvironmentFlag
```
@Deprecated
public PyConfig setIgnoreEnvironmentFlag(int ignoreEnvironmentFlag)
```
Deprecated. Use #setUseEnvironment(int) instead.

Set the Py_IgnoreEnvironmentFlag variable on the python interpreter. This corresponds to the python "-E" flag and will instruct python to ignore all PYTHON* environment variables (e.g. PYTHONPATH).

Parameters:

ignoreEnvironmentFlag - value to pass to Python for Py_IgnoreEnvironmentFlag

Returns:

a reference to this PyConfig

setVerboseFlag
```
@Deprecated
public PyConfig setVerboseFlag(int verboseFlag)
```
Deprecated. Use setVerbose(int) instead.

Set the Py_VerboseFlag variable on the python interpreter. This corresponds to the python "-v" flag and will increase verbosity, in particular tracing import statements.

Parameters:

verboseFlag - value to pass to Python for Py_VerboseFlag

Returns:

a reference to this PyConfig

setOptimizeFlag
```
@Deprecated
public PyConfig setOptimizeFlag(int optimizeFlag)
```
Deprecated. Use setOptimizationLevel(int) instead.

Set the Py_OptimizeFlag variable on the python interpreter. This corresponds to the python "-O" flag and will slightly optimize the generated bytecode.

Parameters:

optimizeFlag - value to pass to Python for Py_OptimizeFlag

Returns:

a reference to this PyConfig

setDontWriteBytecodeFlag
```
@Deprecated
public PyConfig setDontWriteBytecodeFlag(int dontWriteBytecodeFlag)
```
Deprecated. Use #setWriteBytecode(int) instead.

Set the Py_DontWriteBytecodeFlag variable on the python interpreter. This corresponds to the python "-B" flag and will instruct python to not write .py[co] files on import.

Parameters:

dontWriteBytecodeFlag - value to pass to Python for Py_DontWriteBytecodeFlag

Returns:

a reference to this PyConfig

setHashRandomizationFlag
```
@Deprecated
public PyConfig setHashRandomizationFlag(int hashRandomizationFlag)
```
Deprecated. Use setHashSeed(int) and #setUseHashSeed(int) instead.

Set the Py_HashRandomizationFlag variable on the python interpreter. This corresponds to the environment variable PYTHONHASHSEED.

Parameters:

hashRandomizationFlag - value to pass to Python for Py_HashRandomizationFlag

Returns:

a reference to this PyConfig

setPythonHome
```
@Deprecated
public PyConfig setPythonHome(java.lang.String pythonHome)
```
Deprecated. Use setHome(String) instead.

Set the home location on the python interpreter. This is the location of the standard python libraries. This corresponds to the environment variable PYTHONHOME.

Parameters:

pythonHome - the home location of the python installation

Returns:

a reference to this PyConfig

python
```
public static PyConfig python()
```
Create a new PyConfig with the default settings to behave as the regular Python.

See Also:

https://docs.python.org/3/c-api/init_config.html#python-configuration

isolated
```
public static PyConfig isolated()
```
Create a new PyConfig with the default settings to isolate python from the rest of the system.

See Also:

https://docs.python.org/3/c-api/init_config.html#isolated-configuration

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class PyConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PyConfig

Method Detail

setArgv

setHashSeed

setUseHashSeed

setHome

setOptimizationLevel

setParseArgv

setProgramName

setSiteImport

setUseEnvironment

setUserSiteDirectory

setVerbose

setWriteBytecode

setNoSiteFlag

setNoUserSiteDirectory

setIgnoreEnvironmentFlag

setVerboseFlag

setOptimizeFlag

setDontWriteBytecodeFlag

setHashRandomizationFlag

setPythonHome

python

isolated

toString