fix(types): add explicit submodule import for pyright compatibility#3343
Open
janfrederik wants to merge 1 commit intopython-gitlab:mainfrom
Open
fix(types): add explicit submodule import for pyright compatibility#3343janfrederik wants to merge 1 commit intopython-gitlab:mainfrom
janfrederik wants to merge 1 commit intopython-gitlab:mainfrom
Conversation
Add `import gitlab.base` inside the TYPE_CHECKING block in repositories.py so that pyright can resolve `gitlab.base.RESTObject`. Without the explicit import, pyright cannot resolve the submodule access via the parent package (implicit submodule access is a runtime loader side effect that type checkers don't model). This caused `_RestObjectBase` to be `Unknown`, propagating through `RepositoryMixin` into `Project` and other classes. Fixes python-gitlab#3342 Co-Authored-By: Claude Opus 4.6 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
import gitlab.baseinside theTYPE_CHECKINGblock inrepositories.pyso that pyright can resolvegitlab.base.RESTObjectWithout the explicit import, pyright cannot resolve the submodule access via the parent package — implicit submodule access is a runtime loader side effect that type checkers don't model (pyright docs). This causes
_RestObjectBaseto beUnknown, which propagates throughRepositoryMixinintoProjectand other classes that inherit it, producingreportUnknownMemberType/reportUnknownVariableType/reportUnknownArgumentTypewarnings.Note:
gitlab/mixins.pyhas the same pattern but already works correctly because it usesfrom gitlab import baseand thenbase.RESTObject.Fixes #3342
Test plan
# pyright: ignoresuppression comments become unnecessary after this fixTYPE_CHECKINGblock only)