django-proctor 1.0.4

django proctor

django proctor允许您使用来自django的proctor（a/b测试框架），使用proctor pipet，它将proctor公开为一个简单的rest api。

proctor允许您将用户放入随机分配的测试组中进行a/b测试。它还可用于功能切换和新功能的逐步展开。

通过检查bucket的名称，使用django模板中的proctor group assignments非常简单：

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

您还可以在python代码中使用proctor组：

ifrequest.proc.newfeaturerollout.group=='active':foo()else:bar()

如果需要在cron作业或某些服务中使用proctor组而无需请求，则可以执行帐户测试：

fromproctor.identifyimportproc_by_accountidaccountid=999999ifproc_by_accountid(accountid).newfeaturerollout.group=="active":foo()else:bar()

配置

在使用django proctor之前，您需要设置proctor pipet。这是django proctor与之通信以获得测试组分配的rest api。

您还需要一个测试矩阵，它定义所有proctor测试及其当前分配。proctor webapp提供查看和修改测试矩阵的方法。

要求

要使用django proctor，只需安装pip:

$ pip install django-proctor

或者将其添加到requirements.txt文件中（最好是当前版本）。

视图

有一组私有视图可用于测试和调试。启用这些视图需要一些额外的配置。

已安装的应用程序

将proctor添加到项目的已安装应用程序列表中。

INSTALLED_APPS+=(...proctor,...)

网址

将proctor url导入到项目的私人空间中。

urlpatterns=[...url(r'^private/',include('proctor.urls'))...]

显示测试矩阵

showtestmatrix视图允许您查看特定proctor_测试的整个测试矩阵。此视图只是筛选到测试中的测试矩阵的json版本。

使用上面的url模式示例，测试矩阵可以在http://<；your_project_root>；/private/proctor/show和http://<；your_project_root>；/private/show test matrix上找到。后者是为了向后兼容其他项目。

部队

Force Groups（强制组）视图允许您查看会话和标识的当前组分配，并强制您进入特定组进行任何测试。

注意：此模板确实附带了默认的基本模板，但可能会被忽略。要覆盖默认的基本模板，必须有一个要扩展的基本模板，并且该模板文件的名称应在proctor基础模板中设置。

使用上面的url模式示例，force groups页面可以在http://<；your_project_root>；/private/proctor/force

中间件

django proctor的大部分处理都是在中间件中完成的。这将在视图之前运行，并将proc添加到request对象，该对象允许您访问测试组分配。

您必须子类化proctor.middleware.baseproctormiddleware并重写多个函数，以向django proctor提供处理组分配所需的信息。

classMyProctorMiddleware(proctor.middleware.BaseProctorMiddleware):...

获取u标识符（）

标识符是唯一标识站点用户的字符串。这些可以包括跟踪cookies和帐户ID。Proctor使用此信息在请求之间将用户保持在相同的测试组中。

这会将标识符源键（请参阅pipe配置）的dict返回到它们的值。

如果用户缺少某个标识符，不要将其包含在dict中。proctor将跳过使用该标识符的任何测试。但是，请确保始终至少返回一个标识符，如跟踪cookie。

必须覆盖此方法。

方法总是在以前的任何中间件之后运行。

defget_identifiers(self,request):ids={'USER':request.COOKIES.get('tracking')}ifrequest.user.is_authenticated():ids['acctid']=request.user.idreturnids

获取上下文（）

上下文变量是关于在proctor测试规则中使用的用户的属性，用于根据表达式是否为true有选择地启用测试或更改测试的分配。这可用于仅在Firefox上运行测试，或者您可以为我们用户运行50%的测试，为其他用户运行10%的测试。

这会将上下文变量源键（请参阅pipe配置）的dict返回到它们的值，这些值在计算规则表达式之前由pipe转换为它们的最终类型。

如果不重写此方法，则django proctor不使用上下文变量。

如果pipe配置没有上下文变量的默认值，则它必须包含在每个api请求中。如果是这种情况，请确保上下文变量出现在此返回值中。

此方法总是在以前的任何中间件之后运行。

defget_context(self,request):return{"ua":request.META.get('HTTP_USER_AGENT',''),"loggedIn":request.user.is_authenticated(),"country":geo.country(request.get_host()),}

是特权的（）

返回一个bool，指示是否允许请求使用prforcegroupsquery参数强制自己进入proctor组。

如果不重写此方法，则返回false，这将有效地禁用强制组。

使用类似IP地址或管理帐户的内容来确定用户是否可以强制自己进入测试组。

此方法可以在不触及任何先前中间件的情况下运行。您必须假设在中间件中可能做过的任何事情，例如将用户属性添加到请求，都可能没有发生。否则，在诸如重定向之类的奇怪情况下可能会出现异常。

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

获取http（）

返回requests.session（或等效）的实例，在向API发出HTTP请求时将使用该实例。

如果不重写此方法，则返回none，这将导致api使用请求模块。

设置.py

要使django proctor正常工作，必须在settings.py中设置一些内容：

中间件类

将您创建的中间件添加到中间件类。确保将它放在它所依赖的任何中间件之后，比如authenticationmiddleware

模板上下文处理器

将proctor.context_processors.proc添加到template_context_processors中。这使得proc对象在所有django模板中都可用。

程序api根目录

将proctor api根设置为proctor pipet运行的url。

包括http://或https://。不要包含尾随斜杠。

如果您希望生产使用与登台服务器和开发人员计算机不同的测试矩阵，则可能需要根据环境使用不同的pipe实例。

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

普氏试验

proctor_tests是Django项目打算使用的proctor测试的元组或列表。

在模板和代码中实现测试之前，请将测试添加到此元组中，并在删除测试的实现之后从此元组中删除测试。

这里列出的所有测试都保证存在于proc对象中。

如果测试组的值为非负，则此处列出的测试也将位于str（proc）（用于记录测试组）。

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

2

如果只使用一个测试，请确保元组中包含逗号。否则，python将其解释为一个字符串。

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

3

Proctor_Base_模板

将proctor基础模板设置为项目中使用的基础html模板的名称。

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

proctor_cache_方法

您可以选择从proctor pipet rest api中分配django proctor缓存组。通常，每个到达django的http请求都会触发proctor中间件向pipe发出http请求。您可以使用缓存来避免这一额外成本，因为组分配通常保持不变。

如果缓存没有有用的值（比如当一个新用户访问您的站点时），那么django proctor会返回到向proctor pipet发出http请求。

如果proctor_cache_method丢失或没有，django proctor将不会执行任何缓存。

如果proctor_cache_method是'cache'，django proctor使用django的缓存框架来缓存组分配。请参见proctor缓存名称

如果proctor_cache_method是'session'，django proctor会在request.sessiondict中缓存组分配。如果所有http请求都得到或设置d，这是一个不错的选择。Jango的会话对象无论如何。

缓存失效

django proctor的缓存失效相当聪明，如果用户请求的某些属性（如标识符、上下文变量或prforcegroups参数）发生更改，则不会使用缓存。如果您更改proctor_api_root或proctor_tests等设置，缓存也将被忽略。

这意味着，如果用户登录，或用户更改其useragent，或您向proctor_tests添加新测试，则将跳过缓存值。您不必担心过时的值。

TOdo:解释解决无效缓存问题后的矩阵版本检测和缓存。当前的缓存实现无法在多个进程中正常工作。

Proctor缓存名称

只有当proctor_cache_method是'cache'时，此设置才有意义。

proctor_cache_name是django proctor将使用的缓存中缓存的名称。

如果proctor_cache_name丢失或没有，django proctor将使用默认的缓存。

懒散的proctor

如果proctor_lazy为true，则proc对象将延迟加载其组。proctor组分配仅在第一次访问proc对象时从缓存或proctor pipet rest api中检索。

这意味着，对Django服务器的从不使用proc对象的HTTP请求不会产生获得组分配的成本。

在测量性能时，请记住此选项可能会将缓存访问和rest api请求的计时移到意外的位置（例如在模板呈现期间）。

如果proctor_lazy丢失或false，则不会使用延迟加载。

用法

proctor中间件将一个proc对象添加到request，这允许您从任何视图轻松使用proctor组分配。

可以使用proc上的点运算符访问组分配。proctor_tests中列出的每个测试都保证作为属性存在于proc

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

{%ifproc.buttoncolortst.group=='blue'%}<buttonclass="blue-btn"></button>{%else%}<buttonclass="grey-btn"></button>{%endif%}

ifrequest.proc.newfeaturerollout.group=='active':foo()else:bar()

ifrequest.proc.newfeaturerollout.group=='active':foo()else:bar()