From be135da89ee610c2c4ef2d1c780fb9861126617a Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Wed, 1 Apr 2026 20:59:41 +0000 Subject: [PATCH 1/9] initial commit containing code generated by tsp-client --- .../azure-developer-playwright/CHANGELOG.md | 7 + .../azure-developer-playwright/LICENSE | 21 + .../azure-developer-playwright/MANIFEST.in | 7 + .../azure-developer-playwright/README.md | 43 + .../azure-developer-playwright/_metadata.json | 6 + .../apiview-properties.json | 46 + .../azure/__init__.py | 1 + .../azure/developer/__init__.py | 1 + .../azure/developer/playwright/__init__.py | 32 + .../azure/developer/playwright/_client.py | 118 + .../developer/playwright/_configuration.py | 74 + .../azure/developer/playwright/_patch.py | 21 + .../developer/playwright/_utils/__init__.py | 6 + .../developer/playwright/_utils/model_base.py | 1350 +++++++++++ .../playwright/_utils/serialization.py | 2041 +++++++++++++++++ .../azure/developer/playwright/_validation.py | 66 + .../azure/developer/playwright/_version.py | 9 + .../developer/playwright/aio/__init__.py | 29 + .../azure/developer/playwright/aio/_client.py | 120 + .../playwright/aio/_configuration.py | 74 + .../azure/developer/playwright/aio/_patch.py | 21 + .../playwright/aio/operations/__init__.py | 31 + .../playwright/aio/operations/_operations.py | 1292 +++++++++++ .../playwright/aio/operations/_patch.py | 21 + .../developer/playwright/models/__init__.py | 66 + .../developer/playwright/models/_enums.py | 118 + .../developer/playwright/models/_models.py | 432 ++++ .../developer/playwright/models/_patch.py | 21 + .../playwright/operations/__init__.py | 31 + .../playwright/operations/_operations.py | 1602 +++++++++++++ .../developer/playwright/operations/_patch.py | 21 + .../azure/developer/playwright/py.typed | 1 + .../dev_requirements.txt | 3 + .../access_tokens_create_or_replace.py | 35 + .../generated_samples/access_tokens_delete.py | 33 + .../generated_samples/access_tokens_get.py | 34 + .../generated_samples/access_tokens_list.py | 34 + .../generated_samples/browser_sessions_get.py | 34 + .../browser_sessions_list.py | 34 + .../test_runs_create_or_update.py | 35 + .../generated_samples/test_runs_get.py | 34 + .../generated_samples/test_runs_list.py | 34 + .../generated_samples/workspaces_get.py | 33 + .../workspaces_get_browsers.py | 33 + .../generated_tests/conftest.py | 35 + ...est_playwright_access_tokens_operations.py | 68 + ...aywright_access_tokens_operations_async.py | 69 + ..._playwright_browser_sessions_operations.py | 36 + ...right_browser_sessions_operations_async.py | 37 + .../test_playwright_test_runs_operations.py | 76 + ...t_playwright_test_runs_operations_async.py | 77 + .../test_playwright_workspaces_operations.py | 36 + ..._playwright_workspaces_operations_async.py | 37 + .../generated_tests/testpreparer.py | 26 + .../generated_tests/testpreparer_async.py | 20 + .../azure-developer-playwright/pyproject.toml | 61 + .../tsp-location.yaml | 4 + 57 files changed, 8687 insertions(+) create mode 100644 sdk/playwright/azure-developer-playwright/CHANGELOG.md create mode 100644 sdk/playwright/azure-developer-playwright/LICENSE create mode 100644 sdk/playwright/azure-developer-playwright/MANIFEST.in create mode 100644 sdk/playwright/azure-developer-playwright/README.md create mode 100644 sdk/playwright/azure-developer-playwright/_metadata.json create mode 100644 sdk/playwright/azure-developer-playwright/apiview-properties.json create mode 100644 sdk/playwright/azure-developer-playwright/azure/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/model_base.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/serialization.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_validation.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/_version.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_enums.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_models.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_patch.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/__init__.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py create mode 100644 sdk/playwright/azure-developer-playwright/azure/developer/playwright/py.typed create mode 100644 sdk/playwright/azure-developer-playwright/dev_requirements.txt create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_create_or_replace.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_delete.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_get.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_list.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_get.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_list.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/test_runs_create_or_update.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/test_runs_get.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/test_runs_list.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get_browsers.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/conftest.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py create mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py create mode 100644 sdk/playwright/azure-developer-playwright/pyproject.toml create mode 100644 sdk/playwright/azure-developer-playwright/tsp-location.yaml diff --git a/sdk/playwright/azure-developer-playwright/CHANGELOG.md b/sdk/playwright/azure-developer-playwright/CHANGELOG.md new file mode 100644 index 000000000000..b957b2575b48 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/CHANGELOG.md @@ -0,0 +1,7 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +### Other Changes + + - Initial version \ No newline at end of file diff --git a/sdk/playwright/azure-developer-playwright/LICENSE b/sdk/playwright/azure-developer-playwright/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/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. \ No newline at end of file diff --git a/sdk/playwright/azure-developer-playwright/MANIFEST.in b/sdk/playwright/azure-developer-playwright/MANIFEST.in new file mode 100644 index 000000000000..d917681b2342 --- /dev/null +++ b/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 diff --git a/sdk/playwright/azure-developer-playwright/README.md b/sdk/playwright/azure-developer-playwright/README.md new file mode 100644 index 000000000000..48263e038f08 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/README.md @@ -0,0 +1,43 @@ +# Azure Developer Playwright client library for Python + + +## Getting started + +### Install the package + +```bash +python -m pip install azure-developer-playwright +``` + +#### Prequisites + +- 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 instance. + + +## 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. + + +[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/ diff --git a/sdk/playwright/azure-developer-playwright/_metadata.json b/sdk/playwright/azure-developer-playwright/_metadata.json new file mode 100644 index 000000000000..529437628f7d --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/_metadata.json @@ -0,0 +1,6 @@ +{ + "apiVersion": "2026-04-01-preview", + "apiVersions": { + "Playwright": "2026-04-01-preview" + } +} \ No newline at end of file diff --git a/sdk/playwright/azure-developer-playwright/apiview-properties.json b/sdk/playwright/azure-developer-playwright/apiview-properties.json new file mode 100644 index 000000000000..6ca041de67fa --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/sdk/playwright/azure-developer-playwright/azure/__init__.py b/sdk/playwright/azure-developer-playwright/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/__init__.py new file mode 100644 index 000000000000..ef0c81e738ee --- /dev/null +++ b/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() diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py new file mode 100644 index 000000000000..b75bb9953088 --- /dev/null +++ b/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 +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/") + + >>> response = client.send_request(request) + + + 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) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py new file mode 100644 index 000000000000..ed95cf85a182 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py @@ -0,0 +1,74 @@ +# 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 typing import Any, TYPE_CHECKING, Union + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class PlaywrightClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for PlaywrightClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :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: + api_version: str = kwargs.pop("api_version", "2026-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://playwright.microsoft.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-playwright/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if hasattr(self.credential, "get_token"): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + if hasattr(self.credential, "get_token"): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/model_base.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/model_base.py new file mode 100644 index 000000000000..7b7f8ba67b53 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/model_base.py @@ -0,0 +1,1350 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null +from azure.core.rest import HttpResponse + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") +_NONE_TYPE = type(None) + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + +_ARRAY_ENCODE_MAPPING = { + "pipeDelimited": "|", + "spaceDelimited": " ", + "commaDelimited": ",", + "newlineDelimited": "\n", +} + + +def _deserialize_array_encoded(delimit: str, attr): + if isinstance(attr, str): + if attr == "": + return [] + return attr.split(delimit) + return attr + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj # type: ignore[no-any-return] + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) # type: ignore[no-any-return] + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: + return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + # If this key has been deserialized (for mutable types), we need to handle serialization + if hasattr(self, "_attr_to_rest_field"): + cache_attr = f"_deserialized_{key}" + if hasattr(self, cache_attr): + rf = _get_rest_field(getattr(self, "_attr_to_rest_field"), key) + if rf: + value = self._data.get(key) + if isinstance(value, (dict, list, set)): + # For mutable types, serialize and return + # But also update _data with serialized form and clear flag + # so mutations via this returned value affect _data + serialized = _serialize(value, rf._format) + # If serialized form is same type (no transformation needed), + # return _data directly so mutations work + if isinstance(serialized, type(value)) and serialized == value: + return self._data.get(key) + # Otherwise return serialized copy and clear flag + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + # Store serialized form back + self._data[key] = serialized + return serialized + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + # Clear any cached deserialized value when setting through dictionary access + cache_attr = f"_deserialized_{key}" + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + if isinstance(other, _MyMutableMapping): + return self._data == other._data + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o): + return _ARRAY_ENCODE_MAPPING[format].join(o) + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: # pylint: disable=too-many-nested-blocks + if isinstance(args[0], ET.Element): + existed_attr_keys = [] + model_meta = getattr(self, "_xml", {}) + + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and args[0].get(xml_name) is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + # unwrapped array could either use prop items meta/prop meta + if prop_meta.get("itemsName"): + xml_name = prop_meta.get("itemsName") + xml_ns = prop_meta.get("itemNs") + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = args[0].findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, items) + elif not rf._is_optional: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = [] + continue + + # text element is primitive type + if prop_meta.get("text", False): + if args[0].text is not None: + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].text) + continue + + # wrapped element could be normal property or array, it should only have one element + item = args[0].find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in args[0]: + if e.tag not in existed_attr_keys: + dict_to_pass[e.tag] = _convert_element(e) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _is_array_encoded_deserializer(deserializer: functools.partial) -> bool: + return ( + isinstance(deserializer, functools.partial) + and isinstance(deserializer.args[0], functools.partial) + and deserializer.args[0].func == _deserialize_array_encoded # pylint: disable=comparison-with-callable + ) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + + # encoded string may be deserialized to sequence + if isinstance(obj, str) and isinstance(deserializer, functools.partial): + # for list[str] + if _is_array_encoded_deserializer(deserializer): + return deserializer(obj) + + # for list[Union[...]] + if isinstance(deserializer.args[0], list): + for sub_deserializer in deserializer.args[0]: + if _is_array_encoded_deserializer(sub_deserializer): + return sub_deserializer(obj) + + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a is _NONE_TYPE for a in annotation.__args__): # pyright: ignore + if rf: + rf._is_optional = True + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING.values(): + return deserializer(value.text) if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING_WITHFORMAT.values(): + return deserializer(value.text) if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value.text if isinstance(value, ET.Element) else value) + except ValueError: + # for unknown value, return raw value + return value.text if isinstance(value, ET.Element) else value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +# pylint: disable=too-many-instance-attributes +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._is_optional = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + + @property + def _class_type(self) -> typing.Any: + result = getattr(self._type, "args", [None])[0] + # type may be wrapped by nested functools.partial so we need to check for that + if isinstance(result, functools.partial): + return getattr(result, "args", [None])[0] + return result + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + # Use _data.get() directly to avoid triggering __getitem__ which clears the cache + item = obj._data.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + + # For mutable types, we want mutations to directly affect _data + # Check if we've already deserialized this value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + # Return the value from _data directly (it's been deserialized in place) + return obj._data.get(self._rest_name) + + deserialized = _deserialize(self._type, _serialize(item, self._format), rf=self) + + # For mutable types, store the deserialized value back in _data + # so mutations directly affect _data + if isinstance(deserialized, (dict, list, set)): + obj._data[self._rest_name] = deserialized + object.__setattr__(obj, cache_attr, True) # Mark as deserialized + return deserialized + + return deserialized + + def __set__(self, obj: Model, value) -> None: + # Clear the cached deserialized object when setting a new value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + object.__delattr__(obj, cache_attr) + + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + wrapped_element = _create_xml_element( + model_meta.get("name", o.__class__.__name__), + model_meta.get("prefix"), + model_meta.get("ns"), + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # if no ns for prop, use model's + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + xml_name = prop_meta.get("name", k) + if prop_meta.get("ns"): + ET.register_namespace(prop_meta.get("prefix"), prop_meta.get("ns")) # pyright: ignore + xml_name = "{" + prop_meta.get("ns") + "}" + xml_name # pyright: ignore + # attribute should be primitive type + wrapped_element.set(xml_name, _get_primitive_type_value(v)) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": parent_meta.get("ns") if parent_meta else None, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": parent_meta.get("itemsNs", parent_meta.get("ns")), + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, meta.get("ns") if meta else None + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element # type: ignore[no-any-return] + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _create_xml_element( + tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None +) -> ET.Element: + if prefix and ns: + ET.register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/serialization.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/serialization.py new file mode 100644 index 000000000000..81ec1de5922b --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_utils/serialization.py @@ -0,0 +1,2041 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore +from typing_extensions import Self + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized |= target_obj.additional_properties + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + :raises TypeError: raise if data_type is not one of str, int, float, bool. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + if data_type == "int": + return int(data) + if data_type == "float": + return float(data) + if data_type == "bool": + return bool(data) + raise TypeError("Unknown basic data type: {}".format(data_type)) + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(list[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid or data_type is not one of str, int, float, bool. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + if data_type == "int": + return int(attr) + if data_type == "float": + return float(attr) + raise TypeError("Unknown basic data type: {}".format(data_type)) + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_validation.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_validation.py new file mode 100644 index 000000000000..f5af3a4eb8a2 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_validation.py @@ -0,0 +1,66 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- +import functools + + +def api_version_validation(**kwargs): + params_added_on = kwargs.pop("params_added_on", {}) + method_added_on = kwargs.pop("method_added_on", "") + api_versions_list = kwargs.pop("api_versions_list", []) + + def _index_with_default(value: str, default: int = -1) -> int: + """Get the index of value in lst, or return default if not found. + + :param value: The value to search for in the api_versions_list. + :type value: str + :param default: The default value to return if the value is not found. + :type default: int + :return: The index of the value in the list, or the default value if not found. + :rtype: int + """ + try: + return api_versions_list.index(value) + except ValueError: + return default + + def decorator(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + try: + # this assumes the client has an _api_version attribute + client = args[0] + client_api_version = client._config.api_version # pylint: disable=protected-access + except AttributeError: + return func(*args, **kwargs) + + if _index_with_default(method_added_on) > _index_with_default(client_api_version): + raise ValueError( + f"'{func.__name__}' is not available in API version " + f"{client_api_version}. Pass service API version {method_added_on} or newer to your client." + ) + + unsupported = { + parameter: api_version + for api_version, parameters in params_added_on.items() + for parameter in parameters + if parameter in kwargs and _index_with_default(api_version) > _index_with_default(client_api_version) + } + if unsupported: + raise ValueError( + "".join( + [ + f"'{param}' is not available in API version {client_api_version}. " + f"Use service API version {version} or newer.\n" + for param, version in unsupported.items() + ] + ) + ) + return func(*args, **kwargs) + + return wrapper + + return decorator diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_version.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_version.py @@ -0,0 +1,9 @@ +# 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. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/__init__.py new file mode 100644 index 000000000000..b872d3b29c7d --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/__init__.py @@ -0,0 +1,29 @@ +# 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 + +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() diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py new file mode 100644 index 000000000000..06fda3182412 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py @@ -0,0 +1,120 @@ +# 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, Awaitable, TYPE_CHECKING, Union +from typing_extensions import Self + +from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._utils.serialization import Deserializer, Serializer +from ._configuration import PlaywrightClientConfiguration +from .operations import AccessTokensOperations, BrowserSessionsOperations, TestRunsOperations, WorkspacesOperations + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class PlaywrightClient: + """PlaywrightClient. + + :ivar workspaces: WorkspacesOperations operations + :vartype workspaces: azure.developer.playwright.aio.operations.WorkspacesOperations + :ivar access_tokens: AccessTokensOperations operations + :vartype access_tokens: azure.developer.playwright.aio.operations.AccessTokensOperations + :ivar test_runs: TestRunsOperations operations + :vartype test_runs: azure.developer.playwright.aio.operations.TestRunsOperations + :ivar browser_sessions: BrowserSessionsOperations operations + :vartype browser_sessions: azure.developer.playwright.aio.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_async.AsyncTokenCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :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: "AsyncTokenCredential", **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: AsyncPipelineClient = AsyncPipelineClient(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 + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + 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.AsyncHttpResponse + """ + + 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 + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py new file mode 100644 index 000000000000..bf3f116ea3e9 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py @@ -0,0 +1,74 @@ +# 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 typing import Any, TYPE_CHECKING, Union + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class PlaywrightClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for PlaywrightClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :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_async.AsyncTokenCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :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: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2026-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://playwright.microsoft.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-playwright/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if hasattr(self.credential, "get_token"): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + if hasattr(self.credential, "get_token"): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/__init__.py new file mode 100644 index 000000000000..f885cc4296c1 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/__init__.py @@ -0,0 +1,31 @@ +# 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 ._operations import WorkspacesOperations # type: ignore +from ._operations import AccessTokensOperations # type: ignore +from ._operations import TestRunsOperations # type: ignore +from ._operations import BrowserSessionsOperations # type: ignore + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "WorkspacesOperations", + "AccessTokensOperations", + "TestRunsOperations", + "BrowserSessionsOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_operations.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_operations.py new file mode 100644 index 000000000000..f38d1cf3e687 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_operations.py @@ -0,0 +1,1292 @@ +# pylint: disable=too-many-lines +# 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 collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core import AsyncPipelineClient +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._utils.model_base import SdkJSONEncoder, _deserialize +from ..._utils.serialization import Deserializer, Serializer +from ..._validation import api_version_validation +from ...operations._operations import ( + build_access_tokens_create_or_replace_request, + build_access_tokens_delete_request, + build_access_tokens_get_request, + build_access_tokens_list_request, + build_browser_sessions_get_request, + build_browser_sessions_list_request, + build_test_runs_create_or_update_request, + build_test_runs_get_request, + build_test_runs_list_request, + build_workspaces_get_browsers_request, + build_workspaces_get_request, +) +from .._configuration import PlaywrightClientConfiguration + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] +JSON = MutableMapping[str, Any] +List = list + + +class WorkspacesOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.aio.PlaywrightClient`'s + :attr:`workspaces` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + @api_version_validation( + method_added_on="2026-01-01-preview", + params_added_on={ + "2026-01-01-preview": ["api_version", "workspace_id", "client_request_id", "x_ms_useragent", "accept"] + }, + api_versions_list=["2026-01-01-preview", "2026-04-01-preview"], + ) + async def get(self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any) -> _models.Workspace: + """Get details of the Azure resource mapped to a workspace for the given workspace id. + Authorization required is Bearer JWT Access token provided by EntraID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: Workspace. The Workspace is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.Workspace + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.Workspace] = kwargs.pop("cls", None) + + _request = build_workspaces_get_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.Workspace, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_browsers( + self, + workspace_id: str, + *, + os: Union[str, _models.OS], + run_id: Optional[str] = None, + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> None: + """Gets remote browsers for the specified workspace ID and redirects the client to execute + Playwright scripts. Requires Bearer JWT access token provided by Entra ID or Playwright + Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword os: The operating system for remote script execution. Known values are: "Linux" and + "Windows". Required. + :paramtype os: str or ~azure.developer.playwright.models.OS + :keyword run_id: The run ID in GUID format. Default value is None. + :paramtype run_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_workspaces_get_browsers_request( + workspace_id=workspace_id, + os=os, + run_id=run_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [302]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["location"] = self._deserialize("str", response.headers.get("location")) + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + +class AccessTokensOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.aio.PlaywrightClient`'s + :attr:`access_tokens` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: _models.AccessToken, + *, + x_ms_useragent: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.developer.playwright.models.AccessToken + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: JSON, + *, + x_ms_useragent: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Required. + :type resource: JSON + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: IO[bytes], + *, + x_ms_useragent: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: Union[_models.AccessToken, JSON, IO[bytes]], + *, + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Is one of the following types: AccessToken, JSON, + IO[bytes] Required. + :type resource: ~azure.developer.playwright.models.AccessToken or JSON or IO[bytes] + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AccessToken] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_access_tokens_create_or_replace_request( + workspace_id=workspace_id, + access_token_id=access_token_id, + x_ms_useragent=x_ms_useragent, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get( + self, workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> _models.AccessToken: + """Gets an access token for the workspace with the specified access token ID. Requires Bearer JWT + access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AccessToken] = kwargs.pop("cls", None) + + _request = build_access_tokens_get_request( + workspace_id=workspace_id, + access_token_id=access_token_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete( + self, workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> None: + """Deletes an access token for the workspace with the specified access token ID. Requires Bearer + JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_access_tokens_delete_request( + workspace_id=workspace_id, + access_token_id=access_token_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace + def list( + self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> AsyncItemPaged["_models.AccessToken"]: + """Lists access tokens for the specified workspace ID. Supports OData query parameters: $select, + $filter, $orderby, $top, and $skip. Default page size is 10. Use nextLink in response to fetch + additional results. Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: An iterator like instance of AccessToken + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.developer.playwright.models.AccessToken] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AccessToken]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_access_tokens_list_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + List[_models.AccessToken], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + +class TestRunsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.aio.PlaywrightClient`'s + :attr:`test_runs` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: _models.TestRun, + *, + content_type: str = "application/merge-patch+json", + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.developer.playwright.models.TestRun + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: JSON, + *, + content_type: str = "application/merge-patch+json", + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Required. + :type resource: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: Union[_models.TestRun, JSON, IO[bytes]], + *, + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Is one of the following types: TestRun, JSON, IO[bytes] + Required. + :type resource: ~azure.developer.playwright.models.TestRun or JSON or IO[bytes] + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_test_runs_create_or_update_request( + workspace_id=workspace_id, + run_id=run_id, + x_ms_useragent=x_ms_useragent, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + @api_version_validation( + method_added_on="2026-04-01-preview", + params_added_on={ + "2026-04-01-preview": [ + "api_version", + "workspace_id", + "run_id", + "client_request_id", + "x_ms_useragent", + "accept", + ] + }, + api_versions_list=["2026-04-01-preview"], + ) + async def get( + self, workspace_id: str, run_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> _models.TestRun: + """Gets a test run for the specified run and workspace ID. Requires Bearer JWT access token + provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_test_runs_get_request( + workspace_id=workspace_id, + run_id=run_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list( + self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> AsyncItemPaged["_models.TestRun"]: + """Lists test runs for the specified workspace ID. Supports OData query parameters such as $filter + and $top. Default page size is 10. Use nextLink in response to fetch additional results. + Requires Bearer JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: An iterator like instance of TestRun + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.developer.playwright.models.TestRun] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.TestRun]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_test_runs_list_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + List[_models.TestRun], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + +class BrowserSessionsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.aio.PlaywrightClient`'s + :attr:`browser_sessions` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + @api_version_validation( + method_added_on="2026-04-01-preview", + params_added_on={ + "2026-04-01-preview": [ + "api_version", + "workspace_id", + "session_id", + "client_request_id", + "x_ms_useragent", + "accept", + ] + }, + api_versions_list=["2026-04-01-preview"], + ) + async def get( + self, workspace_id: str, session_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> _models.BrowserSession: + """Get a browser session for the specified session and workspace ID. Requires Bearer JWT access + token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param session_id: The browser session ID in GUID format. Required. + :type session_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: BrowserSession. The BrowserSession is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.BrowserSession + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.BrowserSession] = kwargs.pop("cls", None) + + _request = build_browser_sessions_get_request( + workspace_id=workspace_id, + session_id=session_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.BrowserSession, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + @api_version_validation( + method_added_on="2026-04-01-preview", + params_added_on={ + "2026-04-01-preview": ["api_version", "workspace_id", "client_request_id", "x_ms_useragent", "accept"] + }, + api_versions_list=["2026-04-01-preview"], + ) + def list( + self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> AsyncItemPaged["_models.BrowserSession"]: + """Lists browser sessions for the specified workspace ID. Supports OData query parameters such as + $filter and $top. Default page size is 10. Use nextLink in response to fetch additional + results. Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: An iterator like instance of BrowserSession + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.playwright.models.BrowserSession] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.BrowserSession]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_browser_sessions_list_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + List[_models.BrowserSession], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/__init__.py new file mode 100644 index 000000000000..6d02cfbaa503 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/__init__.py @@ -0,0 +1,66 @@ +# 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 ._models import ( # type: ignore + AccessToken, + BrowserSession, + BrowserSessionSource, + CiConfig, + RunConfig, + RunFramework, + RunSummary, + TestRun, + Workspace, +) + +from ._enums import ( # type: ignore + AccessTokenState, + BrowserSessionSourceType, + BrowserSessionStatus, + BrowserType, + EnablementStatus, + OS, + RunStatus, + SDKLanguage, + SubscriptionState, + WorkspaceState, +) +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AccessToken", + "BrowserSession", + "BrowserSessionSource", + "CiConfig", + "RunConfig", + "RunFramework", + "RunSummary", + "TestRun", + "Workspace", + "AccessTokenState", + "BrowserSessionSourceType", + "BrowserSessionStatus", + "BrowserType", + "EnablementStatus", + "OS", + "RunStatus", + "SDKLanguage", + "SubscriptionState", + "WorkspaceState", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_enums.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_enums.py new file mode 100644 index 000000000000..c6107c9b5f6f --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_enums.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 enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class AccessTokenState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The access token state.""" + + ACTIVE = "Active" + """The access token is active and can be used for authentication.""" + EXPIRED = "Expired" + """The access token has expired and cannot be used for authentication.""" + + +class BrowserSessionSourceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The browser session source type.""" + + PLAYWRIGHT_WORKSPACES_TEST_RUN = "PlaywrightWorkspacesTestRun" + """The browser session source is a Playwright Workspaces test run.""" + BROWSER_AUTOMATION_TOOL = "BrowserAutomationTool" + """The browser session source is a browser automation tool.""" + OTHERS = "Others" + """The browser session source is of other types.""" + + +class BrowserSessionStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The browser session status.""" + + CREATED = "Created" + """The browser session is created.""" + ACTIVE = "Active" + """The browser session is currently active.""" + COMPLETED = "Completed" + """The browser session has completed.""" + FAILED = "Failed" + """The browser session has failed.""" + + +class BrowserType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The browser type to configure for remote script execution.""" + + CHROMIUM = "Chromium" + """Chromium browser type.""" + FIREFOX = "Firefox" + """Firefox browser type.""" + WEBKIT = "Webkit" + """WebKit browser type.""" + + +class EnablementStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The enablement status of a feature.""" + + ENABLED = "Enabled" + """The feature is Enabled.""" + DISABLED = "Disabled" + """The feature is Disabled.""" + + +class OS(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The operating system to configure for remote script execution.""" + + LINUX = "Linux" + """Linux operating system.""" + WINDOWS = "Windows" + """Windows operating system.""" + + +class RunStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The test run status.""" + + RUNNING = "RUNNING" + """The test run is currently running.""" + CLIENT_COMPLETE = "CLIENT_COMPLETE" + """The test run has completed on the client side.""" + SERVER_COMPLETE = "SERVER_COMPLETE" + """The test run has completed on the server side.""" + + +class SDKLanguage(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The SDK language used for the test run.""" + + JAVASCRIPT = "JAVASCRIPT" + """JavaScript SDK.""" + TYPESCRIPT = "TYPESCRIPT" + """TypeScript SDK.""" + CSHARP = "CSHARP" + """C# SDK.""" + + +class SubscriptionState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The Azure subscription state.""" + + REGISTERED = "Registered" + """The subscription state is Registered.""" + WARNED = "Warned" + """The subscription state is Warned.""" + SUSPENDED = "Suspended" + """The subscription state is Suspended.""" + DELETED = "Deleted" + """The subscription state is Deleted.""" + UNREGISTERED = "Unregistered" + """The subscription state is Unregistered.""" + + +class WorkspaceState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The Playwright workspace state.""" + + ACTIVE = "Active" + """The workspace is Active.""" + INACTIVE = "Inactive" + """The workspace is Inactive.""" diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_models.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_models.py new file mode 100644 index 000000000000..e2b34017c449 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_models.py @@ -0,0 +1,432 @@ +# 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=useless-super-delegation + +import datetime +from typing import Any, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .._utils.model_base import Model as _Model, rest_field + +if TYPE_CHECKING: + from .. import models as _models + + +class AccessToken(_Model): + """Model of an access token linked to a workspace. + + :ivar id: The access token ID in GUID format. Required. + :vartype id: str + :ivar name: The access token name. Required. + :vartype name: str + :ivar jwt_token: The access token value in JWT format. + :vartype jwt_token: str + :ivar created_at: The access token creation timestamp in UTC. Required. + :vartype created_at: ~datetime.datetime + :ivar expiry_at: The access token expiration timestamp in UTC. Required. + :vartype expiry_at: ~datetime.datetime + :ivar state: The access token state. Required. Known values are: "Active" and "Expired". + :vartype state: str or ~azure.developer.playwright.models.AccessTokenState + """ + + id: str = rest_field(visibility=["read"]) + """The access token ID in GUID format. Required.""" + name: str = rest_field(visibility=["read", "create"]) + """The access token name. Required.""" + jwt_token: Optional[str] = rest_field(name="jwtToken", visibility=["read"]) + """The access token value in JWT format.""" + created_at: datetime.datetime = rest_field(name="createdAt", visibility=["read"], format="rfc3339") + """The access token creation timestamp in UTC. Required.""" + expiry_at: datetime.datetime = rest_field(name="expiryAt", visibility=["read", "create"], format="rfc3339") + """The access token expiration timestamp in UTC. Required.""" + state: Union[str, "_models.AccessTokenState"] = rest_field(visibility=["read"]) + """The access token state. Required. Known values are: \"Active\" and \"Expired\".""" + + @overload + def __init__( + self, + *, + name: str, + expiry_at: datetime.datetime, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class BrowserSession(_Model): + """Model of a browser session used for tracking purposes. + + :ivar id: The browser session ID in GUID format. Required. + :vartype id: str + :ivar display_name: The browser session display name. Required. + :vartype display_name: str + :ivar creator_id: The browser session creator's ID. Required. + :vartype creator_id: str + :ivar start_time: The browser session start time in UTC. + :vartype start_time: ~datetime.datetime + :ivar end_time: The browser session end time in UTC. + :vartype end_time: ~datetime.datetime + :ivar duration_in_milliseconds: The browser session duration in milliseconds. + :vartype duration_in_milliseconds: int + :ivar status: The browser session status. Required. Known values are: "Created", "Active", + "Completed", and "Failed". + :vartype status: str or ~azure.developer.playwright.models.BrowserSessionStatus + :ivar source: The browser session source details. Required. + :vartype source: ~azure.developer.playwright.models.BrowserSessionSource + :ivar browser_type: The browser session browser type. Required. Known values are: "Chromium", + "Firefox", and "Webkit". + :vartype browser_type: str or ~azure.developer.playwright.models.BrowserType + :ivar operating_system: The browser session operating system. Required. Known values are: + "Linux" and "Windows". + :vartype operating_system: str or ~azure.developer.playwright.models.OS + """ + + id: str = rest_field(visibility=["read"]) + """The browser session ID in GUID format. Required.""" + display_name: str = rest_field(name="displayName", visibility=["read"]) + """The browser session display name. Required.""" + creator_id: str = rest_field(name="creatorId", visibility=["read"]) + """The browser session creator's ID. Required.""" + start_time: Optional[datetime.datetime] = rest_field(name="startTime", visibility=["read"], format="rfc3339") + """The browser session start time in UTC.""" + end_time: Optional[datetime.datetime] = rest_field(name="endTime", visibility=["read"], format="rfc3339") + """The browser session end time in UTC.""" + duration_in_milliseconds: Optional[int] = rest_field(name="durationInMilliseconds", visibility=["read"]) + """The browser session duration in milliseconds.""" + status: Union[str, "_models.BrowserSessionStatus"] = rest_field(visibility=["read"]) + """The browser session status. Required. Known values are: \"Created\", \"Active\", \"Completed\", + and \"Failed\".""" + source: "_models.BrowserSessionSource" = rest_field(visibility=["read"]) + """The browser session source details. Required.""" + browser_type: Union[str, "_models.BrowserType"] = rest_field(name="browserType", visibility=["read"]) + """The browser session browser type. Required. Known values are: \"Chromium\", \"Firefox\", and + \"Webkit\".""" + operating_system: Union[str, "_models.OS"] = rest_field(name="operatingSystem", visibility=["read"]) + """The browser session operating system. Required. Known values are: \"Linux\" and \"Windows\".""" + + +class BrowserSessionSource(_Model): + """The browser session source details. + + :ivar id: The browser session source ID, would be same as runId for test-runs. Required. + :vartype id: str + :ivar type: The browser session source type. Required. Known values are: + "PlaywrightWorkspacesTestRun", "BrowserAutomationTool", and "Others". + :vartype type: str or ~azure.developer.playwright.models.BrowserSessionSourceType + """ + + id: str = rest_field(visibility=["read"]) + """The browser session source ID, would be same as runId for test-runs. Required.""" + type: Union[str, "_models.BrowserSessionSourceType"] = rest_field(visibility=["read"]) + """The browser session source type. Required. Known values are: \"PlaywrightWorkspacesTestRun\", + \"BrowserAutomationTool\", and \"Others\".""" + + +class CiConfig(_Model): + """The test run CI configuration. + + :ivar provider_name: The CI provider name. + :vartype provider_name: str + :ivar branch: The CI branch name. + :vartype branch: str + :ivar author: The CI commit author. + :vartype author: str + :ivar commit_id: The CI commit ID. + :vartype commit_id: str + :ivar revision_url: The CI revision URL. + :vartype revision_url: str + """ + + provider_name: Optional[str] = rest_field(name="providerName", visibility=["read", "create"]) + """The CI provider name.""" + branch: Optional[str] = rest_field(visibility=["read", "create"]) + """The CI branch name.""" + author: Optional[str] = rest_field(visibility=["read", "create"]) + """The CI commit author.""" + commit_id: Optional[str] = rest_field(name="commitId", visibility=["read", "create"]) + """The CI commit ID.""" + revision_url: Optional[str] = rest_field(name="revisionUrl", visibility=["read", "create"]) + """The CI revision URL.""" + + @overload + def __init__( + self, + *, + provider_name: Optional[str] = None, + branch: Optional[str] = None, + author: Optional[str] = None, + commit_id: Optional[str] = None, + revision_url: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class RunConfig(_Model): + """The run configuration. + + :ivar framework: The framework used for the test run. + :vartype framework: ~azure.developer.playwright.models.RunFramework + :ivar sdk_language: The SDK language used for the test run. Known values are: "JAVASCRIPT", + "TYPESCRIPT", and "CSHARP". + :vartype sdk_language: str or ~azure.developer.playwright.models.SDKLanguage + :ivar max_workers: The maximum number of workers required for the test run. + :vartype max_workers: int + """ + + framework: Optional["_models.RunFramework"] = rest_field(visibility=["read", "create"]) + """The framework used for the test run.""" + sdk_language: Optional[Union[str, "_models.SDKLanguage"]] = rest_field( + name="sdkLanguage", visibility=["read", "create"] + ) + """The SDK language used for the test run. Known values are: \"JAVASCRIPT\", \"TYPESCRIPT\", and + \"CSHARP\".""" + max_workers: Optional[int] = rest_field(name="maxWorkers", visibility=["read", "create"]) + """The maximum number of workers required for the test run.""" + + @overload + def __init__( + self, + *, + framework: Optional["_models.RunFramework"] = None, + sdk_language: Optional[Union[str, "_models.SDKLanguage"]] = None, + max_workers: Optional[int] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class RunFramework(_Model): + """The test run framework information. + + :ivar name: The framework name. + :vartype name: str + :ivar version: The framework version. + :vartype version: str + :ivar runner_name: The framework runner name. + :vartype runner_name: str + """ + + name: Optional[str] = rest_field(visibility=["read", "create"]) + """The framework name.""" + version: Optional[str] = rest_field(visibility=["read", "create"]) + """The framework version.""" + runner_name: Optional[str] = rest_field(name="runnerName", visibility=["read", "create"]) + """The framework runner name.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + version: Optional[str] = None, + runner_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class RunSummary(_Model): + """The test run summary. + + :ivar status: The test run status. Required. Known values are: "RUNNING", "CLIENT_COMPLETE", + and "SERVER_COMPLETE". + :vartype status: str or ~azure.developer.playwright.models.RunStatus + :ivar billable_time: The test run billable time in milliseconds. + :vartype billable_time: int + :ivar num_browser_sessions: The total number of browser sessions allocated to the test run. + :vartype num_browser_sessions: int + :ivar max_concurrent_browser_sessions: The highest number of browser sessions that were running + concurrently during the test run. + :vartype max_concurrent_browser_sessions: int + :ivar start_time: The test run start time in UTC. Required. + :vartype start_time: ~datetime.datetime + :ivar end_time: The test run end time in UTC. + :vartype end_time: ~datetime.datetime + :ivar duration: The test run duration in milliseconds. + :vartype duration: int + :ivar error_messages: The list of error messages corresponding to the test run. + :vartype error_messages: list[str] + """ + + status: Union[str, "_models.RunStatus"] = rest_field(visibility=["read"]) + """The test run status. Required. Known values are: \"RUNNING\", \"CLIENT_COMPLETE\", and + \"SERVER_COMPLETE\".""" + billable_time: Optional[int] = rest_field(name="billableTime", visibility=["read"]) + """The test run billable time in milliseconds.""" + num_browser_sessions: Optional[int] = rest_field(name="numBrowserSessions", visibility=["read"]) + """The total number of browser sessions allocated to the test run.""" + max_concurrent_browser_sessions: Optional[int] = rest_field( + name="maxConcurrentBrowserSessions", visibility=["read"] + ) + """The highest number of browser sessions that were running concurrently during the test run.""" + start_time: datetime.datetime = rest_field(name="startTime", visibility=["read"], format="rfc3339") + """The test run start time in UTC. Required.""" + end_time: Optional[datetime.datetime] = rest_field(name="endTime", visibility=["read"], format="rfc3339") + """The test run end time in UTC.""" + duration: Optional[int] = rest_field(visibility=["read"]) + """The test run duration in milliseconds.""" + error_messages: Optional[list[str]] = rest_field(name="errorMessages", visibility=["read"]) + """The list of error messages corresponding to the test run.""" + + +class TestRun(_Model): + """Model of a test run used for tracking purposes. + + :ivar id: The test run ID in GUID format. Required. + :vartype id: str + :ivar display_name: The test run display name. Required. + :vartype display_name: str + :ivar creator_id: The test run creator's ID. Required. + :vartype creator_id: str + :ivar creator_name: The test run creator's name. + :vartype creator_name: str + :ivar config: The test run configuration. + :vartype config: ~azure.developer.playwright.models.RunConfig + :ivar ci_config: The test run CI configuration. + :vartype ci_config: ~azure.developer.playwright.models.CiConfig + :ivar summary: The test run summary. Required. + :vartype summary: ~azure.developer.playwright.models.RunSummary + """ + + id: str = rest_field(visibility=["read"]) + """The test run ID in GUID format. Required.""" + display_name: str = rest_field(name="displayName", visibility=["read", "create", "update"]) + """The test run display name. Required.""" + creator_id: str = rest_field(name="creatorId", visibility=["read"]) + """The test run creator's ID. Required.""" + creator_name: Optional[str] = rest_field(name="creatorName", visibility=["read"]) + """The test run creator's name.""" + config: Optional["_models.RunConfig"] = rest_field(visibility=["read", "create"]) + """The test run configuration.""" + ci_config: Optional["_models.CiConfig"] = rest_field(name="ciConfig", visibility=["read", "create"]) + """The test run CI configuration.""" + summary: "_models.RunSummary" = rest_field(visibility=["read"]) + """The test run summary. Required.""" + + @overload + def __init__( + self, + *, + display_name: str, + config: Optional["_models.RunConfig"] = None, + ci_config: Optional["_models.CiConfig"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class Workspace(_Model): + """Playwright workspace is the parent resource for most of the other service resources. + + :ivar id: The workspace ID in GUID format. Required. + :vartype id: str + :ivar resource_id: The fully-qualified Azure resource id for the workspace. Required. + :vartype resource_id: str + :ivar name: The workspace name. Required. + :vartype name: str + :ivar state: The state of workspace - Active | Inactive. Required. Known values are: "Active" + and "Inactive". + :vartype state: str or ~azure.developer.playwright.models.WorkspaceState + :ivar subscription_id: The Azure subscription id in GUID format for the workspace. Required. + :vartype subscription_id: str + :ivar subscription_state: The Azure subscription state - Registered | Unregistered | Warned | + Suspended | Deleted. Required. Known values are: "Registered", "Warned", "Suspended", + "Deleted", and "Unregistered". + :vartype subscription_state: str or ~azure.developer.playwright.models.SubscriptionState + :ivar tenant_id: The Azure tenant id in GUID format for the workspace. Required. + :vartype tenant_id: str + :ivar location: The workspace resource location in Azure, for eg. eastus, southeastasia. + Required. + :vartype location: str + :ivar regional_affinity: This property sets the connection region for Playwright client workers + to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, + ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which + the workspace was initially created. Known values are: "Enabled" and "Disabled". + :vartype regional_affinity: str or ~azure.developer.playwright.models.EnablementStatus + :ivar local_auth: When enabled, this feature allows the workspace to use local auth (through + service access token) for executing operations. Known values are: "Enabled" and "Disabled". + :vartype local_auth: str or ~azure.developer.playwright.models.EnablementStatus + :ivar storage_uri: When set on Playwright workspace resource, it provides the URI of the Azure + storage account used to store workspace artifacts, test results, and reports. + :vartype storage_uri: str + """ + + id: str = rest_field(visibility=["read"]) + """The workspace ID in GUID format. Required.""" + resource_id: str = rest_field(name="resourceId", visibility=["read"]) + """The fully-qualified Azure resource id for the workspace. Required.""" + name: str = rest_field(visibility=["read"]) + """The workspace name. Required.""" + state: Union[str, "_models.WorkspaceState"] = rest_field(visibility=["read"]) + """The state of workspace - Active | Inactive. Required. Known values are: \"Active\" and + \"Inactive\".""" + subscription_id: str = rest_field(name="subscriptionId", visibility=["read"]) + """The Azure subscription id in GUID format for the workspace. Required.""" + subscription_state: Union[str, "_models.SubscriptionState"] = rest_field( + name="subscriptionState", visibility=["read"] + ) + """The Azure subscription state - Registered | Unregistered | Warned | Suspended | Deleted. + Required. Known values are: \"Registered\", \"Warned\", \"Suspended\", \"Deleted\", and + \"Unregistered\".""" + tenant_id: str = rest_field(name="tenantId", visibility=["read"]) + """The Azure tenant id in GUID format for the workspace. Required.""" + location: str = rest_field(visibility=["read"]) + """The workspace resource location in Azure, for eg. eastus, southeastasia. Required.""" + regional_affinity: Optional[Union[str, "_models.EnablementStatus"]] = rest_field( + name="regionalAffinity", visibility=["read"] + ) + """This property sets the connection region for Playwright client workers to cloud-hosted + browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower + latency. If disabled, workers connect to browsers in the Azure region in which the workspace + was initially created. Known values are: \"Enabled\" and \"Disabled\".""" + local_auth: Optional[Union[str, "_models.EnablementStatus"]] = rest_field(name="localAuth", visibility=["read"]) + """When enabled, this feature allows the workspace to use local auth (through service access + token) for executing operations. Known values are: \"Enabled\" and \"Disabled\".""" + storage_uri: Optional[str] = rest_field(name="storageUri", visibility=["read"]) + """When set on Playwright workspace resource, it provides the URI of the Azure storage account + used to store workspace artifacts, test results, and reports.""" diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/models/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/__init__.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/__init__.py new file mode 100644 index 000000000000..f885cc4296c1 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/__init__.py @@ -0,0 +1,31 @@ +# 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 ._operations import WorkspacesOperations # type: ignore +from ._operations import AccessTokensOperations # type: ignore +from ._operations import TestRunsOperations # type: ignore +from ._operations import BrowserSessionsOperations # type: ignore + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "WorkspacesOperations", + "AccessTokensOperations", + "TestRunsOperations", + "BrowserSessionsOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_operations.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_operations.py new file mode 100644 index 000000000000..17ec850bb3cb --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_operations.py @@ -0,0 +1,1602 @@ +# pylint: disable=too-many-lines +# 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 collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core import PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._configuration import PlaywrightClientConfiguration +from .._utils.model_base import SdkJSONEncoder, _deserialize +from .._utils.serialization import Deserializer, Serializer +from .._validation import api_version_validation + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] +JSON = MutableMapping[str, Any] +List = list + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_workspaces_get_request( + workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_workspaces_get_browsers_request( + workspace_id: str, + *, + os: Union[str, _models.OS], + run_id: Optional[str] = None, + x_ms_useragent: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/browsers" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["os"] = _SERIALIZER.query("os", os, "str") + if run_id is not None: + _params["runId"] = _SERIALIZER.query("run_id", run_id, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_access_tokens_create_or_replace_request( # pylint: disable=name-too-long + workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + "accessTokenId": _SERIALIZER.url("access_token_id", access_token_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_access_tokens_get_request( + workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + "accessTokenId": _SERIALIZER.url("access_token_id", access_token_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_access_tokens_delete_request( + workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + "accessTokenId": _SERIALIZER.url("access_token_id", access_token_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_access_tokens_list_request( + workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/access-tokens" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_runs_create_or_update_request( + workspace_id: str, run_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/test-runs/{runId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + "runId": _SERIALIZER.url("run_id", run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_runs_get_request( + workspace_id: str, run_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/test-runs/{runId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + "runId": _SERIALIZER.url("run_id", run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_runs_list_request( + workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/test-runs" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_browser_sessions_get_request( + workspace_id: str, session_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/browser-sessions/{sessionId}" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + "sessionId": _SERIALIZER.url("session_id", session_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_browser_sessions_list_request( + workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/playwrightworkspaces/{workspaceId}/browser-sessions" + path_format_arguments = { + "workspaceId": _SERIALIZER.url("workspace_id", workspace_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if x_ms_useragent is not None: + _headers["x-ms-useragent"] = _SERIALIZER.header("x_ms_useragent", x_ms_useragent, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +class WorkspacesOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.PlaywrightClient`'s + :attr:`workspaces` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2026-01-01-preview", + params_added_on={ + "2026-01-01-preview": ["api_version", "workspace_id", "client_request_id", "x_ms_useragent", "accept"] + }, + api_versions_list=["2026-01-01-preview", "2026-04-01-preview"], + ) + def get(self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any) -> _models.Workspace: + """Get details of the Azure resource mapped to a workspace for the given workspace id. + Authorization required is Bearer JWT Access token provided by EntraID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: Workspace. The Workspace is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.Workspace + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.Workspace] = kwargs.pop("cls", None) + + _request = build_workspaces_get_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.Workspace, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_browsers( # pylint: disable=inconsistent-return-statements + self, + workspace_id: str, + *, + os: Union[str, _models.OS], + run_id: Optional[str] = None, + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> None: + """Gets remote browsers for the specified workspace ID and redirects the client to execute + Playwright scripts. Requires Bearer JWT access token provided by Entra ID or Playwright + Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword os: The operating system for remote script execution. Known values are: "Linux" and + "Windows". Required. + :paramtype os: str or ~azure.developer.playwright.models.OS + :keyword run_id: The run ID in GUID format. Default value is None. + :paramtype run_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_workspaces_get_browsers_request( + workspace_id=workspace_id, + os=os, + run_id=run_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [302]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["location"] = self._deserialize("str", response.headers.get("location")) + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + +class AccessTokensOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.PlaywrightClient`'s + :attr:`access_tokens` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: _models.AccessToken, + *, + x_ms_useragent: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.developer.playwright.models.AccessToken + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: JSON, + *, + x_ms_useragent: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Required. + :type resource: JSON + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: IO[bytes], + *, + x_ms_useragent: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_replace( + self, + workspace_id: str, + access_token_id: str, + resource: Union[_models.AccessToken, JSON, IO[bytes]], + *, + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.AccessToken: + """Creates an access token for the workspace with the specified access token ID and name. The ID + and name must be unique among active access tokens for the user within a Playwright workspace. + Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :param resource: The resource instance. Is one of the following types: AccessToken, JSON, + IO[bytes] Required. + :type resource: ~azure.developer.playwright.models.AccessToken or JSON or IO[bytes] + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AccessToken] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_access_tokens_create_or_replace_request( + workspace_id=workspace_id, + access_token_id=access_token_id, + x_ms_useragent=x_ms_useragent, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get( + self, workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> _models.AccessToken: + """Gets an access token for the workspace with the specified access token ID. Requires Bearer JWT + access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: AccessToken. The AccessToken is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.AccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AccessToken] = kwargs.pop("cls", None) + + _request = build_access_tokens_get_request( + workspace_id=workspace_id, + access_token_id=access_token_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete( # pylint: disable=inconsistent-return-statements + self, workspace_id: str, access_token_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> None: + """Deletes an access token for the workspace with the specified access token ID. Requires Bearer + JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param access_token_id: The access token ID in GUID format. Required. + :type access_token_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_access_tokens_delete_request( + workspace_id=workspace_id, + access_token_id=access_token_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if cls: + return cls(pipeline_response, None, response_headers) # type: ignore + + @distributed_trace + def list( + self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> ItemPaged["_models.AccessToken"]: + """Lists access tokens for the specified workspace ID. Supports OData query parameters: $select, + $filter, $orderby, $top, and $skip. Default page size is 10. Use nextLink in response to fetch + additional results. Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: An iterator like instance of AccessToken + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.playwright.models.AccessToken] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.AccessToken]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_access_tokens_list_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + List[_models.AccessToken], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + +class TestRunsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.PlaywrightClient`'s + :attr:`test_runs` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: _models.TestRun, + *, + content_type: str = "application/merge-patch+json", + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.developer.playwright.models.TestRun + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: JSON, + *, + content_type: str = "application/merge-patch+json", + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Required. + :type resource: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_update( + self, + workspace_id: str, + run_id: str, + resource: Union[_models.TestRun, JSON, IO[bytes]], + *, + x_ms_useragent: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + """Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer + JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :param resource: The resource instance. Is one of the following types: TestRun, JSON, IO[bytes] + Required. + :type resource: ~azure.developer.playwright.models.TestRun or JSON or IO[bytes] + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_test_runs_create_or_update_request( + workspace_id=workspace_id, + run_id=run_id, + x_ms_useragent=x_ms_useragent, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + @api_version_validation( + method_added_on="2026-04-01-preview", + params_added_on={ + "2026-04-01-preview": [ + "api_version", + "workspace_id", + "run_id", + "client_request_id", + "x_ms_useragent", + "accept", + ] + }, + api_versions_list=["2026-04-01-preview"], + ) + def get( + self, workspace_id: str, run_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> _models.TestRun: + """Gets a test run for the specified run and workspace ID. Requires Bearer JWT access token + provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param run_id: The test run ID in GUID format. Required. + :type run_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_test_runs_get_request( + workspace_id=workspace_id, + run_id=run_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list( + self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> ItemPaged["_models.TestRun"]: + """Lists test runs for the specified workspace ID. Supports OData query parameters such as $filter + and $top. Default page size is 10. Use nextLink in response to fetch additional results. + Requires Bearer JWT access token provided by Entra ID or Playwright Service. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: An iterator like instance of TestRun + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.playwright.models.TestRun] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.TestRun]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_test_runs_list_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + List[_models.TestRun], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + +class BrowserSessionsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.playwright.PlaywrightClient`'s + :attr:`browser_sessions` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: PlaywrightClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + @api_version_validation( + method_added_on="2026-04-01-preview", + params_added_on={ + "2026-04-01-preview": [ + "api_version", + "workspace_id", + "session_id", + "client_request_id", + "x_ms_useragent", + "accept", + ] + }, + api_versions_list=["2026-04-01-preview"], + ) + def get( + self, workspace_id: str, session_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> _models.BrowserSession: + """Get a browser session for the specified session and workspace ID. Requires Bearer JWT access + token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :param session_id: The browser session ID in GUID format. Required. + :type session_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: BrowserSession. The BrowserSession is compatible with MutableMapping + :rtype: ~azure.developer.playwright.models.BrowserSession + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.BrowserSession] = kwargs.pop("cls", None) + + _request = build_browser_sessions_get_request( + workspace_id=workspace_id, + session_id=session_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.BrowserSession, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + @api_version_validation( + method_added_on="2026-04-01-preview", + params_added_on={ + "2026-04-01-preview": ["api_version", "workspace_id", "client_request_id", "x_ms_useragent", "accept"] + }, + api_versions_list=["2026-04-01-preview"], + ) + def list( + self, workspace_id: str, *, x_ms_useragent: Optional[str] = None, **kwargs: Any + ) -> ItemPaged["_models.BrowserSession"]: + """Lists browser sessions for the specified workspace ID. Supports OData query parameters such as + $filter and $top. Default page size is 10. Use nextLink in response to fetch additional + results. Requires Bearer JWT access token provided by Entra ID. + + :param workspace_id: The workspace ID in GUID format. Required. + :type workspace_id: str + :keyword x_ms_useragent: Optional header to specify additional client information when the + standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. + The value should follow the standard 'User-Agent' header format. Default value is None. + :paramtype x_ms_useragent: str + :return: An iterator like instance of BrowserSession + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.playwright.models.BrowserSession] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.BrowserSession]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_browser_sessions_list_request( + workspace_id=workspace_id, + x_ms_useragent=x_ms_useragent, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + List[_models.BrowserSession], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/py.typed b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/playwright/azure-developer-playwright/dev_requirements.txt b/sdk/playwright/azure-developer-playwright/dev_requirements.txt new file mode 100644 index 000000000000..0e53b6a72db5 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/dev_requirements.txt @@ -0,0 +1,3 @@ +-e ../../../eng/tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_create_or_replace.py b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_create_or_replace.py new file mode 100644 index 000000000000..c3feb81fc7bb --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_create_or_replace.py @@ -0,0 +1,35 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python access_tokens_create_or_replace.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.access_tokens.create_or_replace( + workspace_id="00000000-0000-0000-0000-000000000000", + access_token_id="00000000-0000-0000-0000-000000000000", + resource={"expiryAt": "2022-09-28T12:32:33Z", "name": "sampleAccessToken"}, + ) + print(response) + + +# x-ms-original-file: 2026-04-01-preview/AccessTokens_CreateOrReplace.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_delete.py b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_delete.py new file mode 100644 index 000000000000..c6e64916684f --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_delete.py @@ -0,0 +1,33 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python access_tokens_delete.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + client.access_tokens.delete( + workspace_id="00000000-0000-0000-0000-000000000000", + access_token_id="00000000-0000-0000-0000-000000000000", + ) + + +# x-ms-original-file: 2026-04-01-preview/AccessTokens_Delete.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_get.py b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_get.py new file mode 100644 index 000000000000..474cb80e11e9 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_get.py @@ -0,0 +1,34 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python access_tokens_get.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.access_tokens.get( + workspace_id="00000000-0000-0000-0000-000000000000", + access_token_id="00000000-0000-0000-0000-000000000000", + ) + print(response) + + +# x-ms-original-file: 2026-04-01-preview/AccessTokens_Get.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_list.py b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_list.py new file mode 100644 index 000000000000..208bca86dc07 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/access_tokens_list.py @@ -0,0 +1,34 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python access_tokens_list.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.access_tokens.list( + workspace_id="00000000-0000-0000-0000-000000000000", + ) + for item in response: + print(item) + + +# x-ms-original-file: 2026-04-01-preview/AccessTokens_List.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_get.py b/sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_get.py new file mode 100644 index 000000000000..4b3435c3f99f --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_get.py @@ -0,0 +1,34 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python browser_sessions_get.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.browser_sessions.get( + workspace_id="00000000-0000-0000-0000-000000000000", + session_id="00000000-0000-0000-0000-000000000000", + ) + print(response) + + +# x-ms-original-file: 2026-04-01-preview/BrowserSessions_Get.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_list.py b/sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_list.py new file mode 100644 index 000000000000..b5c5e262c6c8 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/browser_sessions_list.py @@ -0,0 +1,34 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python browser_sessions_list.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.browser_sessions.list( + workspace_id="00000000-0000-0000-0000-000000000000", + ) + for item in response: + print(item) + + +# x-ms-original-file: 2026-04-01-preview/BrowserSessions_List.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_create_or_update.py b/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_create_or_update.py new file mode 100644 index 000000000000..1833eeb4f343 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_create_or_update.py @@ -0,0 +1,35 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python test_runs_create_or_update.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.test_runs.create_or_update( + workspace_id="00000000-0000-0000-0000-000000000000", + run_id="00000000-0000-0000-0000-000000000000", + resource={"displayName": "sampleTestRun"}, + ) + print(response) + + +# x-ms-original-file: 2026-04-01-preview/TestRuns_CreateOrUpdate.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_get.py b/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_get.py new file mode 100644 index 000000000000..378c09b70957 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_get.py @@ -0,0 +1,34 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python test_runs_get.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.test_runs.get( + workspace_id="00000000-0000-0000-0000-000000000000", + run_id="00000000-0000-0000-0000-000000000000", + ) + print(response) + + +# x-ms-original-file: 2026-04-01-preview/TestRuns_Get.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_list.py b/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_list.py new file mode 100644 index 000000000000..9991af983988 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/test_runs_list.py @@ -0,0 +1,34 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python test_runs_list.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.test_runs.list( + workspace_id="00000000-0000-0000-0000-000000000000", + ) + for item in response: + print(item) + + +# x-ms-original-file: 2026-04-01-preview/TestRuns_List.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get.py b/sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get.py new file mode 100644 index 000000000000..69957e794901 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get.py @@ -0,0 +1,33 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python workspaces_get.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.workspaces.get( + workspace_id="00000000-0000-0000-0000-000000000000", + ) + print(response) + + +# x-ms-original-file: 2026-04-01-preview/Workspaces_Get.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get_browsers.py b/sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get_browsers.py new file mode 100644 index 000000000000..65c443411190 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_samples/workspaces_get_browsers.py @@ -0,0 +1,33 @@ +# 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 azure.developer.playwright import PlaywrightClient + +""" +# PREREQUISITES + pip install azure-developer-playwright +# USAGE + python workspaces_get_browsers.py +""" + + +def main(): + client = PlaywrightClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + client.workspaces.get_browsers( + workspace_id="00000000-0000-0000-0000-000000000000", + os="Linux", + ) + + +# x-ms-original-file: 2026-04-01-preview/Workspaces_GetBrowsers.json +if __name__ == "__main__": + main() diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/conftest.py b/sdk/playwright/azure-developer-playwright/generated_tests/conftest.py new file mode 100644 index 000000000000..c47e0b5f30aa --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/conftest.py @@ -0,0 +1,35 @@ +# 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. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) + +load_dotenv() + + +# For security, please avoid record sensitive identity information in recordings +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + playwright_subscription_id = os.environ.get("PLAYWRIGHT_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") + playwright_tenant_id = os.environ.get("PLAYWRIGHT_TENANT_ID", "00000000-0000-0000-0000-000000000000") + playwright_client_id = os.environ.get("PLAYWRIGHT_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + playwright_client_secret = os.environ.get("PLAYWRIGHT_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=playwright_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=playwright_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=playwright_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=playwright_client_secret, value="00000000-0000-0000-0000-000000000000") + + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py new file mode 100644 index 000000000000..14533f821156 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py @@ -0,0 +1,68 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightAccessTokensOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_create_or_replace(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.access_tokens.create_or_replace( + workspace_id="str", + access_token_id="str", + resource={ + "createdAt": "2020-02-20 00:00:00", + "expiryAt": "2020-02-20 00:00:00", + "id": "str", + "name": "str", + "state": "str", + "jwtToken": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_get(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.access_tokens.get( + workspace_id="str", + access_token_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_delete(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.access_tokens.delete( + workspace_id="str", + access_token_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_list(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.access_tokens.list( + workspace_id="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py new file mode 100644 index 000000000000..eb4e9aa47d74 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py @@ -0,0 +1,69 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightAccessTokensOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_create_or_replace(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.access_tokens.create_or_replace( + workspace_id="str", + access_token_id="str", + resource={ + "createdAt": "2020-02-20 00:00:00", + "expiryAt": "2020-02-20 00:00:00", + "id": "str", + "name": "str", + "state": "str", + "jwtToken": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_get(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.access_tokens.get( + workspace_id="str", + access_token_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_delete(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.access_tokens.delete( + workspace_id="str", + access_token_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_list(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = client.access_tokens.list( + workspace_id="str", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py new file mode 100644 index 000000000000..0f13c0890fee --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py @@ -0,0 +1,36 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightBrowserSessionsOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_browser_sessions_get(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.browser_sessions.get( + workspace_id="str", + session_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_browser_sessions_list(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.browser_sessions.list( + workspace_id="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py new file mode 100644 index 000000000000..bd06026fbdf4 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py @@ -0,0 +1,37 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightBrowserSessionsOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_browser_sessions_get(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.browser_sessions.get( + workspace_id="str", + session_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_browser_sessions_list(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = client.browser_sessions.list( + workspace_id="str", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py new file mode 100644 index 000000000000..de17efda0d2a --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py @@ -0,0 +1,76 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightTestRunsOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_test_runs_create_or_update(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.test_runs.create_or_update( + workspace_id="str", + run_id="str", + resource={ + "creatorId": "str", + "displayName": "str", + "id": "str", + "summary": { + "startTime": "2020-02-20 00:00:00", + "status": "str", + "billableTime": 0, + "duration": 0, + "endTime": "2020-02-20 00:00:00", + "errorMessages": ["str"], + "maxConcurrentBrowserSessions": 0, + "numBrowserSessions": 0, + }, + "ciConfig": { + "author": "str", + "branch": "str", + "commitId": "str", + "providerName": "str", + "revisionUrl": "str", + }, + "config": { + "framework": {"name": "str", "runnerName": "str", "version": "str"}, + "maxWorkers": 0, + "sdkLanguage": "str", + }, + "creatorName": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_test_runs_get(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.test_runs.get( + workspace_id="str", + run_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_test_runs_list(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.test_runs.list( + workspace_id="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py new file mode 100644 index 000000000000..4ff3c1a4803d --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py @@ -0,0 +1,77 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightTestRunsOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_test_runs_create_or_update(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.test_runs.create_or_update( + workspace_id="str", + run_id="str", + resource={ + "creatorId": "str", + "displayName": "str", + "id": "str", + "summary": { + "startTime": "2020-02-20 00:00:00", + "status": "str", + "billableTime": 0, + "duration": 0, + "endTime": "2020-02-20 00:00:00", + "errorMessages": ["str"], + "maxConcurrentBrowserSessions": 0, + "numBrowserSessions": 0, + }, + "ciConfig": { + "author": "str", + "branch": "str", + "commitId": "str", + "providerName": "str", + "revisionUrl": "str", + }, + "config": { + "framework": {"name": "str", "runnerName": "str", "version": "str"}, + "maxWorkers": 0, + "sdkLanguage": "str", + }, + "creatorName": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_test_runs_get(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.test_runs.get( + workspace_id="str", + run_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_test_runs_list(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = client.test_runs.list( + workspace_id="str", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py new file mode 100644 index 000000000000..e8036345410a --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py @@ -0,0 +1,36 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightWorkspacesOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_workspaces_get(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.workspaces.get( + workspace_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy + def test_workspaces_get_browsers(self, playwright_endpoint): + client = self.create_client(endpoint=playwright_endpoint) + response = client.workspaces.get_browsers( + workspace_id="str", + os="str", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py new file mode 100644 index 000000000000..5febbc12ee2c --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py @@ -0,0 +1,37 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestPlaywrightWorkspacesOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_workspaces_get(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.workspaces.get( + workspace_id="str", + ) + + # please add some check logic here by yourself + # ... + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_workspaces_get_browsers(self, playwright_endpoint): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.workspaces.get_browsers( + workspace_id="str", + os="str", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py b/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py new file mode 100644 index 000000000000..1a47c3a001bc --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py @@ -0,0 +1,26 @@ +# 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 azure.developer.playwright import PlaywrightClient +from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer +import functools + + +class PlaywrightClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(PlaywrightClient) + return self.create_client_from_credential( + PlaywrightClient, + credential=credential, + endpoint=endpoint, + ) + + +PlaywrightPreparer = functools.partial( + PowerShellPreparer, "playwright", playwright_endpoint="https://fake_playwright_endpoint.com" +) diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py new file mode 100644 index 000000000000..0d3153c42c07 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py @@ -0,0 +1,20 @@ +# 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 azure.developer.playwright.aio import PlaywrightClient +from devtools_testutils import AzureRecordedTestCase + + +class PlaywrightClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(PlaywrightClient, is_async=True) + return self.create_client_from_credential( + PlaywrightClient, + credential=credential, + endpoint=endpoint, + ) diff --git a/sdk/playwright/azure-developer-playwright/pyproject.toml b/sdk/playwright/azure-developer-playwright/pyproject.toml new file mode 100644 index 000000000000..0eebfc86b934 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/pyproject.toml @@ -0,0 +1,61 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- + +[build-system] +requires = ["setuptools>=77.0.3", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-developer-playwright" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Developer Playwright Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", +] +requires-python = ">=3.9" +keywords = ["azure", "azure sdk"] + +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.37.0", + "typing-extensions>=4.6.0", +] +dynamic = [ +"version", "readme" +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic] +version = {attr = "azure.developer.playwright._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.developer", +] + +[tool.setuptools.package-data] +pytyped = ["py.typed"] diff --git a/sdk/playwright/azure-developer-playwright/tsp-location.yaml b/sdk/playwright/azure-developer-playwright/tsp-location.yaml new file mode 100644 index 000000000000..201e5f1424a5 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/loadtestservice/data-plane/playwright +commit: c2ad70ba448340ebd36b5e626d9566d9fdd060b8 +repo: Azure/azure-rest-api-specs +additionalDirectories: From 2a560c3603044122a1515aed9812cedd79e47ba8 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Wed, 1 Apr 2026 21:12:53 +0000 Subject: [PATCH 2/9] Adding custom code --- .../azure/developer/playwright/_patch.py | 20 ++++- .../azure/developer/playwright/aio/_patch.py | 20 ++++- .../playwright/aio/operations/_patch.py | 49 +++++++++++- .../developer/playwright/operations/_patch.py | 78 ++++++++++++++++++- 4 files changed, 163 insertions(+), 4 deletions(-) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py index 87676c65a8f0..65400c2009ac 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py @@ -7,9 +7,27 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, TYPE_CHECKING +from ._client import PlaywrightClient as _GeneratedPlaywrightClient -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class PlaywrightClient(_GeneratedPlaywrightClient): + """Customized PlaywrightClient with correct credential scope. + + The generated scope (playwright.microsoft.com) is incorrect due to a + spec bug. This override sets the working scope until the spec is fixed. + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + kwargs.setdefault("credential_scopes", ["https://management.core.windows.net/.default"]) + super().__init__(endpoint, credential, **kwargs) + + +__all__: list[str] = ["PlaywrightClient"] def patch_sdk(): diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py index 87676c65a8f0..f1d1cdf509c5 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py @@ -7,9 +7,27 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, TYPE_CHECKING +from ._client import PlaywrightClient as _GeneratedPlaywrightClient -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class PlaywrightClient(_GeneratedPlaywrightClient): + """Customized PlaywrightClient with correct credential scope. + + The generated scope (playwright.microsoft.com) is incorrect due to a + spec bug. This override sets the working scope until the spec is fixed. + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + kwargs.setdefault("credential_scopes", ["https://management.core.windows.net/.default"]) + super().__init__(endpoint, credential, **kwargs) + + +__all__: list[str] = ["PlaywrightClient"] def patch_sdk(): diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py index 87676c65a8f0..cf2de4512459 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py @@ -7,9 +7,56 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, Optional, Union +from ._operations import TestRunsOperations as _GeneratedTestRunsOperations +from ._operations import WorkspacesOperations as _GeneratedWorkspacesOperations +from ... import models as _models +from ...operations._patch import _ReportingEndpointConfig -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + +class WorkspacesOperations(_GeneratedWorkspacesOperations): + """Customized WorkspacesOperations with redirect handling fix for get_browsers. + + The get_browsers endpoint returns a 302 redirect to a WebSocket URL. + We disable automatic redirect following so the caller receives the + 302 response with the location header instead of the pipeline + attempting to follow the redirect (which fails due to auth policy + rejecting non-HTTPS targets). + """ + + async def get_browsers( + self, + workspace_id: str, + *, + os: Union[str, _models.OS], + run_id: Optional[str] = None, + x_ms_useragent: Optional[str] = None, + **kwargs: Any, + ) -> None: + kwargs.setdefault("permit_redirects", False) + return await super().get_browsers(workspace_id, os=os, run_id=run_id, x_ms_useragent=x_ms_useragent, **kwargs) + + +class TestRunsOperations(_GeneratedTestRunsOperations): + """Customized TestRunsOperations that routes requests to the reporting subdomain. + + The test-runs API is served from a different subdomain + (*.reporting.api.playwright.microsoft.com) than the main API + (*.api.playwright.microsoft.com). This override wraps the shared + config with a proxy that returns the reporting endpoint, without + copying or mutating the original config object. + """ + + def __init__(self, *args, **kwargs) -> None: + super().__init__(*args, **kwargs) + self._config = _ReportingEndpointConfig(self._config) + + +__all__: list[str] = [ + "WorkspacesOperations", + "TestRunsOperations", +] def patch_sdk(): diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py index 87676c65a8f0..182151e7b2f3 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py @@ -7,9 +7,85 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, Optional, Union +from ._operations import TestRunsOperations as _GeneratedTestRunsOperations +from ._operations import WorkspacesOperations as _GeneratedWorkspacesOperations +from .. import models as _models -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + +def _to_reporting_endpoint(endpoint: str) -> str: + """Derive the reporting API endpoint from the base service endpoint. + + The test-runs API is served from the reporting subdomain + (e.g. https://{region}.reporting.api.playwright.microsoft.com) while + all other operations use the base subdomain + (e.g. https://{region}.api.playwright.microsoft.com). + """ + return endpoint.replace(".api.playwright.", ".reporting.api.playwright.") + + +class _ReportingEndpointConfig: + """Lightweight proxy that delegates all attribute access to the original + config but returns the reporting subdomain for ``endpoint``. + + This avoids copying or mutating the shared config object. + """ + + def __init__(self, config): + object.__setattr__(self, "_inner", config) + object.__setattr__(self, "_reporting_endpoint", _to_reporting_endpoint(config.endpoint)) + + @property + def endpoint(self) -> str: # type: ignore[override] + return object.__getattribute__(self, "_reporting_endpoint") + + def __getattr__(self, name): + return getattr(object.__getattribute__(self, "_inner"), name) + + +class WorkspacesOperations(_GeneratedWorkspacesOperations): + """Customized WorkspacesOperations with redirect handling fix for get_browsers. + + The get_browsers endpoint returns a 302 redirect to a WebSocket URL. + We disable automatic redirect following so the caller receives the + 302 response with the location header instead of the pipeline + attempting to follow the redirect (which fails due to auth policy + rejecting non-HTTPS targets). + """ + + def get_browsers( + self, + workspace_id: str, + *, + os: Union[str, _models.OS], + run_id: Optional[str] = None, + x_ms_useragent: Optional[str] = None, + **kwargs: Any, + ) -> None: + kwargs.setdefault("permit_redirects", False) + return super().get_browsers(workspace_id, os=os, run_id=run_id, x_ms_useragent=x_ms_useragent, **kwargs) + + +class TestRunsOperations(_GeneratedTestRunsOperations): + """Customized TestRunsOperations that routes requests to the reporting subdomain. + + The test-runs API is served from a different subdomain + (*.reporting.api.playwright.microsoft.com) than the main API + (*.api.playwright.microsoft.com). This override wraps the shared + config with a proxy that returns the reporting endpoint, without + copying or mutating the original config object. + """ + + def __init__(self, *args, **kwargs) -> None: + super().__init__(*args, **kwargs) + self._config = _ReportingEndpointConfig(self._config) + + +__all__: list[str] = [ + "WorkspacesOperations", + "TestRunsOperations", +] def patch_sdk(): From 2e359b09c312edee6bae692f33f6d71d44e21d75 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Wed, 1 Apr 2026 21:18:26 +0000 Subject: [PATCH 3/9] Adding test cases --- .../tests/conftest.py | 62 ++++++++++ ...est_playwright_access_tokens_operations.py | 109 +++++++++++++++++ ...aywright_access_tokens_operations_async.py | 110 ++++++++++++++++++ ..._playwright_browser_sessions_operations.py | 21 ++++ ...right_browser_sessions_operations_async.py | 22 ++++ .../test_playwright_test_runs_operations.py | 66 +++++++++++ ...t_playwright_test_runs_operations_async.py | 67 +++++++++++ .../test_playwright_workspaces_operations.py | 32 +++++ ..._playwright_workspaces_operations_async.py | 33 ++++++ .../tests/testpreparer.py | 28 +++++ .../tests/testpreparer_async.py | 18 +++ 11 files changed, 568 insertions(+) create mode 100644 sdk/playwright/azure-developer-playwright/tests/conftest.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/testpreparer.py create mode 100644 sdk/playwright/azure-developer-playwright/tests/testpreparer_async.py diff --git a/sdk/playwright/azure-developer-playwright/tests/conftest.py b/sdk/playwright/azure-developer-playwright/tests/conftest.py new file mode 100644 index 000000000000..5388773bed6a --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/conftest.py @@ -0,0 +1,62 @@ +# 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. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv + +load_dotenv() + +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_general_string_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, + remove_batch_sanitizers, + set_custom_default_matcher, +) + + +@pytest.fixture(scope="session", autouse=True) +def start_proxy(test_proxy, patch_sleep, patch_async_sleep): + set_custom_default_matcher(excluded_headers="Cookie") + return + + +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + # Sanitize subscription ID + playwright_subscription_id = os.environ.get("PLAYWRIGHT_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=playwright_subscription_id, value="00000000-0000-0000-0000-000000000000") + + # Sanitize endpoint (both https:// and http:// variants for @odata.context) + playwright_endpoint = os.environ.get("PLAYWRIGHT_ENDPOINT", "") + if playwright_endpoint: + # Extract hostname for protocol-agnostic sanitization + hostname = playwright_endpoint.replace("https://", "").replace("http://", "") + reporting_hostname = hostname.replace(".api.playwright.", ".reporting.api.playwright.") + + # Sanitize reporting subdomain first (longer match) to avoid partial matches + add_general_string_sanitizer( + target=reporting_hostname, + value="fake.reporting.api.playwright.microsoft.com", + ) + add_general_string_sanitizer(target=hostname, value="fake.api.playwright.microsoft.com") + + # Sanitize workspace ID + playwright_workspace_id = os.environ.get("PLAYWRIGHT_WORKSPACE_ID", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=playwright_workspace_id, value="00000000-0000-0000-0000-000000000000") + + # Sanitize cookies and tokens + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") + add_body_key_sanitizer(json_path="$..jwtToken", value="sanitized") + add_body_key_sanitizer(json_path="$..creatorId", value="00000000-0000-0000-0000-000000000000") + add_body_key_sanitizer(json_path="$..creatorName", value="Sanitized") + + # Remove overly aggressive default sanitizers for $..id and $..name + remove_batch_sanitizers(["AZSDK3430", "AZSDK3493"]) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations.py new file mode 100644 index 000000000000..a711e469b33d --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations.py @@ -0,0 +1,109 @@ +# 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. +# -------------------------------------------------------------------------- +import uuid +from datetime import datetime, timedelta, timezone + +import pytest +from devtools_testutils import recorded_by_proxy + +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +class TestPlaywrightAccessTokensOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_create_or_replace(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + token_id = variables.setdefault("token_id", str(uuid.uuid4())) + suffix = variables.setdefault("suffix", uuid.uuid4().hex[:4]) + expiry = variables.setdefault( + "expiry", (datetime.now(timezone.utc) + timedelta(days=180)).strftime("%Y-%m-%dT%H:%M:%SZ") + ) + + client = self.create_client(endpoint=playwright_endpoint) + response = client.access_tokens.create_or_replace( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + resource={ + "name": f"tk-c-{suffix}", + "expiryAt": expiry, + }, + ) + + assert response is not None + assert response["name"] == f"tk-c-{suffix}" + assert "id" in response + assert "state" in response + assert "createdAt" in response + assert "expiryAt" in response + return variables + + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_get(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + token_id = variables.setdefault("token_id", str(uuid.uuid4())) + suffix = variables.setdefault("suffix", uuid.uuid4().hex[:4]) + expiry = variables.setdefault( + "expiry", (datetime.now(timezone.utc) + timedelta(days=180)).strftime("%Y-%m-%dT%H:%M:%SZ") + ) + + client = self.create_client(endpoint=playwright_endpoint) + client.access_tokens.create_or_replace( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + resource={ + "name": f"tk-g-{suffix}", + "expiryAt": expiry, + }, + ) + + response = client.access_tokens.get( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + ) + + assert response is not None + assert response["name"] == f"tk-g-{suffix}" + assert response["id"] is not None + return variables + + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_delete(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + token_id = variables.setdefault("token_id", str(uuid.uuid4())) + suffix = variables.setdefault("suffix", uuid.uuid4().hex[:4]) + expiry = variables.setdefault( + "expiry", (datetime.now(timezone.utc) + timedelta(days=180)).strftime("%Y-%m-%dT%H:%M:%SZ") + ) + + client = self.create_client(endpoint=playwright_endpoint) + client.access_tokens.create_or_replace( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + resource={ + "name": f"tk-d-{suffix}", + "expiryAt": expiry, + }, + ) + + response = client.access_tokens.delete( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + ) + assert response is None + return variables + + @PlaywrightPreparer() + @recorded_by_proxy + def test_access_tokens_list(self, playwright_endpoint, playwright_workspace_id): + client = self.create_client(endpoint=playwright_endpoint) + response = client.access_tokens.list( + workspace_id=playwright_workspace_id, + ) + result = [r for r in response] + assert isinstance(result, list) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations_async.py new file mode 100644 index 000000000000..a89f16f09bbe --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_access_tokens_operations_async.py @@ -0,0 +1,110 @@ +# 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. +# -------------------------------------------------------------------------- +import uuid +from datetime import datetime, timedelta, timezone + +import pytest +from devtools_testutils.aio import recorded_by_proxy_async + +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +class TestPlaywrightAccessTokensOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_create_or_replace(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + token_id = variables.setdefault("token_id", str(uuid.uuid4())) + suffix = variables.setdefault("suffix", uuid.uuid4().hex[:4]) + expiry = variables.setdefault( + "expiry", (datetime.now(timezone.utc) + timedelta(days=180)).strftime("%Y-%m-%dT%H:%M:%SZ") + ) + + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.access_tokens.create_or_replace( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + resource={ + "name": f"tk-c-{suffix}", + "expiryAt": expiry, + }, + ) + + assert response is not None + assert response["name"] == f"tk-c-{suffix}" + assert "id" in response + assert "state" in response + assert "createdAt" in response + assert "expiryAt" in response + return variables + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_get(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + token_id = variables.setdefault("token_id", str(uuid.uuid4())) + suffix = variables.setdefault("suffix", uuid.uuid4().hex[:4]) + expiry = variables.setdefault( + "expiry", (datetime.now(timezone.utc) + timedelta(days=180)).strftime("%Y-%m-%dT%H:%M:%SZ") + ) + + client = self.create_async_client(endpoint=playwright_endpoint) + await client.access_tokens.create_or_replace( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + resource={ + "name": f"tk-g-{suffix}", + "expiryAt": expiry, + }, + ) + + response = await client.access_tokens.get( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + ) + + assert response is not None + assert response["name"] == f"tk-g-{suffix}" + assert response["id"] is not None + return variables + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_delete(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + token_id = variables.setdefault("token_id", str(uuid.uuid4())) + suffix = variables.setdefault("suffix", uuid.uuid4().hex[:4]) + expiry = variables.setdefault( + "expiry", (datetime.now(timezone.utc) + timedelta(days=180)).strftime("%Y-%m-%dT%H:%M:%SZ") + ) + + client = self.create_async_client(endpoint=playwright_endpoint) + await client.access_tokens.create_or_replace( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + resource={ + "name": f"tk-d-{suffix}", + "expiryAt": expiry, + }, + ) + + response = await client.access_tokens.delete( + workspace_id=playwright_workspace_id, + access_token_id=token_id, + ) + assert response is None + return variables + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_access_tokens_list(self, playwright_endpoint, playwright_workspace_id): + client = self.create_async_client(endpoint=playwright_endpoint) + response = client.access_tokens.list( + workspace_id=playwright_workspace_id, + ) + result = [r async for r in response] + assert isinstance(result, list) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py new file mode 100644 index 000000000000..ea929de70186 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy + +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +class TestPlaywrightBrowserSessionsOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_browser_sessions_list(self, playwright_endpoint, playwright_workspace_id): + client = self.create_client(endpoint=playwright_endpoint) + response = client.browser_sessions.list( + workspace_id=playwright_workspace_id, + ) + result = [r for r in response] + assert isinstance(result, list) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py new file mode 100644 index 000000000000..2dcff1602277 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py @@ -0,0 +1,22 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async + +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +class TestPlaywrightBrowserSessionsOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_browser_sessions_list(self, playwright_endpoint, playwright_workspace_id): + client = self.create_async_client(endpoint=playwright_endpoint) + response = client.browser_sessions.list( + workspace_id=playwright_workspace_id, + ) + result = [r async for r in response] + assert isinstance(result, list) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations.py new file mode 100644 index 000000000000..985843ae25f4 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations.py @@ -0,0 +1,66 @@ +# 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. +# -------------------------------------------------------------------------- +import uuid + +import pytest +from devtools_testutils import recorded_by_proxy + +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +class TestPlaywrightTestRunsOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_test_runs_create_or_update(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + run_id = variables.setdefault("run_id", str(uuid.uuid4())) + + client = self.create_client(endpoint=playwright_endpoint) + response = client.test_runs.create_or_update( + workspace_id=playwright_workspace_id, + run_id=run_id, + resource={ + "displayName": "test-run", + }, + ) + + assert response is not None + assert response["displayName"] == "test-run" + assert "runId" in response + assert "creatorId" in response + return variables + + @PlaywrightPreparer() + @recorded_by_proxy + def test_test_runs_get(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + run_id = variables.setdefault("run_id", str(uuid.uuid4())) + + client = self.create_client(endpoint=playwright_endpoint) + # Create a run first so we can get it + client.test_runs.create_or_update( + workspace_id=playwright_workspace_id, + run_id=run_id, + resource={"displayName": "test-run-for-get"}, + ) + response = client.test_runs.get( + workspace_id=playwright_workspace_id, + run_id=run_id, + ) + assert response is not None + assert "runId" in response + assert response["displayName"] == "test-run-for-get" + return variables + + @PlaywrightPreparer() + @recorded_by_proxy + def test_test_runs_list(self, playwright_endpoint, playwright_workspace_id): + client = self.create_client(endpoint=playwright_endpoint) + response = client.test_runs.list( + workspace_id=playwright_workspace_id, + ) + result = [r for r in response] + assert isinstance(result, list) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations_async.py new file mode 100644 index 000000000000..f8dd3af896b9 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_test_runs_operations_async.py @@ -0,0 +1,67 @@ +# 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. +# -------------------------------------------------------------------------- +import uuid + +import pytest +from devtools_testutils.aio import recorded_by_proxy_async + +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +class TestPlaywrightTestRunsOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_test_runs_create_or_update(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + run_id = variables.setdefault("run_id", str(uuid.uuid4())) + + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.test_runs.create_or_update( + workspace_id=playwright_workspace_id, + run_id=run_id, + resource={ + "displayName": "test-run", + }, + ) + + assert response is not None + assert response["displayName"] == "test-run" + assert "runId" in response + assert "creatorId" in response + return variables + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_test_runs_get(self, playwright_endpoint, playwright_workspace_id, **kwargs): + variables = kwargs.pop("variables", {}) + run_id = variables.setdefault("run_id", str(uuid.uuid4())) + + client = self.create_async_client(endpoint=playwright_endpoint) + # Create a run first so we can get it + await client.test_runs.create_or_update( + workspace_id=playwright_workspace_id, + run_id=run_id, + resource={"displayName": "test-run-for-get"}, + ) + response = await client.test_runs.get( + workspace_id=playwright_workspace_id, + run_id=run_id, + ) + assert response is not None + assert "runId" in response + assert response["displayName"] == "test-run-for-get" + return variables + + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_test_runs_list(self, playwright_endpoint, playwright_workspace_id): + client = self.create_async_client(endpoint=playwright_endpoint) + response = client.test_runs.list( + workspace_id=playwright_workspace_id, + ) + result = [r async for r in response] + assert isinstance(result, list) diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py new file mode 100644 index 000000000000..d2bb8797f818 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy + +from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer + + +class TestPlaywrightWorkspacesOperations(PlaywrightClientTestBase): + @PlaywrightPreparer() + @recorded_by_proxy + def test_workspaces_get(self, playwright_endpoint, playwright_workspace_id): + client = self.create_client(endpoint=playwright_endpoint) + response = client.workspaces.get( + workspace_id=playwright_workspace_id, + ) + assert response is not None + assert "workspaceId" in response + + @pytest.mark.live_test_only + @PlaywrightPreparer() + @recorded_by_proxy + def test_workspaces_get_browsers(self, playwright_endpoint, playwright_workspace_id): + client = self.create_client(endpoint=playwright_endpoint) + response = client.workspaces.get_browsers( + workspace_id=playwright_workspace_id, + os="Linux", + ) + assert response is None diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py new file mode 100644 index 000000000000..40e0f415ed9f --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py @@ -0,0 +1,33 @@ +# 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. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async + +from testpreparer import PlaywrightPreparer +from testpreparer_async import PlaywrightClientTestBaseAsync + + +class TestPlaywrightWorkspacesOperationsAsync(PlaywrightClientTestBaseAsync): + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_workspaces_get(self, playwright_endpoint, playwright_workspace_id): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.workspaces.get( + workspace_id=playwright_workspace_id, + ) + assert response is not None + assert "workspaceId" in response + + @pytest.mark.live_test_only + @PlaywrightPreparer() + @recorded_by_proxy_async + async def test_workspaces_get_browsers(self, playwright_endpoint, playwright_workspace_id): + client = self.create_async_client(endpoint=playwright_endpoint) + response = await client.workspaces.get_browsers( + workspace_id=playwright_workspace_id, + os="Linux", + ) + assert response is None diff --git a/sdk/playwright/azure-developer-playwright/tests/testpreparer.py b/sdk/playwright/azure-developer-playwright/tests/testpreparer.py new file mode 100644 index 000000000000..81f3ac849ce2 --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/testpreparer.py @@ -0,0 +1,28 @@ +# 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. +# -------------------------------------------------------------------------- +import functools + +from azure.developer.playwright import PlaywrightClient +from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer + + +class PlaywrightClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(PlaywrightClient) + return self.create_client_from_credential( + PlaywrightClient, + credential=credential, + endpoint=endpoint, + ) + + +PlaywrightPreparer = functools.partial( + PowerShellPreparer, + "playwright", + playwright_endpoint="https://fake.api.playwright.microsoft.com", + playwright_workspace_id="00000000-0000-0000-0000-000000000000", +) diff --git a/sdk/playwright/azure-developer-playwright/tests/testpreparer_async.py b/sdk/playwright/azure-developer-playwright/tests/testpreparer_async.py new file mode 100644 index 000000000000..7fa18ae4f9dd --- /dev/null +++ b/sdk/playwright/azure-developer-playwright/tests/testpreparer_async.py @@ -0,0 +1,18 @@ +# 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. +# -------------------------------------------------------------------------- +from azure.developer.playwright.aio import PlaywrightClient +from devtools_testutils import AzureRecordedTestCase + + +class PlaywrightClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(PlaywrightClient, is_async=True) + return self.create_client_from_credential( + PlaywrightClient, + credential=credential, + endpoint=endpoint, + ) From 67b4b0813af0c8403625daeaf832a039625e9053 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Thu, 2 Apr 2026 16:09:55 +0530 Subject: [PATCH 4/9] fixes for BrowserSessions operations and added test cases for it. Pushed test recordings also --- .../azure-developer-playwright/assets.json | 6 +++++ .../playwright/aio/operations/_patch.py | 17 ++++++++++++ .../developer/playwright/operations/_patch.py | 17 ++++++++++++ .../tests/conftest.py | 17 ++++++++++++ ..._playwright_browser_sessions_operations.py | 27 +++++++++++++++++++ ...right_browser_sessions_operations_async.py | 27 +++++++++++++++++++ .../test_playwright_workspaces_operations.py | 14 +++++----- ..._playwright_workspaces_operations_async.py | 15 ++++++----- 8 files changed, 128 insertions(+), 12 deletions(-) create mode 100644 sdk/playwright/azure-developer-playwright/assets.json diff --git a/sdk/playwright/azure-developer-playwright/assets.json b/sdk/playwright/azure-developer-playwright/assets.json new file mode 100644 index 000000000000..8c31780ce1ce --- /dev/null +++ b/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_b26ef6ed9f" +} diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py index cf2de4512459..f31a13e0cac8 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py @@ -9,6 +9,7 @@ """ from typing import Any, Optional, Union +from ._operations import BrowserSessionsOperations as _GeneratedBrowserSessionsOperations from ._operations import TestRunsOperations as _GeneratedTestRunsOperations from ._operations import WorkspacesOperations as _GeneratedWorkspacesOperations from ... import models as _models @@ -53,9 +54,25 @@ def __init__(self, *args, **kwargs) -> None: self._config = _ReportingEndpointConfig(self._config) +class BrowserSessionsOperations(_GeneratedBrowserSessionsOperations): + """Customized BrowserSessionsOperations that routes requests to the reporting subdomain. + + The browser-sessions API is served from a different subdomain + (*.reporting.api.playwright.microsoft.com) than the main API + (*.api.playwright.microsoft.com). This override wraps the shared + config with a proxy that returns the reporting endpoint, without + copying or mutating the original config object. + """ + + def __init__(self, *args, **kwargs) -> None: + super().__init__(*args, **kwargs) + self._config = _ReportingEndpointConfig(self._config) + + __all__: list[str] = [ "WorkspacesOperations", "TestRunsOperations", + "BrowserSessionsOperations", ] diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py index 182151e7b2f3..722c69d1b03c 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py @@ -9,6 +9,7 @@ """ from typing import Any, Optional, Union +from ._operations import BrowserSessionsOperations as _GeneratedBrowserSessionsOperations from ._operations import TestRunsOperations as _GeneratedTestRunsOperations from ._operations import WorkspacesOperations as _GeneratedWorkspacesOperations from .. import models as _models @@ -82,9 +83,25 @@ def __init__(self, *args, **kwargs) -> None: self._config = _ReportingEndpointConfig(self._config) +class BrowserSessionsOperations(_GeneratedBrowserSessionsOperations): + """Customized BrowserSessionsOperations that routes requests to the reporting subdomain. + + The browser-sessions API is served from a different subdomain + (*.reporting.api.playwright.microsoft.com) than the main API + (*.api.playwright.microsoft.com). This override wraps the shared + config with a proxy that returns the reporting endpoint, without + copying or mutating the original config object. + """ + + def __init__(self, *args, **kwargs) -> None: + super().__init__(*args, **kwargs) + self._config = _ReportingEndpointConfig(self._config) + + __all__: list[str] = [ "WorkspacesOperations", "TestRunsOperations", + "BrowserSessionsOperations", ] diff --git a/sdk/playwright/azure-developer-playwright/tests/conftest.py b/sdk/playwright/azure-developer-playwright/tests/conftest.py index 5388773bed6a..20c7e23e0ec0 100644 --- a/sdk/playwright/azure-developer-playwright/tests/conftest.py +++ b/sdk/playwright/azure-developer-playwright/tests/conftest.py @@ -50,6 +50,23 @@ def add_sanitizers(test_proxy): playwright_workspace_id = os.environ.get("PLAYWRIGHT_WORKSPACE_ID", "00000000-0000-0000-0000-000000000000") add_general_regex_sanitizer(regex=playwright_workspace_id, value="00000000-0000-0000-0000-000000000000") + # Sanitize browser session test endpoint (separate workspace) + session_endpoint = os.environ.get("PLAYWRIGHT_SESSION_ENDPOINT", "") + if session_endpoint: + session_hostname = session_endpoint.replace("https://", "").replace("http://", "") + session_reporting_hostname = session_hostname.replace(".api.playwright.", ".reporting.api.playwright.") + add_general_string_sanitizer( + target=session_reporting_hostname, + value="fake.reporting.api.playwright.microsoft.com", + ) + add_general_string_sanitizer(target=session_hostname, value="fake.api.playwright.microsoft.com") + + session_workspace_id = os.environ.get("PLAYWRIGHT_SESSION_WORKSPACE_ID", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=session_workspace_id, value="00000000-0000-0000-0000-000000000000") + + session_id = os.environ.get("PLAYWRIGHT_SESSION_ID", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=session_id, value="00000000-0000-0000-0000-000000000000") + # Sanitize cookies and tokens add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") add_header_regex_sanitizer(key="Cookie", value="cookie;") diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py index ea929de70186..cb4ca6beb054 100644 --- a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py @@ -3,6 +3,8 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +import os + import pytest from devtools_testutils import recorded_by_proxy @@ -19,3 +21,28 @@ def test_browser_sessions_list(self, playwright_endpoint, playwright_workspace_i ) result = [r for r in response] assert isinstance(result, list) + + @recorded_by_proxy + def test_browser_sessions_get(self, **kwargs): + """Test getting a browser session by ID. + + This test uses a pre-existing browser session from a separate workspace + because there is no publicly available API to create a browser session. + The session endpoint, workspace ID, and session ID are configured via + PLAYWRIGHT_SESSION_ENDPOINT, PLAYWRIGHT_SESSION_WORKSPACE_ID, and + PLAYWRIGHT_SESSION_ID environment variables. + """ + endpoint = os.environ["PLAYWRIGHT_SESSION_ENDPOINT"] + workspace_id = os.environ["PLAYWRIGHT_SESSION_WORKSPACE_ID"] + session_id = os.environ["PLAYWRIGHT_SESSION_ID"] + + client = self.create_client(endpoint=endpoint) + response = client.browser_sessions.get( + workspace_id=workspace_id, + session_id=session_id, + ) + + assert response is not None + assert "id" in response + assert "status" in response + diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py index 2dcff1602277..05253225ad3a 100644 --- a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py @@ -3,6 +3,8 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +import os + import pytest from devtools_testutils.aio import recorded_by_proxy_async @@ -20,3 +22,28 @@ async def test_browser_sessions_list(self, playwright_endpoint, playwright_works ) result = [r async for r in response] assert isinstance(result, list) + + @pytest.mark.asyncio + @recorded_by_proxy_async + async def test_browser_sessions_get(self, **kwargs): + """Test getting a browser session by ID. + + This test uses a pre-existing browser session from a separate workspace + because there is no publicly available API to create a browser session. + The session endpoint, workspace ID, and session ID are configured via + PLAYWRIGHT_SESSION_ENDPOINT, PLAYWRIGHT_SESSION_WORKSPACE_ID, and + PLAYWRIGHT_SESSION_ID environment variables. + """ + endpoint = os.environ["PLAYWRIGHT_SESSION_ENDPOINT"] + workspace_id = os.environ["PLAYWRIGHT_SESSION_WORKSPACE_ID"] + session_id = os.environ["PLAYWRIGHT_SESSION_ID"] + + client = self.create_async_client(endpoint=endpoint) + response = await client.browser_sessions.get( + workspace_id=workspace_id, + session_id=session_id, + ) + + assert response is not None + assert "id" in response + assert "status" in response diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py index d2bb8797f818..78a1ff38bcbb 100644 --- a/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations.py @@ -3,6 +3,8 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +import os + import pytest from devtools_testutils import recorded_by_proxy @@ -18,15 +20,15 @@ def test_workspaces_get(self, playwright_endpoint, playwright_workspace_id): workspace_id=playwright_workspace_id, ) assert response is not None - assert "workspaceId" in response + assert "id" in response @pytest.mark.live_test_only - @PlaywrightPreparer() - @recorded_by_proxy - def test_workspaces_get_browsers(self, playwright_endpoint, playwright_workspace_id): - client = self.create_client(endpoint=playwright_endpoint) + def test_workspaces_get_browsers(self): + endpoint = os.environ["PLAYWRIGHT_ENDPOINT"] + workspace_id = os.environ["PLAYWRIGHT_WORKSPACE_ID"] + client = self.create_client(endpoint=endpoint) response = client.workspaces.get_browsers( - workspace_id=playwright_workspace_id, + workspace_id=workspace_id, os="Linux", ) assert response is None diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py index 40e0f415ed9f..e2551f58fa0d 100644 --- a/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_workspaces_operations_async.py @@ -3,6 +3,8 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +import os + import pytest from devtools_testutils.aio import recorded_by_proxy_async @@ -19,15 +21,16 @@ async def test_workspaces_get(self, playwright_endpoint, playwright_workspace_id workspace_id=playwright_workspace_id, ) assert response is not None - assert "workspaceId" in response + assert "id" in response @pytest.mark.live_test_only - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_workspaces_get_browsers(self, playwright_endpoint, playwright_workspace_id): - client = self.create_async_client(endpoint=playwright_endpoint) + @pytest.mark.asyncio + async def test_workspaces_get_browsers(self): + endpoint = os.environ["PLAYWRIGHT_ENDPOINT"] + workspace_id = os.environ["PLAYWRIGHT_WORKSPACE_ID"] + client = self.create_async_client(endpoint=endpoint) response = await client.workspaces.get_browsers( - workspace_id=playwright_workspace_id, + workspace_id=workspace_id, os="Linux", ) assert response is None From 9d25c8558f7a6698801435ff550d5382368fdb14 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Thu, 2 Apr 2026 16:10:33 +0530 Subject: [PATCH 5/9] fixes for checks failing --- .../azure/developer/playwright/_patch.py | 2 ++ .../azure/developer/playwright/aio/_patch.py | 2 ++ .../azure/developer/playwright/aio/operations/_patch.py | 4 ++-- .../azure/developer/playwright/operations/_patch.py | 8 ++++++-- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py index 65400c2009ac..3f4d3da3b1cd 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_patch.py @@ -20,6 +20,8 @@ class PlaywrightClient(_GeneratedPlaywrightClient): The generated scope (playwright.microsoft.com) is incorrect due to a spec bug. This override sets the working scope until the spec is fixed. + + :keyword str api_version: The API version to use for this operation. """ def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py index f1d1cdf509c5..fde2e41d7684 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_patch.py @@ -20,6 +20,8 @@ class PlaywrightClient(_GeneratedPlaywrightClient): The generated scope (playwright.microsoft.com) is incorrect due to a spec bug. This override sets the working scope until the spec is fixed. + + :keyword str api_version: The API version to use for this operation. """ def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py index f31a13e0cac8..96fb3b08426f 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/operations/_patch.py @@ -51,7 +51,7 @@ class TestRunsOperations(_GeneratedTestRunsOperations): def __init__(self, *args, **kwargs) -> None: super().__init__(*args, **kwargs) - self._config = _ReportingEndpointConfig(self._config) + self._config = _ReportingEndpointConfig(self._config) # type: ignore[assignment] class BrowserSessionsOperations(_GeneratedBrowserSessionsOperations): @@ -66,7 +66,7 @@ class BrowserSessionsOperations(_GeneratedBrowserSessionsOperations): def __init__(self, *args, **kwargs) -> None: super().__init__(*args, **kwargs) - self._config = _ReportingEndpointConfig(self._config) + self._config = _ReportingEndpointConfig(self._config) # type: ignore[assignment] __all__: list[str] = [ diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py index 722c69d1b03c..ba84bdb057e3 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/operations/_patch.py @@ -22,6 +22,10 @@ def _to_reporting_endpoint(endpoint: str) -> str: (e.g. https://{region}.reporting.api.playwright.microsoft.com) while all other operations use the base subdomain (e.g. https://{region}.api.playwright.microsoft.com). + + :param str endpoint: The base API endpoint URL. + :returns: The reporting API endpoint URL. + :rtype: str """ return endpoint.replace(".api.playwright.", ".reporting.api.playwright.") @@ -80,7 +84,7 @@ class TestRunsOperations(_GeneratedTestRunsOperations): def __init__(self, *args, **kwargs) -> None: super().__init__(*args, **kwargs) - self._config = _ReportingEndpointConfig(self._config) + self._config = _ReportingEndpointConfig(self._config) # type: ignore[assignment] class BrowserSessionsOperations(_GeneratedBrowserSessionsOperations): @@ -95,7 +99,7 @@ class BrowserSessionsOperations(_GeneratedBrowserSessionsOperations): def __init__(self, *args, **kwargs) -> None: super().__init__(*args, **kwargs) - self._config = _ReportingEndpointConfig(self._config) + self._config = _ReportingEndpointConfig(self._config) # type: ignore[assignment] __all__: list[str] = [ From 4ff61dacce352c75efedb8fcd6a46bd39908ff76 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Thu, 2 Apr 2026 16:14:17 +0530 Subject: [PATCH 6/9] Updating changelog --- .../azure-developer-playwright/CHANGELOG.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/sdk/playwright/azure-developer-playwright/CHANGELOG.md b/sdk/playwright/azure-developer-playwright/CHANGELOG.md index b957b2575b48..62386d6f84f9 100644 --- a/sdk/playwright/azure-developer-playwright/CHANGELOG.md +++ b/sdk/playwright/azure-developer-playwright/CHANGELOG.md @@ -1,7 +1,12 @@ # Release History -## 1.0.0b1 (1970-01-01) +## 1.0.0b1 (2026-04-06) -### Other Changes +### Features Added - - Initial version \ No newline at end of file + - 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 \ No newline at end of file From d2ec25abbb8837c91fbc39973f29abdce1e87bfa Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Thu, 2 Apr 2026 17:01:51 +0530 Subject: [PATCH 7/9] removing generated tests as tests are already added in sdk\playwright\azure-developer-playwright\tests and other CI fix --- .../azure-developer-playwright/README.md | 60 ++++++++++++++- .../azure/developer/playwright/_client.py | 2 +- .../developer/playwright/_configuration.py | 2 +- .../azure/developer/playwright/aio/_client.py | 2 +- .../playwright/aio/_configuration.py | 2 +- .../generated_tests/conftest.py | 35 --------- ...est_playwright_access_tokens_operations.py | 68 ---------------- ...aywright_access_tokens_operations_async.py | 69 ----------------- ..._playwright_browser_sessions_operations.py | 36 --------- ...right_browser_sessions_operations_async.py | 37 --------- .../test_playwright_test_runs_operations.py | 76 ------------------ ...t_playwright_test_runs_operations_async.py | 77 ------------------- .../test_playwright_workspaces_operations.py | 36 --------- ..._playwright_workspaces_operations_async.py | 37 --------- .../generated_tests/testpreparer.py | 26 ------- .../generated_tests/testpreparer_async.py | 20 ----- 16 files changed, 61 insertions(+), 524 deletions(-) delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/conftest.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py delete mode 100644 sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py diff --git a/sdk/playwright/azure-developer-playwright/README.md b/sdk/playwright/azure-developer-playwright/README.md index 48263e038f08..4cfb7450de75 100644 --- a/sdk/playwright/azure-developer-playwright/README.md +++ b/sdk/playwright/azure-developer-playwright/README.md @@ -1,5 +1,6 @@ # 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 @@ -9,11 +10,61 @@ python -m pip install azure-developer-playwright ``` -#### Prequisites +### 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 instance. +- 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://.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://.api.playwright.microsoft.com", + credential=DefaultAzureCredential(), +) + +for run in client.test_runs.list(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 @@ -41,3 +92,6 @@ additional questions or comments. [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 diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py index b75bb9953088..a0be4968fe66 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_client.py @@ -7,7 +7,7 @@ # -------------------------------------------------------------------------- from copy import deepcopy -from typing import Any, TYPE_CHECKING, Union +from typing import Any, TYPE_CHECKING, Union # pylint: disable=unused-import from typing_extensions import Self from azure.core import PipelineClient diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py index ed95cf85a182..361cf79bd07d 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/_configuration.py @@ -6,7 +6,7 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from typing import Any, TYPE_CHECKING, Union +from typing import Any, TYPE_CHECKING, Union # pylint: disable=unused-import from azure.core.pipeline import policies diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py index 06fda3182412..2ae3dbb4eee1 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_client.py @@ -7,7 +7,7 @@ # -------------------------------------------------------------------------- from copy import deepcopy -from typing import Any, Awaitable, TYPE_CHECKING, Union +from typing import Any, Awaitable, TYPE_CHECKING, Union # pylint: disable=unused-import from typing_extensions import Self from azure.core import AsyncPipelineClient diff --git a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py index bf3f116ea3e9..37cea3461696 100644 --- a/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py +++ b/sdk/playwright/azure-developer-playwright/azure/developer/playwright/aio/_configuration.py @@ -6,7 +6,7 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from typing import Any, TYPE_CHECKING, Union +from typing import Any, TYPE_CHECKING, Union # pylint: disable=unused-import from azure.core.pipeline import policies diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/conftest.py b/sdk/playwright/azure-developer-playwright/generated_tests/conftest.py deleted file mode 100644 index c47e0b5f30aa..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/conftest.py +++ /dev/null @@ -1,35 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import os -import pytest -from dotenv import load_dotenv -from devtools_testutils import ( - test_proxy, - add_general_regex_sanitizer, - add_body_key_sanitizer, - add_header_regex_sanitizer, -) - -load_dotenv() - - -# For security, please avoid record sensitive identity information in recordings -@pytest.fixture(scope="session", autouse=True) -def add_sanitizers(test_proxy): - playwright_subscription_id = os.environ.get("PLAYWRIGHT_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") - playwright_tenant_id = os.environ.get("PLAYWRIGHT_TENANT_ID", "00000000-0000-0000-0000-000000000000") - playwright_client_id = os.environ.get("PLAYWRIGHT_CLIENT_ID", "00000000-0000-0000-0000-000000000000") - playwright_client_secret = os.environ.get("PLAYWRIGHT_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=playwright_subscription_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=playwright_tenant_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=playwright_client_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=playwright_client_secret, value="00000000-0000-0000-0000-000000000000") - - add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") - add_header_regex_sanitizer(key="Cookie", value="cookie;") - add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py deleted file mode 100644 index 14533f821156..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations.py +++ /dev/null @@ -1,68 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightAccessTokensOperations(PlaywrightClientTestBase): - @PlaywrightPreparer() - @recorded_by_proxy - def test_access_tokens_create_or_replace(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.access_tokens.create_or_replace( - workspace_id="str", - access_token_id="str", - resource={ - "createdAt": "2020-02-20 00:00:00", - "expiryAt": "2020-02-20 00:00:00", - "id": "str", - "name": "str", - "state": "str", - "jwtToken": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_access_tokens_get(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.access_tokens.get( - workspace_id="str", - access_token_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_access_tokens_delete(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.access_tokens.delete( - workspace_id="str", - access_token_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_access_tokens_list(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.access_tokens.list( - workspace_id="str", - ) - result = [r for r in response] - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py deleted file mode 100644 index eb4e9aa47d74..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_access_tokens_operations_async.py +++ /dev/null @@ -1,69 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils.aio import recorded_by_proxy_async -from testpreparer import PlaywrightPreparer -from testpreparer_async import PlaywrightClientTestBaseAsync - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightAccessTokensOperationsAsync(PlaywrightClientTestBaseAsync): - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_access_tokens_create_or_replace(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.access_tokens.create_or_replace( - workspace_id="str", - access_token_id="str", - resource={ - "createdAt": "2020-02-20 00:00:00", - "expiryAt": "2020-02-20 00:00:00", - "id": "str", - "name": "str", - "state": "str", - "jwtToken": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_access_tokens_get(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.access_tokens.get( - workspace_id="str", - access_token_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_access_tokens_delete(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.access_tokens.delete( - workspace_id="str", - access_token_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_access_tokens_list(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = client.access_tokens.list( - workspace_id="str", - ) - result = [r async for r in response] - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py deleted file mode 100644 index 0f13c0890fee..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations.py +++ /dev/null @@ -1,36 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightBrowserSessionsOperations(PlaywrightClientTestBase): - @PlaywrightPreparer() - @recorded_by_proxy - def test_browser_sessions_get(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.browser_sessions.get( - workspace_id="str", - session_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_browser_sessions_list(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.browser_sessions.list( - workspace_id="str", - ) - result = [r for r in response] - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py deleted file mode 100644 index bd06026fbdf4..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_browser_sessions_operations_async.py +++ /dev/null @@ -1,37 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils.aio import recorded_by_proxy_async -from testpreparer import PlaywrightPreparer -from testpreparer_async import PlaywrightClientTestBaseAsync - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightBrowserSessionsOperationsAsync(PlaywrightClientTestBaseAsync): - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_browser_sessions_get(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.browser_sessions.get( - workspace_id="str", - session_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_browser_sessions_list(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = client.browser_sessions.list( - workspace_id="str", - ) - result = [r async for r in response] - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py deleted file mode 100644 index de17efda0d2a..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations.py +++ /dev/null @@ -1,76 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightTestRunsOperations(PlaywrightClientTestBase): - @PlaywrightPreparer() - @recorded_by_proxy - def test_test_runs_create_or_update(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.test_runs.create_or_update( - workspace_id="str", - run_id="str", - resource={ - "creatorId": "str", - "displayName": "str", - "id": "str", - "summary": { - "startTime": "2020-02-20 00:00:00", - "status": "str", - "billableTime": 0, - "duration": 0, - "endTime": "2020-02-20 00:00:00", - "errorMessages": ["str"], - "maxConcurrentBrowserSessions": 0, - "numBrowserSessions": 0, - }, - "ciConfig": { - "author": "str", - "branch": "str", - "commitId": "str", - "providerName": "str", - "revisionUrl": "str", - }, - "config": { - "framework": {"name": "str", "runnerName": "str", "version": "str"}, - "maxWorkers": 0, - "sdkLanguage": "str", - }, - "creatorName": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_test_runs_get(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.test_runs.get( - workspace_id="str", - run_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_test_runs_list(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.test_runs.list( - workspace_id="str", - ) - result = [r for r in response] - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py deleted file mode 100644 index 4ff3c1a4803d..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_test_runs_operations_async.py +++ /dev/null @@ -1,77 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils.aio import recorded_by_proxy_async -from testpreparer import PlaywrightPreparer -from testpreparer_async import PlaywrightClientTestBaseAsync - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightTestRunsOperationsAsync(PlaywrightClientTestBaseAsync): - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_test_runs_create_or_update(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.test_runs.create_or_update( - workspace_id="str", - run_id="str", - resource={ - "creatorId": "str", - "displayName": "str", - "id": "str", - "summary": { - "startTime": "2020-02-20 00:00:00", - "status": "str", - "billableTime": 0, - "duration": 0, - "endTime": "2020-02-20 00:00:00", - "errorMessages": ["str"], - "maxConcurrentBrowserSessions": 0, - "numBrowserSessions": 0, - }, - "ciConfig": { - "author": "str", - "branch": "str", - "commitId": "str", - "providerName": "str", - "revisionUrl": "str", - }, - "config": { - "framework": {"name": "str", "runnerName": "str", "version": "str"}, - "maxWorkers": 0, - "sdkLanguage": "str", - }, - "creatorName": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_test_runs_get(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.test_runs.get( - workspace_id="str", - run_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_test_runs_list(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = client.test_runs.list( - workspace_id="str", - ) - result = [r async for r in response] - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py deleted file mode 100644 index e8036345410a..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations.py +++ /dev/null @@ -1,36 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import PlaywrightClientTestBase, PlaywrightPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightWorkspacesOperations(PlaywrightClientTestBase): - @PlaywrightPreparer() - @recorded_by_proxy - def test_workspaces_get(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.workspaces.get( - workspace_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy - def test_workspaces_get_browsers(self, playwright_endpoint): - client = self.create_client(endpoint=playwright_endpoint) - response = client.workspaces.get_browsers( - workspace_id="str", - os="str", - ) - - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py deleted file mode 100644 index 5febbc12ee2c..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/test_playwright_workspaces_operations_async.py +++ /dev/null @@ -1,37 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils.aio import recorded_by_proxy_async -from testpreparer import PlaywrightPreparer -from testpreparer_async import PlaywrightClientTestBaseAsync - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestPlaywrightWorkspacesOperationsAsync(PlaywrightClientTestBaseAsync): - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_workspaces_get(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.workspaces.get( - workspace_id="str", - ) - - # please add some check logic here by yourself - # ... - - @PlaywrightPreparer() - @recorded_by_proxy_async - async def test_workspaces_get_browsers(self, playwright_endpoint): - client = self.create_async_client(endpoint=playwright_endpoint) - response = await client.workspaces.get_browsers( - workspace_id="str", - os="str", - ) - - # please add some check logic here by yourself - # ... diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py b/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py deleted file mode 100644 index 1a47c3a001bc..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer.py +++ /dev/null @@ -1,26 +0,0 @@ -# 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 azure.developer.playwright import PlaywrightClient -from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer -import functools - - -class PlaywrightClientTestBase(AzureRecordedTestCase): - - def create_client(self, endpoint): - credential = self.get_credential(PlaywrightClient) - return self.create_client_from_credential( - PlaywrightClient, - credential=credential, - endpoint=endpoint, - ) - - -PlaywrightPreparer = functools.partial( - PowerShellPreparer, "playwright", playwright_endpoint="https://fake_playwright_endpoint.com" -) diff --git a/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py b/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py deleted file mode 100644 index 0d3153c42c07..000000000000 --- a/sdk/playwright/azure-developer-playwright/generated_tests/testpreparer_async.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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 azure.developer.playwright.aio import PlaywrightClient -from devtools_testutils import AzureRecordedTestCase - - -class PlaywrightClientTestBaseAsync(AzureRecordedTestCase): - - def create_async_client(self, endpoint): - credential = self.get_credential(PlaywrightClient, is_async=True) - return self.create_client_from_credential( - PlaywrightClient, - credential=credential, - endpoint=endpoint, - ) From e95e43677d19e51e93a99b8c69b38908c120b146 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Thu, 2 Apr 2026 18:58:37 +0530 Subject: [PATCH 8/9] nit: tests default env var and updated recordings --- sdk/playwright/azure-developer-playwright/assets.json | 2 +- .../tests/test_playwright_browser_sessions_operations.py | 6 +++--- .../test_playwright_browser_sessions_operations_async.py | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/sdk/playwright/azure-developer-playwright/assets.json b/sdk/playwright/azure-developer-playwright/assets.json index 8c31780ce1ce..d92079cce0f3 100644 --- a/sdk/playwright/azure-developer-playwright/assets.json +++ b/sdk/playwright/azure-developer-playwright/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/playwright/azure-developer-playwright", - "Tag": "python/playwright/azure-developer-playwright_b26ef6ed9f" + "Tag": "python/playwright/azure-developer-playwright_d1a8dd1621" } diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py index cb4ca6beb054..620c90389738 100644 --- a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations.py @@ -32,9 +32,9 @@ def test_browser_sessions_get(self, **kwargs): PLAYWRIGHT_SESSION_ENDPOINT, PLAYWRIGHT_SESSION_WORKSPACE_ID, and PLAYWRIGHT_SESSION_ID environment variables. """ - endpoint = os.environ["PLAYWRIGHT_SESSION_ENDPOINT"] - workspace_id = os.environ["PLAYWRIGHT_SESSION_WORKSPACE_ID"] - session_id = os.environ["PLAYWRIGHT_SESSION_ID"] + endpoint = os.environ.get("PLAYWRIGHT_SESSION_ENDPOINT", "https://fake.api.playwright.microsoft.com") + workspace_id = os.environ.get("PLAYWRIGHT_SESSION_WORKSPACE_ID", "00000000-0000-0000-0000-000000000000") + session_id = os.environ.get("PLAYWRIGHT_SESSION_ID", "00000000-0000-0000-0000-000000000000") client = self.create_client(endpoint=endpoint) response = client.browser_sessions.get( diff --git a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py index 05253225ad3a..418c0ac33121 100644 --- a/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py +++ b/sdk/playwright/azure-developer-playwright/tests/test_playwright_browser_sessions_operations_async.py @@ -34,9 +34,9 @@ async def test_browser_sessions_get(self, **kwargs): PLAYWRIGHT_SESSION_ENDPOINT, PLAYWRIGHT_SESSION_WORKSPACE_ID, and PLAYWRIGHT_SESSION_ID environment variables. """ - endpoint = os.environ["PLAYWRIGHT_SESSION_ENDPOINT"] - workspace_id = os.environ["PLAYWRIGHT_SESSION_WORKSPACE_ID"] - session_id = os.environ["PLAYWRIGHT_SESSION_ID"] + endpoint = os.environ.get("PLAYWRIGHT_SESSION_ENDPOINT", "https://fake.api.playwright.microsoft.com") + workspace_id = os.environ.get("PLAYWRIGHT_SESSION_WORKSPACE_ID", "00000000-0000-0000-0000-000000000000") + session_id = os.environ.get("PLAYWRIGHT_SESSION_ID", "00000000-0000-0000-0000-000000000000") client = self.create_async_client(endpoint=endpoint) response = await client.browser_sessions.get( From 7327d000eea848f3eec8fe9c4c46f0ae5a8dc3e9 Mon Sep 17 00:00:00 2001 From: Himanshu Bisht Date: Thu, 2 Apr 2026 19:39:32 +0530 Subject: [PATCH 9/9] nit: [fix] disable mypy type_check_samples for generated samples --- sdk/playwright/azure-developer-playwright/pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sdk/playwright/azure-developer-playwright/pyproject.toml b/sdk/playwright/azure-developer-playwright/pyproject.toml index 0eebfc86b934..ca4bb2b45beb 100644 --- a/sdk/playwright/azure-developer-playwright/pyproject.toml +++ b/sdk/playwright/azure-developer-playwright/pyproject.toml @@ -46,6 +46,9 @@ repository = "https://github.com/Azure/azure-sdk-for-python" version = {attr = "azure.developer.playwright._version.VERSION"} readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} +[tool.azure-sdk-build] +type_check_samples = false + [tool.setuptools.packages.find] exclude = [ "tests*",