Skip to content

added links #2437

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
acockburn merged 1 commit into from
Oct 12, 2025
Merged

added links #2437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions docs/INTERNALS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ Additional Subsystems
Startup
-------

The top-level entrypoint is ``appdaemon.__main__.main``, which uses :py:mod:`argparse` to parse the launch arguments.
The top-level entrypoint is :py:func:`appdaemon.__main__.main`, which uses :py:mod:`argparse` to parse the launch
arguments.

The :py:class:`~appdaemon.__main__.ADMain` class primarily provides a :py:ref:`context manager<context-managers>` that
can be used with a :py:keyword:`with statement<with>`. This contains an :py:class:`~contextlib.ExitStack` instance that
Expand All @@ -67,10 +68,11 @@ to run in the correct order, which is the reverse order that the contexts were e
Contexts
~~~~~~~~

The various context managers that get entered as AppDaemon is started include the logic for following steps. Some of these
are entered as part of the ``ADMain`` context, and some are entered in the :py:class:`~appdaemon.__main__.ADMain.run`
method. All of them are exited in reverse order as the :py:class:`~contextlib.ExitStack` is closed, which happens when
``ADMain`` context is exited.
The various context managers that get entered as AppDaemon starts include the logic for following steps. Some of these
are entered as part of the :py:class:`~appdaemon.__main__.ADMain` context, and some are entered in the
:py:class:`~appdaemon.__main__.ADMain.run` method. All of them are exited in reverse order as the
:py:class:`~contextlib.ExitStack` is closed, which happens when the :py:class:`~appdaemon.__main__.ADMain` context
exits.

* Backstop logic to catch any exceptions and log them more prettily.
* Creates a PID file for the duration of the context, if necessary/applicapable.
Expand Down Expand Up @@ -138,7 +140,7 @@ AppDaemon shutdown is globally indicated by the stop :py:class:`~asyncio.Event`
import contextlib

async def loop(self):
while not self.AD.stopping:
while not self.AD.stop_event.is_set():
... # Do stuff
with contextlib.suppress(asyncio.TimeoutError):
await asyncio.wait_for(self.AD.stop_event.wait(), timeout=1)
Expand Down
Loading