You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/asking_questions.rst
+9-6Lines changed: 9 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -68,12 +68,15 @@ You can also set the following options when you call :mod:`Child.ask <octue.reso
68
68
- ``question_uuid`` - if provided, the question will use this UUID instead of a generated one
69
69
- ``push_endpoint`` - if provided, the result and other events produced during the processing of the question will be pushed to this HTTP endpoint (a URL)
70
70
- ``asynchronous`` - if ``True``, don't wait for an answer to the question (the result and other events can be :ref:`retrieved from the event store later <retrieving_asynchronous_answers>`)
71
-
- If ``raise_errors=False`` is provided, answers are returned for all successful questions while unraised errors are logged and returned for unsuccessful ones
72
-
- If ``raise_errors=False`` is provided with ``max_retries > 0``, failed questions are retried up to this number of times
73
-
- If ``raise_errors=False`` is provided with ``max_retries > 0`` and ``prevent_retries_when`` is set to a list of exception types, failed questions are retried except for those whose exception types are in the list
74
-
- ``log_errors``: If `True` and ``raise_errors=False``, any errors remaining once retries are exhausted are logged in addition to being returned
75
71
- ``timeout`` - how long in seconds to wait for an answer (``None`` by default - i.e. don't time out)
76
72
73
+
If the question fails:
74
+
- If ``raise_errors=False``, the unraised error is returned
75
+
- If ``raise_errors=False`` and ``max_retries > 0``, the question is retried up to this number of times
76
+
- If ``raise_errors=False``, ``max_retries > 0``, and ``prevent_retries_when`` is a list of exception types, the question is retried unless the error type is in the list
77
+
- If ``raise_errors=False``, ``log_errors=True``, and the question fails after its final retry, the error is logged
78
+
79
+
77
80
Exceptions raised by a child
78
81
----------------------------
79
82
If a child raises an exception while processing your question, the exception will always be forwarded and re-raised in
@@ -189,8 +192,8 @@ access the event store and run:
189
192
190
193
Asking multiple questions in parallel
191
194
=====================================
192
-
You can also ask multiple questions to a service in parallel - just provide any number of questions as dictionaries of
193
-
`Child.ask` arguments:
195
+
You can also ask multiple questions to a service in parallel - just provide questions as dictionaries of `Child.ask`
0 commit comments