Automatically check whether API key is valid #79
Conversation
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
|
The OA team provided an API key; see #80 for the update. |
Great! |
THis PR is still valid to check the user's API, right? Or am I missing something in your changes? |
J535D165
requested changes
Jun 25, 2025
| else: | ||
| logging.info("API key is working 👍") | ||
| ``` | ||
| pyalex will automatically check whether your API key is valid and throw a `ValueError` if it isn't. |
There was a problem hiding this comment.
Actually, OpenAlex should check this server-side and raise an error if the key is not valid. I propose to file an issue in their issue tracker.
I propose to remove this logic here because it's implicit, which is not very Pythonic.
Comment on lines
+1106
to
+1124
| def _check_api_key(): | ||
| """Check if the API key is valid.""" | ||
| bk_cods = config.retry_http_codes | ||
| config.retry_http_codes = None | ||
| dt = f"{datetime.datetime.now().year}-01-01" | ||
| res = None | ||
| try: | ||
| Works().filter(from_updated_date=dt).get() | ||
| except requests.exceptions.HTTPError as e: | ||
| if e.response.status_code == 403: | ||
| res = False | ||
| else: | ||
| logging.error(f"Unexpected HTTP error: {e}") | ||
| raise | ||
| else: | ||
| res = True | ||
| finally: | ||
| config.retry_http_codes = bk_cods | ||
| return res |
There was a problem hiding this comment.
I like this function. I propose the following API:
from pyalex.utils import check_api_key
check_api_key()
# raises ValueError if incorrect, returns None if valid. This way, we separate our custom logics from the pure wrapper.
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.
It is not extremely clean but is the cleanest approach I could come up with
The problem is that to check the API key we need
Worksto be defined, butAlexConfigis defined beforeWorks