_write() — langchain Function Reference

Architecture documentation for the _write() function in file.py from the langchain codebase.

Function python CoreAbstractions Serialization called by 6

Entity Profile

CoreAbstractions→ Serialization→ _write() — langchain Function Reference

Dependency Diagram

graph TD
  9396c2e0_20cf_48a3_9826_6145bfd4b528["_write()"]
  dad857c9_1c74_a18b_02fe_3974dfe83253["FileCallbackHandler"]
  9396c2e0_20cf_48a3_9826_6145bfd4b528 -->|defined in| dad857c9_1c74_a18b_02fe_3974dfe83253
  e3332ebf_6acb_3d86_6259_be437b15d9df["on_chain_start()"]
  e3332ebf_6acb_3d86_6259_be437b15d9df -->|calls| 9396c2e0_20cf_48a3_9826_6145bfd4b528
  7b09254e_17ad_e4e3_6913_eb78a10be4e2["on_chain_end()"]
  7b09254e_17ad_e4e3_6913_eb78a10be4e2 -->|calls| 9396c2e0_20cf_48a3_9826_6145bfd4b528
  7288d355_1fc0_a8cd_aeed_000ba760098d["on_agent_action()"]
  7288d355_1fc0_a8cd_aeed_000ba760098d -->|calls| 9396c2e0_20cf_48a3_9826_6145bfd4b528
  bed4a435_8240_4971_5a53_a82aa90133cf["on_tool_end()"]
  bed4a435_8240_4971_5a53_a82aa90133cf -->|calls| 9396c2e0_20cf_48a3_9826_6145bfd4b528
  a2246d77_4738_fd32_4c36_c483d03ac694["on_text()"]
  a2246d77_4738_fd32_4c36_c483d03ac694 -->|calls| 9396c2e0_20cf_48a3_9826_6145bfd4b528
  a6678976_6856_3b2a_d50f_ad36b127e4ee["on_agent_finish()"]
  a6678976_6856_3b2a_d50f_ad36b127e4ee -->|calls| 9396c2e0_20cf_48a3_9826_6145bfd4b528
  style 9396c2e0_20cf_48a3_9826_6145bfd4b528 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/callbacks/file.py lines 126–161

    def _write(
        self,
        text: str,
        color: str | None = None,
        end: str = "",
    ) -> None:
        """Write text to the file with deprecation warning if needed.

        Args:
            text: The text to write to the file.
            color: Optional color for the text. Defaults to `self.color`.
            end: String appended after the text.
            file: Optional file to write to. Defaults to `self.file`.

        Raises:
            RuntimeError: If the file is closed or not available.

        """
        global _GLOBAL_DEPRECATION_WARNED  # noqa: PLW0603
        if not self._file_opened_in_context and not _GLOBAL_DEPRECATION_WARNED:
            warn_deprecated(
                since="0.3.67",
                pending=True,
                message=(
                    "Using FileCallbackHandler without a context manager is "
                    "deprecated. Use 'with FileCallbackHandler(...) as "
                    "handler:' instead."
                ),
            )
            _GLOBAL_DEPRECATION_WARNED = True

        if not hasattr(self, "file") or self.file is None or self.file.closed:
            msg = "File is not open. Use FileCallbackHandler as a context manager."
            raise RuntimeError(msg)

        print_text(text, file=self.file, color=color, end=end)