Use TYPE_CHECKING in optuna/_gp/acqf.py to avoid circular imports#6204
Merged
nabenabe0928 merged 1 commit intooptuna:masterfrom Jul 17, 2025
Merged
Conversation
optuna/_gp/acqf.py
Outdated
Comment on lines
+10
to
+14
| from optuna._gp.gp import GPRegressor | ||
| from optuna._gp.search_space import SearchSpace | ||
|
|
||
| if TYPE_CHECKING: | ||
| from optuna._gp.gp import GPRegressor | ||
| from optuna._gp.search_space import SearchSpace | ||
|
|
Contributor
There was a problem hiding this comment.
The TYPE_CHECKING section is already prepared below, so could you please move these module imports to the section?
Author
There was a problem hiding this comment.
Sure! Thanks for pointing that out , I’ll move the imports into the existing TYPE_CHECKING section and update the PR shortly
3a475e5 to
8e29b0e
Compare
nabenabe0928
approved these changes
Jul 17, 2025
Contributor
nabenabe0928
left a comment
There was a problem hiding this comment.
Thank you for the change, LGTM:)
TYPE_CHECKING in optuna/_gp/acqf.py to avoid circular imports
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
2 participants
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.
Motivation
Currently, two modules (GPRegressor and SearchSpace) are imported unconditionally in optuna/_gp/acqf.py, which can trigger circular‐import errors at runtime. By moving these imports into a if TYPE_CHECKING: block, we ensure that they’re only used for static type hints and never executed during normal imports.
Description of the changes
This fixes issue #6029 by wrapping the two imports in optuna/_gp/acqf.py with if TYPE_CHECKING: so they’re only for type hints.
Also ran python3 -m flake8 optuna/_gp/acqf.py —> no more TC001 warnings in that file.
Fixes #6029