Skip to content

feat: reduce IP Address parsing overhead in ServiceInfo #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdraco merged 2 commits into from
Sep 6, 2023
Merged

feat: reduce IP Address parsing overhead in ServiceInfo #1257

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61ab2b9
feat: reduce IP Address parsing overhead in ServiceInfo
bdraco Sep 6, 2023
9e58cfd
feat: reduce IP Address parsing overhead in ServiceInfo
bdraco Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 24 additions & 15 deletions src/zeroconf/_services/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,13 @@ def instance_name_from_service_info(info: "ServiceInfo", strict: bool = True) ->
return info.name[: -len(service_name) - 1]


_cached_ip_addresses = lru_cache(maxsize=256)(ip_address)
@lru_cache(maxsize=512)
def _cached_ip_addresses(address: Union[str, bytes, int]) -> Optional[Union[IPv4Address, IPv6Address]]:
"""Cache IP addresses."""
try:
return ip_address(address)
except ValueError:
return None


class ServiceInfo(RecordUpdateListener):
Expand Down Expand Up @@ -227,16 +233,19 @@ def addresses(self, value: List[bytes]) -> None:
self._get_address_and_nsec_records_cache = None

for address in value:
try:
addr = _cached_ip_addresses(address)
except ValueError:
addr = _cached_ip_addresses(address)
if addr is None:
raise TypeError(
"Addresses must either be IPv4 or IPv6 strings, bytes, or integers;"
f" got {address!r}. Hint: convert string addresses with socket.inet_pton"
)
if addr.version == 4:
if TYPE_CHECKING:
assert isinstance(addr, IPv4Address)
self._ipv4_addresses.append(addr)
else:
if TYPE_CHECKING:
assert isinstance(addr, IPv6Address)
self._ipv6_addresses.append(addr)

@property
Expand Down Expand Up @@ -394,11 +403,8 @@ def _get_ip_addresses_from_cache_lifo(
for record in self._get_address_records_from_cache_by_type(zc, type):
if record.is_expired(now):
continue
try:
ip_addr = _cached_ip_addresses(record.address)
except ValueError:
continue
else:
ip_addr = _cached_ip_addresses(record.address)
if ip_addr is not None:
address_list.append(ip_addr)
address_list.reverse() # Reverse to get LIFO order
return address_list
Expand Down Expand Up @@ -446,13 +452,14 @@ def _process_record_threadsafe(self, zc: 'Zeroconf', record: DNSRecord, now: flo
if record_key == self.server_key and record_type is DNSAddress:
if TYPE_CHECKING:
assert isinstance(record, DNSAddress)
try:
ip_addr = _cached_ip_addresses(record.address)
except ValueError as ex:
log.warning("Encountered invalid address while processing %s: %s", record, ex)
ip_addr = _cached_ip_addresses(record.address)
if ip_addr is None:
log.warning("Encountered invalid address while processing %s: %s", record, record.address)
return False

if type(ip_addr) is IPv4Address:
if ip_addr.version == 4:
if TYPE_CHECKING:
assert isinstance(ip_addr, IPv4Address)
ipv4_addresses = self._ipv4_addresses
if ip_addr not in ipv4_addresses:
ipv4_addresses.insert(0, ip_addr)
Expand All @@ -463,6 +470,8 @@ def _process_record_threadsafe(self, zc: 'Zeroconf', record: DNSRecord, now: flo

return False

if TYPE_CHECKING:
assert isinstance(ip_addr, IPv6Address)
ipv6_addresses = self._ipv6_addresses
if ip_addr not in self._ipv6_addresses:
ipv6_addresses.insert(0, ip_addr)
Expand Down Expand Up @@ -516,7 +525,7 @@ def dns_addresses(
records = [
DNSAddress(
name,
_TYPE_AAAA if type(ip_addr) is IPv6Address else _TYPE_A,
_TYPE_AAAA if ip_addr.version == 6 else _TYPE_A,
class_,
ttl,
ip_addr.packed,
Expand Down