github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-23 15:19:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhance deprecation decorator to modify docs with sphinx directives (#9069)

Browse Source 
Enhance deprecation decorator
This commit is contained in:
Eugene Yurtsev 2023-08-13 15:35:01 -04:00 committed by GitHub
parent 8d69dacdf3
commit 9b24f0b067
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
libs/langchain/langchain/_api/deprecation.py
View File

@ -293,6 +293,21 @@ def deprecated(
else: else:
new_doc = f"[*Deprecated*] {old_doc}" new_doc = f"[*Deprecated*] {old_doc}"
# Modify the docstring to include a deprecation notice.
notes_header = "\nNotes\n-----"
components = [
message,
f"Use {alternative} instead." if alternative else "",
addendum,
]
details = " ".join([component.strip() for component in components if component])
new_doc += (
f"[*Deprecated*] {old_doc}\n"
f"{notes_header if notes_header not in old_doc else ''}\n"
f".. deprecated:: {since}\n"
f" {details}"
)
return finalize(warning_emitting_wrapper, new_doc) return finalize(warning_emitting_wrapper, new_doc)
return deprecate return deprecate

4
libs/langchain/langchain/prompts/chat.py
View File

@ -431,7 +431,7 @@ class ChatPromptTemplate(BaseChatPromptTemplate, ABC):
return cls.from_messages([message]) return cls.from_messages([message])
@classmethod @classmethod
@deprecated("0.0.260", alternative="from_messages classmethod.", pending=True) @deprecated("0.0.260", alternative="from_messages classmethod", pending=True)
def from_role_strings( def from_role_strings(
cls, string_messages: List[Tuple[str, str]] cls, string_messages: List[Tuple[str, str]]
) -> ChatPromptTemplate: ) -> ChatPromptTemplate:
@ -451,7 +451,7 @@ class ChatPromptTemplate(BaseChatPromptTemplate, ABC):
) )
@classmethod @classmethod
@deprecated("0.0.260", alternative="from_messages classmethod.", pending=True) @deprecated("0.0.260", alternative="from_messages classmethod", pending=True)
def from_strings( def from_strings(
cls, string_messages: List[Tuple[Type[BaseMessagePromptTemplate], str]] cls, string_messages: List[Tuple[Type[BaseMessagePromptTemplate], str]]
) -> ChatPromptTemplate: ) -> ChatPromptTemplate:

34
libs/langchain/tests/unit_tests/_api/test_deprecation.py
View File

@ -115,7 +115,9 @@ def test_deprecated_function() -> None:
"and will be removed in 3.0.0" "and will be removed in 3.0.0"
) )
assert deprecated_function.__doc__ == "[*Deprecated*] original doc" doc = deprecated_function.__doc__
assert isinstance(doc, str)
assert doc.startswith("[*Deprecated*] original doc")
def test_deprecated_method() -> None: def test_deprecated_method() -> None:
@ -131,7 +133,9 @@ def test_deprecated_method() -> None:
"LangChain 2.0.0 and will be removed in 3.0.0" "LangChain 2.0.0 and will be removed in 3.0.0"
) )
assert obj.deprecated_method.__doc__ == "[*Deprecated*] original doc" doc = obj.deprecated_method.__doc__
assert isinstance(doc, str)
assert doc.startswith("[*Deprecated*] original doc")
def test_deprecated_classmethod() -> None: def test_deprecated_classmethod() -> None:
@ -145,10 +149,10 @@ def test_deprecated_classmethod() -> None:
"The function `deprecated_classmethod` was deprecated in " "The function `deprecated_classmethod` was deprecated in "
"LangChain 2.0.0 and will be removed in 3.0.0" "LangChain 2.0.0 and will be removed in 3.0.0"
) )
assert (
ClassWithDeprecatedMethods.deprecated_classmethod.__doc__ doc = ClassWithDeprecatedMethods.deprecated_classmethod.__doc__
== "[*Deprecated*] original doc" assert isinstance(doc, str)
) assert doc.startswith("[*Deprecated*] original doc")
def test_deprecated_staticmethod() -> None: def test_deprecated_staticmethod() -> None:
@ -166,10 +170,9 @@ def test_deprecated_staticmethod() -> None:
"The function `deprecated_staticmethod` was deprecated in " "The function `deprecated_staticmethod` was deprecated in "
"LangChain 2.0.0 and will be removed in 3.0.0" "LangChain 2.0.0 and will be removed in 3.0.0"
) )
assert ( doc = ClassWithDeprecatedMethods.deprecated_staticmethod.__doc__
ClassWithDeprecatedMethods.deprecated_staticmethod.__doc__ assert isinstance(doc, str)
== "[*Deprecated*] original doc" assert doc.startswith("[*Deprecated*] original doc")
)
def test_deprecated_property() -> None: def test_deprecated_property() -> None:
@ -187,10 +190,9 @@ def test_deprecated_property() -> None:
"The function `deprecated_property` was deprecated in " "The function `deprecated_property` was deprecated in "
"LangChain 2.0.0 and will be removed in 3.0.0" "LangChain 2.0.0 and will be removed in 3.0.0"
) )
assert ( doc = ClassWithDeprecatedMethods.deprecated_property.__doc__
ClassWithDeprecatedMethods.deprecated_property.__doc__ assert isinstance(doc, str)
== "[*Deprecated*] original doc" assert doc.startswith("[*Deprecated*] original doc")
)
def test_whole_class_deprecation() -> None: def test_whole_class_deprecation() -> None:
@ -249,4 +251,6 @@ def test_deprecated_method_pydantic() -> None:
"LangChain 2.0.0 and will be removed in 3.0.0" "LangChain 2.0.0 and will be removed in 3.0.0"
) )
assert obj.deprecated_method.__doc__ == "[*Deprecated*] original doc" doc = obj.deprecated_method.__doc__
assert isinstance(doc, str)
assert doc.startswith("[*Deprecated*] original doc")