PyCharm文件模板配置的完整指南
更新時間：2025年07月28日 09:09:39 作者：Yant224
這篇文章主要介紹了PyCharm文件模板配置的全流程,涵蓋模板創(chuàng)建、變量使用（如日期、用戶名）、LiveTemplates設置、團隊共享及最佳實踐,通過統(tǒng)一代碼結構提升開發(fā)效率,需要的朋友可以參考下
實現(xiàn)創(chuàng)建文件時自動添加自定義模板
一、完整配置流程
1. 打開模板設置
2. 配置全局模板
在 File and Code Templates 界面：
- Files 標簽頁：設置各類文件模板
- Includes 標簽頁：創(chuàng)建可復用的模板片段
- Code 標簽頁：設置代碼片段模板
3. 創(chuàng)建 Python 文件模板
#!/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()
4. 添加自定義變量
| 變量 | 描述 | 示例 |
|---|---|---|
| ${DATE} | 當前日期 | 2023-07-26 |
| ${TIME} | 當前時間 | 14:30 |
| ${USER} | 系統(tǒng)用戶名 | john |
| ${NAME} | 文件名（不含擴展名） | my_script |
| ${PRODUCT_NAME} | PyCharm 產品名 | PyCharm |
| ${YEAR} | 當前年份 | 2023 |
| ${MONTH} | 當前月份 | 07 |
| ${DAY} | 當前日期 | 26 |
| ${HOUR} | 當前小時 | 14 |
| ${MINUTE} | 當前分鐘 | 30 |
5. 創(chuàng)建 Django 模型模板
# ${NAME}.py
from django.db import models
class ${ModelName}(models.Model):
"""${Description}"""
# 字段定義
created_at = models.DateTimeField(auto_now_add=True, verbose_name='創(chuàng)建時間')
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}"
# 以下為自動生成的代碼
二、高級模板配置
1. 創(chuàng)建模板片段（Includes）
# File Header.py """ test includes """
2. 使用模板片段
# Python Script
#parse("File Header.py")
import os
import sys
def main():
pass
if __name__ == '__main__':
main()
3. 條件模板
#if (${NAME} == "models")
from django.db import models
#else
import os
import sys
#end
4. 自定義變量
#set($ModelName = ${NAME.substring(0,1).toUpperCase()} + ${NAME.substring(1)})
class ${ModelName}(models.Model):
pass
三、模板示例集
1. Django View 模板
#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)
2. Django Form 模板
#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
3. Django ModelAdmin 模板
#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')
}),
)
四、自動生成工具
1. 使用 Live Templates
# 創(chuàng)建 Django 模型字段模板 # Abbreviation: df # Description: Django field # Template text: $FIELD_NAME$ = models.$FIELD_TYPE$($PARAMS$)
2. 配置 Live Templates
打開 Settings > Editor > Live Templates
創(chuàng)建 Python 組
添加新模板：
- Abbreviation:
df - Description:
Django field - Template text:
${FIELD_NAME} = models.${FIELD_TYPE}(${PARAMS})
定義變量：
- FIELD_NAME:
suggestVariableName() - FIELD_TYPE:
complete() - PARAMS:
defaultValue("")
五、團隊共享模板
1. 導出模板
2. 導入模板
3. 版本控制
# 模板文件位置 ~/.config/JetBrains/PyCharm2023.1/templates
六、模板變量全集
| 變量 | 描述 | 示例 |
|---|---|---|
| ${NAME} | 文件名（不含擴展名） | my_view |
| ${PACKAGE_NAME} | 包名 | myapp.views |
| ${PROJECT_NAME} | 項目名 | MyDjangoProject |
| ${USER} | 當前用戶 | john |
| ${DATE} | 當前日期 | 2023-07-26 |
| ${TIME} | 當前時間 | 14:30 |
| ${YEAR} | 當前年份 | 2023 |
| ${MONTH} | 當前月份 | 07 |
| ${DAY} | 當前日期 | 26 |
| ${HOUR} | 當前小時 | 14 |
| ${MINUTE} | 當前分鐘 | 30 |
| ${SECOND} | 當前秒數(shù) | 45 |
| ${PRODUCT_NAME} | IDE 名稱 | PyCharm |
| ${MONTH_NAME_FULL} | 月份全名 | July |
| ${MONTH_NAME_SHORT} | 月份縮寫 | Jul |
| ${DS} | 美元符號 | $ |
七、最佳實踐建議
1. 模板設計原則
- 簡潔性：只包含必要元素
- 一致性：團隊統(tǒng)一模板風格
- 實用性：包含常用導入和結構
- 可擴展性：使用 Includes 片段
2. 推薦模板結構
# 文件頭
#parse("File Header.py")
# 導入區(qū)
import os
import sys
# 主邏輯
def main():
pass
# 執(zhí)行入口
if __name__ == '__main__':
main()
3. 動態(tài)模板技巧
#if (${PACKAGE_NAME} == "models")
from django.db import models
#elseif (${PACKAGE_NAME} == "views")
from django.views import View
#end
八、常見問題解決
1. 模板不生效
- 檢查文件類型匹配
- 確認模板名稱正確
- 重啟 PyCharm
2. 變量不解析
- 使用正確的大寫格式
${VAR} - 檢查變量名拼寫
- 確保變量在作用域內
3. 多級目錄模板
# 在特定目錄創(chuàng)建模板 # 右鍵目錄 > New > Edit File Templates
總結
配置 PyCharm 文件模板的完整流程：
- 打開設置：
File > Settings > Editor > File and Code Templates - 選擇文件類型：在 Files 標簽頁選擇 Python Script
- 編寫模板：使用變量和邏輯控制
- 添加 Includes：創(chuàng)建可復用片段
- 保存應用：點擊 OK 保存設置
高級技巧：
- 使用
#parse指令組合模板 - 通過
#if實現(xiàn)條件模板 - 用
#set定義自定義變量 - 配置 Live Templates 快速生成代碼片段
通過合理配置模板，您可以：
- 統(tǒng)一代碼風格
- 減少重復工作
- 提高開發(fā)效率
- 確保最佳實踐
以上就是PyCharm文件模板配置的完整指南的詳細內容，更多關于PyCharm文件模板配置的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了基于opencv對高空拍攝視頻消抖處理,首先對視頻進行抽第一幀與最后一幀，為什么抽取兩幀?這樣做的主要目的是，我們在做幀對齊時，使用幀中靜態(tài)物的關鍵點做對齊，需要的朋友可以參考下2022-10-10
這篇文章主要介紹了Python動刷新12306火車票的完整代碼,非常不錯,具有參考借鑒價值,需要的朋友參考下吧2018-01-01
這篇文章主要介紹了Python快速生成隨機密碼，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-08-08
如何使用 Pylint 來規(guī)范 Python 代碼風格(來自IBM)
本文通過詳細的理論介紹和簡單易懂的實例全面介紹了 Python 代碼分析工具 Pylint。相信讀者看完后一定可以輕松地將 Pylint 運用到自己的開發(fā)工程中2018-04-04
Pycharm下載pyinstaller報錯:You?should?consider?upgrading?via
這篇文章主要給大家介紹了關于Pycharm下載pyinstaller報錯：You?should?consider?upgrading?via?the?'python?-m?pip?install?--upgrade?pip'?command的解決方法,需要的朋友可以參考下2022-02-02
這篇文章主要介紹了python函數(shù)之任意數(shù)量的實參方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-02-02
這篇文章主要介紹了Python多線程與異步處理在HTTP請求中的應用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
解決pytorch 損失函數(shù)中輸入輸出不匹配的問題
這篇文章主要介紹了解決pytorch 損失函數(shù)中輸入輸出不匹配的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-06-06
Django中STATIC_ROOT和STATIC_URL及STATICFILES_DIRS淺析
這篇文章主要給大家介紹了關于Django中STATIC_ROOT和STATIC_URL及STATICFILES_DIRS的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面來一起看看吧2018-05-05
這篇文章主要介紹了Pytest之Fixture參數(shù)詳解及使用,本文結合實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-01-01