PyCharm文件模板配置的完整指南

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : ${DATE} ${TIME}
# @Author  : ${USER}
# @File    : ${NAME}.py
# @Software: ${PRODUCT_NAME}

"""
${DESCRIPTION}
"""

import os
import sys

def main():
    pass

if __name__ == '__main__':
    main()

# ${NAME}.py
from django.db import models

class ${ModelName}(models.Model):
    """${Description}"""
    
    # 字段定义
    created_at = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')
    updated_at = models.DateTimeField(auto_now=True, verbose_name='更新时间')
    
    class Meta:
        verbose_name = '${VerboseName}'
        verbose_name_plural = '${VerboseNamePlural}'
        ordering = ['-created_at']
        
    def __str__(self):
        return f"{self.id}"

# 以下为自动生成的代码

# File Header.py
"""
test includes
"""

# Python Script
#parse("File Header.py")

import os
import sys

def main():
    pass

if __name__ == '__main__':
    main()

#if (${NAME} == "models")
from django.db import models
#else
import os
import sys
#end

#set($ModelName = ${NAME.substring(0,1).toUpperCase()} + ${NAME.substring(1)})
class ${ModelName}(models.Model):
    pass

#parse("File Header.py")

from django.views import View
from django.http import JsonResponse

class ${ClassName}(View):
    """${Description}"""
    
    def get(self, request, *args, **kwargs):
        return JsonResponse({'status': 'ok'})
    
    def post(self, request, *args, **kwargs):
        return JsonResponse({'status': 'created'}, status=201)

#parse("File Header.py")

from django import forms

class ${FormName}(forms.Form):
    """${Description}"""
    
    # 字段示例
    name = forms.CharField(
        max_length=100,
        label='名称',
        widget=forms.TextInput(attrs={'class': 'form-control'})
    )
    
    def clean_name(self):
        # 自定义验证
        name = self.cleaned_data['name']
        if len(name) < 3:
            raise forms.ValidationError("名称太短")
        return name

#parse("File Header.py")

from django.contrib import admin
from .models import ${ModelName}

@admin.register(${ModelName})
class ${ModelName}Admin(admin.ModelAdmin):
    """${Description}"""
    
    list_display = ('id', 'created_at')
    list_filter = ('created_at',)
    search_fields = ('id',)
    date_hierarchy = 'created_at'
    
    fieldsets = (
        (None, {
            'fields': ('created_at', 'updated_at')
        }),
    )

# 创建 Django 模型字段模板
# Abbreviation: df
# Description: Django field
# Template text:
$FIELD_NAME$ = models.$FIELD_TYPE$($PARAMS$)

${FIELD_NAME} = models.${FIELD_TYPE}(${PARAMS})

# 模板文件位置
~/.config/JetBrains/PyCharm2023.1/templates

# 文件头
#parse("File Header.py")

# 导入区
import os
import sys

# 主逻辑
def main():
    pass

# 执行入口
if __name__ == '__main__':
    main()

#if (${PACKAGE_NAME} == "models")
from django.db import models
#elseif (${PACKAGE_NAME} == "views")
from django.views import View
#end

# 在特定目录创建模板
# 右键目录 > New > Edit File Templates