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

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
-Name: python-anvil
-Version: 3.0.1
+Name: python_anvil
+Version: 5.0.0
 Summary: Anvil API
 Home-page: https://www.useanvil.com/
 License: MIT
 Keywords: anvil,api,pdf,signing
 Author: Anvil Foundry Inc.
 Author-email: developers@useanvil.com
-Requires-Python: >=3.7.2,<3.12
+Requires-Python: >=3.8.0,<3.12
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
@@ -18,15 +18,13 @@ 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.7
 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: gql[requests] (==3.6.0b1)
+Requires-Dist: pydantic (>=2.6.1,<3.0.0)
 Requires-Dist: ratelimit (>=2.2.1,<3.0.0)
-Requires-Dist: requests (>=2.25.0,<3.0.0)
+Requires-Dist: requests (>=2.28.2,<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
@@ -59,7 +57,7 @@ General API documentation: [Anvil API docs](https://www.useanvil.com/docs)
 
 ## Requirements
 
-* Python 3.7.2+
+* Python >=3.8
 
 ## Installation
 

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

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

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

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "python_anvil"
-version = "3.0.1"
+version = "5.0.0"
 description = "Anvil API"
 license = "MIT"
 authors = ["Anvil Foundry Inc. <developers@useanvil.com>"]
@@ -23,28 +23,23 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 
 [tool.poetry.dependencies]
 
-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"
+python = ">=3.8.0,<3.12"
 
 click = "^8.0"
-requests = "^2.25.0"
+requests = "^2.28.2"
 ratelimit = "^2.2.1"
 tabulate = "^0.9.0"
-pydantic = "^1.8.2"
-gql = {version = "3.5.0b1", extras = ["requests"]}
+pydantic = "^2.6.1"
+gql = { version = "3.6.0b1", extras = ["requests"] }
 
 [tool.poetry.group.dev.dependencies]
 
@@ -53,10 +48,18 @@ black = "=22.12.0"
 isort = "^5.11.4"
 
 # Linters
-mypy = "*"
 pydocstyle = "^6.3.0"
 pylint = "^2.16.2"
 
+# FIXME: Upgrading mypy will require updates to aliased fields. e.g.
+#
+# class EtchSigner(BaseModel):
+#     redirect_url: Optional[str] = Field(None, alias="redirectURL")
+#
+# Not sure what the solution is.
+mypy = "1.0.1"
+
+
 # Testing
 pytest = "^7.2.1"
 pytest-cov = "^4.0.0"
@@ -74,7 +77,7 @@ pygments = "^2.14.0"
 # Tooling
 pyinstaller = "^5.8.0"
 sniffer = "*"
-MacFSEvents = { version = "*", platform = "darwin" }
+macfsevents = { version = "^0.8.4", platform = "darwin" }
 pync = { version = "*", platform = "darwin" }
 pyinotify = {version = "^0.9.6", optional = true}
 tox = "^3.21.2"
@@ -90,7 +93,7 @@ anvil = "python_anvil.cli:cli"
 
 [tool.black]
 
-target-version = ["py37", "py38", "py39", "py310"]
+target-version = ["py38", "py39", "py310", "py311"]
 skip-string-normalization = true
 
 [build-system]

{python_anvil-3.0.1 → python_anvil-5.0.0}/python_anvil/__init__.py

@@ -1,9 +1,12 @@
 from pkg_resources import DistributionNotFound, get_distribution
 
 from python_anvil import api, cli
+from python_anvil.models import FileCompatibleBaseModel
 
 
 try:
     __version__ = get_distribution('python_anvil').version
 except DistributionNotFound:
     __version__ = '(local)'
+
+__all__ = ['api', 'cli', 'FileCompatibleBaseModel']

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

@@ -1,7 +1,7 @@
 import logging
 from gql import gql
 from graphql import DocumentNode
-from typing import Any, AnyStr, Callable, Dict, List, Optional, Text, Tuple, Union
+from typing import Any, AnyStr, Callable, Dict, List, Optional, Tuple, Union
 
 from .api_resources.mutations import (
     BaseQuery,
@@ -137,9 +137,7 @@ class Anvil:
             if isinstance(payload, dict):
                 data = FillPDFPayload(**payload)
             elif isinstance(payload, str):
-                data = FillPDFPayload.parse_raw(
-                    payload, content_type="application/json"
-                )
+                data = FillPDFPayload.model_validate_json(payload)
             elif isinstance(payload, FillPDFPayload):
                 data = payload
             else:
@@ -158,7 +156,7 @@ class Anvil:
         api = RestRequest(client=self.client)
         return api.post(
             f"fill/{template_id}.pdf",
-            data.dict(by_alias=True, exclude_none=True) if data else {},
+            data.model_dump(by_alias=True, exclude_none=True) if data else {},
             **kwargs,
         )
 
@@ -169,9 +167,7 @@ class Anvil:
         if isinstance(payload, dict):
             data = GeneratePDFPayload(**payload)
         elif isinstance(payload, str):
-            data = GeneratePDFPayload.parse_raw(
-                payload, content_type="application/json"
-            )
+            data = GeneratePDFPayload.model_validate_json(payload)
         elif isinstance(payload, GeneratePDFPayload):
             data = payload
         else:
@@ -180,7 +176,9 @@ class Anvil:
         # Any data errors would come from here
         api = RestRequest(client=self.client)
         return api.post(
-            "generate-pdf", data=data.dict(by_alias=True, exclude_none=True), **kwargs
+            "generate-pdf",
+            data=data.model_dump(by_alias=True, exclude_none=True),
+            **kwargs,
         )
 
     def get_cast(
@@ -326,7 +324,7 @@ class Anvil:
 
         return _get_return(res, get_data=get_data)
 
-    def get_weld(self, eid: Text, **kwargs):
+    def get_weld(self, eid: str, **kwargs):
         res = self.query(
             gql(
                 """
@@ -380,9 +378,7 @@ class Anvil:
             raise TypeError('One of the arguments `payload` or `json` must exist')
 
         if json:
-            payload = CreateEtchPacketPayload.parse_raw(
-                json, content_type="application/json"
-            )
+            payload = CreateEtchPacketPayload.model_validate_json(json)
 
         if isinstance(payload, dict):
             mutation = CreateEtchPacket.create_from_dict(payload)
@@ -396,7 +392,7 @@ class Anvil:
             )
 
         payload = mutation.create_payload()
-        variables = payload.dict(by_alias=True, exclude_none=True)
+        variables = payload.model_dump(by_alias=True, exclude_none=True)
 
         return self.mutate(mutation, variables=variables, upload_files=True, **kwargs)
 
@@ -407,7 +403,9 @@ class Anvil:
             client_user_id=client_user_id,
         )
         payload = mutation.create_payload()
-        return self.mutate(mutation, variables=payload.dict(by_alias=True), **kwargs)
+        return self.mutate(
+            mutation, variables=payload.model_dump(by_alias=True), **kwargs
+        )
 
     def download_documents(self, document_group_eid: str, **kwargs):
         """Retrieve all completed documents in zip form."""
@@ -416,7 +414,7 @@ class Anvil:
 
     def forge_submit(
         self,
-        payload: Optional[Union[Dict[Text, Any], ForgeSubmitPayload]] = None,
+        payload: Optional[Union[Dict[str, Any], ForgeSubmitPayload]] = None,
         json=None,
         **kwargs,
     ) -> Dict[str, Any]:
@@ -425,9 +423,7 @@ class Anvil:
             raise TypeError('One of arguments `json` or `payload` are required')
 
         if json:
-            payload = ForgeSubmitPayload.parse_raw(
-                json, content_type="application/json"
-            )
+            payload = ForgeSubmitPayload.model_validate_json(json)
 
         if isinstance(payload, dict):
             mutation = ForgeSubmit.create_from_dict(payload)
@@ -440,6 +436,8 @@ class Anvil:
 
         return self.mutate(
             mutation,
-            variables=mutation.create_payload().dict(by_alias=True, exclude_none=True),
+            variables=mutation.create_payload().model_dump(
+                by_alias=True, exclude_none=True
+            ),
             **kwargs,
         )

python_anvil-5.0.0/python_anvil/api_resources/base.py

@@ -0,0 +1,31 @@
+# pylint: disable=no-self-argument
+import re
+
+# Disabling pylint no-name-in-module because this is the documented way to
+# import `BaseModel` and it's not broken, so let's keep it.
+from pydantic import (  # pylint: disable=no-name-in-module
+    BaseModel as _BaseModel,
+    ConfigDict,
+)
+
+
+under_pat = re.compile(r"_([a-z])")
+
+
+def underscore_to_camel(name):
+    ret = under_pat.sub(lambda x: x.group(1).upper(), name)
+    return ret
+
+
+class BaseModel(_BaseModel):
+    """Config override for all models.
+
+    This override is mainly so everything can go from snake to camel-case.
+    """
+
+    # Allow extra fields even if it is not defined. This will allow models
+    # to be more flexible if features are added in the Anvil API, but
+    # explicit support hasn't been added yet to this library.
+    model_config = ConfigDict(
+        alias_generator=underscore_to_camel, populate_by_name=True, extra="allow"
+    )

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

@@ -19,17 +19,14 @@ from python_anvil.utils import create_unique_id
 logger: Logger = logging.getLogger(__name__)
 
 DEFAULT_RESPONSE_QUERY = """{
-  id
   eid
   name
   detailsURL
   documentGroup {
-    id
     eid
     status
     files
     signers {
-      id
       eid
       aliasId
       routingOrder

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

@@ -1,4 +1,4 @@
-from typing import Any, Dict, Optional, Text, Union
+from typing import Any, Dict, Optional, Union
 
 from python_anvil.api_resources.mutations.base import BaseQuery
 from python_anvil.api_resources.mutations.helpers import get_payload_attrs
@@ -7,7 +7,6 @@ from python_anvil.api_resources.payload import ForgeSubmitPayload
 
 DEFAULT_RESPONSE_QUERY = """
 {
-  id
   eid
   status
   resolvedPayload
@@ -22,7 +21,6 @@ DEFAULT_RESPONSE_QUERY = """
     routingOrder
   }
   weldData {
-    id
     eid
     status
     isTest
@@ -72,10 +70,10 @@ class ForgeSubmit(BaseQuery):
 
     def __init__(
         self,
-        payload: Union[Dict[Text, Any], ForgeSubmitPayload],
-        forge_eid: Optional[Text] = None,
-        weld_data_eid: Optional[Text] = None,
-        submission_eid: Optional[Text] = None,
+        payload: Union[Dict[str, Any], ForgeSubmitPayload],
+        forge_eid: Optional[str] = None,
+        weld_data_eid: Optional[str] = None,
+        submission_eid: Optional[str] = None,
         is_test: Optional[bool] = None,
         **kwargs,
     ):
@@ -109,7 +107,7 @@ class ForgeSubmit(BaseQuery):
                 setattr(self, attr, kwargs[attr])
 
     @classmethod
-    def create_from_dict(cls, payload: Dict[Text, Any]):
+    def create_from_dict(cls, payload: Dict[str, Any]):
         # Parse the data through the model class to validate and pass it back
         # as variables in this class.
         return cls(**payload)

python_anvil-5.0.0/python_anvil/api_resources/mutations/helpers.py

@@ -0,0 +1,7 @@
+from typing import List, Type
+
+from python_anvil.api_resources.base import BaseModel
+
+
+def get_payload_attrs(payload_model: Type[BaseModel]) -> List[str]:
+    return list(payload_model.model_fields.keys())

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

@@ -6,12 +6,14 @@ from io import BufferedIOBase
 # Disabling pylint no-name-in-module because this is the documented way to
 # import `BaseModel` and it's not broken, so let's keep it.
 from pydantic import (  # pylint: disable=no-name-in-module
+    ConfigDict,
     Field,
     HttpUrl,
-    root_validator,
-    validator,
+    field_validator,
 )
-from typing import Any, Dict, List, Optional, Text, Union
+from typing import Any, Dict, List, Optional, Union
+
+from python_anvil.models import FileCompatibleBaseModel
 
 from .base import BaseModel
 
@@ -24,8 +26,8 @@ else:
 
 class EmbeddedLogo(BaseModel):
     src: str
-    max_width: Optional[int]
-    max_height: Optional[int]
+    max_width: Optional[int] = None
+    max_height: Optional[int] = None
 
 
 class FillPDFPayload(BaseModel):
@@ -34,7 +36,8 @@ class FillPDFPayload(BaseModel):
     font_size: Optional[int] = None
     text_color: Optional[str] = None
 
-    @validator("data")
+    @field_validator("data")
+    @classmethod
     def data_cannot_be_empty(cls, v):
         if isinstance(v, dict) and len(v) == 0:
             raise ValueError("cannot be empty")
@@ -43,25 +46,13 @@ class FillPDFPayload(BaseModel):
 
 class GeneratePDFPayload(BaseModel):
     data: Union[List[Dict[str, Any]], Dict[Literal["html", "css"], str]]
-    logo: Optional[EmbeddedLogo]
-    title: Optional[str]
+    logo: Optional[EmbeddedLogo] = None
+    title: Optional[str] = None
     type: Optional[Literal["markdown", "html"]] = "markdown"
-
-    @validator("data")
-    def data_must_match_type(cls, v, values):
-        if "type" in values and values["type"] == "html":
-            if "html" not in v:
-                raise ValueError("must contain HTML if using `html` type")
-            if isinstance(v, list):
-                raise ValueError("must contain a data dict not a list")
-        return v
-
-    @validator("type")
-    def type_must_match_data(cls, v, values):
-        if v == "html":
-            if "data" in values and not isinstance(values["data"], dict):
-                raise ValueError("HTML types must used a dict data payload")
-        return v
+    page: Optional[Dict[str, Any]] = None
+    font_size: Optional[int] = None
+    font_family: Optional[str] = None
+    text_color: Optional[str] = None
 
 
 class GenerateEtchSigningURLPayload(BaseModel):
@@ -178,7 +169,7 @@ class DocumentMarkdown(BaseModel):
     text_color: str = "#000000"
 
 
-class DocumentUpload(BaseModel):
+class DocumentUpload(FileCompatibleBaseModel):
     """Dataclass representing an uploaded document."""
 
     id: str
@@ -189,16 +180,14 @@ class DocumentUpload(BaseModel):
     # the client library side.
     # This might be a bug on the `pydantic` side(?) when this object gets
     # converted into a dict.
-    file: Any
+
+    # NOTE: This field name is referenced in the models.py file, if you change it you
+    #   must change the reference
+    file: Any = None
     fields: List[SignatureField]
     font_size: int = 14
     text_color: str = "#000000"
-
-    class Config:
-        """Special rules for this model class."""
-
-        # Needed to allow `BufferedIOBase` as an allowed `file` type.
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
 class EtchCastRef(BaseModel):
@@ -212,7 +201,7 @@ class CreateEtchFilePayload(BaseModel):
     payloads: Union[str, Dict[str, FillPDFPayload]]
 
 
-class CreateEtchPacketPayload(BaseModel):
+class CreateEtchPacketPayload(FileCompatibleBaseModel):
     """
     Payload for createEtchPacket.
 
@@ -222,6 +211,9 @@ class CreateEtchPacketPayload(BaseModel):
 
     name: str
     signers: List[EtchSigner]
+    # NOTE: This is a list of `AttachableEtchFile` objects, but we need to
+    # override the default `FileCompatibleBaseModel` to handle multipart/form-data
+    # uploads correctly. This field name is referenced in the models.py file.
     files: List["AttachableEtchFile"]
     signature_email_subject: Optional[str] = None
     signature_email_body: Optional[str] = None
@@ -246,10 +238,10 @@ class ForgeSubmitPayload(BaseModel):
     https://www.useanvil.com/docs/api/graphql/reference/#operation-forgesubmit-Mutations
     """
 
-    forge_eid: Text
-    payload: Dict[Text, Any]
-    weld_data_eid: Optional[Text] = None
-    submission_eid: Optional[Text] = None
+    forge_eid: str
+    payload: Dict[str, Any]
+    weld_data_eid: Optional[str] = None
+    submission_eid: Optional[str] = None
     # Defaults to True when not provided/is None
     enforce_payload_valid_on_create: Optional[bool] = None
     current_step: Optional[int] = None
@@ -257,22 +249,11 @@ class ForgeSubmitPayload(BaseModel):
     # Note that if using a development API key, this will be forced to `True`
     # even when `False` is used in the payload.
     is_test: Optional[bool] = True
-    timezone: Optional[Text] = None
+    timezone: Optional[str] = None
     webhook_url: Optional[HttpUrl] = Field(None, alias="webhookURL")
-    group_array_id: Optional[Text] = None
+    group_array_id: Optional[str] = None
     group_array_index: Optional[int] = None
 
-    @root_validator
-    def wd_submission_both_required(cls, values):
-        both_required = ["weld_data_eid", "submission_eid"]
-        picked = [k for k in both_required if k in values and values[k] is not None]
-        if len(picked) == 1:
-            raise ValueError(
-                "Both `weld_data_eid` and `submission_eid` are "
-                "required if either are provided."
-            )
-        return values
-
 
 UploadableFile = Union[Base64Upload, BufferedIOBase]
 AttachableEtchFile = Union[
@@ -282,5 +263,5 @@ AttachableEtchFile = Union[
 # Classes below use types wrapped in quotes avoid a circular dependency/weird
 # variable assignment locations with the aliases above. We need to manually
 # update the refs for them to point to the right things.
-DocumentUpload.update_forward_refs()
-CreateEtchPacketPayload.update_forward_refs()
+DocumentUpload.model_rebuild()
+CreateEtchPacketPayload.model_rebuild()

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

@@ -208,7 +208,7 @@ def fill_pdf(ctx, template_id, out_filename, payload_csv):
         with click.progressbar(payloads, label="Filling PDFs and saving") as ps:
             indexed_files = utils.build_batch_filenames(out_filename)
             for payload in ps:
-                res = anvil.fill_pdf(template_id, payload.to_dict(), debug=debug)
+                res = anvil.fill_pdf(template_id, payload.model_dump(), debug=debug)
 
                 if contains_headers(res):
                     res, headers = process_response(res)

{python_anvil-3.0.1 → python_anvil-5.0.0}/python_anvil/http.py

@@ -1,4 +1,6 @@
 import os
+
+# import json
 import requests
 from base64 import b64encode
 from gql import Client
@@ -53,6 +55,15 @@ def get_gql_ds(client: Client) -> DSLSchema:
     return DSLSchema(client.schema)
 
 
+# FIXME: when gql 3.6.0 is stable, we can use this to paper over pre-graphql
+# handler errors. https://github.com/graphql-python/gql/releases/tag/v3.6.0b1
+# def json_deserialize (response_text):
+#   try:
+#       return json.loads(response_text)
+#   except Exception as e:
+#       return {"errors": [{"message": response_text}]}
+
+
 class GQLClient:
     """GraphQL client factory class."""
 
@@ -71,6 +82,8 @@ class GQLClient:
             auth=auth,
             url=endpoint_url,
             verify=True,
+            # FIXME: when gql 3.6.0 is stable... see note above
+            # json_deserialize=json_deserialize,
         )
 
         schema = None

python_anvil-5.0.0/python_anvil/models.py

@@ -0,0 +1,75 @@
+import base64
+import os
+from io import BufferedReader, BytesIO
+from mimetypes import guess_type
+from pydantic import BaseModel, ConfigDict
+
+from python_anvil.api_resources.base import underscore_to_camel
+
+
+class FileCompatibleBaseModel(BaseModel):
+    """
+    Patched model_dump to extract file objects from SerializationIterator.
+
+    Becaus of Pydantic V2. Return as BufferedReader or base64 encoded dict as needed.
+    """
+
+    # Allow extra fields even if it is not defined. This will allow models
+    # to be more flexible if features are added in the Anvil API, but
+    # explicit support hasn't been added yet to this library.
+    model_config = ConfigDict(
+        alias_generator=underscore_to_camel, populate_by_name=True, extra="allow"
+    )
+
+    def _iterator_to_buffered_reader(self, value):
+        content = bytearray()
+        try:
+            while True:
+                content.extend(next(value))
+        except StopIteration:
+            # Create a BytesIO with the content
+            bio = BytesIO(bytes(content))
+            # Create a BufferedReader with the content
+            reader = BufferedReader(bio)  # type: ignore[arg-type]
+            return reader
+
+    def _check_if_serialization_iterator(self, value):
+        return str(type(value).__name__) == 'SerializationIterator' and hasattr(
+            value, '__next__'
+        )
+
+    def _process_file_data(self, file_obj):
+        """Process file object into base64 encoded dict format."""
+        # Read the file data and encode it as base64
+        file_content = file_obj.read()
+
+        # Get filename - handle both regular files and BytesIO objects
+        filename = getattr(file_obj, 'name', "document.pdf")
+
+        if isinstance(filename, (bytes, bytearray)):
+            filename = filename.decode('utf-8')
+
+        # manage mimetype based on file extension
+        mimetype = guess_type(filename)[0] or 'application/pdf'
+
+        return {
+            'data': base64.b64encode(file_content).decode('utf-8'),
+            'mimetype': mimetype,
+            'filename': os.path.basename(filename),
+        }
+
+    def model_dump(self, **kwargs):
+        data = super().model_dump(**kwargs)
+        for key, value in data.items():
+            if key == 'file' and self._check_if_serialization_iterator(value):
+                # Direct file case
+                file_obj = self._iterator_to_buffered_reader(value)
+                data[key] = self._process_file_data(file_obj)
+            elif key == 'files' and isinstance(value, list):
+                # List of objects case
+                for index, item in enumerate(value):
+                    if isinstance(item, dict) and 'file' in item:
+                        if self._check_if_serialization_iterator(item['file']):
+                            file_obj = self._iterator_to_buffered_reader(item['file'])
+                            data[key][index]['file'] = self._process_file_data(file_obj)
+        return data

{python_anvil-3.0.1 → python_anvil-5.0.0}/python_anvil/tests/test_api.py

@@ -1,7 +1,6 @@
 # pylint: disable=unused-variable,unused-argument,too-many-statements
 import json
 import pytest
-from pydantic import ValidationError
 from typing import Any, MutableMapping
 from unittest import mock
 
@@ -186,18 +185,6 @@ def describe_api():
                 )
             assert m_request_post.call_count == 0
 
-        @mock.patch('python_anvil.api.RestRequest.post')
-        def test_invalid_data_for_html(m_request_post, anvil):
-            with pytest.raises(ValueError):
-                anvil.generate_pdf(
-                    {
-                        # This should be a plain dict, not a list
-                        "data": [{"d1": "data"}],
-                        "type": "html",
-                    }
-                )
-            assert m_request_post.call_count == 0
-
         @mock.patch('python_anvil.api.RestRequest.post')
         def test_invalid_data_for_markdown(m_request_post, anvil):
             with pytest.raises(ValueError):
@@ -355,13 +342,13 @@ def describe_api():
                 for k, v in payloads.EXPECTED_ETCH_TEST_PAYLOAD_JSON.items()
                 if v is not None
             }
-            cep = CreateEtchPacketPayload.parse_obj(payload)
+            cep = CreateEtchPacketPayload.model_validate(payload)
             cep.newFeature = True  # type: ignore[attr-defined]
             anvil.create_etch_packet(payload=cep)
             assert m_request_post.call_count == 1
 
             variables = m_request_post.call_args[1]["variable_values"]
-            assert cep.dict(by_alias=True, exclude_none=True) == variables
+            assert cep.model_dump(by_alias=True, exclude_none=True) == variables
             assert "newFeature" in variables
 
     def describe_forge_submit():
@@ -386,30 +373,6 @@ def describe_api():
             assert m_request_post.call_count == 1
             assert {"variable_values": expected_data} in m_request_post.call_args
 
-        @mock.patch('gql.Client.execute')
-        def test_invalid_wd_submission(m_request_post, anvil):
-            with pytest.raises(ValidationError):
-                payload = dict(
-                    forge_eid="forge1234",
-                    # weld_data_eid and submission_eid must be provided
-                    # if one exists.
-                    weld_data_eid="wd1234",
-                    payload=dict(field1="Updated data"),
-                )
-                anvil.forge_submit(payload=payload)
-                assert m_request_post.call_count == 0
-
-            with pytest.raises(ValidationError):
-                payload = dict(
-                    forge_eid="forge1234",
-                    # weld_data_eid and submission_eid must be provided
-                    # if one exists.
-                    submission_eid="sub1234",
-                    payload=dict(field1="Updated data"),
-                )
-                anvil.forge_submit(payload=payload)
-                assert m_request_post.call_count == 0
-
         @mock.patch('gql.Client.execute')
         def test_minimum_valid_data_submission(m_request_post, anvil):
             payload = ForgeSubmitPayload(

python_anvil-5.0.0/python_anvil/tests/test_models.py

@@ -0,0 +1,264 @@
+import base64
+import pytest
+from pydantic import BaseModel
+from typing import Any, List, Optional
+
+from python_anvil.models import FileCompatibleBaseModel
+
+
+def test_file_compat_base_model_handles_regular_data():
+    class TestModel(FileCompatibleBaseModel):
+        name: str
+        value: int
+
+    model = TestModel(name="test", value=42)
+    data = model.model_dump()
+    assert data == {"name": "test", "value": 42}
+
+
+def test_file_compat_base_model_preserves_file_objects():
+    class FileModel(FileCompatibleBaseModel):
+        file: Any = None
+
+    # Create a test file object
+    with open(__file__, 'rb') as test_file:
+        model = FileModel(file=test_file)
+        data = model.model_dump()
+
+        # Verify we got a dictionary with the expected structure
+        assert isinstance(data['file'], dict)
+        assert 'data' in data['file']
+        assert 'mimetype' in data['file']
+        assert 'filename' in data['file']
+
+        # Verify the content matches
+        with open(__file__, 'rb') as original_file:
+            original_content = original_file.read()
+            decoded_content = base64.b64decode(data['file']['data'].encode('utf-8'))
+            assert (
+                decoded_content == original_content
+            ), "File content should match original"
+
+
+def test_file_compat_base_model_validates_types():
+    class TestModel(FileCompatibleBaseModel):
+        name: str
+        age: int
+
+    # Should work with valid types
+    model = TestModel(name="Alice", age=30)
+    assert model.name == "Alice"
+    assert model.age == 30
+
+    # Should raise validation error for wrong types
+    with pytest.raises(ValueError):
+        TestModel(name="Alice", age="thirty")
+
+
+def test_file_compat_base_model_handles_optional_fields():
+    class TestModel(FileCompatibleBaseModel):
+        required: str
+        optional: Optional[str] = None
+
+    # Should work with just required field
+    model = TestModel(required="test")
+    assert model.required == "test"
+    assert model.optional is None
+
+    # Should work with both fields
+    model = TestModel(required="test", optional="present")
+    assert model.optional == "present"
+
+
+def test_file_compat_base_model_handles_nested_models():
+    class NestedModel(BaseModel):
+        value: str
+
+    class ParentModel(FileCompatibleBaseModel):
+        nested: NestedModel
+
+    nested = NestedModel(value="test")
+    model = ParentModel(nested=nested)
+
+    data = model.model_dump()
+    assert data == {"nested": {"value": "test"}}
+
+
+def test_file_compat_base_model_handles_lists():
+    class TestModel(FileCompatibleBaseModel):
+        items: List[str]
+
+    model = TestModel(items=["a", "b", "c"])
+    data = model.model_dump()
+    assert data == {"items": ["a", "b", "c"]}
+
+
+def test_document_upload_handles_file_objects():
+    # pylint: disable-next=import-outside-toplevel
+    from python_anvil.api_resources.payload import DocumentUpload, SignatureField
+
+    # Create a sample signature field
+    field = SignatureField(
+        id="sig1",
+        type="signature",
+        page_num=1,
+        rect={"x": 100.0, "y": 100.0, "width": 100.0},
+    )
+
+    # Test with a file object
+    with open(__file__, 'rb') as test_file:
+        doc = DocumentUpload(
+            id="doc1", title="Test Document", file=test_file, fields=[field]
+        )
+
+        data = doc.model_dump()
+
+        # Verify file is converted to expected dictionary format
+        assert isinstance(data['file'], dict)
+        assert 'data' in data['file']
+        assert 'mimetype' in data['file']
+        assert 'filename' in data['file']
+
+        # Verify content matches
+        with open(__file__, 'rb') as original_file:
+            original_content = original_file.read()
+            decoded_content = base64.b64decode(data['file']['data'].encode('utf-8'))
+            assert decoded_content == original_content
+
+        # Verify other fields are correct
+        assert data['id'] == "doc1"
+        assert data['title'] == "Test Document"
+        assert len(data['fields']) == 1
+        assert data['fields'][0]['id'] == "sig1"
+
+
+def test_create_etch_packet_payload_handles_nested_file_objects():
+    # pylint: disable-next=import-outside-toplevel
+    from python_anvil.api_resources.payload import (
+        CreateEtchPacketPayload,
+        DocumentUpload,
+        EtchSigner,
+        SignatureField,
+    )
+
+    # Create a sample signature field
+    field = SignatureField(
+        id="sig1",
+        type="signature",
+        page_num=1,
+        rect={"x": 100.0, "y": 100.0, "width": 100.0},
+    )
+
+    # Create a signer
+    signer = EtchSigner(
+        name="Test Signer",
+        email="test@example.com",
+        fields=[{"file_id": "doc1", "field_id": "sig1"}],
+    )
+
+    # Test with a file object
+    with open(__file__, 'rb') as test_file:
+        # Create a DocumentUpload instance
+        doc = DocumentUpload(
+            id="doc1", title="Test Document", file=test_file, fields=[field]
+        )
+
+        # Create the packet payload
+        packet = CreateEtchPacketPayload(
+            name="Test Packet", signers=[signer], files=[doc], is_test=True
+        )
+
+        # Dump the model
+        data = packet.model_dump()
+
+        # Verify the structure
+        assert data['name'] == "Test Packet"
+        assert len(data['files']) == 1
+        assert len(data['signers']) == 1
+
+        # Verify file handling in the nested DocumentUpload
+        file_data = data['files'][0]
+        assert file_data['id'] == "doc1"
+        assert file_data['title'] == "Test Document"
+        assert isinstance(file_data['file'], dict)
+        assert 'data' in file_data['file']
+        assert 'mimetype' in file_data['file']
+        assert 'filename' in file_data['file']
+
+        # Verify content matches
+        with open(__file__, 'rb') as original_file:
+            original_content = original_file.read()
+            decoded_content = base64.b64decode(
+                file_data['file']['data'].encode('utf-8')
+            )
+            assert decoded_content == original_content
+
+
+def test_create_etch_packet_payload_handles_multiple_files():
+    # pylint: disable-next=import-outside-toplevel
+    from python_anvil.api_resources.payload import (
+        CreateEtchPacketPayload,
+        DocumentUpload,
+        EtchSigner,
+        SignatureField,
+    )
+
+    # Create signature fields
+    field1 = SignatureField(
+        id="sig1",
+        type="signature",
+        page_num=1,
+        rect={"x": 100.0, "y": 100.0, "width": 100.0},
+    )
+
+    field2 = SignatureField(
+        id="sig2",
+        type="signature",
+        page_num=1,
+        rect={"x": 200.0, "y": 200.0, "width": 100.0},
+    )
+
+    signer = EtchSigner(
+        name="Test Signer",
+        email="test@example.com",
+        fields=[
+            {"file_id": "doc1", "field_id": "sig1"},
+            {"file_id": "doc2", "field_id": "sig2"},
+        ],
+    )
+
+    # Test with multiple file objects
+    with open(__file__, 'rb') as test_file1, open(__file__, 'rb') as test_file2:
+        doc1 = DocumentUpload(
+            id="doc1", title="Test Document 1", file=test_file1, fields=[field1]
+        )
+
+        doc2 = DocumentUpload(
+            id="doc2", title="Test Document 2", file=test_file2, fields=[field2]
+        )
+
+        packet = CreateEtchPacketPayload(
+            name="Test Packet", signers=[signer], files=[doc1, doc2], is_test=True
+        )
+
+        data = packet.model_dump()
+
+        # Verify structure
+        assert len(data['files']) == 2
+
+        # Verify both files are properly handled
+        for i, file_data in enumerate(data['files'], 1):
+            assert file_data['id'] == f"doc{i}"
+            assert file_data['title'] == f"Test Document {i}"
+            assert isinstance(file_data['file'], dict)
+            assert 'data' in file_data['file']
+            assert 'mimetype' in file_data['file']
+            assert 'filename' in file_data['file']
+
+            # Verify content matches
+            with open(__file__, 'rb') as original_file:
+                original_content = original_file.read()
+                decoded_content = base64.b64decode(
+                    file_data['file']['data'].encode('utf-8')
+                )
+                assert decoded_content == original_content

python_anvil-3.0.1/python_anvil/api_resources/base.py

@@ -1,30 +0,0 @@
-# pylint: disable=no-self-argument
-import re
-
-# Disabling pylint no-name-in-module because this is the documented way to
-# import `BaseModel` and it's not broken, so let's keep it.
-from pydantic import BaseModel as _BaseModel, Extra  # pylint: disable=no-name-in-module
-
-
-under_pat = re.compile(r"_([a-z])")
-
-
-def underscore_to_camel(name):
-    ret = under_pat.sub(lambda x: x.group(1).upper(), name)
-    return ret
-
-
-class BaseModel(_BaseModel):
-    class Config:
-        """Config override for all models.
-
-        This override is mainly so everything can go from snake to camel-case.
-        """
-
-        alias_generator = underscore_to_camel
-        allow_population_by_field_name = True
-
-        # Allow extra fields even if it is not defined. This will allow models
-        # to be more flexible if features are added in the Anvil API, but
-        # explicit support hasn't been added yet to this library.
-        extra = Extra.allow

python_anvil-3.0.1/python_anvil/api_resources/mutations/helpers.py

@@ -1,7 +0,0 @@
-from typing import List, Text, Type
-
-from python_anvil.api_resources.base import BaseModel
-
-
-def get_payload_attrs(payload_model: Type[BaseModel]) -> List[Text]:
-    return list(payload_model.__fields__.keys())