diff options
| author | Andrew Godwin <andrew@aeracode.org> | 2019-12-02 13:02:21 -0700 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-12-03 17:29:31 +0100 |
| commit | c90ab30fa1305481024b9c3c50b5a6ed6cd9a2f5 (patch) | |
| tree | c1178f55153aec63190c0329882a00513569e2cc /docs | |
| parent | 635a3f8e6e0303e8a87586ef6be4ab0cc01d7c0d (diff) | |
Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/releases/3.0.1.txt | 5 | ||||
| -rw-r--r-- | docs/spelling_wordlist | 1 | ||||
| -rw-r--r-- | docs/topics/async.txt | 20 |
3 files changed, 25 insertions, 1 deletions
diff --git a/docs/releases/3.0.1.txt b/docs/releases/3.0.1.txt index 18e2ea44c4..589ef40499 100644 --- a/docs/releases/3.0.1.txt +++ b/docs/releases/3.0.1.txt @@ -9,4 +9,7 @@ Django 3.0.1 fixes several bugs in 3.0. Bugfixes ======== -* ... +* Fixed a regression in Django 3.0 by restoring the ability to use Django + inside Jupyter and other environments that force an async context, by adding + and option to disable :ref:`async-safety` mechanism with + ``DJANGO_ALLOW_ASYNC_UNSAFE`` environment variable (:ticket:`31056`). diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 9c56339cc0..6a36a11707 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -309,6 +309,7 @@ ize JavaScript Jinja jQuery +Jupyter jython Kaplan Kessler diff --git a/docs/topics/async.txt b/docs/topics/async.txt index 6a6f0030c9..b341084b1a 100644 --- a/docs/topics/async.txt +++ b/docs/topics/async.txt @@ -12,6 +12,8 @@ There is limited support for other parts of the async ecosystem; namely, Django can natively talk :doc:`ASGI </howto/deployment/asgi/index>`, and some async safety support. +.. _async-safety: + Async-safety ------------ @@ -34,3 +36,21 @@ code from an async context; instead, write your code that talks to async-unsafe in its own, synchronous function, and call that using ``asgiref.sync.async_to_sync``, or any other preferred way of running synchronous code in its own thread. + +If you are *absolutely* in dire need to run this code from an asynchronous +context - for example, it is being forced on you by an external environment, +and you are sure there is no chance of it being run concurrently (e.g. you are +in a Jupyter_ notebook), then you can disable the warning with the +``DJANGO_ALLOW_ASYNC_UNSAFE`` environment variable. + +.. warning:: + + If you enable this option and there is concurrent access to the + async-unsafe parts of Django, you may suffer data loss or corruption. Be + very careful and do not use this in production environments. + +If you need to do this from within Python, do that with ``os.environ``:: + + os.environ["DJANGO_ALLOW_ASYNC_UNSAFE"] = "true" + +.. _Jupyter: https://jupyter.org/ |