invirtualenv.plugin module¶
Functions to enable packaging plugin functionality
-
invirtualenv.plugin.config()¶ Get default configuration settings for all installed plugins
Returns: - str – Configparser format configuration as a string
- dict – Configuration types dictionary
-
invirtualenv.plugin.config_defaults()¶ Get default configuration settings for all installed plugins
Returns: ConfigParser format configuration as a string Return type: str
-
invirtualenv.plugin.config_types()¶ Get the default types for all configuration valuse based on installed plugins.
Returns: Dictionary with configuration values as keys and object classes as values Return type: dict
-
invirtualenv.plugin.config_update(configuration)¶ Allow plugins to update the configuration after the values have been propagated.
This function updates the dictionary in place.
Parameters: configuration (dict) – The configuration dictionary
-
invirtualenv.plugin.create_package(package_type)¶ Create a package of a specific package type
This functions iterates all the registered invirtualenv.create_package entry points and runs them passing the package_type argument to them.
These plugins should return None if they do not handle that package type.
Parameters: package_type (str) – The package type to create a package for
-
invirtualenv.plugin.create_package_configuration(package_type)¶ Create a package of a specific package type
This functions iterates all the registered invirtualenv.create_package entry points and runs them passing the package_type argument to them.
These plugins should return None if they do not handle that package type.
Parameters: package_type (str) – The package type to create a package for
-
invirtualenv.plugin.get_package_plugin(package_type)¶ Get a plugin for a specific package
Parameters: package_type (str) – The package type to fetch Returns: The invirtualenv plugin for the specific package_type Return type: InvirtualEnvPlugin
-
invirtualenv.plugin.installed_plugins()¶