convert_to_secret_str() — langchain Function Reference

Architecture documentation for the convert_to_secret_str() function in utils.py from the langchain codebase.

Function python Observability CallbackManager

Entity Profile

Observability→ CallbackManager→ convert_to_secret_str() — langchain Function Reference

Dependency Diagram

graph TD
  56d0a220_75eb_9a94_ccfb_7688fe0cef7a["convert_to_secret_str()"]
  b77fd012_b825_e350_c8f5_a8f1b44997d9["utils.py"]
  56d0a220_75eb_9a94_ccfb_7688fe0cef7a -->|defined in| b77fd012_b825_e350_c8f5_a8f1b44997d9
  style 56d0a220_75eb_9a94_ccfb_7688fe0cef7a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/utils/utils.py lines 313–324

def convert_to_secret_str(value: SecretStr | str) -> SecretStr:
    """Convert a string to a `SecretStr` if needed.

    Args:
        value: The value to convert.

    Returns:
        The `SecretStr` value.
    """
    if isinstance(value, SecretStr):
        return value
    return SecretStr(value)