Skip to content
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

Add property expiry in gspread client #1453

Merged
merged 1 commit into from
May 26, 2024
Merged

Add property expiry in gspread client #1453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions gspread/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

"""

from datetime import datetime
from http import HTTPStatus
from typing import Any, Dict, List, Optional, Tuple, Union

Expand Down Expand Up @@ -39,6 +40,18 @@ def __init__(
) -> None:
self.http_client = http_client(auth, session)

@property
def expiry(self) -> Optional[datetime]:
"""Returns the expiry date of the curenlty loaded credentials

:returns: (optional) datetime the expiry date time object.

.. note::

It only applies to gspread client created using oauth
"""
return self.http_client.auth.expiry

def set_timeout(
self, timeout: Optional[Union[float, Tuple[float, float]]] = None
) -> None:
Expand Down