Add explicit get_<X>() functions.

libs/langchain/langchain/__init__.py

@@ -29,17 +29,24 @@ def _is_interactive_env() -> bool:
     return hasattr(sys, "ps2")
 
 
-def _warn_on_import(name: str) -> None:
+def _warn_on_import(name: str, replacement: str = None) -> None:
     """Warn on import of deprecated module."""
     if _is_interactive_env():
         # No warnings for interactive environments.
         # This is done to avoid polluting the output of interactive environments
         # where users rely on auto-complete and may trigger this warning
         # even if they are not using any deprecated modules
         return
-    warnings.warn(
-        f"Importing {name} from langchain root module is no longer supported."
-    )
+
+    if replacement:
+        warnings.warn(
+            f"Importing {name} from langchain root module is no longer supported. "
+            f"Please use {replacement} instead."
+        )
+    else:
+        warnings.warn(
+            f"Importing {name} from langchain root module is no longer supported."
+        )
 
 
 # Surfaces Deprecation and Pending Deprecation warnings from langchain.
@@ -327,19 +334,37 @@ def __getattr__(name: str) -> Any:
     elif name == "verbose":
         from langchain.utils.globals import verbose
 
-        _warn_on_import(name)
+        _warn_on_import(
+            name,
+            replacement=(
+                "langchain.utils.globals.set_verbose() / "
+                "langchain.utils.globals.get_verbose()",
+            ),
+        )
 
         return verbose
     elif name == "debug":
         from langchain.utils.globals import debug
 
-        _warn_on_import(name)
+        _warn_on_import(
+            name,
+            replacement=(
+                "langchain.utils.globals.set_debug() / "
+                "langchain.utils.globals.get_debug()",
+            ),
+        )
 
         return debug
     elif name == "llm_cache":
         from langchain.utils.globals import llm_cache
 
-        _warn_on_import(name)
+        _warn_on_import(
+            name,
+            replacement=(
+                "langchain.utils.globals.set_llm_cache() / "
+                "langchain.utils.globals.get_llm_cache()",
+            ),
+        )
 
         return llm_cache
     else:

libs/langchain/langchain/utils/globals.py

@@ -5,9 +5,13 @@
     from langchain.schema import BaseCache
 
 
-verbose: bool = False
-debug: bool = False
-llm_cache: Optional["BaseCache"] = None
+# DO NOT USE THESE VALUES DIRECTLY!
+# Use them only via `get_<X>()` and `set_<X>()` below,
+# or else your code may behave unexpectedly with other uses of these global settings:
+# https://github.com/langchain-ai/langchain/pull/11311#issuecomment-1743780004
+_verbose: bool = False
+_debug: bool = False
+_llm_cache: Optional["BaseCache"] = None
 
 
 def set_verbose(value: bool) -> None:
@@ -22,8 +26,29 @@ def set_verbose(value: bool) -> None:
     # have migrated to using `set_verbose()` here.
     langchain.verbose = value
 
-    global verbose
-    verbose = value
+    global _verbose
+    _verbose = value
+
+
+def get_verbose() -> bool:
+    """Get the value of the `verbose` global setting."""
+    import langchain
+
+    # N.B.: This is a workaround for an unfortunate quirk of Python's
+    #       module-level `__getattr__()` implementation:
+    # https://github.com/langchain-ai/langchain/pull/11311#issuecomment-1743780004
+    #
+    # Remove it once `langchain.verbose` is no longer supported, and once all users
+    # have migrated to using `set_verbose()` here.
+    #
+    # In the meantime, the `verbose` setting is considered True if either the old
+    # or the new value are True. This accommodates users who haven't migrated
+    # to using `set_verbose()` yet. Those users are getting deprecation warnings
+    # directing them to use `set_verbose()` when they import `langhchain.verbose`.
+    old_verbose = langchain.verbose
+
+    global _verbose
+    return _verbose or old_verbose
 
 
 def set_debug(value: bool) -> None:
@@ -38,8 +63,29 @@ def set_debug(value: bool) -> None:
     # have migrated to using `set_debug()` here.
     langchain.debug = value
 
-    global debug
-    debug = value
+    global _debug
+    _debug = value
+
+
+def get_debug() -> bool:
+    """Get the value of the `debug` global setting."""
+    import langchain
+
+    # N.B.: This is a workaround for an unfortunate quirk of Python's
+    #       module-level `__getattr__()` implementation:
+    # https://github.com/langchain-ai/langchain/pull/11311#issuecomment-1743780004
+    #
+    # Remove it once `langchain.debug` is no longer supported, and once all users
+    # have migrated to using `set_debug()` here.
+    #
+    # In the meantime, the `debug` setting is considered True if either the old
+    # or the new value are True. This accommodates users who haven't migrated
+    # to using `set_debug()` yet. Those users are getting deprecation warnings
+    # directing them to use `set_debug()` when they import `langhchain.debug`.
+    old_debug = langchain.debug
+
+    global _debug
+    return _debug or old_debug
 
 
 def set_llm_cache(value: "BaseCache") -> None:
@@ -54,5 +100,27 @@ def set_llm_cache(value: "BaseCache") -> None:
     # have migrated to using `set_llm_cache()` here.
     langchain.llm_cache = value
 
-    global llm_cache
-    llm_cache = value
+    global _llm_cache
+    _llm_cache = value
+
+
+def get_llm_cache() -> bool:
+    """Get the value of the `llm_cache` global setting."""
+    import langchain
+
+    # N.B.: This is a workaround for an unfortunate quirk of Python's
+    #       module-level `__getattr__()` implementation:
+    # https://github.com/langchain-ai/langchain/pull/11311#issuecomment-1743780004
+    #
+    # Remove it once `langchain.llm_cache` is no longer supported, and once all users
+    # have migrated to using `set_llm_cache()` here.
+    #
+    # In the meantime, the `llm_cache` setting returns whichever of its two backing
+    # sources is truthy (not `None` and non-empty), or the old value if both are falsy.
+    # This accommodates users who haven't migrated to using `set_llm_cache()` yet.
+    # Those users are getting deprecation warnings
+    # directing them to use `set_llm_cache()` when they import `langhchain.llm_cache`.
+    old_llm_cache = langchain.llm_cache
+
+    global _llm_cache
+    return _llm_cache or old_llm_cache

libs/langchain/tests/unit_tests/test_globals.py

@@ -1,4 +1,4 @@
-from langchain.utils.globals import set_debug, set_verbose
+from langchain.utils.globals import get_debug, get_verbose, set_debug, set_verbose
 
 
 def test_debug_is_settable_directly() -> None:
@@ -22,6 +22,9 @@ def test_debug_is_settable_directly() -> None:
         # If we access `debug` via a function used elsewhere in langchain,
         # it also sees the same new value.
         assert new_value == new_fn_reading
+
+        # If we access `debug` via `get_debug()` we also get the same value.
+        assert new_value == get_debug()
     finally:
         # Make sure we don't alter global state, even if the test fails.
         # Always reset `debug` to the value it had before.
@@ -49,6 +52,9 @@ def test_debug_is_settable_via_setter() -> None:
         # If we access `debug` via a function used elsewhere in langchain,
         # it also sees the same new value.
         assert new_value == new_fn_reading
+
+        # If we access `debug` via `get_debug()` we also get the same value.
+        assert new_value == get_debug()
     finally:
         # Make sure we don't alter global state, even if the test fails.
         # Always reset `debug` to the value it had before.
@@ -76,6 +82,9 @@ def test_verbose_is_settable_directly() -> None:
         # If we access `verbose` via a function used elsewhere in langchain,
         # it also sees the same new value.
         assert new_value == new_fn_reading
+
+        # If we access `verbose` via `get_verbose()` we also get the same value.
+        assert new_value == get_verbose()
     finally:
         # Make sure we don't alter global state, even if the test fails.
         # Always reset `verbose` to the value it had before.
@@ -103,6 +112,9 @@ def test_verbose_is_settable_via_setter() -> None:
         # If we access `verbose` via a function used elsewhere in langchain,
         # it also sees the same new value.
         assert new_value == new_fn_reading
+
+        # If we access `verbose` via `get_verbose()` we also get the same value.
+        assert new_value == get_verbose()
     finally:
         # Make sure we don't alter global state, even if the test fails.
         # Always reset `verbose` to the value it had before.