pyrit.setup.initialize_pyrit

pyrit.setup.initialize_pyrit#

initialize_pyrit(memory_db_type: Literal['InMemory', 'SQLite', 'AzureSQL'] | str, *, initialization_scripts: Sequence[str | Path] | None = None, initializers: Sequence[PyRITInitializer] | None = None, **memory_instance_kwargs: Any) → None[source]#

Initializes 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.

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

Contents