Adds method to list webapps.

Author: filiplajszczak

pythonanywhere_core/webapp.py

@@ -21,16 +21,21 @@ class Webapp:
 
     Methods:
         - :meth:`Webapp.create`: Create a new webapp.
+        - :meth:`Webapp.create_static_file_mapping`: Create a static file mapping.
         - :meth:`Webapp.reload`: Reload the webapp.
         - :meth:`Webapp.set_ssl`: Set the SSL certificate and private key.
         - :meth:`Webapp.get_ssl_info`: Retrieve SSL certificate information.
         - :meth:`Webapp.delete_log`: Delete a log file.
         - :meth:`Webapp.get_log_info`: Retrieve log file information.
+
+    Class Methods:
+        - :meth:`Webapp.list_webapps`: List all webapps for the current user.
     """
+    username = getpass.getuser()
+    files_url = get_api_endpoint(username=username, flavor="files")
+    webapps_url = get_api_endpoint(username=username, flavor="webapps")
+
     def __init__(self, domain: str) -> None:
-        self.username = getpass.getuser()
-        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}/"
 
@@ -215,3 +220,14 @@ def get_log_info(self) -> dict:
                         continue
                     logs[log_type].append(log_index)
         return logs
+
+    @classmethod
+    def list_webapps(cls) -> list:
+        """List all webapps for the current user.
+
+        :returns: list of webapps info as dictionaries
+        """
+        response = call_api(cls.webapps_url, "get")
+        if not response.ok:
+            raise PythonAnywhereApiException(f"GET webapps via API failed, got {response}:{response.text}")
+        return response.json()

tests/test_webapp.py

@@ -447,3 +447,34 @@ def test_raises_if_get_does_not_20x(api_responses, api_token, base_file_url, web
 
     assert "GET log files info via API failed" in str(e.value)
     assert "nope" in str(e.value)
+
+
+def test_list_webapps_returns_list(api_responses, api_token, base_url):
+    # Simulate API response for listing webapps
+    webapps_data = [
+        {"id": 1, "domain_name": "www.domain1.com"},
+        {"id": 2, "domain_name": "www.domain2.com"},
+    ]
+    api_responses.add(
+        responses.GET,
+        base_url,
+        status=200,
+        body=json.dumps(webapps_data),
+    )
+    result = Webapp.list_webapps()
+    assert isinstance(result, list)
+    assert result == webapps_data
+
+
+def test_list_webapps_raises_on_error(api_responses, api_token, base_url):
+    api_responses.add(
+        responses.GET,
+        base_url,
+        status=500,
+        body="server error",
+    )
+    with pytest.raises(PythonAnywhereApiException) as e:
+        Webapp.list_webapps()
+    assert "GET webapps via API failed" in str(e.value)
+    assert "server error" in str(e.value)
+