From a69ef52cf61bf3fd13ce5af7d00aded175ae2446 Mon Sep 17 00:00:00 2001
From: drbh <david.richard.holtz@gmail.com>
Date: Wed, 15 May 2024 09:40:07 -0400
Subject: [PATCH] feat: add deprecation warning to clients (#1855)

This PR adds a deprecation warning to the clients and points users to
the https://github.com/huggingface/huggingface_hub
---
 clients/python/text_generation/__init__.py | 5 +++++
 clients/python/text_generation/client.py   | 7 +++++++
 2 files changed, 12 insertions(+)

diff --git a/clients/python/text_generation/__init__.py b/clients/python/text_generation/__init__.py
index 5ab10fdb..a8e67071 100644
--- a/clients/python/text_generation/__init__.py
+++ b/clients/python/text_generation/__init__.py
@@ -14,5 +14,10 @@
 
 __version__ = "0.6.0"
 
+DEPRECATION_WARNING = (
+    "`text_generation` clients are deprecated and will be removed in the near future. "
+    "Please use the `InferenceClient` from the `huggingface_hub` package instead."
+)
+
 from text_generation.client import Client, AsyncClient
 from text_generation.inference_api import InferenceAPIClient, InferenceAPIAsyncClient
diff --git a/clients/python/text_generation/client.py b/clients/python/text_generation/client.py
index 0e86901d..98c018d5 100644
--- a/clients/python/text_generation/client.py
+++ b/clients/python/text_generation/client.py
@@ -1,10 +1,12 @@
 import json
 import requests
+import warnings
 
 from aiohttp import ClientSession, ClientTimeout
 from pydantic import ValidationError
 from typing import Dict, Optional, List, AsyncIterator, Iterator, Union
 
+from text_generation import DEPRECATION_WARNING
 from text_generation.types import (
     StreamResponse,
     Response,
@@ -19,6 +21,9 @@ from text_generation.types import (
 )
 from text_generation.errors import parse_error
 
+# emit deprecation warnings
+warnings.simplefilter("always", DeprecationWarning)
+
 
 class Client:
     """Client to make calls to a text-generation-inference instance
@@ -59,6 +64,7 @@ class Client:
             timeout (`int`):
                 Timeout in seconds
         """
+        warnings.warn(DEPRECATION_WARNING, DeprecationWarning)
         self.base_url = base_url
         self.headers = headers
         self.cookies = cookies
@@ -449,6 +455,7 @@ class AsyncClient:
             timeout (`int`):
                 Timeout in seconds
         """
+        warnings.warn(DEPRECATION_WARNING, DeprecationWarning)
         self.base_url = base_url
         self.headers = headers
         self.cookies = cookies