标签,执行replacer回调函数
+ # 返回处理后的文章内容
return link_pattern.sub(replacer, content)
-plugin = ExternalLinksPlugin()
+# 实例化插件类,使插件系统能识别并加载该插件
+plugin = ExternalLinksPlugin()
\ No newline at end of file
diff --git a/plugins/reading_time/plugin.py b/plugins/reading_time/plugin.py
index 35f9db1..6cf9a7f 100644
--- a/plugins/reading_time/plugin.py
+++ b/plugins/reading_time/plugin.py
@@ -1,43 +1,69 @@
+# 导入数学运算模块,用于向上取整计算
import math
+# 导入正则表达式模块,用于处理HTML内容和文本分词
import re
+# 导入Django博客插件基类,当前插件需继承此类
from djangoblog.plugin_manage.base_plugin import BasePlugin
+# 导入插件钩子管理模块,用于注册插件功能
from djangoblog.plugin_manage import hooks
+# 导入文章内容钩子常量,指定插件作用的位置
from djangoblog.plugin_manage.hook_constants import ARTICLE_CONTENT_HOOK_NAME
class ReadingTimePlugin(BasePlugin):
+ # 插件名称,用于插件管理界面展示
PLUGIN_NAME = '阅读时间预测'
+ # 插件功能描述,说明核心作用
PLUGIN_DESCRIPTION = '估算文章阅读时间并显示在文章开头。'
+ # 插件版本号
PLUGIN_VERSION = '0.1.0'
+ # 插件作者信息
PLUGIN_AUTHOR = 'liangliangyy'
def register_hooks(self):
+ """注册插件钩子,将处理方法绑定到文章内容钩子"""
+ # 当文章内容被渲染时,触发add_reading_time方法
hooks.register(ARTICLE_CONTENT_HOOK_NAME, self.add_reading_time)
def add_reading_time(self, content, *args, **kwargs):
"""
- 计算阅读时间并添加到内容开头。
+ 计算文章阅读时间并添加到内容开头
+
+ 参数:
+ content: 文章原始HTML内容
+ *args, **kwargs: 预留参数,用于接收额外信息
+ 返回:
+ 添加了阅读时间信息的HTML内容
"""
- # 移除HTML标签和空白字符,以获得纯文本
+ # 1. 清理内容:使用正则移除所有HTML标签(<...>格式),保留纯文本
clean_content = re.sub(r'<[^>]*>', '', content)
+ # 移除文本前后的空白字符(空格、换行等)
clean_content = clean_content.strip()
-
- # 中文和英文单词混合计数的一个简单方法
- # 匹配中文字符或连续的非中文字符(视为单词)
+
+ # 2. 计数单词/字符:
+ # 正则匹配规则:匹配单个中文字符([\u4e00-\u9fa5])或连续的非中文字符(视为英文单词,\w+)
+ # 这样处理中英文混合的内容,兼顾两种语言的计数逻辑
words = re.findall(r'[\u4e00-\u9fa5]|\w+', clean_content)
+ # 统计匹配到的元素数量(中文按单个字算,英文按单词算)
word_count = len(words)
-
- # 按平均每分钟200字的速度计算
+
+ # 3. 计算阅读时间:
+ # 设定平均阅读速度为每分钟200字(中英文通用的经验值)
reading_speed = 200
+ # 总字数除以阅读速度,向上取整得到分钟数
reading_minutes = math.ceil(word_count / reading_speed)
- # 如果阅读时间少于1分钟,则显示为1分钟
+ # 处理边界情况:如果计算结果小于1分钟,强制显示为1分钟
if reading_minutes < 1:
reading_minutes = 1
-
+
+ # 4. 生成阅读时间的HTML片段:
+ # 使用浅灰色文字,斜体样式,显示在段落中
reading_time_html = f'预计阅读时间:{reading_minutes} 分钟
'
-
+
+ # 将阅读时间信息添加到文章内容开头并返回
return reading_time_html + content
-plugin = ReadingTimePlugin()
\ No newline at end of file
+# 实例化插件,使插件系统能够识别并加载
+plugin = ReadingTimePlugin()
\ No newline at end of file