Silahkan ikuti standar pengkodean ini ketika menulis kode untuk penyertaan di Django.
\npre-commit is a framework for managing pre-commit\nhooks. These hooks help to identify simple issues before committing code for\nreview. By checking for these issues before code review it allows the reviewer\nto focus on the change itself, and it can also help to reduce the number of CI\nruns.
\nUntuk menggunakan alat, pertama pasang pre-commit dan kemudian kait git:
Linux / macOS
$ python -m pip install pre-commit\n$ pre-commit install\nWindows
...\\> py -m pip install pre-commit\n...\\> pre-commit install\nOn the first commit pre-commit will install the hooks, these are\ninstalled in their own environments and will take a short while to\ninstall on the first run. Subsequent checks will be significantly faster.\nIf an error is found an appropriate error message will be displayed.\nIf the error was with black or isort then the tool will go ahead and\nfix them for you. Review the changes and re-stage for commit if you are happy\nwith them.
All files should be formatted using the black auto-formatter. This\nwill be run by pre-commit if that is configured.
The project repository includes an .editorconfig file. We recommend using\na text editor with EditorConfig support to avoid indentation and\nwhitespace issues. The Python files use 4 spaces for indentation and the HTML\nfiles use 2 spaces.
Meskipun sebaliknya ditentukan, ikuti PEP 8.
\nUse flake8 to check for problems in this area. Note that our\n.flake8 file excludes some errors that we don't consider as gross\nviolations. Remember that PEP 8 is only a guide, so respect the style of\nthe surrounding code as a primary goal.
An exception to PEP 8 is our rules on line lengths. We allow up to 88\ncharacters in code, as this is the line length used by black.\nDocumentation, comments, and docstrings should be wrapped at 79 characters.\nThese limits are checked when flake8 is run.
String variable interpolation may use\n%-formatting, f-strings, or str.format() as appropriate, with the goal of\nmaximizing code readability.
Final judgments of readability are left to the Merger's discretion. As a\nguide, f-strings should use only plain variable and property access, with\nprior local variable assignment for more complex cases:
\n# Allowed\nf"hello {user}"\nf"hello {user.name}"\nf"hello {self.user.name}"\n\n# Disallowed\nf"hello {get_user()}"\nf"you are {user.age * 365.25} days old"\n\n# Allowed with local variable assignment\nuser = get_user()\nf"hello {user}"\nuser_days_old = user.age * 365.25\nf"you are {user_days_old} days old"\nf-strings should not be used for any string that may require translation,\nincluding error and logging messages. In general format() is more\nverbose, so the other formatting methods are preferred.
Don't waste time doing unrelated refactoring of existing code to adjust the\nformatting method.
\nHindari 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() dan assertWarnsMessage() daripada assertRaises() dan assertWarns() sehingga anda dapat memeriksa pengecualian atau pesan peringatan. Hanya gunakan assertRaisesRegex() dan assertWarnsRegex() jika anda butuh pencocokan regular expression.
Gunakan assertIs(…, True/False) untuk pengujian nilai boolean, daripada assertTrue() dan assertFalse(), sehingga anda dapat memeriksa nilai boolean sebenarnya, bukan kebenaran dari pernyataan.
Dalam docstring percobaan, nyatakan perilaku yang diharapkan yang setiap percobaan ditunjukkan. Jangan menyertakan pembukaan seperti "Tests that" atau "Ensures that".
\nAcuan 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:
\ndef test_foo():\n """\n A test docstring looks like this (#123456).\n """\n ...\nWhere applicable, use unpacking generalizations compliant with PEP 448,\nsuch as merging mappings ({**x, **y}) or sequences ([*a, *b]). This\nimproves performance, readability, and maintainability while reducing errors.
Gunakan isort untuk mengotomatisasi pengurutan impor menggunakan panduan dibawah.
\nMulai cepat:
\nLinux / macOS
$ python -m pip install "isort >= 7.0.0"\n$ isort .\nWindows
...\\> py -m pip install "isort >= 7.0.0"\n...\\> isort .\nIni 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\nPut imports in these groups: future, standard library, third-party libraries,\nother Django components, local Django component, try/excepts. Sort lines in\neach group alphabetically by the full module name. Place all\nimport module statements before from module import objects in each\nsection. Use absolute imports for other Django components and a one-dot\nrelative import (from .foo import Bar) for local components. Avoid\nmulti-dot relative imports.
Pada setiap baris, mengabjadkan barang dengan barang huruf besar dikelompokkan sebelum 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.
\nGunakan baris kosong tunggal diantara impor terakhir dan tiap modul kode tingkatan, dan gunakan dua baris kosong diatas fungsi atau kelas pertama.
\nSebagai contoh (komentar hanya untuk tujuan penjelasan):
\ndjango/contrib/admin/example.py# future\nfrom __future__ import annotations\n\n# standard library\nimport json\nfrom itertools import chain\n\n# third-party\nimport bcrypt\n\n# Django\nfrom django.http import Http404\nfrom django.http.response import (\n Http404,\n HttpResponse,\n HttpResponseNotAllowed,\n StreamingHttpResponse,\n cookie,\n)\n\n# local Django\nfrom .models import LogEntry\n\n# try/except\ntry:\n import yaml\nexcept ImportError:\n yaml = None\n\nCONSTANT = "foo"\n\n\nclass Example: ...\nGunakan impor praktis kapan pun tersedia. Misalnya, lakukan ini
\nfrom django.views import View\ndari pada:
\nfrom django.views.generic.base import View\nIkuti aturan dibawah ini dalam kode cetakan Django.
\n{% extends %} harus menjadi baris non-komentar pertama.
Lakukan ini:
\n{% extends "base.html" %}\n\n{% block content %}\n <h1 class="font-semibold text-xl">\n {{ pages.title }}\n </h1>\n{% endblock content %}\nAtau ini:
\n{# This is a comment #}\n{% extends "base.html" %}\n\n{% block content %}\n <h1 class="font-semibold text-xl">\n {{ pages.title }}\n </h1>\n{% endblock content %}\nJangan lakukan ini:
\n{% load i18n %}\n{% extends "base.html" %}\n\n{% block content %}\n <h1 class="font-semibold text-xl">\n {{ pages.title }}\n </h1>\n{% endblock content %}\nTaruh tepatnya satu ruang diantara {{, konteks variabel, dan }}.
Lakukan ini:
\n{{ user }}\nJangan lakukan ini:
\n{{user}}\nDi {% muat ... %}, daftar pustaka dalam urutan alfabet.
Lakukan ini:
\n{% load i18n l10 tz %}\nJangan lakukan ini:
\n{% load l10 i18n tz %}\nPut exactly one space between {%, tag contents, and %}.
Lakukan ini:
\n{% load humanize %}\nJangan lakukan ini:
\n{%load humanize%}\nPut the {% block %} tag name in the {% endblock %} tag if it is not\non the same line.
Lakukan ini:
\n{% block header %}\n\n Code goes here\n\n{% endblock header %}\nJangan lakukan ini:
\n{% block header %}\n\n Code goes here\n\n{% endblock %}\nInside curly braces, separate tokens by single spaces, except for around the\n. for attribute access and the | for a filter.
Lakukan ini:
\n{% if user.name|lower == "admin" %}\nJangan lakukan ini:
\n{% if user . name | lower == "admin" %}\n\n{{ user.name | upper }}\nWithin a template using {% extends %}, avoid indenting top-level\n{% block %} tags.
Lakukan ini:
\n{% extends "base.html" %}\n\n{% block content %}\nJangan lakukan ini:
\n{% extends "base.html" %}\n\n {% block content %}\n ...\nDalam tampilan Django, parameter pertama dalam sebuah fungsi tampilan harus dipanggil request.
Lakukan ini:
\ndef my_view(request, foo): ...\nJangan lakukan ini:
\ndef my_view(req, foo): ...\nNama-nama bidang harus semuanya huruf kecil, menggunakan garis bawah daripada camelCase.
\nLakukan ini:
\nclass Person(models.Model):\n first_name = models.CharField(max_length=20)\n last_name = models.CharField(max_length=40)\nJangan lakukan ini:
\nclass Person(models.Model):\n FirstName = models.CharField(max_length=20)\n Last_Name = models.CharField(max_length=40)\nclass Meta harus muncul setelah bidang ditentukan, dengan baris tunggal kosong memisahkan penentuan bidang-bidang dan kelas
Lakukan ini:
\nclass Person(models.Model):\n first_name = models.CharField(max_length=20)\n last_name = models.CharField(max_length=40)\n\n class Meta:\n verbose_name_plural = "people"\nJangan lakukan ini:
\nclass Person(models.Model):\n class Meta:\n verbose_name_plural = "people"\n\n first_name = models.CharField(max_length=20)\n last_name = models.CharField(max_length=40)\nUrutan model kelas-kelas sebelah dalam dan cara standar harus sebagai berikut (catat bahwa ini tidak wajib):
\nSemua bidang basisdata
Penyesuaian pengelolaan atribut
class Meta
def __str__() dan metode ajaib Python lainnya
def save()
def get_absolute_url()
Cara penyesuaian apapun
If choices is defined for a given model field, define each choice as a\nmapping, with an all-uppercase name as a class attribute on the model.\nExample:
class MyModel(models.Model):\n DIRECTION_UP = "U"\n DIRECTION_DOWN = "D"\n DIRECTION_CHOICES = {\n DIRECTION_UP: "Up",\n DIRECTION_DOWN: "Down",\n }\nAlternatifnya, pertimbangkan menggunakan Enumeration types:
\nclass MyModel(models.Model):\n class Direction(models.TextChoices):\n UP = "U", "Up"\n DOWN = "D", "Down"\ndjango.conf.settingsLink to this heading#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:
Manual configuration of settings (i.e. not relying on the\nDJANGO_SETTINGS_MODULE environment variable) is allowed and possible\nas follows:
from django.conf import settings\n\nsettings.configure({}, SOME_SETTING="foo")\nBagaimanapun, 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:
\nfrom django.conf import settings\nfrom django.urls import get_callable\n\ndefault_foo_view = get_callable(settings.FOO_VIEW)\n...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.
\nSebagai gantinya kode diatas, tingkatan kemalasan atau tipuan harus digunakan, seperti django.utils.functional.LazyObject, django.utils.functional.lazy() atau lambda.
Tandai semua deretan karakter untuk internasionalisasi; lihat i18n documentation untuk rincian.
Remove import statements that are no longer used when you change code.\nflake8 will identify these imports for you. If an unused import needs\nto remain for backwards-compatibility, mark the end of with # NOQA to\nsilence the flake8 warning.
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.
For details about the JavaScript code style used by Django, see\nKode JavaScript.
\n