Skip to content

fix: well_known_url field deprecation warning #1625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jacob-williamson merged 4 commits into from
Aug 14, 2026
Merged

fix: well_known_url field deprecation warning #1625

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8902b94
Fix deprecation warning
jacob-williamson Aug 13, 2026
b411b3d
Merge branch 'main' into fix_deprecation_warning
jacob-williamson Aug 13, 2026
044505a
Fix tests
jacob-williamson Aug 13, 2026
b223a7a
Log a message instead of a warning
jacob-williamson Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions src/blueapi/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,26 +236,20 @@ class OIDCConfig(BlueapiBaseModel):

@model_validator(mode="after")
def check_urls(self) -> Self:
if self.issuer is None and self.well_known_url is None:
if self.issuer is None and self.__dict__.get("well_known_url") is None:
raise ValueError("Please provide 'OIDCConfig.issuer'")
if self.well_known_url:
if self.__dict__.get("well_known_url"):
LOGGER.warning(

@tpoliaw tpoliaw Aug 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should either raise a warning or log a message. Logging a warning is not really doing either how they're intended.

@jacob-williamson jacob-williamson Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, I've made it a log message

DeprecationWarning(
"OIDCConfig.well_known_url is deprecated, "
"Please use OIDCConfig.issuer"
),
"OIDCConfig.well_known_url is deprecated, Please use OIDCConfig.issuer"
)
return self

@cached_property
def _well_known_url(self) -> str:
if self.issuer:
if self.well_known_url:
if self.__dict__.get("well_known_url"):
LOGGER.warning(
DeprecationWarning(
"well_known_url and issuer are both set. "
"Defaulting to issuer URL"
),
"well_known_url and issuer are both set. Defaulting to issuer URL"
)
return self.issuer + "/.well-known/openid-configuration"
return cast(str, self.well_known_url)
Expand Down
Loading