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 | """Data models used in the project."""
import logging
from functools import cached_property
from typing import Any
import requests
from bs4 import BeautifulSoup
from pydantic import BaseModel, Field
logger = logging.getLogger(__package__)
class SearchQuery(BaseModel):
"""A search query."""
cities: list[str] = Field(default_factory=list)
min_price: int | None = Field(default=None, ge=0)
max_price: int | None = Field(default=None, ge=0)
min_monthly_fee: int | None = Field(default=None, ge=0)
max_monthly_fee: int | None = Field(default=None, ge=0)
min_rooms: int | None = Field(default=None, ge=1)
max_rooms: int | None = Field(default=None, ge=1)
min_size: int | None = Field(default=None, ge=1)
max_size: int | None = Field(default=None, ge=1)
queries: list[str] = Field(default_factory=list)
property_type: list[str] | None = Field(default=None)
def is_empty(self) -> bool:
"""Check if the search query is empty.
Returns:
True if the search query is empty, False otherwise.
"""
return (
not self.cities
and self.min_price is None
and self.max_price is None
and self.min_rooms is None
and self.max_rooms is None
and self.min_size is None
and self.max_size is None
)
def get_url(self, page: int = 1) -> str:
"""Get the URL for the search query.
Args:
page (optional):
The page number to get the URL for. Defaults to 1.
Returns:
The URL for the search query.
"""
url = f"https://api.boligsiden.dk/search/cases?page={page}"
property_type_names: list[str] = []
if self.property_type is not None:
if "ejerlejlighed" in self.property_type:
property_type_names.extend(["condo", "villa apartment"])
if "andelslejlighed" in self.property_type:
property_type_names.append("cooperative")
if "house" in self.property_type:
property_type_names.extend(["terraced house", "villa", "farm"])
property_type_names = sorted(set(property_type_names))
arguments: dict[str, Any] = dict(
addressTypes=",".join(property_type_names) if property_type_names else None,
cities=self.cities or None,
priceMin=self.min_price,
priceMax=self.max_price,
numberOfRoomsMin=self.min_rooms,
numberOfRoomsMax=self.max_rooms,
areaMin=self.min_size,
areaMax=self.max_size,
monthlyExpenseMin=self.min_monthly_fee,
monthlyExpenseMax=self.max_monthly_fee,
)
non_trivial_arguments = {
key: value for key, value in arguments.items() if value is not None
}
if non_trivial_arguments:
for key, value in non_trivial_arguments.items():
if not isinstance(value, list):
value = [value]
for item in value:
url += f"&{key}={item}"
return url
class Home(BaseModel):
"""A property listing."""
url: str
address: str
price: int | None = Field(default=None, ge=0)
num_rooms: int | None = Field(default=None, ge=1)
size: int | None = Field(default=None, ge=1)
monthly_fee: int | None = Field(default=None, ge=0)
year: int | None = Field(default=None, ge=0)
@cached_property
def description(self) -> str | None:
"""Get the description of the home.
Returns:
The description of the home, or None if not available.
"""
response = requests.get(url=self.url)
if response.ok:
soup = BeautifulSoup(response.content, "html.parser")
lines = soup.text.split("\n")
long_lines = [line.strip() for line in lines if len(line.strip()) > 200]
if long_lines:
return "\n".join(long_lines)
else:
logger.warning(
f"Could not find description for property {self.url}. The longest "
f"line was {max(len(line) for line in lines)} characters long."
)
return None
def __hash__(self) -> int:
"""Get the hash of the home.
Returns:
The hash of the home.
"""
return hash(self.url)
def to_html(self) -> str:
"""Get the home as an HTML string.
Returns:
The home as an HTML string.
"""
components = [f"<a href='{self.url}'>{self.address}</a>"]
if self.price is not None:
components.append(f"Price: {self.price:,} kr.")
if self.num_rooms is not None:
components.append(f"Number of rooms: {self.num_rooms}")
if self.size is not None:
components.append(f"Size: {self.size} m²")
if self.monthly_fee is not None:
components.append(f"Monthly fee: {self.monthly_fee:,} kr./md")
if self.year is not None:
components.append(f"Year built: {self.year}")
return "\n".join(components)
def to_text(self) -> str:
"""Get the home as a text string.
Returns:
The home as a text string.
"""
components = [f"URL: {self.url}", f"Address: {self.address}"]
if self.price is not None:
components.append(f"Price: {self.price:,} kr.")
if self.num_rooms is not None:
components.append(f"Number of rooms: {self.num_rooms}")
if self.size is not None:
components.append(f"Size: {self.size} m²")
if self.monthly_fee is not None:
components.append(f"Monthly fee: {self.monthly_fee:,} kr./md")
if self.year is not None:
components.append(f"Year built: {self.year}")
return "\n".join(components)
|