add deprecation decorator to create_chat_openai_model

werewolf/utils/openai.py

@@ -1,8 +1,10 @@
 from functools import lru_cache
 from langchain_openai import ChatOpenAI
 from ..const import DEFAULT_MODEL
+from ..utils.utils import deprecate
 
 
+@deprecate(msg='Use werewolf.chat_models.create_chat_model instead.')
 @lru_cache(maxsize=None)
 def create_chat_openai_model(
     llm: ChatOpenAI | str | None = None,

werewolf/utils/utils.py

@@ -1,4 +1,6 @@
 from contextlib import contextmanager
+from functools import partial
+from logging import Logger, getLogger
 from typing import Callable, Generator, Iterable, TypeVar
 
 InputType = TypeVar('InputType')
@@ -47,3 +49,36 @@ def consecutive_string_generator(
     while True:
         yield f'{prefix}{idx}'
         idx += step
+
+
+def deprecate(
+    func: Callable[[InputType], OutputType] | None = None,
+    *,
+    msg: str = '',
+    logger: Logger = getLogger(__name__),
+) -> (
+    Callable[[InputType], OutputType]
+    | Callable[[Callable[[InputType], OutputType]], Callable[[InputType], OutputType]]
+):
+    """Decorator to deprecate a function.
+
+    Args:
+        func (Callable[[InputType], OutputType] | None, optional): function to deprecate. Defaults to None.
+        msg (str, optional): message to show. Defaults to ''.
+        logger (Logger, optional): logger. Defaults to getLogger(__name__).
+
+    Returns:
+        Callable[[InputType], OutputType] | Callable[[Callable[[InputType], OutputType]], Callable[[InputType], OutputType]]: decorated function or decorator
+    """  # noqa
+
+    if func is None:
+        return partial(deprecate, msg=msg, logger=logger)
+
+    def wrapper(*args, **kwargs):
+        if hasattr(func, '__name__'):
+            logger.warning(' '.join([f'{func.__name__} is planned to be deprecated.', msg]))  # noqa
+        else:
+            logger.warning(' '.join([f'{func} is planned to be deprecated.', msg]))  # noqa
+        return func(*args, **kwargs)
+
+    return wrapper