This documentation covers Review Bot 3.0. You can select a version above or view the latest documentation.

Module and Class Reference¶

Base Tools Support¶

`reviewbot.tools.base`	Base support for code checking tools.
`reviewbot.tools.base.mixins`	Useful mixins for code checking tools.
`reviewbot.tools.base.registry`	Tool registration
`reviewbot.tools.base.tool`	Base support for creating code checking tools.

Unit Testing¶

`reviewbot.testing.testcases`	Common test case for Review Bot unit testing.
`reviewbot.testing.utils`	Utility functions for unit tests.
`reviewbot.tools.testing`	Testing support for tools.
`reviewbot.tools.testing.decorators`	Decorators for tool tests.
`reviewbot.tools.testing.testcases`	Base test case support for tools.

Reviews, Patches, and Commenting¶

reviewbot.processing.review

Utilities¶

`reviewbot.utils.api`	API utility functions.
`reviewbot.utils.filesystem`	Utilities for filesystem operations and path normalization.
`reviewbot.utils.log`	Utility functions for loggers.
`reviewbot.utils.process`	Utility functions for Process invocation and management.
`reviewbot.utils.text`	Utility functions for working with text.

Worker Operations¶

`reviewbot.celery`	Celery and Review Bot worker setup and management.
`reviewbot.config`	Configuration loading and validation.
`reviewbot.deprecation`	Internal support for handling deprecations in Review Bot.
`reviewbot.errors`	Common exceptions for tools and processing."
`reviewbot.repositories`	Full access repository management.
`reviewbot.tasks`	Core task handling.

Built-in Tools¶

`reviewbot.tools.cargotool`	Review Bot tool to run Cargo commands.
`reviewbot.tools.checkstyle`	Review Bot tool to run checkstyle.
`reviewbot.tools.clang`	Review Bot tool to run Clang.
`reviewbot.tools.cppcheck`	Review Bot tool to run Cppcheck.
`reviewbot.tools.cpplint`	Review Bot tool to run cpplint.
`reviewbot.tools.doc8`	Review Bot tool to run doc8.
`reviewbot.tools.fbinfer`	Review Bot tool to run FBInfer.
`reviewbot.tools.flake8`	Review Bot tool to run flake8.
`reviewbot.tools.gofmt`	Review Bot tool to run go fmt.
`reviewbot.tools.gotool`	Review Bot tool to run Go Tools.
`reviewbot.tools.jshint`	Review Bot tool to run JSHint.
`reviewbot.tools.pmd`	Review Bot tool to run PMD.
`reviewbot.tools.pycodestyle`	Unit tests for reviewbot.tools.pycodestyle.
`reviewbot.tools.pydocstyle`	Review Bot tool to run pydocstyle.
`reviewbot.tools.pyflakes`	Review Bot tool to run pyflakes.
`reviewbot.tools.rbsecretscanner`	Review Bot tool to check for hard-coded security credentials.
`reviewbot.tools.rubocop`	Review Bot tool to run rubocop.
`reviewbot.tools.rustfmt`	Review Bot tool to run rustfmt.
`reviewbot.tools.shellcheck`	Review Bot tool to run shellcheck.