• 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.clients.base.repository
  • 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.clients.base.repository¶

    Classes for representing source code repositories.

    New in version 4.0.

    Classes

    RepositoryInfo(*[, path, base_path, local_path])

    A representation of a source code repository.

    class rbtools.clients.base.repository.RepositoryInfo(*, path: Optional[Union[str, List[str]]] = None, base_path: Optional[str] = None, local_path: Optional[str] = None)[source]¶

    Bases: object

    A representation of a source code repository.

    Changed in version 4.0:

    • Moved from rbtools.clients. That module still provides compatibility imports.

    • Removed the deprecated name, supports_changesets, and supports_parent_diffs attributes.

    • Removed the deprecated find_server_repository_info() method.

    __init__(*, path: Optional[Union[str, List[str]]] = None, base_path: Optional[str] = None, local_path: Optional[str] = None) → None[source]¶

    Initialize the object.

    Changed in version 4.0:

    • The name, supports_changesets, and supports_parent_diffs arguments have been removed.

    • All arguments must be passed in as keyword arguments. This will be required in RBTools 5.

    Changed in version 3.0:

    • The name argument was deprecated. Clients which allow configuring the repository name in metadata should instead implement get_repository_name().

    • The supports_changesets and supports_parent_diffs arguments were deprecated. Clients which need these should instead set supports_changesets and supports_parent_diffs on themselves.

    Parameters:
    • path (str or list of str, optional) –

      The path of the repository, or a list of possible paths (with the primary one appearing first).

      This can be empty by default, if the caller expects to later populate it with update_from_remote().

    • base_path (str, optional) – The relative path between the current working directory and the repository root.

    • local_path (str, optional) – The local filesystem path for the repository. This can sometimes be the same as path, but may not be (since that can contain a remote repository path).

    • name (str, optional) – The name of the repository, as configured on Review Board. This might be available through some repository metadata.

    • supports_changesets (bool, optional) – Whether the repository type supports changesets that store their data server-side.

    • supports_parent_diffs (bool, optional) – Whether the repository type supports posting changes with parent diffs.

    path: Optional[Union[str, List[str]]]¶

    The path of the repository, or a list of possible paths.

    This may be empty.

    Type:

    str or list of str

    base_path: Optional[str]¶

    Relative path between the working directory and repository root.

    This is dependent on the type of SCM, and may be empty.

    Type:

    str

    local_path: Optional[str]¶

    The local filesystem path for the repository.

    This can sometimes be the same as path, but may not be (since that can contain a remote repository path).

    Type:

    str

    __repr__() → str[source]¶

    Return a string representation of the repository info.

    Returns:

    The string representation.

    Return type:

    str

    __str__() → str[source]¶

    Return a human-readable representation of the repository info.

    Returns:

    The string representation.

    Return type:

    str

    set_base_path(base_path: str) → None[source]¶

    Set the base path of the repository info.

    Parameters:

    base_path (str) – The relative path between the current working directory and the repository root.

    update_from_remote(repository: ItemResource, info: Optional[ItemResource]) → None[source]¶

    Update the info from a remote repository.

    Subclasses may override this to fetch additional data from the server.

    By default, this simply sets the path based on the repository.

    Parameters:
    • repository (rbtools.api.resource.ItemResource) – The repository resource.

    • info (rbtools.api.resource.ItemResource, unused) –

      The repository info resource.

      This is not used by default, but is available to callers.

    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]
    • RepositoryInfo
      • RepositoryInfo.__init__()
      • RepositoryInfo.path
      • RepositoryInfo.base_path
      • RepositoryInfo.local_path
      • RepositoryInfo.__repr__()
      • RepositoryInfo.__str__()
      • RepositoryInfo.set_base_path()
      • RepositoryInfo.update_from_remote()