• 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. Review Board 7.x
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Extending Review Board
    14. Module and Class References
    15. reviewboard.reviews.managers
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • Review Board Workflows
  • Account Settings
  • Dashboard
  • Working with Review Requests
  • Overview
  • Creating Review Requests
  • Editing Fields
  • Uploading Diffs
  • Uploading File Attachments
  • Publishing Review Requests
  • Closing Review Requests
  • Reviewing
  • Reviews and Comments
  • The Review Banner
  • Managing and Publishing Drafts
  • Issue Tracking
  • Reviewing Code (Diffs)
  • Reviewing File Attachments
  • Reviewing Images
  • Reviewing Markdown Files
  • Reviewing Text Files
  • Creating and Editing Reviews
  • Approving Changes (Ship It!)
  • Replying to Comments
  • Automated Code Reviews
  • Searching
  • Quick Search
  • Full-Text Search
  • Using Markdown
  • Administration Guide
  • Installation
  • Installing Review Board
  • Linux System Compatibility
  • Installing with Docker
  • Manually Installing on Linux
  • Installing on macOS
  • Installing on Windows
  • Installing Development Releases
  • Creating a Review Board Site
  • Upgrading
  • Upgrading Review Board
  • Upgrading Review Board Sites
  • Optimization
  • Optimizing and Scaling Review Board
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Configuration
  • Site Settings
  • General Settings
  • Authentication Settings
  • Avatar Services Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • SSH Settings
  • File Storage Settings
  • User Privacy Settings
  • Search Settings
  • Access Control
  • Working with E-Mail
  • Default Reviewers
  • Permission Groups
  • Repositories
  • Bazaar Repositories
  • CVS Repositories
  • Git Repositories
  • HCL VersionVault and IBM ClearCase
  • Mercurial Repositories
  • Perforce Repositories
  • Subversion Repositories
  • Assembla Repositories
  • AWS CodeCommit Repositories
  • Beanstalk Repositories
  • Bitbucket Repositories
  • Bitbucket Server Repositories
  • Codebase HQ Repositories
  • Fedora Hosted Repositories
  • Gerrit Repositories
  • GitHub Repositories
  • GitHub Enterprise Repositories
  • GitLab Repositories
  • Gitorious Repositories
  • Cliosoft SOS Repositories
  • SourceForge Repositories
  • Unfuddle STACK Repositories
  • VisualStudio.com Repositories
  • Review Groups
  • Users
  • WebHooks
  • Extensions
  • Integrations
  • Asana Integration
  • CircleCI Integration
  • Discord Integration
  • I Done This Integration
  • Jenkins CI Integration
  • Matrix Integration
  • Mattermost Integration
  • Microsoft Teams Integration
  • Slack Integration
  • Travis CI Integration
  • Trello Integration
  • Site Maintenance
  • The rb-site Tool
  • Advanced Management Commands
  • Monitoring Review Board
  • Health Checks
  • Web API Guide
  • Resource Tree
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • 219 - Diff Empty
  • 220 - Diff Too Big
  • 221 - File Retrieval Error
  • 222 - Hosting Service Authentication Error
  • 223 - Group Already Exists
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • REST API 2.0
  • Overview
  • Authenticating
  • API Token Policies
  • OAuth2 Authentication
  • Rich Text Fields and Types
  • Storing/Accessing Extra Data
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • 219 - Diff Empty
  • 220 - Diff Too Big
  • 221 - File Retrieval Error
  • 222 - Hosting Service Authentication Error
  • 223 - Group Already Exists
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • Glossary
  • Extending Review Board
  • Extension Files/Package Layout
  • Creating an Extension Class
  • Extension Configuration
  • Database Models
  • Extension Static Media Files
  • JavaScript Extensions
  • Testing Extensions
  • Extension Distribution
  • Writing Review Board Extensions
  • The rbext Tool
  • Extension Hooks
  • AccountPageFormsHook
  • AccountPagesHook
  • Action Hooks
  • AdminWidgetHook
  • APIExtraDataAccessHook
  • AuthBackendHook
  • AvatarServiceHook
  • CommentDetailDisplayHook
  • DashboardColumnsHook
  • DashboardSidebarItemsHook
  • DataGridColumnsHook
  • EmailHook
  • ReviewRequestPublishedEmailHook
  • ReviewRequestClosedEmailHook
  • ReviewPublishedEmailHook
  • ReviewReplyPublishedEmailHook
  • FileAttachmentThumbnailHook
  • FileDiffACLHook
  • HostingServiceHook
  • IntegrationHook
  • NavigationBarHook
  • ReviewRequestApprovalHook
  • ReviewRequestFieldsHook
  • ReviewRequestFieldSetsHook
  • ReviewUIHook
  • SCMToolHook
  • SignalHook
  • TemplateHook
  • URLHook
  • UserInfoboxHook
  • UserPageSidebarItemsHook
  • WebAPICapabilitiesHook
  • JavaScript Extension Hooks
  • CommentDialogHook
  • FileAttachmentThumbnailContainerHook
  • ReviewDialogCommentHook
  • ReviewDialogHook
  • Adding Review Request Fields
  • Review UI Integration
  • Writing Authentication Backends
  • Writing Legacy Authentication Backends
  • Extending the Web API
  • Module and Class References
  • reviewboard
  • reviewboard.deprecation
  • reviewboard.rb_platform
  • reviewboard.signals
  • reviewboard.accounts.backends
  • reviewboard.accounts.backends.ad
  • reviewboard.accounts.backends.base
  • reviewboard.accounts.backends.http_digest
  • reviewboard.accounts.backends.ldap
  • reviewboard.accounts.backends.nis
  • reviewboard.accounts.backends.registry
  • reviewboard.accounts.backends.standard
  • reviewboard.accounts.backends.x509
  • reviewboard.accounts.decorators
  • reviewboard.accounts.errors
  • reviewboard.accounts.forms.auth
  • reviewboard.accounts.forms.pages
  • reviewboard.accounts.forms.registration
  • reviewboard.accounts.managers
  • reviewboard.accounts.middleware
  • reviewboard.accounts.mixins
  • reviewboard.accounts.models
  • reviewboard.accounts.pages
  • reviewboard.accounts.privacy
  • reviewboard.accounts.templatetags.accounts
  • reviewboard.accounts.testing
  • reviewboard.accounts.testing.queries
  • reviewboard.accounts.trophies
  • reviewboard.actions
  • reviewboard.actions.base
  • reviewboard.actions.errors
  • reviewboard.actions.registry
  • reviewboard.admin
  • reviewboard.admin.admin_sites
  • reviewboard.admin.cache_stats
  • reviewboard.admin.checks
  • reviewboard.admin.decorators
  • reviewboard.admin.form_widgets
  • reviewboard.admin.middleware
  • reviewboard.admin.model_admin
  • reviewboard.admin.security_checks
  • reviewboard.admin.server
  • reviewboard.admin.siteconfig
  • reviewboard.admin.support
  • reviewboard.admin.validation
  • reviewboard.admin.widgets
  • reviewboard.attachments.errors
  • reviewboard.attachments.forms
  • reviewboard.attachments.managers
  • reviewboard.attachments.mimetypes
  • reviewboard.attachments.models
  • reviewboard.avatars.registry
  • reviewboard.avatars.services
  • reviewboard.avatars.settings
  • reviewboard.avatars.templatetags.avatars
  • reviewboard.avatars.testcase
  • reviewboard.changedescs.models
  • reviewboard.datagrids.columns
  • reviewboard.datagrids.grids
  • reviewboard.datagrids.sidebar
  • reviewboard.diffviewer.chunk_generator
  • reviewboard.diffviewer.differ
  • reviewboard.diffviewer.diffutils
  • reviewboard.diffviewer.errors
  • reviewboard.diffviewer.forms
  • reviewboard.diffviewer.managers
  • reviewboard.diffviewer.models
  • reviewboard.diffviewer.models.diffcommit
  • reviewboard.diffviewer.models.diffset
  • reviewboard.diffviewer.models.diffset_history
  • reviewboard.diffviewer.models.filediff
  • reviewboard.diffviewer.models.legacy_file_diff_data
  • reviewboard.diffviewer.models.raw_file_diff_data
  • reviewboard.diffviewer.myersdiff
  • reviewboard.diffviewer.opcode_generator
  • reviewboard.diffviewer.parser
  • reviewboard.diffviewer.processors
  • reviewboard.diffviewer.renderers
  • reviewboard.diffviewer.smdiff
  • reviewboard.certs
  • reviewboard.certs.cert
  • reviewboard.certs.errors
  • reviewboard.extensions.base
  • reviewboard.extensions.hooks
  • reviewboard.extensions.packaging
  • reviewboard.extensions.testing
  • reviewboard.extensions.testing.testcases
  • reviewboard.hostingsvcs.base
  • reviewboard.hostingsvcs.base.client
  • reviewboard.hostingsvcs.base.forms
  • reviewboard.hostingsvcs.base.hosting_service
  • reviewboard.hostingsvcs.base.http
  • reviewboard.hostingsvcs.base.paginator
  • reviewboard.hostingsvcs.base.registry
  • reviewboard.hostingsvcs.base.repository
  • reviewboard.hostingsvcs.errors
  • reviewboard.hostingsvcs.forms
  • reviewboard.hostingsvcs.hook_utils
  • reviewboard.hostingsvcs.models
  • reviewboard.hostingsvcs.repository
  • reviewboard.hostingsvcs.service
  • reviewboard.hostingsvcs.testing
  • reviewboard.hostingsvcs.testing.testcases
  • reviewboard.hostingsvcs.utils.paginator
  • reviewboard.integrations
  • reviewboard.integrations.base
  • reviewboard.integrations.forms
  • reviewboard.integrations.models
  • reviewboard.integrations.urls
  • reviewboard.integrations.views
  • reviewboard.notifications
  • reviewboard.notifications.email
  • reviewboard.notifications.email.backend
  • reviewboard.notifications.email.decorators
  • reviewboard.notifications.email.hooks
  • reviewboard.notifications.email.message
  • reviewboard.notifications.email.utils
  • reviewboard.notifications.email.views
  • reviewboard.notifications.forms
  • reviewboard.notifications.managers
  • reviewboard.notifications.models
  • reviewboard.notifications.webhooks
  • reviewboard.reviews.actions
  • reviewboard.reviews.builtin_fields
  • reviewboard.reviews.chunk_generators
  • reviewboard.reviews.conditions
  • reviewboard.reviews.context
  • reviewboard.reviews.default_actions
  • reviewboard.reviews.detail
  • reviewboard.reviews.errors
  • reviewboard.reviews.features
  • reviewboard.reviews.fields
  • reviewboard.reviews.forms
  • reviewboard.reviews.managers
  • reviewboard.reviews.markdown_utils
  • reviewboard.reviews.models
  • reviewboard.reviews.signals
  • reviewboard.reviews.templatetags.reviewtags
  • reviewboard.reviews.testing
  • reviewboard.reviews.testing.queries
  • reviewboard.reviews.testing.queries.review_groups
  • reviewboard.reviews.testing.queries.review_requests
  • reviewboard.reviews.testing.queries.reviews
  • reviewboard.reviews.ui.base
  • reviewboard.reviews.ui.image
  • reviewboard.reviews.ui.markdownui
  • reviewboard.reviews.ui.text
  • reviewboard.reviews.views.attachments
  • reviewboard.reviews.views.bug_trackers
  • reviewboard.reviews.views.diff_fragments
  • reviewboard.reviews.views.diffviewer
  • reviewboard.reviews.views.download_diff
  • reviewboard.reviews.views.email
  • reviewboard.reviews.views.mixins
  • reviewboard.reviews.views.new_review_request
  • reviewboard.reviews.views.review_request_detail
  • reviewboard.reviews.views.review_request_infobox
  • reviewboard.reviews.views.review_request_updates
  • reviewboard.reviews.views.root
  • reviewboard.scmtools.certs
  • reviewboard.scmtools.conditions
  • reviewboard.scmtools.core
  • reviewboard.scmtools.crypto_utils
  • reviewboard.scmtools.errors
  • reviewboard.scmtools.forms
  • reviewboard.scmtools.managers
  • reviewboard.scmtools.models
  • reviewboard.scmtools.signals
  • reviewboard.scmtools.testing
  • reviewboard.scmtools.testing.queries
  • reviewboard.scmtools.tests.testcases
  • reviewboard.search.fields
  • reviewboard.search.forms
  • reviewboard.search.indexes
  • reviewboard.search.search_backends.base
  • reviewboard.search.search_backends.elasticsearch
  • reviewboard.search.search_backends.registry
  • reviewboard.search.search_backends.whoosh
  • reviewboard.search.signal_processor
  • reviewboard.search.testing
  • reviewboard.site.conditions
  • reviewboard.site.context_processors
  • reviewboard.site.decorators
  • reviewboard.site.middleware
  • reviewboard.site.mixins
  • reviewboard.site.models
  • reviewboard.site.signals
  • reviewboard.site.templatetags.localsite
  • reviewboard.site.testing
  • reviewboard.site.testing.queries
  • reviewboard.site.urlresolvers
  • reviewboard.site.validation
  • reviewboard.ssh.client
  • reviewboard.ssh.errors
  • reviewboard.ssh.policy
  • reviewboard.ssh.storage
  • reviewboard.ssh.utils
  • reviewboard.testing.hosting_services
  • reviewboard.testing.queries
  • reviewboard.testing.queries.base
  • reviewboard.testing.queries.http
  • reviewboard.testing.scmtool
  • reviewboard.testing.testcase
  • reviewboard.themes
  • reviewboard.themes.context_processors
  • reviewboard.themes.ui
  • reviewboard.themes.ui.base
  • reviewboard.themes.ui.default
  • reviewboard.themes.ui.registry
  • reviewboard.webapi.auth_backends
  • reviewboard.webapi.base
  • reviewboard.webapi.decorators
  • reviewboard.webapi.errors
  • reviewboard.webapi.mixins
  • reviewboard.webapi.models
  • reviewboard.webapi.server_info
  • reviewboard.webapi.testing
  • reviewboard.webapi.testing.queries
  • reviewboard.webapi.tests.base
  • Frequently Asked Questions
  • General Index
  • Python Module Index
  • Release Notes
  • reviewboard.reviews.managers¶

    Managers for reviewboard.reviews.models.

    class CommentManager(*args, **kwargs)[source]¶

    Bases: ConcurrencyManager

    A manager for Comment models.

    This handles concurrency issues with Comment models.

    New in version 5.0.

    accessible(user, extra_query=None, local_site=None, distinct=False)[source]¶

    Return a queryset for comments accessible by the given user.

    For superusers, all comments in all reviews will be returned.

    For regular users, only comments in reviews that they own or that are in the repositories, local sites, and review groups which the user has access to will be returned.

    For anonymous users, only comments that are in public repositories and whose review requests are not targeted by invite-only review groups will be returned.

    Parameters:
    • user (django.contrib.auth.models.User) – The User object that must have access to any returned comments.

    • extra_query (django.db.models.Q, optional) – Additional query parameters to add for filtering down the resulting queryset.

    • local_site (reviewboard.site.models.LocalSite or :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` reviewboard.site.models.LocalSite.ALL, optional) –

      A specific Local Site that the comments must be associated with. It is assumed that the given user has access to the Local Site. By default, this will only return comments not part of a site.

      This may be LocalSite.ALL.

    • distinct (bool, optional) –

      Whether to return distinct results.

      Turning this on can decrease performance. It’s off by default.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    from_user(user, *args, **kwargs)[source]¶

    Return the query for comments created by a user.

    Parameters:
    • user (django.contrib.auth.models.User) – The User object to query for.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    A queryset for all the comments created by the given user.

    Return type:

    django.db.models.query.QuerySet

    __annotations__ = {}¶
    __slotnames__ = []¶
    class DefaultReviewerManager(*args, **kwargs)[source]¶

    Bases: Manager

    A manager for DefaultReviewer models.

    for_repository(repository, local_site)[source]¶

    Returns all DefaultReviewers that represent a repository.

    These include both DefaultReviewers that have no repositories (for backwards-compatibility) and DefaultReviewers that are associated with the given repository.

    can_create(user, local_site=None)[source]¶

    Returns whether the user can create default reviewers.

    __annotations__ = {}¶
    __slotnames__ = []¶
    class ReviewGroupManager(*args, **kwargs)[source]¶

    Bases: Manager

    A manager for Group models.

    accessible(user, *, visible_only=True, local_site=None, distinct=True)[source]¶

    Return a queryset for review groups accessible by the given user.

    For superusers, all public and invite-only review groups will be returned.

    For regular users, only review groups that are public or that the user is on the access list for will be returned.

    For anonymous users, only public review groups will be returned.

    The returned list is further filtered down based on the visible_only and local_site parameters.

    Note

    This is not responsible for checking if a user has access to a given local_site. This function assumes that access has already been checked.

    Changed in version 6.0: Removed the show_all_local_sites argument.

    Changed in version 5.0: Deprecated show_all_local_sites and added support for setting local_site to LocalSite.ALL.

    Changed in version 3.0.24: Added the distinct parameter.

    Parameters:
    • user (django.contrib.auth.models.User) – The user that must have access to any returned groups.

    • visible_only (bool, optional) – Whether only visible review groups should be returned.

    • local_site (reviewboard.site.models.LocalSite or :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` reviewboard.site.models.LocalSite.ALL, optional) –

      A specific Local Site that the groups must be associated with. By default, this will only return groups not part of a site.

      This may be LocalSite.ALL.

      Changed in version 5.0: Added support for LocalSite.ALL.

    • distinct (bool, optional) –

      Whether to return distinct results.

      Turning this off can increase performance. It’s on by default for backwards-compatibility.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    accessible_ids(*args, **kwargs)[source]¶

    Return IDs of groups that are accessible by the given user.

    This wraps accessible() and takes the same arguments (with the exception of distinct, which is ignored).

    Changed in version 3.0.24: In prior versions, the order was not specified, but was generally numeric order. This should still be true, but officially, we no longer guarantee any order of results.

    Parameters:
    • *args (tuple) – Positional arguments to pass to accessible().

    • **kwargs (dict) – Keyword arguments to pass to accessible().

    Returns:

    The list of IDs.

    Return type:

    list of int

    can_create(user, local_site=None)[source]¶

    Returns whether the user can create groups.

    __annotations__ = {}¶
    __slotnames__ = []¶
    class ReviewRequestQuerySet(model=None, query=None, using=None, hints=None)[source]¶

    Bases: QuerySet

    with_counts(user)[source]¶
    __annotations__ = {}¶
    class ReviewRequestManager(*args, **kwargs)[source]¶

    Bases: ConcurrencyManager

    A manager for review requests. Provides specialized queries to retrieve review requests with specific targets or origins, and to create review requests based on certain data.

    get_queryset()[source]¶

    Return a QuerySet for ReviewRequest models.

    Returns:

    The new QuerySet instance.

    Return type:

    ReviewRequestQuerySet

    create(user, repository, commit_id=None, local_site=None, create_from_commit_id=False, create_with_history=False)[source]¶

    Create a new review request.

    Parameters:
    • user (django.contrib.auth.models.User) – The user creating the review request. They will be tracked as the submitter.

    • repository (reviewboard.scmtools.Models.Repository) –

      The repository, if any, the review request is associated with.

      If None, diffs cannot be added to the review request.

    • commit_id (unicode, optional) – An optional commit ID.

    • local_site (reviewboard.site.models.LocalSite, optional) – An optional LocalSite to associate the review request with.

    • create_from_commit_id (bool, optional) – Whether or not the given commit_id should be used to pre-populate the review request data. If True, the given repository will be used to do so.

    • create_with_history (bool, optional) –

      Whether or not the created review request will support attaching multiple commits per diff revision.

      If False, it will not be possible to use the DiffResource to upload diffs; the DiffCommitResource must be used instead.

    Returns:

    The created review request.

    Return type:

    reviewboard.reviews.models.review_request.ReviewRequest

    Raises:
    • reviewboard.hostingsvcs.errors.HostingServiceError – The hosting service backing the repository encountered an error.

    • reviewboard.scmtools.errors.ChangeNumberInUseError – The commit ID is already in use by another review request.

    • reviewboard.scmtools.errors.SCMError – The repository tool encountered an error.

    • ValueError – An invalid value was passed for an argument.

    get_to_group_query(group_name, local_site)[source]¶

    Return a Q() query object targeting a group.

    This is meant to be passed as an extra_query argument to public().

    Parameters:
    • group_name (str) – The name of the review group the review requests must be assigned to.

    • local_site (reviewboard.site.models.LocalSite) –

      The Local Site that the review requests must be on, if any.

      This does not accept LocalSite.ALL.

      Callers should first validate that the user has access to the Local Site, if provided.

    Returns:

    The query object.

    Return type:

    django.db.models.Q

    get_to_user_groups_query(user_or_username)[source]¶

    Return a Q() query object targeting groups joined by a user.

    This is meant to be passed as an extra_query argument to public().

    Parameters:

    user_or_username (django.contrib.auth.models.User or str) – The User instance or username that all review requests must be assigned to indirectly.

    Returns:

    The query object.

    Return type:

    django.db.models.Q

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    get_to_user_directly_query(user_or_username)[source]¶

    Returns the query targeting a user directly.

    This will include review requests where the user has been listed as a reviewer, or the user has starred.

    This is meant to be passed as an extra_query argument to public().

    Parameters:

    user_or_username (django.contrib.auth.models.User or str) – The User instance or username that all review requests must be assigned to directly.

    Returns:

    The query object.

    Return type:

    django.db.models.Q

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    get_to_user_query(user_or_username)[source]¶

    Return a Q() query object targeting a user indirectly.

    This will include review requests where the user has been listed as a reviewer, or a group that the user belongs to has been listed, or the user has starred.

    This is meant to be passed as an extra_query argument to public().

    Parameters:

    user_or_username (django.contrib.auth.models.User or str) – The User instance or username that all review requests must be assigned to (directly to indirectly).

    Returns:

    The query object.

    Return type:

    django.db.models.Q

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    get_from_user_query(user_or_username)[source]¶

    Return a Q() query object for review requests owned by a user.

    This is meant to be passed as an extra_query argument to public().

    Parameters:

    user_or_username (django.contrib.auth.models.User or str) – The User instance or username that all review requests must be owned by.

    Returns:

    The query object.

    Return type:

    django.db.models.Q

    get_to_or_from_user_query(user_or_username)[source]¶

    Return a Q() query object for review requests involving a user.

    This is meant to be passed as an extra_query argument to public().

    Parameters:

    user_or_username (django.contrib.auth.models.User or unicode) – The User instance or username that all review requests must either be owned by or assigned to (directly to indirectly).

    Returns:

    The query object.

    Return type:

    django.db.models.Q

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    public(filter_private=True, *args, **kwargs)[source]¶

    Query public review requests, filtered by given criteria.

    Parameters:
    • filter_private (bool, optional) –

      Whether to filter out any review requests on private repositories or invite-only review groups that the user does not have access to.

      By default, they are filtered out.

      This requires user to be provided.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    to_group(group_name, local_site, *args, **kwargs)[source]¶

    Query review requests made to a review group.

    The result will be review requests assigned to a review group.

    By default, the results will not be filtered based on whether a user has access to the review requests (via private repository or invite-only review group ACLs). To filter based on access, pass filter_private=True.

    Parameters:
    • group_name (str) – The name of the review group the review requests must be assigned to.

    • local_site (reviewboard.site.models.LocalSite) –

      The Local Site that the review requests must be on, if any.

      This does not accept LocalSite.ALL.

      Callers should first validate that the user has access to the Local Site, if provided.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    to_or_from_user(user_or_username, *args, **kwargs)[source]¶

    Query review requests a user is involved in.

    The result will be review requests from a user, assigned to the user, or assigned to a group the user is in.

    By default, the results will not be filtered based on whether a user has access to the review requests (via private repository or invite-only review group ACLs). To filter based on access, pass filter_private=True.

    Parameters:
    • user_or_username (django.contrib.auth.models.User or unicode) – The User instance or username that all review requests must either be owned by or assigned to (directly to indirectly).

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    A queryset of all review requests the users is involved in as either a submitter or a reviewer (either directly assigned or indirectly as a member of a group).

    Return type:

    django.db.models.query.QuerySet

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    to_user_groups(username, *args, **kwargs)[source]¶

    Query review requests made to a user’s review groups.

    The result will be review requests assigned to a group the user is in.

    By default, the results will not be filtered based on whether a user has access to the review requests (via private repository or invite-only review group ACLs). To filter based on access, pass filter_private=True.

    Parameters:

    username (django.contrib.auth.models.User or str) – The User instance or username.

    Returns:

    A queryset of all review requests the users is involved in as either a submitter or a reviewer (either directly assigned or indirectly as a member of a group).

    Return type:

    django.db.models.query.QuerySet

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    to_user_directly(user_or_username, *args, **kwargs)[source]¶

    Query review requests assigned directly to a user.

    The result will be review requests assigned to the user.

    By default, the results will not be filtered based on whether a user has access to the review requests (via private repository or invite-only review group ACLs). To filter based on access, pass filter_private=True.

    Parameters:
    • user_or_username (django.contrib.auth.models.User or unicode) – The user object or username to query for.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    to_user(user_or_username, *args, **kwargs)[source]¶

    Query review requests assigned directly or indirectly to a user.

    The result will be review requests assigned to the user or to a group the user is in.

    By default, the results will not be filtered based on whether a user has access to the review requests (via private repository or invite-only review group ACLs). To filter based on access, pass filter_private=True.

    Parameters:
    • user_or_username (django.contrib.auth.models.User or unicode) – The user object or username to query for.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    Raises:

    django.contrib.auth.models.User.DoesNotExist – A username was provided, and that user does not exist.

    from_user(user_or_username, *args, **kwargs)[source]¶

    Query review requests from a user.

    The result will be review requests created or currently owned by a user.

    By default, the results will not be filtered based on whether a user has access to the review requests (via private repository or invite-only review group ACLs). To filter based on access, pass filter_private=True.

    Parameters:
    • user_or_username (django.contrib.auth.models.User or unicode) – The user object or username to query for.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    for_id(pk, local_site=None)[source]¶

    Returns the review request matching the given ID and LocalSite.

    If a LocalSite is provided, then the ID will be matched against the displayed ID for the LocalSite, rather than the in-database ID.

    __annotations__ = {}¶
    __slotnames__ = []¶
    class ReviewManager(*args, **kwargs)[source]¶

    Bases: ConcurrencyManager

    A manager for Review models.

    This handles concurrency issues with Review models. In particular, it will try hard not to save two reviews at the same time, and if it does manage to do that (which may happen for pending reviews while a server is under heavy load), it will repair and consolidate the reviews on load. This prevents errors and lost data.

    ANY = <ReviewManager.ANY>[source]¶
    accessible(user: User, extra_query: Optional[Q] = None, local_site: Optional[LocalSite] = None, public: Optional[bool] = None, base_reply_to: Optional[Union[Review, _ReviewANY]] = None, distinct: Optional[bool] = False) → QuerySet[source]¶

    Return a queryset for reviews accessible by the given user.

    For superusers, all public (published) and unpublished reviews will be returned.

    For regular users, only reviews that are owned by the user or that are public in the repositories, local sites, and review groups which the user has access to will be returned.

    For anonymous users, only public reviews that are on public repositories and whose review requests are not targeted by invite-only review groups will be returned.

    Changed in version 6.0: Added the base_reply_to argument.

    New in version 5.0.

    Parameters:
    • user (django.contrib.auth.models.User) – The User object that must have access to any returned reviews.

    • extra_query (django.db.models.Q, optional) – Additional query parameters to add for filtering down the resulting queryset.

    • local_site (reviewboard.site.models.LocalSite or :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` :class:`` reviewboard.site.models.LocalSite.ALL, optional) –

      A specific Local Site that the reviews must be associated with. It is assumed that the given user has access to the Local Site. By default, this will only return reviews not part of a site.

      This may be LocalSite.ALL.

    • public (bool or None, optional) – Whether to filter for public (published) reviews. If set to None, both published and unpublished reviews will be included.

    • base_reply_to (reviewboard.reviews.models.review.Review, optional) – If provided, limit results to reviews that are part of the thread of replies to this review.

    • distinct (bool, optional) –

      Whether to return distinct results.

      Turning this on can decrease performance. It’s off by default.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.query.QuerySet

    get_pending_review(review_request, user)[source]¶

    Return a user’s pending review on a review request.

    This will handle fixing duplicate reviews if more than one pending review is found.

    Parameters:
    • review_request (reviewboard.reviews.models.review_request.ReviewRequest) – The review request being reviewed.

    • user (django.contrib.auth.models.User) – The user making the review.

    Returns:

    The pending review object.

    Return type:

    reviewboard.reviews.models.review.Review

    get_pending_reply(review, user)[source]¶

    Return a user’s pending reply to a given review.

    This will handle fixing duplicate reviews if more than one pending review reply is found.

    Parameters:
    • review (reviewboard.reviews.models.review.Review) – The review being replied to.

    • user (django.contrib.auth.models.User) – The user making the reply.

    Returns:

    The pending review object.

    Return type:

    reviewboard.reviews.models.review.Review

    fix_duplicate_reviews(reviews)[source]¶

    Fix duplicate reviews, condensing them into a single review.

    This will consolidate the data from all reviews into the first review in the list, and return the first review.

    Parameters:

    reviews (list of reviewboard.reviews.models.review.Review) – The list of duplicate reviews.

    Returns:

    The first review in the list containing the consolidated data.

    Return type:

    reviewboard.reviews.models.review.Review

    from_user(user_or_username, *args, **kwargs)[source]¶

    Return the query for reviews created by a user.

    Parameters:
    • user_or_username (django.contrib.auth.models.User or str) – The User object or username.

    • *args (tuple) – Additional positional arguments to pass to the common _query() function.

    • **kwargs (dict) – Additional keyword arguments to pass to the common _query() function.

    Returns:

    A queryset for all the reviews created by the given user.

    Return type:

    django.db.models.query.QuerySet

    __annotations__ = {}¶
    __slotnames__ = []¶
    class StatusUpdateManager(*args, **kwargs)[source]¶

    Bases: Manager

    A manager for StatusUpdate models.

    This offers conveniences around creating StatusUpdate models for custom integrations.

    New in version 5.0.3.

    create_for_integration(integration: Integration, *, config: IntegrationConfig, user: User, review_request: ReviewRequest, change_description: Optional[ChangeDescription] = None, service_id: Optional[str] = None, summary: Optional[str] = None, description: Optional[str] = None, state: Optional[str] = None, can_retry: bool = False, extra_data: Dict = {}, starting_description: str = 'starting...', waiting_description: str = 'waiting to run.', **kwargs) → StatusUpdate[source]¶

    Return a new status update for a given integration.

    This helps with generating defaults for a status update, and putting it in the correct initial state when running manually.

    The integration configuration will be associated with the status update, which is important for manually running integrations when multiple integrations are present on a review request.

    Parameters:
    • integration (reviewboard.integrations.base.Integration) – The integration that this status update will be associated with.

    • config (reviewboard.integrations.models.IntegrationConfig) – The configuration for the integration, used to provide defaults and used for later manual runs.

    • user (django.contrib.auth.models.User) – The user that the status update will be associated with.

    • review_request (reviewboard.reviews.models.review_request.ReviewRequest) – The review request that the status update will be associated with.

    • change_description (reviewboard.changedescs.models.ChangeDescription, optional) – The optional change description that the status update will be associated with.

    • service_id (str, optional) –

      An explicit service ID for the status update.

      If not provided (or if None), a slugified version of the integration’s name will be used.

    • summary (str, optional) –

      An explicit summary for the status update.

      If not provided (or if None), the integration name will be used.

    • description (str, optional) –

      An explicit description for the status update.

      If not provided (or if None), a standardized description will be used depending on whether the status update will be created in manual run mode.

      See starting_description and waiting_description to customize these strings.

    • state (str, optional) –

      An explicit state for the status update.

      If not provided (or if None), the state will be in Not Yet Run if creating in manual run mode, or Pending otherwise.

    • can_retry (bool, optional) – Whether the status update can be retried after being run.

    • extra_data (dict, optional) – Extra data to store in the status update.

    • starting_description (str, optional) – The description to use if creating a status update that is immediately starting.

    • waiting_description (str, optional) – The description to use if creating a status update that is in manual run mode.

    • **kwargs (dict, optional) – Additional keyword arguments for the model.

    Returns:

    The new status update.

    Return type:

    reviewboard.reviews.status_update.StatusUpdate

    __annotations__ = {}¶
    __slotnames__ = []¶

    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-2025 Beanbag, Inc. All rights reserved.

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

    On this page

    • [Top]
    • CommentManager
      • CommentManager.accessible()
      • CommentManager.from_user()
      • CommentManager.__annotations__
      • CommentManager.__slotnames__
    • DefaultReviewerManager
      • DefaultReviewerManager.for_repository()
      • DefaultReviewerManager.can_create()
      • DefaultReviewerManager.__annotations__
      • DefaultReviewerManager.__slotnames__
    • ReviewGroupManager
      • ReviewGroupManager.accessible()
      • ReviewGroupManager.accessible_ids()
      • ReviewGroupManager.can_create()
      • ReviewGroupManager.__annotations__
      • ReviewGroupManager.__slotnames__
    • ReviewRequestQuerySet
      • ReviewRequestQuerySet.with_counts()
      • ReviewRequestQuerySet.__annotations__
    • ReviewRequestManager
      • ReviewRequestManager.get_queryset()
      • ReviewRequestManager.create()
      • ReviewRequestManager.get_to_group_query()
      • ReviewRequestManager.get_to_user_groups_query()
      • ReviewRequestManager.get_to_user_directly_query()
      • ReviewRequestManager.get_to_user_query()
      • ReviewRequestManager.get_from_user_query()
      • ReviewRequestManager.get_to_or_from_user_query()
      • ReviewRequestManager.public()
      • ReviewRequestManager.to_group()
      • ReviewRequestManager.to_or_from_user()
      • ReviewRequestManager.to_user_groups()
      • ReviewRequestManager.to_user_directly()
      • ReviewRequestManager.to_user()
      • ReviewRequestManager.from_user()
      • ReviewRequestManager.for_id()
      • ReviewRequestManager.__annotations__
      • ReviewRequestManager.__slotnames__
    • ReviewManager
      • ReviewManager.ANY
      • ReviewManager.accessible()
      • ReviewManager.get_pending_review()
      • ReviewManager.get_pending_reply()
      • ReviewManager.fix_duplicate_reviews()
      • ReviewManager.from_user()
      • ReviewManager.__annotations__
      • ReviewManager.__slotnames__
    • StatusUpdateManager
      • StatusUpdateManager.create_for_integration()
      • StatusUpdateManager.__annotations__
      • StatusUpdateManager.__slotnames__