Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Simon Knott (Skn0tt) merged 2 commits into from
May 12, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
daf6a18
feat: add FormData class for form and multipart requests
dgozman Apr 30, 2026
a8919c8
Merge remote-tracking branch 'upstream/main' into dgozman-form-data
Skn0tt May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 57 additions & 18 deletions playwright/_impl/_fetch.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down
34 changes: 34 additions & 0 deletions playwright/_impl/_form_data.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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
3 changes: 3 additions & 0 deletions playwright/async_api/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
"FileChooser",
"FilePayload",
"FloatRect",
"FormData",
"Frame",
"FrameLocator",
"Geolocation",
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat: add FormData class for form and multipart requests by dgozman · Pull Request #3060 · microsoft/playwright-python · GitHub
Skip to content
feat: add FormData class for form and multipart requests#3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Simon Knott (Skn0tt)
merged 2 commits into

from

May 12, 2026
 Merged


feat: add FormData class for form and multipart requests
#3060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
daf6a18

feat: add FormData class for form and multipart requests


dgozman Apr 30, 2026
a8919c8

Merge remote-tracking branch 'upstream/main' into dgozman-form-data


Skn0tt May 12, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


75 changes: 57 additions & 18 deletions
playwright/_impl/_fetch.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

import base64
import json
import mimetypes
import pathlib
import typing
from pathlib import Path
Expand All@@ -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,
Expand All@@ -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]


Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down

34 changes: 34 additions & 0 deletions
playwright/_impl/_form_data.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

3 changes: 3 additions & 0 deletions
playwright/async_api/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -171,6 +173,7 @@ def __call__(
 "FileChooser",
 "FilePayload",
 "FloatRect",
 "FormData",
 "Frame",
 "FrameLocator",
 "Geolocation",
Expand Down
Loading
Loading