pyrit.setup.initialize_pyrit_async

pyrit.setup.initialize_pyrit_async#

async initialize_pyrit_async(memory_db_type: Literal['InMemory', 'SQLite', 'AzureSQL'] | str, *, initialization_scripts: Sequence[str | Path] | None = None, initializers: Sequence[PyRITInitializer] | None = None, env_files: Sequence[Path] | None = None, silent: bool = False, **memory_instance_kwargs: Any) → None[source]#

Initialize PyRIT with the provided memory instance and loads environment files.

Parameters:

  • memory_db_type (MemoryDatabaseType) – The MemoryDatabaseType string literal which indicates the memory instance to use for central memory. Options include “InMemory”, “SQLite”, and “AzureSQL”.

  • initialization_scripts (Optional[Sequence[Union[str, pathlib.Path]]]) – Optional sequence of Python script paths that contain PyRITInitializer classes. Each script must define either a get_initializers() function or an ‘initializers’ variable that returns/contains a list of PyRITInitializer instances.

  • initializers (Optional[Sequence[PyRITInitializer]]) – Optional sequence of PyRITInitializer instances to execute directly. These provide type-safe, validated configuration with clear documentation.

  • env_files (Optional[Sequence[pathlib.Path]]) – Optional sequence of environment file paths to load in order. If not provided, will load default .env and .env.local files from PyRIT home if they exist. All paths must be valid pathlib.Path objects.

  • silent (bool) – If True, suppresses print statements about environment file loading. Defaults to False.

  • **memory_instance_kwargs (Optional[Any]) – Additional keyword arguments to pass to the memory instance.

Raises:

ValueError – If an unsupported memory_db_type is provided or if env_files contains non-existent files.

Contents