Module and Class References¶

See also

Top-Level Modules¶

`reviewboard`	Review Board version and package information.
`reviewboard.deprecation`	Internal support for handling deprecations in Review Board.
`reviewboard.rb_platform`	Global configuration for deployment paths and settings.
`reviewboard.signals`	Top-level signals for initialization, upgrades, and settings changes.

User Accounts¶

`reviewboard.accounts.backends`	Forwarding imports and legacy utilities for authentication backends.
`reviewboard.accounts.backends.ad`	Active Directory authentication backend.
`reviewboard.accounts.backends.base`	Base class for authentication backends.
`reviewboard.accounts.backends.http_digest`	HTTP Digest authentication backend.
`reviewboard.accounts.backends.ldap`	LDAP authentication backend.
`reviewboard.accounts.backends.nis`	NIS authentication backend.
`reviewboard.accounts.backends.registry`	Authentication backend registry.
`reviewboard.accounts.backends.standard`	Standard authentication backend.
`reviewboard.accounts.backends.x509`	X.509 authentication backend.
`reviewboard.accounts.decorators`
`reviewboard.accounts.errors`	Exception classes for accounts.
`reviewboard.accounts.forms.auth`
`reviewboard.accounts.forms.pages`
`reviewboard.accounts.forms.registration`
`reviewboard.accounts.managers`
`reviewboard.accounts.middleware`	Middleware for account-related functionality.
`reviewboard.accounts.mixins`	Mixins for account-related views.
`reviewboard.accounts.models`	Models for user profiles and related objects.
`reviewboard.accounts.pages`
`reviewboard.accounts.privacy`	Privacy support for user accounts.
`reviewboard.accounts.templatetags.accounts`	Account-related template tags.
`reviewboard.accounts.testing`	Testing infrastructure for accounts support.
`reviewboard.accounts.testing.queries`	Testing utilities for building expected queries for accounts.
`reviewboard.accounts.trophies`

Actions¶

`reviewboard.actions`	Actions framework for Review Board.
`reviewboard.actions.base`	Base classes for actions.
`reviewboard.actions.errors`	Errors for actions app.
`reviewboard.actions.registry`	Registry for actions.

Administration and Server¶

`reviewboard.admin`	Review Board's Administration UI.
`reviewboard.admin.admin_sites`	Django AdminSite customization for Review Board.
`reviewboard.admin.cache_stats`
`reviewboard.admin.checks`
`reviewboard.admin.decorators`	Review Board admin panel-specific decorators
`reviewboard.admin.form_widgets`	Admin-specific form widgets.
`reviewboard.admin.middleware`
`reviewboard.admin.model_admin`	Administration UI customization for models.
`reviewboard.admin.security_checks`
`reviewboard.admin.server`	Functions for retrieving server information.
`reviewboard.admin.siteconfig`	Loads and manages site configuration settings.
`reviewboard.admin.support`
`reviewboard.admin.validation`
`reviewboard.admin.widgets`

File Attachments¶

`reviewboard.attachments.errors`	Error definitions for attachments.
`reviewboard.attachments.forms`	A form that handles uploading of new files.
`reviewboard.attachments.managers`	Manager for FileAttachment objects.
`reviewboard.attachments.mimetypes`	File attachment mimetype registration and scoring.
`reviewboard.attachments.models`	Models for file attachments and related objects.

Avatars¶

`reviewboard.avatars.registry`
`reviewboard.avatars.services`	Review Board-specific specializations of avatar services.
`reviewboard.avatars.settings`
`reviewboard.avatars.templatetags.avatars`	Template tags for working with avatars.
`reviewboard.avatars.testcase`

See also

djblets.avatars

Review Request Change Descriptions¶

reviewboard.changedescs.models

Datagrids¶

`reviewboard.datagrids.columns`	Columns for datagrids.
`reviewboard.datagrids.grids`	Datagrids for the Dashboard and other pages.
`reviewboard.datagrids.sidebar`	Sidebar item management for datagrids.

See also

djblets.datagrids

Diff Viewer¶

`reviewboard.diffviewer.chunk_generator`	Diff chunk generator implementations.
`reviewboard.diffviewer.differ`
`reviewboard.diffviewer.diffutils`	Utilities for processing and generating diffs.
`reviewboard.diffviewer.errors`
`reviewboard.diffviewer.forms`	Forms for uploading diffs.
`reviewboard.diffviewer.managers`	Managers for reviewboard.diffviewer.models.
`reviewboard.diffviewer.models`	Model re-exports for reviewboard.diffviewer.*.
`reviewboard.diffviewer.models.diffcommit`	DiffCommit model definition.
`reviewboard.diffviewer.models.diffset`	DiffSet model definition.
`reviewboard.diffviewer.models.diffset_history`	DiffSetHistory model definition.
`reviewboard.diffviewer.models.filediff`	FileDiff model definition.
`reviewboard.diffviewer.models.legacy_file_diff_data`	LegacyFileDiffData model defitnition.
`reviewboard.diffviewer.models.raw_file_diff_data`	RawFileDiffData model definition.
`reviewboard.diffviewer.myersdiff`
`reviewboard.diffviewer.opcode_generator`	The diff opcode generator.
`reviewboard.diffviewer.parser`	Diff parsing support.
`reviewboard.diffviewer.processors`	Diff processing and filtering logic.
`reviewboard.diffviewer.renderers`
`reviewboard.diffviewer.smdiff`

SSL/TLS Certificates¶

`reviewboard.certs`	SSL/TLS certificate management support.
`reviewboard.certs.cert`	Certificates, fingerprints, and bundles.
`reviewboard.certs.errors`	Certificate-related errors.

Extensions¶

`reviewboard.extensions.base`	Base support for writing custom extensions.
`reviewboard.extensions.hooks`	Extension hooks for Review Board.
`reviewboard.extensions.packaging`	Packaging support for Review Board extensions.
`reviewboard.extensions.testing`	Extension unit test helpers.
`reviewboard.extensions.testing.testcases`	Base test case support for extension unit tests.

See also

djblets.extensions

Hosting Service Integration¶

`reviewboard.hostingsvcs.base`	Base support for writing hosting services.
`reviewboard.hostingsvcs.base.client`	Base communication client support for hosting services.
`reviewboard.hostingsvcs.base.forms`	Base hosting service configuration forms.
`reviewboard.hostingsvcs.base.hosting_service`	Base communication client support for hosting services.
`reviewboard.hostingsvcs.base.http`	Base HTTP support for hosting services.
`reviewboard.hostingsvcs.base.paginator`	Paginators for iterating over API results.
`reviewboard.hostingsvcs.base.registry`	Registry for managing available hosting services.
`reviewboard.hostingsvcs.base.repository`	Representations of remote repositories.
`reviewboard.hostingsvcs.errors`	Errors for hosting service operations.
`reviewboard.hostingsvcs.forms`	The base hosting service class and associated definitions.
`reviewboard.hostingsvcs.hook_utils`
`reviewboard.hostingsvcs.models`	Models for hosting service accounts.
`reviewboard.hostingsvcs.repository`	Representations of remote repositories.
`reviewboard.hostingsvcs.service`	The base hosting service class and associated definitions.
`reviewboard.hostingsvcs.testing`	Support for testing hosting services.
`reviewboard.hostingsvcs.testing.testcases`	Test cases for testing hosting services.
`reviewboard.hostingsvcs.utils.paginator`	Paginators for iterating over API results.

Integrations¶

`reviewboard.integrations`	Integrations support for Review Board.
`reviewboard.integrations.base`	Base support for creating and using integrations.
`reviewboard.integrations.forms`	Configuration forms for integrations.
`reviewboard.integrations.models`	Database models for integration configuration storage.
`reviewboard.integrations.urls`	URLs for integration listing and configuration.
`reviewboard.integrations.views`	Views for listing and configuring integrations.

See also

djblets.integrations

E-mail and WebHooks¶

`reviewboard.notifications`
`reviewboard.notifications.email`	Review Board e-mail module.
`reviewboard.notifications.email.backend`	E-mail backend for Review Board.
`reviewboard.notifications.email.decorators`	E-mail message-related decorators.
`reviewboard.notifications.email.hooks`	Extension hooks for augmenting e-mail messages.
`reviewboard.notifications.email.message`	The Review Board e-mail message class and methods for generating e-mails.
`reviewboard.notifications.email.utils`	Utilities for sending e-mail messages.
`reviewboard.notifications.email.views`	Views used to render e-mail previews.
`reviewboard.notifications.forms`	Notification-related forms.
`reviewboard.notifications.managers`	Manager for WebHookTarget models.
`reviewboard.notifications.models`	Models for WebHooks.
`reviewboard.notifications.webhooks`

Review Requests and Reviews¶

`reviewboard.reviews.actions`	Actions for the reviews app.
`reviewboard.reviews.builtin_fields`
`reviewboard.reviews.chunk_generators`
`reviewboard.reviews.conditions`	Condition choices and operators for review requests and related objects.
`reviewboard.reviews.context`	Methods to help with building the review request rendering context.
`reviewboard.reviews.default_actions`	Default actions for the reviews app.
`reviewboard.reviews.detail`	Definitions for the review request detail view.
`reviewboard.reviews.errors`	Error definitions for the reviews app.
`reviewboard.reviews.features`	Feature definitions for reviews.
`reviewboard.reviews.fields`	Definitions for review request fields.
`reviewboard.reviews.forms`
`reviewboard.reviews.managers`	Managers for reviewboard.reviews.models.
`reviewboard.reviews.markdown_utils`
`reviewboard.reviews.models`
`reviewboard.reviews.signals`	Signals related to review requests, reviews, and replies.
`reviewboard.reviews.templatetags.reviewtags`	Tags related to review requests.
`reviewboard.reviews.testing`	Testing infrastructure for review/review request support.
`reviewboard.reviews.testing.queries`	Testing utilities for building expected queries for review groups.
`reviewboard.reviews.testing.queries.review_groups`	Testing utilities for building expected queries for review groups.
`reviewboard.reviews.testing.queries.review_requests`	Testing utilities for building expected queries for review requests.
`reviewboard.reviews.testing.queries.reviews`	Testing utilities for building expected queries for reviews.
`reviewboard.reviews.ui.base`	Base class for a Review UI.
`reviewboard.reviews.ui.image`	A Review UI for image files.
`reviewboard.reviews.ui.markdownui`	A Review UI for Markdown files.
`reviewboard.reviews.ui.text`	A Review UI for text-based files.
`reviewboard.reviews.views.attachments`	Views for reviewing file attachments (and legacy screenshots).
`reviewboard.reviews.views.bug_trackers`	Views for interacting with bug trackers.
`reviewboard.reviews.views.diff_fragments`	Views for rendering diff fragments.
`reviewboard.reviews.views.diffviewer`	Diff viewer view.
`reviewboard.reviews.views.download_diff`	Views for downloading diffs.
`reviewboard.reviews.views.email`	Views for e-mail previews.
`reviewboard.reviews.views.mixins`	Mixins for review request views.
`reviewboard.reviews.views.new_review_request`	View for the New Review Request page.
`reviewboard.reviews.views.review_request_detail`	Main review request page view.
`reviewboard.reviews.views.review_request_infobox`	View for rendering the review request infobox.
`reviewboard.reviews.views.review_request_updates`	View for sending data for updating the review request page.
`reviewboard.reviews.views.root`	Root view for reviews.

Repository Communication¶

`reviewboard.scmtools.certs`
`reviewboard.scmtools.conditions`	Condition choices and operators for repositories and SCMTools.
`reviewboard.scmtools.core`	Data structures and classes for defining and using SCMTools.
`reviewboard.scmtools.crypto_utils`
`reviewboard.scmtools.errors`	Repository-related errors.
`reviewboard.scmtools.forms`	Forms for configuring repositories.
`reviewboard.scmtools.managers`	Model managers for Repository and Tool.
`reviewboard.scmtools.models`	Models for repository support.
`reviewboard.scmtools.signals`
`reviewboard.scmtools.testing`	Testing infrastructure for repository support.
`reviewboard.scmtools.testing.queries`	Testing utilities for building expected queries for repositories.
`reviewboard.scmtools.tests.testcases`

Search¶

`reviewboard.search.fields`	Custom search index fields.
`reviewboard.search.forms`	Forms for searching Review Board.
`reviewboard.search.indexes`
`reviewboard.search.search_backends.base`	The base search backend classes.
`reviewboard.search.search_backends.elasticsearch`	A backend for the Elasticsearch search engine.
`reviewboard.search.search_backends.registry`	The search engine backend registry.
`reviewboard.search.search_backends.whoosh`	A backend for the Whoosh search engine.
`reviewboard.search.signal_processor`	The signal processor for Review Board search.
`reviewboard.search.testing`	Search-related testing utilities.

Local Sites¶

`reviewboard.site.conditions`	Condition support for Local Sites.
`reviewboard.site.context_processors`
`reviewboard.site.decorators`	Decorators for checking Local Site access.
`reviewboard.site.middleware`	Middleware for Local Sites.
`reviewboard.site.mixins`	Mixins for LocalSite-related views and forms.
`reviewboard.site.models`	Models for Local Sites.
`reviewboard.site.signals`
`reviewboard.site.templatetags.localsite`
`reviewboard.site.testing`	Testing infrastructure for Local Site support.
`reviewboard.site.testing.queries`	Testing utilities for building expected queries for Local Sites.
`reviewboard.site.urlresolvers`
`reviewboard.site.validation`

SSH¶

`reviewboard.ssh.client`
`reviewboard.ssh.errors`
`reviewboard.ssh.policy`
`reviewboard.ssh.storage`
`reviewboard.ssh.utils`

Unit Test Helpers¶

`reviewboard.testing.hosting_services`
`reviewboard.testing.queries`	Common testing utilities for building expected queries.
`reviewboard.testing.queries.base`	Base patterns and support for defining expected queries for unit tests.
`reviewboard.testing.queries.http`	Testing utilities for building HTTP-related expected queries.
`reviewboard.testing.scmtool`
`reviewboard.testing.testcase`	Base test case support for Review Board.

Themes¶

`reviewboard.themes`	Support for themes for controlling Review Board appearance.
`reviewboard.themes.context_processors`	Context processors for theme-related state.
`reviewboard.themes.ui`	Support for themes for Review Board's UI.
`reviewboard.themes.ui.base`	Base support for defining UI themes.
`reviewboard.themes.ui.default`	Default UI themes for Review Board.
`reviewboard.themes.ui.registry`	Registries for Review Board UI theme support.

Web API¶

`reviewboard.webapi.auth_backends`
`reviewboard.webapi.base`
`reviewboard.webapi.decorators`	Decorators for API handlers.
`reviewboard.webapi.errors`	Review Board API errors.
`reviewboard.webapi.mixins`
`reviewboard.webapi.models`	Models for API tokens.
`reviewboard.webapi.server_info`	Server information and capability registration for the API.
`reviewboard.webapi.testing`	Testing infrastructure for API support.
`reviewboard.webapi.testing.queries`	Testing utilities for API unit tests.
`reviewboard.webapi.tests.base`	Base helpers for WebAPI unit tests.

See also

djblets.webapi