substack.py 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. import hashlib
  2. import logging
  3. import time
  4. from xml.etree import ElementTree
  5. import requests
  6. from embedchain.helpers.json_serializable import register_deserializable
  7. from embedchain.loaders.base_loader import BaseLoader
  8. from embedchain.utils.misc import is_readable
  9. logger = logging.getLogger(__name__)
  10. @register_deserializable
  11. class SubstackLoader(BaseLoader):
  12. """
  13. This loader is used to load data from Substack URLs.
  14. """
  15. def load_data(self, url: str):
  16. try:
  17. from bs4 import BeautifulSoup
  18. from bs4.builder import ParserRejectedMarkup
  19. except ImportError:
  20. raise ImportError(
  21. 'Substack requires extra dependencies. Install with `pip install --upgrade "embedchain[dataloaders]"`'
  22. ) from None
  23. if not url.endswith("sitemap.xml"):
  24. url = url + "/sitemap.xml"
  25. output = []
  26. response = requests.get(url)
  27. try:
  28. response.raise_for_status()
  29. except requests.exceptions.HTTPError as e:
  30. raise ValueError(
  31. f"""
  32. Failed to load {url}: {e}. Please use the root substack URL. For example, https://example.substack.com
  33. """
  34. )
  35. try:
  36. ElementTree.fromstring(response.content)
  37. except ElementTree.ParseError:
  38. raise ValueError(
  39. f"""
  40. Failed to parse {url}. Please use the root substack URL. For example, https://example.substack.com
  41. """
  42. )
  43. soup = BeautifulSoup(response.text, "xml")
  44. links = [link.text for link in soup.find_all("loc") if link.parent.name == "url" and "/p/" in link.text]
  45. if len(links) == 0:
  46. links = [link.text for link in soup.find_all("loc") if "/p/" in link.text]
  47. doc_id = hashlib.sha256((" ".join(links) + url).encode()).hexdigest()
  48. def serialize_response(soup: BeautifulSoup):
  49. data = {}
  50. h1_els = soup.find_all("h1")
  51. if h1_els is not None and len(h1_els) > 0:
  52. data["title"] = h1_els[1].text
  53. description_el = soup.find("meta", {"name": "description"})
  54. if description_el is not None:
  55. data["description"] = description_el["content"]
  56. content_el = soup.find("div", {"class": "available-content"})
  57. if content_el is not None:
  58. data["content"] = content_el.text
  59. like_btn = soup.find("div", {"class": "like-button-container"})
  60. if like_btn is not None:
  61. no_of_likes_div = like_btn.find("div", {"class": "label"})
  62. if no_of_likes_div is not None:
  63. data["no_of_likes"] = no_of_likes_div.text
  64. return data
  65. def load_link(link: str):
  66. try:
  67. substack_data = requests.get(link)
  68. substack_data.raise_for_status()
  69. soup = BeautifulSoup(substack_data.text, "html.parser")
  70. data = serialize_response(soup)
  71. data = str(data)
  72. if is_readable(data):
  73. return data
  74. else:
  75. logger.warning(f"Page is not readable (too many invalid characters): {link}")
  76. except ParserRejectedMarkup as e:
  77. logger.error(f"Failed to parse {link}: {e}")
  78. return None
  79. for link in links:
  80. data = load_link(link)
  81. if data:
  82. output.append({"content": data, "meta_data": {"url": link}})
  83. # TODO: allow users to configure this
  84. time.sleep(1.0) # added to avoid rate limiting
  85. return {"doc_id": doc_id, "data": output}