• 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.scmtools.models
  • 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.scmtools.models¶

    Models for repository support.

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

    Bases: Model

    A configured source code management tool.

    Each SCMTool used by repositories must have a corresponding Tool entry. These provide information on the capabilities of the tool, and accessors to construct a tool for a repository.

    Deprecated since version 5.0: This model is now obsolete. Any usage of this should be updated to use equivalent methods on the Repository or SCMTool instead.

    name[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    class_name[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    objects: ClassVar[ToolManager] = <reviewboard.scmtools.managers.ToolManager object>¶
    property field_help_text[source]¶

    Overridden help text for the configuration form fields.

    See SCMTool.field_help_text for details.

    property scmtool_id: str[source]¶

    The unique ID for the SCMTool.

    Type:

    str

    get_scmtool_class() → type[SCMTool][source]¶

    Return the configured SCMTool class.

    Returns:

    The subclass of SCMTool backed by this Tool entry.

    Return type:

    type

    Raises:

    django.core.exceptions.ImproperlyConfigured – The SCMTool could not be found.

    property scmtool_class: type[SCMTool][source]¶

    Return the configured SCMTool class.

    Returns:

    The subclass of SCMTool backed by this Tool entry.

    Return type:

    type

    Raises:

    django.core.exceptions.ImproperlyConfigured – The SCMTool could not be found.

    __str__() → str[source]¶

    Return the name of the tool.

    Returns:

    The name of the tool.

    Return type:

    str

    __annotations__ = {'objects': 'ClassVar[ToolManager]'}¶
    id¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    repositories¶

    Accessor to the related objects manager on the reverse side of a many-to-one relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Parent.children is a ReverseManyToOneDescriptor instance.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

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

    Bases: Model

    A configured external source code repository.

    Each configured Repository entry represents a source code repository that Review Board can communicate with as part of the diff uploading and viewing process.

    Repositories are backed by a SCMTool, which functions as a client for the type of repository and can fetch files, load lists of commits and branches, and more.

    Access control is managed by a combination of the public, users, and groups fields. public controls whether a repository is publicly-accessible by all users on the server. When False, only users explicitly listed in users or users who are members of the groups listed in groups will be able to access the repository or view review requests posted against it.

    BRANCHES_CACHE_PERIOD: Final[int] = 300¶

    The amount of time branches are cached, in seconds.

    Branches are cached for 5 minutes.

    COMMITS_CACHE_PERIOD_SHORT: Final[int] = 300¶

    The short period of time to cache commit information, in seconds.

    Some commit information (such as retrieving the latest commits in a repository) should result in information cached only for a short period of time. This is set to cache for 5 minutes.

    COMMITS_CACHE_PERIOD_LONG: Final[int] = 86400¶

    The long period of time to cache commit information, in seconds.

    Commit information that is unlikely to change should be kept around for a longer period of time. This is set to cache for 1 day.

    FALLBACK_ENCODING: Final[str] = 'iso-8859-15'¶

    The fallback encoding for text-based files in repositories.

    This is used if the file isn’t valid UTF-8, and if the repository doesn’t specify a list of encodings.

    NAME_CONFLICT_ERROR: Final[StrPromise] = 'A repository with this name already exists'¶

    The error message used to indicate that a repository name conflicts.

    PATH_CONFLICT_ERROR: Final[StrPromise] = 'A repository with this path already exists'¶

    The error message used to indicate that a repository path conflicts.

    ENCRYPTED_PASSWORD_PREFIX: Final[str] = '\t'¶

    The prefix used to indicate an encrypted password.

    This is used to indicate whether a stored password is in encrypted form or plain text form.

    name[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    path[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    mirror_path[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    raw_file_url[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    username[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    encrypted_password[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    extra_data[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    tool[source]¶

    Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Child.parent is a ForwardManyToOneDescriptor instance.

    scmtool_id[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    hosting_account[source]¶

    Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Child.parent is a ForwardManyToOneDescriptor instance.

    bug_tracker[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    encoding[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    visible[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    archived[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    archived_timestamp[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    local_site[source]¶

    Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Child.parent is a ForwardManyToOneDescriptor instance.

    public[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    users[source]¶

    Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

    In the example:

    class Pizza(Model):
        toppings = ManyToManyField(Topping, related_name='pizzas')
    

    Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    review_groups[source]¶

    Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

    In the example:

    class Pizza(Model):
        toppings = ManyToManyField(Topping, related_name='pizzas')
    

    Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    hooks_uuid[source]¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    objects: ClassVar[RepositoryManager] = <reviewboard.scmtools.managers.RepositoryManager object>¶
    property password: Optional[str][source]¶

    The password for the repository.

    If a password is stored and encrypted, it will be decrypted and returned.

    If the stored password is in plain-text, then it will be encrypted, stored in the database, and returned.

    property scmtool_class: Optional[type[SCMTool]][source]¶

    The SCMTool subclass used for this repository.

    Type:

    type – A subclass of SCMTool.

    Raises:

    django.core.exceptions.ImproperlyConfigured – The SCMTool could not be found, due to missing packages or extensions. Details are in the message, and the failure is logged.

    hosting_service()[source]¶

    The hosting service providing this repository.

    This will be None if this is a standalone repository.

    Type:

    reviewboard.hostingsvcs.base.hosting_service.BaseHostingService

    Raises:

    reviewboard.hostingsvcs.errors.MissingHostingServiceError – The hosting service for this repository could not be loaded.

    bug_tracker_service()[source]¶

    The selected bug tracker service for the repository.

    This will be None if this repository is not associated with a bug tracker.

    Type:

    reviewboard.hostingsvcs.base.hosting_service.BaseHostingService

    Raises:

    reviewboard.hostingsvcs.errors.MissingHostingServiceError – The hosting service for this repository could not be loaded.

    property supports_post_commit: bool[source]¶

    Whether or not this repository supports post-commit creation.

    If this is True, the get_branches() and get_commits() methods will be implemented to fetch information about the committed revisions, and get_change will be implemented to fetch the actual diff. This is used by ReviewRequestDraft.update_from_commit_id.

    Type:

    bool

    Raises:

    reviewboard.hostingsvcs.errors.MissingHostingServiceError – The hosting service for this repository could not be loaded.

    property supports_pending_changesets: bool[source]¶

    Whether this repository supports server-aware pending changesets.

    Type:

    bool

    diffs_use_absolute_paths()[source]¶

    Whether or not diffs for this repository contain absolute paths.

    Some types of source code management systems generate diffs that contain paths relative to the directory where the diff was generated. Most contain absolute paths. This flag indicates which path format this repository can expect.

    Type:

    bool

    get_scmtool() → SCMTool[source]¶

    Return an instance of the SCMTool for this repository.

    Each call will construct a brand new instance. The returned value should be stored and used for multiple operations in a single session.

    Returns:

    A new instance of the SCMTool for this repository.

    Return type:

    reviewboard.scmtools.core.SCMTool

    get_credentials() → Mapping[str, Any][source]¶

    Return the credentials for this repository.

    This returns a dictionary with username and password keys. By default, these will be the values stored for the repository, but if a hosting service is used and the repository doesn’t have values for one or both of these, the hosting service’s credentials (if available) will be used instead.

    Returns:

    A dictionary with credentials information.

    Return type:

    dict

    get_or_create_hooks_uuid(*, max_attempts: int = 20) → str[source]¶

    Return a hooks UUID, creating one if necessary.

    A hooks UUID is used for creating unique incoming webhook URLs, allowing services to communicate information to Review Board.

    If a hooks UUID isn’t already saved, then this will try to generate one that doesn’t conflict with any other registered hooks UUID. It will try up to max_attempts times, and if it fails, None will be returned.

    Parameters:

    max_attempts (int, optional) – The maximum number of UUID generation attempts to try before giving up.

    Returns:

    The resulting UUID.

    Return type:

    str

    Raises:

    Exception – The maximum number of attempts has been reached.

    get_encoding_list() → Sequence[str][source]¶

    Return a list of candidate text encodings for files.

    This will return a list based on a comma-separated list of encodings in encoding. If no encodings are configured, the default of iso-8859-15 will be used.

    Returns:

    The list of text encodings to try for files in the repository.

    Return type:

    list of str

    get_file(*, path: str, revision: str, base_commit_id: Optional[str] = None, request: Optional[HttpRequest] = None, context: Optional[FileLookupContext] = None) → bytes[source]¶

    Return a file from the repository.

    This will attempt to retrieve the file from the repository. If the repository is backed by a hosting service, it will go through that. Otherwise, it will attempt to directly access the repository.

    This will send the fetching_file signal before beginning a file fetch from the repository (if not cached), and the fetched_file signal after.

    Parameters:
    • path (str) – The path to the file in the repository.

    • revision (str) – The revision of the file to retrieve.

    • base_commit_id (str, optional) –

      The ID of the commit containing the revision of the file to retrieve. This is required for some types of repositories where the revision of a file and the ID of a commit differ.

      Deprecated since version 4.0.5: Callers should provide this in context instead.

    • request (django.http.HttpRequest, optional) –

      The current HTTP request from the client. This is used for logging purposes.

      Deprecated since version 4.0.5: Callers should provide this in context instead.

    • context (reviewboard.scmtools.core.FileLookupContext, optional) –

      Extra context used to help look up this file.

      This contains information about the HTTP request, requesting user, and parsed diff information, which may be useful as part of the repository lookup process.

      New in version 4.0.5.

    Returns:

    The resulting file contents.

    Return type:

    bytes

    Raises:

    TypeError – One or more of the provided arguments is an invalid type. Details are contained in the error message.

    get_file_exists(*, path: str, revision: str, base_commit_id: Optional[str] = None, request: Optional[HttpRequest] = None, context: Optional[FileLookupContext] = None) → bool[source]¶

    Return whether or not a file exists in the repository.

    If the repository is backed by a hosting service, this will go through that. Otherwise, it will attempt to directly access the repository.

    The result of this call will be cached, making future lookups of this path and revision on this repository faster.

    This will send the checking_file_exists signal before beginning a file fetch from the repository (if not cached), and the checked_file_exists signal after.

    Parameters:
    • path (str) – The path to the file in the repository.

    • revision (str) – The revision of the file to check.

    • base_commit_id (str, optional) –

      The ID of the commit containing the revision of the file to check. This is required for some types of repositories where the revision of a file and the ID of a commit differ.

      Deprecated since version 4.0.5: Callers should provide this in context instead.

    • request (django.http.HttpRequest, optional) –

      The current HTTP request from the client. This is used for logging purposes.

      Deprecated since version 4.0.5: Callers should provide this in context instead.

    • context (reviewboard.scmtools.core.FileLookupContext, optional) –

      Extra context used to help look up this file.

      This contains information about the HTTP request, requesting user, and parsed diff information, which may be useful as part of the repository lookup process.

      New in version 4.0.5.

    Returns:

    True if the file exists in the repository. False if it does not.

    Return type:

    bool

    Raises:

    TypeError – One or more of the provided arguments is an invalid type. Details are contained in the error message.

    get_branches() → Sequence[Branch][source]¶

    Return a list of all branches on the repository.

    This will fetch a list of all known branches for use in the API and New Review Request page.

    Returns:

    The list of branches in the repository. One (and only one) will be marked as the default branch.

    Return type:

    list of reviewboard.scmtools.core.Branch

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

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

    • NotImplementedError – Branch retrieval is not available for this type of repository.

    get_commit_cache_key(commit_id: str) → str[source]¶

    Return the cache key used for a commit ID.

    The resulting cache key is used to cache information about a commit retrieved from the repository that matches the provided ID. This can be used to delete information already in cache.

    Parameters:

    commit_id (str) – The ID of the commit to generate a cache key for.

    Returns:

    The resulting cache key.

    Return type:

    str

    get_commits(*, branch: Optional[str] = None, start: Optional[str] = None) → Sequence[Commit][source]¶

    Return a list of commits.

    This will fetch a batch of commits from the repository for use in the API and New Review Request page.

    The resulting commits will be in order from newest to oldest, and should return upwards of a fixed number of commits (usually 30, but this depends on the type of repository and its limitations). It may also be limited to commits that exist on a given branch (if supported by the repository).

    This can be called multiple times in succession using the Commit.parent of the last entry as the start parameter in order to paginate through the history of commits in the repository.

    Parameters:
    • branch (str, optional) – The branch to limit commits to. This may not be supported by all repositories.

    • start (str, optional) – The commit to start at. If not provided, this will fetch the first commit in the repository.

    Returns:

    The retrieved commits.

    Return type:

    list of reviewboard.scmtools.core.Commit

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

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

    • NotImplementedError – Commits retrieval is not available for this type of repository.

    get_change(revision: str) → Commit[source]¶

    Return an individual change/commit in the repository.

    Parameters:

    revision (str) – The commit ID or revision to retrieve.

    Returns:

    The commit from the repository.

    Return type:

    reviewboard.scmtools.core.Commit

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

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

    • NotImplementedError – Commits retrieval is not available for this type of repository.

    normalize_patch(patch: bytes, *, filename: str, revision: str) → bytes[source]¶

    Normalize a diff/patch file before it’s applied.

    This can be used to take an uploaded diff file and modify it so that it can be properly applied. This may, for instance, uncollapse keywords or remove metadata that would confuse patch.

    This passes the request on to the hosting service or repository tool backend.

    Parameters:
    • patch (bytes) – The diff/patch file to normalize.

    • filename (str) – The name of the file being changed in the diff.

    • revision (str) – The revision of the file being changed in the diff.

    Returns:

    The resulting diff/patch file.

    Return type:

    bytes

    Raises:

    reviewboard.hostingsvcs.errors.MissingHostingServiceError – The hosting service for this repository could not be loaded.

    is_accessible_by(user: Union[AnonymousUser, User]) → bool[source]¶

    Return whether or not the user has access to the repository.

    The repository is accessibly by the user if it is public or the user has access to it (either by being explicitly on the allowed users list, or by being a member of a review group on that list).

    Parameters:

    user (django.contrib.auth.models.User) – The user to check.

    Returns:

    True if the repository is accessible by the user. False if it is not.

    Return type:

    bool

    is_mutable_by(user: Union[AnonymousUser, User]) → bool[source]¶

    Return whether or not the user can modify or delete the repository.

    The repository is mutable by the user if the user is an administrator with proper permissions or the repository is part of a LocalSite and the user has permissions to modify it.

    Parameters:

    user (django.contrib.auth.models.User) – The user to check.

    Returns:

    True if the repository can modify or delete the repository. False if they cannot.

    Return type:

    bool

    archive(*, save: bool = True) → None[source]¶

    Archive a repository.

    The repository won’t appear in any public lists of repositories, and won’t be used when looking up repositories. Review requests can’t be posted against an archived repository.

    New repositories can be created with the same information as the archived repository.

    Parameters:

    save (bool, optional) – Whether to save the repository immediately.

    save(*args, **kwargs) → None[source]¶

    Save the repository.

    This will perform any data normalization needed, and then save the repository to the database.

    Parameters:

    **kwargs (dict) – Keyword arguments to pass to the parent method.

    clean() → None[source]¶

    Clean method for checking null unique_together constraints.

    Django has a bug where unique_together constraints for foreign keys aren’t checked properly if one of the relations is null. This means that users who aren’t using local sites could create multiple groups with the same name.

    Raises:

    django.core.exceptions.ValidationError – Validation of the model’s data failed. Details are in the exception.

    __str__() → str[source]¶

    Return a string representation of the repository.

    This uses the repository’s name as the string representation. However, it should not be used if explicitly wanting to retrieve the repository name, as future versions may return a different value.

    Returns:

    The repository name.

    Return type:

    str

    __annotations__ = {'BRANCHES_CACHE_PERIOD': 'Final[int]', 'COMMITS_CACHE_PERIOD_LONG': 'Final[int]', 'COMMITS_CACHE_PERIOD_SHORT': 'Final[int]', 'ENCRYPTED_PASSWORD_PREFIX': 'Final[str]', 'FALLBACK_ENCODING': 'Final[str]', 'NAME_CONFLICT_ERROR': 'Final[StrPromise]', 'PATH_CONFLICT_ERROR': 'Final[StrPromise]', '_scmtool_class': 'type[SCMTool]', 'objects': 'ClassVar[RepositoryManager]'}¶
    defaultreviewer_set¶

    Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

    In the example:

    class Pizza(Model):
        toppings = ManyToManyField(Topping, related_name='pizzas')
    

    Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    diffsets¶

    Accessor to the related objects manager on the reverse side of a many-to-one relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Parent.children is a ReverseManyToOneDescriptor instance.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    file_attachments¶

    Accessor to the related objects manager on the reverse side of a many-to-one relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Parent.children is a ReverseManyToOneDescriptor instance.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    get_extra_data_json()¶
    hosting_account_id¶
    id¶

    A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

    local_site_id¶
    review_requests¶

    Accessor to the related objects manager on the reverse side of a many-to-one relation.

    In the example:

    class Child(Model):
        parent = ForeignKey(Parent, related_name='children')
    

    Parent.children is a ReverseManyToOneDescriptor instance.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    set_extra_data_json(json)¶
    tool_id¶
    webhooks¶

    Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

    In the example:

    class Pizza(Model):
        toppings = ManyToManyField(Topping, related_name='pizzas')
    

    Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

    Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

    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]
    • Tool
      • Tool.name
      • Tool.class_name
      • Tool.objects
      • Tool.field_help_text
      • Tool.scmtool_id
      • Tool.get_scmtool_class()
      • Tool.scmtool_class
      • Tool.__str__()
      • Tool.__annotations__
      • Tool.id
      • Tool.repositories
    • Repository
      • Repository.BRANCHES_CACHE_PERIOD
      • Repository.COMMITS_CACHE_PERIOD_SHORT
      • Repository.COMMITS_CACHE_PERIOD_LONG
      • Repository.FALLBACK_ENCODING
      • Repository.NAME_CONFLICT_ERROR
      • Repository.PATH_CONFLICT_ERROR
      • Repository.ENCRYPTED_PASSWORD_PREFIX
      • Repository.name
      • Repository.path
      • Repository.mirror_path
      • Repository.raw_file_url
      • Repository.username
      • Repository.encrypted_password
      • Repository.extra_data
      • Repository.tool
      • Repository.scmtool_id
      • Repository.hosting_account
      • Repository.bug_tracker
      • Repository.encoding
      • Repository.visible
      • Repository.archived
      • Repository.archived_timestamp
      • Repository.local_site
      • Repository.public
      • Repository.users
      • Repository.review_groups
      • Repository.hooks_uuid
      • Repository.objects
      • Repository.password
      • Repository.scmtool_class
      • Repository.hosting_service()
      • Repository.bug_tracker_service()
      • Repository.supports_post_commit
      • Repository.supports_pending_changesets
      • Repository.diffs_use_absolute_paths()
      • Repository.get_scmtool()
      • Repository.get_credentials()
      • Repository.get_or_create_hooks_uuid()
      • Repository.get_encoding_list()
      • Repository.get_file()
      • Repository.get_file_exists()
      • Repository.get_branches()
      • Repository.get_commit_cache_key()
      • Repository.get_commits()
      • Repository.get_change()
      • Repository.normalize_patch()
      • Repository.is_accessible_by()
      • Repository.is_mutable_by()
      • Repository.archive()
      • Repository.save()
      • Repository.clean()
      • Repository.__str__()
      • Repository.__annotations__
      • Repository.defaultreviewer_set
      • Repository.diffsets
      • Repository.file_attachments
      • Repository.get_extra_data_json()
      • Repository.hosting_account_id
      • Repository.id
      • Repository.local_site_id
      • Repository.review_requests
      • Repository.set_extra_data_json()
      • Repository.tool_id
      • Repository.webhooks