Module and Class References¶

Top-Level Modules¶

`rbtools`	RBTools version and package information.
`rbtools.deprecation`	Internal support for handling deprecations in RBTools.

Review Board API¶

Base Support¶

`rbtools.api`
`rbtools.api.cache`	Caching implementation for the RBTools API.
`rbtools.api.capabilities`	Review Board server capability management.
`rbtools.api.client`	Main client used to talk to a Review Board server's API.
`rbtools.api.decode`	API payload decoders.
`rbtools.api.decorators`	Decorators for API requests.
`rbtools.api.errors`	Error classes and codes for API communication.
`rbtools.api.factory`	Resource creation method(s).
`rbtools.api.request`	Support for forming requests to a Review Board server.
`rbtools.api.transport`	Base class for API Transport layers.
`rbtools.api.transport.sync`	Transport for synchronous API access.
`rbtools.api.utils`	API-specific MIME type utilities.

Resource Base Classes¶

`rbtools.api.resource`	Resource definitions for the RBTools Python API.
`rbtools.api.resource.base`	Resource base classes for the RBTools Python API.
`rbtools.api.resource.base_archived_object`	Base resource definitions for archived object resources.
`rbtools.api.resource.base_comment`	Base class for comment resources.
`rbtools.api.resource.base_diff_commit`	Base class for diff commit resources.
`rbtools.api.resource.base_review_group`	Base class for review group resources.
`rbtools.api.resource.base_review_request`	Base class for review request resources.
`rbtools.api.resource.base_review`	Base class for review resources.
`rbtools.api.resource.base_user`	Base class for user resources.
`rbtools.api.resource.mixins`	Mixins for API resources.

Resources¶

`rbtools.api.resource.api_token`	Resource definitions for API tokens.
`rbtools.api.resource.archived_review_request`	Resource definitions for archived review requests.
`rbtools.api.resource.change`	Resource definitions for change descriptions.
`rbtools.api.resource.default_reviewer`	Resource definitions for default reviewers.
`rbtools.api.resource.diff_comment`	Resource definitions for diff comments.
`rbtools.api.resource.diff_commit`	Resource definitions for diff commits.
`rbtools.api.resource.diff_context`	Resource definitions for the diff context resource.
`rbtools.api.resource.diff_file_attachment`	Resource definitions for diff file attachments.
`rbtools.api.resource.diff`	Resource definitions for diffs.
`rbtools.api.resource.draft_diff_commit`	Resource definitions for draft diff commits.
`rbtools.api.resource.draft_file_attachment`	Resource definitions for draft file attachments.
`rbtools.api.resource.draft_screenshot`	Resource definitions for draft screenshots.
`rbtools.api.resource.extension`	Resource definitions for extensions.
`rbtools.api.resource.file_attachment_comment`	Resource definitions for file attachment comments.
`rbtools.api.resource.file_attachment`	Resource definitions for file attachments.
`rbtools.api.resource.file_diff`	Resource definitions for file diffs.
`rbtools.api.resource.general_comment`	Resource definitions for general comments.
`rbtools.api.resource.hosting_service_account`	Resource definitions for hosting service accounts.
`rbtools.api.resource.hosting_service`	Resource definitions for hosting services.
`rbtools.api.resource.last_update`	Resource definitions for the review request last update.
`rbtools.api.resource.muted_review_request`	Resource definitions for muted review requests.
`rbtools.api.resource.oauth_application`	Resource definitions for OAuth2 applications.
`rbtools.api.resource.oauth_token`	Resource definitions for OAuth2 tokens.
`rbtools.api.resource.plain_text`	Resource definitions for plain text.
`rbtools.api.resource.remote_repository`	Resource definitions for remote repositories.
`rbtools.api.resource.repository_branch`	Resource definitions for repository branches.
`rbtools.api.resource.repository_commit`	Resource definitions for repository commits.
`rbtools.api.resource.repository_group`	Resource definitions for repository groups.
`rbtools.api.resource.repository_info`	Resource definitions for repository info.
`rbtools.api.resource.repository_user`	Resource definitions for repository users.
`rbtools.api.resource.repository`	Resource definitions for repositories.
`rbtools.api.resource.review_group_user`	Resource definitions for review group users.
`rbtools.api.resource.review_group`	Resource definitions for review groups.
`rbtools.api.resource.review_reply`	Resource definitions for review replies.
`rbtools.api.resource.review_request_draft`	Resource definitions for review request drafts.
`rbtools.api.resource.review_request`	Resource definitions for review requests.
`rbtools.api.resource.review`	Resource definitions for reviews.
`rbtools.api.resource.root`	Resource definitions for the API root.
`rbtools.api.resource.screenshot_comment`	Resource definitions for screenshot comments.
`rbtools.api.resource.screenshot`	Resource definitions for screenshots.
`rbtools.api.resource.search`	Resource definition for the search resource.
`rbtools.api.resource.server_info`	Resource definition for the server info resource.
`rbtools.api.resource.session`	Resource definition for the session resource.
`rbtools.api.resource.status_update`	Resource definitions for status updates.
`rbtools.api.resource.user_file_attachment`	Resource definitions for user file attachments.
`rbtools.api.resource.user`	Resource definitions for users.
`rbtools.api.resource.validate_diff_commit`	Resource definitions for diff commit validation.
`rbtools.api.resource.validate_diff`	Resource definitions for diff validation.
`rbtools.api.resource.validation`	Resource definitions for the validation list.
`rbtools.api.resource.watched_review_group`	Resource definitions for watched review groups.
`rbtools.api.resource.watched_review_request`	Resource definitions for watched review requests.
`rbtools.api.resource.watched`	Resource definitions for the watched list.
`rbtools.api.resource.webhook`	Resource definitions for WebHooks.

Source Code Management Clients¶

Base Support¶

`rbtools.clients`	Support for interfacing with source code management systems.
`rbtools.clients.base`	Base support for defining SCMClients.
`rbtools.clients.base.patch`	Classes for representing patch results in SCM clients.
`rbtools.clients.base.registry`	Registry of available SCMClients.
`rbtools.clients.base.repository`	Classes for representing source code repositories.
`rbtools.clients.base.scmclient`	Base class for interfacing with source code management tools.
`rbtools.clients.errors`	Error definitions for SCMClient implementations.

Client Implementations¶

`rbtools.clients.bazaar`	A client for Bazaar and Breezy.
`rbtools.clients.clearcase`	A client for ClearCase.
`rbtools.clients.cvs`	A client for CVS.
`rbtools.clients.git`	A client for Git.
`rbtools.clients.mercurial`	A client for Mercurial.
`rbtools.clients.perforce`	A client for Perforce.
`rbtools.clients.plastic`	A client for Plastic SCM.
`rbtools.clients.sos`	A client for Keysight SOS (formerly Cliosoft SOS).
`rbtools.clients.svn`	A client for Subversion.
`rbtools.clients.tfs`	A client for Azure DevOps / Team Foundation Server TFVC repositories.

RBTools Configuration¶

`rbtools.config`	Configuration management for RBTools.
`rbtools.config.config`	Configuration for RBTools.
`rbtools.config.loader`	Loaders for configuration files.

Diff Generation/Processing/Patching¶

`rbtools.diffs`	Utilities and support for generating and processing diffs.
`rbtools.diffs.patches`	Patch information and support for applying patches.
`rbtools.diffs.patcher`	Support for applying patches to a local source tree.
`rbtools.diffs.tools`	Support for working with external diff tools.
`rbtools.diffs.tools.backends`	Diff tool backends for specific external tools.
`rbtools.diffs.tools.backends.gnu`	A diff tool interfacing with GNU Diff.
`rbtools.diffs.tools.base`	Base support for creating diff tools.
`rbtools.diffs.tools.base.diff_file_result`	Classes for working with the result of a diff between files.
`rbtools.diffs.tools.base.diff_tool`	Base class for building diff tools.
`rbtools.diffs.tools.errors`	Errors for working with diff tools.
`rbtools.diffs.tools.registry`	Registry of available diff tools.
`rbtools.diffs.writers`	Writers to help programmatically generate new diffs.

RBTools Commands¶

Base Support¶

`rbtools.commands`	Base support for creating commands.
`rbtools.commands.main`	Main handler for the rbt command.

Base Command Support¶

`rbtools.commands.base`	Base support for commands.
`rbtools.commands.base.commands`	Base classes for commands.
`rbtools.commands.base.errors`	Error types for commands.
`rbtools.commands.base.options`	Command line option management for commands.
`rbtools.commands.base.output`	Output management for commands.

Command Implementations¶

`rbtools.commands.alias`	Implementation of rbt alias.
`rbtools.commands.api_get`	Implementation of rbt api-get.
`rbtools.commands.attach`	Implementation of rbt attach.
`rbtools.commands.clearcache`	Implementation of rbt clear-cache.
`rbtools.commands.close`	Implementation of rbt close.
`rbtools.commands.diff`	Implementation of rbt diff.
`rbtools.commands.info`	The rbt info command.
`rbtools.commands.install`	Implementation of rbt install.
`rbtools.commands.land`	Implementation of rbt land.
`rbtools.commands.list_repo_types`	Implementation of rbt list-repo-types.
`rbtools.commands.login`	Implementation of rbt login.
`rbtools.commands.logout`	Implementation of rbt logout.
`rbtools.commands.patch`	Implementation of rbt patch.
`rbtools.commands.post`	Implementation of rbt post.
`rbtools.commands.publish`	Implementation of rbt publish.
`rbtools.commands.review`	Implementation of rbt review.
`rbtools.commands.setup_completion`	Implementation of rbt setup-completion.
`rbtools.commands.setup_repo`	Implementation of rbt setup-repo.
`rbtools.commands.stamp`	Implementation of rbt stamp.
`rbtools.commands.status`	Implementation of rbt status.
`rbtools.commands.status_update`	Implementation of rbt status-update.

Repository Hooks¶

Base Support¶

`rbtools.hooks`
`rbtools.hooks.common`	Common functionality for working with repository hooks.

Repository Implementations¶

rbtools.hooks.git

Git repository hook utilities.

Testing¶

`rbtools.testing`	Common support for writing unit tests for RBTools.
`rbtools.testing.api`
`rbtools.testing.api.payloads`	API payload generation factory for unit tests.
`rbtools.testing.api.transport`	API transports for unit tests.
`rbtools.testing.commands`	Command unit testing support.
`rbtools.testing.testcase`	Base test cases for RBTools unit tests.
`rbtools.testing.transport`	Transport subclass used for unit testing.

Utilities¶

`rbtools.utils`
`rbtools.utils.aliases`	Utilities for working with command aliases.
`rbtools.utils.browser`	Utilities for working with web browsers.
`rbtools.utils.checks`	Utilities for checking for dependencies.
`rbtools.utils.commands`	Utilities for commands.
`rbtools.utils.console`	Utilities for working with console interactions.
`rbtools.utils.diffs`	Utilities for generating or parsing diffs.
`rbtools.utils.encoding`	Utilities for managing string types and encoding.
`rbtools.utils.errors`	Error classes for utility functions.
`rbtools.utils.filesystem`	Utilities for working with files.
`rbtools.utils.graphs`	Topological graphing and sorting utilities.
`rbtools.utils.mimetypes`	Utilities for working with MIME types.
`rbtools.utils.process`	Utilities for running processes.
`rbtools.utils.repository`	Utility functions for working with repositories.
`rbtools.utils.review_request`	Utilities for matching review requests.
`rbtools.utils.source_tree`	Utilities for scanning and working with source trees.
`rbtools.utils.users`	Utilities for working with user sessions.