django-secretballot 2.0.0

votes

管理当前模型所有相关Vote对象的管理器（通常不需要直接访问）。可以通过将votes_name参数传递给SECRETBALLOT_FOR_MODELS来重命名，例如

SECRETBALLOT_FOR_MODELS = {
    "<app_label.model_name>": {
        "votes_name": "vs",
    },
}

total_upvotes

所有+1票的总数。可以通过将upvotes_name参数传递给SECRETBALLOT_FOR_MODELS来重命名，例如

SECRETBALLOT_FOR_MODELS = {
    "<app_label.model_name>": {
        "upvotes_name": "total_upvs",
    },
}

total_downvotes

所有-1票的总数。可以通过将downvotes_name参数传递给SECRETBALLOT_FOR_MODELS来重命名，例如

SECRETBALLOT_FOR_MODELS = {
    "<app_label.model_name>": {
        "downvotes_name": "total_downvs",
    },
}

vote_total

(total_upvotes减去total_downvotes)的快捷访问器。可以通过将total_name参数传递给SECRETBALLOT_FOR_MODELS来重命名，例如

SECRETBALLOT_FOR_MODELS = {
    "<app_label.model_name>": {
        "total_name": "v_total",
    },
}

_secretballot_enabled

表示secretballot是否启用（可以使用hasattr进行测试）的布尔值。不能重命名，存在是为了在所有其他字段都已重命名的情况下，仍然可以可靠地检查secretballot是否可用。

add_vote

一个函数，它接受一个token和一个投票(+1或-1)，并添加或更新指定token的投票。可以通过将add_vote_name参数传递给SECRETBALLOT_FOR_MODELS来重命名，例如

SECRETBALLOT_FOR_MODELS = {
    "<app_label.model_name>": {
        "add_vote_name": "add_v",
    },
}

remove_vote

一个函数，它接受一个token并移除（如果存在）指定token的投票。可以通过将remove_vote_name参数传递给SECRETBALLOT_FOR_MODELS来重命名，例如

SECRETBALLOT_FOR_MODELS = {
    "<app_label.model_name>": {
        "remove_vote_name": "remove_v",
    },
}

from_request(self, request)

当在可投票对象的查询集中调用时，将添加一个user_vote属性，该属性是当前‘用户’投的票（实际上是分配给请求的token），例如

def story_view(request, slug):
    story = Story.objects.from_request(request).get(pk=slug)
    # story has the following extra attributes
    # user_vote: -1, 0, or +1
    # total_upvotes: total number of +1 votes
    # total_downvotes: total number of -1 votes
    # vote_total: total_upvotes-total_downvotes
    # votes: related object manager to get specific votes (rarely needed)

SecretBallotIpMiddleware

简单地将token设置为request.META['REMOTE_ADDR'] – 用户IP地址

SecretBallotIpUseragentMiddleware

将token设置为用户IP地址和用户代理的哈希值 – 比仅IP地址稍微更独特

如果您想定义自己的中间件，只需从SecretBallotMiddleware派生一个类并实现generate_token方法。如果您想出一些可能对他人有用的东西，贡献始终欢迎。

secretballot.views.vote

描述

此视图创建或更改具有content_type的具有主键object_id的对象的投票。如果已存在投票，则将其替换（除非投票为0，在这种情况下将删除投票）。

用于防止无限投票的投票的token属性在此视图中设置，基于活动的SecretBallotMiddleware。

根据提供的参数，此视图的返回值可能会有所不同

1. 如果指定了redirect_url，则无论什么情况都会使用它

2. 如果指定了template_name，则将使用它（以及template_loader、context_processors等）

3. 如果没有redirect_url或template_name，则返回文本/json响应

必需参数

• content_type：投票发生的类（一个从VotableModel派生的模型）。

  可以是django.contrib.contenttypes.models.ContentType的实例、模型类本身或<app_label.model_name>字符串。

• object_id：要投票的对象的主键

• vote：此投票的值（+1、0或-1）（0删除投票）

可选参数

• can_vote_test：允许限制用户是否可以投票的函数。它是视图的可选参数，可以在记录用户的投票之前在urlconf中指定。

  can_vote_test的示例实现

  from secretballot.utils import get_vote_model
  
  def only_three_votes(request, content_type, object_id, vote):
      return get_vote_model().objects.filter(content_type=content_type, token=request.secretballot_token).count() < 3

  所有can_vote_test方法都必须接受secretballot.views.vote的非可选参数，并且如果应允许投票，则应返回True。如果默认不允许投票，则视图将返回403，但也可以引发不同的异常。

• redirect_url：要重定向到的URL，如果存在，将重定向而不是返回正常的HttpResponse

• template_name：要渲染的模板，接收一个包含content_obj的上下文，它是被投票的对象

• template_loader：要使用的模板加载器，默认为django.template.loader

• extra_context：包含任何额外上下文的字典，在渲染时将调用可调用对象

• context_processors：此视图的上下文处理程序列表

• mimetype：mimetype覆盖