mirror of
https://github.com/Mintplex-Labs/langchain-python.git
synced 2026-07-19 13:26:32 -04:00
Harrison Chase
b7ae9f715d
I have added a reddit document loader which fetches the text from the Posts of Subreddits or Reddit users, using the `praw` Python package. I have also added an example notebook reddit.ipynb in order to guide users to use this dataloader. This code was made in format similar to twiiter document loader. I have run code formating, linting and also checked the code myself for different scenarios. This is my first contribution to an open source project and I am really excited about this. If you want to suggest some improvements in my code, I will be happy to do it. :) Co-authored-by: Taaha Bajwa <taaha.s.bajwa@gmail.com>
129 lines
4.0 KiB
Python
129 lines
4.0 KiB
Python
"""Reddit document loader."""
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Iterable, List, Optional, Sequence
|
|
|
|
from langchain.docstore.document import Document
|
|
from langchain.document_loaders.base import BaseLoader
|
|
|
|
if TYPE_CHECKING:
|
|
import praw
|
|
|
|
|
|
def _dependable_praw_import() -> praw:
|
|
try:
|
|
import praw
|
|
except ImportError:
|
|
raise ValueError(
|
|
"praw package not found, please install it with `pip install praw`"
|
|
)
|
|
return praw
|
|
|
|
|
|
class RedditPostsLoader(BaseLoader):
|
|
"""Reddit posts loader.
|
|
Read posts on a subreddit.
|
|
First you need to go to
|
|
https://www.reddit.com/prefs/apps/
|
|
and create your application
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
client_id: str,
|
|
client_secret: str,
|
|
user_agent: str,
|
|
search_queries: Sequence[str],
|
|
mode: str,
|
|
categories: Sequence[str] = ["new"],
|
|
number_posts: Optional[int] = 10,
|
|
):
|
|
self.client_id = client_id
|
|
self.client_secret = client_secret
|
|
self.user_agent = user_agent
|
|
self.search_queries = search_queries
|
|
self.mode = mode
|
|
self.categories = categories
|
|
self.number_posts = number_posts
|
|
|
|
def load(self) -> List[Document]:
|
|
"""Load reddits."""
|
|
praw = _dependable_praw_import()
|
|
|
|
reddit = praw.Reddit(
|
|
client_id=self.client_id,
|
|
client_secret=self.client_secret,
|
|
user_agent=self.user_agent,
|
|
)
|
|
|
|
results: List[Document] = []
|
|
|
|
if self.mode == "subreddit":
|
|
for search_query in self.search_queries:
|
|
for category in self.categories:
|
|
docs = self._subreddit_posts_loader(
|
|
search_query=search_query, category=category, reddit=reddit
|
|
)
|
|
results.extend(docs)
|
|
|
|
elif self.mode == "username":
|
|
for search_query in self.search_queries:
|
|
for category in self.categories:
|
|
docs = self._user_posts_loader(
|
|
search_query=search_query, category=category, reddit=reddit
|
|
)
|
|
results.extend(docs)
|
|
|
|
else:
|
|
raise ValueError(
|
|
"mode not correct, please enter 'username' or 'subreddit' as mode"
|
|
)
|
|
|
|
return results
|
|
|
|
def _subreddit_posts_loader(
|
|
self, search_query: str, category: str, reddit: praw.reddit.Reddit
|
|
) -> Iterable[Document]:
|
|
subreddit = reddit.subreddit(search_query)
|
|
method = getattr(subreddit, category)
|
|
cat_posts = method(limit=self.number_posts)
|
|
|
|
"""Format reddit posts into a string."""
|
|
for post in cat_posts:
|
|
metadata = {
|
|
"post_subreddit": post.subreddit_name_prefixed,
|
|
"post_category": category,
|
|
"post_title": post.title,
|
|
"post_score": post.score,
|
|
"post_id": post.id,
|
|
"post_url": post.url,
|
|
"post_author": post.author,
|
|
}
|
|
yield Document(
|
|
page_content=post.selftext,
|
|
metadata=metadata,
|
|
)
|
|
|
|
def _user_posts_loader(
|
|
self, search_query: str, category: str, reddit: praw.reddit.Reddit
|
|
) -> Iterable[Document]:
|
|
user = reddit.redditor(search_query)
|
|
method = getattr(user.submissions, category)
|
|
cat_posts = method(limit=self.number_posts)
|
|
|
|
"""Format reddit posts into a string."""
|
|
for post in cat_posts:
|
|
metadata = {
|
|
"post_subreddit": post.subreddit_name_prefixed,
|
|
"post_category": category,
|
|
"post_title": post.title,
|
|
"post_score": post.score,
|
|
"post_id": post.id,
|
|
"post_url": post.url,
|
|
"post_author": post.author,
|
|
}
|
|
yield Document(
|
|
page_content=post.selftext,
|
|
metadata=metadata,
|
|
)
|