• Get Review Board
  • What's New
  • Downloads
  • 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 More
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Product Information for AI Agents
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. RBTools 4.x
    2. Version 7.x
    3. Version 6.x
    4. Version 5.x
    5. Version 4.x
    6. Version 3.x
    7. Version 2.0
    8. Version 1.0
    9. Version 0.7
    10. Version 0.6
    11. Version 0.5
    12. RBTools Python API
    13. Module and Class References
    14. rbtools.utils.checks
  • Home
  • Installing RBTools
  • rbt Command
  • Configuration
  • Authenticating to Review Board
  • Repository Configuration
  • Per-User Configuration
  • Team Foundation Server Configuration
  • Commands
  • alias
  • api-get
  • attach
  • clear-cache
  • close
  • diff
  • install
  • land
  • list-repo-types
  • login
  • logout
  • patch
  • post
  • publish
  • review
  • setup-completion
  • setup-repo
  • stamp
  • status
  • status-update
  • RBTools Workflows
  • Using RBTools With Cliosoft SOS
  • Using RBTools with Git
  • Using RBTools with HCL VersionVault and IBM ClearCase
  • Using RBTools With Perforce
  • RBTools Python API
  • Overview of the Python API Client
  • Tutorial
  • Resource-Specific Functionality
  • Module and Class References
  • rbtools
  • rbtools.deprecation
  • rbtools.api
  • rbtools.api.cache
  • rbtools.api.capabilities
  • rbtools.api.client
  • rbtools.api.decode
  • 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
  • rbtools.clients
  • rbtools.clients.base
  • rbtools.clients.base.patch
  • rbtools.clients.base.registry
  • rbtools.clients.base.repository
  • rbtools.clients.base.scmclient
  • rbtools.clients.errors
  • rbtools.clients.bazaar
  • rbtools.clients.clearcase
  • rbtools.clients.cvs
  • rbtools.clients.git
  • rbtools.clients.mercurial
  • rbtools.clients.perforce
  • rbtools.clients.plastic
  • rbtools.clients.sos
  • rbtools.clients.svn
  • rbtools.clients.tfs
  • rbtools.diffs
  • rbtools.diffs.tools
  • rbtools.diffs.tools.backends
  • rbtools.diffs.tools.backends.gnu
  • rbtools.diffs.tools.base
  • rbtools.diffs.tools.base.diff_file_result
  • rbtools.diffs.tools.base.diff_tool
  • rbtools.diffs.tools.errors
  • rbtools.diffs.tools.registry
  • rbtools.diffs.writers
  • 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
  • rbtools.commands.install
  • rbtools.commands.land
  • rbtools.commands.list_repo_types
  • rbtools.commands.login
  • rbtools.commands.logout
  • rbtools.commands.patch
  • rbtools.commands.post
  • rbtools.commands.publish
  • rbtools.commands.review
  • rbtools.commands.setup_completion
  • rbtools.commands.setup_repo
  • rbtools.commands.stamp
  • rbtools.commands.status
  • rbtools.commands.status_update
  • rbtools.hooks
  • rbtools.hooks.common
  • rbtools.hooks.git
  • rbtools.testing
  • rbtools.testing.api
  • rbtools.testing.api.payloads
  • rbtools.testing.api.transport
  • rbtools.testing.commands
  • rbtools.testing.testcase
  • rbtools.testing.transport
  • rbtools.utils
  • rbtools.utils.aliases
  • rbtools.utils.checks
  • rbtools.utils.commands
  • rbtools.utils.console
  • rbtools.utils.diffs
  • rbtools.utils.encoding
  • rbtools.utils.errors
  • rbtools.utils.filesystem
  • rbtools.utils.graphs
  • rbtools.utils.match_score
  • rbtools.utils.process
  • rbtools.utils.repository
  • rbtools.utils.review_request
  • rbtools.utils.source_tree
  • rbtools.utils.testbase
  • rbtools.utils.users
  • Glossary
  • General Index
  • Python Module Index
  • Release Notes
  • This documentation covers RBTools 4.x. You can select a version above or view the latest documentation.

    rbtools.utils.checks¶

    Utilities for checking for dependencies.

    Functions

    check_gnu_diff()

    Check if GNU diff is installed, and informs the user if it's not.

    check_install(command)

    Check if the given command is installed.

    is_valid_version(actual, expected)

    Return whether one tuple is greater than or equal to another.

    rbtools.utils.checks.check_install(command)[source]¶

    Check if the given command is installed.

    Try executing an external command and return a boolean indicating whether that command is installed or not. The ‘command’ argument should be something that executes quickly, without hitting the network (for instance, ‘svn help’ or ‘git –version’).

    rbtools.utils.checks.check_gnu_diff()[source]¶

    Check if GNU diff is installed, and informs the user if it’s not.

    Deprecated since version 4.0: Clients should use Diff Tools (see rbtools.diffs.tools) instead.

    This will be removed in 5.0.

    Raises:

    Exception – GNU diff is not installed.

    rbtools.utils.checks.is_valid_version(actual, expected)[source]¶

    Return whether one tuple is greater than or equal to another.

    Tuples should be in the form of:

    (major_version, minor_version, micro_version)
    

    With each version an integer.

    Deprecated since version 4.0: Consumers should just compare tuples directly. This will be removed in RBTools 5.0.

    Parameters:
    • actual (tuple of int) – The actual version to compare.

    • expected (tuple of int) – The expected version to compare against.

    Returns:

    True if actual is greater than or equal to the expected version. False otherwise.

    Return type:

    bool

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    Pricing/Plans
    News
    Demo
    Integrations
    Support Options
    Product Info for Agents
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    Power Pack
    RBCommons Hosting
    RBTools
    Review Bot
    RB Gateway
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube
    Copyright © 2006-2026 Beanbag, Inc. All rights reserved.
    Terms of Service — Privacy Policy — AI Ethics Policy — AI Agent Sitemap — Branding

    On this page

    • [Top]