Provide an asyncio class for service registration by bdraco · Pull Request #347 · python-zeroconf/python-zeroconf

bdraco · 2021-05-03T18:55:50Z

When using zeroconf with async code, service registration can cause the
executor to overload when registering multiple services since each one
will have to wait a bit between sending the broadcast. An asyncio class
is now available as aio.AsyncZeroconf that implements the following
- async_register_service
- async_unregister_service
- async_update_service
- async_close
I/O is currently run in the executor to provide backwards compat with
existing use cases.

These functions avoid overloading the executor by waiting in the event
loop instead of the executor threads.

The existing Zeroconf object is available as .zeroconf
Various tests that do not need to broadcast records no longer do so
as this slows down the test for something not being tested

jstasiak

I think we should rename the aio module to async or something, I'll imagine it'll be more familiar to the users (and rolls of the keyboard more naturally, at least to me).

All on all I'm really happy to see this change and with few tweaks it should be ready for merging!

bdraco · 2021-05-03T20:54:18Z

I think we should rename the aio module to async or something, I'll imagine it'll be more familiar to the users (and rolls of the keyboard more naturally, at least to me).

All on all I'm really happy to see this change and with few tweaks it should be ready for merging!

Python has problems with modules named async.py because of the reserved word. (which is why Home Assistant ended up with https://github.com/home-assistant/core/blob/dev/homeassistant/util/async_.py)

I can call it async_ or asynczc?

jstasiak · 2021-05-03T21:11:40Z

Huh, that's something that I didn't have in mind at all (the async keyword). What do you think about asyncio? (As in zeroconf.asyncio?) That's what aio stands for anyway after all.

bdraco · 2021-05-03T21:12:51Z

Huh, that's something that I didn't have in mind at all (the async keyword). What do you think about asyncio? (As in zeroconf.asyncio?) That's what aio stands for anyway after all.

Lets do that 👍

codecov-commenter · 2021-05-03T21:23:11Z

Codecov Report

Merging #347 (dbf95ff) into master (7816278) will increase coverage by 0.44%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #347      +/-   ##
==========================================
+ Coverage   91.71%   92.15%   +0.44%     
==========================================
  Files           2        4       +2     
  Lines        2678     2780     +102     
  Branches      361      367       +6     
==========================================
+ Hits         2456     2562     +106     
+ Misses        148      146       -2     
+ Partials       74       72       -2

Impacted Files	Coverage Δ
zeroconf/__init__.py	`89.59% <100.00%> (+0.28%)`	⬆️
zeroconf/asyncio.py	`100.00% <100.00%> (ø)`
zeroconf/test_asyncio.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7816278...dbf95ff. Read the comment docs.

bdraco · 2021-05-03T21:37:23Z

At this point, I'm going to write the changes to use this in

Home Assistant - https://github.com/bdraco/home-assistant/tree/zeroconf_async_register
HAP-python - https://github.com/bdraco/HAP-python/tree/switch_to_async_zc

to make sure the use cases are covered.

- When using zeroconf with async code, service registration can cause the executor to overload when registering multiple services since each one will have to wait a bit between sending the broadcast. An aio subclass is now available as aio.AsyncZeroconf that implements the following - async_register_service - async_unregister_service - async_update_service - async_close I/O is currently run in the executor to provide backwards compat with existing use cases. These functions avoid overloading the executor by waiting in the event loop instead of the executor threads.

- Add async version of check_service

bdraco · 2021-05-05T00:16:59Z

Retested, everything working as expected 👍

bdraco · 2021-05-05T00:21:04Z

If this looks like its ready, it would be great to get a release so I can start updating packages to use the new async calls.

jstasiak · 2021-05-05T20:10:09Z

Very nice work! I'll release this shortly.

jstasiak · 2021-05-05T20:43:02Z

Version 0.30.0 has just been relased with this change.

bdraco · 2021-05-05T21:15:26Z

Thanks!

bdraco force-pushed the register_without_broadcast branch 4 times, most recently from 13d04d6 to 81e3e2d Compare May 3, 2021 19:09

bdraco changed the title ~~Provide an AIO wrapper for service registration~~ Provide an AIO subclass for service registration May 3, 2021

bdraco commented May 3, 2021

View reviewed changes

Comment thread zeroconf/aio.py Outdated

jstasiak reviewed May 3, 2021

View reviewed changes

Comment thread zeroconf/__init__.py Outdated

Comment thread zeroconf/__init__.py Outdated

Comment thread zeroconf/__init__.py Outdated

Comment thread zeroconf/aio.py Outdated

Comment thread zeroconf/test.py Outdated

bdraco changed the title ~~Provide an AIO subclass for service registration~~ Provide an asyncio class for service registration May 3, 2021

bdraco marked this pull request as ready for review May 3, 2021 23:08

bdraco added 7 commits May 4, 2021 08:50

Revert constant prefix

b354624

Add missing "s"

ad27481

Tweak names

5a5aa65

Fix refactor error

672094d

order

3490264

black

f9f3e68

bdraco force-pushed the register_without_broadcast branch from 53ad3ce to f9f3e68 Compare May 4, 2021 18:51

bdraco added 4 commits May 4, 2021 10:04

- Revert changes to add broadcast_service

50bacb9

- Add async version of check_service

- async version does not modify the service name

40688dc

sort imports

118a771

Add missing coverage

2885db5

bdraco commented May 4, 2021

View reviewed changes

Comment thread zeroconf/__init__.py Outdated

Revert docstrings, implement cooperating_responders

81b922d

bdraco commented May 4, 2021

View reviewed changes

Comment thread zeroconf/__init__.py Outdated

Update zeroconf/__init__.py

fd93e9c

bdraco commented May 4, 2021

View reviewed changes

Comment thread zeroconf/__init__.py

Update zeroconf/__init__.py

8dcf67e

bdraco commented May 4, 2021

View reviewed changes

Comment thread zeroconf/__init__.py Outdated

Update zeroconf/__init__.py

dbf95ff

jstasiak merged commit a41d7b8 into python-zeroconf:master May 5, 2021

Conversation

bdraco commented May 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jstasiak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bdraco commented May 3, 2021

Uh oh!

jstasiak commented May 3, 2021

Uh oh!

bdraco commented May 3, 2021

Uh oh!

codecov-commenter commented May 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bdraco commented May 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bdraco commented May 5, 2021

Uh oh!

bdraco commented May 5, 2021

Uh oh!

jstasiak commented May 5, 2021

Uh oh!

jstasiak commented May 5, 2021

Uh oh!

bdraco commented May 5, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bdraco commented May 3, 2021 •

edited

Loading

codecov-commenter commented May 3, 2021 •

edited

Loading

bdraco commented May 3, 2021 •

edited

Loading