helpful messages when no api token is present both inside and outside PythonAnywhere.

Author: filiplajszczak

pyproject.toml

@@ -27,6 +27,9 @@ pytest = "^7.0.0"
 pytest-mock = "^3.6.1"
 responses = "^0.13.3"
 
+[tool.black]
+line-length = 120
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

pythonanywhere_core/base.py

@@ -6,41 +6,52 @@
 from pythonanywhere_core.exceptions import AuthenticationError, NoTokenError
 
 PYTHON_VERSIONS: Dict[str, str] = {
-    "3.6": "python36", "3.7": "python37", "3.8": "python38", "3.9": "python39"
+    "3.6": "python36",
+    "3.7": "python37",
+    "3.8": "python38",
+    "3.9": "python39",
+    "3.10": "python310",
 }
 
 
 def get_api_endpoint() -> str:
     hostname = os.environ.get(
         "PYTHONANYWHERE_SITE",
-        "www." + os.environ.get(
-            "PYTHONANYWHERE_DOMAIN",
-            "pythonanywhere.com"
-        )
+        "www." + os.environ.get("PYTHONANYWHERE_DOMAIN", "pythonanywhere.com"),
     )
     return f"https://{hostname}/api/v0/user/{{username}}/{{flavor}}/"
 
 
-def call_api(url: str, method: str, **kwargs) -> requests.Response:
-    token = os.environ.get("API_TOKEN")
-    if token is None:
-        raise NoTokenError(
+def helpful_token_error_message() -> str:
+    if os.environ.get("PYTHONANYWHERE_SITE"):
+        return (
             "Oops, you don't seem to have an API token.  "
             "Please go to the 'Account' page on PythonAnywhere, then to the 'API Token' "
             "tab.  Click the 'Create a new API token' button to create the token, then "
-            "start a new console and try running this script again."
+            "start a new console and try running me again."
+        )
+    else:
+        return (
+            "Oops, you don't seem to have an API_TOKEN environment variable set.  "
+            "Please go to the 'Account' page on PythonAnywhere, then to the 'API Token' "
+            "tab.  Click the 'Create a new API token' button to create the token, then "
+            "use it to set API_TOKEN environmental variable and try running me again."
         )
+
+
+def call_api(url: str, method: str, **kwargs) -> requests.Response:
+    token = os.environ.get("API_TOKEN")
+    if token is None:
+        raise NoTokenError(helpful_token_error_message())
     insecure = os.environ.get("PYTHONANYWHERE_INSECURE_API") == "true"
     response = requests.request(
         method=method,
         url=url,
         headers={"Authorization": f"Token {token}"},
         verify=not insecure,
-        **kwargs
+        **kwargs,
     )
     if response.status_code == 401:
         print(response, response.text)
-        raise AuthenticationError(
-            f"Authentication error {response.status_code} calling API: {response.text}"
-        )
+        raise AuthenticationError(f"Authentication error {response.status_code} calling API: {response.text}")
     return response

tests/test_base.py

@@ -1,49 +1,75 @@
 import pytest
 import responses
 
-from pythonanywhere_core.base import call_api, get_api_endpoint
-from pythonanywhere_core.exceptions import AuthenticationError
+from pythonanywhere_core.base import (
+    call_api,
+    get_api_endpoint,
+    helpful_token_error_message,
+)
+from pythonanywhere_core.exceptions import AuthenticationError, NoTokenError
+
 
 @pytest.fixture
 def mock_requests(mocker):
     return mocker.patch("pythonanywhere_core.base.requests")
 
 
-class TestGetAPIEndpoint:
+def test_api_endpoint_defaults_to_pythonanywhere_dot_com_if_no_environment_variables():
+    assert get_api_endpoint() == "https://www.pythonanywhere.com/api/v0/user/{username}/{flavor}/"
+
+
+def test_gets_domain_from_pythonanywhere_site_and_ignores_pythonanywhere_domain_if_both_set(monkeypatch):
+    monkeypatch.setenv("PYTHONANYWHERE_SITE", "www.foo.com")
+    monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "wibble.com")
+
+    assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
+
+
+def test_gets_domain_from_pythonanywhere_domain_and_adds_on_www_if_set_but_no_pythonanywhere_site(monkeypatch):
+    monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "foo.com")
+
+    assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
+
+
+def test_raises_on_401(api_token, api_responses):
+    url = "https://foo.com/"
+    api_responses.add(responses.POST, url, status=401, body="nope")
+    with pytest.raises(AuthenticationError) as e:
+        call_api(url, "post")
+    assert str(e.value) == "Authentication error 401 calling API: nope"
+
+
+def test_passes_verify_from_environment(api_token, monkeypatch, mock_requests):
+    monkeypatch.setenv("PYTHONANYWHERE_INSECURE_API", "true")
+
+    call_api("url", "post", foo="bar")
+
+    _, kwargs = mock_requests.request.call_args
+    assert kwargs["verify"] is False
+
+
+def test_verify_is_true_if_env_not_set(api_token, mock_requests):
+    call_api("url", "post", foo="bar")
 
-    def test_defaults_to_pythonanywhere_dot_com_if_no_environment_variables(self):
-        assert get_api_endpoint() == "https://www.pythonanywhere.com/api/v0/user/{username}/{flavor}/"
+    _, kwargs = mock_requests.request.call_args
+    assert kwargs["verify"] is True
 
-    def test_gets_domain_from_pythonanywhere_site_and_ignores_pythonanywhere_domain_if_both_set(self, monkeypatch):
-        monkeypatch.setenv("PYTHONANYWHERE_SITE", "www.foo.com")
-        monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "wibble.com")
-        assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
 
-    def test_gets_domain_from_pythonanywhere_domain_and_adds_on_www_if_set_but_no_pythonanywhere_site(
-        self, monkeypatch
-    ):
-        monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "foo.com")
-        assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
+def test_raises_with_helpful_message_if_no_token_present(mocker):
+    mock_helpful_message = mocker.patch("pythonanywhere_core.base.helpful_token_error_message")
+    mock_helpful_message.return_value = "I'm so helpful"
 
+    with pytest.raises(NoTokenError) as exc:
+        call_api("blah", "get")
 
-class TestCallAPI:
-    def test_raises_on_401(self, api_token, api_responses):
-        url = "https://foo.com/"
-        api_responses.add(responses.POST, url, status=401, body="nope")
-        with pytest.raises(AuthenticationError) as e:
-            call_api(url, "post")
-        assert str(e.value) == "Authentication error 401 calling API: nope"
+    assert str(exc.value) == "I'm so helpful"
 
-    def test_passes_verify_from_environment(self, api_token, monkeypatch, mock_requests):
-        monkeypatch.setenv("PYTHONANYWHERE_INSECURE_API", "true")
 
-        call_api("url", "post", foo="bar")
+def test_helpful_message_inside_pythonanywhere(monkeypatch):
+    monkeypatch.setenv("PYTHONANYWHERE_SITE", "www.foo.com")
 
-        args, kwargs = mock_requests.request.call_args
-        assert kwargs["verify"] is False
+    assert "Oops, you don't seem to have an API token." in helpful_token_error_message()
 
-    def test_verify_is_true_if_env_not_set(self, api_token, mock_requests):
-        call_api("url", "post", foo="bar")
 
-        args, kwargs = mock_requests.request.call_args
-        assert kwargs["verify"] is True
+def test_helpful_message_outside_pythonanywhere():
+    assert "Oops, you don't seem to have an API_TOKEN environment variable set." in helpful_token_error_message()