Repository navigation
Wrong return type annotation in ProjectCommit.refs() #1805
Description
Description of the problem, including code/CLI snippet
ProjectCommit.refs() returns List[Dict[str, Any]], but the type annotations say it returns Union[Dict[str, Any], requests.Response].
Specifications
- python-gitlab version: 3.0.0
- API version you are using (v3/v4): v4
- Gitlab server version (or gitlab.com): -
Reacted by Nejc Habjan and John Villalovos
Activity
nejch commentedon Jan 5, 2022
Thanks for the report @robertschweizer. Looking at the endpoint, the method currently used is wrong anyway, because we might get a paginated response so we should be doing an
http_list()instead. So we should revamp this a little.nejch commentedon Jan 5, 2022
We probably also have the same issue with
ProjectCommit.diff()andProjectCommit.merge_requests()at least for typing, and not sure about pagination yet as it is not documented upstream.JohnVillalovos commentedon Jan 5, 2022
Ah. I had assumed every API call returned a
Dict[str, Any]. Okay will need to change things to handle this. Thanks for the report!chore: fix type-hints for ProjectCommit methods
chore: fix type-hints for ProjectCommit methods
fix: change to `http_list` for some ProjectCommit methods