Keseimbangan API

Django menjanjikan kestabilan API dan kesesuaian-kedepan sejak versi 1.0. Dalam cangkang kacang, ini berarti bahwa kode anda kembangkan terhadap versi DJango akan tetap bekerja dengan terbitan akan datang. Anda butuh membuat perubahan kecil ketika meningkatkan versi Django dari proyek anda gunakan: lihat bagian “Perubahan ketidaksesuaian kebelakang” dari catatan terbitan untuk versi atau versi dimana anda tingkatkan.

Apa “stabil” berarti

Daam konteks ini, stabil berarti:

  • Semua API umum (semuanya di dokumentasi ini) tidak akan dipindahkan atau dinamai kembali tanpa menyediakan alias belakang-sesuai.

  • Jika fitur baru ini ditambahkan ke API ini – yang sangat memungkinkan – mereka akan tidak rusak atau merubah arti dari cara yang ada. Dengan kata lain, “stabil” tidak (perlu) berarti “lengkap.”

  • Jika, untuk beberapa alasan, sebuah API dinyatakan stabil harus dipindahkan atau diganti, dia akan dinyatakan usang tetapi akan tetap berada di API unuk setidaknya dua fitur terbitan. Peringatan akan ditampilkan ketika cara usang dipanggil.

    Lihat Terbitan resmi utnuk lebih rinci bagaimana skema penomoran versi Django bekerja, dan bagaimana fitur akan diusangkan.

  • Kami hanya merusak kecocokan sebelumnya dari API ini jika sebuah lubang kesalahan atau keamanan membuatnya tidak dapat dihindari.

API Stabil

Pada umumnya, semaunya dicakupi di dokumentasi – dengan pengecualian dari apapun di kawasan internal adalah dianggap stabil.

Pengecualian

Ada beberapa pengecualian pada kestabilan ini dan janji kecocokan-belakang.

Perbaikan keamanan

Jika kami menjadi waspada dari masalah keamanan – semoga oleh seseorang mengikuti kebijakan pelaporan keamanan kami – kami akan melakukan apapun yang dibutuhkan untuk memperbaikinya. Ini mungkin berarti merusak kecocokan sebelumnya; keamanan mengalahkan jaminan kecocokan.

API ditandai sebagai internal

Beberapa API secara eksplisit ditandai sebagai “internal” dalam sepsang jalan:

  • Beberapa dokumentasi mengacu ke internal dan menyebutkan mereka seperti itu. Jika dokumentasi mengatakan sesuatu adalah internal, kami berhak untuk mengubahnya.

  • Fungsi, cara, dan obyek lain diawali dengan dipimpin garis bawah (_). Ini adalah standar cara Phyton dari mengindikasikan bahwa sesuatu adalah private; jika cara apapun mulai dengan _ tunggal, itu adalah sebuah API internal.

Back to Top