• 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. RBTools 5.x
    2. Version 5.x
    3. Version 4.x
    4. Version 3.x
    5. Version 2.0
    6. Version 1.0
    7. Version 0.7
    8. Version 0.6
    9. Version 0.5
    10. RBTools Python API
    11. Module and Class References
    12. rbtools.utils.filesystem
  • 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.config
  • rbtools.config.config
  • rbtools.config.loader
  • rbtools.diffs
  • rbtools.diffs.patches
  • rbtools.diffs.patcher
  • 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
  • rbtools.commands.base
  • rbtools.commands.base.commands
  • rbtools.commands.base.errors
  • rbtools.commands.base.options
  • rbtools.commands.base.output
  • 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.browser
  • 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.mimetypes
  • rbtools.utils.process
  • rbtools.utils.repository
  • rbtools.utils.review_request
  • rbtools.utils.source_tree
  • rbtools.utils.users
  • Glossary
  • General Index
  • Python Module Index
  • Release Notes
  • rbtools.utils.filesystem¶

    Utilities for working with files.

    Functions

    chdir(path)

    Change to the specified directory for the duration of the context.

    cleanup_tempfiles()

    Clean up temporary files which have been created.

    get_config_paths()

    Return the paths to each .reviewboardrc influencing the cwd.

    get_home_path()

    Return the path to the home directory.

    is_exe_in_path(name)

    Return whether an executable is in the user's search path.

    iter_exes_in_path(name)

    Iterate through all executables with a name in the user's search path.

    load_config()

    Load configuration from .reviewboardrc files.

    make_empty_files(files)

    Create each file in the given list and any intermediate directories.

    make_tempdir([parent, track])

    Create a temporary directory and return the path.

    make_tempfile(*[, content, prefix, suffix, ...])

    Create a temporary file and return the path.

    parse_config_file(filename)

    Parse a .reviewboardrc file.

    walk_parents(path)

    Walk up the tree to the root directory.

    rbtools.utils.filesystem.is_exe_in_path(name: str) → bool[source]¶

    Return whether an executable is in the user’s search path.

    This expects a name without any system-specific executable extension. It will append the proper extension as necessary. For example, use “myapp” and not “myapp.exe”.

    The result will be cached. Future lookups for the same executable will return the same value.

    Changed in version 3.0: The result is now cached.

    Parameters:

    name (str) – The name of the executable.

    Returns:

    True if the executable is in the path. False if it is not.

    Return type:

    bool

    rbtools.utils.filesystem.iter_exes_in_path(name: str) → Iterable[str][source]¶

    Iterate through all executables with a name in the user’s search path.

    This expects a name without any system-specific executable extension. It will append the proper extension as necessary. For example, use “myapp” and not “myapp.exe” or “myapp.cmd”. This will look for both variations.

    Changed in version 4.0.1: On Windows, if not searching for a deliberate .exe or .cmd extension, this will now look for variations with both extensions.

    New in version 4.0.

    Parameters:

    name (str) – The name of the executable.

    Yields:

    str – The location of an executable in the path.

    rbtools.utils.filesystem.cleanup_tempfiles() → None[source]¶

    Clean up temporary files which have been created.

    rbtools.utils.filesystem.make_tempfile(*, content: Optional[bytes] = None, prefix: str = 'rbtools.', suffix: Optional[str] = None, filename: Optional[str] = None) → str[source]¶

    Create a temporary file and return the path.

    If not manually removed, then the resulting temp file will be removed when RBTools exits (or if cleanup_tempfiles() is called).

    This can be given an explicit name for a temporary file, in which case the file will be created inside of a temporary directory (created with make_tempdir(). In this case, the parent directory will only be deleted when cleanup_tempfiles() is called.

    Parameters:
    • content (bytes, optional) – The content for the text file.

    • prefix (str, optional) – The prefix for the temp filename. This defaults to rbtools..

    • suffix (str, optional) – The suffix for the temp filename.

    • filename (str, optional) – An explicit name of the file. If provided, this will override suffix and prefix.

    Returns:

    The temp file path.

    Return type:

    str

    rbtools.utils.filesystem.make_tempdir(parent: Optional[str] = None, track: bool = True) → str[source]¶

    Create a temporary directory and return the path.

    By default, the path will be stored in a list for cleanup when calling cleanup_tempfiles().

    Changed in version 3.0: Added track.

    Parameters:
    • parent (str, optional) – An optional parent directory to create the path in.

    • track (bool, optional) –

      Whether to track the directory for later cleanup.

      New in version 3.0.

    Returns:

    The name of the new temporary directory.

    Return type:

    str

    rbtools.utils.filesystem.make_empty_files(files: Sequence[str]) → None[source]¶

    Create each file in the given list and any intermediate directories.

    Parameters:

    files (list of str) – The list of filenames to create.

    rbtools.utils.filesystem.walk_parents(path: str) → Iterable[str][source]¶

    Walk up the tree to the root directory.

    Yields:

    str – Each directory name while walking up to the root.

    rbtools.utils.filesystem.get_home_path() → str[source]¶

    Return the path to the home directory.

    Returns:

    The user’s home directory (or general place to store application data).

    Return type:

    str

    rbtools.utils.filesystem.get_config_paths() → Sequence[str][source]¶

    Return the paths to each .reviewboardrc influencing the cwd.

    A list of paths to .reviewboardrc files will be returned, where each subsequent list entry should have lower precedence than the previous. i.e. configuration found in files further up the list will take precedence.

    Configuration in the paths set in $RBTOOLS_CONFIG_PATH will take precedence over files found in the current working directory or its parents.

    Deprecated since version 5.0: This has been replaced with rbtools.config.loader.get_config_paths(), and will be removed in RBTools 6.

    rbtools.utils.filesystem.parse_config_file(filename: str) → RBToolsConfig[source]¶

    Parse a .reviewboardrc file.

    Returns a dictionary containing the configuration from the file.

    Deprecated since version 5.0: This has been replaced with rbtools.config.loader.parse_config_file(), and will be removed in RBTools 6.

    Parameters:

    filename (str) – The full path to a .reviewboardrc file.

    Returns:

    The loaded configuration data.

    Return type:

    dict

    Raises:

    SyntaxError – There was a syntax error in the configuration file.

    rbtools.utils.filesystem.load_config() → RBToolsConfig[source]¶

    Load configuration from .reviewboardrc files.

    This will read all of the .reviewboardrc files influencing the cwd and return a dictionary containing the configuration.

    Deprecated since version 5.0: This has been replaced with rbtools.config.loader.load_config(), and will be removed in RBTools 6.

    Returns:

    The loaded configuration data.

    Return type:

    dict

    rbtools.utils.filesystem.chdir(path: str) → Generator[None, None, None][source]¶

    Change to the specified directory for the duration of the context.

    New in version 4.0.

    Parameters:

    path (str) – The path to change to.

    Context:

    Operations will run within the specified directory.

    Raises:

    FileNotFoundError – The provided path does not exist.

    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]
    • is_exe_in_path()
    • iter_exes_in_path()
    • cleanup_tempfiles()
    • make_tempfile()
    • make_tempdir()
    • make_empty_files()
    • walk_parents()
    • get_home_path()
    • get_config_paths()
    • parse_config_file()
    • load_config()
    • chdir()