nplusone-TrialSpark 1.0.3

Django

注意：nplusone支持Django>；=1.8。在

将nplusone添加到INSTALLED_APPS：

添加NPlusOneMiddleware：

MIDDLEWARE = (
    'nplusone.ext.django.NPlusOneMiddleware',
    ...
)

可选地配置日志记录设置：

NPLUSONE_LOGGER = logging.getLogger('nplusone')
NPLUSONE_LOG_LEVEL = logging.WARN

配置日志处理程序：

LOGGING = {
    'version': 1,
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
        },
    },
    'loggers': {
        'nplusone': {
            'handlers': ['console'],
            'level': 'WARN',
        },
    },
}

当应用程序延迟加载数据时，nplusone将发出一条日志消息：

Potential n+1 query detected on `<model>.<field>`

在这种情况下，请考虑使用select_related或prefetch_related。在

当你的应用程序迫不及待地加载相关数据而不访问它时，nplusone将记录一条警告：

Potential unnecessary eager load detected on `<model>.<field>`

烧瓶炼金术

用NPlusOne包装应用程序：

from flask import Flask
from nplusone.ext.flask_sqlalchemy import NPlusOne

app = Flask(__name__)
NPlusOne(app)

可选地配置日志记录设置：

app = Flask(__name__)
app.config['NPLUSONE_LOGGER'] = logging.getLogger('app.nplusone')
app.config['NPLUSONE_LOG_LEVEL'] = logging.ERROR
NPlusOne(app)

当应用程序延迟加载数据时，nplusone将发出一条日志消息：

Potential n+1 query detected on `<model>.<field>`

在本例中，请考虑使用subqueryload或joinedload；有关完整的文档，请参阅SQLAlchemy的relationship loading指南。在

当你的应用程序迫不及待地加载相关数据而不访问它时，nplusone将记录一条警告：

Potential unnecessary eager load detected on `<model>.<field>`

WSGI

对于遵循WSGI规范的其他框架，请使用NPlusOneMiddleware包装应用程序。您还必须为您的ORM导入相关的nplusone扩展名：

import bottle
from nplusone.ext.wsgi import NPlusOneMiddleware
import nplusone.ext.sqlalchemy

app = NPlusOneMiddleware(bottle.app())

通用

上面的集成与请求-响应周期耦合。要在HTTP请求的上下文之外使用nplusone，请使用Profiler上下文管理器：还必须为ORM导入相关的nplusone扩展名：

from nplusone.core import profiler
import nplusone.ext.sqlalchemy

with profiler.Profiler():
    ...

自定义通知

默认情况下，nplusone使用名为“nplusone”的记录器记录所有可能不必要的查询。设置NPLUSONE\u RAISE配置选项时，nplusone也将引发NPlusOneError。这可以用来强制所有涉及不必要查询的自动化测试失败。在

# Django config
NPLUSONE_RAISE = True

# Flask config
app.config['NPLUSONE_RAISE'] = True

如果需要，也可以使用NPLUSONE_ERROR选项指定异常类型。在

忽略通知

要全局忽略来自nplusone的通知，请使用NPLUSONE\u whitelist选项配置白名单：

# Django config
NPLUSONE_WHITELIST = [
    {'label': 'n_plus_one', 'model': 'myapp.MyModel'}
]

# Flask-SQLAlchemy config
app.config['NPLUSONE_WHITELIST'] = [
    {'label': 'unused_eager_load', 'model': 'MyModel', 'field': 'my_field'}
]

您可以按确切名称或按fnmatch模式列出模型：

# Django config
NPLUSONE_WHITELIST = [
    {'model': 'myapp.*'}
]

要在本地禁止通知，请使用ignore上下文管理器：

from nplusone.core import signals

with signals.ignore(signals.lazy_load):
    # lazy-load rows
    # ...