pymhf.main module#

class pymhf.main.WrappedProcess(proc: Process | None = None, thread_handle: int | None = None)#

Bases: object

resume()#
suspend()#
pymhf.main.get_process_when_ready(cmd: list[str], target: str, required_assemblies: list[str] | None = None, is_steam: bool = True, start_paused: bool = False) → tuple[pyRunner | None, WrappedProcess | None]#
pymhf.main.load_mod_file(filepath: str, config_overrides: pymhfConfig | None = None)#

Load an individual file as a mod.

Parameters:

  • filepath – The relative or absolute filepath to a single python file to be loaded as a mod. It is generally recommended to pass an absolute path as it will be more reliable.

  • config_overrides – An optional dictionary containing values which will override any existing config values read from the specified file.

pymhf.main.load_module(plugin_name: str, module_path: str)#

Load a module. This should be used when loading an entire folder or a plugin based on name.

exception pymhf.main.pymhfExitException#

Bases: Exception

pymhf.main.run_module(module_path: str, config: pymhfConfig, plugin_name: str | None = None, config_dir: str | None = None)#

Run the module provided.

Parameters:

  • module_path – The path to the module or single-file mod to be run.

  • config – A mapping of the associated pymhf config.

  • plugin_name – The name of the plugin. This will only be provided if we are running a library.

  • config_dir – The local config directory. This will only be provided if we are running a library.