Please follow these coding standards when writing code for inclusion in Django.
\nPlease conform to the indentation style dictated in the .editorconfig\nfile. We recommend using a text editor with EditorConfig support to avoid\nindentation and whitespace issues. The Python files use 4 spaces for\nindentation and the HTML files use 2 spaces.
Unless otherwise specified, follow PEP 8.
\nUse flake8 to check for problems in this area. Note that our setup.cfg\nfile contains some excluded files (deprecated modules we don't care about\ncleaning up and some third-party code that Django vendors) as well as some\nexcluded errors that we don't consider as gross violations. Remember that\nPEP 8 is only a guide, so respect the style of the surrounding code as a\nprimary goal.
An exception to PEP 8 is our rules on line lengths. Don't limit lines of\ncode to 79 characters if it means the code looks significantly uglier or is\nharder to read. We allow up to 119 characters as this is the width of GitHub\ncode review; anything longer requires horizontal scrolling which makes review\nmore difficult. This check is included when you run flake8. Documentation,\ncomments, and docstrings should be wrapped at 79 characters, even though\nPEP 8 suggests 72.
Gunakan empat ruang untuk lekukan.
Gunakan garis bawah, bukan camelCase, untuk variabel, fungsi dan nama-nama cara (yaitu poll.get_unique_voters(), bukan poll.getUniqueVoters).
Use InitialCaps for class names (or for factory functions that\nreturn classes).
Dalam docstring, ikuti PEP 257. Sebagai contoh:
\ndef foo():\n """\n Calculate something and return the result.\n """\n ...\nIn tests, use assertRaisesMessage() instead\nof assertRaises() so you can check the exception\nmessage. Use assertRaisesRegex()\n(six.assertRaisesRegex() as long as we support Python 2) only if you need\nto use regular expression matching.
Gunakan isort untuk mengotomatisasi pengurutan impor menggunakan panduan dibawah.
\nMulai cepat:
\n$ pip install isort\n$ isort -rc .\nThis runs isort recursively from your current directory, modifying any\nfiles that don't conform to the guidelines. If you need to have imports out\nof order (to avoid a circular import, for example) use a comment like this:
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 import module\nstatements before from module import objects in each section. Use absolute\nimports for other Django components and relative imports for local components.
On each line, alphabetize the items with the upper case items grouped before\nthe lower case items.
Break long lines using parentheses and indent continuation lines by 4 spaces.\nInclude a trailing comma after the last import and put the closing\nparenthesis on its own line.
\nUse a single blank line between the last import and any module level code,\nand use two blank lines above the first function or class.
\nSebagai contoh (komentar hanya untuk tujuan penjelasan):
\ndjango/contrib/admin/example.py# future\nfrom __future__ import unicode_literals\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, HttpResponse, HttpResponseNotAllowed, StreamingHttpResponse,\n cookie,\n)\n\n# local Django\nfrom .models import LogEntry\n\n# try/except\ntry:\n import pytz\nexcept ImportError:\n pytz = None\n\nCONSTANT = 'foo'\n\n\nclass Example(object):\n # ...\nUse convenience imports whenever available. For example, do this:
\nfrom django.views.generic import View\ndari pada:
\nfrom django.views.generic.base import View\nDi kode cetakan Django, taruh satu (dan hanya satu) spasi diantara kurung keriting dan etiket isi.
\nLakukan ini:
\n{{ foo }}\nJangan lakukan ini:
\n{{foo}}\nDalam tampilan Django, parameter pertama dalam sebuah fungsi tampilan harus dipanggil request.
Lakukan ini:
\ndef my_view(request, foo):\n # ...\nJangan lakukan ini:
\ndef my_view(req, foo):\n # ...\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)\nThe class Meta should appear after the fields are defined, with\na single blank line separating the fields and the class definition.
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 first_name = models.CharField(max_length=20)\n last_name = models.CharField(max_length=40)\n class Meta:\n verbose_name_plural = 'people'\nJangan lakukan ini, salah satu:
\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)\nIf you define a __str__ method (previously __unicode__ before Python 3\nwas supported), decorate the model class with\npython_2_unicode_compatible().
The order of model inner classes and standard methods should be as\nfollows (noting that these are not all required):
\nSemua bidang basisdata
Custom manager attributes
class Meta
def __str__()
def save()
def get_absolute_url()
Cara penyesuaian apapun
If choices is defined for a given model field, define each choice as\na tuple of tuples, with an all-uppercase name as a class attribute on the\nmodel. Example:
class MyModel(models.Model):\n DIRECTION_UP = 'U'\n DIRECTION_DOWN = 'D'\n DIRECTION_CHOICES = (\n (DIRECTION_UP, 'Up'),\n (DIRECTION_DOWN, 'Down'),\n )\ndjango.conf.settingsLink to this heading#Modules should not in general use settings stored in django.conf.settings\nat the top level (i.e. evaluated when the module is imported). The explanation\nfor this is as follows:
Manual configuration of settings (i.e. not relying on the\nDJANGO_SETTINGS_MODULE environment variable) is allowed and possible as\nfollows:
from django.conf import settings\n\nsettings.configure({}, SOME_SETTING='foo')\nHowever, if any setting is accessed before the settings.configure line,\nthis will not work. (Internally, settings is a LazyObject which\nconfigures itself automatically when the settings are accessed if it has not\nalready been configured).
Jadi, jika terdapat modul mengandung beberapa kode sebagai berikut:
\nfrom django.conf import settings\nfrom django.core.urlresolvers import get_callable\n\ndefault_foo_view = get_callable(settings.FOO_VIEW)\n...then importing this module will cause the settings object to be configured.\nThat means that the ability for third parties to import the module at the top\nlevel is incompatible with the ability to configure the settings object\nmanually, or makes it very difficult in some circumstances.
\nInstead of the above code, a level of laziness or indirection must be used,\nsuch as django.utils.functional.LazyObject,\ndjango.utils.functional.lazy() or lambda.
Mark all strings for internationalization; see the i18n\ndocumentation for details.
Remove import statements that are no longer used when you change code.\nflake8 will identify these imports for you. If an unused import needs to\nremain for backwards-compatibility, mark the end of with # NOQA to\nsilence the flake8 warning.
Systematically remove all trailing whitespaces from your code as those\nadd unnecessary bytes, add visual clutter to the patches and can also\noccasionally cause unnecessary merge conflicts. Some IDE's can be\nconfigured to automatically remove them and most VCS tools can be set to\nhighlight them in diff outputs.
Please don't put your name in the code you contribute. Our policy is to\nkeep contributors' names in the AUTHORS file distributed with Django\n-- not scattered throughout the codebase itself. Feel free to include a\nchange to the AUTHORS file in your patch if you make more than a\nsingle trivial change.
Untuk rincian tentang gaya kode JavaScript digunakan oleh Django, lihat JavaScript.
\n