Doc'd use of asgiref.sync adapters with sensitive variables.

This commit is contained in:
Carlton Gibson 2023-03-22 12:32:13 +01:00
parent 203a15cadb
commit b00046d2c2
2 changed files with 25 additions and 0 deletions

View file

@ -194,6 +194,17 @@ filtered out of error reports in a production environment (that is, where
def process_info(user):
...
.. warning::
Due to the machinery needed to cross the sync/async boundary,
:func:`~asgiref.sync.sync_to_async` and
:func:`~asgiref.sync.async_to_sync` are **not** compatible with
``sensitive_variables()``.
If using these adapters with sensitive variables, ensure to audit
exception reporting, and consider implementing a :ref:`custom filter
<custom-error-reports>` if necessary.
.. versionchanged:: 5.0
Support for wrapping ``async`` functions was added.