[Playwright] Adding dataplane python sdk for playwright against latest API 2026-04-01-preview

sdk/playwright/azure-developer-playwright/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Release History
+
+## 1.0.0b1 (2026-04-06)
+
+### Features Added
+
+  - Initial preview release of the Azure Developer Playwright client library for Python
+  - Based on Azure Developer Playwright data-plane API version **2026-04-01-preview**
+  - Support for managing access tokens (create, get, delete, list)
+  - Support for managing test runs (create or update, get, list)
+  - Support for managing browser sessions (get, list)
+  - Support for getting remote browsers for Playwright script execution

sdk/playwright/azure-developer-playwright/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdk/playwright/azure-developer-playwright/MANIFEST.in

@@ -0,0 +1,7 @@
+include *.md
+include LICENSE
+include azure/developer/playwright/py.typed
+recursive-include tests *.py
+recursive-include samples *.py *.md
+include azure/__init__.py
+include azure/developer/__init__.py

sdk/playwright/azure-developer-playwright/README.md

@@ -0,0 +1,97 @@
+# Azure Developer Playwright client library for Python
+
+Azure Developer Playwright is a service that enables you to run Playwright tests at scale in the cloud. This client library allows you to manage access tokens, test runs, browser sessions, and remote browsers for your Playwright Testing workspace.
+
+## Getting started
+
+### Install the package
+
+```bash
+python -m pip install azure-developer-playwright
+```
+
+### Prerequisites
+
+- Python 3.9 or later is required to use this package.
+- You need an [Azure subscription][azure_sub] to use this package.
+- An existing Azure Developer Playwright workspace.
+
+### Authenticate the client
+
+To use this library, you need a [TokenCredential][azure_identity_credentials] implementation, such as [DefaultAzureCredential][default_azure_credential].
+
+```bash
+pip install azure-identity
+```
+
+```python
+from azure.identity import DefaultAzureCredential
+from azure.developer.playwright import PlaywrightClient
+
+client = PlaywrightClient(
+    endpoint="https://<region>.api.playwright.microsoft.com",
+    credential=DefaultAzureCredential(),
+)
+```
+
+## Key concepts
+
+- **Workspace**: An Azure Playwright Testing workspace that hosts your testing resources.
+- **Access Token**: A token used to authenticate Playwright browsers with the service.
+- **Test Run**: Represents a collection of test results reported to the service.
+- **Browser Session**: A remote browser session used during test execution.
+
+## Examples
+
+### List test runs
+
+```python
+from azure.identity import DefaultAzureCredential
+from azure.developer.playwright import PlaywrightClient
+
+client = PlaywrightClient(
+    endpoint="https://<region>.api.playwright.microsoft.com",
+    credential=DefaultAzureCredential(),
+)
+
+for run in client.test_runs.list(workspace_id="<workspace-id>"):
+    print(run)
+```
+
+## Troubleshooting
+
+For help troubleshooting common issues, see [Troubleshoot test run failures][troubleshoot_guide].
+
+## Next steps
+
+For more information about the Azure Developer Playwright service, see the [Azure Playwright Testing documentation][product_documentation].
+
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require
+you to agree to a Contributor License Agreement (CLA) declaring that you have
+the right to, and actually do, grant us the rights to use your contribution.
+For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether
+you need to provide a CLA and decorate the PR appropriately (e.g., label,
+comment). Simply follow the instructions provided by the bot. You will only
+need to do this once across all repos using our CLA.
+
+This project has adopted the
+[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
+see the Code of Conduct FAQ or contact opencode@microsoft.com with any
+additional questions or comments.
+
+<!-- LINKS -->
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
+[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
+[azure_identity_pip]: https://pypi.org/project/azure-identity/
+[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
+[pip]: https://pypi.org/project/pip/
+[azure_sub]: https://azure.microsoft.com/free/
+[python_logging]: https://docs.python.org/3/library/logging.html
+[product_documentation]: https://learn.microsoft.com/azure/playwright-testing/
+[troubleshoot_guide]: https://learn.microsoft.com/azure/playwright-testing/troubleshoot-test-run-failures

sdk/playwright/azure-developer-playwright/_metadata.json

@@ -0,0 +1,6 @@
+{
+  "apiVersion": "2026-04-01-preview",
+  "apiVersions": {
+    "Playwright": "2026-04-01-preview"
+  }
+}

sdk/playwright/azure-developer-playwright/apiview-properties.json

@@ -0,0 +1,46 @@
+{
+    "CrossLanguagePackageId": "Playwright",
+    "CrossLanguageDefinitionId": {
+        "azure.developer.playwright.models.AccessToken": "Playwright.AccessToken",
+        "azure.developer.playwright.models.BrowserSession": "Playwright.BrowserSession",
+        "azure.developer.playwright.models.BrowserSessionSource": "Playwright.BrowserSessionSource",
+        "azure.developer.playwright.models.CiConfig": "Playwright.CiConfig",
+        "azure.developer.playwright.models.RunConfig": "Playwright.RunConfig",
+        "azure.developer.playwright.models.RunFramework": "Playwright.RunFramework",
+        "azure.developer.playwright.models.RunSummary": "Playwright.RunSummary",
+        "azure.developer.playwright.models.TestRun": "Playwright.TestRun",
+        "azure.developer.playwright.models.Workspace": "Playwright.Workspace",
+        "azure.developer.playwright.models.WorkspaceState": "Playwright.WorkspaceState",
+        "azure.developer.playwright.models.SubscriptionState": "Playwright.SubscriptionState",
+        "azure.developer.playwright.models.EnablementStatus": "Playwright.EnablementStatus",
+        "azure.developer.playwright.models.OS": "Playwright.OS",
+        "azure.developer.playwright.models.AccessTokenState": "Playwright.AccessTokenState",
+        "azure.developer.playwright.models.SDKLanguage": "Playwright.SDKLanguage",
+        "azure.developer.playwright.models.RunStatus": "Playwright.RunStatus",
+        "azure.developer.playwright.models.BrowserSessionStatus": "Playwright.BrowserSessionStatus",
+        "azure.developer.playwright.models.BrowserSessionSourceType": "Playwright.BrowserSessionSourceType",
+        "azure.developer.playwright.models.BrowserType": "Playwright.BrowserType",
+        "azure.developer.playwright.operations.WorkspacesOperations.get": "Playwright.Workspaces.get",
+        "azure.developer.playwright.aio.operations.WorkspacesOperations.get": "Playwright.Workspaces.get",
+        "azure.developer.playwright.operations.WorkspacesOperations.get_browsers": "Playwright.Workspaces.getBrowsers",
+        "azure.developer.playwright.aio.operations.WorkspacesOperations.get_browsers": "Playwright.Workspaces.getBrowsers",
+        "azure.developer.playwright.operations.AccessTokensOperations.create_or_replace": "Playwright.AccessTokens.createOrReplace",
+        "azure.developer.playwright.aio.operations.AccessTokensOperations.create_or_replace": "Playwright.AccessTokens.createOrReplace",
+        "azure.developer.playwright.operations.AccessTokensOperations.get": "Playwright.AccessTokens.get",
+        "azure.developer.playwright.aio.operations.AccessTokensOperations.get": "Playwright.AccessTokens.get",
+        "azure.developer.playwright.operations.AccessTokensOperations.delete": "Playwright.AccessTokens.delete",
+        "azure.developer.playwright.aio.operations.AccessTokensOperations.delete": "Playwright.AccessTokens.delete",
+        "azure.developer.playwright.operations.AccessTokensOperations.list": "Playwright.AccessTokens.list",
+        "azure.developer.playwright.aio.operations.AccessTokensOperations.list": "Playwright.AccessTokens.list",
+        "azure.developer.playwright.operations.TestRunsOperations.create_or_update": "Playwright.TestRuns.createOrUpdate",
+        "azure.developer.playwright.aio.operations.TestRunsOperations.create_or_update": "Playwright.TestRuns.createOrUpdate",
+        "azure.developer.playwright.operations.TestRunsOperations.get": "Playwright.TestRuns.get",
+        "azure.developer.playwright.aio.operations.TestRunsOperations.get": "Playwright.TestRuns.get",
+        "azure.developer.playwright.operations.TestRunsOperations.list": "Playwright.TestRuns.list",
+        "azure.developer.playwright.aio.operations.TestRunsOperations.list": "Playwright.TestRuns.list",
+        "azure.developer.playwright.operations.BrowserSessionsOperations.get": "Playwright.BrowserSessions.get",
+        "azure.developer.playwright.aio.operations.BrowserSessionsOperations.get": "Playwright.BrowserSessions.get",
+        "azure.developer.playwright.operations.BrowserSessionsOperations.list": "Playwright.BrowserSessions.list",
+        "azure.developer.playwright.aio.operations.BrowserSessionsOperations.list": "Playwright.BrowserSessions.list"
+    }
+}

sdk/playwright/azure-developer-playwright/assets.json

@@ -0,0 +1,6 @@
+{
+  "AssetsRepo": "Azure/azure-sdk-assets",
+  "AssetsRepoPrefixPath": "python",
+  "TagPrefix": "python/playwright/azure-developer-playwright",
+  "Tag": "python/playwright/azure-developer-playwright_d1a8dd1621"
+}

sdk/playwright/azure-developer-playwright/azure/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/playwright/azure-developer-playwright/azure/developer/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/playwright/azure-developer-playwright/azure/developer/playwright/__init__.py

@@ -0,0 +1,32 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import PlaywrightClient  # type: ignore
+from ._version import VERSION
+
+__version__ = VERSION
+
+try:
+    from ._patch import __all__ as _patch_all
+    from ._patch import *
+except ImportError:
+    _patch_all = []
+from ._patch import patch_sdk as _patch_sdk
+
+__all__ = [
+    "PlaywrightClient",
+]
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
+
+_patch_sdk()

sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py

@@ -0,0 +1,118 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from copy import deepcopy
+from typing import Any, TYPE_CHECKING, Union  # pylint: disable=unused-import
+from typing_extensions import Self
+
+from azure.core import PipelineClient
+from azure.core.pipeline import policies
+from azure.core.rest import HttpRequest, HttpResponse
+
+from ._configuration import PlaywrightClientConfiguration
+from ._utils.serialization import Deserializer, Serializer
+from .operations import AccessTokensOperations, BrowserSessionsOperations, TestRunsOperations, WorkspacesOperations
+
+if TYPE_CHECKING:
+    from azure.core.credentials import TokenCredential
+
+
+class PlaywrightClient:
+    """PlaywrightClient.
+
+    :ivar workspaces: WorkspacesOperations operations
+    :vartype workspaces: azure.developer.playwright.operations.WorkspacesOperations
+    :ivar access_tokens: AccessTokensOperations operations
+    :vartype access_tokens: azure.developer.playwright.operations.AccessTokensOperations
+    :ivar test_runs: TestRunsOperations operations
+    :vartype test_runs: azure.developer.playwright.operations.TestRunsOperations
+    :ivar browser_sessions: BrowserSessionsOperations operations
+    :vartype browser_sessions: azure.developer.playwright.operations.BrowserSessionsOperations
+    :param endpoint: Playwright Service API endpoint (protocol and hostname) formatted as
+     https://{region}.api.playwright.microsoft.com. The region corresponds to your Azure Playwright
+     workspace location. You can find this value in your Azure Playwright workspace properties under
+     ``dataplaneUri``. Required.
+    :type endpoint: str
+    :param credential: Credential used to authenticate requests to the service. Is one of the
+     following types: token credential Required.
+    :type credential: ~azure.core.credentials.TokenCredential or
+     ~azure.core.credentials.TokenCredential
+    :keyword api_version: The API version to use for this operation. Known values are
+     "2026-04-01-preview". Default value is "2026-04-01-preview". Note that overriding this default
+     value may result in unsupported behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
+        _endpoint = "{endpoint}"
+        self._config = PlaywrightClientConfiguration(endpoint=endpoint, credential=credential, **kwargs)
+
+        _policies = kwargs.pop("policies", None)
+        if _policies is None:
+            _policies = [
+                policies.RequestIdPolicy(**kwargs),
+                self._config.headers_policy,
+                self._config.user_agent_policy,
+                self._config.proxy_policy,
+                policies.ContentDecodePolicy(**kwargs),
+                self._config.redirect_policy,
+                self._config.retry_policy,
+                self._config.authentication_policy,
+                self._config.custom_hook_policy,
+                self._config.logging_policy,
+                policies.DistributedTracingPolicy(**kwargs),
+                policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
+                self._config.http_logging_policy,
+            ]
+        self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
+
+        self._serialize = Serializer()
+        self._deserialize = Deserializer()
+        self._serialize.client_side_validation = False
+        self.workspaces = WorkspacesOperations(self._client, self._config, self._serialize, self._deserialize)
+        self.access_tokens = AccessTokensOperations(self._client, self._config, self._serialize, self._deserialize)
+        self.test_runs = TestRunsOperations(self._client, self._config, self._serialize, self._deserialize)
+        self.browser_sessions = BrowserSessionsOperations(
+            self._client, self._config, self._serialize, self._deserialize
+        )
+
+    def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
+        """Runs the network request through the client's chained policies.
+
+        >>> from azure.core.rest import HttpRequest
+        >>> request = HttpRequest("GET", "https://www.example.org/")
+        <HttpRequest [GET], url: 'https://www.example.org/'>
+        >>> response = client.send_request(request)
+        <HttpResponse: 200 OK>
+
+        For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
+
+        :param request: The network request you want to make. Required.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.HttpResponse
+        """
+
+        request_copy = deepcopy(request)
+        path_format_arguments = {
+            "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
+        }
+
+        request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
+        return self._client.send_request(request_copy, stream=stream, **kwargs)  # type: ignore
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> Self:
+        self._client.__enter__()
+        return self
+
+    def __exit__(self, *exc_details: Any) -> None:
+        self._client.__exit__(*exc_details)