Gaya pengkodean

Silahkan ikuti standar pengkodean ini ketika menulis kode untuk penyertaan di Django.

Gaya Phyton

  • Silahkan sesuaikan pada gaya lekukan yang didikte dalam berkas .editorconfig. Kami menganjurkan menggunakan pengubah teks dengan dukungan EditorConfig untuk menghindari masalah lekukan dan spasi putih. Berkas-berkas Python menggunakan 4 ruang kosong untuk lekukan dan berkas-berkas HTML menggunakan 2 ruang kosong .

  • Meskipun sebaliknya ditentukan, ikuti PEP 8.

    Gunakan flake8 untuk memeriksa masalah-maslaah dalam kawasan ini. Catat bahwa berkas setup.cfg kami mengandung beberapa berkas tidak tersertakan (modul diusangkan kami tidak peduli tentang perapihan dan beberapa kode pihak-ketiga penjaja Django itu) sama halnya beberapa kesalahan yang tidak disertakan yang kami tidak pertimbangkan sebagai pelanggaran berat. Ingat bahwa PEP 8 adalah hanya panduan, jadi hormati gaya dari kode sekelilingnya sebagai tujuan utama.

    Sebuah pengecualian pada PEP 8 adalah aturan kami pada panjang baris. Jangan batasi baris kode sampai 79 karakter jika itu berarti kode terlihat sangat buruk atau sulit dibaca. Kami mengizinkan sampai 119 karakter karena ini adalah lebar dari tinjauan kode GitHub; apapun lebih panjang membutuhkan menggulung secara mendatar yang membuat tinjauan lebih sulit. Pemeriksaan ini disertakan ketika anda menjalankan flake8. Dokumentasi, komentar, dan docstring harus dibungkus pada 79 karakter, meskipun PEP 8 menyarankan 72.

  • Gunakan empat ruang untuk lekukan.

  • Gunakan empat ruang menggantung lekukan daripada penjajaran tegak lurus:

    raise AttributeError(
    'Here is a multine error message '
    'shortened for clarity.'
)

    Daripada:

    raise AttributeError('Here is a multine error message '
                     'shortened for clarity.')

    Hal ini membuat penggunaan ruang lebih baik dan menghindari memiliki penjajarkan kembali string jika panjang dari baris pertama berubah.

  • Gunakan kutipan tunggal untuk string, atau kutipan ganda jika string mengandung kutipan tunggal. Jangan membuang waktu melakukan refactoring yang tidak terkait dari kode yang ada untuk memastikan gaya ini.

  • Hindari penggunaan "we" dalam komentar, sebagai contoh "Loop over" daripada "We loop over".

  • Gunakan garis bawah, bukan camelCase, untuk variabel, fungsi dan nama-nama metode (yaitu poll.get_unique_voters(), bukan poll.getUniqueVoters()).

  • Gunakan InitialCaps untuk nama-nama kelas (atau untuk fungsi pabrik yang mengembalikan kelas-kelas).

  • Dalam docstring, ikuti gaya dari docstring yang ada dan PEP 257.

  • Dalam percobaan, gunakan assertRaisesMessage() daripada assertRaises() jadi anda dapat memeriksa pesan pengecualian. Gunakan assertRaisesRegex() hanya jika anda butuh pencocokan regular expression.

  • Dalam docstring percobaan, nyatakan perilaku yang diharapkan yang setiap percobaan ditunjukkan. Jangan menyertakan pembukaan seperti "Tests that" atau "Ensures that".

    Acuan tiket balikan untuk mengaburkan masalah dimana tiket mempunyai rincian tambahan yang tidak dapat dengan mudah digambarkan dalam docstring atau komentar. Termasuk nomor tiket pada akhir dari sebuah kalimat seperti ini:

    def test_foo():
    """
    A test docstring looks like this (#123456).
    """
    ...

Impor

  • Gunakan isort untuk mengotomatisasi pengurutan impor menggunakan panduan dibawah.

    Mulai cepat:

    $ pip install isort
$ isort -rc .

    Ini menjalankan isort secara berulang dari pelipat anda saat ini, merubah berkas apapun yang tidak sesuai pada baris panduan. Jika anda butuh mengimpor rusak (untuk menghidari impor memutar, sebagai contoh) gunakan komentar seperti ini:

    import module  # isort:skip

  • Taruh impor dalam kelompok ini: akan datang, pustaka standar, pustaka pihak-ketiga, komponen Django lainnya, komponen Django lokal, coba/pengecualian. Urutkan baris dalam setiap kelompok secara alfabet dengan nama modul penuh. Tempatkan semua pernyataan import module sebelum from module import objects di setiap bagian. Gunakan impor sepenuhnya untuk komponen Django lainnya dan impor berhubugan untuk komponen lokal.

  • Pada setiap baris, alfabetkan barang-barang dengan barang-barang huruf besar dikelompokkan sebelum barang-barang huruf kecil.

  • Putuskan baris panjang menggunakan kurung dan lekukan garis kelanjutan dengan 4 ruang. Termasuk koma yang membuntuti setelah impor terakhir dan taruh kurung penutup pada baris itu sendiri.

    Gunakan baris kosong tunggal diantara impor terakhir dan tiap modul kode tingkatan, dan gunakan dua baris kosong diatas fungsi atau kelas pertama.

    Sebagai contoh (komentar hanya untuk tujuan penjelasan):

    django/contrib/admin/example.py
    # future
from __future__ import unicode_literals

# standard library
import json
from itertools import chain

# third-party
import bcrypt

# Django
from django.http import Http404
from django.http.response import (
    Http404, HttpResponse, HttpResponseNotAllowed, StreamingHttpResponse,
    cookie,
)

# local Django
from .models import LogEntry

# try/except
try:
    import yaml
except ImportError:
    yaml = None

CONSTANT = 'foo'


class Example:
    # ...

  • Gunakan manfaat impor kapanpun tersedia. Sebagai contoh, lakukan ini:

    from django.views import View

    dari pada:

    from django.views.generic.base import View

Gaya cetakan

  • Di kode cetakan Django, taruh satu (dan hanya satu) spasi diantara kurung keriting dan etiket isi.

    Lakukan ini:

    {{ foo }}

    Jangan lakukan ini:

    {{foo}}

Gaya tampilan

  • Dalam tampilan Django, parameter pertama dalam sebuah fungsi tampilan harus dipanggil request.

    Lakukan ini:

    def my_view(request, foo):
    # ...

    Jangan lakukan ini:

    def my_view(req, foo):
    # ...

Gaya model

  • Nama-nama bidang harus semuanya huruf kecil, menggunakan garis bawah daripada camelCase.

    Lakukan ini:

    class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

    Jangan lakukan ini:

    class Person(models.Model):
    FirstName = models.CharField(max_length=20)
    Last_Name = models.CharField(max_length=40)

  • class Meta harus muncul setelah bidang ditentukan, dengan baris tunggal kosong memisahkan penentuan bidang-bidang dan kelas

    Lakukan ini:

    class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

    class Meta:
        verbose_name_plural = 'people'

    Jangan lakukan ini:

    class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)
    class Meta:
        verbose_name_plural = 'people'

    Jangan lakukan ini, salah satu:

    class Person(models.Model):
    class Meta:
        verbose_name_plural = 'people'

    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

  • Urutan model kelas-kelas sebelah dalam dan cara standar harus sebagai berikut (catat bahwa ini tidak wajib):

    • Semua bidang basisdata
    • Penyesuaian pengelolaan atribut
    • class Meta
    • def __str__()
    • def save()
    • def get_absolute_url()
    • Cara penyesuaian apapun

  • Jika choices ditentukan untuk bidang model diberikan, tentukan setiap pilihan sebagai tuple dari tuple-tuple, dengan nama semua huruf besar sebagai atribut kelas pada model. Contoh:

    class MyModel(models.Model):
    DIRECTION_UP = 'U'
    DIRECTION_DOWN = 'D'
    DIRECTION_CHOICES = (
        (DIRECTION_UP, 'Up'),
        (DIRECTION_DOWN, 'Down'),
    )

Penggunaan django.conf.settings

Modul-modul tidak harus dalam pengaturan penggunaan umum di django.conf.settings pada tingkatan atas (yaitu dinilai ketika modul diimpor). Penjelasan untuk ini adalah sebagai berikut:

Konfigurasi manual dari pengaturan (yaitu bergantung pada variabel lingkungan DJANGO_SETTINGS_MODULE`) diizinkan dan dimungkinkan sebagai berikut:

from django.conf import settings

settings.configure({}, SOME_SETTING='foo')

Bagaimanapun, jika tiap pengaturan diakses sebelum baris settings.configure, ini tidak akan bekerja (Secara internal, settings adalah LazyObject yang mengkonfigurasikan diri dia sendiri otomatis ketika pengaturan diakses jika dia belum dikonfigurasikan).

Jadi, jika terdapat modul mengandung beberapa kode sebagai berikut:

from django.conf import settings
from django.urls import get_callable

default_foo_view = get_callable(settings.FOO_VIEW)

...kemudian mengimpor modul ini akan menyebabkan pengaturan obyek untuk dikonfigurasi. Itu berarti bahwa kemampuan untuk pihak ketiga mengimpor modul pada tingkat atas tidak sesuai dengan kemampuan mengkonfigurasi pengaturan obyek secara manual, atau membuatnya sulit di beberapa keadaan.

Sebagai gantinya kode diatas, tingkatan kemalasan atau tipuan harus digunakan, seperti django.utils.functional.LazyObject, django.utils.functional.lazy() atau lambda.

Bermacam-macam

  • Tandai semua deretan karakter untuk internasionalisasi; lihat i18n documentation untuk rincian.
  • Pindahkan pernyataan import yang tidak lagi digunakan ketika anda merubah kode. flake8 akan mencirikan impor ini untuk anda. Jika impor tidak digunakan butuh tinggal untuk kesesuaian kebelakang, tandai akhir dengan # NOQA untuk membisukan peringatan flake8.
  • Secara teratur pindahkan semua ruang kosong dari kode anda dimana mereka menambahkan byte yang tidak dibutuhkan, tambah kekacauan penglihatan pada tambalan dan juga terkadang menyebabkan pertentangan penggabungan yang tidak diperlukan. Beberapa IDE dapat dikonfigurasikan otomatis memindahkan mereka dan kebanyakan alat-alat VCS dapat di setel untuk menyorot mereka di keluaran berbeda.
  • Harap jangan menaruh nama anda di kode anda sumbangkan. Kebijakan kami adalah menjaga nama-nama penyumbang di berkas AUTHORS disalurkan dengan Django -- bukan goresan melalui basis kode itu sendiri. Merasa bebas untuk menyertakan perubahan pada berkas AUTHORS di tambalan anda jika anda membuat lebih dari perubahan sepele tunggal.

Gaya JavaScript

Untuk rincian tentang gaya kode JavaScript digunakan oleh Django, lihat JavaScript.

Back to Top