To celebrate our 18th birthday, and ensure the future of Review Board, we're offering 18% off all new Power Pack licenses and support contracts through the end of 2024! Learn more!
  • Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
    • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Djblets dev
    2. Version 5.x
    3. Version 4.x
    4. Version 3.x
    5. Version 2.x
    6. Version 2.0
    7. Version 1.0
    8. Version 0.9
    9. Djblets Documentation
  • Home
  • Guides
  • Avatar Services Guides
  • Writing Avatar Services
  • Extension Guides
  • Writing Extensions
  • Testing Extensions
  • Feature Checks Guides
  • Introduction to Feature Checks
  • Writing Features
  • Writing Feature Checkers
  • Testing with Feature Checks
  • Integration Guides
  • Supporting Integrations
  • Writing Integrations
  • Privacy Compliance Guides
  • Getting and Checking Consent
  • Working with Personally Identifiable Information
  • Service Integrations
  • reCAPTCHA Guides
  • Using reCAPTCHA
  • Registries Guides
  • Writing Registries
  • Web API Guides
  • Writing Web API Resources
  • Adding OAuth2 Support
  • Module and Class References
  • djblets
  • djblets.deprecation
  • djblets.auth.forms
  • djblets.auth.ratelimit
  • djblets.auth.signals
  • djblets.auth.util
  • djblets.auth.views
  • djblets.avatars.errors
  • djblets.avatars.forms
  • djblets.avatars.registry
  • djblets.avatars.services
  • djblets.avatars.services.base
  • djblets.avatars.services.fallback
  • djblets.avatars.services.file_upload
  • djblets.avatars.services.gravatar
  • djblets.avatars.services.url
  • djblets.avatars.settings
  • djblets.cache.backend
  • djblets.cache.backend_compat
  • djblets.cache.context_processors
  • djblets.cache.errors
  • djblets.cache.forwarding_backend
  • djblets.cache.serials
  • djblets.cache.synchronizer
  • djblets.conditions
  • djblets.conditions.choices
  • djblets.conditions.conditions
  • djblets.conditions.errors
  • djblets.conditions.operators
  • djblets.conditions.values
  • djblets.configforms.forms
  • djblets.configforms.mixins
  • djblets.configforms.pages
  • djblets.configforms.registry
  • djblets.configforms.views
  • djblets.datagrid.grids
  • djblets.db.backends.mysql.base
  • djblets.db.fields
  • djblets.db.fields.base64_field
  • djblets.db.fields.comma_separated_values_field
  • djblets.db.fields.counter_field
  • djblets.db.fields.json_field
  • djblets.db.fields.modification_timestamp_field
  • djblets.db.fields.relation_counter_field
  • djblets.db.managers
  • djblets.db.query
  • djblets.db.query_catcher
  • djblets.db.query_comparator
  • djblets.db.validators
  • djblets.extensions.admin
  • djblets.extensions.errors
  • djblets.extensions.extension
  • djblets.extensions.forms
  • djblets.extensions.hooks
  • djblets.extensions.loaders
  • djblets.extensions.manager
  • djblets.extensions.middleware
  • djblets.extensions.models
  • djblets.extensions.packaging
  • djblets.extensions.resources
  • djblets.extensions.settings
  • djblets.extensions.signals
  • djblets.extensions.staticfiles
  • djblets.extensions.testing
  • djblets.extensions.testing.testcases
  • djblets.extensions.urls
  • djblets.extensions.views
  • djblets.extensions.templatetags.djblets_extensions
  • djblets.features
  • djblets.features.checkers
  • djblets.features.decorators
  • djblets.features.errors
  • djblets.features.feature
  • djblets.features.level
  • djblets.features.registry
  • djblets.features.testing
  • djblets.features.templatetags.features
  • djblets.forms.fields
  • djblets.forms.fieldsets
  • djblets.forms.forms
  • djblets.forms.forms.key_value_form
  • djblets.forms.widgets
  • djblets.gravatars
  • djblets.gravatars.templatetags.gravatars
  • djblets.http.middleware
  • djblets.http.responses
  • djblets.integrations.errors
  • djblets.integrations.forms
  • djblets.integrations.hooks
  • djblets.integrations.integration
  • djblets.integrations.manager
  • djblets.integrations.mixins
  • djblets.integrations.models
  • djblets.integrations.urls
  • djblets.integrations.views
  • djblets.log
  • djblets.log.middleware
  • djblets.log.siteconfig
  • djblets.log.urls
  • djblets.log.views
  • djblets.mail.dmarc
  • djblets.mail.message
  • djblets.mail.testing
  • djblets.mail.utils
  • djblets.markdown
  • djblets.markdown.extensions.escape_html
  • djblets.markdown.extensions.wysiwyg
  • djblets.markdown.extensions.wysiwyg_email
  • djblets.pipeline.compilers.es6
  • djblets.pipeline.compilers.less
  • djblets.pipeline.compilers.mixins
  • djblets.pipeline.compilers.rollup
  • djblets.pipeline.compilers.typescript
  • djblets.pipeline.settings
  • djblets.privacy.consent
  • djblets.privacy.consent.base
  • djblets.privacy.consent.common
  • djblets.privacy.consent.errors
  • djblets.privacy.consent.forms
  • djblets.privacy.consent.hooks
  • djblets.privacy.consent.registry
  • djblets.privacy.consent.tracker
  • djblets.privacy.models
  • djblets.privacy.pii
  • djblets.privacy.templatetags.djblets_privacy
  • djblets.recaptcha.mixins
  • djblets.recaptcha.siteconfig
  • djblets.recaptcha.templatetags.djblets_recaptcha
  • djblets.recaptcha.widgets
  • djblets.registries
  • djblets.registries.errors
  • djblets.registries.importer
  • djblets.registries.mixins
  • djblets.registries.registry
  • djblets.registries.signals
  • djblets.secrets
  • djblets.secrets.crypto
  • djblets.secrets.token_generators
  • djblets.secrets.token_generators.base
  • djblets.secrets.token_generators.legacy_sha1
  • djblets.secrets.token_generators.registry
  • djblets.secrets.token_generators.vendor_checksum
  • djblets.siteconfig
  • djblets.siteconfig.admin
  • djblets.siteconfig.context_processors
  • djblets.siteconfig.django_settings
  • djblets.siteconfig.forms
  • djblets.siteconfig.managers
  • djblets.siteconfig.middleware
  • djblets.siteconfig.models
  • djblets.siteconfig.signals
  • djblets.siteconfig.views
  • djblets.template.caches
  • djblets.template.context
  • djblets.template.loaders.conditional_cached
  • djblets.template.loaders.namespaced_app_dirs
  • djblets.testing.decorators
  • djblets.testing.testcases
  • djblets.testing.testrunners
  • djblets.urls.context_processors
  • djblets.urls.decorators
  • djblets.urls.patterns
  • djblets.urls.resolvers
  • djblets.urls.root
  • djblets.urls.staticfiles
  • djblets.util.compat.django.core.cache
  • djblets.util.compat.python.past
  • djblets.util.contextmanagers
  • djblets.util.dates
  • djblets.util.decorators
  • djblets.util.filesystem
  • djblets.util.functional
  • djblets.util.html
  • djblets.util.http
  • djblets.util.humanize
  • djblets.util.json_utils
  • djblets.util.properties
  • djblets.util.serializers
  • djblets.util.symbols
  • djblets.util.templatetags.djblets_deco
  • djblets.util.templatetags.djblets_email
  • djblets.util.templatetags.djblets_forms
  • djblets.util.templatetags.djblets_images
  • djblets.util.templatetags.djblets_js
  • djblets.util.templatetags.djblets_utils
  • djblets.util.typing
  • djblets.util.views
  • djblets.views.generic.base
  • djblets.views.generic.etag
  • djblets.webapi.auth
  • djblets.webapi.auth.backends
  • djblets.webapi.auth.backends.api_tokens
  • djblets.webapi.auth.backends.base
  • djblets.webapi.auth.backends.basic
  • djblets.webapi.auth.backends.oauth2_tokens
  • djblets.webapi.auth.views
  • djblets.webapi.decorators
  • djblets.webapi.encoders
  • djblets.webapi.errors
  • djblets.webapi.fields
  • djblets.webapi.managers
  • djblets.webapi.models
  • djblets.webapi.oauth2_scopes
  • djblets.webapi.resources
  • djblets.webapi.resources.base
  • djblets.webapi.resources.group
  • djblets.webapi.resources.registry
  • djblets.webapi.resources.root
  • djblets.webapi.resources.user
  • djblets.webapi.resources.mixins.api_tokens
  • djblets.webapi.resources.mixins.forms
  • djblets.webapi.resources.mixins.oauth2_tokens
  • djblets.webapi.resources.mixins.queries
  • djblets.webapi.responses
  • djblets.webapi.signals
  • djblets.webapi.testing
  • djblets.webapi.testing.decorators
  • djblets.webapi.testing.testcases
  • General Index
  • Python Module Index
  • Release Notes
    •

    This documentation covers the in-development release of Djblets. You can see the stable Djblets documentation or all previous versions.

    Djblets Documentation¶

    • Guides
      • Avatar Services Guides
        • Writing Avatar Services
      • Extension Guides
        • Writing Extensions
        • Testing Extensions
      • Feature Checks Guides
        • Introduction to Feature Checks
        • Writing Features
        • Writing Feature Checkers
        • Testing with Feature Checks
      • Integration Guides
        • Supporting Integrations
        • Writing Integrations
      • Privacy Compliance Guides
        • Getting and Checking Consent
        • Working with Personally Identifiable Information
        • Service Integrations
      • reCAPTCHA Guides
        • Using reCAPTCHA
      • Registries Guides
        • Writing Registries
      • Web API Guides
        • Writing Web API Resources
        • Adding OAuth2 Support
    • Module and Class References
      • Top-Level Modules
        • djblets
        • djblets.deprecation
      • Authentication
        • djblets.auth.forms
        • djblets.auth.ratelimit
        • djblets.auth.signals
        • djblets.auth.util
        • djblets.auth.views
      • Avatars
        • djblets.avatars.errors
        • djblets.avatars.forms
        • djblets.avatars.registry
        • djblets.avatars.services
        • djblets.avatars.services.base
        • djblets.avatars.services.fallback
        • djblets.avatars.services.file_upload
        • djblets.avatars.services.gravatar
        • djblets.avatars.services.url
        • djblets.avatars.settings
      • Caching
        • djblets.cache.backend
        • djblets.cache.backend_compat
        • djblets.cache.context_processors
        • djblets.cache.errors
        • djblets.cache.forwarding_backend
        • djblets.cache.serials
        • djblets.cache.synchronizer
      • Conditions
        • djblets.conditions
        • djblets.conditions.choices
        • djblets.conditions.conditions
        • djblets.conditions.errors
        • djblets.conditions.operators
        • djblets.conditions.values
      • Config Forms
        • djblets.configforms.forms
        • djblets.configforms.mixins
        • djblets.configforms.pages
        • djblets.configforms.registry
        • djblets.configforms.views
      • Datagrids
        • djblets.datagrid.grids
      • Database Utilities
        • djblets.db.backends.mysql.base
        • djblets.db.fields
        • djblets.db.fields.base64_field
        • djblets.db.fields.comma_separated_values_field
        • djblets.db.fields.counter_field
        • djblets.db.fields.json_field
        • djblets.db.fields.modification_timestamp_field
        • djblets.db.fields.relation_counter_field
        • djblets.db.managers
        • djblets.db.query
        • djblets.db.query_catcher
        • djblets.db.query_comparator
        • djblets.db.validators
      • Extensions
        • djblets.extensions.admin
        • djblets.extensions.errors
        • djblets.extensions.extension
        • djblets.extensions.forms
        • djblets.extensions.hooks
        • djblets.extensions.loaders
        • djblets.extensions.manager
        • djblets.extensions.middleware
        • djblets.extensions.models
        • djblets.extensions.packaging
        • djblets.extensions.resources
        • djblets.extensions.settings
        • djblets.extensions.signals
        • djblets.extensions.staticfiles
        • djblets.extensions.testing
        • djblets.extensions.testing.testcases
        • djblets.extensions.urls
        • djblets.extensions.views
        • djblets.extensions.templatetags.djblets_extensions
      • Feature Checks
        • djblets.features
        • djblets.features.checkers
        • djblets.features.decorators
        • djblets.features.errors
        • djblets.features.feature
        • djblets.features.level
        • djblets.features.registry
        • djblets.features.testing
        • djblets.features.templatetags.features
      • Form Utilities
        • djblets.forms.fields
        • djblets.forms.fieldsets
        • djblets.forms.forms
        • djblets.forms.forms.key_value_form
        • djblets.forms.widgets
      • Gravatars
        • djblets.gravatars
        • djblets.gravatars.templatetags.gravatars
      • HTTP Utilities
        • djblets.http.middleware
        • djblets.http.responses
      • Integrations
        • djblets.integrations.errors
        • djblets.integrations.forms
        • djblets.integrations.hooks
        • djblets.integrations.integration
        • djblets.integrations.manager
        • djblets.integrations.mixins
        • djblets.integrations.models
        • djblets.integrations.urls
        • djblets.integrations.views
      • Log Handlers and Viewer
        • djblets.log
        • djblets.log.middleware
        • djblets.log.siteconfig
        • djblets.log.urls
        • djblets.log.views
      • Mail Sending
        • djblets.mail.dmarc
        • djblets.mail.message
        • djblets.mail.testing
        • djblets.mail.utils
      • Markdown Utilities and Extensions
        • djblets.markdown
        • djblets.markdown.extensions.escape_html
        • djblets.markdown.extensions.wysiwyg
        • djblets.markdown.extensions.wysiwyg_email
      • Django Pipeline Additions
        • djblets.pipeline.compilers.es6
        • djblets.pipeline.compilers.less
        • djblets.pipeline.compilers.mixins
        • djblets.pipeline.compilers.rollup
        • djblets.pipeline.compilers.typescript
        • djblets.pipeline.settings
      • Privacy Protection
        • djblets.privacy.consent
        • djblets.privacy.consent.base
        • djblets.privacy.consent.common
        • djblets.privacy.consent.errors
        • djblets.privacy.consent.forms
        • djblets.privacy.consent.hooks
        • djblets.privacy.consent.registry
        • djblets.privacy.consent.tracker
        • djblets.privacy.models
        • djblets.privacy.pii
        • djblets.privacy.templatetags.djblets_privacy
      • reCAPTCHA
        • djblets.recaptcha.mixins
        • djblets.recaptcha.siteconfig
        • djblets.recaptcha.templatetags.djblets_recaptcha
        • djblets.recaptcha.widgets
      • Registries
        • djblets.registries
        • djblets.registries.errors
        • djblets.registries.importer
        • djblets.registries.mixins
        • djblets.registries.registry
        • djblets.registries.signals
      • Secrets
        • djblets.secrets
        • djblets.secrets.crypto
        • djblets.secrets.token_generators
        • djblets.secrets.token_generators.base
        • djblets.secrets.token_generators.legacy_sha1
        • djblets.secrets.token_generators.registry
        • djblets.secrets.token_generators.vendor_checksum
      • Site Configuration
        • djblets.siteconfig
        • djblets.siteconfig.admin
        • djblets.siteconfig.context_processors
        • djblets.siteconfig.django_settings
        • djblets.siteconfig.forms
        • djblets.siteconfig.managers
        • djblets.siteconfig.middleware
        • djblets.siteconfig.models
        • djblets.siteconfig.signals
        • djblets.siteconfig.views
      • Template Utilities
        • djblets.template.caches
        • djblets.template.context
        • djblets.template.loaders.conditional_cached
        • djblets.template.loaders.namespaced_app_dirs
      • Testing Helpers
        • djblets.testing.decorators
        • djblets.testing.testcases
        • djblets.testing.testrunners
      • URL Utilities
        • djblets.urls.context_processors
        • djblets.urls.decorators
        • djblets.urls.patterns
        • djblets.urls.resolvers
        • djblets.urls.root
        • djblets.urls.staticfiles
      • Generic Utilities
        • djblets.util.compat.django.core.cache
        • djblets.util.compat.python.past
        • djblets.util.contextmanagers
        • djblets.util.dates
        • djblets.util.decorators
        • djblets.util.filesystem
        • djblets.util.functional
        • djblets.util.html
        • djblets.util.http
        • djblets.util.humanize
        • djblets.util.json_utils
        • djblets.util.properties
        • djblets.util.serializers
        • djblets.util.symbols
        • djblets.util.templatetags.djblets_deco
        • djblets.util.templatetags.djblets_email
        • djblets.util.templatetags.djblets_forms
        • djblets.util.templatetags.djblets_images
        • djblets.util.templatetags.djblets_js
        • djblets.util.templatetags.djblets_utils
        • djblets.util.typing
        • djblets.util.views
      • View Helpers
        • djblets.views.generic.base
        • djblets.views.generic.etag
      • Web API
        • djblets.webapi.auth
        • djblets.webapi.auth.backends
        • djblets.webapi.auth.backends.api_tokens
        • djblets.webapi.auth.backends.base
        • djblets.webapi.auth.backends.basic
        • djblets.webapi.auth.backends.oauth2_tokens
        • djblets.webapi.auth.views
        • djblets.webapi.decorators
        • djblets.webapi.encoders
        • djblets.webapi.errors
        • djblets.webapi.fields
        • djblets.webapi.managers
        • djblets.webapi.models
        • djblets.webapi.oauth2_scopes
        • djblets.webapi.resources
        • djblets.webapi.resources.base
        • djblets.webapi.resources.group
        • djblets.webapi.resources.registry
        • djblets.webapi.resources.root
        • djblets.webapi.resources.user
        • djblets.webapi.resources.mixins.api_tokens
        • djblets.webapi.resources.mixins.forms
        • djblets.webapi.resources.mixins.oauth2_tokens
        • djblets.webapi.resources.mixins.queries
        • djblets.webapi.responses
        • djblets.webapi.signals
        • djblets.webapi.testing
        • djblets.webapi.testing.decorators
        • djblets.webapi.testing.testcases

    Indices, glossary and tables¶

    • Table of Contents

    • Index

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2024 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Indices, glossary and tables