为 forms.py 添加注释

pull/22/head
djq 4 months ago
parent 86c19ec71c
commit 02cfa52e76

@ -1,4 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="Black">
<option name="sdkName" value="Python 3.12" />
</component>
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.12" project-jdk-type="Python SDK" />
</project>

@ -4,7 +4,11 @@
<option name="autoReloadType" value="SELECTIVE" />
</component>
<component name="ChangeListManager">
<list default="true" id="cf1e79d1-38c9-4d6d-b8e3-dfa5a3810da4" name="更改" comment="nch注释" />
<list default="true" id="cf1e79d1-38c9-4d6d-b8e3-dfa5a3810da4" name="更改" comment="nch注释">
<change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/software-engineering-methodology-djq-branch(2)/software-engineering-methodology/src/DjangoBlog-master(1)/DjangoBlog-master/blog/forms.py" beforeDir="false" afterPath="$PROJECT_DIR$/software-engineering-methodology-djq-branch(2)/software-engineering-methodology/src/DjangoBlog-master(1)/DjangoBlog-master/blog/forms.py" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
@ -41,7 +45,7 @@
"RunOnceActivity.TerminalTabsStorage.copyFrom.TerminalArrangementManager.252": "true",
"RunOnceActivity.git.unshallow": "true",
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
"git-widget-placeholder": "develop",
"git-widget-placeholder": "zjp__branch",
"ignore.virus.scanning.warn.message": "true",
"last_opened_file_path": "D:/软件工程方法学/software-engineering-methodology-nch-branch"
}

@ -1,19 +1,42 @@
# 导入日志模块,用于记录搜索相关日志信息
import logging
# 导入Django的表单基础类用于构建自定义表单
from django import forms
# 导入Haystack的搜索表单基类扩展其功能实现自定义搜索
from haystack.forms import SearchForm
# 获取当前模块的日志记录器,用于记录搜索操作日志
logger = logging.getLogger(__name__)
class BlogSearchForm(SearchForm):
"""
博客搜索表单类继承自Haystack的SearchForm
用于自定义博客内容的搜索表单和搜索逻辑
"""
# 定义搜索关键词输入字段required=True表示该字段为必填项
# 用于接收用户输入的搜索关键词
querydata = forms.CharField(required=True)
def search(self):
"""
重写父类的search方法自定义搜索逻辑
实现基于用户输入关键词的博客内容搜索
"""
# 调用父类的search方法获取初始的搜索结果集
# 父类方法会处理基本的搜索逻辑
datas = super(BlogSearchForm, self).search()
# 检查表单数据是否有效(如是否填写了搜索关键词)
# 若无效,返回无搜索结果的默认处理
if not self.is_valid():
return self.no_query_found()
# 如果表单验证通过且存在有效的搜索关键词
if self.cleaned_data['querydata']:
# 将用户输入的搜索关键词记录到日志中,便于后续分析搜索行为
logger.info(self.cleaned_data['querydata'])
return datas
# 返回处理后的搜索结果集
return datas# 查看工作区修改的文件,确认包含你添加注释的文件
Loading…
Cancel
Save