Summary

Add a local_site parameter to SCMClients.

Review Request #14910 — Created March 17, 2026 and submitted April 8, 2026, 1:14 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Many SCMClients need to manage state tied to a Local Site, and do so by
passing in a client-specific local_site_name. With the upcoming cert
work, this is going to be needed more broadly, and we'll need an
instance.

We always have access to an instance in places where we initialize a
client. This happens in both an SCMTool's __init__() and in
check_repository(). This makes it easy to pass this in.

This change updates the base SCMClient to take and store this,
updates all subclasses to pass it to the parent, and updates call sites
to pass it to the client. In many cases, surrounding code has been
cleaned up to avoid duplicate effort or to bail early when there are
problems.

There were a couple of clients that didn't inherit from SCMClient.
This change updates most of them. A notable exception is the Subversion
clients, which have a lot more complexity going on and aren't worth
tackling in this change.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add a local_site parameter to SCMClients. Many SCMClients need to manage state tied to a Local Site, and do so by passing in a client-specific `local_site_name`. With the upcoming cert work, this is going to be needed more broadly, and we'll need an instance. We always have access to an instance in places where we initialize a client. This happens in both an SCMTool's `__init__()` and in `check_repository()`. This makes it easy to pass this in. This change updates the base `SCMClient` to take and store this, updates all subclasses to pass it to the parent, and updates call sites to pass it to the client. In many cases, surrounding code has been cleaned up to avoid duplicate effort or to bail early when there are problems. There were a couple of clients that didn't inherit from `SCMClient`. This change updates most of them. A notable exception is the Subversion clients, which have a lot more complexity going on and aren't worth tackling in this change.	426dfb7fe088c3a196713f3c4e11b61c4477b076

Summary

Add a local_site parameter to SCMClients.

Many SCMClients need to manage state tied to a Local Site, and do so by passing in a client-specific `local_site_name`. With the upcoming cert work, this is going to be needed more broadly, and we'll need an instance. We always have access to an instance in places where we initialize a client. This happens in both an SCMTool's `__init__()` and in `check_repository()`. This makes it easy to pass this in. This change updates the base `SCMClient` to take and store this, updates all subclasses to pass it to the parent, and updates call sites to pass it to the client. In many cases, surrounding code has been cleaned up to avoid duplicate effort or to bail early when there are problems. There were a couple of clients that didn't inherit from `SCMClient`. This change updates most of them. A notable exception is the Subversion clients, which have a lot more complexity going on and aren't worth tackling in this change.

426dfb7fe088c3a196713f3c4e11b61c4477b076

Issues

Description	From	Last Updated
A bunch of the clients also take local_site_name and then store it as an attribute. Perhaps we should plumb that …	david	April 2, 2026, 8 a.m.
'reviewboard.site.models.LocalSite' imported but unused Column: 5 Error code: F401	reviewbot	April 2, 2026, 1:13 p.m.
Typo: local_site -> local_site_name	david	April 2, 2026, 1:06 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/scmtools/cvs.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.site.models.LocalSite' imported but unused

Column: 5
Error code: F401

The issue has been dropped. Show all issues

A bunch of the clients also take local_site_name and then store it as an attribute. Perhaps we should plumb that through to the base class as well, and then we could derive local_site or local_site_name as needed if one or the other is provided?

chipx86

April 2, 2026, 1:06 a.m.

I started doing that when working on this change and it was just feeling like a larger set of work I didn't want to tackle. I think it's something to circle back to once this is in.

david

April 2, 2026, 8 a.m.

reviewboard/scmtools/git.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: local_site -> local_site_name
```

Change Summary:


Removed an unused import.
Fixed an argument name in docs.

Commits:

	Summary	ID
	Add a local_site parameter to SCMClients. Many SCMClients need to manage state tied to a Local Site, and do so by passing in a client-specific `local_site_name`. With the upcoming cert work, this is going to be needed more broadly, and we'll need an instance. We always have access to an instance in places where we initialize a client. This happens in both an SCMTool's `__init__()` and in `check_repository()`. This makes it easy to pass this in. This change updates the base `SCMClient` to take and store this, updates all subclasses to pass it to the parent, and updates call sites to pass it to the client. In many cases, surrounding code has been cleaned up to avoid duplicate effort or to bail early when there are problems. There were a couple of clients that didn't inherit from `SCMClient`. This change updates most of them. A notable exception is the Subversion clients, which have a lot more complexity going on and aren't worth tackling in this change.	44faab9b3c5435949d662cf2e08c58349fd4fb8b
	Add a local_site parameter to SCMClients. Many SCMClients need to manage state tied to a Local Site, and do so by passing in a client-specific `local_site_name`. With the upcoming cert work, this is going to be needed more broadly, and we'll need an instance. We always have access to an instance in places where we initialize a client. This happens in both an SCMTool's `__init__()` and in `check_repository()`. This makes it easy to pass this in. This change updates the base `SCMClient` to take and store this, updates all subclasses to pass it to the parent, and updates call sites to pass it to the client. In many cases, surrounding code has been cleaned up to avoid duplicate effort or to bail early when there are problems. There were a couple of clients that didn't inherit from `SCMClient`. This change updates most of them. A notable exception is the Subversion clients, which have a lot more complexity going on and aren't worth tackling in this change.	426dfb7fe088c3a196713f3c4e11b61c4477b076

Diff:

Revision 2 (+804 -254)

Show changes

	reviewboard/scmtools/core.py
	reviewboard/scmtools/cvs.py
	reviewboard/scmtools/git.py
	reviewboard/scmtools/hg.py
	reviewboard/scmtools/perforce.py
	reviewboard/scmtools/bzr/__init__.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.1.x (fcd2d81)