mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/howto/error-reporting.txt
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.

14
docs/topics/async.txt
View File

@ -338,3 +338,17 @@ trigger the thread safety checks:
Rather, you should encapsulate all database access within a helper function
that can be called with ``sync_to_async()`` without relying on the connection
object in the calling code.
Use with exception reporting filters
------------------------------------
.. warning::
Due to the machinery needed to cross the sync/async boundary,
``sync_to_async()`` and ``async_to_sync()`` are **not** compatible with
:func:`~django.views.decorators.debug.sensitive_variables`, used to mask
local variables from exception reports.
If using these adapters with sensitive variables, ensure to audit exception
reporting, and consider implementing a :ref:`custom filter
<custom-error-reports>` if necessary.