evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Tweak core add_job and async_add_job docstrings (#62112)

Browse source
This commit is contained in:
Erik Montnemery 2021-12-16 22:08:13 +01:00 • committed by GitHub
parent 9e4f720591
commit 773ac289dd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
homeassistant/core.py
View file

@ -323,7 +323,10 @@ class HomeAssistant:
_async_create_timer(self)
def add_job(self, target: Callable[..., Any], *args: Any) -> None:
"""Add job to the executor pool.
"""Add a job to be executed by the event loop or by an executor.
If the job is either a coroutine or decorated with @callback, it will be
run by the event loop, if not it will be run by an executor.
target: target to call.
args: parameters for method to call.
@ -336,7 +339,10 @@ class HomeAssistant:
def async_add_job(
self, target: Callable[..., Any], *args: Any
) -> asyncio.Future | None:
"""Add a job from within the event loop.
"""Add a job to be executed by the event loop or by an executor.
If the job is either a coroutine or decorated with @callback, it will be
run by the event loop, if not it will be run by an executor.
This method must be run in the event loop.