chore: Restore add_auth_token(s) as deprecated for backward compatibility (#236)

* fix(toolbox-langchain)!: Base toolbox-langchain over toolbox-core

* fix: add toolbox-core as package dependency

* fix: Base sync client

* fix: Fix running background asyncio in current loop issue

* fix: Base toolbox sync & async tools to toolbox core counterparts

* fix: Fix getting pydantic model from ToolboxSyncTool

* fix: Fix issue causing async core tools for creating sync tools

* fix: Fix reading name from correct param

* fix: Fix issue of unknown parameter due to pydantic initialization

* fix: Fix nit error + add comment

* fix: Fix sync tool name assertion

* chore: Temporarily remove unittests

* chore: Remove unused strict flag + fix default values + fix docstring

* fix: Update package to be from git repo

* fix: Fix toolbox-core package local path

* fix: Fix local package path

* fix: Update git path

* fix: Fix tests

* fix: Fix using correct object for fetching loop

* fix: Return invoke result

* fix: Integration test errors

* chore: Delint

* fix: Fix integration test

* fix: Fix integration tests

* chore: Add unit tests previously deleted

* chore: Delint

* fix: Fix using correct protected member variables

* chore: Delint

* chore: Fix types

* fix: Ensure bg loop/thread not null

* fix: Check bg loop/thread value

* fix: Revert warnings to prefer auth_tokens over auth_headers

* chore: Update unittests

* docs: Improve docstrings

* chore: Add TODO note

* chore: Improve TODO note

* fix: Fix integration test

* chore: Delint

* chore: Rename internal member variable names to be more concise

* chore: Delint

* chore: Add toolbox actual package version in toml and local path in requirements.txt

* fix: Fix editable toolbox-core package path in requirements.txt

* fix: Fix lowest supported version until released

* fix: Fix issue causing relative path in requirements.txt to cause issues

* docs: Fix issue README

* fix: Use correct core client interfaces in langchain client

* fix: Use correct core tool interfaces in langchain tool

* fix: Use correct interface from core tool

* fix: Use correct interfaces of toolbox-core

* chore: Update async client unit tests

* chore: Fix client unit tests

* chore: Delint

* chore: Fix tools unit tests

* chore: Restore add_auth_token(s) as deprecated for backward compatibility

This PR addresses a breaking change introduced by the removal of `add_auth_token(s)` methods in #182. To ensure backward compatibility and facilitate a smoother upgrade path, these methods are now reintroduced but explicitly marked as **deprecated**. Users are encouraged to migrate to the new `add_auth_token_getter(s)` methods instead.

> [!NOTE]
> The `strict` flag in the deprecated methods are not used anymore since the functionality of the `strict` flag has been changed (see #205 for more details).

Author: anubhav756

packages/toolbox-langchain/src/toolbox_langchain/async_tools.py

@@ -14,6 +14,7 @@
 
 from typing import Any, Callable, Union
 
+from deprecated import deprecated
 from langchain_core.tools import BaseTool
 from toolbox_core.tool import ToolboxTool as ToolboxCoreTool
 from toolbox_core.utils import params_to_pydantic_model
@@ -108,6 +109,18 @@ def add_auth_token_getter(
         """
         return self.add_auth_token_getters({auth_source: get_id_token})
 
+    @deprecated("Please use `add_auth_token_getters` instead.")
+    def add_auth_tokens(
+        self, auth_tokens: dict[str, Callable[[], str]], strict: bool = True
+    ) -> "AsyncToolboxTool":
+        return self.add_auth_token_getters(auth_tokens)
+
+    @deprecated("Please use `add_auth_token_getter` instead.")
+    def add_auth_token(
+        self, auth_source: str, get_id_token: Callable[[], str], strict: bool = True
+    ) -> "AsyncToolboxTool":
+        return self.add_auth_token_getter(auth_source, get_id_token)
+
     def bind_params(
         self,
         bound_params: dict[str, Union[Any, Callable[[], Any]]],

packages/toolbox-langchain/src/toolbox_langchain/tools.py

@@ -15,6 +15,7 @@
 from asyncio import to_thread
 from typing import Any, Callable, Union
 
+from deprecated import deprecated
 from langchain_core.tools import BaseTool
 from toolbox_core.sync_tool import ToolboxSyncTool as ToolboxCoreSyncTool
 from toolbox_core.utils import params_to_pydantic_model
@@ -94,6 +95,18 @@ def add_auth_token_getter(
         """
         return self.add_auth_token_getters({auth_source: get_id_token})
 
+    @deprecated("Please use `add_auth_token_getters` instead.")
+    def add_auth_tokens(
+        self, auth_tokens: dict[str, Callable[[], str]], strict: bool = True
+    ) -> "ToolboxTool":
+        return self.add_auth_token_getters(auth_tokens)
+
+    @deprecated("Please use `add_auth_token_getter` instead.")
+    def add_auth_token(
+        self, auth_source: str, get_id_token: Callable[[], str], strict: bool = True
+    ) -> "ToolboxTool":
+        return self.add_auth_token_getter(auth_source, get_id_token)
+
     def bind_params(
         self,
         bound_params: dict[str, Union[Any, Callable[[], Any]]],