Django views/class 命名约定
Django views/class naming conventions
最近我将我的 IDE 更改为 PyCharm(以前是 Sublime),结果我所有的 views/classes 都被认为是坏的,因为它们的名称中有下划线 (_)。
我的django-rest项目视图如下:
# BuyersProject
path('bproject/', views.BP_List.as_view()), # Create BP | List user's BP
path('bproject/active/', views.BP_LastActive.as_view()), # Get last active BP
path('bproject/<int:pk>/', views.BP_Detail.as_view()), # Get specific BP
path('bproject/<int:pk>/filter/', views.BP_UpdateFilter.as_view()), # Update BP's filter
path('bproject/<int:pk>/step/', views.BP_StatusUpdate.as_view()), # BP status update
# BuyersProjectDetail
path('bproject/<int:pk>/detail/', views.BPD_List.as_view()), # BP's BPD List
path('bproject/detail/<int:pk>/', views.BPD_Detail.as_view()), # BPD Detail
path('bproject/detail/<int:pk>/close/', views.BPD_Close.as_view()), # Close BPD
# SellersProject
path('sproject/', views.SP_List.as_view()), # Create SP | List user's SP
path('sproject/<int:pk>/', views.SP_Detail.as_view()), # Get specific SP
path('sproject/<int:pk>/bc/', views.SP_BC_SellerUpdate.as_view()), # Update SP's BC
path('sproject/<int:pk>/step/', views.SP_StatusUpdate.as_view()), # SP status update
BP、BPD、SP、SPD 和 BC 是我的一些模型的首字母缩写词
我的问题:名字中有下划线真的那么糟糕吗?我应该重命名我的 类 以符合命名约定吗?
我坚信代码对于人类来说应该比机器更易读。
"Any fool can write code that a computer can understand. Good programmers write code that humans can understand.” – Martin Fowler
我非常关心文档、格式和代码 structure/conventions(在团队中工作时这非常重要)所以如果我当前的代码不好,我愿意改变。
此外,我们将不胜感激您对端点、视图名称或评论所做的任何 advice/comment。
PascalCase 中的项目通常没有 有下划线 (_
),即 snake_case,但是蛇形写成小写。
对于classes,PEP-8建议使用PerlCase:
Class names should normally use the CapWords convention.
所以应该是BPList
,而不是BP_List
。
此外,在 Django 中,基于 class 的视图通常具有 …View
后缀。所以你可能想将 BP_List
重命名为 BPListView
.
最近我将我的 IDE 更改为 PyCharm(以前是 Sublime),结果我所有的 views/classes 都被认为是坏的,因为它们的名称中有下划线 (_)。
我的django-rest项目视图如下:
# BuyersProject
path('bproject/', views.BP_List.as_view()), # Create BP | List user's BP
path('bproject/active/', views.BP_LastActive.as_view()), # Get last active BP
path('bproject/<int:pk>/', views.BP_Detail.as_view()), # Get specific BP
path('bproject/<int:pk>/filter/', views.BP_UpdateFilter.as_view()), # Update BP's filter
path('bproject/<int:pk>/step/', views.BP_StatusUpdate.as_view()), # BP status update
# BuyersProjectDetail
path('bproject/<int:pk>/detail/', views.BPD_List.as_view()), # BP's BPD List
path('bproject/detail/<int:pk>/', views.BPD_Detail.as_view()), # BPD Detail
path('bproject/detail/<int:pk>/close/', views.BPD_Close.as_view()), # Close BPD
# SellersProject
path('sproject/', views.SP_List.as_view()), # Create SP | List user's SP
path('sproject/<int:pk>/', views.SP_Detail.as_view()), # Get specific SP
path('sproject/<int:pk>/bc/', views.SP_BC_SellerUpdate.as_view()), # Update SP's BC
path('sproject/<int:pk>/step/', views.SP_StatusUpdate.as_view()), # SP status update
BP、BPD、SP、SPD 和 BC 是我的一些模型的首字母缩写词
我的问题:名字中有下划线真的那么糟糕吗?我应该重命名我的 类 以符合命名约定吗?
我坚信代码对于人类来说应该比机器更易读。
"Any fool can write code that a computer can understand. Good programmers write code that humans can understand.” – Martin Fowler
我非常关心文档、格式和代码 structure/conventions(在团队中工作时这非常重要)所以如果我当前的代码不好,我愿意改变。 此外,我们将不胜感激您对端点、视图名称或评论所做的任何 advice/comment。
PascalCase 中的项目通常没有 有下划线 (_
),即 snake_case,但是蛇形写成小写。
对于classes,PEP-8建议使用PerlCase:
Class names should normally use the CapWords convention.
所以应该是BPList
,而不是BP_List
。
此外,在 Django 中,基于 class 的视图通常具有 …View
后缀。所以你可能想将 BP_List
重命名为 BPListView
.