mirror of
https://github.com/Bunsly/HomeHarvest.git
synced 2026-03-05 03:54:29 -08:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7065f8a0d4 | ||
|
|
d88f781b47 | ||
|
|
282064d8be |
69
README.md
69
README.md
@@ -129,30 +129,38 @@ for prop in properties[:5]:
|
||||
```
|
||||
Required
|
||||
├── location (str): Flexible location search - accepts any of these formats:
|
||||
- ZIP code: "92104"
|
||||
- City: "San Diego" or "San Francisco"
|
||||
- City, State (abbreviated or full): "San Diego, CA" or "San Diego, California"
|
||||
- Full address: "1234 Main St, San Diego, CA 92104"
|
||||
- Neighborhood: "Downtown San Diego"
|
||||
- County: "San Diego County"
|
||||
├── listing_type (option): Choose the type of listing.
|
||||
- 'for_rent'
|
||||
- 'for_sale'
|
||||
- 'sold'
|
||||
- 'pending' (for pending/contingent sales)
|
||||
|
||||
│ - ZIP code: "92104"
|
||||
│ - City: "San Diego" or "San Francisco"
|
||||
│ - City, State (abbreviated or full): "San Diego, CA" or "San Diego, California"
|
||||
│ - Full address: "1234 Main St, San Diego, CA 92104"
|
||||
│ - Neighborhood: "Downtown San Diego"
|
||||
│ - County: "San Diego County"
|
||||
│ - State (no support for abbreviated): "California"
|
||||
│
|
||||
├── listing_type (str | list[str] | None): Choose the type of listing.
|
||||
│ - 'for_sale'
|
||||
│ - 'for_rent'
|
||||
│ - 'sold'
|
||||
│ - 'pending'
|
||||
│ - 'off_market'
|
||||
│ - 'new_community'
|
||||
│ - 'other'
|
||||
│ - 'ready_to_build'
|
||||
│ - List of strings returns properties matching ANY status: ['for_sale', 'pending']
|
||||
│ - None returns all listing types
|
||||
│
|
||||
Optional
|
||||
├── property_type (list): Choose the type of properties.
|
||||
- 'single_family'
|
||||
- 'multi_family'
|
||||
- 'condos'
|
||||
- 'condo_townhome_rowhome_coop'
|
||||
- 'condo_townhome'
|
||||
- 'townhomes'
|
||||
- 'duplex_triplex'
|
||||
- 'farm'
|
||||
- 'land'
|
||||
- 'mobile'
|
||||
│ - 'single_family'
|
||||
│ - 'multi_family'
|
||||
│ - 'condos'
|
||||
│ - 'condo_townhome_rowhome_coop'
|
||||
│ - 'condo_townhome'
|
||||
│ - 'townhomes'
|
||||
│ - 'duplex_triplex'
|
||||
│ - 'farm'
|
||||
│ - 'land'
|
||||
│ - 'mobile'
|
||||
│
|
||||
├── return_type (option): Choose the return type.
|
||||
│ - 'pandas' (default)
|
||||
@@ -165,12 +173,12 @@ Optional
|
||||
├── past_days (integer): Number of past days to filter properties. Utilizes 'last_sold_date' for 'sold' listing types, and 'list_date' for others (for_rent, for_sale).
|
||||
│ Example: 30 (fetches properties listed/sold in the last 30 days)
|
||||
│
|
||||
├── past_hours (integer): Number of past hours to filter properties (more precise than past_days). Uses client-side filtering.
|
||||
│ Example: 24 (fetches properties from the last 24 hours)
|
||||
├── past_hours (integer | timedelta): Number of past hours to filter properties (more precise than past_days). Uses client-side filtering.
|
||||
│ Example: 24 or timedelta(hours=24) (fetches properties from the last 24 hours)
|
||||
│ Note: Cannot be used together with past_days or date_from/date_to
|
||||
│
|
||||
├── date_from, date_to (string): Start and end dates to filter properties listed or sold, both dates are required.
|
||||
| (use this to get properties in chunks as there's a 10k result limit)
|
||||
│ (use this to get properties in chunks as there's a 10k result limit)
|
||||
│ Accepts multiple formats with automatic precision detection:
|
||||
│ - Date strings: "YYYY-MM-DD" (day precision)
|
||||
│ - Datetime strings: "YYYY-MM-DDTHH:MM:SS" (hour precision, uses client-side filtering)
|
||||
@@ -180,6 +188,14 @@ Optional
|
||||
│ Day precision: "2023-05-01", "2023-05-15"
|
||||
│ Hour precision: "2025-01-20T09:00:00", "2025-01-20T17:00:00"
|
||||
│
|
||||
├── updated_since (datetime | str): Filter properties updated since a specific date/time (based on last_update_date field)
|
||||
│ Accepts datetime objects or ISO 8601 strings
|
||||
│ Example: updated_since=datetime(2025, 11, 10, 9, 0) or "2025-11-10T09:00:00"
|
||||
│
|
||||
├── updated_in_past_hours (integer | timedelta): Filter properties updated in the past X hours (based on last_update_date field)
|
||||
│ Accepts integer (hours) or timedelta object
|
||||
│ Example: updated_in_past_hours=24 or timedelta(hours=24)
|
||||
│
|
||||
├── beds_min, beds_max (integer): Filter by number of bedrooms
|
||||
│ Example: beds_min=2, beds_max=4 (2-4 bedrooms)
|
||||
│
|
||||
@@ -199,7 +215,7 @@ Optional
|
||||
│ Example: year_built_min=2000, year_built_max=2024 (built between 2000-2024)
|
||||
│
|
||||
├── sort_by (string): Sort results by field
|
||||
│ Options: 'list_date', 'sold_date', 'list_price', 'sqft', 'beds', 'baths'
|
||||
│ Options: 'list_date', 'sold_date', 'list_price', 'sqft', 'beds', 'baths', 'last_update_date'
|
||||
│ Example: sort_by='list_price'
|
||||
│
|
||||
├── sort_direction (string): Sort direction, default is 'desc'
|
||||
@@ -265,6 +281,7 @@ Property
|
||||
│ ├── sold_price
|
||||
│ ├── last_sold_date # datetime (full timestamp: YYYY-MM-DD HH:MM:SS)
|
||||
│ ├── last_status_change_date # datetime (full timestamp: YYYY-MM-DD HH:MM:SS)
|
||||
│ ├── last_update_date # datetime (full timestamp: YYYY-MM-DD HH:MM:SS)
|
||||
│ ├── last_sold_price
|
||||
│ ├── price_per_sqft
|
||||
│ ├── new_construction
|
||||
|
||||
@@ -129,6 +129,22 @@ def scrape_property(
|
||||
converted_updated_since = convert_to_datetime_string(updated_since)
|
||||
converted_updated_in_past_hours = extract_timedelta_hours(updated_in_past_hours)
|
||||
|
||||
# Auto-apply optimal sort for time-based filters (unless user specified different sort)
|
||||
if (converted_updated_since or converted_updated_in_past_hours) and not sort_by:
|
||||
sort_by = "last_update_date"
|
||||
if not sort_direction:
|
||||
sort_direction = "desc" # Most recent first
|
||||
|
||||
# Auto-apply optimal sort for PENDING listings with date filters
|
||||
# PENDING API filtering is broken, so we rely on client-side filtering
|
||||
# Sorting by pending_date ensures efficient pagination with early termination
|
||||
elif (converted_listing_type == ListingType.PENDING and
|
||||
(converted_past_days or converted_past_hours or converted_date_from) and
|
||||
not sort_by):
|
||||
sort_by = "pending_date"
|
||||
if not sort_direction:
|
||||
sort_direction = "desc" # Most recent first
|
||||
|
||||
scraper_input = ScraperInput(
|
||||
location=location,
|
||||
listing_type=converted_listing_type,
|
||||
|
||||
@@ -526,31 +526,39 @@ class RealtorScraper(Scraper):
|
||||
total = result["total"]
|
||||
homes = result["properties"]
|
||||
|
||||
with ThreadPoolExecutor() as executor:
|
||||
# Store futures with their offsets to maintain proper sort order
|
||||
# Start from offset + page_size and go up to offset + limit
|
||||
futures_with_offsets = [
|
||||
(i, executor.submit(
|
||||
self.general_search,
|
||||
variables=search_variables | {"offset": i},
|
||||
search_type=search_type,
|
||||
))
|
||||
for i in range(
|
||||
self.offset + self.DEFAULT_PAGE_SIZE,
|
||||
min(total, self.offset + self.limit),
|
||||
self.DEFAULT_PAGE_SIZE,
|
||||
)
|
||||
]
|
||||
# Pre-check: Should we continue pagination?
|
||||
# This optimization prevents unnecessary API calls when using time-based filters
|
||||
# with date sorting. If page 1's last property is outside the time window,
|
||||
# all future pages will also be outside (due to sort order).
|
||||
should_continue_pagination = self._should_fetch_more_pages(homes)
|
||||
|
||||
# Collect results and sort by offset to preserve API sort order across pages
|
||||
results = []
|
||||
for offset, future in futures_with_offsets:
|
||||
results.append((offset, future.result()["properties"]))
|
||||
# Only launch parallel pagination if needed
|
||||
if should_continue_pagination and self.offset + self.DEFAULT_PAGE_SIZE < min(total, self.offset + self.limit):
|
||||
with ThreadPoolExecutor() as executor:
|
||||
# Store futures with their offsets to maintain proper sort order
|
||||
# Start from offset + page_size and go up to offset + limit
|
||||
futures_with_offsets = [
|
||||
(i, executor.submit(
|
||||
self.general_search,
|
||||
variables=search_variables | {"offset": i},
|
||||
search_type=search_type,
|
||||
))
|
||||
for i in range(
|
||||
self.offset + self.DEFAULT_PAGE_SIZE,
|
||||
min(total, self.offset + self.limit),
|
||||
self.DEFAULT_PAGE_SIZE,
|
||||
)
|
||||
]
|
||||
|
||||
# Sort by offset and concatenate in correct order
|
||||
results.sort(key=lambda x: x[0])
|
||||
for offset, properties in results:
|
||||
homes.extend(properties)
|
||||
# Collect results and sort by offset to preserve API sort order across pages
|
||||
results = []
|
||||
for offset, future in futures_with_offsets:
|
||||
results.append((offset, future.result()["properties"]))
|
||||
|
||||
# Sort by offset and concatenate in correct order
|
||||
results.sort(key=lambda x: x[0])
|
||||
for offset, properties in results:
|
||||
homes.extend(properties)
|
||||
|
||||
# Apply client-side hour-based filtering if needed
|
||||
# (API only supports day-level filtering, so we post-filter for hour precision)
|
||||
@@ -844,6 +852,71 @@ class RealtorScraper(Scraper):
|
||||
return date_range['from_date'] <= date_obj <= date_range['to_date']
|
||||
return False
|
||||
|
||||
def _should_fetch_more_pages(self, first_page):
|
||||
"""Determine if we should continue pagination based on first page results.
|
||||
|
||||
This optimization prevents unnecessary API calls when using time-based filters
|
||||
with date sorting. If the last property on page 1 is already outside the time
|
||||
window, all future pages will also be outside (due to sort order).
|
||||
|
||||
Args:
|
||||
first_page: List of properties from the first page
|
||||
|
||||
Returns:
|
||||
bool: True if we should continue pagination, False to stop early
|
||||
"""
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
# Check for last_update_date filters
|
||||
if (self.updated_since or self.updated_in_past_hours) and self.sort_by == "last_update_date":
|
||||
if not first_page:
|
||||
return False
|
||||
|
||||
last_property = first_page[-1]
|
||||
last_date = self._extract_date_from_home(last_property, 'last_update_date')
|
||||
|
||||
if not last_date:
|
||||
return True
|
||||
|
||||
# Build date range for last_update_date filter
|
||||
if self.updated_since:
|
||||
try:
|
||||
cutoff_datetime = datetime.fromisoformat(self.updated_since.replace('Z', '+00:00') if self.updated_since.endswith('Z') else self.updated_since)
|
||||
date_range = {'type': 'since', 'date': cutoff_datetime}
|
||||
except ValueError:
|
||||
return True
|
||||
elif self.updated_in_past_hours:
|
||||
cutoff_datetime = datetime.now() - timedelta(hours=self.updated_in_past_hours)
|
||||
date_range = {'type': 'since', 'date': cutoff_datetime}
|
||||
else:
|
||||
return True
|
||||
|
||||
return self._is_datetime_in_range(last_date, date_range)
|
||||
|
||||
# Check for PENDING date filters
|
||||
if (self.listing_type == ListingType.PENDING and
|
||||
(self.last_x_days or self.past_hours or self.date_from) and
|
||||
self.sort_by == "pending_date"):
|
||||
|
||||
if not first_page:
|
||||
return False
|
||||
|
||||
last_property = first_page[-1]
|
||||
last_date = self._extract_date_from_home(last_property, 'pending_date')
|
||||
|
||||
if not last_date:
|
||||
return True
|
||||
|
||||
# Build date range for pending date filter
|
||||
date_range = self._get_date_range()
|
||||
if not date_range:
|
||||
return True
|
||||
|
||||
return self._is_datetime_in_range(last_date, date_range)
|
||||
|
||||
# No optimization applicable, continue pagination
|
||||
return True
|
||||
|
||||
def _apply_sort(self, homes):
|
||||
"""Apply client-side sorting to ensure results are properly ordered.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "homeharvest"
|
||||
version = "0.8.0"
|
||||
version = "0.8.2"
|
||||
description = "Real estate scraping library"
|
||||
authors = ["Zachary Hampton <zachary@bunsly.com>", "Cullen Watson <cullen@bunsly.com>"]
|
||||
homepage = "https://github.com/ZacharyHampton/HomeHarvest"
|
||||
|
||||
@@ -1357,4 +1357,171 @@ def test_combined_filters_with_raw_data():
|
||||
mls_id = source.get('id') if source else None
|
||||
|
||||
assert mls_id is not None and mls_id != "", \
|
||||
f"Property {prop.get('property_id')} should have an MLS ID (source.id)"
|
||||
f"Property {prop.get('property_id')} should have an MLS ID (source.id)"
|
||||
|
||||
|
||||
def test_updated_since_filtering():
|
||||
"""Test the updated_since parameter for filtering by last_update_date"""
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
# Test 1: Filter by last update in past 10 minutes (user's example)
|
||||
cutoff_time = datetime.now() - timedelta(minutes=10)
|
||||
result_10min = scrape_property(
|
||||
location="California",
|
||||
updated_since=cutoff_time,
|
||||
sort_by="last_update_date",
|
||||
sort_direction="desc",
|
||||
limit=100
|
||||
)
|
||||
|
||||
assert result_10min is not None
|
||||
print(f"\n10-minute window returned {len(result_10min)} properties")
|
||||
|
||||
# Test 2: Verify all results have last_update_date within range
|
||||
if len(result_10min) > 0:
|
||||
for idx in range(min(10, len(result_10min))):
|
||||
update_date_str = result_10min.iloc[idx]["last_update_date"]
|
||||
if pd.notna(update_date_str):
|
||||
try:
|
||||
# Handle timezone-aware datetime strings
|
||||
date_str = str(update_date_str)
|
||||
if '+' in date_str or date_str.endswith('Z'):
|
||||
# Remove timezone for comparison with naive cutoff_time
|
||||
date_str = date_str.replace('+00:00', '').replace('Z', '')
|
||||
update_date = datetime.strptime(date_str, "%Y-%m-%d %H:%M:%S")
|
||||
|
||||
assert update_date >= cutoff_time, \
|
||||
f"Property last_update_date {update_date} should be >= {cutoff_time}"
|
||||
print(f"Property {idx}: last_update_date = {update_date} (valid)")
|
||||
except (ValueError, TypeError) as e:
|
||||
print(f"Warning: Could not parse date {update_date_str}: {e}")
|
||||
|
||||
# Test 3: Compare different time windows
|
||||
result_1hour = scrape_property(
|
||||
location="California",
|
||||
updated_since=datetime.now() - timedelta(hours=1),
|
||||
limit=50
|
||||
)
|
||||
|
||||
result_24hours = scrape_property(
|
||||
location="California",
|
||||
updated_since=datetime.now() - timedelta(hours=24),
|
||||
limit=50
|
||||
)
|
||||
|
||||
print(f"1-hour window: {len(result_1hour)} properties")
|
||||
print(f"24-hour window: {len(result_24hours)} properties")
|
||||
|
||||
# Longer time window should return same or more results
|
||||
if len(result_1hour) > 0 and len(result_24hours) > 0:
|
||||
assert len(result_1hour) <= len(result_24hours), \
|
||||
"1-hour filter should return <= 24-hour results"
|
||||
|
||||
# Test 4: Verify sorting works with filtering
|
||||
if len(result_10min) > 1:
|
||||
# Get non-null dates
|
||||
dates = []
|
||||
for idx in range(len(result_10min)):
|
||||
date_str = result_10min.iloc[idx]["last_update_date"]
|
||||
if pd.notna(date_str):
|
||||
try:
|
||||
# Handle timezone-aware datetime strings
|
||||
clean_date_str = str(date_str)
|
||||
if '+' in clean_date_str or clean_date_str.endswith('Z'):
|
||||
clean_date_str = clean_date_str.replace('+00:00', '').replace('Z', '')
|
||||
dates.append(datetime.strptime(clean_date_str, "%Y-%m-%d %H:%M:%S"))
|
||||
except (ValueError, TypeError):
|
||||
pass
|
||||
|
||||
if len(dates) > 1:
|
||||
# Check if sorted descending
|
||||
for i in range(len(dates) - 1):
|
||||
assert dates[i] >= dates[i + 1], \
|
||||
f"Results should be sorted by last_update_date descending: {dates[i]} >= {dates[i+1]}"
|
||||
|
||||
|
||||
def test_updated_since_optimization():
|
||||
"""Test that updated_since optimization works (auto-sort + early termination)"""
|
||||
from datetime import datetime, timedelta
|
||||
import time
|
||||
|
||||
# Test 1: Verify auto-sort is applied when using updated_since without explicit sort
|
||||
start_time = time.time()
|
||||
result = scrape_property(
|
||||
location="California",
|
||||
updated_since=datetime.now() - timedelta(minutes=5),
|
||||
# NO sort_by specified - should auto-apply sort_by="last_update_date"
|
||||
limit=50
|
||||
)
|
||||
elapsed_time = time.time() - start_time
|
||||
|
||||
print(f"\nAuto-sort test: {len(result)} properties in {elapsed_time:.2f}s")
|
||||
|
||||
# Should complete quickly due to early termination optimization (<5 seconds)
|
||||
assert elapsed_time < 5.0, f"Query should be fast with optimization, took {elapsed_time:.2f}s"
|
||||
|
||||
# Verify results are sorted by last_update_date (proving auto-sort worked)
|
||||
if len(result) > 1:
|
||||
dates = []
|
||||
for idx in range(min(10, len(result))):
|
||||
date_str = result.iloc[idx]["last_update_date"]
|
||||
if pd.notna(date_str):
|
||||
try:
|
||||
clean_date_str = str(date_str)
|
||||
if '+' in clean_date_str or clean_date_str.endswith('Z'):
|
||||
clean_date_str = clean_date_str.replace('+00:00', '').replace('Z', '')
|
||||
dates.append(datetime.strptime(clean_date_str, "%Y-%m-%d %H:%M:%S"))
|
||||
except (ValueError, TypeError):
|
||||
pass
|
||||
|
||||
if len(dates) > 1:
|
||||
# Verify descending order (most recent first)
|
||||
for i in range(len(dates) - 1):
|
||||
assert dates[i] >= dates[i + 1], \
|
||||
"Auto-applied sort should order by last_update_date descending"
|
||||
|
||||
print("Auto-sort optimization verified ✓")
|
||||
|
||||
|
||||
def test_pending_date_optimization():
|
||||
"""Test that PENDING + date filters get auto-sort and early termination"""
|
||||
from datetime import datetime, timedelta
|
||||
import time
|
||||
|
||||
# Test: Verify auto-sort is applied for PENDING with past_days
|
||||
start_time = time.time()
|
||||
result = scrape_property(
|
||||
location="California",
|
||||
listing_type="pending",
|
||||
past_days=7,
|
||||
# NO sort_by specified - should auto-apply sort_by="pending_date"
|
||||
limit=50
|
||||
)
|
||||
elapsed_time = time.time() - start_time
|
||||
|
||||
print(f"\nPENDING auto-sort test: {len(result)} properties in {elapsed_time:.2f}s")
|
||||
|
||||
# Should complete quickly due to optimization (<10 seconds)
|
||||
assert elapsed_time < 10.0, f"PENDING query should be fast with optimization, took {elapsed_time:.2f}s"
|
||||
|
||||
# Verify results are sorted by pending_date (proving auto-sort worked)
|
||||
if len(result) > 1:
|
||||
dates = []
|
||||
for idx in range(min(10, len(result))):
|
||||
date_str = result.iloc[idx]["pending_date"]
|
||||
if pd.notna(date_str):
|
||||
try:
|
||||
clean_date_str = str(date_str)
|
||||
if '+' in clean_date_str or clean_date_str.endswith('Z'):
|
||||
clean_date_str = clean_date_str.replace('+00:00', '').replace('Z', '')
|
||||
dates.append(datetime.strptime(clean_date_str, "%Y-%m-%d %H:%M:%S"))
|
||||
except (ValueError, TypeError):
|
||||
pass
|
||||
|
||||
if len(dates) > 1:
|
||||
# Verify descending order (most recent first)
|
||||
for i in range(len(dates) - 1):
|
||||
assert dates[i] >= dates[i + 1], \
|
||||
"PENDING auto-applied sort should order by pending_date descending"
|
||||
|
||||
print("PENDING optimization verified ✓")
|
||||
Reference in New Issue
Block a user