Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.
Python aiburrchatbot-frameworkdagsgenerative-aigraphshacktoberfestllmopsllmsmlopspersistent-data-structurestate-machinestate-managementvisibility
Adds note on ApplicationContext and how to use it (#446)
Stefan Krawczyk3e8e53a6913e
diff --git a/burr/core/application.py b/burr/core/application.pyindex 569271b7..33aeb288 100644--- a/burr/core/application.py+++ b/burr/core/application.py@@ -492,6 +492,20 @@ class ApplicationContext(AbstractContextManager):Often used for recursive tracking.Note this is also a context manager (allowing you to pass context to sub-applications).++ To access this object in a running application, you can use the `__context` variable in the+ action signature:++ .. code-block:: python++ from burr.core import action, State, ApplicationContext++ @action(reads=[...], writes=[...])+ def my_action(state: State, __context: ApplicationContext) -> State:+ app_id = __context.app_id+ partition_key = __context.partition_key+ ...+"""app_id: strdiff --git a/docs/concepts/state-persistence.rst b/docs/concepts/state-persistence.rstindex 24dabb16..8ae5f884 100644--- a/docs/concepts/state-persistence.rst+++ b/docs/concepts/state-persistence.rst@@ -35,14 +35,28 @@ State Keys----------Burr `applications` are, by default, keyed on two entities:-1. ``app_uid`` - A unique identifier for the application. This is used to identify the application in the persistence layer.+1. ``app_id`` - A unique identifier for the application. This is used to identify the application in the persistence layer.2. ``partition_key`` - An identifier for grouping (partitioning) applications-In the case of a chatbot, the ``app_uid`` could be a uuid, and the ``partition_key`` could be the user's name.-Note that ``partition_key`` can be `None` if this is not relevant. A UUID is always generated for the ``app_uid`` if not provided.+In the case of a chatbot, the ``app_id`` could be a uuid, and the ``partition_key`` could be the user's ID or email, etc.+Note that ``partition_key`` can be `None` if this is not relevant. A UUID is always generated for the ``app_id`` if not provided.You set these values using the :py:meth:`with_identifiers() <burr.core.application.ApplicationBuilder.with_identifiers>` method.+Note: to access ``app_id`` and ``partition_key`` in your running application, you can have the :py:class:`ApplicationContext <burr.core.application.ApplicationContext>`+injected into your Burr Actions. This is done by adding ``__context`` to the action signature:++.. code-block:: python++ from burr.core import action, State, ApplicationContext++ @action(reads=[...], writes=[...])+ def my_action(state: State, __context: ApplicationContext) -> State:+ app_id = __context.app_id+ partition_key = __context.partition_key+ ...++Initializing state------------------