Python, Django Coding Convention


Coding Convention
私だけが理解できるコードは悪いコードです.
他の開発者も分かりやすいコードが良いコードです.
クラス(Class)
class http_request
  • X
  • class HttpRequest
  • O
  • 大文字・小文字ともに使用
  • 大文字は単語の区別に用いられ、単語の最初の文字だけは大文字
  • 名詞のみからなる
  • _無効
  • モジュール
    import json
    import re
    
    from django.http import JsonResponse
    from django.views import View
    from users.models import User
  • X
  • import json
    import re
    
    from django.http import JsonResponse
    from django.views import View
    
    from users.models import User
  • O
  • Djangoが提供するモジュールは直接生成したモジュールとは別である.
  • 空行は関連する論理単位で挿入する.
  • コードの配置
    class User(models.Model):
        name = models.CharField(max_length=45)
        email = models.CharField(max_length=100)
        password = models.CharField(max_length=100)
        mobile = models.CharField(max_length=100)
        address = models.CharField(max_length=100)
        birth_date = models.DateField()
  • X
  • class User(models.Model):
        name       = models.CharField(max_length=45)
        email      = models.CharField(max_length=100)
        password   = models.CharField(max_length=100)
        mobile     = models.CharField(max_length=100)
        address    = models.CharField(max_length=100)
        birth_date = models.DateField()
  • O
  • 4/457,7917、和弦が調えると、和弦がきれいに見えます.
  • コードの可読性を向上させる.
  • 最長の変数名を基準とした変数名
  • 表の名前
    class Meta:
    	db_table = "user"
  • X
  • class Meta:
    	db_table = "users"
  • データベース表名は小文字、複数形指定
  • アプリケーション名
    python manage.py startapp user
  • X
  • python manage.py startapp users
  • アプリケーション名が複数