Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add remove_comments option (default True): do not extract html comments #13259

Merged
merged 10 commits into from
Apr 2, 2024
Merged

Add remove_comments option (default True): do not extract html comments #13259

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ed8ffe1
Add ignore_comments option (default False): do not extract html comments
petervandenabeele Nov 12, 2023
1a024d7
Rename to "remove_comments" and make it the default behaviour
petervandenabeele Nov 13, 2023
bc6270d
fix: complete the rename from ignore_comments to remove_comments
petervandenabeele Nov 13, 2023
83223ec
merge
baskaryan Apr 2, 2024
c9685eb
fmt
baskaryan Apr 2, 2024
6dce7b1
fmt
baskaryan Apr 2, 2024
aba75d6
fmt
baskaryan Apr 2, 2024
7cacd8e
fmt
baskaryan Apr 2, 2024
815e710
fmt
baskaryan Apr 2, 2024
9c6f508
fmt
baskaryan Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 18 additions & 8 deletions libs/community/langchain_community/document_transformers/beautiful_soup_transformer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ def transform_documents(
unwanted_tags: List[str] = ["script", "style"],
tags_to_extract: List[str] = ["p", "li", "div", "a"],
remove_lines: bool = True,
*,
remove_comments: bool = False,
**kwargs: Any,
) -> Sequence[Document]:
"""
Expand All @@ -45,8 +47,8 @@ def transform_documents(
documents: A sequence of Document objects containing HTML content.
unwanted_tags: A list of tags to be removed from the HTML.
tags_to_extract: A list of tags whose content will be extracted.
remove_lines: If set to True, unnecessary lines will be
removed from the HTML content.
remove_lines: If set to True, unnecessary lines will be removed.
remove_comments: If set to True, comments will be removed.

Returns:
A sequence of Document objects with transformed content.
Expand All @@ -56,7 +58,9 @@ def transform_documents(

cleaned_content = self.remove_unwanted_tags(cleaned_content, unwanted_tags)

cleaned_content = self.extract_tags(cleaned_content, tags_to_extract)
cleaned_content = self.extract_tags(
cleaned_content, tags_to_extract, remove_comments=remove_comments
)

if remove_lines:
cleaned_content = self.remove_unnecessary_lines(cleaned_content)
Expand Down Expand Up @@ -86,7 +90,9 @@ def remove_unwanted_tags(html_content: str, unwanted_tags: List[str]) -> str:
return str(soup)

@staticmethod
def extract_tags(html_content: str, tags: List[str]) -> str:
def extract_tags(
html_content: str, tags: List[str], *, remove_comments: bool = False
) -> str:
"""
Extract specific tags from a given HTML content.

Expand All @@ -104,7 +110,9 @@ def extract_tags(html_content: str, tags: List[str]) -> str:
for element in soup.find_all():
if element.name in tags:
# Extract all navigable strings recursively from this element.
text_parts += get_navigable_strings(element)
text_parts += get_navigable_strings(
element, remove_comments=remove_comments
)

# To avoid duplicate text, remove all descendants from the soup.
element.decompose()
Expand Down Expand Up @@ -136,7 +144,7 @@ async def atransform_documents(
raise NotImplementedError


def get_navigable_strings(element: Any) -> Iterator[str]:
def get_navigable_strings(element: Any, *, remove_comments: bool = False) -> Iterator[str]:
"""Get all navigable strings from a BeautifulSoup element.

Args:
Expand All @@ -146,11 +154,13 @@ def get_navigable_strings(element: Any) -> Iterator[str]:
A generator of strings.
"""

from bs4 import NavigableString, Tag
from bs4 import Comment, NavigableString, Tag

for child in cast(Tag, element).children:
if isinstance(child, Comment) and remove_comments:
continue
if isinstance(child, Tag):
yield from get_navigable_strings(child)
yield from get_navigable_strings(child, remove_comments)
elif isinstance(child, NavigableString):
if (element.name == "a") and (href := element.get("href")):
yield f"{child.strip()} ({href})"
Expand Down
34 changes: 34 additions & 0 deletions libs/community/tests/unit_tests/document_transformers/test_beautiful_soup_transformer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,3 +230,37 @@ def test_invalid_html() -> None:
)
assert docs_transformed[0].page_content == "First heading."
assert docs_transformed[1].page_content == ""


@pytest.mark.requires("bs4")
def test_remove_comments_by_default() -> None:
bs_transformer = BeautifulSoupTransformer()
html_with_comments = (
"<html><!-- Google tag (gtag.js) --><p>First paragraph.</p</html>"
)
documents = [
Document(page_content=html_with_comments),
]

docs_transformed = bs_transformer.transform_documents(
documents, tags_to_extract=["html"]
)
assert docs_transformed[0].page_content == "First paragraph."


@pytest.mark.requires("bs4")
def test_optionally_do_not_remove_comments() -> None:
bs_transformer = BeautifulSoupTransformer()
html_with_comments = (
"<html><!-- Google tag (gtag.js) --><p>First paragraph.</p</html>"
)
documents = [
Document(page_content=html_with_comments),
]

docs_transformed = bs_transformer.transform_documents(
documents,
tags_to_extract=["html"],
remove_comments=False,
)
assert docs_transformed[0].page_content == "Google tag (gtag.js) First paragraph."