Skip to content

Commit 61d1fd6

Browse files
author
SDKAuto
committed
CodeGen from PR 34012 in Azure/azure-rest-api-specs
Merge aec41abfffd08b2866f03ca5b7f6f03da72bed6c into 5db6f4b2219494122de700460988e9f3ef735dc0
1 parent 2c9172e commit 61d1fd6

36 files changed

+5405
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release History
2+
3+
## 1.0.0b1 (1970-01-01)
4+
5+
- Initial version
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include *.md
2+
include LICENSE
3+
include azure/developer/playwright/py.typed
4+
recursive-include tests *.py
5+
recursive-include samples *.py *.md
6+
include azure/__init__.py
7+
include azure/developer/__init__.py
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Azure Developer Playwright client library for Python
2+
<!-- write necessary description of service -->
3+
4+
## Getting started
5+
6+
### Install the package
7+
8+
```bash
9+
python -m pip install azure-developer-playwright
10+
```
11+
12+
#### Prequisites
13+
14+
- Python 3.9 or later is required to use this package.
15+
- You need an [Azure subscription][azure_sub] to use this package.
16+
- An existing Azure Developer Playwright instance.
17+
18+
19+
## Contributing
20+
21+
This project welcomes contributions and suggestions. Most contributions require
22+
you to agree to a Contributor License Agreement (CLA) declaring that you have
23+
the right to, and actually do, grant us the rights to use your contribution.
24+
For details, visit https://cla.microsoft.com.
25+
26+
When you submit a pull request, a CLA-bot will automatically determine whether
27+
you need to provide a CLA and decorate the PR appropriately (e.g., label,
28+
comment). Simply follow the instructions provided by the bot. You will only
29+
need to do this once across all repos using our CLA.
30+
31+
This project has adopted the
32+
[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
33+
see the Code of Conduct FAQ or contact [email protected] with any
34+
additional questions or comments.
35+
36+
<!-- LINKS -->
37+
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
38+
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
39+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
40+
[azure_identity_pip]: https://pypi.org/project/azure-identity/
41+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
42+
[pip]: https://pypi.org/project/pip/
43+
[azure_sub]: https://azure.microsoft.com/free/
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "f0143019cfea40b0257f746a6d512a83774e375e",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/loadtestservice/Playwright",
5+
"@azure-tools/typespec-python": "0.44.1"
6+
}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"CrossLanguagePackageId": "Playwright",
3+
"CrossLanguageDefinitionId": {
4+
"azure.developer.playwright.models.AccessToken": "Playwright.AccessToken",
5+
"azure.developer.playwright.models.AccessTokenState": "Playwright.AccessTokenState",
6+
"azure.developer.playwright.models.OS": "Playwright.OS",
7+
"azure.developer.playwright.operations.AccessTokensOperations.create_or_replace": "Playwright.AccessTokens.createOrReplace",
8+
"azure.developer.playwright.aio.operations.AccessTokensOperations.create_or_replace": "Playwright.AccessTokens.createOrReplace",
9+
"azure.developer.playwright.operations.AccessTokensOperations.get": "Playwright.AccessTokens.get",
10+
"azure.developer.playwright.aio.operations.AccessTokensOperations.get": "Playwright.AccessTokens.get",
11+
"azure.developer.playwright.operations.AccessTokensOperations.delete": "Playwright.AccessTokens.delete",
12+
"azure.developer.playwright.aio.operations.AccessTokensOperations.delete": "Playwright.AccessTokens.delete",
13+
"azure.developer.playwright.operations.AccessTokensOperations.list": "Playwright.AccessTokens.list",
14+
"azure.developer.playwright.aio.operations.AccessTokensOperations.list": "Playwright.AccessTokens.list",
15+
"azure.developer.playwright.operations.WorkspacesOperations.get_browsers": "Playwright.Workspaces.getBrowsers",
16+
"azure.developer.playwright.aio.operations.WorkspacesOperations.get_browsers": "Playwright.Workspaces.getBrowsers"
17+
}
18+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
# pylint: disable=wrong-import-position
9+
10+
from typing import TYPE_CHECKING
11+
12+
if TYPE_CHECKING:
13+
from ._patch import * # pylint: disable=unused-wildcard-import
14+
15+
from ._client import PlaywrightClient # type: ignore
16+
from ._version import VERSION
17+
18+
__version__ = VERSION
19+
20+
try:
21+
from ._patch import __all__ as _patch_all
22+
from ._patch import *
23+
except ImportError:
24+
_patch_all = []
25+
from ._patch import patch_sdk as _patch_sdk
26+
27+
__all__ = [
28+
"PlaywrightClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from copy import deepcopy
10+
from typing import Any, TYPE_CHECKING, Union
11+
from typing_extensions import Self
12+
13+
from azure.core import PipelineClient
14+
from azure.core.pipeline import policies
15+
from azure.core.rest import HttpRequest, HttpResponse
16+
17+
from ._configuration import PlaywrightClientConfiguration
18+
from ._utils.serialization import Deserializer, Serializer
19+
from .operations import AccessTokensOperations, WorkspacesOperations
20+
21+
if TYPE_CHECKING:
22+
from azure.core.credentials import TokenCredential
23+
24+
25+
class PlaywrightClient:
26+
"""PlaywrightClient.
27+
28+
:ivar access_tokens: AccessTokensOperations operations
29+
:vartype access_tokens: azure.developer.playwright.operations.AccessTokensOperations
30+
:ivar workspaces: WorkspacesOperations operations
31+
:vartype workspaces: azure.developer.playwright.operations.WorkspacesOperations
32+
:param endpoint: Supported Playwright Service API Endpoints (protocol and hostname, for
33+
example:
34+
https://{region}.api.playwright.microsoft.com). Required.
35+
:type endpoint: str
36+
:param credential: Credential used to authenticate requests to the service. Is one of the
37+
following types: token credential Required.
38+
:type credential: ~azure.core.credentials.TokenCredential or
39+
~azure.core.credentials.TokenCredential
40+
:keyword api_version: The API version to use for this operation. Default value is
41+
"2025-07-01-preview". Note that overriding this default value may result in unsupported
42+
behavior.
43+
:paramtype api_version: str
44+
"""
45+
46+
def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
47+
_endpoint = "{endpoint}"
48+
self._config = PlaywrightClientConfiguration(endpoint=endpoint, credential=credential, **kwargs)
49+
50+
_policies = kwargs.pop("policies", None)
51+
if _policies is None:
52+
_policies = [
53+
policies.RequestIdPolicy(**kwargs),
54+
self._config.headers_policy,
55+
self._config.user_agent_policy,
56+
self._config.proxy_policy,
57+
policies.ContentDecodePolicy(**kwargs),
58+
self._config.redirect_policy,
59+
self._config.retry_policy,
60+
self._config.authentication_policy,
61+
self._config.custom_hook_policy,
62+
self._config.logging_policy,
63+
policies.DistributedTracingPolicy(**kwargs),
64+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
65+
self._config.http_logging_policy,
66+
]
67+
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
68+
69+
self._serialize = Serializer()
70+
self._deserialize = Deserializer()
71+
self._serialize.client_side_validation = False
72+
self.access_tokens = AccessTokensOperations(self._client, self._config, self._serialize, self._deserialize)
73+
self.workspaces = WorkspacesOperations(self._client, self._config, self._serialize, self._deserialize)
74+
75+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
76+
"""Runs the network request through the client's chained policies.
77+
78+
>>> from azure.core.rest import HttpRequest
79+
>>> request = HttpRequest("GET", "https://www.example.org/")
80+
<HttpRequest [GET], url: 'https://www.example.org/'>
81+
>>> response = client.send_request(request)
82+
<HttpResponse: 200 OK>
83+
84+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
85+
86+
:param request: The network request you want to make. Required.
87+
:type request: ~azure.core.rest.HttpRequest
88+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
89+
:return: The response of your network call. Does not do error handling on your response.
90+
:rtype: ~azure.core.rest.HttpResponse
91+
"""
92+
93+
request_copy = deepcopy(request)
94+
path_format_arguments = {
95+
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"),
96+
}
97+
98+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
99+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
100+
101+
def close(self) -> None:
102+
self._client.close()
103+
104+
def __enter__(self) -> Self:
105+
self._client.__enter__()
106+
return self
107+
108+
def __exit__(self, *exc_details: Any) -> None:
109+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)