warn_beta() — langchain Function Reference

Architecture documentation for the warn_beta() function in beta_decorator.py from the langchain codebase.

Function python CoreAbstractions Serialization called by 1

Entity Profile

CoreAbstractions→ Serialization→ warn_beta() — langchain Function Reference

Dependency Diagram

graph TD
  5b954159_166b_1d8d_a550_0870b51fa2dd["warn_beta()"]
  99630651_1456_c882_1b50_48e292b442ff["beta_decorator.py"]
  5b954159_166b_1d8d_a550_0870b51fa2dd -->|defined in| 99630651_1456_c882_1b50_48e292b442ff
  a46773f8_4c3d_a279_43db_daf6a5b4e0a6["beta()"]
  a46773f8_4c3d_a279_43db_daf6a5b4e0a6 -->|calls| 5b954159_166b_1d8d_a550_0870b51fa2dd
  style 5b954159_166b_1d8d_a550_0870b51fa2dd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/_api/beta_decorator.py lines 213–245

def warn_beta(
    *,
    message: str = "",
    name: str = "",
    obj_type: str = "",
    addendum: str = "",
) -> None:
    """Display a standardized beta annotation.

    Args:
        message: Override the default beta message.

            The %(name)s, %(obj_type)s, %(addendum)s format specifiers will be replaced
            by the values of the respective arguments passed to this function.
        name: The name of the annotated object.
        obj_type: The object type being annotated.
        addendum: Additional text appended directly to the final message.
    """
    if not message:
        message = ""

        if obj_type:
            message += f"The {obj_type} `{name}`"
        else:
            message += f"`{name}`"

        message += " is in beta. It is actively being worked on, so the API may change."

        if addendum:
            message += f" {addendum}"

    warning = LangChainBetaWarning(message)
    warnings.warn(warning, category=LangChainBetaWarning, stacklevel=4)