Skip to content

feat: speed up unpacking text records in ServiceInfo #1212

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 4 commits into from
Aug 4, 2023
Merged

feat: speed up unpacking text records in ServiceInfo #1212

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
558989a
feat: speed up unpack text records in ServiceInfo
bdraco Aug 3, 2023
ed200eb
Merge branch 'master' into set_text_cleanup
bdraco Aug 3, 2023
2c8da0f
fix: make property unpacking lazy
bdraco Aug 4, 2023
0394130
Merge branch 'master' into set_text_cleanup
bdraco Aug 4, 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
36 changes: 27 additions & 9 deletions src/zeroconf/_services/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def __init__(
self.priority = priority
self.server = server if server else None
self.server_key = server.lower() if server else None
self._properties: Dict[Union[str, bytes], Optional[Union[str, bytes]]] = {}
self._properties: Optional[Dict[Union[str, bytes], Optional[Union[str, bytes]]]] = None
if isinstance(properties, bytes):
self._set_text(properties)
else:
Expand Down Expand Up @@ -226,14 +226,18 @@ def addresses(self, value: List[bytes]) -> None:
self._ipv6_addresses.append(addr)

@property
def properties(self) -> Dict:
def properties(self) -> Dict[Union[str, bytes], Optional[Union[str, bytes]]]:
"""If properties were set in the constructor this property returns the original dictionary
of type `Dict[Union[bytes, str], Any]`.

If properties are coming from the network, after decoding a TXT record, the keys are always
bytes and the values are either bytes, if there was a value, even empty, or `None`, if there
was none. No further decoding is attempted. The type returned is `Dict[bytes, Optional[bytes]]`.
"""
if self._properties is None:
self._unpack_text_into_properties()
if TYPE_CHECKING:
assert self._properties is not None
return self._properties

async def async_wait(self, timeout: float) -> None:
Expand Down Expand Up @@ -317,10 +321,10 @@ def parsed_scoped_addresses(self, version: IPVersion = IPVersion.All) -> List[st
for addr in self._ip_addresses_by_version_value(version.value)
]

def _set_properties(self, properties: Dict) -> None:
def _set_properties(self, properties: Dict[Union[str, bytes], Optional[Union[str, bytes]]]) -> None:
"""Sets properties and text of this info from a dictionary"""
self._properties = properties
list_ = []
list_: List[bytes] = []
result = b''
for key, value in properties.items():
if isinstance(key, str):
Expand All @@ -338,14 +342,25 @@ def _set_properties(self, properties: Dict) -> None:

def _set_text(self, text: bytes) -> None:
"""Sets properties and text given a text field"""
if text == self.text:
return
self.text = text
# Clear the properties cache
self._properties = None

def _unpack_text_into_properties(self) -> None:
"""Unpacks the text field into properties"""
text = self.text
end = len(text)
if end == 0:
# Properties should be set atomically
# in case another thread is reading them
self._properties = {}
return

result: Dict[Union[str, bytes], Optional[Union[str, bytes]]] = {}
index = 0
strs = []
strs: List[bytes] = []
while index < end:
length = text[index]
index += 1
Expand All @@ -355,17 +370,20 @@ def _set_text(self, text: bytes) -> None:
key: bytes
value: Optional[bytes]
for s in strs:
try:
key, value = s.split(b'=', 1)
except ValueError:
key_value = s.split(b'=', 1)
if len(key_value) == 2:
key, value = key_value
else:
# No equals sign at all
key = s
value = None

# Only update non-existent properties
if key and result.get(key) is None:
if key and key not in result:
result[key] = value

# Properties should be set atomically
# in case another thread is reading them
self._properties = result

def get_name(self) -> str:
Expand Down