Skip to content

Commit

Permalink
Removed obsolete warnings about asgiref.sync adapters with sensitive …
Browse files Browse the repository at this point in the history
…variables.

Django 5.0+ required asgiref 3.7+, and this warning is obsolete for
asgiref 3.7+ since
django/asgiref@be6635e.
  • Loading branch information
felixxm authored Nov 17, 2023
1 parent 6daf860 commit 594873b
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 25 deletions.
11 changes: 0 additions & 11 deletions docs/howto/error-reporting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -194,17 +194,6 @@ 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.
Expand Down
14 changes: 0 additions & 14 deletions docs/topics/async.txt
Original file line number Diff line number Diff line change
Expand Up @@ -401,17 +401,3 @@ 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.

0 comments on commit 594873b

Please sign in to comment.