Changed interface of base.get_api_endpoint so it receives username and flavor, and returns interpolated string, by Filip, Piotr

Author: caseneuve

pythonanywhere_core/base.py

@@ -15,12 +15,12 @@
 }
 
 
-def get_api_endpoint() -> str:
+def get_api_endpoint(username: str, flavor: str) -> str:
     hostname = os.environ.get(
         "PYTHONANYWHERE_SITE",
         "www." + os.environ.get("PYTHONANYWHERE_DOMAIN", "pythonanywhere.com"),
     )
-    return f"https://{hostname}/api/v0/user/{{username}}/{{flavor}}/"
+    return f"https://{hostname}/api/v0/user/{username}/{flavor}/"
 
 
 def helpful_token_error_message() -> str:

pythonanywhere_core/files.py

@@ -41,7 +41,7 @@ class Files:
     subdirectories of a directory at `path` (limited to 1000 results)
     """
 
-    base_url = get_api_endpoint().format(username=getpass.getuser(), flavor="files")
+    base_url = get_api_endpoint(username=getpass.getuser(), flavor="files")
     path_endpoint = urljoin(base_url, "path")
     sharing_endpoint = urljoin(base_url, "sharing/")
     tree_endpoint = urljoin(base_url, "tree/")
@@ -176,4 +176,4 @@ def tree_get(self, path: str) -> dict:
         if result.ok:
             return result.json()
 
-        raise PythonAnywhereApiException(f"GET to {url} failed, got {result}{self._error_msg(result)}")
+        raise PythonAnywhereApiException(f"GET to {url} failed, got {result}{self._error_msg(result)}")

pythonanywhere_core/schedule.py

@@ -22,7 +22,7 @@ class Schedule:
     Use :method: `Schedule.delete` to delete existing task.
     Use :method: `Schedule.update` to update existing task."""
 
-    base_url: str = get_api_endpoint().format(username=getpass.getuser(), flavor="schedule")
+    base_url: str = get_api_endpoint(username=getpass.getuser(), flavor="schedule")
 
     def create(self, params: dict) -> Optional[dict]:
         """Creates new scheduled task using `params`.

pythonanywhere_core/students.py

@@ -21,7 +21,7 @@ class StudentsAPI:
     - use :method: `StudentsAPI.delete` to remove a student
     """
 
-    base_url: str = get_api_endpoint().format(username=getpass.getuser(), flavor="students")
+    base_url: str = get_api_endpoint(username=getpass.getuser(), flavor="students")
 
     def get(self) -> Optional[dict]:
         """Returns list of PythonAnywhere students related with user's account."""

pythonanywhere_core/webapp.py

@@ -28,10 +28,9 @@ class Webapp:
 
     """
     def __init__(self, domain: str) -> None:
-        self.endpoint = get_api_endpoint()
         self.username = getpass.getuser()
-        self.files_url = self.endpoint.format(username=self.username, flavor="files")
-        self.webapps_url = self.endpoint.format(username=self.username, flavor="webapps")
+        self.files_url = get_api_endpoint(username=self.username, flavor="files")
+        self.webapps_url = get_api_endpoint(username=self.username, flavor="webapps")
         self.domain = domain
         self.domain_url = f"{self.webapps_url}{self.domain}/"
 

tests/test_base.py

@@ -14,21 +14,31 @@ def mock_requests(mocker):
     return mocker.patch("pythonanywhere_core.base.requests")
 
 
-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_get_api_endpoint_defaults_to_pythonanywhere_dot_com_if_no_environment_variables():
+    result = get_api_endpoint(username="bill", flavor="webapp")
 
+    assert result == "https://www.pythonanywhere.com/api/v0/user/bill/webapp/"
 
-def test_gets_domain_from_pythonanywhere_site_and_ignores_pythonanywhere_domain_if_both_set(monkeypatch):
+
+def test_get_api_endpoint_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}/"
+    result = get_api_endpoint(username="bill", flavor="webapp")
+
+    assert result == "https://www.foo.com/api/v0/user/bill/webapp/"
 
 
-def test_gets_domain_from_pythonanywhere_domain_and_adds_on_www_if_set_but_no_pythonanywhere_site(monkeypatch):
+def test_get_api_endpoint_gets_domain_from_pythonanywhere_domain_and_adds_on_www_if_set_but_pythonanywhere_site_is_not(
+        monkeypatch
+):
     monkeypatch.setenv("PYTHONANYWHERE_DOMAIN", "foo.com")
 
-    assert get_api_endpoint() == "https://www.foo.com/api/v0/user/{username}/{flavor}/"
+    result = get_api_endpoint(username="bill", flavor="webapp")
+
+    assert result == "https://www.foo.com/api/v0/user/bill/webapp/"
 
 
 def test_raises_on_401(api_token, api_responses):

tests/test_files.py

@@ -17,7 +17,7 @@ def username():
 
 @pytest.fixture()
 def base_url(username):
-    return get_api_endpoint().format(username=username, flavor="files")
+    return get_api_endpoint(username=username, flavor="files")
 
 
 @pytest.fixture()
@@ -295,7 +295,7 @@ def test_sharing_post_raises_exception_when_path_not_provided(
         "provided path is not valid"  # or similar
     )
     assert str(e.value) == expected_error_msg
-    
+
 
 def test_sharing_get_returns_sharing_url_when_path_is_shared(
         api_token, api_responses, base_url, home_dir_path, username
@@ -325,7 +325,7 @@ def test_sharing_get_returns_empty_string_when_path_not_shared(
     api_responses.add(method=responses.GET, url=url, status=404)
 
     assert Files().sharing_get(valid_path) == ""
-    
+
 
 def test_returns_204_on_sucessful_unshare(
         api_token, api_responses, base_url, home_dir_path, username
@@ -336,7 +336,7 @@ def test_returns_204_on_sucessful_unshare(
     api_responses.add(method=responses.DELETE, url=url, status=204)
 
     assert Files().sharing_delete(valid_path) == 204
-    
+
 
 def test_returns_list_of_the_regular_files_and_subdirectories_of_a_directory(
         api_token, api_responses, base_url, default_home_dir_files, home_dir_path

tests/test_schedule.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def task_base_url():
-    return get_api_endpoint().format(username=getpass.getuser(), flavor="schedule")
+    return get_api_endpoint(username=getpass.getuser(), flavor="schedule")
 
 
 @pytest.fixture

tests/test_students.py

@@ -10,7 +10,7 @@
 
 @pytest.fixture
 def students_base_url():
-    return get_api_endpoint().format(username=getpass.getuser(), flavor="students")
+    return get_api_endpoint(username=getpass.getuser(), flavor="students")
 
 
 class TestStudentsAPIGet:

tests/test_webapp.py

@@ -14,7 +14,7 @@
 
 @pytest.fixture
 def base_url():
-    return get_api_endpoint().format(username=getpass.getuser(), flavor="webapps")
+    return get_api_endpoint(username=getpass.getuser(), flavor="webapps")
 
 
 @pytest.fixture
@@ -24,7 +24,7 @@ def domain():
 
 @pytest.fixture()
 def base_file_url():
-    return get_api_endpoint().format(username=getpass.getuser(), flavor='files')
+    return get_api_endpoint(username=getpass.getuser(), flavor='files')
 
 
 @pytest.fixture