mirror of
https://github.com/encounter/adk-python.git
synced 2026-07-09 18:19:28 -07:00
chore: Add a base credential refresher interface
PiperOrigin-RevId: 772248299
This commit is contained in:
committed by
Copybara-Service
parent
28dfcd2512
commit
e2a81365ec
@@ -24,9 +24,17 @@ from ..auth_credential import AuthCredential
|
||||
from ..auth_schemes import AuthScheme
|
||||
|
||||
|
||||
class CredentialExchangError(Exception):
|
||||
"""Base exception for credential exchange errors."""
|
||||
|
||||
|
||||
@experimental
|
||||
class BaseCredentialExchanger(abc.ABC):
|
||||
"""Base interface for credential exchangers."""
|
||||
"""Base interface for credential exchangers.
|
||||
|
||||
Credential exchangers are responsible for exchanging credentials from
|
||||
one format or scheme to another.
|
||||
"""
|
||||
|
||||
@abc.abstractmethod
|
||||
async def exchange(
|
||||
@@ -44,6 +52,6 @@ class BaseCredentialExchanger(abc.ABC):
|
||||
The exchanged credential.
|
||||
|
||||
Raises:
|
||||
ValueError: If credential exchange fails.
|
||||
CredentialExchangError: If credential exchange fails.
|
||||
"""
|
||||
pass
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""Credential refresher module."""
|
||||
|
||||
from .base_credential_refresher import BaseCredentialRefresher
|
||||
|
||||
__all__ = [
|
||||
"BaseCredentialRefresher",
|
||||
]
|
||||
@@ -0,0 +1,74 @@
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""Base credential refresher interface."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import abc
|
||||
from typing import Optional
|
||||
|
||||
from google.adk.auth.auth_credential import AuthCredential
|
||||
from google.adk.auth.auth_schemes import AuthScheme
|
||||
from google.adk.utils.feature_decorator import experimental
|
||||
|
||||
|
||||
class CredentialRefresherError(Exception):
|
||||
"""Base exception for credential refresh errors."""
|
||||
|
||||
|
||||
@experimental
|
||||
class BaseCredentialRefresher(abc.ABC):
|
||||
"""Base interface for credential refreshers.
|
||||
|
||||
Credential refreshers are responsible for checking if a credential is expired
|
||||
or needs to be refreshed, and for refreshing it if necessary.
|
||||
"""
|
||||
|
||||
@abc.abstractmethod
|
||||
async def is_refresh_needed(
|
||||
self,
|
||||
auth_credential: AuthCredential,
|
||||
auth_scheme: Optional[AuthScheme] = None,
|
||||
) -> bool:
|
||||
"""Checks if a credential needs to be refreshed.
|
||||
|
||||
Args:
|
||||
auth_credential: The credential to check.
|
||||
auth_scheme: The authentication scheme (optional, some refreshers don't need it).
|
||||
|
||||
Returns:
|
||||
True if the credential needs to be refreshed, False otherwise.
|
||||
"""
|
||||
pass
|
||||
|
||||
@abc.abstractmethod
|
||||
async def refresh(
|
||||
self,
|
||||
auth_credential: AuthCredential,
|
||||
auth_scheme: Optional[AuthScheme] = None,
|
||||
) -> AuthCredential:
|
||||
"""Refreshes a credential if needed.
|
||||
|
||||
Args:
|
||||
auth_credential: The credential to refresh.
|
||||
auth_scheme: The authentication scheme (optional, some refreshers don't need it).
|
||||
|
||||
Returns:
|
||||
The refreshed credential.
|
||||
|
||||
Raises:
|
||||
CredentialRefresherError: If credential refresh fails.
|
||||
"""
|
||||
pass
|
||||
Reference in New Issue
Block a user