Module and Class References¶

Top-Level Modules¶

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

`rbtools.api`
`rbtools.api.cache`
`rbtools.api.capabilities`	Review Board server capability management.
`rbtools.api.client`
`rbtools.api.decode`	API payload decoders.
`rbtools.api.decorators`
`rbtools.api.errors`
`rbtools.api.factory`
`rbtools.api.request`
`rbtools.api.resource`
`rbtools.api.transport`
`rbtools.api.transport.sync`
`rbtools.api.utils`	Utilities used by the API interfaces.

`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.

`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 Cliosoft SOS.
`rbtools.clients.svn`	A client for Subversion.
`rbtools.clients.tfs`	A client for Team Foundation Server.

`rbtools.diffs`	Utilities and support for generating and processing diffs.
`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`
`rbtools.commands.main`

`rbtools.commands.alias`
`rbtools.commands.api_get`
`rbtools.commands.attach`
`rbtools.commands.clearcache`
`rbtools.commands.close`
`rbtools.commands.diff`
`rbtools.commands.info`	The rbt info command.
`rbtools.commands.install`
`rbtools.commands.land`
`rbtools.commands.list_repo_types`
`rbtools.commands.login`
`rbtools.commands.logout`
`rbtools.commands.patch`	The rbt patch command.
`rbtools.commands.post`
`rbtools.commands.publish`
`rbtools.commands.review`	RBTools command to create and publish reviews.
`rbtools.commands.setup_completion`
`rbtools.commands.setup_repo`
`rbtools.commands.stamp`
`rbtools.commands.status`
`rbtools.commands.status_update`	Interact with review request status-updates on Review Board.

`rbtools.hooks`
`rbtools.hooks.common`

`rbtools.testing`
`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.

`rbtools.utils`
`rbtools.utils.aliases`
`rbtools.utils.checks`
`rbtools.utils.commands`
`rbtools.utils.console`
`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`
`rbtools.utils.graphs`
`rbtools.utils.match_score`	Utilities for applying matching scores for summaries and descriptions.
`rbtools.utils.process`
`rbtools.utils.repository`	Utility functions for working with repositories.
`rbtools.utils.review_request`
`rbtools.utils.source_tree`	Utilities for scanning and working with source trees.
`rbtools.utils.testbase`	Legacy testing support for RBTools.
`rbtools.utils.users`