File size: 15,496 Bytes
a6e70b1 d4465fe a6e70b1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | """Reddit scraper β uses PRAW with OAuth authentication.
Uses Reddit's official API via PRAW library:
1. Search a subreddit for posts matching complaint keywords (`self:yes` + `t=month`)
2. Filter posts by complaint keywords in title
3. Fetch top-level comments from the matching posts
4. Return structured comment data with verbatim text + direct URLs
Requires: REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET in environment
Get credentials at: https://www.reddit.com/prefs/apps
"""
from __future__ import annotations
import logging
import re
import time
from dataclasses import dataclass
from typing import Iterator
import diskcache
import requests
import urllib3
from src.config import settings
from src.tools.types import ScrapedComment
# Optional import - praw not required if Reddit scraping is disabled
try:
import praw
PRAW_AVAILABLE = True
except ImportError:
PRAW_AVAILABLE = False
praw = None # type: ignore
logger = logging.getLogger(__name__)
# Suppress SSL warnings for Reddit (known certificate issues)
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
# Disk-backed cache for Reddit JSON responses
_CACHE = diskcache.Cache(settings.cache_dir)
_TTL_S: int = settings.cache_ttl_hours * 3600
_MISSING = object()
# ------------------------------------------------------------------
# Search parameters (locked by design)
# ------------------------------------------------------------------
_SEARCH_QUERIES: list[str] = [
"frustrated with self:yes",
"I wish there was self:yes",
"biggest problem self:yes",
]
_TITLE_KEYWORDS: list[str] = [
"frustrated", "hate", "annoying", "problem", "issue",
"struggle", "pain", "wish", "difficult", "terrible",
"awful", "bad", "sucks", "complaint", "worst",
]
_MAX_POSTS_PER_SUBREDDIT: int = 5
_MAX_COMMENTS_PER_POST: int = 10
_MAX_COMMENTS_PER_SUBREDDIT: int = 50
_REQUEST_DELAY_S: float = 0.5
_SEARCH_LIMIT: int = 25
_TIME_WINDOW: str = "month"
# ------------------------------------------------------------------
# Community map β ordered most-specific β most-general
# ------------------------------------------------------------------
COMMUNITY_MAP: dict[str, list[str]] = {
"developer_tools": ["devops", "sysadmin", "webdev", "programming", "SaaS", "startups"],
"healthcare": ["physicaltherapy", "healthIT", "nursing", "medicine", "dentistry"],
"finance_fintech": ["financialindependence", "personalfinance", "smallbusiness", "Entrepreneur"],
"education": ["Homeschooling", "highereducation", "edtech", "Teachers", "studying"],
"food_service": ["restaurantowners", "KitchenConfidential", "smallbusiness", "Entrepreneur"],
"e_commerce": ["shopify", "ecommerce", "marketing", "smallbusiness", "Entrepreneur"],
"marketing_social": ["SEO", "marketing", "socialmedia", "advertising", "startups"],
"real_estate": ["Landlord", "realestateinvesting", "RealEstate", "smallbusiness"],
"transportation": ["trucking", "UberDrivers", "cars", "dashcam", "smallbusiness"],
"ai_ml": ["LocalLLaMA", "artificial", "MachineLearning", "SaaS", "startups"],
"productivity": ["Notion", "ObsidianMD", "productivity", "Entrepreneur", "smallbusiness"],
"fashion_retail": ["fashion", "malefashionadvice", "femalefashionadvice", "smallbusiness"],
"sports_fitness": ["CrossFit", "yoga", "running", "loseit", "fitness"],
"agriculture": ["farming", "homestead", "Agriculture", "smallbusiness"],
"content_creator": ["SmallYTChannel", "NewTubers", "podcasting", "VideoEditing", "YouTubers", "ContentCreation"],
"general_other": ["Entrepreneur", "smallbusiness", "startups", "SaaS"],
}
# Build a keyword β category reverse index for free-text matching
_KEYWORD_TO_CATEGORY: dict[str, str] = {}
for _cat, _subs in COMMUNITY_MAP.items():
_KEYWORD_TO_CATEGORY[_cat.lower()] = _cat
for _kw in _cat.lower().split("_"):
_KEYWORD_TO_CATEGORY[_kw] = _cat
REDIRECT_MAP: dict[str, str] = {
"sysadmin": "sysadmin",
"healthit": "healthIT",
"saas": "SaaS",
"seo": "SEO",
"crossfit": "CrossFit",
}
def resolve_domain(domain: str) -> tuple[str, list[str]]:
"""Map a free-text domain to a category key and its ordered subreddit list."""
domain_lower = domain.lower().strip()
# Exact match
if domain_lower in COMMUNITY_MAP:
return domain_lower, COMMUNITY_MAP[domain_lower]
# Keyword/token matching
tokens = re.findall(r"[a-z]+", domain_lower)
scores: dict[str, int] = {}
for tok in tokens:
cat = _KEYWORD_TO_CATEGORY.get(tok)
if cat:
scores[cat] = scores.get(cat, 0) + 1
if scores:
best = max(scores, key=lambda k: (scores[k], k))
return best, COMMUNITY_MAP[best]
return "general_other", COMMUNITY_MAP["general_other"]
# ------------------------------------------------------------------
# PRAW Reddit client
# ------------------------------------------------------------------
def _get_reddit_client() -> praw.Reddit | None:
"""Get a PRAW Reddit client with OAuth authentication."""
if not settings.reddit_client_id or not settings.reddit_client_secret:
logger.warning("[reddit] REDDIT_CLIENT_ID or REDDIT_CLIENT_SECRET not set")
return None
try:
# Create a custom requests session with SSL verification disabled
session = requests.Session()
session.verify = False
reddit = praw.Reddit(
client_id=settings.reddit_client_id,
client_secret=settings.reddit_client_secret,
user_agent=settings.reddit_user_agent,
read_only=True,
request_timeout=15,
session=session,
)
# Test the connection
reddit.user.me()
return reddit
except Exception as e:
logger.warning(f"[reddit] Failed to initialize PRAW client: {e}")
return None
# ------------------------------------------------------------------
# Low-level HTTP helpers (fallback for non-PRAW operations)
# ------------------------------------------------------------------
def _make_request(url: str, retries: int = 2) -> dict | list | None:
"""GET a Reddit JSON endpoint with automatic delay + retry, cached via diskcache.
This is kept as a fallback for operations not supported by PRAW.
"""
cache_key = ("reddit_json", url)
cached = _CACHE.get(cache_key, default=_MISSING)
if cached is not _MISSING:
return cached
for attempt in range(retries + 1):
try:
time.sleep(_REQUEST_DELAY_S)
headers = {
"User-Agent": settings.reddit_user_agent,
"Accept": "application/json",
}
# Reddit has known SSL certificate issues, so we disable verification
r = requests.get(url, headers=headers, timeout=15, verify=False)
if r.status_code == 404:
# Cache 404s as None to avoid repeated misses
_CACHE.set(cache_key, None, expire=_TTL_S)
return None
r.raise_for_status()
data = r.json()
_CACHE.set(cache_key, data, expire=_TTL_S)
return data
except requests.HTTPError as e:
logger.warning(f"Reddit HTTP error {r.status_code} for {url}: {e}")
except Exception as e:
logger.warning(f"Reddit request error for {url}: {e}")
if attempt < retries:
time.sleep(_REQUEST_DELAY_S * 2)
return None
def _post_title_matches(post_data: dict) -> bool:
"""Check if a post title contains complaint keywords."""
title = post_data.get("title", "").lower()
return any(kw in title for kw in _TITLE_KEYWORDS)
def _extract_top_level_comments(comments_listing: dict, post_title: str, subreddit: str) -> list[ScrapedComment]:
"""Walk top-level (depth-0) comments. Skip AutoModerator / deleted."""
out: list[ScrapedComment] = []
for child in comments_listing.get("data", {}).get("children", []):
if child.get("kind") != "t1":
continue
d = child["data"]
body = d.get("body", "").strip()
permalink = d.get("permalink", "").strip()
author = d.get("author", "").strip()
if not body or len(body) < 30:
continue
if author.lower() in {"automoderator", "[deleted]", "deleted"}:
continue
if not permalink:
continue
url = f"https://www.reddit.com{permalink}"
out.append(ScrapedComment(text=body, url=url, subreddit=subreddit, post_title=post_title))
if len(out) >= _MAX_COMMENTS_PER_POST:
break
return out
# ------------------------------------------------------------------
# Public API
# ------------------------------------------------------------------
def search_posts(subreddit: str, query: str) -> list[dict]:
"""Run a single search query on a subreddit; return raw post children."""
reddit = _get_reddit_client()
if reddit:
try:
# Use PRAW for search
subreddit_obj = reddit.subreddit(subreddit)
results = subreddit_obj.search(
query,
sort="new",
time_filter=_TIME_WINDOW,
limit=_SEARCH_LIMIT,
)
# Convert PRAW Submission objects to dict format
posts = []
for submission in results:
posts.append(
{
"data": {
"title": submission.title,
"selftext": submission.selftext,
"permalink": submission.permalink,
"id": submission.id,
"url": submission.url,
"num_comments": submission.num_comments,
}
}
)
return posts
except Exception as e:
logger.warning(f"[reddit] PRAW search failed for r/{subreddit}: {e}")
# Fall back to JSON API
pass
# Fallback to JSON API
q = requests.utils.quote(query)
url = (
f"https://www.reddit.com/r/{subreddit}/search.json"
f"?q={q}&sort=new&t={_TIME_WINDOW}&limit={_SEARCH_LIMIT}&restrict_sr=on"
)
data = _make_request(url)
if not data or "data" not in data:
return []
return data["data"].get("children", [])
def fetch_post_comments(subreddit: str, post_id: str) -> tuple[str, list[ScrapedComment]] | None:
"""Fetch a post and its top-level comments.
Returns ``(post_title, comments)`` or ``None`` on failure.
"""
reddit = _get_reddit_client()
if reddit:
try:
# Use PRAW to fetch submission
submission = reddit.submission(id=post_id)
submission.comments.replace_more(limit=0) # Remove "load more comments"
post_title = submission.title
comments = []
for comment in submission.comments:
if not hasattr(comment, "body"):
continue
body = comment.body.strip()
if not body or len(body) < 30:
continue
if comment.author and comment.author.name.lower() in {"automoderator", "[deleted]", "deleted"}:
continue
url = f"https://www.reddit.com{comment.permalink}"
comments.append(
ScrapedComment(text=body, url=url, subreddit=subreddit, post_title=post_title)
)
if len(comments) >= _MAX_COMMENTS_PER_POST:
break
return post_title, comments
except Exception as e:
logger.warning(f"[reddit] PRAW comment fetch failed for {post_id}: {e}")
# Fall back to JSON API
pass
# Fallback to JSON API
url = f"https://www.reddit.com/r/{subreddit}/comments/{post_id}.json"
resp = _make_request(url)
if not resp or not isinstance(resp, list) or len(resp) < 2:
return None
post_listing = resp[0]
comments_listing = resp[1]
children = post_listing.get("data", {}).get("children", [])
if not children:
return None
post_title = children[0].get("data", {}).get("title", "")
comments = _extract_top_level_comments(comments_listing, post_title, subreddit)
return post_title, comments
def scrape_subreddit(subreddit: str, cap: int = _MAX_COMMENTS_PER_SUBREDDIT) -> list[ScrapedComment]:
"""Scrape a single subreddit, returning verbatim top-level comments."""
all_comments: list[ScrapedComment] = []
seen: set[str] = set()
for query in _SEARCH_QUERIES:
posts = search_posts(subreddit, query)
for child in posts:
if child.get("kind") != "t3":
continue
pid = child["data"].get("id")
if not pid or pid in seen:
continue
seen.add(pid)
if not _post_title_matches(child["data"]):
continue
result = fetch_post_comments(subreddit, pid)
if not result:
continue
_, comments = result
all_comments.extend(comments)
if len(all_comments) >= cap or len(seen) >= _MAX_POSTS_PER_SUBREDDIT:
return all_comments[:cap]
return all_comments[:cap]
def scrape_for_domain(domain: str, max_total_comments: int = 200) -> list[ScrapedComment]:
"""Main entry point.
1. Resolve domain β category β ordered subreddit list.
2. Scrape subreddits sequentially (niche β general).
3. Stop when ``max_total_comments`` collected.
"""
category, subreddits = resolve_domain(domain)
logger.info(
f"[reddit] domain='{domain}' β category='{category}' β "
f"subreddits={[f'r/{s}' for s in subreddits]}"
)
all_comments: list[ScrapedComment] = []
for sr in subreddits:
if len(all_comments) >= max_total_comments:
break
batch = scrape_subreddit(sr, cap=max_total_comments - len(all_comments))
all_comments.extend(batch)
logger.info(f"[reddit] r/{sr}: scraped {len(batch)} comments (running total {len(all_comments)})")
logger.info(f"[reddit] finished with {len(all_comments)} comments")
return all_comments
# ------------------------------------------------------------------
# Helpers consumed by other modules
# ------------------------------------------------------------------
def validate_quote(raw_quote: str, comments: list[ScrapedComment]) -> tuple[bool, str]:
"""Return ``(found, url_of_matching_comment)``.
Performs an exact (case-sensitive) substring match first, then a
relaxed match after stripping common Reddit markdown characters.
"""
stripped = raw_quote.strip()
if not stripped:
return False, ""
for c in comments:
if stripped in c.text:
return True, c.url
# Relaxed: strip asterisks, angle brackets, collapse whitespace
def _clean(text: str) -> str:
return " ".join(
text.replace("*", "").replace(">", "").replace("#", "").split()
)
c_stripped = _clean(stripped)
for c in comments:
if c_stripped in _clean(c.text):
return True, c.url
return False, ""
|