Skip to content

ux: Provide helpful link to documentation when error due to missing API token #1364

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
LennartPurucker merged 7 commits into from
Oct 17, 2024
Merged

ux: Provide helpful link to documentation when error due to missing API token #1364

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4edfd6
ux: Add better error message for missing API tokens
eddiebergman Oct 15, 2024
dc006a3
doc(_api): Give more description to magic numbers
eddiebergman Oct 15, 2024
9266a7f
test: Move `autouse` fixtures to test root
eddiebergman Oct 15, 2024
14d6584
feat: context manager to temporarily set config values
eddiebergman Oct 15, 2024
d1d2da2
style: better function name with `overwrite_config_context`
eddiebergman Oct 15, 2024
c95ef39
test: Ensure context fixtures are session scoped
eddiebergman Oct 16, 2024
a845535
fix: remove prints
eddiebergman Oct 17, 2024
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
Prev Previous commit
Next Next commit
feat: context manager to temporarily set config values
  • Loading branch information
@eddiebergman
eddiebergman committed Oct 17, 2024
commit 14d658411de2b2758dab01e60c9b843a40392da6
15 changes: 14 additions & 1 deletion openml/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
import platform
import shutil
import warnings
from contextlib import contextmanager
from io import StringIO
from pathlib import Path
from typing import Any, cast
from typing import Any, Iterator, cast
from typing_extensions import Literal, TypedDict
from urllib.parse import urlparse

Expand Down Expand Up @@ -497,6 +498,18 @@ def set_root_cache_directory(root_cache_directory: str | Path) -> None:
stop_using_configuration_for_example = ConfigurationForExamples.stop_using_configuration_for_example


@contextmanager
def set_context(config: dict[str, Any]) -> Iterator[_Config]:
"""A context manager to temporarily override variables in the configuration."""
existing_config = get_config_as_dict()
merged_config = {**existing_config, **config}

_setup(merged_config) # type: ignore
yield merged_config # type: ignore

_setup(existing_config)


__all__ = [
"get_cache_directory",
"set_root_cache_directory",
Expand Down
7 changes: 5 additions & 2 deletions tests/test_openml/test_api_calls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import pytest

import openml
from openml.config import ConfigurationForExamples
import openml.testing
from openml._api_calls import _download_minio_bucket, API_TOKEN_HELP_LINK

Expand Down Expand Up @@ -118,5 +119,7 @@ def test_authentication_endpoints_requiring_api_key_show_relevant_help_link(
endpoint: str,
method: str,
) -> None:
with pytest.raises(openml.exceptions.OpenMLNotAuthorizedError, match=API_TOKEN_HELP_LINK) as e:
openml._api_calls._perform_api_call(call=endpoint, request_method=method, data=None)
# We need to temporarily disable the API key to test the error message
with openml.config.set_context({"apikey": None}):
with pytest.raises(openml.exceptions.OpenMLNotAuthorizedError, match=API_TOKEN_HELP_LINK):
openml._api_calls._perform_api_call(call=endpoint, request_method=method, data=None)