存储后端

要创建自定义存储后台，您需要将 StorageBackend 课 然后创建新类的实例并将其作为 storage 创建时的关键字参数 WebSupport 对象：：

support = WebSupport(srcdir=srcdir,
                     builddir=builddir,
                     storage=MyStorage())

有关创建自定义存储后端的更多信息，请参阅 StorageBackend 下面的班级。

class sphinxcontrib.websupport.storage.StorageBackend[源代码]

定义存储后端的接口。

在 1.6 版本发生变更: 将StorageBackend类从sphinx.websupport.store移至sphinxcontri.websupport.store。

方法

StorageBackend.pre_build()[源代码]

在构建过程开始前立即调用。使用此功能来为添加节点做好收件箱后台准备。

StorageBackend.add_node(id, document, source)[源代码]

将节点添加到收件箱后台。

参数:

  • id -- 评论的唯一ID。

  • document -- 该节点所属的文档的名称。

  • source -- 源文件名称。

StorageBackend.post_build()[源代码]

构建完成后调用。如果需要，使用此功能来完成节点的添加。

StorageBackend.add_comment(text, displayed, username, time, proposal, node_id, parent_id, moderator)[源代码]

添加评论时调用。

参数:

  • text -- 注释文本

  • displayed -- 是否应显示评论

  • username -- 添加评论的用户名称

  • time -- 包含添加评论的时间的日期对象

  • proposal -- 用户提出的提案文本

  • node_id -- 要添加评论的节点的id

  • parent_id -- 评论的父评论的id。

  • moderator -- 添加评论的用户是否是主持人

StorageBackend.delete_comment(comment_id, username, moderator)[源代码]

删除评论。

提出 UserNotAuthorizedError 如果版主为假， username 与评论上的用户名不匹配。

参数:

  • comment_id -- 正在删除的评论的id。

  • username -- 请求删除的用户的用户名。

  • moderator -- 用户是否是版主。

StorageBackend.get_data(node_id, username, moderator)[源代码]

调用以检索节点的所有数据。这应该返回带有两个密钥的dict， source 和 comments 所描述 WebSupport 的 get_data() 法

参数:

  • node_id -- 要获取数据的节点的ID。

  • username -- 请求数据的用户的名称。

  • moderator -- 请求者是否是版主。

StorageBackend.process_vote(comment_id, username, value)[源代码]

处理正在进行的投票。 value 将是-1、0或1。

参数:

  • comment_id -- 正在投票的评论的id。

  • username -- 投票用户的用户名。

  • value -- 所投选票的价值。

StorageBackend.update_username(old_username, new_username)[源代码]

如果允许用户更改其用户名，则应调用此方法，以便存储系统中不会有停滞数据。

参数:

  • old_username -- 用户名正在更改。

  • new_username -- 用户名要更改为什么。

StorageBackend.accept_comment(comment_id)[源代码]

当版主接受评论时调用。调用该方法后，应向所有用户显示评论。

参数:

comment_id -- 被接受的评论的id。