dspex

# Generated by SnakeBridge v0.12.0 - DO NOT EDIT MANUALLY
# Regenerate with: mix compile
# Library: dspy 3.1.2
# Python module: dspy.utils.logging_utils

defmodule Dspy.Utils.LoggingUtils do
  @moduledoc """
  Submodule bindings for `dspy.utils.logging_utils`.
  """

  def __snakebridge_python_name__, do: "dspy.utils.logging_utils"
  def __snakebridge_library__, do: "dspy"

  @doc """

  """
  @spec configure_dspy_loggers(term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def configure_dspy_loggers(root_module_name, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :configure_dspy_loggers, [root_module_name], opts)
  end

  @doc """
  Disables the `DSPyLoggingStream` used by event logging APIs throughout DSPy

  (`eprint()`, `logger.info()`, etc), silencing all subsequent event logs.

  Returns:
  - `term()`
  """
  @spec disable_logging(keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def disable_logging(opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :disable_logging, [], opts)
  end

  @doc """
  A Python stream for use with event logging APIs throughout DSPy (`eprint()`,

  `logger.info()`, etc.). This stream wraps `sys.stderr`, forwarding `write()` and
  `flush()` calls to the stream referred to by `sys.stderr` at the time of the call.
  It also provides capabilities for disabling the stream to silence event logs.

  Returns:
  - `Dspy.Utils.LoggingUtils.DSPyLoggingStream.t()`
  """
  @spec dspy_logging_stream() ::
          {:ok, Dspy.Utils.LoggingUtils.DSPyLoggingStream.t()} | {:error, Snakepit.Error.t()}
  def dspy_logging_stream() do
    SnakeBridge.Runtime.get_module_attr(__MODULE__, "DSPY_LOGGING_STREAM")
  end

  @doc """
  Enables the `DSPyLoggingStream` used by event logging APIs throughout DSPy

  (`eprint()`, `logger.info()`, etc), emitting all subsequent event logs. This
  reverses the effects of `disable_logging()`.

  Returns:
  - `term()`
  """
  @spec enable_logging(keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def enable_logging(opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :enable_logging, [], opts)
  end
end