Summary

Modernize github implementation and use Pydantic for parsing.

Review Request #15122 — Created June 12, 2026 and submitted June 24, 2026, 8:34 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-9.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change updates our github client implementation to use Pydantic for
parsing API payloads, and fixes up type hints and docstrings throughout.

While working in the paginated resources, I realized that the start
and per_page parameters weren't getting plumbed through at all, so
I've fixed that as well.

Testing Done

Ran unit tests.

Commits

Summary	ID
Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp

Summary

Modernize github implementation and use Pydantic for parsing.

This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.

myylkmlorkqwkztrmunzoxxvoszokpqp

Issues

Description	From	Last Updated
closing bracket does not match indentation of opening bracket's line Column: 9 Error code: E123	reviewbot	June 12, 2026, 4:22 p.m.
Can we use Sequence instead of list here and for rhe rest of the list-type attributes?	maubin	June 15, 2026, 8:51 a.m.
Old typo not caught by your other change: "with" -> "will".	maubin	June 15, 2026, 8:51 a.m.
This is missing an Args and Returns section.	maubin	June 15, 2026, 8:53 a.m.
Same typo here as mentioned above.	maubin	June 15, 2026, 8:53 a.m.
'reviewboard.scmtools.core.Commit' imported but unused Column: 1 Error code: F401	reviewbot	June 15, 2026, 2:43 p.m.
continuation line over-indented for hanging indent Column: 17 Error code: E126	reviewbot	June 15, 2026, 2:43 p.m.
This should say TreeResponse.	maubin	June 24, 2026, 8:33 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/hostingsvcs/github/service.py (Diff revision 1)

The issue has been dropped. Show all issues

closing bracket does not match indentation of opening bracket's line

Column: 9
Error code: E123

Commits:

	Summary	ID
	Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp
	Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp

Diff:

Revision 2 (+2852 -1048)

Show changes

	reviewboard/hostingsvcs/base/paginator.py
	reviewboard/hostingsvcs/github/api.py
	reviewboard/hostingsvcs/github/client.py
	reviewboard/hostingsvcs/github/forms.py
	reviewboard/hostingsvcs/github/service.py
	reviewboard/hostingsvcs/github/views.py
	reviewboard/hostingsvcs/tests/test_github.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/hostingsvcs/github/api.py (Diff revision 2)

The issue has been dropped. Show all issues

Can we use Sequence instead of list here and for rhe rest of the list-type attributes?

david

June 15, 2026, 2:40 p.m.

No, pydantic doesn't know what Sequence should resolve to.

reviewboard/hostingsvcs/github/client.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Old typo not caught by your other change: "with" -> "will".
```

reviewboard/hostingsvcs/github/service.py (Diff revision 2)

The issue has been resolved. Show all issues

This is missing an Args and Returns section.

reviewboard/hostingsvcs/github/service.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Same typo here as mentioned above.
```

Change Summary:

Changed my mind on the approach. Instead of the client basically implementing the BaseHostingService API directly, it now is a thin(ish) layer that makes requests to specific API endpoints and returns either the pydantic model (for individual items) or a paginator (for lists). Logic for composing API calls and converting the pydantic models into the hostingsvcs/scmtools return values has been moved back into the hosting service class.
I've also added the default_branch implementation that was previously a TODO comment.

Commits:

	Summary	ID
	Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp
	Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp

Diff:

Revision 3 (+3296 -1136)

Show changes

	reviewboard/hostingsvcs/base/paginator.py
	reviewboard/hostingsvcs/github/api.py
	reviewboard/hostingsvcs/github/client.py
	reviewboard/hostingsvcs/github/forms.py
	reviewboard/hostingsvcs/github/service.py
	reviewboard/hostingsvcs/github/views.py
	reviewboard/hostingsvcs/tests/test_github.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/hostingsvcs/github/client.py (Diff revision 3)
The issue has been resolved. Show all issues
```
'reviewboard.scmtools.core.Commit' imported but unused

Column: 1
Error code: F401
```
reviewboard/hostingsvcs/github/service.py (Diff revision 3)
The issue has been dropped. Show all issues
```
continuation line over-indented for hanging indent

Column: 17
Error code: E126
```

Commits:

	Summary	ID
	Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp
	Modernize github implementation and use Pydantic for parsing. This change updates our github client implementation to use Pydantic for parsing API payloads, and fixes up type hints and docstrings throughout. While working in the paginated resources, I realized that the way the page parameters were plumbed for the GitHubAPIPaginator wasn't actually working, and that given that GitHub API resources don't use a consistent name for the start parameter, I've baked the start and per_page values into the initial URL parameters instead of relying on the `request_kwargs` member. Testing Done: Ran unit tests.	myylkmlorkqwkztrmunzoxxvoszokpqp

Diff:

Revision 4 (+3294 -1136)

Show changes

	reviewboard/hostingsvcs/base/paginator.py
	reviewboard/hostingsvcs/github/api.py
	reviewboard/hostingsvcs/github/client.py
	reviewboard/hostingsvcs/github/forms.py
	reviewboard/hostingsvcs/github/service.py
	reviewboard/hostingsvcs/github/views.py
	reviewboard/hostingsvcs/tests/test_github.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

reviewboard/hostingsvcs/github/client.py (Diff revision 4)
The issue has been resolved. Show all issues
```
This should say TreeResponse.
```

Status:: Completed
Change Summary:: Pushed to release-9.x (d33a34b)