python-anvil 2.0.0__tar.gz → 3.0.1__tar.gz

{python_anvil-2.0.0 → python_anvil-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-anvil
-Version: 2.0.0
+Version: 3.0.1
 Summary: Anvil API
 Home-page: https://www.useanvil.com/
 License: MIT
@@ -18,17 +18,15 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: click (>=8.0,<9.0)
+Requires-Dist: gql[requests] (==3.5.0b1)
 Requires-Dist: pydantic (>=1.8.2,<2.0.0)
 Requires-Dist: ratelimit (>=2.2.1,<3.0.0)
 Requires-Dist: requests (>=2.25.0,<3.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: urllib3 (<2)
 Project-URL: Documentation, https://github.com/anvilco/python-anvil
 Project-URL: Repository, https://github.com/anvilco/python-anvil
 Description-Content-Type: text/markdown
@@ -61,7 +59,7 @@ General API documentation: [Anvil API docs](https://www.useanvil.com/docs)
 
 ## Requirements
 
-* Python 3.6.2+
+* Python 3.7.2+
 
 ## Installation
 

{python_anvil-2.0.0 → python_anvil-3.0.1}/README.md

@@ -26,7 +26,7 @@ General API documentation: [Anvil API docs](https://www.useanvil.com/docs)
 
 ## Requirements
 
-* Python 3.6.2+
+* Python 3.7.2+
 
 ## Installation
 

{python_anvil-2.0.0 → python_anvil-3.0.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "python_anvil"
-version = "2.0.0"
+version = "3.0.1"
 description = "Anvil API"
 license = "MIT"
 authors = ["Anvil Foundry Inc. <developers@useanvil.com>"]
@@ -34,13 +34,19 @@ classifiers = [
 
 python = ">=3.7.2,<3.12"
 
+# urllib must be pinned to <2 due to an issue with the `requests_toolbelt`
+# dependency in `gql`.
+# Similar: https://github.com/apache/arrow/commit/4295e3dd06f9f507f75ccc780eaca16a6b621a02
+urllib3 = "<2"
+
 click = "^8.0"
 requests = "^2.25.0"
 ratelimit = "^2.2.1"
 tabulate = "^0.9.0"
 pydantic = "^1.8.2"
+gql = {version = "3.5.0b1", extras = ["requests"]}
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 
 # Formatters
 black = "=22.12.0"
@@ -48,30 +54,28 @@ isort = "^5.11.4"
 
 # Linters
 mypy = "*"
-pydocstyle = "6.2.3"
-pylint = "2.15.10"
+pydocstyle = "^6.3.0"
+pylint = "^2.16.2"
 
 # Testing
-pytest = "^7.2.0"
-pytest-cov = "*"
+pytest = "^7.2.1"
+pytest-cov = "^4.0.0"
 pytest-describe = "^2.0"
-pytest-random = "*"
+pytest-random = "^0.2"
 freezegun = "*"
 
 # Reports
 coveragespace = "*"
 
 # Documentation
-mkdocs = "1.4.2"
-pygments = "^2.5.2"
+mkdocs = "^1.4.2"
+pygments = "^2.14.0"
 
 # Tooling
-pyinstaller = "^5.7.0"
+pyinstaller = "^5.8.0"
 sniffer = "*"
 MacFSEvents = { version = "*", platform = "darwin" }
 pync = { version = "*", platform = "darwin" }
-# Updating `ipython` to 8.0+ will require a minimum Python of >=3.8
-ipython = "^7.12.0"
 pyinotify = {version = "^0.9.6", optional = true}
 tox = "^3.21.2"
 pre-commit = "^2.21.0"

{python_anvil-2.0.0 → python_anvil-3.0.1}/python_anvil/api.py

@@ -1,4 +1,6 @@
-from logging import getLogger
+import logging
+from gql import gql
+from graphql import DocumentNode
 from typing import Any, AnyStr, Callable, Dict, List, Optional, Text, Tuple, Union
 
 from .api_resources.mutations import (
@@ -13,12 +15,11 @@ from .api_resources.payload import (
     ForgeSubmitPayload,
     GeneratePDFPayload,
 )
-from .api_resources.requests import GraphqlRequest, PlainRequest, RestRequest
-from .http import HTTPClient
-from .multipart_helpers import get_multipart_payload
+from .api_resources.requests import PlainRequest, RestRequest
+from .http import GQLClient, HTTPClient
 
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def _get_return(res: Dict, get_data: Callable[[Dict], Union[Dict, List]]):
@@ -47,39 +48,70 @@ class Anvil:
     # This is the default when a version is not provided.
     VERSION_LATEST_PUBLISHED = -2
 
-    def __init__(self, api_key=None, environment='dev'):
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        environment="dev",
+        endpoint_url=None,
+    ):
+        if not api_key:
+            raise ValueError('`api_key` must be a valid string')
+
         self.client = HTTPClient(api_key=api_key, environment=environment)
+        self.gql_client = GQLClient.get_client(
+            api_key=api_key,
+            environment=environment,
+            endpoint_url=endpoint_url,
+        )
 
     def query(
         self,
-        query: str,
-        variables: Union[Optional[Text], Dict[Text, Any]] = None,
+        query: Union[str, DocumentNode],
+        variables: Optional[Dict[str, Any]] = None,
         **kwargs,
     ):
-        gql = GraphqlRequest(client=self.client)
-        return gql.post(query, variables=variables, **kwargs)
+        """Execute a GraphQL query.
+
+        :param query:
+        :type query: Union[str, DocumentNode]
+        :param variables:
+        :type variables: Optional[Dict[str, Any]]
+        :param kwargs:
+        :return:
+        """
+        # Remove `debug` for now.
+        kwargs.pop("debug", None)
+        if isinstance(query, str):
+            query = gql(query)
 
-    def mutate(self, query: BaseQuery, variables: dict, **kwargs):
-        gql = GraphqlRequest(client=self.client)
-        return gql.post(query.get_mutation(), variables, **kwargs)
+        return self.gql_client.execute(query, variable_values=variables, **kwargs)
 
-    def mutate_multipart(self, files: Dict, **kwargs):
+    def mutate(
+        self, query: Union[str, BaseQuery], variables: Dict[str, Any], **kwargs
+    ) -> Dict[str, Any]:
         """
-        Multipart version of `mutate`.
+        Execute a GraphQL mutation.
 
-        This will send a mutation based on the multipart spec defined here:
+        NOTE: Any files attached provided in `variables` will be sent via the
+        multipart spec:
         https://github.com/jaydenseric/graphql-multipart-request-spec
 
-        Note that `variables` and `query` have been removed and replaced with
-        `files`. The entire GraphQL payload should already be prepared as a
-        `dict` beforehand.
-
-        :param files:
+        :param query:
+        :type query: Union[str, BaseQuery]
+        :param variables:
+        :type variables: Dict[str, Any]
         :param kwargs:
         :return:
         """
-        gql = GraphqlRequest(client=self.client)
-        return gql.post_multipart(files=files, **kwargs)
+        # Remove `debug` for now.
+        kwargs.pop("debug", None)
+        if isinstance(query, str):
+            use_query = gql(query)
+        else:
+            mutation = query.get_mutation()
+            use_query = gql(mutation)
+
+        return self.gql_client.execute(use_query, variable_values=variables, **kwargs)
 
     def request_rest(self, options: Optional[dict] = None):
         api = RestRequest(self.client, options=options)
@@ -180,20 +212,34 @@ class Anvil:
             arg_str = f"({','.join(joined_args)})"
 
         res = self.query(
-            f"""{{
+            gql(
+                f"""{{
               cast {arg_str} {{
                 {" ".join(fields)}
               }}
-            }}""",
+            }}"""
+            ),
             **kwargs,
         )
 
-        def get_data(r) -> Dict[str, Any]:
-            return r["data"]["cast"]
+        def get_data(r: dict) -> Dict[str, Any]:
+            return r["cast"]
 
         return _get_return(res, get_data=get_data)
 
-    def get_casts(self, fields=None, show_all=False, **kwargs) -> List[Dict[str, Any]]:
+    def get_casts(
+        self, fields: Optional[List[str]] = None, show_all: bool = False, **kwargs
+    ) -> List[Dict[str, Any]]:
+        """Retrieve all Cast objects for the current user across all organizations.
+
+        :param fields: List of fields to retrieve for each cast object
+        :type fields: Optional[List[str]]
+        :param show_all: Boolean to show all Cast objects.
+            Defaults to showing only templates.
+        :type show_all: bool
+        :param kwargs:
+        :return:
+        """
         if not fields:
             # Use default fields
             fields = ["eid", "title", "fieldInfo"]
@@ -201,7 +247,8 @@ class Anvil:
         cast_args = "" if show_all else "(isTemplate: true)"
 
         res = self.query(
-            f"""{{
+            gql(
+                f"""{{
               currentUser {{
                 organizations {{
                   casts {cast_args} {{
@@ -209,19 +256,26 @@ class Anvil:
                   }}
                 }}
               }}
-            }}""",
+            }}"""
+            ),
             **kwargs,
         )
 
-        def get_data(r):
-            orgs = r["data"]["currentUser"]["organizations"]
+        def get_data(r: dict):
+            orgs = r["currentUser"]["organizations"]
             return [item for org in orgs for item in org["casts"]]
 
         return _get_return(res, get_data=get_data)
 
     def get_current_user(self, **kwargs):
+        """Retrieve current user data.
+
+        :param kwargs:
+        :return:
+        """
         res = self.query(
-            """{
+            gql(
+                """{
               currentUser {
                 name
                 email
@@ -237,22 +291,23 @@ class Anvil:
                   }
                 }
               }
-            }
-            """,
+            }"""
+            ),
             **kwargs,
         )
 
-        return _get_return(res, get_data=lambda r: r["data"]["currentUser"])
+        return _get_return(res, get_data=lambda r: r["currentUser"])
 
     def get_welds(self, **kwargs) -> Union[List, Tuple[List, Dict]]:
         res = self.query(
-            """{
+            gql(
+                """{
               currentUser {
                 organizations {
                   welds {
                     eid
                     slug
-                    title
+                    name
                     forges {
                       eid
                       name
@@ -260,19 +315,21 @@ class Anvil:
                   }
                 }
               }
-            }""",
+            }"""
+            ),
             **kwargs,
         )
 
-        def get_data(r):
-            orgs = r["data"]["currentUser"]["organizations"]
+        def get_data(r: dict):
+            orgs = r["currentUser"]["organizations"]
             return [item for org in orgs for item in org["welds"]]
 
         return _get_return(res, get_data=get_data)
 
     def get_weld(self, eid: Text, **kwargs):
         res = self.query(
-            """
+            gql(
+                """
             query WeldQuery(
                 #$organizationSlug: String!,
                 #$slug: String!
@@ -292,13 +349,14 @@ class Anvil:
                         slug
                     }
                 }
-            }""",
+            }"""
+            ),
             variables=dict(eid=eid),
             **kwargs,
         )
 
-        def get_data(r):
-            return r["data"]["weld"]
+        def get_data(r: dict):
+            return r["weld"]
 
         return _get_return(res, get_data=get_data)
 
@@ -337,10 +395,10 @@ class Anvil:
                 "`payload` must be a valid CreateEtchPacket instance or dict"
             )
 
-        files = get_multipart_payload(mutation)
+        payload = mutation.create_payload()
+        variables = payload.dict(by_alias=True, exclude_none=True)
 
-        res = self.mutate_multipart(files, **kwargs)
-        return res
+        return self.mutate(mutation, variables=variables, upload_files=True, **kwargs)
 
     def generate_etch_signing_url(self, signer_eid: str, client_user_id: str, **kwargs):
         """Generate a signing URL for a given user."""
@@ -361,7 +419,7 @@ class Anvil:
         payload: Optional[Union[Dict[Text, Any], ForgeSubmitPayload]] = None,
         json=None,
         **kwargs,
-    ):
+    ) -> Dict[str, Any]:
         """Create a Webform (forge) submission via a graphql mutation."""
         if not any([json, payload]):
             raise TypeError('One of arguments `json` or `payload` are required')

{python_anvil-2.0.0 → python_anvil-3.0.1}/python_anvil/api_resources/mutations/create_etch_packet.py

@@ -1,11 +1,13 @@
 # pylint: disable=too-many-instance-attributes
-from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple, Union
+import logging
+from io import BufferedIOBase
+from logging import Logger
+from mimetypes import guess_type
+from typing import Any, Dict, List, Optional, Union
 
 from python_anvil.api_resources.mutations.base import BaseQuery
 from python_anvil.api_resources.payload import (
     AttachableEtchFile,
-    Base64Upload,
     CreateEtchFilePayload,
     CreateEtchPacketPayload,
     DocumentUpload,
@@ -14,6 +16,8 @@ from python_anvil.api_resources.payload import (
 from python_anvil.utils import create_unique_id
 
 
+logger: Logger = logging.getLogger(__name__)
+
 DEFAULT_RESPONSE_QUERY = """{
   id
   eid
@@ -193,6 +197,18 @@ class CreateEtchPacket(BaseQuery):
         Files will not be uploaded when running this method. They will be
         uploaded when the mutation actually runs.
         """
+        if (
+            isinstance(file, DocumentUpload)
+            and isinstance(file.file, BufferedIOBase)
+            and getattr(file.file, "content_type", None) is None
+        ):
+            # Don't clobber existing `content_type`s provided.
+            content_type, _ = guess_type(file.file.name)  # type: ignore
+            logger.debug(
+                "File did not have a `content_type`, guessing as '%s'", content_type
+            )
+            file.file.content_type = content_type  # type: ignore
+
         self.files.append(file)
 
     def add_file_payloads(self, file_id: str, fill_payload):
@@ -215,43 +231,7 @@ class CreateEtchPacket(BaseQuery):
                 )
         return self.file_payloads
 
-    def get_files_for_payload(self) -> Tuple[List[AttachableEtchFile], List[Any]]:
-        """Scan through and gather files for use in multipart requests.
-
-        During the process, files will be replaced with a dummy `Path`
-        instance as `Callable` instances and likely their returns of some
-        sort of IO reader is not serializable and not easily dealt with in
-        pydantic (the underlying model system for the types used in this
-        library). Closer to the actual request, when the multipart payload is
-        being constructed, the dummy instances will be replaced by their actual
-        file instances.
-
-        :return: Tuple containing a list of uploadable file types, and a list
-            of actual file references
-        :rtype: Tuple[List, List]
-        """
-        contains_uploads = any(  # pylint: disable=use-a-generator
-            [isinstance(f, DocumentUpload) for f in self.files]
-        )
-        if not contains_uploads:
-            return self.files, []
-
-        files = []
-        for f in self.files:
-            if not isinstance(f, DocumentUpload):
-                continue
-
-            if getattr(f.Config, "contains_uploads", False):
-                attr_name = getattr(f.Config, "contains_uploads")
-                upload = getattr(f, attr_name)
-
-                if not isinstance(upload, Base64Upload):
-                    files.append(upload)
-                    setattr(f, attr_name, Path())
-
-        return self.files, files
-
-    def create_payload(self) -> Tuple[CreateEtchPacketPayload, List]:
+    def create_payload(self) -> CreateEtchPacketPayload:
         """Create a payload based on data set on the class instance.
 
         Check `api_resources.payload.CreateEtchPacketPayload` for full payload
@@ -260,19 +240,17 @@ class CreateEtchPacket(BaseQuery):
         """
         # If there's an existing payload instance attribute, just return that.
         if self.payload:
-            return self.payload, []
+            return self.payload
 
         if not self.name:
             raise TypeError("`name` and `signature_email_subject` cannot be None")
 
-        payload_files, file_refs = self.get_files_for_payload()
-
         payload = CreateEtchPacketPayload(
             is_test=self.is_test,
             is_draft=self.is_draft,
             name=self.name,
             signers=self.signers,
-            files=payload_files,
+            files=self.files,
             data=CreateEtchFilePayload(payloads=self.get_file_payloads()),
             signature_email_subject=self.signature_email_subject,
             signature_email_body=self.signature_email_body,
@@ -286,4 +264,4 @@ class CreateEtchPacket(BaseQuery):
             duplicate_casts=self.duplicate_casts,
         )
 
-        return payload, file_refs
+        return payload

{python_anvil-2.0.0 → python_anvil-3.0.1}/python_anvil/api_resources/mutations/forge_submit.py

@@ -47,7 +47,6 @@ mutation ForgeSubmit(
     $timezone: String,
     $groupArrayId: String,
     $groupArrayIndex: Int,
-    $errorType: String,
     $webhookURL: String,
 ) {{
     forgeSubmit (
@@ -61,7 +60,6 @@ mutation ForgeSubmit(
         timezone: $timezone,
         groupArrayId: $groupArrayId,
         groupArrayIndex: $groupArrayIndex,
-        errorType: $errorType,
         webhookURL: $webhookURL
     ) {query}
 }}

{python_anvil-2.0.0 → python_anvil-3.0.1}/python_anvil/api_resources/payload.py

@@ -7,12 +7,11 @@ from io import BufferedIOBase
 # import `BaseModel` and it's not broken, so let's keep it.
 from pydantic import (  # pylint: disable=no-name-in-module
     Field,
-    FilePath,
     HttpUrl,
     root_validator,
     validator,
 )
-from typing import Any, Callable, Dict, List, Optional, Text, Tuple, Union
+from typing import Any, Dict, List, Optional, Text, Union
 
 from .base import BaseModel
 
@@ -184,7 +183,13 @@ class DocumentUpload(BaseModel):
 
     id: str
     title: str
-    file: "UploadableFile"
+    # Previously "UploadableFile", however, that seems to cause weird upload
+    # issues where a PDF file would have its first few bytes removed.
+    # We're now relying on the backend to validate this property instead of on
+    # the client library side.
+    # This might be a bug on the `pydantic` side(?) when this object gets
+    # converted into a dict.
+    file: Any
     fields: List[SignatureField]
     font_size: int = 14
     text_color: str = "#000000"
@@ -192,10 +197,8 @@ class DocumentUpload(BaseModel):
     class Config:
         """Special rules for this model class."""
 
+        # Needed to allow `BufferedIOBase` as an allowed `file` type.
         arbitrary_types_allowed = True
-        # String to help point out the file upload attr.
-        # Used in multipart uploads and should not affect base64-encoded files.
-        contains_uploads = "file"
 
 
 class EtchCastRef(BaseModel):
@@ -271,16 +274,7 @@ class ForgeSubmitPayload(BaseModel):
         return values
 
 
-# Types usable for uploads:
-# Base64Upload: An entire PDF file base64 encoded
-# FilePath: The absolute path of the file. When the pydantic model is used,
-#   it will convert a path string (i.e. "/home/me/my_file.pdf") into a
-#   `pathlib.Path` instance.
-# UploadMethod: A function that returns a tuple of:
-#   * BufferedIOBase instance for use in `requests`
-#   * String containing the name for the file for use in Anvil
-UploadMethod = Callable[[Any], Tuple[BufferedIOBase, str]]
-UploadableFile = Union[Base64Upload, FilePath, UploadMethod]
+UploadableFile = Union[Base64Upload, BufferedIOBase]
 AttachableEtchFile = Union[
     DocumentUpload, EtchCastRef, DocumentMarkup, DocumentMarkdown
 ]

{python_anvil-2.0.0 → python_anvil-3.0.1}/python_anvil/api_resources/requests.py

@@ -34,6 +34,7 @@ class AnvilRequest:
         else:
             message = f"Error: {status_code}: {response} {extra}"
 
+        # pylint: disable=broad-exception-raised
         raise Exception(message)
 
     def process_response(self, response, status_code, headers, **kwargs):
@@ -78,6 +79,12 @@ class BaseAnvilHttpRequest(AnvilRequest):
 
 
 class GraphqlRequest(AnvilRequest):
+    """Create a GraphQL request.
+
+    .. deprecated :: 2.0.0
+       Use `python_anvil.http.GQLClient` to make GraphQL queries and mutations.
+    """
+
     API_HOST = "https://graphql.useanvil.com"
 
     def __init__(self, client: HTTPClient):

{python_anvil-2.0.0 → python_anvil-3.0.1}/python_anvil/cli.py

@@ -102,11 +102,12 @@ def weld(ctx, eid, list_all):
             if debug:
                 click.echo(headers)
 
-        data = [(w["eid"], w.get("slug"), w.get("title"), w.get("forges")) for w in res]
+        data = [(w["eid"], w.get("slug"), w.get("name"), w.get("forges")) for w in res]
         click.echo(tabulate(data, tablefmt="pretty", headers=["eid", "slug", "title"]))
         return
 
     if not eid:
+        # pylint: disable=broad-exception-raised
         raise Exception("You need to pass in a weld eid")
 
     res = anvil.get_weld(eid)

python_anvil-3.0.1/python_anvil/constants.py

@@ -0,0 +1,18 @@
+"""Basic constants used in the library."""
+
+GRAPHQL_ENDPOINT: str = "https://graphql.useanvil.com"
+REST_ENDPOINT = "https://app.useanvil.com/api/v1/"
+
+RETRIES_LIMIT = 5
+REQUESTS_LIMIT = {
+    "dev": {
+        "calls": 2,
+        "seconds": 1,
+    },
+    "prod": {
+        "calls": 40,
+        "seconds": 1,
+    },
+}
+
+RATELIMIT_ENV = "dev"