• 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 Bot 3.0
    2. Version 4.x
    3. Version 3.0
    4. Version 2.0
    5. Version 1.0
    6. Module and Class Reference
    7. reviewbot.config
  • Home
  • Installation
  • Manually Installing Review Bot
  • Review Bot Docker Images
  • Upgrading Review Bot
  • Configuring Review Bot
  • Review Bot Tools
  • Cargo Tool
  • Checkstyle
  • Clang Static Analyzer
  • Cppcheck
  • Cpplint
  • Doc8
  • FBInfer
  • Flake8
  • Go Fmt
  • Go Tool
  • JSHint
  • PMD
  • Pycodestyle
  • Pydocstyle
  • Pyflakes
  • RuboCop
  • Rust Fmt
  • Secret Scanner
  • ShellCheck
  • Module and Class Reference
  • reviewbot.tools.base
  • reviewbot.tools.base.mixins
  • reviewbot.tools.base.registry
  • reviewbot.tools.base.tool
  • reviewbot.testing.testcases
  • reviewbot.testing.utils
  • reviewbot.tools.testing
  • reviewbot.tools.testing.decorators
  • reviewbot.tools.testing.testcases
  • reviewbot.processing.review
  • reviewbot.utils.api
  • reviewbot.utils.filesystem
  • reviewbot.utils.log
  • reviewbot.utils.process
  • reviewbot.utils.text
  • reviewbot.celery
  • reviewbot.config
  • reviewbot.deprecation
  • reviewbot.errors
  • reviewbot.repositories
  • reviewbot.tasks
  • 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
  • General Index
  • Python Module Index
  • Release Notes
  • This documentation covers Review Bot 3.0. You can select a version above or view the latest documentation.

    reviewbot.config¶

    Configuration loading and validation.

    Module Attributes

    DEFAULT_CONFIG

    The default configuration for Review Bot.

    deprecated_keys

    Deprecated configuration keys.

    config

    The active configuration for Review Bot.

    Functions

    get_config_file_path()

    Return the configuration file path.

    load_config()

    Load the Review Bot configuraiton.

    reset_config()

    Reset the configuration to defaults.

    DEFAULT_CONFIG = {'cookie_dir': '/Users/chipx86/Library/Caches/reviewbot', 'exe_paths': {}, 'java_classpaths': {}, 'repositories': [], 'repositories_config_path': None, 'reviewboard_servers': [], 'reviewboard_servers_config_path': None}[source]¶

    The default configuration for Review Bot.

    config is generated from this.

    New in version 3.0.

    deprecated_keys = {'pmd_path', 'review_board_servers'}[source]¶

    Deprecated configuration keys.

    New in version 3.0.

    config = {'cookie_dir': '/Users/chipx86/Library/Caches/reviewbot', 'exe_paths': {}, 'java_classpaths': {}, 'repositories': [], 'repositories_config_path': None, 'reviewboard_servers': [], 'reviewboard_servers_config_path': None}[source]¶

    The active configuration for Review Bot.

    get_config_file_path()[source]¶

    Return the configuration file path.

    New in version 3.0.

    Returns:

    The configuration file path.

    Return type:

    unicode

    load_config()[source]¶

    Load the Review Bot configuraiton.

    This will load the configuration file reviewbot/config.py, located in the system’s main configuration directory (/etc/ on Linux).

    If the REVIEWBOT_CONFIG_FILE environment variable is provided, configuration from that file will be loaded instead.

    If anything goes wrong when loading the configuration, the defaults will be used.

    New in version 3.0: This was previously called init. As it’s internal API, hopefully nobody was calling that.

    reset_config()[source]¶

    Reset the configuration to defaults.

    New in version 3.0.

    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]
    • DEFAULT_CONFIG
    • deprecated_keys
    • config
    • get_config_file_path()
    • load_config()
    • reset_config()