mirror of
https://github.com/hwchase17/langchain.git
synced 2025-09-24 03:52:10 +00:00
chore(core): fix some docstrings (from DOC preview rule) (#32833)
* Add `Raises` sections * Add `Returns` sections * Add `Yields` sections --------- Co-authored-by: Mason Daugherty <mason@langchain.dev>
This commit is contained in:
committed by
GitHub
parent
4024d47412
commit
f4e83e0ad8
@@ -145,7 +145,14 @@ class Blob(BaseMedia):
|
||||
return values
|
||||
|
||||
def as_string(self) -> str:
|
||||
"""Read data as a string."""
|
||||
"""Read data as a string.
|
||||
|
||||
Raises:
|
||||
ValueError: If the blob cannot be represented as a string.
|
||||
|
||||
Returns:
|
||||
The data as a string.
|
||||
"""
|
||||
if self.data is None and self.path:
|
||||
return Path(self.path).read_text(encoding=self.encoding)
|
||||
if isinstance(self.data, bytes):
|
||||
@@ -156,7 +163,14 @@ class Blob(BaseMedia):
|
||||
raise ValueError(msg)
|
||||
|
||||
def as_bytes(self) -> bytes:
|
||||
"""Read data as bytes."""
|
||||
"""Read data as bytes.
|
||||
|
||||
Raises:
|
||||
ValueError: If the blob cannot be represented as bytes.
|
||||
|
||||
Returns:
|
||||
The data as bytes.
|
||||
"""
|
||||
if isinstance(self.data, bytes):
|
||||
return self.data
|
||||
if isinstance(self.data, str):
|
||||
@@ -168,7 +182,14 @@ class Blob(BaseMedia):
|
||||
|
||||
@contextlib.contextmanager
|
||||
def as_bytes_io(self) -> Generator[Union[BytesIO, BufferedReader], None, None]:
|
||||
"""Read data as a byte stream."""
|
||||
"""Read data as a byte stream.
|
||||
|
||||
Raises:
|
||||
NotImplementedError: If the blob cannot be represented as a byte stream.
|
||||
|
||||
Yields:
|
||||
The data as a byte stream.
|
||||
"""
|
||||
if isinstance(self.data, bytes):
|
||||
yield BytesIO(self.data)
|
||||
elif self.data is None and self.path:
|
||||
@@ -246,7 +267,7 @@ class Blob(BaseMedia):
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""Define the blob representation."""
|
||||
"""Return the blob representation."""
|
||||
str_repr = f"Blob {id(self)}"
|
||||
if self.source:
|
||||
str_repr += f" {self.source}"
|
||||
@@ -280,19 +301,24 @@ class Document(BaseMedia):
|
||||
|
||||
@classmethod
|
||||
def is_lc_serializable(cls) -> bool:
|
||||
"""Return whether this class is serializable."""
|
||||
"""Return True as this class is serializable."""
|
||||
return True
|
||||
|
||||
@classmethod
|
||||
def get_lc_namespace(cls) -> list[str]:
|
||||
"""Get the namespace of the langchain object.
|
||||
|
||||
Default namespace is ["langchain", "schema", "document"].
|
||||
Returns:
|
||||
["langchain", "schema", "document"]
|
||||
"""
|
||||
return ["langchain", "schema", "document"]
|
||||
|
||||
def __str__(self) -> str:
|
||||
"""Override __str__ to restrict it to page_content and metadata."""
|
||||
"""Override __str__ to restrict it to page_content and metadata.
|
||||
|
||||
Returns:
|
||||
A string representation of the Document.
|
||||
"""
|
||||
# The format matches pydantic format for __str__.
|
||||
#
|
||||
# The purpose of this change is to make sure that user code that
|
||||
|
Reference in New Issue
Block a user