feat: add FormData class for form and multipart requests (#3060)

Co-authored-by: Simon Knott <info@simonknott.de>

Author: dgozman

playwright/_impl/_fetch.py

@@ -14,6 +14,7 @@
 
 import base64
 import json
+import mimetypes
 import pathlib
 import typing
 from pathlib import Path
@@ -32,6 +33,7 @@
 )
 from playwright._impl._connection import ChannelOwner, from_channel
 from playwright._impl._errors import is_target_closed_error
+from playwright._impl._form_data import FormData
 from playwright._impl._helper import (
     Error,
     NameValue,
@@ -51,9 +53,9 @@
     from playwright._impl._playwright import Playwright
 
 
-FormType = Dict[str, Union[bool, float, str]]
+FormType = Union[Dict[str, Union[bool, float, str]], FormData]
 DataType = Union[Any, bytes, str]
-MultipartType = Dict[str, Union[bytes, bool, float, str, FilePayload]]
+MultipartType = Union[Dict[str, Union[bytes, bool, float, str, FilePayload]], FormData]
 ParamsType = Union[Dict[str, Union[bool, float, str]], str]
 
 
@@ -217,7 +219,7 @@ async def patch(
         headers: Headers = None,
         data: DataType = None,
         form: FormType = None,
-        multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,
+        multipart: MultipartType = None,
         timeout: float = None,
         failOnStatusCode: bool = None,
         ignoreHTTPSErrors: bool = None,
@@ -246,7 +248,7 @@ async def put(
         headers: Headers = None,
         data: DataType = None,
         form: FormType = None,
-        multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,
+        multipart: MultipartType = None,
         timeout: float = None,
         failOnStatusCode: bool = None,
         ignoreHTTPSErrors: bool = None,
@@ -275,7 +277,7 @@ async def post(
         headers: Headers = None,
         data: DataType = None,
         form: FormType = None,
-        multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,
+        multipart: MultipartType = None,
         timeout: float = None,
         failOnStatusCode: bool = None,
         ignoreHTTPSErrors: bool = None,
@@ -305,7 +307,7 @@ async def fetch(
         headers: Headers = None,
         data: DataType = None,
         form: FormType = None,
-        multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,
+        multipart: MultipartType = None,
         timeout: float = None,
         failOnStatusCode: bool = None,
         ignoreHTTPSErrors: bool = None,
@@ -346,7 +348,7 @@ async def _inner_fetch(
         data: DataType = None,
         params: ParamsType = None,
         form: FormType = None,
-        multipart: Dict[str, Union[bytes, bool, float, str, FilePayload]] = None,
+        multipart: MultipartType = None,
         timeout: float = None,
         failOnStatusCode: bool = None,
         ignoreHTTPSErrors: bool = None,
@@ -386,21 +388,36 @@ async def _inner_fetch(
             else:
                 raise Error(f"Unsupported 'data' type: {type(data)}")
         elif form:
-            form_data = object_to_array(form)
+            if isinstance(form, FormData):
+                form_data = []
+                for fd_name, fd_value in form._fields:
+                    if isinstance(fd_value, (pathlib.Path, dict)):
+                        raise Error(
+                            f"Form field {fd_name!r} must be a string, number or boolean. Use 'multipart' for file uploads."
+                        )
+                    form_data.append(NameValue(name=fd_name, value=str(fd_value)))
+            else:
+                form_data = object_to_array(form)
         elif multipart:
             multipart_data = []
-            # Convert file-like values to ServerFilePayload structs.
-            for name, value in multipart.items():
-                if is_file_payload(value):
-                    payload = cast(FilePayload, value)
-                    assert isinstance(
-                        payload["buffer"], bytes
-                    ), f"Unexpected buffer type of 'data.{name}'"
+            if isinstance(multipart, FormData):
+                for fd_name, fd_value in multipart._fields:
                     multipart_data.append(
-                        FormField(name=name, file=file_payload_to_json(payload))
+                        await _form_data_field_to_form_field(fd_name, fd_value)
                     )
-                elif isinstance(value, str):
-                    multipart_data.append(FormField(name=name, value=value))
+            else:
+                # Convert file-like values to ServerFilePayload structs.
+                for name, value in multipart.items():
+                    if is_file_payload(value):
+                        payload = cast(FilePayload, value)
+                        assert isinstance(
+                            payload["buffer"], bytes
+                        ), f"Unexpected buffer type of 'data.{name}'"
+                        multipart_data.append(
+                            FormField(name=name, file=file_payload_to_json(payload))
+                        )
+                    elif isinstance(value, str):
+                        multipart_data.append(FormField(name=name, value=value))
         if (
             post_data_buffer is None
             and json_data is None
@@ -455,6 +472,28 @@ def file_payload_to_json(payload: FilePayload) -> ServerFilePayload:
     )
 
 
+async def _form_data_field_to_form_field(name: str, value: Any) -> FormField:
+    if isinstance(value, pathlib.Path):
+        mime_type, _ = mimetypes.guess_type(str(value))
+        return FormField(
+            name=name,
+            file=ServerFilePayload(
+                name=value.name,
+                mimeType=mime_type or "application/octet-stream",
+                buffer=base64.b64encode(await async_readfile(str(value))).decode(),
+            ),
+        )
+    if is_file_payload(value):
+        payload = cast(FilePayload, value)
+        assert isinstance(
+            payload["buffer"], bytes
+        ), f"Unexpected buffer type of form field {name!r}"
+        return FormField(name=name, file=file_payload_to_json(payload))
+    if isinstance(value, (str, int, float, bool)):
+        return FormField(name=name, value=str(value))
+    raise Error(f"Unsupported form field {name!r} value type: {type(value).__name__}")
+
+
 class APIResponse:
     def __init__(self, context: APIRequestContext, initializer: Dict) -> None:
         self._loop = context._loop

playwright/_impl/_form_data.py

@@ -0,0 +1,34 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import pathlib
+from typing import List, Tuple, Union
+
+from playwright._impl._api_structures import FilePayload
+
+FormDataValue = Union[bool, float, str, pathlib.Path, FilePayload]
+
+
+class FormData:
+    def __init__(self) -> None:
+        self._fields: List[Tuple[str, FormDataValue]] = []
+
+    def set(self, name: str, value: FormDataValue) -> "FormData":
+        self._fields = [(n, v) for (n, v) in self._fields if n != name]
+        self._fields.append((name, value))
+        return self
+
+    def append(self, name: str, value: FormDataValue) -> "FormData":
+        self._fields.append((name, value))
+        return self

playwright/async_api/__init__.py

@@ -22,6 +22,7 @@
 
 import playwright._impl._api_structures
 import playwright._impl._errors
+import playwright._impl._form_data
 import playwright.async_api._generated
 from playwright._impl._assertions import (
     APIResponseAssertions as APIResponseAssertionsImpl,
@@ -69,6 +70,7 @@
 
 Cookie = playwright._impl._api_structures.Cookie
 FilePayload = playwright._impl._api_structures.FilePayload
+FormData = playwright._impl._form_data.FormData
 FloatRect = playwright._impl._api_structures.FloatRect
 Geolocation = playwright._impl._api_structures.Geolocation
 HttpCredentials = playwright._impl._api_structures.HttpCredentials
@@ -171,6 +173,7 @@ def __call__(
     "FileChooser",
     "FilePayload",
     "FloatRect",
+    "FormData",
     "Frame",
     "FrameLocator",
     "Geolocation",