PyCharm 自定义文件和代码模板

1. 引言

1.1 PyCharm 简介

PyCharm 是一个由 JetBrains 开发的专为 Python 语言设计的集成开发环境（IDE）。它提供了许多强大的功能，如智能代码补全、代码分析、以及一个功能强大的调试器。

1.2 文件模板与代码模板的重要性

文件模板和代码模板在开发过程中扮演着至关重要的角色。它们可以帮助开发者快速生成一致的代码结构，从而提高开发效率，确保代码的质量和风格的一致性。

---

2. 文件模板的基础知识

2.1 什么是文件模板？

文件模板是预定义的文件内容，可以为您提供一个开发项目或特定文件类型的基本框架。通过使用模板，开发者可以确保新创建的文件具有相同的基本结构和格式。

2.2 文件模板的默认结构

PyCharm 默认提供了多种文件模板，如 Python 类文件、测试文件等。这些模板已经为开发者提供了基本的文件结构，但也可以根据项目需求进行定制。

2.3 常用模板变量

以下是 PyCharm 中常用的模板变量，开发者可以在自己的模板中使用这些变量：对于 PyCharm 和其他 JetBrains IDE，存在一系列预定义的模板变量，这些变量可用于文件和代码模板。以下是一些常见的模板变量：

变量	描述
${NAME}	新建文件或类的名称
${USER}	当前用户名，这通常是从系统配置或VCS配置中获取的
${DATE}	当前日期
${TIME}	当前时间
${YEAR}	当前年份
${MONTH}	当前月份（数字）
${MONTH_NAME_FULL}	当前月份的全称（如January）
${MONTH_NAME_SHORT}	当前月份的简称（如Jan）
${DAY}	当月的当前日期（数字）
${HOUR}	当前小时
${MINUTE}	当前分钟
${PRODUCT_NAME}	IDE 的产品名称（例如 “PyCharm”）
${MONTH_NAME_SHORT}	当前月份的英文简写（例如“Jan”）

这只是一个简化列表，PyCharm 可能还有其他特定的变量或更深入的设置。

此外，除了预定义变量之外，用户还可以定义自己的自定义变量并在模板中使用。

---

3. 如何创建自定义的文件模板

3.1 创建自定义模板的步骤

为了在PyCharm中创建自定义文件模板，请按照以下步骤进行：

1. 打开PyCharm集成开发环境。
2. 在顶部菜单栏中，选择 “File”（文件）。
3. 从下拉菜单中选择 “Settings”（设置）或 “Preferences”（首选项）。
4. 在弹出的窗口中，找到 “Editor”（编辑器）部分。
5. 展开 “File and Code Templates”（文件和代码模板）选项。

在这里，您可以创建并编辑各种类型的文件模板，以满足您的开发需求。

3.2 设计自己的模板内容

1. 在左侧面板中选择所需的模板类型（例如，Python 文件）。
2. 在右侧的代码编辑器中，您可以编辑该模板的内容。您也可以利用上述提到的模板变量来自定义模板。

# -*- coding: utf-8 -*-
# -------------------------------

    # @软件：${PRODUCT_NAME}
    # @PyCharm：自行填入你的版本号
    # @Python：自行填入你的版本号
    # @项目：${PROJECT_NAME}

# -------------------------------

    # @文件：${NAME}.py
    # @时间：${DATE} ${TIME}
    # @作者：你的名称/当然你也可以使用命令获取计算机账户名称
    # @邮箱：你的邮箱账号

# -------------------------------

    ${PACKAGE_IMPORTS}
    
    ${BODY}

${PACKAGE_IMPORTS} 和 ${BODY} 是文件模板中的占位符，它们分别表示导入包和文件主体内容的位置。您可以根据需要选择是否保留它们。

• ${PACKAGE_IMPORTS}：这个占位符通常用于表示您在文件中需要导入的包或模块。如果您在文件中经常使用一些常见的导入，您可以在模板中包含这个占位符，以便每次创建文件时，这些导入语句会自动添加到文件顶部。如果您不需要预先导入包，可以在模板中删除这个占位符。
• ${BODY}：这个占位符表示文件的主体内容，即您实际写的代码部分。如果您希望每次创建文件时都有一些通用的代码结构，您可以在模板中包含这个占位符。如果不需要预先添加代码，可以将这个占位符删除。

在文件模板中，这些占位符的目的是为了在创建新文件时提供一些通用的结构或代码，从而加快开发过程。如果您觉得它们不适用于您的使用情况，完全可以将它们从模板中删除，以便在创建文件时获得更干净的起始状态。

当您将${PACKAGE_IMPORTS} 和 ${BODY} 替换为实际的导入和代码部分时，您的模板可能如下所示：

# -*- coding: utf-8 -*-
# -------------------------------

    # @软件：${PRODUCT_NAME}
    # @PyCharm：2021.1.3
    # @Python：3.9
    # @项目：${PROJECT_NAME}

# -------------------------------

    # @文件：${NAME}.py
    # @时间：${DATE} ${TIME}
    # @作者：鹅不糊涂
    # @邮箱：youle8109@gmail.com

 # -------------------------------

import requests
from bs4 import BeautifulSoup
import time

def scrape_baidu_page(url):
    headers = {
        'User-Agent': '"User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36"'  
    }
    
    
    with requests.Session() as session:
        response = session.get(url, headers=headers)
        
        if response.status_code == 200:
            soup = BeautifulSoup(response.content, 'html.parser')
            return soup.prettify()  
        else:
            return None

if __name__ == '__main__':
    baidu_url = 'https://www.baidu.com'
    html_source = scrape_baidu_page(baidu_url)
    
    if html_source:
        print(html_source)
    else:
        print("无法获取页面内容.")

3.3 保存和使用自定义模板

1. 保存您的更改。
2. 当您下次尝试创建一个新文件时，新的文件模板就会出现在选择列表中。