pythonanywhere-core 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

pythonanywhere_core/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.1"
+__version__ = "0.3.3"

pythonanywhere_core/base.py

@@ -96,6 +96,5 @@ def call_api(url: str, method: str, **kwargs) -> requests.Response:
         **kwargs,
     )
     if response.status_code == 401:
-        print(response, response.text)
         raise AuthenticationError(f"Authentication error {response.status_code} calling API: {response.text}")
     return response

pythonanywhere_core/files.py

@@ -117,15 +117,16 @@ class Files:
         """Starts sharing a file at `path`.
 
         Returns a tuple with a message and sharing link on
-        success, raises otherwise.  Message is "successfully shared" on success,
-        "was already shared" if file has been already shared."""
+        HTTP 200/201, raises otherwise. Message is "successfully shared" on 201,
+        "was already shared" on 200."""
 
         url = self.sharing_endpoint
 
         result = call_api(url, "POST", json={"path": path})
 
-        if result.ok:
-            msg = {200: "was already shared", 201: "successfully shared"}[result.status_code]
+        messages = {200: "was already shared", 201: "successfully shared"}
+        if result.status_code in messages:
+            msg = messages[result.status_code]
             sharing_url_suffix = result.json()["url"]
             return msg, self._make_sharing_url(sharing_url_suffix)
 
@@ -137,7 +138,7 @@ class Files:
         """Checks sharing status for a `path`.
 
         Returns url with sharing link if file is shared or an empty
-        string otherwise."""
+        string on HTTP 404 (not shared). Raises on other API errors."""
 
         url = f"{self.sharing_endpoint}?path={path}"
 
@@ -145,9 +146,13 @@ class Files:
         if result.ok:
             sharing_url_suffix = result.json()["url"]
             return self._make_sharing_url(sharing_url_suffix)
-        else:
+        if result.status_code == 404:
             return ""
 
+        raise PythonAnywhereApiException(
+            f"GET sharing status for {url} failed, got {result}{self._error_msg(result)}"
+        )
+
     def sharing_delete(self, path: str) -> int:
         """Stops sharing file at `path`.
 

pythonanywhere_core/schedule.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import List
 
 from typing_extensions import Literal
 
@@ -29,30 +29,31 @@ class Schedule:
 
     base_url: str = get_api_endpoint(username=get_username(), flavor="schedule")
 
-    def create(self, params: dict) -> Optional[dict]:
+    def create(self, params: dict) -> dict:
         """Creates new scheduled task using `params`.
 
         Params should be: command, enabled (True or False), interval (daily or
         hourly), hour (24h format) and minute.
 
         :param params: dictionary with required scheduled task specs
-        :returns: dictionary with created task specs"""
+        :returns: dictionary with created task specs on HTTP 201
+        :raises PythonAnywhereApiException: if the response is not HTTP 201"""
 
         result = call_api(self.base_url, "POST", json=params)
 
         if result.status_code == 201:
             return result.json()
 
-        if not result.ok:
-            raise PythonAnywhereApiException(
-                f"POST to set new task via API failed, got {result}: {result.text}"
-            )
+        raise PythonAnywhereApiException(
+            f"POST to set new task via API failed, got {result}: {result.text}"
+        )
 
     def delete(self, task_id: int) -> Literal[True]:
         """Deletes scheduled task by id.
 
         :param task_id: scheduled task to be deleted id number
-        :returns: True when API response is 204"""
+        :returns: True when API response is 204
+        :raises PythonAnywhereApiException: if the response is not HTTP 204"""
 
         result = call_api(
             f"{self.base_url}{task_id}/", "DELETE"
@@ -61,17 +62,22 @@ class Schedule:
         if result.status_code == 204:
             return True
 
-        if not result.ok:
-            raise PythonAnywhereApiException(
-                f"DELETE via API on task {task_id} failed, got {result}: {result.text}"
-            )
+        raise PythonAnywhereApiException(
+            f"DELETE via API on task {task_id} failed, got {result}: {result.text}"
+        )
 
     def get_list(self) -> List[dict]:
         """Gets list of existing scheduled tasks.
 
-        :returns: list of existing scheduled tasks specs"""
+        :returns: list of existing scheduled tasks specs on HTTP 200
+        :raises PythonAnywhereApiException: if the response is not HTTP 200"""
 
-        return call_api(self.base_url, "GET").json()
+        result = call_api(self.base_url, "GET")
+        if result.status_code != 200:
+            raise PythonAnywhereApiException(
+                f"GET scheduled tasks via API failed, got {result}: {result.text}"
+            )
+        return result.json()
 
     def get_specs(self, task_id: int) -> dict:
         """Get task specs by id.

pythonanywhere_core/webapp.py

@@ -51,6 +51,7 @@ class Webapp:
         :param nuke: if True, skip the check for existing webapp
 
         :raises SanityException: if API token is missing or webapp already exists
+        :raises PythonAnywhereApiException: if the existence check returns neither 200 nor 404
         """
         token = os.environ.get("API_TOKEN")
         if not token:
@@ -73,18 +74,28 @@ class Webapp:
                 f"You already have a webapp for {self.domain}.\n\nUse the --nuke option if you want to replace it."
             )
 
+        if response.status_code != 404:
+            raise PythonAnywhereApiException(
+                f"GET to check webapp existence via API failed, got {response}:{response.text}"
+            )
+
     def create(self, python_version: str, virtualenv_path: Path | None, project_path: Path, nuke: bool) -> None:
         """Create a webapp for the given domain, using the given python version and virtualenv path
 
         :param python_version:  python version to use
         :param virtualenv_path: path to the virtualenv, or None to skip setting it
         :param project_path: path to the project
-        :param nuke: if True, delete any existing webapp for this domain
+        :param nuke: if True, delete any existing webapp for this domain;
+            continue only on HTTP 204 (deleted) or 404 (absent)
 
         :raises PythonAnywhereApiException: if API call fails
         """
         if nuke:
-            call_api(self.domain_url, "delete")
+            response = call_api(self.domain_url, "delete")
+            if response.status_code not in (204, 404):
+                raise PythonAnywhereApiException(
+                    f"DELETE before replacing webapp via API failed, got {response}:{response.text}"
+                )
         response = call_api(
             self.webapps_url,
             "post",
@@ -106,10 +117,14 @@ class Webapp:
         :param url_path: URL path (e.g., '/static/')
         :param directory_path: Filesystem path to serve (as Path)
 
-        :raises PythonAnywhereApiException: if API call fails
+        :raises PythonAnywhereApiException: if the response is not HTTP 201
         """
         url = f"{self.domain_url}static_files/"
-        call_api(url, "post", json=dict(url=url_path, path=str(directory_path)))
+        response = call_api(url, "post", json=dict(url=url_path, path=str(directory_path)))
+        if response.status_code != 201:
+            raise PythonAnywhereApiException(
+                f"POST to create static file mapping via API failed, got {response}:{response.text}"
+            )
 
     def add_default_static_files_mappings(self, project_path: Path) -> None:
         """Add default static files mappings for /static/ and /media/.

pythonanywhere_core/website.py

@@ -52,33 +52,48 @@ class Website:
     def get(self, domain_name: str) -> dict:
         """Returns dictionary with website info for ``domain_name``.
         :param domain_name:
-        :return: dictionary with website info"""
+        :return: dictionary with website info on HTTP 200
+        :raises PythonAnywhereApiException: if the response is not HTTP 200"""
 
         response = call_api(
             f"{self.websites_base_url}{domain_name}/",
             "get",
         )
+        if response.status_code != 200:
+            raise PythonAnywhereApiException(
+                f"GET website via API failed, got {response}:{response.text}"
+            )
         return response.json()
 
     def list(self) -> list:
         """Returns list of dictionaries with all websites info.
-        :return: list of dictionaries with websites info"""
+        :return: list of dictionaries with websites info on HTTP 200
+        :raises PythonAnywhereApiException: if the response is not HTTP 200"""
 
         response = call_api(
             self.websites_base_url,
             "get",
         )
+        if response.status_code != 200:
+            raise PythonAnywhereApiException(
+                f"GET websites via API failed, got {response}:{response.text}"
+            )
         return response.json()
 
     def reload(self, domain_name: str) -> dict:
         """Reloads website with ``domain_name``.
         :param domain_name: domain name for website to reload
-        :return: dictionary with response"""
+        :return: dictionary with response on HTTP 200
+        :raises PythonAnywhereApiException: if the response is not HTTP 200"""
 
         response = call_api(
             f"{self.websites_base_url}{domain_name}/reload/",
             "post",
         )
+        if response.status_code != 200:
+            raise PythonAnywhereApiException(
+                f"POST to reload website via API failed, got {response}:{response.text}"
+            )
         return response.json()
 
     def auto_ssl(self, domain_name: str) -> dict:
@@ -110,10 +125,15 @@ class Website:
     def delete(self, domain_name: str) -> dict:
         """Deletes website with ``domain_name``.
         :param domain_name: domain name for website to delete
-        :return: empty dictionary"""
+        :return: empty dictionary on HTTP 204
+        :raises PythonAnywhereApiException: if the response is not HTTP 204"""
 
-        call_api(
+        response = call_api(
             f"{self.websites_base_url}{domain_name}/",
             "delete",
         )
+        if response.status_code != 204:
+            raise PythonAnywhereApiException(
+                f"DELETE website via API failed, got {response}:{response.text}"
+            )
         return {}

{pythonanywhere_core-0.3.1.dist-info → pythonanywhere_core-0.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonanywhere-core
-Version: 0.3.1
+Version: 0.3.3
 Summary: API wrapper for programmatic management of PythonAnywhere services.
 License: MIT
 License-File: LICENSE

pythonanywhere_core-0.3.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+pythonanywhere_core/__init__.py,sha256=8KcCYTXH99C2-gCLuPILJvtT9YftRWJsartIx6TQ2ZY,22
+pythonanywhere_core/base.py,sha256=nyyX53D0O5o_1a9rHhJDHUM24wlCr0SS544ZZbXbOYw,3415
+pythonanywhere_core/exceptions.py,sha256=37aZy6txVFuiXfUdRJA5d7NQ1N5vbkdOveqv8rwnDbk,691
+pythonanywhere_core/files.py,sha256=vksw1ZEPvCn9Hv1YrRhc1fea72cuzUzzeyr67u9CvKM,7765
+pythonanywhere_core/resources.py,sha256=VBXspr1sGhfAVSFoTQtwpeN5CDG9-wHZwXJ3-5vy7dY,1167
+pythonanywhere_core/schedule.py,sha256=9YHKvSql9p6VtLGLn7IqXzmdtg2U9ZG287hAcv8Je5g,4261
+pythonanywhere_core/students.py,sha256=VfdftRrwPFEb-m2LW7pbiS9LiffwFNTfHpVeLXMQLLc,1774
+pythonanywhere_core/webapp.py,sha256=dniwSCxogsKuqHI25TyVpk5vTxusrqgJjR4coaq9CYE,12126
+pythonanywhere_core/website.py,sha256=yAosA61uQ7dEIsqX5qUFzNZflWDevMiS25FzNfXeArc,5625
+pythonanywhere_core-0.3.3.dist-info/METADATA,sha256=Wd3dJ_-lZlurXDit_oMnvIr2xUM-nXM-DO_4hWaqNeM,1931
+pythonanywhere_core-0.3.3.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+pythonanywhere_core-0.3.3.dist-info/licenses/LICENSE,sha256=zOJT_E5Fv8crFEKS5ulv0btbjnUiIkdsEBPEBmLHRlQ,1080
+pythonanywhere_core-0.3.3.dist-info/RECORD,,

pythonanywhere_core-0.3.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-pythonanywhere_core/__init__.py,sha256=r4xAFihOf72W9TD-lpMi6ntWSTKTP2SlzKP1ytkjRbI,22
-pythonanywhere_core/base.py,sha256=l4GiEa-oe-EyAc_knX9kqmzQsPEIAH3ec1CivkWeK3Q,3454
-pythonanywhere_core/exceptions.py,sha256=37aZy6txVFuiXfUdRJA5d7NQ1N5vbkdOveqv8rwnDbk,691
-pythonanywhere_core/files.py,sha256=XjOsxei_tDgrubUVMmH4iYgc4sTmoFNk5EtZMJR3-0Q,7531
-pythonanywhere_core/resources.py,sha256=VBXspr1sGhfAVSFoTQtwpeN5CDG9-wHZwXJ3-5vy7dY,1167
-pythonanywhere_core/schedule.py,sha256=payqSYJf92gQzsZwVBtccXH4m_C--AAbdbf5DOtImhs,3900
-pythonanywhere_core/students.py,sha256=VfdftRrwPFEb-m2LW7pbiS9LiffwFNTfHpVeLXMQLLc,1774
-pythonanywhere_core/webapp.py,sha256=inwCDOHY_7IVQXJTeAxucn5vYPpJNdn-JLM3ji5gHwQ,11308
-pythonanywhere_core/website.py,sha256=RnMf97CjfLnDF2aFiH_EJcuChBrGhZ7DMErWkpmXqHM,4535
-pythonanywhere_core-0.3.1.dist-info/METADATA,sha256=wsbVvuF57oHtgGdHNuQM01HgX9GCgfM3B4i0Dvt0c2Y,1931
-pythonanywhere_core-0.3.1.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
-pythonanywhere_core-0.3.1.dist-info/licenses/LICENSE,sha256=zOJT_E5Fv8crFEKS5ulv0btbjnUiIkdsEBPEBmLHRlQ,1080
-pythonanywhere_core-0.3.1.dist-info/RECORD,,