BETA

DjangoでのMy命名規則

投稿日:2020-03-14
最終更新:2020-03-14

命名規則を決めておく。
不都合が生じたら、修正。

URL pattern

  • ハイフンは入れない
# path('path-to/file', ...) # NG: ハイフンは入れない  

URL pattern name

  • ルートはtop
  • URL pathのスラッシュをハイフンにする
  • <username>などのCaptured parametersは、キャプチャ名を使用
  • <pk>などのオブジェクトが一意に識別できるものはキャプチャ名でなくdetail
# 引数nameの規則  
path('', ..., name='top')  
path('path/to/dir', ..., name='paht-to-dir')  
path('path/to/dir/file', ..., name='paht-to-dir-file')  
path('user/<nickname>', ..., name='user-nickname')  
path('user/<user_id>/profile/<pk>', ..., name='user-detail-profile-detail')  

View class name

URL pattern nameをハイフンで分割、CamelCaseになるように連結して終わりにView。

>>> url_pattern_name = 'path-to-file'  
>>> ''.join(map(str.title, url_pattern_name.split('-'))) + 'View'  
'PathToFileView'  

example)

class PathToFileView(View):  
    pass  

...  

class UserDetailProfileDetailView(View):  
    pass  

Template file path

URL pattern nameのハイフンをスラッシュにし、.htmlつける。

>>> url_pattern_name = 'path-to-dir-file'  
>>> '/'.join(url_pattern_name.split('-')) + '.html'  
'path/to/dir/file.html'  

Model field name

type naming rule example
date _date created_date
datetime _at created_at
flag is_ is_active, is_deleted
long text _text episode_text
name _name user_name
数値 _num sort_num
個数 _count user_count
種別 _kind novel_kind
状態 _status commit_status
OneToOneField.related_name singular(field name also singular) user = OneToOneField(User, related_name='item')
ForeignKeyField.related_name plural(field name is singular) user =ForeignKeyField(User, related_name='items')
ManyToManyField.related_name plural(field name also plural) users = OneToOneField(User, related_name='items')
技術ブログをはじめよう Qrunch(クランチ)は、プログラマの技術アプトプットに特化したブログサービスです
駆け出しエンジニアからエキスパートまで全ての方々のアウトプットを歓迎しております!
or 外部アカウントで 登録 / ログイン する
クランチについてもっと詳しく

この記事が掲載されているブログ

@nippon1novelの技術ブログ

よく一緒に読まれる記事

0件のコメント

ブログ開設 or ログイン してコメントを送ってみよう