Permintaan & ORM¶

Dengan beberapa pengecualian, Django dapat menjalankan permintaan ORM asinkron juga:

async for author in Author.objects.filter(name__startswith="A"):
    book = await author.books.afirst()

Rincian catatan dapat ditemukan dakam Asynchronous queries, tapi singkatnya:

• Semua metode QuerySet yang dapat menyebabkan sebuah permintaan SQL untuk muncul memiliki asinkron a-prefixed berbeda.
• async for didukung pada semua QuerySets (termasuk keluaran values() dan values_list().)

Django juga mendukung beberapa metode model asinkron yang menggunakan basisdata:

async def make_book(*args, **kwargs):
    book = Book(...)
    await book.asave(using="secondary")


async def make_book_with_tags(tags, *args, **kwargs):
    book = await Book.objects.acreate(...)
    await book.tags.aset(tags)

Transaksi belum berjalan di suasana asinkron. Jika anda memiliki potongan kode yang butuh perilaku transaksi, kami menganjurkan anda menulis potongan sebagai fungsi sinkron tunggal dan memanggil dia menggunakan sync_to_async().

Penampilan¶

Saat dijalankan dalam suasana yang tidak sesuai dengan tampilan (misalnya tampilan asinkron dibawah WSGI, atau tampilan sinkron tradisional dibwah ASGI), Django harus ditiru gaya panggilan lain mengizinkan kode anda berjalan. Peralihan konteks ini menyebabkan sedikit hukuman penampilan sekitar millidetik.

Ini juga benar dari middleware. Django akan berusaha meminimalkan sejumlah jumlah konteks-beralih diantara sinkron dan asinkron. JIka anda memiliki peladen ASGI, tetapi semua middleware anda dan tampilan adalah sinkron, itu akan beralih sekali saja, sebelum dia memasuki tumpukan middleware.

Bagaimanapun, jika anda menaruh middleware sinkron diantara peladen ASGI tampilan asinkron, dia harus berganti ke suasana sinkron untuk middleware dan kembali ke suasana asnkron untuk tampilan. Django juga akan menahan urutan sinkron membuka pengecualian middleware eksepsi perambatan. Ini mungkin tidak terlihat pertamanya, tetapi menambahkan hukuman ini dari satu urutan per permintaan dapat memindahkan keuntungan penampilan asinkron apapun.

Anda harus melakukan pengujian penampilan sendiri untuk melihat pengaruh apa ASGI melawan WSGI miliki pada kode anda. Di beberapa kasus, ada kemungkinan penampilan meningkat bahkan untuk basis kode yang murni sinkron dibawah ASGI karena semua kode penangan-permintaan masih berjalan asinkron. Secara umum anda hanya ingin mengadakan suasana ASGI jika anda memiliki kode asinkron di proyek anda.

async_to_sync()¶

async_to_sync(async_function, force_new_loop=False)¶

Mengambil fungsi asinkron dan mengembalikan fungsi sinkronisasi yang membungkusnya. Dapat digunakan sebagai pembungkus langsung atau dekorator

from asgiref.sync import async_to_sync


async def get_data():
    ...


sync_get_data = async_to_sync(get_data)


@async_to_sync
async def get_other_data():
    ...

Fungsi asinkron dijalankan di putaran kegiatan untuk antrian saat ini, jika ada. Jika tidak ada putaran kegiatan saat ini, putaran kegiatan baru akan diputar secara khusus untuk pemanggilan asinkron tunggal dan dimatikan lagi setelah selesai. Dalam situasi apa pun, fungsi asinkron akan dijalankan pada antrian yang berbeda dengan kode panggilan.

Nilai threadlocal dan contextvar dipertahankan melintasi batas di kedua arah.

async_to_sync() pada dasarnya adalah versi yang lebih kuat dari fungsi asyncio.run() di pustaka standar Python. Selain memastikan threadlocal berfungsi, ini juga mengaktifkan suasana thread_sensitive dari sync_to_async() saat pembungkus tersebut digunakan di bawahnya.

sync_to_async()¶

sync_to_async(sync_function, thread_sensitive=True)[sumber]¶

Mengambil fungsi sinkronisasi dan mengembalikan fungsi asinkron yang membungkusnya. Dapat digunakan sebagai pembungkus langsung atau dekorator

from asgiref.sync import sync_to_async

async_function = sync_to_async(sync_function, thread_sensitive=False)
async_function = sync_to_async(sensitive_sync_function, thread_sensitive=True)


@sync_to_async
def sync_function():
    ...

Nilai threadlocal dan contextvar dipertahankan melintasi batas di kedua arah.

Fungsi sinkronisasi cenderung ditulis dengan asumsi semuanya berjalan di antrian utama, jadi sync_to_async() memiliki dua mode antrian:

• thread_sensitive=True (awalan): fungsi sinkronisasi akan berjalan di antrian yang sama dengan semua fungsi thread_sensitive lainnya. Ini akan menjadi antrian utama, jika antrian utama sinkron dan anda menggunakan pembungkus async_to_sync().
• thread_sensitive=False: fungsi sinkronisasi akan berjalan di antrian baru yang kemudian ditutup setelah pemanggilan selesai.

Suasana peka utas cukup istimewa, dan melakukan banyak pekerjaan untuk menjalankan semua fungsi di antrian yang sama. Perhatikan, bahwa itu bergantung pada penggunaan async_to_sync() di atasnya dalam tumpukan untuk menjalankan berbagai hal dengan benar di antrian utama. Jika Anda menggunakan asyncio.run() atau yang serupa, fungsi ini akan kembali menjalankan fungsi antrian-sensitif dalam satu antrian bersama, tetapi ini tidak akan menjadi antrian utama.

Alasan ini diperlukan di Django adalah bahwa banyak perpustakaan, khususnya adaptor berdasarkan data, mengharuskan mereka diakses di antrian yang sama dengan tempat mereka dibuat. Juga banyak kode Django yang ada menganggap semuanya berjalan di antrian yang sama, mis. middleware menambahkan sesuatu ke permintaan untuk digunakan nanti dalam tampilan.

Daripada memperkenalkan potensi masalah kompatibilitas dengan kode ini, kami memilih untuk menambahkan suasana ini sehingga semua kode sinkronisasi Django yang ada berjalan di antrian yang sama dan dengan demikian sepenuhnya kompatibel dengan suasana asinkron. Perhatikan bahwa kode sinkronisasi akan selalu berada dalam antrian berbeda dengan kode asinkron apa pun yang memanggilnya, jadi Anda harus menghindari meneruskan pegangan database mentah atau acuan sensitif antrian lainnya.

Dalam praktiknya, pembatasan ini berarti bahwa anda tidak boleh melewatkan fitur objek connection basisdata saat memanggil sync_to_async(). Melakukannya akan memicu antrian pemeriksaan keamanan:

# DJANGO_SETTINGS_MODULE=settings.py python -m asyncio
>>> import asyncio
>>> from asgiref.sync import sync_to_async
>>> from django.db import connection
>>> # In an async context so you cannot use the database directly:
>>> connection.cursor()
django.core.exceptions.SynchronousOnlyOperation: You cannot call this from
an async context - use a thread or sync_to_async.
>>> # Nor can you pass resolved connection attributes across threads:
>>> await sync_to_async(connection.cursor)()
django.db.utils.DatabaseError: DatabaseWrapper objects created in a thread
can only be used in that same thread. The object with alias 'default' was
created in thread id 4371465600 and this is thread id 6131478528.

Sebaliknya, Anda harus mengenkapsulasi semua akses database dalam fungsi pembantu yang dapat dipanggil dengan sync_to_async() tanpa bergantung pada objek koneksi dalam suasana panggilan.

Gunakan dengan penyaring pelaporan pengecualian¶