BaseFakeCallbackHandlerMixin Class — langchain Architecture

Architecture documentation for the BaseFakeCallbackHandlerMixin class in callbacks.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  36d14fc2_cb11_2856_bc3b_120f8e72dda8["BaseFakeCallbackHandlerMixin"]
  542f3f1e_7782_84d9_777a_e16a365138ae["BaseFakeCallbackHandler"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|extends| 542f3f1e_7782_84d9_777a_e16a365138ae
  07deddc6_bb63_0758_8452_6935ef3e67d6["callbacks.py"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|defined in| 07deddc6_bb63_0758_8452_6935ef3e67d6
  ecce78b2_3824_bfbc_1ae1_a1027cee45ea["on_llm_start_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| ecce78b2_3824_bfbc_1ae1_a1027cee45ea
  6b822d8f_ba1d_6660_f0c2_985553561557["on_llm_end_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 6b822d8f_ba1d_6660_f0c2_985553561557
  426649b4_c343_abe7_1c46_607846eccf9a["on_llm_error_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 426649b4_c343_abe7_1c46_607846eccf9a
  413201cf_fe17_fabd_1b31_56225aec9938["on_llm_new_token_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 413201cf_fe17_fabd_1b31_56225aec9938
  ff42f7af_d696_1c1b_4056_499f478daded["on_retry_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| ff42f7af_d696_1c1b_4056_499f478daded
  56f54948_c4bc_db04_67ff_718612010a22["on_chain_start_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 56f54948_c4bc_db04_67ff_718612010a22
  677efecb_5b84_97bc_1442_3d0e0c849bac["on_chain_end_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 677efecb_5b84_97bc_1442_3d0e0c849bac
  9fd3c042_aefb_4860_0b2c_c800d2d2e50f["on_chain_error_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 9fd3c042_aefb_4860_0b2c_c800d2d2e50f
  82f9e2fd_a386_dd6a_13de_81a97d81ecc6["on_tool_start_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| 82f9e2fd_a386_dd6a_13de_81a97d81ecc6
  bebe41d4_df46_6697_647a_074eeca37009["on_tool_end_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| bebe41d4_df46_6697_647a_074eeca37009
  adacb555_d915_216b_f965_052ef9a788f0["on_tool_error_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| adacb555_d915_216b_f965_052ef9a788f0
  acc081bc_507f_6ea9_61a9_660413bd8867["on_agent_action_common()"]
  36d14fc2_cb11_2856_bc3b_120f8e72dda8 -->|method| acc081bc_507f_6ea9_61a9_660413bd8867

Relationship Graph

Source Code

libs/core/tests/unit_tests/fake/callbacks.py lines 48–116

class BaseFakeCallbackHandlerMixin(BaseFakeCallbackHandler):
    """Base fake callback handler mixin for testing."""

    def on_llm_start_common(self) -> None:
        self.llm_starts += 1
        self.starts += 1

    def on_llm_end_common(self) -> None:
        self.llm_ends += 1
        self.ends += 1

    def on_llm_error_common(self, *args: Any, **kwargs: Any) -> None:
        self.errors += 1
        self.errors_args.append({"args": args, "kwargs": kwargs})

    def on_llm_new_token_common(self) -> None:
        self.llm_streams += 1

    def on_retry_common(self) -> None:
        self.retries += 1

    def on_chain_start_common(self) -> None:
        self.chain_starts += 1
        self.starts += 1

    def on_chain_end_common(self) -> None:
        self.chain_ends += 1
        self.ends += 1

    def on_chain_error_common(self) -> None:
        self.errors += 1

    def on_tool_start_common(self) -> None:
        self.tool_starts += 1
        self.starts += 1

    def on_tool_end_common(self) -> None:
        self.tool_ends += 1
        self.ends += 1

    def on_tool_error_common(self) -> None:
        self.errors += 1

    def on_agent_action_common(self) -> None:
        self.agent_actions += 1
        self.starts += 1

    def on_agent_finish_common(self) -> None:
        self.agent_ends += 1
        self.ends += 1

    def on_chat_model_start_common(self) -> None:
        self.chat_model_starts += 1
        self.starts += 1

    def on_text_common(self) -> None:
        self.text += 1

    def on_retriever_start_common(self) -> None:
        self.starts += 1
        self.retriever_starts += 1

    def on_retriever_end_common(self) -> None:
        self.ends += 1
        self.retriever_ends += 1

    def on_retriever_error_common(self) -> None:
        self.errors += 1
        self.retriever_errors += 1