Review Bot 1.0 Documentation

Need help? Talk to us today about a support contract!

This documentation covers Review Bot 1.0. You can see the latest Review Bot documentation or all other versions.

General Index

_ | A | B | C | D | E | F | G | H | I | J | L | M | N | O | P | R | S | T | U | V | W

_

__annotations__ (BaseTool attribute): (BaseToolTestCase attribute) , [Link]; (CargoTool attribute); (CheckstyleTool attribute); (ClangTool attribute); (CPPCheckTool attribute); (CPPLintTool attribute); (Doc8Tool attribute); (DummyFileDiffResource attribute); (DummyRootResource attribute); (FBInferTool attribute); (FileAttachmentListResource attribute); (FilePatternsFromSettingMixin attribute); (Flake8Tool attribute); (FullRepositoryToolMixin attribute); (GitRepository attribute); (GofmtTool attribute); (GoTool attribute); (HgRepository attribute); (JavaToolMixin attribute); (JSHintTool attribute); (PMDTool attribute); (PycodestyleTool attribute); (PydocstyleTool attribute); (PyflakesTool attribute); (RemovedInReviewBot40Warning attribute); (RemovedInReviewBot50Warning attribute); (RepositoryListResource attribute); (ReviewBotExtensionResource attribute); (ReviewBotReviewResource attribute); (ReviewBotReviewsResource attribute); (ReviewBotToolsResource attribute); (RubocopTool attribute); (RustfmtTool attribute); (SecretScannerTool attribute); (ShellCheckTool attribute); (StatusUpdateResource attribute); (ToolTestCaseMetaclass attribute) , [Link]
__eq__() (BaseRepository method)
__getattribute__() (DummyFileDiffResource method)
__hash__ (BaseRepository attribute)
__init__() (BaseRepository method): (BaseTool method) , [Link]; (File method); (FilePatternsFromSettingMixin method) , [Link]; (RepositoryListResource method); (Review method); (ReviewBotCelery method); (SuspiciousFilePath method)
__new__() (ToolTestCaseMetaclass static method)
__repr__() (BaseRepository method)

A

apply_patch() (File method)

B

base62_encode() (in module reviewbot.utils.text)
BaseRemovedInReviewBotVersionWarning
BaseRepository (class in reviewbot.repositories)
BaseTool (class in reviewbot.tools.base): (class in reviewbot.tools.base.tool)
BaseToolTestCase (class in reviewbot.tools.testing): (class in reviewbot.tools.testing.testcases)
body_bottom (Review attribute)
body_top (Review attribute)
build_base_command() (BaseTool method): (CargoTool method); (CheckstyleTool method); (ClangTool method); (CPPCheckTool method); (CPPLintTool method); (Doc8Tool method); (FBInferTool method); (Flake8Tool method); (GofmtTool method); (JavaToolMixin method) , [Link]; (JSHintTool method); (PMDTool method); (PycodestyleTool method); (PydocstyleTool method); (PyflakesTool method); (RubocopTool method); (RustfmtTool method); (ShellCheckTool method)

C

CargoTool (class in reviewbot.tools.cargotool)
chdir() (in module reviewbot.utils.filesystem)
check_dependencies() (BaseTool method): (JavaToolMixin method) , [Link]
checkout() (BaseRepository method): (GitRepository method); (HgRepository method)
CheckstyleTool (class in reviewbot.tools.checkstyle)
ClangTool (class in reviewbot.tools.clang)
cleanup_tempfiles() (in module reviewbot.utils.filesystem)
clear_has_java_runtime() (JavaToolMixin class method)
clone_path (BaseRepository attribute)
comment() (File method)
config (in module reviewbot.config): (TestCase attribute)
COPIED (ReviewFileStatus attribute)
CPPCheckTool (class in reviewbot.tools.cppcheck)
CPPLintTool (class in reviewbot.tools.cpplint)
create() (ReviewBotReviewsResource method): (ReviewBotToolsResource method)
create_diff_data() (TestCase method)
create_filediff_resource() (TestCase method)
create_queues() (in module reviewbot.celery)
create_review() (TestCase method)
create_review_file() (TestCase method)
CREATED (ReviewFileStatus attribute)

D

DEFAULT_CONFIG (in module reviewbot.config)
DELETED (ReviewFileStatus attribute)
deprecated_keys (in module reviewbot.config)
description (BaseTool attribute): (CargoTool attribute); (CheckstyleTool attribute); (ClangTool attribute); (CPPCheckTool attribute); (CPPLintTool attribute); (Doc8Tool attribute); (FBInferTool attribute); (Flake8Tool attribute); (GofmtTool attribute); (GoTool attribute); (JSHintTool attribute); (PMDTool attribute); (PycodestyleTool attribute); (PydocstyleTool attribute); (PyflakesTool attribute); (RubocopTool attribute); (RustfmtTool attribute); (SecretScannerTool attribute); (ShellCheckTool attribute)
Doc8Tool (class in reviewbot.tools.doc8)
DummyFileDiffResource (class in reviewbot.testing.testcases)
DummyRootResource (class in reviewbot.testing.testcases)

E

ensure_dirs_exist() (in module reviewbot.utils.filesystem)
environment variable: PATH , [Link]; REVIEWBOT_CONFIG_FILE , [Link]
ERROR_RE (CPPCheckTool attribute): (CPPLintTool attribute); (GofmtTool attribute); (PydocstyleTool attribute); (RustfmtTool attribute)
exe_dependencies (BaseTool attribute): (CargoTool attribute); (ClangTool attribute); (CPPCheckTool attribute); (CPPLintTool attribute); (Doc8Tool attribute); (FBInferTool attribute); (Flake8Tool attribute); (GofmtTool attribute); (GoTool attribute); (JavaToolMixin attribute) , [Link]; (JSHintTool attribute); (PMDTool attribute); (PycodestyleTool attribute); (PydocstyleTool attribute); (PyflakesTool attribute); (RubocopTool attribute); (RustfmtTool attribute); (ShellCheckTool attribute)
execute() (BaseTool method): (FullRepositoryToolMixin method) , [Link]; (in module reviewbot.utils.process)

F

FBInferTool (class in reviewbot.tools.fbinfer)
fetch_repositories() (in module reviewbot.repositories)
File (class in reviewbot.processing.review)
file_extension_setting (JSHintTool attribute)
file_extensions_setting (FilePatternsFromSettingMixin attribute): (PMDTool attribute)
file_patterns (BaseTool attribute): (CargoTool attribute); (CheckstyleTool attribute); (ClangTool attribute); (CPPCheckTool attribute); (CPPLintTool attribute); (Doc8Tool attribute); (Flake8Tool attribute); (GofmtTool attribute); (GoTool attribute); (JSHintTool attribute); (PycodestyleTool attribute); (PydocstyleTool attribute); (PyflakesTool attribute); (RubocopTool attribute); (RustfmtTool attribute); (ShellCheckTool attribute)
file_patterns_setting (FilePatternsFromSettingMixin attribute)
FileAttachmentItemResource (class in reviewbot.testing.testcases)
FileAttachmentListResource (class in reviewbot.testing.testcases)
FilePatternsFromSettingMixin (class in reviewbot.tools.base): (class in reviewbot.tools.base.mixins)
Flake8Tool (class in reviewbot.tools.flake8)
for_filediff() (ReviewFileStatus class method)
FullRepositoryToolMixin (class in reviewbot.tools.base): (class in reviewbot.tools.base.mixins)

G

general_comment() (Review method)
get_api_root() (in module reviewbot.utils.api)
get_can_handle_file() (BaseTool method): (GoTool method); (ShellCheckTool method)
get_celery() (in module reviewbot.celery)
get_config_file_path() (in module reviewbot.config)
get_diff_data() (DummyFileDiffResource method)
get_extension() (DummyRootResource method)
get_files() (DummyRootResource method)
get_lines() (File method)
get_logger() (in module reviewbot.utils.log)
get_original_file_path() (File method)
get_patch() (DummyFileDiffResource method)
get_patch_file_path() (Review method)
get_patched_file_path() (File method)
get_path_platform() (in module reviewbot.utils.filesystem)
get_repositories() (DummyRootResource method)
get_review_bot_reviews() (ReviewBotExtensionResource method)
get_root_logger() (in module reviewbot.utils.log)
get_status_update() (DummyRootResource method)
get_test_dep_path() (in module reviewbot.testing.utils)
get_tool_class() (in module reviewbot.tools.base.registry)
get_tool_classes() (in module reviewbot.tools.base.registry)
get_tools() (ReviewBotExtensionResource method)
get_user_file_attachments() (DummyRootResource method)
GitRepository (class in reviewbot.repositories)
GofmtTool (class in reviewbot.tools.gofmt)
GoTool (class in reviewbot.tools.gotool)

H

handle_file() (BaseTool method): (CargoTool method); (CheckstyleTool method); (ClangTool method); (CPPCheckTool method); (CPPLintTool method); (Doc8Tool method); (FBInferTool method); (Flake8Tool method); (GofmtTool method); (GoTool method); (JSHintTool method); (PMDTool method); (PycodestyleTool method); (PydocstyleTool method); (PyflakesTool method); (RubocopTool method); (RustfmtTool method); (SecretScannerTool method); (ShellCheckTool method)
handle_files() (BaseTool method): (CargoTool method); (FBInferTool method); (GoTool method); (SecretScannerTool method)
has_comments (Review property)
HgRepository (class in reviewbot.repositories)

I

include_default_file_patterns (FilePatternsFromSettingMixin attribute)
init_repositories() (in module reviewbot.repositories)
integration_test() (in module reviewbot.tools.testing): (in module reviewbot.tools.testing.decorators)
is_exe_in_path() (in module reviewbot.utils.process)

J

java_classpaths_key (CheckstyleTool attribute): (JavaToolMixin attribute) , [Link]
java_main (CheckstyleTool attribute): (JavaToolMixin attribute) , [Link]
JavaToolMixin (class in reviewbot.tools.base): (class in reviewbot.tools.base.mixins)
JSHintTool (class in reviewbot.tools.jshint)

L

LINE_RE (Doc8Tool attribute): (PyflakesTool attribute)
load_config() (in module reviewbot.config)
load_tool_classes() (in module reviewbot.tools.base.registry)
LOCAL (PathPlatform attribute)
logger (BaseTool property): (in module reviewbot.processing.review)

M

make_integration_test_func() (ToolTestCaseMetaclass class method)
make_simulation_test_func() (ToolTestCaseMetaclass class method)
make_tempdir() (in module reviewbot.utils.filesystem)
make_tempfile() (in module reviewbot.utils.filesystem)
maxDiff (TestCase attribute)
MODIFIED (ReviewFileStatus attribute)
module: reviewbot.celery; reviewbot.config; reviewbot.deprecation; reviewbot.errors; reviewbot.processing.review; reviewbot.repositories; reviewbot.tasks; reviewbot.testing.testcases; reviewbot.testing.utils; reviewbot.tools.base; reviewbot.tools.base.mixins; reviewbot.tools.base.registry; reviewbot.tools.base.tool; reviewbot.tools.cargotool; reviewbot.tools.checkstyle; reviewbot.tools.clang; reviewbot.tools.cppcheck; reviewbot.tools.cpplint; reviewbot.tools.doc8; reviewbot.tools.fbinfer; reviewbot.tools.flake8; reviewbot.tools.gofmt; reviewbot.tools.gotool; reviewbot.tools.jshint; reviewbot.tools.pmd; reviewbot.tools.pycodestyle; reviewbot.tools.pydocstyle; reviewbot.tools.pyflakes; reviewbot.tools.rbsecretscanner; reviewbot.tools.rubocop; reviewbot.tools.rustfmt; reviewbot.tools.shellcheck; reviewbot.tools.testing; reviewbot.tools.testing.decorators; reviewbot.tools.testing.testcases; reviewbot.utils.api; reviewbot.utils.filesystem; reviewbot.utils.log; reviewbot.utils.process; reviewbot.utils.text
MOVED (ReviewFileStatus attribute)
MULTI_FILE_BUILD_TYPES (FBInferTool attribute)

N

O

options (BaseTool attribute): (CargoTool attribute); (CheckstyleTool attribute); (ClangTool attribute); (CPPCheckTool attribute); (CPPLintTool attribute); (Doc8Tool attribute); (FBInferTool attribute); (Flake8Tool attribute); (GoTool attribute); (JSHintTool attribute); (PMDTool attribute); (PycodestyleTool attribute); (PydocstyleTool attribute); (RubocopTool attribute); (ShellCheckTool attribute)
original_file_contents (File property)
override_config() (TestCase method)

P

PACKAGE_LINE_RE (GoTool attribute)
patch_contents (Review property)
patched_file_contents (File property)
PATH
path_mod (PathPlatform property)
PathPlatform (class in reviewbot.utils.filesystem)
PMDTool (class in reviewbot.tools.pmd)
POSIX (PathPlatform attribute)
preserve_path_env (TestCase attribute)
publish() (Review method)
PycodestyleTool (class in reviewbot.tools.pycodestyle)
PydocstyleTool (class in reviewbot.tools.pydocstyle)
PyflakesTool (class in reviewbot.tools.pyflakes)
Python Enhancement Proposals: PEP 8

R

register_tool_class() (in module reviewbot.tools.base.registry)
RemovedInNextReviewBotVersionWarning (in module reviewbot.deprecation)
RemovedInReviewBot40Warning
RemovedInReviewBot50Warning
repo_path (BaseRepository attribute)
repo_types (BaseRepository attribute): (GitRepository attribute); (HgRepository attribute)
REPORTER_PATH (JSHintTool attribute)
RepositoryListResource (class in reviewbot.testing.testcases)
reset_config() (in module reviewbot.config)
reset_repositories() (in module reviewbot.repositories)
Review (class in reviewbot.processing.review)
reviewbot.celery: module
reviewbot.config: module
reviewbot.deprecation: module
reviewbot.errors: module
reviewbot.processing.review: module
reviewbot.repositories: module
reviewbot.tasks: module
reviewbot.testing.testcases: module
reviewbot.testing.utils: module
reviewbot.tools.base: module
reviewbot.tools.base.mixins: module
reviewbot.tools.base.registry: module
reviewbot.tools.base.tool: module
reviewbot.tools.cargotool: module
reviewbot.tools.checkstyle: module
reviewbot.tools.clang: module
reviewbot.tools.cppcheck: module
reviewbot.tools.cpplint: module
reviewbot.tools.doc8: module
reviewbot.tools.fbinfer: module
reviewbot.tools.flake8: module
reviewbot.tools.gofmt: module
reviewbot.tools.gotool: module
reviewbot.tools.jshint: module
reviewbot.tools.pmd: module
reviewbot.tools.pycodestyle: module
reviewbot.tools.pydocstyle: module
reviewbot.tools.pyflakes: module
reviewbot.tools.rbsecretscanner: module
reviewbot.tools.rubocop: module
reviewbot.tools.rustfmt: module
reviewbot.tools.shellcheck: module
reviewbot.tools.testing: module
reviewbot.tools.testing.decorators: module
reviewbot.tools.testing.testcases: module
reviewbot.utils.api: module
reviewbot.utils.filesystem: module
reviewbot.utils.log: module
reviewbot.utils.process: module
reviewbot.utils.text: module
REVIEWBOT_CONFIG_FILE
ReviewBotCelery (class in reviewbot.celery)
ReviewBotExtensionResource (class in reviewbot.testing.testcases)
ReviewBotReviewResource (class in reviewbot.testing.testcases)
ReviewBotReviewsResource (class in reviewbot.testing.testcases)
ReviewBotToolsResource (class in reviewbot.testing.testcases)
ReviewFileStatus (class in reviewbot.processing.review)
RubocopTool (class in reviewbot.tools.rubocop)
run_cargo_clippy() (CargoTool method)
run_cargo_test() (CargoTool method)
run_get_can_handle_file() (BaseToolTestCase method)
run_go_test() (GoTool method)
run_go_vet() (GoTool method)
run_tool_execute() (BaseToolTestCase method)
RustfmtTool (class in reviewbot.tools.rustfmt)

S

SecretScannerTool (class in reviewbot.tools.rbsecretscanner)
set_has_java_runtime() (JavaToolMixin class method)
settings (BaseTool attribute)
setUp() (TestCase method)
setup_cookies() (in module reviewbot.celery)
setup_integration_test() (BaseToolTestCase method)
setup_logging() (in module reviewbot.celery)
setup_reviewbot() (in module reviewbot.celery)
setup_simulation_test() (BaseToolTestCase method)
setUpClass() (TestCase class method)
SHELL_RE (ShellCheckTool attribute)
ShellCheckTool (class in reviewbot.tools.shellcheck)
shortDescription() (TestCase method)
simulation_test() (in module reviewbot.tools.testing): (in module reviewbot.tools.testing.decorators)
split_comma_separated() (in module reviewbot.utils.text)
start_worker() (in module reviewbot.celery)
StatusUpdateResource (class in reviewbot.testing.testcases)
SuspiciousFilePath
sync() (BaseRepository method): (GitRepository method); (HgRepository method)

T

tag_func_name() (ToolTestCaseMetaclass class method)
tearDownClass() (TestCase class method)
TEST_GROUP_RE (CargoTool attribute)
TEST_LINES_LIMIT (CargoTool attribute)
TestCase (class in reviewbot.testing.testcases)
timeout (BaseTool attribute): (CargoTool attribute); (CheckstyleTool attribute); (ClangTool attribute); (CPPCheckTool attribute); (CPPLintTool attribute); (Doc8Tool attribute); (FBInferTool attribute); (Flake8Tool attribute); (GofmtTool attribute); (GoTool attribute); (JSHintTool attribute); (PMDTool attribute); (PycodestyleTool attribute); (PydocstyleTool attribute); (PyflakesTool attribute); (RubocopTool attribute); (RustfmtTool attribute); (SecretScannerTool attribute); (ShellCheckTool attribute)
tool_class (BaseToolTestCase attribute)
tool_exe_config_key (BaseToolTestCase attribute)
tool_exe_path (BaseToolTestCase attribute)
tool_extra_exe_paths (BaseToolTestCase attribute)
tool_name (BaseRepository attribute): (GitRepository attribute); (HgRepository attribute)
ToolTestCaseMetaclass (class in reviewbot.tools.testing): (class in reviewbot.tools.testing.testcases)

U

unregister_tool_class() (in module reviewbot.tools.base.registry)
update() (StatusUpdateResource method)
update_tools_list() (in module reviewbot.tasks)
upload_attachment() (FileAttachmentListResource method)

V

W

warn() (BaseRemovedInReviewBotVersionWarning class method)
WINDOWS (PathPlatform attribute)
working_directory_required (BaseTool attribute): (FullRepositoryToolMixin attribute) , [Link]