Aplikasi¶

Untuk pengarang aplikasi¶

Jika anda membuat sebuah aplikasi dapat dipasang dipanggil "Rock ’n’ roll", ini adalah bagaimana anda akan menyediakan sebuah nama pantas untuk admin:

# rock_n_roll/apps.py

from django.apps import AppConfig

class RockNRollConfig(AppConfig):
    name = 'rock_n_roll'
    verbose_name = "Rock ’n’ roll"

Anda dapat membuat aplikasi anda memuat subkelas ini AppConfig subclass secara awal sebagai berikut:

# rock_n_roll/__init__.py

default_app_config = 'rock_n_roll.apps.RockNRollConfig'

Itu akan menyebabkan RockNRollConfig untuk digunakan ketika INSTALLED_APPS hanya mengandung 'rock_n_roll'. Ini mengizinkan anda untuk membuat penggunaan dari fitur AppConfig tanpa membutuhkan pengguna anda untuk memperbaharui pengaturan INSTALLED_APPS mereka. Disamping ini menggunakan kasus, adalah terbaik untuk menghindari menggunakan default_app_config dan sebagai gantinya menentukan kelas konfigurasi aplikasi di INSTALLED_APPS sebagai digambarkan selanjutnya.

Tentu saja, anda dapa juga mengatakan pengguna anda untuk menaruh 'rock_n_roll.apps.RockNRollConfig' di pengaturan INSTALLED_APPS mereka. Anda dapat bahkan menyediakan beberapa perbedaan subkelas AppConfig dengan kebiasaan berbeda dan mengizinkan pengguna anda untuk memilih sati melalui pengaturan INSTALLED_APPS mereka.

Ketentuan yang dianjurkan adalah menaruh kelas konfigurasi di submodul dari aplikasi dipanggil apps. Bagaimanapun, ini tidak akan dipaksakan oleh Django.

Anda harus menyertakan atribut name untuk Django untuk menentukan aplikasi mana konfigurasi ini berlaku. Anda dapat menentukan atribut apapun didokumentasikan di acuan API AppConfig.

from django.apps import apps as django_apps

Untuk pengguna aplikasi¶

Jika anda menggunakan "Rock ’n’ roll" dalam proyek disebut anthology, tetapi anda ingin menampilkan "Jazz Manouche", anda dapat menyediakan konfigurasi anda sendiri:

# anthology/apps.py

from rock_n_roll.apps import RockNRollConfig

class JazzManoucheConfig(RockNRollConfig):
    verbose_name = "Jazz Manouche"

# anthology/settings.py

INSTALLED_APPS = [
    'anthology.apps.JazzManoucheConfig',
    # ...
]

Lagi, menentukan kelas konfigurasi proyek-khusus di submodul dipanggil apps adalah sebuah ketentuan, bukan sebuah persyaratan.

Atribut dapat dikonfigurasi¶

AppConfig.name¶

Jalur Phyton penuh ke aplikasi, sebagai contoh 'django.contrib.admin'.

Atribut ini menentukan konfigurasi aplikasi mana yang berlaku. DIa harus disetel di semua subkelas AppConfig.

Dia harus unik terhadap proyek Django.

AppConfig.label¶

Nama pendek untuk aplikasi, sebagai contoh 'admin'

Atribut ini mengizinkan melabel kembali sebuah aplikasi ketika dua aplikasi mempunyai label bertentangan. Awal dia ke komponen terakhir dari name. Dia harus penciri Python yang sah.

Dia harus unik terhadap proyek Django.

AppConfig.verbose_name¶

Nama dapat dibaca manusia untuk aplikasi, sebagai contoh "Administrasi".

Atribut awal ke label.title().

AppConfig.path¶

Jalur sistem berkas pada direktori aplikasi, sebagai contoh '/usr/lib/python3.4/dist-packages/django/contrib/admin'.

Dalam banyak kasus, Django dapat otomatis mengenali dan mengatur ini, tetapi anda dapat juga menyediakan menimpa eksplisit sebagai atribut kelas di subkelas AppConfig anda. Dalam beberapa situasi ini diwajibkan; sebagai contoh jika paket aplikasi adalah namespace package dengan banyak jalur.

Atribut hanya-baca¶

AppConfig.module¶

modul utama/akar untuk aplikasi, misalnya "<module 'django.contrib.admin' from 'django/contrib/admin/__init__.py'>".

AppConfig.models_module¶

Modul yang berisi model, misalnya "<module 'django.contrib.admin.models' from 'django/contrib/admin/models.py'>".

Itu mungkin None jika aplikasi tidak mengandung sebuah modul models. Catat bahwa basisdata terkait sinyal seperti pre_migrate dan post_migrate hanya dimunculkan untuk aplikasi yang mempunyai sebuah modul models

Cara¶

AppConfig.get_models()[sumber]¶

Mengembalikan kelas Model berulang untuk aplikasi ini.

Membutuhkan aplikasi registrar untuk sepenuhnya dikumpulkan.

AppConfig.get_model(model_name, require_ready=True)[sumber]¶

Mengembalikan Model dengan model_name diberikan. model_name adalah tidak sensitif.

Memunculkan LookupError jika tidak ada model yang ada dalam aplikasi ini.

Membutuhkan aplikasi regristrar untuk sepenuhnya dikumpulkan meskipun argumen require_ready disetel menjadi False. require_ready berperilaku tepat seperti dalam apps.get_model().

New in Django 1.11:

Argumen kata kunci require_ready telah ditambahkan.

AppConfig.ready()[sumber]¶

Subkelas dapat menimpa metode ini untuk melakukan tugas inisialisasi seperti mendaftarkan sinyal. Dia dipanggil segera ketika registrar dikumpulkan penuh.

Meskipun anda tidak dapat mengimpor pada tingkat-modul dimana kelas-kelas AppConfig ditentukan, anda dapat mengimpor ready(), menggunakan antara pernyataan import atau get_model().

Jika anda sedang mendaftarkan model signals, anda dapat mengacu pada pengirim berdasarkan label deretan karakter nya daripada menggunakan kelas model itu sendiri.

Contoh:

from django.db.models.signals import pre_save

def ready(self):
    # importing model classes
    from .models import MyModel  # or...
    MyModel = self.get_model('MyModel')

    # registering signals with the model's string label
    pre_save.connect(receiver, sender='app_label.MyModel')

Peringatan

Meskipun anda dapat mengakses kelas-kelas model seperti yang digambarkan dibawah, hindari berinteraksi dengan basisdata dalam penerapan ready() anda. Ini termasuk cara model yang mengerjakan permintaan (save(), delete(), manager methods etc.), dan juga permintaan SQL mentah melalui cara django.db.connection. Your ready() akan jalan selama permulaan dari stiap perintah pengelolaan. Sebagai contoh, meskipun konfigurasi basis data percobaan terpisah dari pengaturan produksi, manage.py test masih dapat mengerjakan beberapa permintaan terhadap basisdata produksi anda!

Catatan

Dalam pengolahan inisialisasi biasa, cara ready hanya dipanggil sekali oleh Django. Tetapi dalam kasus-kasus terpojok, khususnya dalam percobaan yang remeh dengan aplikasi terpasang, ready mngkin dipanggil lebih dari sekali. Dalam kasus tersebut, antara menulis cara idempoten, atau menaruh sebuah bendera pada kelas-kelas AppConfig anda untuk mencegah menjalankan kembali kode yang seharusnya dikerjakan tepatnya satu waktu.

Paket namespace sebagai aplikasi¶

Paket-paket Python tanpa berkas __init__.py dikenal sebagai "namespace packages" dan mungkin tersebar di banyak direktori pada tempat berbeda di sys.path (see PEP 420).

Aplikasi Django membutuhkan sebuah jalus sistem berkas berbasis tunggal dimana Django (tergantung pada konfigurasi) akan mencari cetakan, aset tetap, dll. Hingga, paket namespace mungkin hanya aplikasi Django jika satu dari hal berikut adalah benar:

1. Paket namespace sebenarnya mempunyai hanya tempat tunggal (yaitu tidak tersebar terhadap lebih dari satu direktori.)
2. Kelas AppConfig digunakan untuk mengkonfigurasikan aplikasi yang mempunyai atribut kelas path, yang merupakan jalur direktori mutlak Django akan digunakan sebagai jalur dasar tunggal untuk aplikasi.

Jika tidak satupun dari kondisi ini bertemu, Django akan memunculkan ImproperlyConfigured.

Bagaimana aplikasi dimuat¶

Ketika Django mulai, django.setup() bertanggung jawab untuk mengumpulkan registrar aplikasi.

setup(set_prefix=True)[sumber]¶

Konfigurasi Django oleh:

• Memuat pengaturan.
• Mengatur pencatatan.
• Jika set_prefix adalah True, pengaturan awalan tulisan penyelesai URL ke FORCE_SCRIPT_NAME jika ditentukan, atau jika tidak /.
• Memulai registrar aplikasi

Fungsi ini dipanggil otomatis:

• Ketika menjalankan peladen HTTP melalui dukungan WSGI Django.
• Ketika meminta perintah pengelolaan.

Dia harus dipanggil secara tersirat di kasus lain, sebagai contoh di tulisan Phyton.

Registrar aplikasi dimulai dalam tiga tingkatan, Pada setiap tingkatan, Django mengolah semua aplikasi berdasarkan dari INSTALLED_APPS.

1. Django pertama mengimpor setiap barang di INSTALLED_APPS.

   Jika itu sebuah kelas konfigurasi aplikasi, Django impor paket akar dari aplikasi, ditentukan oleh atribut name nya. Jika itu adalah sebuah paket Python, Django membuat konfigurasi aplikasi awal.

   Pada tingkatan ini, kode anda jangan mengimpor model apapun!

   Dengan kata lain, paket akar aplikasi anda dan modul yang menentukan kelas-kelas konfigurasi aplikasi anda jangan impor model apapun, bahkan secara tidak langsung.

   Sesungguhnya, Django mengizinkan mengimpor model sekali konfigurasi aplikasi mereka dimuat. Bagaimanapun, agar menghindari kendala yang tidak perlu pada urutan INSTALLED_APPS, sangat dianjurkan tidak mengimpor model apapun pada tingkatan ini.

   Sekali tingkatan ini lengkap, API yang menjalankan konfigurasi aplikasi seperti get_app_config() menjadi tidak berguna.

2. Kemudian Django berusaha mengimpor submodul model dari setiap aplikasi, jika memang ada.

   Anda harus menentukan atau mengimpor semua model di aplikasi models.py anda atau models/__init__.py. Sebaliknya, registri aplikasi mungkin tidak dikumpulkan penuh pada titik ini, yang dapat menyebabkan ORM tidak berfungsi.

   Ketika tingkatan ini lengkap, API yang bekerja di model seperti get_model() menjadi dapat digunakan.

3. Akhirnya Django menjalankan cara ready() dari setiap konfigurasi aplikasi.

Menyelesaikan masalah¶

Disini beberapa masalah umum yang mungkin muncul selama inisialisasi:

• AppRegistryNotReady: Ini terjadi ketika mengimpor sebuah konfigurasi aplikasi atau sebuah kode pemicu modul model yang bergantung di registri aplikasi.

  Sebagai contoh, gettext() menggunakan registrar aplikasi untuk mencari katalog terjemahan di aplikasi. Untuk menterjemahkan pada waktu impor, anda butuh gettext_lazy() sebagai gantinya. (Menggunakan gettext() akan berupa sebuah kesalahan, karena terjemahan akan terjadi pada waktu impor, daripada setiap permintaan tergantung pada bahasa aktif.)

  Menjalankan permintaan basisdata dengan ORM pada waktu impor dalam modul model juga akan memicu pengecualian ini. ORM tidak dapat berfungsi dengan benar sampai semua model tersedia.

  Pengecualian ini juga terjadi jika anda lupa memanggil django.setup() di tulisan berdiri sendiri.

• ImportError: tidak dapat impor nama ... Ini terjadi jika urutan impor berakhir dalam perulangan.

  Untuk mengurangi permasalahan tersebut, anda harus mengecilkan ketergantungan diantara model anda dan melakukan sedikit pekerjaan sebisa mungkin pada waktu impor. Untuk menghindari penjalanan kode pada waktu impor, anda dapat memindahkannya dan menembolok hasilnya. Kode akan dikerjakan ketika anda pertama butuh hasilnya. Konsep ini dikenal sebagai "lazy evaluation".

• django.contrib.admin automatically performs autodiscovery of admin modules in installed applications. To prevent it, change your INSTALLED_APPS to contain 'django.contrib.admin.apps.SimpleAdminConfig' instead of 'django.contrib.admin'.