如何让PyCharm为自定义函数的Django模板路径参数启用自动补全？

问题 #

在PyCharm中，Django内置功能里最终会作为resolve_template参数的模板路径（例如TemplateView的template_name属性、include模板标签的参数），PyCharm会依据Django模板查找语法提供自动补全建议和值警告。我有一个包含模板名称参数的自定义函数，能否通过注解该函数，让PyCharm在调用此函数时，像处理内置模板名称参数一样提供模板目录自动补全建议？

解决方法 #

可以通过类型注解实现，以下是两种可靠方式：

方式一：使用django-stubs的专用类型注解 #

1. 先安装django-stubs包：

pip install django-stubs

2. 在自定义函数中导入并使用TemplateName类型标注模板参数：

from django_stubs_ext import TemplateName

def render_custom_template(template_name: TemplateName):
    # 自定义逻辑，比如调用resolve_template处理路径
    pass

这种方式是官方推荐的类型标注方案，PyCharm能直接识别TemplateName类型，自动关联项目中的模板目录，提供和内置参数一致的补全、路径校验功能。

方式二：使用PyCharm专属注释标记 #

如果不想额外安装依赖，可通过PyCharm识别的特殊注释标记参数类型：

def render_custom_template(template_name):
    # type: (django.template.backends.django.Template) -> None
    # 函数逻辑
    pass

不过这种方式的精准度略低于TemplateName注解，建议优先选择第一种方案。

额外注意事项 #

• 确保PyCharm已启用Django插件（在Settings > Plugins中确认）
• 项目的Django配置已正确设置模板目录路径（Settings > Languages & Frameworks > Django > Template Directories）

内容的提问来源于stack exchange，提问作者Grace Whitney