From ea8bf405fe7c92f14f546f0231a8226e5d2e5e83 Mon Sep 17 00:00:00 2001 From: Alex Tsao Date: Sat, 1 Oct 2022 00:23:38 +0800 Subject: [PATCH] [Azure Maps] - Onboarding for Geolocation SDKs (#25504) * init developement for geolocation SDK * Update * Update freeze depency * update test * Drop namespace pkg for Python2 support * Update * Test with Test_proxy * update doc strings * Update requirements&run prepare release * Update according to feedback * update new recorded test --- sdk/maps/azure-maps-geolocation/CHANGELOG.md | 7 + sdk/maps/azure-maps-geolocation/MANIFEST.in | 6 + sdk/maps/azure-maps-geolocation/README.md | 202 ++ .../azure-maps-geolocation/azure/__init__.py | 1 + .../azure/maps/__init__.py | 1 + .../azure/maps/geolocation/__init__.py | 12 + .../azure/maps/geolocation/_base_client.py | 47 + .../maps/geolocation/_generated/__init__.py | 23 + .../maps/geolocation/_generated/_client.py | 100 + .../geolocation/_generated/_configuration.py | 73 + .../maps/geolocation/_generated/_patch.py | 19 + .../geolocation/_generated/_serialization.py | 2006 +++++++++++++++++ .../maps/geolocation/_generated/_vendor.py | 21 + .../maps/geolocation/_generated/_version.py | 9 + .../geolocation/_generated/aio/__init__.py | 20 + .../geolocation/_generated/aio/_client.py | 97 + .../_generated/aio/_configuration.py | 72 + .../maps/geolocation/_generated/aio/_patch.py | 19 + .../_generated/aio/operations/__init__.py | 18 + .../_generated/aio/operations/_operations.py | 106 + .../_generated/aio/operations/_patch.py | 19 + .../geolocation/_generated/models/__init__.py | 28 + .../geolocation/_generated/models/_enums.py | 18 + .../geolocation/_generated/models/_models.py | 181 ++ .../geolocation/_generated/models/_patch.py | 19 + .../_generated/operations/__init__.py | 18 + .../_generated/operations/_operations.py | 150 ++ .../_generated/operations/_patch.py | 19 + .../maps/geolocation/_generated/py.typed | 1 + .../maps/geolocation/_geolocation_client.py | 99 + .../azure/maps/geolocation/_version.py | 9 + .../azure/maps/geolocation/aio/__init__.py | 10 + .../geolocation/aio/_base_client_async.py | 48 + .../aio/_geolocation_client_async.py | 96 + .../azure/maps/geolocation/models/__init__.py | 9 + .../azure/maps/geolocation/models/_models.py | 23 + .../azure/maps/geolocation/py.typed | 1 + .../dev_requirements.txt | 5 + .../azure-maps-geolocation/samples/README.md | 52 + .../sample_authentication_async.py | 71 + .../sample_get_geolocation_async.py | 39 + .../samples/sample_authentication.py | 62 + .../samples/sample_get_geolocation.py | 40 + .../azure-maps-geolocation/sdk_packaging.toml | 9 + sdk/maps/azure-maps-geolocation/setup.py | 86 + .../azure-maps-geolocation/swagger/README.md | 39 + .../azure-maps-geolocation/tests/conftest.py | 26 + .../tests/geolocation_preparer.py | 15 + ...GeolocationClienttest_get_geolocation.json | 34 + ...GeolocationClienttest_get_geolocation.json | 34 + .../tests/test_client_unit.py | 30 + .../tests/test_geolocation_client.py | 24 + sdk/maps/ci.yml | 5 +- sdk/maps/test-resources.json | 172 +- sdk/maps/tests.yml | 7 +- 55 files changed, 4267 insertions(+), 90 deletions(-) create mode 100644 sdk/maps/azure-maps-geolocation/CHANGELOG.md create mode 100644 sdk/maps/azure-maps-geolocation/MANIFEST.in create mode 100644 sdk/maps/azure-maps-geolocation/README.md create mode 100644 sdk/maps/azure-maps-geolocation/azure/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_base_client.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_client.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_configuration.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_patch.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_serialization.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_vendor.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_version.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_client.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_configuration.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_patch.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_operations.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_patch.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_enums.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_models.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_patch.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_operations.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_patch.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/py.typed create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_geolocation_client.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_version.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_base_client_async.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_geolocation_client_async.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/__init__.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/_models.py create mode 100644 sdk/maps/azure-maps-geolocation/azure/maps/geolocation/py.typed create mode 100644 sdk/maps/azure-maps-geolocation/dev_requirements.txt create mode 100644 sdk/maps/azure-maps-geolocation/samples/README.md create mode 100644 sdk/maps/azure-maps-geolocation/samples/async_samples/sample_authentication_async.py create mode 100644 sdk/maps/azure-maps-geolocation/samples/async_samples/sample_get_geolocation_async.py create mode 100644 sdk/maps/azure-maps-geolocation/samples/sample_authentication.py create mode 100644 sdk/maps/azure-maps-geolocation/samples/sample_get_geolocation.py create mode 100644 sdk/maps/azure-maps-geolocation/sdk_packaging.toml create mode 100644 sdk/maps/azure-maps-geolocation/setup.py create mode 100644 sdk/maps/azure-maps-geolocation/swagger/README.md create mode 100644 sdk/maps/azure-maps-geolocation/tests/conftest.py create mode 100644 sdk/maps/azure-maps-geolocation/tests/geolocation_preparer.py create mode 100644 sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestGeolocationClienttest_get_geolocation.json create mode 100644 sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestMapsGeolocationClienttest_get_geolocation.json create mode 100644 sdk/maps/azure-maps-geolocation/tests/test_client_unit.py create mode 100644 sdk/maps/azure-maps-geolocation/tests/test_geolocation_client.py diff --git a/sdk/maps/azure-maps-geolocation/CHANGELOG.md b/sdk/maps/azure-maps-geolocation/CHANGELOG.md new file mode 100644 index 000000000000..c75caf041d69 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/CHANGELOG.md @@ -0,0 +1,7 @@ +# Release History + +## 1.0.0b1 (2022-10-11) + +### Features Added + +- Initial release diff --git a/sdk/maps/azure-maps-geolocation/MANIFEST.in b/sdk/maps/azure-maps-geolocation/MANIFEST.in new file mode 100644 index 000000000000..53b16c33fe14 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/MANIFEST.in @@ -0,0 +1,6 @@ +recursive-include tests *.py *.yaml +recursive-include samples *.py *.md +include *.md +include azure/__init__.py +include azure/maps/__init__.py +include azure/maps/geolocation/py.typed diff --git a/sdk/maps/azure-maps-geolocation/README.md b/sdk/maps/azure-maps-geolocation/README.md new file mode 100644 index 000000000000..7690b93f8c8b --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/README.md @@ -0,0 +1,202 @@ +# Azure Maps Geolocation Package client library for Python + +This package contains a Python SDK for Azure Maps Services for Geolocation. +Read more about Azure Maps Services [here](https://docs.microsoft.com/azure/azure-maps/) + +[Source code](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-geolocation) | [API reference documentation](https://docs.microsoft.com/rest/api/maps/geolocation) | [Product documentation](https://docs.microsoft.com/azure/azure-maps/) + +## _Disclaimer_ + +_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to _ + +## Getting started + +### Prerequisites + +- Python 3.7 or later is required to use this package. +- An [Azure subscription][azure_subscription] and an [Azure Maps account](https://docs.microsoft.com/azure/azure-maps/how-to-manage-account-keys). +- A deployed Maps Services resource. You can create the resource via [Azure Portal][azure_portal] or [Azure CLI][azure_cli]. + +If you use Azure CLI, replace `` and `` of your choice, and select a proper [pricing tier](https://docs.microsoft.com/azure/azure-maps/choose-pricing-tier) based on your needs via the `` parameter. Please refer to [this page](https://docs.microsoft.com/cli/azure/maps/account?view=azure-cli-latest#az_maps_account_create) for more details. + +```bash +az maps account create --resource-group --account-name --sku +``` + +### Install the package + +Install the Azure Maps Service Geolocation SDK. + +```bash +pip install azure-maps-geolocation +``` + +### Create and Authenticate the GeolocationClient + +To create a client object to access the Azure Maps Geolocation API, you will need a **credential** object. Azure Maps Geolocation client also support two ways to authenticate. + +#### 1. Authenticate with a Subscription Key Credential + +You can authenticate with your Azure Maps Subscription Key. +Once the Azure Maps Subscription Key is created, set the value of the key as environment variable: `AZURE_SUBSCRIPTION_KEY`. +Then pass an `AZURE_SUBSCRIPTION_KEY` as the `credential` parameter into an instance of [AzureKeyCredential][azure-key-credential]. + +```python +from azure.core.credentials import AzureKeyCredential +from azure.maps.geolocation import GeolocationClient + +credential = AzureKeyCredential(os.environ.get("AZURE_SUBSCRIPTION_KEY")) + +geolocation_client = GeolocationClient( + credential=credential, +) +``` + +#### 2. Authenticate with an Azure Active Directory credential + +You can authenticate with [Azure Active Directory (AAD) token credential][maps_authentication_aad] using the [Azure Identity library][azure_identity]. +Authentication by using AAD requires some initial setup: + +- Install [azure-identity][azure-key-credential] +- Register a [new AAD application][register_aad_app] +- Grant access to Azure Maps by assigning the suitable role to your service principal. Please refer to the [Manage authentication page][manage_aad_auth_page]. + +After setup, you can choose which type of [credential][azure-key-credential] from `azure.identity` to use. +As an example, [DefaultAzureCredential][default_azure_credential] +can be used to authenticate the client: + +Next, set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +You will also need to specify the Azure Maps resource you intend to use by specifying the `clientId` in the client options. The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to the [documentation][how_to_manage_authentication] on how to find it. + +```python +from azure.maps.geolocation import GeolocationClient +from azure.identity import DefaultAzureCredential + +credential = DefaultAzureCredential() +geolocation_client = GeolocationClient( + client_id="", + credential=credential +) +``` + +## Key concepts + +The Azure Maps Geolocation client library for Python allows you to interact with each of the components through the use of a dedicated client object. + +### Sync Clients + +`GeolocationClient` is the primary client for developers using the Azure Maps Geolocation client library for Python. +Once you initialized a `GeolocationClient` class, you can explore the methods on this client object to understand the different features of the Azure Maps Geolocation service that you can access. + +### Async Clients + +This library includes a complete async API supported on Python 3.5+. To use it, you must first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/). +See [azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport) for more information. + +Async clients and credentials should be closed when they're no longer needed. These +objects are async context managers and define async `close` methods. + +## Examples + +The following sections provide several code snippets covering some of the most common Azure Maps Geolocation tasks, including: + +- [Get Geolocation](#get-geolocation) + +### Get Geolocation + +This service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. + +```python +from azure.maps.geolocation import GeolocationClient + +BLOCK_COUNTRY_LIST = ['US', 'TW', 'AF', 'AX', 'DL'] +INCOME_IP_ADDRESS = "2001:4898:80e8:b::189" +geolocation_result = client.get_geolocation(ip_address=INCOME_IP_ADDRESS) + +result_country_code = geolocation_result.iso_code + +if result_country_code in BLOCK_COUNTRY_LIST: + raise Exception("These IP address is from forebiden country") +``` + +## Troubleshooting + +### General + +Maps Geolocation clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md). + +This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use the `error_code` attribute, i.e, `exception.error_code`. + +### Logging + +This library uses the standard [logging](https://docs.python.org/3/library/logging.html) library for logging. +Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level. + +Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the `logging_enable` argument: + +```python +import sys +import logging +from azure.maps.geolocation import GeolocationClient + +# Create a logger for the 'azure.maps.geolocation' SDK +logger = logging.getLogger('azure.maps.geolocation') +logger.setLevel(logging.DEBUG) + +# Configure a console output +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +``` + +### Additional + +Still running into issues? If you encounter any bugs or have suggestions, please file an issue in the [Issues]() section of the project. + +## Next steps + +### More sample code + +Get started with our [Maps Geolocation samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-geolocation/samples) ([Async Version samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-geolocation/samples/async_samples)). + +Several Azure Maps Geolocation Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Maps Geolocation + +```bash +set AZURE_SUBSCRIPTION_KEY="" + +pip install azure-maps-geolocation --pre + +python samples/sample_authentication.py +python sample/sample_get_geolocation.py +``` + +> Notes: `--pre` flag can be optionally added, it is to include pre-release and development versions for `pip install`. By default, `pip` only finds stable versions. + +Further detail please refer to [Samples Introduction](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-geolocation/samples/README.md) + +### Additional documentation + +For more extensive documentation on Azure Maps Geolocation, see the [Azure Maps Geolocation documentation](https://docs.microsoft.com/rest/api/maps/geolocation) on docs.microsoft.com. + +## 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 . + +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](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + +[azure_subscription]: https://azure.microsoft.com/free/ +[azure_identity]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/identity/azure-identity +[azure_portal]: https://portal.azure.com +[azure_cli]: https://docs.microsoft.com/cli/azure +[azure-key-credential]: https://aka.ms/azsdk/python/core/azurekeycredential +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[register_aad_app]: https://docs.microsoft.com/powershell/module/Az.Resources/New-AzADApplication?view=azps-8.0.0 +[maps_authentication_aad]: https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication +[create_new_application_registration]: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/applicationsListBlade/quickStartType/AspNetWebAppQuickstartPage/sourceType/docs +[manage_aad_auth_page]: https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication +[how_to_manage_authentication]: https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication#view-authentication-details diff --git a/sdk/maps/azure-maps-geolocation/azure/__init__.py b/sdk/maps/azure-maps-geolocation/azure/__init__.py new file mode 100644 index 000000000000..8db66d3d0f0f --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/__init__.py new file mode 100644 index 000000000000..8db66d3d0f0f --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/__init__.py new file mode 100644 index 000000000000..da5a90aab4dd --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/__init__.py @@ -0,0 +1,12 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +from ._version import VERSION +from ._geolocation_client import GeolocationClient + +__all__ = [ + 'GeolocationClient' +] +__version__ = VERSION diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_base_client.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_base_client.py new file mode 100644 index 000000000000..525ee4144e9c --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_base_client.py @@ -0,0 +1,47 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +from typing import Union, Any +from azure.core.pipeline.policies import AzureKeyCredentialPolicy +from azure.core.credentials import AzureKeyCredential, TokenCredential +from ._generated import GeolocationClient as _GeolocationClient +from ._version import VERSION + +# To check the credential is either AzureKeyCredential or TokenCredential +def _authentication_policy(credential): + authentication_policy = None + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if isinstance(credential, AzureKeyCredential): + authentication_policy = AzureKeyCredentialPolicy( + name="subscription-key", credential=credential + ) + elif credential is not None and not hasattr(credential, "get_token"): + raise TypeError( + "Unsupported credential: {}. Use an instance of AzureKeyCredential " + "or a token credential from azure.identity".format(type(credential)) + ) + return authentication_policy + +class GeolocationClientBase: + def __init__( + self, + credential: Union[AzureKeyCredential, TokenCredential], + **kwargs: Any + ) -> None: + self._maps_client = _GeolocationClient( + credential=credential, # type: ignore + api_version=kwargs.pop("api_version", VERSION), + authentication_policy=kwargs.pop("authentication_policy", _authentication_policy(credential)), + **kwargs + ) + self._geolocation_client = self._maps_client.geolocation + + def __enter__(self): + self._maps_client.__enter__() # pylint:disable=no-member + return self + + def __exit__(self, *args): + self._maps_client.__exit__(*args) # pylint:disable=no-member diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/__init__.py new file mode 100644 index 000000000000..ad20aa69a8ac --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/__init__.py @@ -0,0 +1,23 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import GeolocationClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk +__all__ = ['GeolocationClient'] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_client.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_client.py new file mode 100644 index 000000000000..3522d3f46e55 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_client.py @@ -0,0 +1,100 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Optional, TYPE_CHECKING + +from azure.core import PipelineClient +from azure.core.rest import HttpRequest, HttpResponse + +from . import models +from ._configuration import GeolocationClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import GeolocationOperations + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + +class GeolocationClient: # pylint: disable=client-accepts-api-version-keyword + """Azure Maps Geolocation REST APIs. + + :ivar geolocation: GeolocationOperations operations + :vartype geolocation: azure.maps.geolocation.operations.GeolocationOperations + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param client_id: Specifies which account is intended for usage in conjunction with the Azure + AD security model. It represents a unique ID for the Azure Maps account and can be retrieved + from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see + the following `articles `_ for guidance. Default value is None. + :type client_id: str + :keyword endpoint: Service URL. Default value is "https://atlas.microsoft.com". + :paramtype endpoint: str + :keyword api_version: Api Version. Default value is "1.0". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + credential: "TokenCredential", + client_id: Optional[str] = None, + *, + endpoint: str = "https://atlas.microsoft.com", + **kwargs: Any + ) -> None: + self._config = GeolocationClientConfiguration(credential=credential, client_id=client_id, **kwargs) + self._client = PipelineClient(base_url=endpoint, config=self._config, **kwargs) + + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + self._serialize = Serializer(client_models) + self._deserialize = Deserializer(client_models) + self._serialize.client_side_validation = False + self.geolocation = GeolocationOperations( + self._client, self._config, self._serialize, self._deserialize + ) + + + def send_request( + self, + request: HttpRequest, + **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) + request_copy.url = self._client.format_url(request_copy.url) + return self._client.send_request(request_copy, **kwargs) + + def close(self): + # type: () -> None + self._client.close() + + def __enter__(self): + # type: () -> GeolocationClient + self._client.__enter__() + return self + + def __exit__(self, *exc_details): + # type: (Any) -> None + self._client.__exit__(*exc_details) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_configuration.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_configuration.py new file mode 100644 index 000000000000..7e7e8eb8eb3a --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_configuration.py @@ -0,0 +1,73 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, Optional, TYPE_CHECKING + +from azure.core.configuration import Configuration +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class GeolocationClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes + """Configuration for GeolocationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param client_id: Specifies which account is intended for usage in conjunction with the Azure + AD security model. It represents a unique ID for the Azure Maps account and can be retrieved + from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see + the following `articles `_ for guidance. Default value is None. + :type client_id: str + :keyword api_version: Api Version. Default value is "1.0". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + credential: "TokenCredential", + client_id: Optional[str] = None, + **kwargs: Any + ) -> None: + super(GeolocationClientConfiguration, self).__init__(**kwargs) + api_version = kwargs.pop('api_version', "1.0") # type: str + + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.credential = credential + self.client_id = client_id + self.api_version = api_version + self.credential_scopes = kwargs.pop('credential_scopes', ['https://atlas.microsoft.com/.default']) + kwargs.setdefault('sdk_moniker', 'maps-geolocation/{}'.format(VERSION)) + self._configure(**kwargs) + + def _configure( + self, + **kwargs # type: Any + ): + # type: (...) -> 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.retry_policy = kwargs.get('retry_policy') or policies.RetryPolicy(**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.authentication_policy = kwargs.get('authentication_policy') + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_patch.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_patch.py new file mode 100644 index 000000000000..0ad201a8c586 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_patch.py @@ -0,0 +1,19 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__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/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_serialization.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_serialization.py new file mode 100644 index 000000000000..2e44d8666b2b --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_serialization.py @@ -0,0 +1,2006 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# 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. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file + +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 +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote # type: ignore +import xml.etree.ElementTree as ET + +import isodate + +from typing import Dict, Any, cast, TYPE_CHECKING + +from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback + +_BOM = codecs.BOM_UTF8.decode(encoding='utf-8') + +if TYPE_CHECKING: + from typing import Optional, Union, AnyStr, IO, Mapping + +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, content_type=None): + # type: (Optional[Union[AnyStr, IO]], Optional[str]) -> 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. + """ + 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) + 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: + # 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_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes, headers): + # type: (Optional[Union[AnyStr, IO]], 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" + """ + # 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 + +try: + basestring # type: ignore + unicode_str = unicode # type: ignore +except NameError: + basestring = str # type: ignore + unicode_str = str # type: ignore + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + +try: + from datetime import timezone as _FixedOffset +except ImportError: # Python 2.7 + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds()/3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + +try: + from datetime import timezone + TZ_UTC = timezone.utc # type: ignore +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? 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=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(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param 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. + """ + 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() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get('readonly', False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == '': + if target_obj.additional_properties is not None: + serialized.update(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) + continue + if xml_desc.get("text", False): + serialized.text = new_attr + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) + 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) + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node( + xml_name, + xml_prefix, + xml_ns + ) + local_node.text = unicode_str(new_attr) + serialized.append(local_node) + else: # JSON + for k in reversed(keys): + unflattened = {k: new_attr} + new_attr = unflattened + + _new_attr = new_attr + _serialized = serialized + for k in keys: + if k not in _serialized: + _serialized.update(_new_attr) + _new_attr = _new_attr[k] + _serialized = _serialized[k] + except ValueError: + continue + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format( + attr_name, class_name, str(target_obj)) + raise_with_traceback(SerializationError, msg, err) + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param 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 + """ + + # Just in case this is a dict + internal_data_type = data_type.strip('[]{}') + internal_data_type = self.dependencies.get(internal_data_type, 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 = [ + 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) + except DeserializationError as err: + raise_with_traceback( + SerializationError, "Unable to build a model: "+str(err), err) + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param 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 + """ + 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) + else: + output = quote(str(output), safe='') + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param 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 + """ + 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] + data = [ + self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" + for d + in data + ] + if not kwargs.get('skip_quote', False): + data = [ + quote(str(d), safe='') + for d + in data + ] + return str(self.serialize_iter(data, internal_data_type, **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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param 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 + """ + 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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif 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, 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_with_traceback( + SerializationError, msg.format(data, data_type), err) + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + 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 data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + 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) + return eval(data_type)(data) # nosec + + @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 data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + 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 attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :rtype: list, str + """ + 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: + serialized.append(None) + + 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. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + 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: + 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): + """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 + """ + 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 unicode_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 + elif 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) + return result + except ValueError: + for enum_value in enum_obj: + 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)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode('ascii') + return encoded.strip('=').replace('+', '-').replace('/', '_') + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + 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): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + 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): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning( + "Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + 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): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + 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_with_traceback(SerializationError, msg, err) + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise_with_traceback(TypeError, msg, err) + + @staticmethod + def serialize_unix(attr, **kwargs): + """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 + """ + 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: + raise TypeError("Unix time object must be valid Datetime object.") + +def rest_key_extractor(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 = 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 + # https://github.com/Azure/msrest-for-python/issues/197 + return None + key = '.'.join(dict_keys[1:]) + + return working_data.get(key) + +def rest_key_case_insensitive_extractor(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 + # https://github.com/Azure/msrest-for-python/issues/197 + 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): + """Extract the attribute in "data" based on the last part of the JSON path key. + """ + 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): + """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" + """ + 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): + 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 + else: + 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 + else: # 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(object): + """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}' + r'\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?') + + def __init__(self, classes=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(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. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """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. + """ + # 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(): + 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, basestring): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map + 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 + raise_with_traceback(DeserializationError, msg, err) + else: + 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 deseralize. + """ + if target is None: + return None, None + + if isinstance(target, basestring): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ + + 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 deseralize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.warning( + "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 raw_data: Data to be processed. + :param 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 + """ + # 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, (basestring, bytes)) or hasattr(raw_data, 'read'): + return RawDeserializer.deserialize_from_text(raw_data, content_type) + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, '_subtype_map', {}) + try: + readonly = [k for k, v in response._validation.items() + if v.get('readonly')] + const = [k for k, v in response._validation.items() + 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 + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format( + kwargs, response) + raise DeserializationError(msg + str(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) + + def deserialize_data(self, data, data_type): + """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. + """ + 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 ["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_with_traceback(DeserializationError, msg, err) + else: + 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. + :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. + :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): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :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, basestring): + 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 + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """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. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # 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 '' + else: + # 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) + elif isinstance(attr, basestring): + if attr.lower() in ['true', '1']: + return True + elif attr.lower() in ['false', '0']: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == 'str': + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @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. + :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): + return data + except NameError: + return str(data) + else: + 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. + :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. + # https://github.com/Azure/azure-rest-api-specs/issues/141 + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + 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. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = '=' * (3 - (len(attr) + 3) % 4) + attr = attr + padding + 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. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(attr) + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise_with_traceback(DeserializationError, msg, err) + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :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_with_traceback(DeserializationError, msg, err) + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :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): + 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=None, defaultday=None) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :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): + 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. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) + date_obj = datetime.datetime( + *parsed_date[:6], + tzinfo=_FixedOffset(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_with_traceback(DeserializationError, msg, err) + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() + 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_with_traceback(DeserializationError, msg, err) + else: + 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. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) + try: + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise_with_traceback(DeserializationError, msg, err) + else: + return date_obj \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_vendor.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_vendor.py new file mode 100644 index 000000000000..e12b61dea670 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_vendor.py @@ -0,0 +1,21 @@ +# -------------------------------------------------------------------------- +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + + + + +def _format_url_section(template, **kwargs): + components = template.split("/") + while components: + try: + return template.format(**kwargs) + except KeyError as key: + formatted_components = template.split("/") + components = [ + c for c in formatted_components if "{}".format(key.args[0]) not in c + ] + template = "/".join(components) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_version.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_version.py new file mode 100644 index 000000000000..b9995fb385b0 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/_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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0-preview" diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/__init__.py new file mode 100644 index 000000000000..87e964a79089 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/__init__.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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import GeolocationClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk +__all__ = ['GeolocationClient'] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_client.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_client.py new file mode 100644 index 000000000000..a378c775587c --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_client.py @@ -0,0 +1,97 @@ +# 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) AutoRest 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, Optional, TYPE_CHECKING + +from azure.core import AsyncPipelineClient +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .. import models +from .._serialization import Deserializer, Serializer +from ._configuration import GeolocationClientConfiguration +from .operations import GeolocationOperations + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + +class GeolocationClient: # pylint: disable=client-accepts-api-version-keyword + """Azure Maps Geolocation REST APIs. + + :ivar geolocation: GeolocationOperations operations + :vartype geolocation: azure.maps.geolocation.aio.operations.GeolocationOperations + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param client_id: Specifies which account is intended for usage in conjunction with the Azure + AD security model. It represents a unique ID for the Azure Maps account and can be retrieved + from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see + the following `articles `_ for guidance. Default value is None. + :type client_id: str + :keyword endpoint: Service URL. Default value is "https://atlas.microsoft.com". + :paramtype endpoint: str + :keyword api_version: Api Version. Default value is "1.0". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + credential: "AsyncTokenCredential", + client_id: Optional[str] = None, + *, + endpoint: str = "https://atlas.microsoft.com", + **kwargs: Any + ) -> None: + self._config = GeolocationClientConfiguration(credential=credential, client_id=client_id, **kwargs) + self._client = AsyncPipelineClient(base_url=endpoint, config=self._config, **kwargs) + + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + self._serialize = Serializer(client_models) + self._deserialize = Deserializer(client_models) + self._serialize.client_side_validation = False + self.geolocation = GeolocationOperations( + self._client, self._config, self._serialize, self._deserialize + ) + + + def send_request( + self, + request: HttpRequest, + **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) + request_copy.url = self._client.format_url(request_copy.url) + return self._client.send_request(request_copy, **kwargs) + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "GeolocationClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_configuration.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_configuration.py new file mode 100644 index 000000000000..4da03ffdf721 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_configuration.py @@ -0,0 +1,72 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, Optional, TYPE_CHECKING + +from azure.core.configuration import Configuration +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class GeolocationClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes + """Configuration for GeolocationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param client_id: Specifies which account is intended for usage in conjunction with the Azure + AD security model. It represents a unique ID for the Azure Maps account and can be retrieved + from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see + the following `articles `_ for guidance. Default value is None. + :type client_id: str + :keyword api_version: Api Version. Default value is "1.0". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + credential: "AsyncTokenCredential", + client_id: Optional[str] = None, + **kwargs: Any + ) -> None: + super(GeolocationClientConfiguration, self).__init__(**kwargs) + api_version = kwargs.pop('api_version', "1.0") # type: str + + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.credential = credential + self.client_id = client_id + self.api_version = api_version + self.credential_scopes = kwargs.pop('credential_scopes', ['https://atlas.microsoft.com/.default']) + kwargs.setdefault('sdk_moniker', 'maps-geolocation/{}'.format(VERSION)) + self._configure(**kwargs) + + 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.retry_policy = kwargs.get('retry_policy') or policies.AsyncRetryPolicy(**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.authentication_policy = kwargs.get('authentication_policy') + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_patch.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_patch.py new file mode 100644 index 000000000000..0ad201a8c586 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/_patch.py @@ -0,0 +1,19 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__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/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/__init__.py new file mode 100644 index 000000000000..98538e2a370a --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/__init__.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. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import GeolocationOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk +__all__ = [ + 'GeolocationOperations', +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_operations.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_operations.py new file mode 100644 index 000000000000..ca06c8fc18a2 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_operations.py @@ -0,0 +1,106 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from typing import Any, Callable, Dict, Optional, TypeVar, Union + +from azure.core.exceptions import ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, map_error +from azure.core.pipeline import PipelineResponse +from azure.core.pipeline.transport import AsyncHttpResponse +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async + +from ... import models as _models +from ...operations._operations import build_geolocation_get_location_request +T = TypeVar('T') +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + +class GeolocationOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.maps.geolocation.aio.GeolocationClient`'s + :attr:`geolocation` attribute. + """ + + models = _models + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + + @distributed_trace_async + async def get_location( + self, + format: Union[str, "_models.JsonFormat"] = "json", + *, + ip_address: str, + **kwargs: Any + ) -> _models.IpAddressToLocationResult: + """**Applies to:** see pricing `tiers `_. + + This service will return the ISO country code for the provided IP address. Developers can use + this information to block or alter certain content based on geographical locations where the + application is being viewed from. + + :param format: Desired format of the response. Only ``json`` format is supported. "json" + Default value is "json". + :type format: str or ~azure.maps.geolocation.models.JsonFormat + :keyword ip_address: The IP address. Both IPv4 and IPv6 are allowed. Required. + :paramtype ip_address: str + :return: IpAddressToLocationResult + :rtype: ~azure.maps.geolocation.models.IpAddressToLocationResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop('cls', None) # type: ClsType[_models.IpAddressToLocationResult] + + + request = build_geolocation_get_location_request( + format=format, + ip_address=ip_address, + client_id=self._config.client_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + request.url = self._client.format_url(request.url) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, + stream=False, + **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) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error) + + deserialized = self._deserialize('IpAddressToLocationResult', pipeline_response) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_patch.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_patch.py new file mode 100644 index 000000000000..0ad201a8c586 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/aio/operations/_patch.py @@ -0,0 +1,19 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__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/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/__init__.py new file mode 100644 index 000000000000..06195698de88 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/__init__.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. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import CountryRegion +from ._models import ErrorAdditionalInfo +from ._models import ErrorDetail +from ._models import ErrorResponse +from ._models import IpAddressToLocationResult + +from ._enums import JsonFormat +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk +__all__ = [ + 'CountryRegion', + 'ErrorAdditionalInfo', + 'ErrorDetail', + 'ErrorResponse', + 'IpAddressToLocationResult', + 'JsonFormat', +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_enums.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_enums.py new file mode 100644 index 000000000000..d8693c01ba58 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_enums.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. +# Code generated by Microsoft (R) AutoRest 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 JsonFormat(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """JsonFormat. + """ + + #: `The JavaScript Object Notation Data Interchange Format `_ + JSON = "json" diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_models.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_models.py new file mode 100644 index 000000000000..e6c876faf1a1 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_models.py @@ -0,0 +1,181 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Optional, TYPE_CHECKING + +from .. import _serialization + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class CountryRegion(_serialization.Model): + """The object containing the country/region information. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar iso_code: The IP Address's 2-character code `(ISO 3166-1) + `_ of the country or region. Please note, IP + address in ranges reserved for special purpose will return Null for country/region. + :vartype iso_code: str + """ + + _validation = { + 'iso_code': {'readonly': True}, + } + + _attribute_map = { + "iso_code": {"key": "isoCode", "type": "str"}, + } + + def __init__( + self, + **kwargs + ): + """ + """ + super().__init__(**kwargs) + self.iso_code = None + + +class ErrorAdditionalInfo(_serialization.Model): + """The resource management error additional info. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar type: The additional info type. + :vartype type: str + :ivar info: The additional info. + :vartype info: JSON + """ + + _validation = { + 'type': {'readonly': True}, + 'info': {'readonly': True}, + } + + _attribute_map = { + "type": {"key": "type", "type": "str"}, + "info": {"key": "info", "type": "object"}, + } + + def __init__( + self, + **kwargs + ): + """ + """ + super().__init__(**kwargs) + self.type = None + self.info = None + + +class ErrorDetail(_serialization.Model): + """The error detail. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar code: The error code. + :vartype code: str + :ivar message: The error message. + :vartype message: str + :ivar target: The error target. + :vartype target: str + :ivar details: The error details. + :vartype details: list[~azure.maps.geolocation.models.ErrorDetail] + :ivar additional_info: The error additional info. + :vartype additional_info: list[~azure.maps.geolocation.models.ErrorAdditionalInfo] + """ + + _validation = { + 'code': {'readonly': True}, + 'message': {'readonly': True}, + 'target': {'readonly': True}, + 'details': {'readonly': True}, + 'additional_info': {'readonly': True}, + } + + _attribute_map = { + "code": {"key": "code", "type": "str"}, + "message": {"key": "message", "type": "str"}, + "target": {"key": "target", "type": "str"}, + "details": {"key": "details", "type": "[ErrorDetail]"}, + "additional_info": {"key": "additionalInfo", "type": "[ErrorAdditionalInfo]"}, + } + + def __init__( + self, + **kwargs + ): + """ + """ + super().__init__(**kwargs) + self.code = None + self.message = None + self.target = None + self.details = None + self.additional_info = None + + +class ErrorResponse(_serialization.Model): + """Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). + + :ivar error: The error object. + :vartype error: ~azure.maps.geolocation.models.ErrorDetail + """ + + _attribute_map = { + "error": {"key": "error", "type": "ErrorDetail"}, + } + + def __init__( + self, + *, + error: Optional["_models.ErrorDetail"] = None, + **kwargs + ): + """ + :keyword error: The error object. + :paramtype error: ~azure.maps.geolocation.models.ErrorDetail + """ + super().__init__(**kwargs) + self.error = error + + +class IpAddressToLocationResult(_serialization.Model): + """This object is returned from a successful call to IP Address to country/region API. + + Variables are only populated by the server, and will be ignored when sending a request. + + :ivar country_region: The object containing the country/region information. + :vartype country_region: ~azure.maps.geolocation.models.CountryRegion + :ivar ip_address: The IP Address of the request. + :vartype ip_address: str + """ + + _validation = { + 'country_region': {'readonly': True}, + 'ip_address': {'readonly': True}, + } + + _attribute_map = { + "country_region": {"key": "countryRegion", "type": "CountryRegion"}, + "ip_address": {"key": "ipAddress", "type": "str"}, + } + + def __init__( + self, + **kwargs + ): + """ + """ + super().__init__(**kwargs) + self.country_region = None + self.ip_address = None diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_patch.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_patch.py new file mode 100644 index 000000000000..0ad201a8c586 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/models/_patch.py @@ -0,0 +1,19 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__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/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/__init__.py new file mode 100644 index 000000000000..98538e2a370a --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/__init__.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. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import GeolocationOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk +__all__ = [ + 'GeolocationOperations', +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_operations.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_operations.py new file mode 100644 index 000000000000..c2b0dd30a499 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_operations.py @@ -0,0 +1,150 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from typing import Any, Callable, Dict, Optional, TypeVar, Union + +from azure.core.exceptions import ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, map_error +from azure.core.pipeline import PipelineResponse +from azure.core.pipeline.transport import HttpResponse +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._serialization import Serializer +from .._vendor import _format_url_section +T = TypeVar('T') +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_geolocation_get_location_request( + format: Union[str, "_models.JsonFormat"] = "json", + *, + ip_address: str, + client_id: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop('api_version', _params.pop('api-version', "1.0")) # type: str + accept = _headers.pop('Accept', "application/json") + + # Construct URL + _url = "/geolocation/ip/{format}" + path_format_arguments = { + "format": _SERIALIZER.url("format", format, 'str'), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + _params['ip'] = _SERIALIZER.query("ip_address", ip_address, 'str') + + # Construct headers + if client_id is not None: + _headers['x-ms-client-id'] = _SERIALIZER.header("client_id", client_id, 'str') + _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + + return HttpRequest( + method="GET", + url=_url, + params=_params, + headers=_headers, + **kwargs + ) + +class GeolocationOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.maps.geolocation.GeolocationClient`'s + :attr:`geolocation` attribute. + """ + + models = _models + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + + @distributed_trace + def get_location( + self, + format: Union[str, "_models.JsonFormat"] = "json", + *, + ip_address: str, + **kwargs: Any + ) -> _models.IpAddressToLocationResult: + """**Applies to:** see pricing `tiers `_. + + This service will return the ISO country code for the provided IP address. Developers can use + this information to block or alter certain content based on geographical locations where the + application is being viewed from. + + :param format: Desired format of the response. Only ``json`` format is supported. "json" + Default value is "json". + :type format: str or ~azure.maps.geolocation.models.JsonFormat + :keyword ip_address: The IP address. Both IPv4 and IPv6 are allowed. Required. + :paramtype ip_address: str + :return: IpAddressToLocationResult + :rtype: ~azure.maps.geolocation.models.IpAddressToLocationResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop('cls', None) # type: ClsType[_models.IpAddressToLocationResult] + + + request = build_geolocation_get_location_request( + format=format, + ip_address=ip_address, + client_id=self._config.client_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + request.url = self._client.format_url(request.url) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, + stream=False, + **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) + error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response) + raise HttpResponseError(response=response, model=error) + + deserialized = self._deserialize('IpAddressToLocationResult', pipeline_response) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_patch.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_patch.py new file mode 100644 index 000000000000..0ad201a8c586 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/operations/_patch.py @@ -0,0 +1,19 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__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/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/py.typed b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_generated/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_geolocation_client.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_geolocation_client.py new file mode 100644 index 000000000000..df1ad5ec5740 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_geolocation_client.py @@ -0,0 +1,99 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +# pylint: disable=unused-import,ungrouped-imports, R0904, C0302 +from typing import Union, Any +from azure.core.tracing.decorator import distributed_trace +from azure.core.credentials import AzureKeyCredential, TokenCredential + +from ._base_client import GeolocationClientBase +from .models import ( + Geolocation +) + + +# By default, use the latest supported API version +class GeolocationClient(GeolocationClientBase): + """Azure Maps Geolocation REST APIs. + + :param credential: + Credential needed for the client to connect to Azure. + :type credential: + ~azure.core.credentials.TokenCredential or ~azure.core.credentials.AzureKeyCredential + :keyword str client_id: + Specifies which account is intended for usage with the Azure AD security model. + It represents a unique ID for the Azure Maps account. + :keyword api_version: + The API version of the service to use for requests. It defaults to the latest service version. + Setting to an older version may result in reduced feature compatibility. + :paramtype api_version: str + + .. admonition:: Example: + + .. literalinclude:: ../samples/sample_authentication.py + :start-after: [START create_maps_geolocation_service_client_with_key] + :end-before: [END create_maps_geolocation_service_client_with_key] + :language: python + :dedent: 4 + :caption: Creating the GeolocationClient with an subscription key. + .. literalinclude:: ../samples/sample_authentication.py + :start-after: [START create_maps_geolocation_service_client_with_aad] + :end-before: [END create_maps_geolocation_service_client_with_aad] + :language: python + :dedent: 4 + :caption: Creating the GeolocationClient with a token credential. + """ + + def __init__( + self, + credential: Union[AzureKeyCredential, TokenCredential], + **kwargs: Any + ) -> None: + + super().__init__( + credential=credential, **kwargs + ) + + @distributed_trace + def get_geolocation( + self, + ip_address: str, + **kwargs: Any + ) -> Geolocation: + """ + This service will return the ISO country code for the provided IP address. Developers can use + this information to block or alter certain content based on geographical locations where the + application is being viewed from. + + :param ip_address: + The IP address. Both IPv4 and IPv6 are allowed. Required. + :type ip_address: + str + :return: + Geolocation + :rtype: + ~azure.maps.geolocation.models.Geolocation + :raises ~azure.core.exceptions.HttpResponseError: + + .. admonition:: Example: + + .. literalinclude:: ../samples/sample_get_geolocation.py + :start-after: [START get_geolocation] + :end-before: [END get_geolocation] + :language: python + :dedent: 4 + :caption: Return the ISO country code for the provided IP address. + """ + + geolocation_result = self._geolocation_client.get_location( + format="json", + ip_address=ip_address, + **kwargs + ) + + return Geolocation( + ip_address=geolocation_result.ip_address, + iso_code=geolocation_result.country_region.iso_code + ) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_version.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_version.py new file mode 100644 index 000000000000..e5754a47ce68 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/__init__.py new file mode 100644 index 000000000000..bd409a845918 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/__init__.py @@ -0,0 +1,10 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._geolocation_client_async import GeolocationClient +__all__ = ['GeolocationClient'] diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_base_client_async.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_base_client_async.py new file mode 100644 index 000000000000..967769b83a5d --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_base_client_async.py @@ -0,0 +1,48 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +from typing import Union, Any +from azure.core.pipeline.policies import AzureKeyCredentialPolicy +from azure.core.credentials import AzureKeyCredential +from azure.core.credentials_async import AsyncTokenCredential +from .._generated.aio import GeolocationClient as _GeolocationClient +from .._version import VERSION + +def _authentication_policy(credential): + authentication_policy = None + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if isinstance(credential, AzureKeyCredential): + authentication_policy = AzureKeyCredentialPolicy( + name="subscription-key", credential=credential + ) + elif credential is not None and not hasattr(credential, "get_token"): + raise TypeError( + "Unsupported credential: {}. Use an instance of AzureKeyCredential " + "or a token credential from azure.identity".format(type(credential)) + ) + return authentication_policy + +class AsyncGeolocationClientBase: + def __init__( + self, + credential: Union[AzureKeyCredential, AsyncTokenCredential], + **kwargs: Any + ) -> None: + + self._maps_client = _GeolocationClient( + credential=credential, # type: ignore + api_version=kwargs.pop("api_version", VERSION), + authentication_policy=kwargs.pop("authentication_policy", _authentication_policy(credential)), + **kwargs + ) + self._geolocation_client = self._maps_client.geolocation + + async def __aenter__(self): + await self._maps_client.__aenter__() # pylint:disable=no-member + return self + + async def __aexit__(self, *args): + return await self._maps_client.__aexit__(*args) # pylint:disable=no-member diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_geolocation_client_async.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_geolocation_client_async.py new file mode 100644 index 000000000000..0f48f9e5a17f --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_geolocation_client_async.py @@ -0,0 +1,96 @@ +# --------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# --------------------------------------------------------------------- + +# pylint: disable=unused-import,ungrouped-imports, R0904, C0302, too-many-function-args, W0212 +from typing import Any, Union +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.credentials import AzureKeyCredential +from azure.core.credentials_async import AsyncTokenCredential + +from ._base_client_async import AsyncGeolocationClientBase +from ..models import ( + Geolocation +) + +# By default, use the latest supported API version +class GeolocationClient(AsyncGeolocationClientBase): + """Azure Maps Geolocation REST APIs. + + :param credential: Credential needed for the client to connect to Azure. + :type credential: + ~azure.core.credentials.AsyncTokenCredential or ~azure.core.credentials.AzureKeyCredential + :keyword str client_id: + Specifies which account is intended for usage with the Azure AD security model. + It represents a unique ID for the Azure Maps account. + :keyword api_version: + The API version of the service to use for requests. It defaults to the latest service version. + Setting to an older version may result in reduced feature compatibility. + :paramtype api_version: str + .. admonition:: Example: + + .. literalinclude:: ../samples/async_samples/sample_authentication_async.py + :start-after: [START create_maps_geolocation_service_client_with_key_async] + :end-before: [END create_maps_geolocation_service_client_with_key_async] + :language: python + :dedent: 4 + :caption: Creating the GeolocationClient with an subscription key. + .. literalinclude:: ../samples/async_samples/sample_authentication_async.py + :start-after: [START create_maps_geolocation_service_client_with_aad_async] + :end-before: [END create_maps_geolocation_service_client_with_aad_async] + :language: python + :dedent: 4 + :caption: Creating the GeolocationClient with a token credential. + """ + def __init__( + self, + credential: Union[AzureKeyCredential, AsyncTokenCredential], + **kwargs: Any + ) -> None: + super().__init__( + credential=credential, **kwargs + ) + + + @distributed_trace_async + async def get_geolocation( + self, + ip_address: str, + **kwargs: Any + ) -> Geolocation: + """ + This service will return the ISO country code for the provided IP address. Developers can use + this information to block or alter certain content based on geographical locations where the + application is being viewed from. + + :param ip_address: + The IP address. Both IPv4 and IPv6 are allowed. Required. + :type ip_address: str + :return: + Geolocation + :rtype: + ~azure.maps.geolocation.models.Geolocation + :raises ~azure.core.exceptions.HttpResponseError: + + .. admonition:: Example: + + .. literalinclude:: ../samples/async_samples/sample_get_geolocation_async.py + :start-after: [START get_geolocation_async] + :end-before: [END get_geolocation_async] + :language: python + :dedent: 4 + :caption: Return the ISO country code for the provided IP address. + """ + + geolocation_result = await self._geolocation_client.get_location( + format="json", + ip_address=ip_address, + **kwargs + ) + + return Geolocation( + ip_address=geolocation_result.ip_address, + iso_code=geolocation_result.country_region.iso_code + ) diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/__init__.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/__init__.py new file mode 100644 index 000000000000..340c209cc384 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/__init__.py @@ -0,0 +1,9 @@ + +from ._models import ( + Geolocation +) + + +__all__ = [ + 'Geolocation' +] diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/_models.py b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/_models.py new file mode 100644 index 000000000000..43be5cc98118 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/_models.py @@ -0,0 +1,23 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +class Geolocation(object): + """Represents coordinate latitude and longitude + + :keyword ip_address: + The IP Address of the request. + :paramtype ip_address: str + :keyword iso_code: iso_code: + The IP Address's 2-character code of the country or region. + Please note, IP address in ranges reserved for special purpose will return Null for country/region. + :paramtype iso_code: str + """ + def __init__( + self, + ip_address: str = None, + iso_code: str = None + ): + self.ip_address = ip_address + self.iso_code = iso_code diff --git a/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/py.typed b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/azure/maps/geolocation/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/dev_requirements.txt b/sdk/maps/azure-maps-geolocation/dev_requirements.txt new file mode 100644 index 000000000000..1ab09a46e87f --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/dev_requirements.txt @@ -0,0 +1,5 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +-e ../../core/azure-core +-e ../../identity/azure-identity +aiohttp>=3.0; python_version >= '3.7' \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/samples/README.md b/sdk/maps/azure-maps-geolocation/samples/README.md new file mode 100644 index 000000000000..8a11d57104f0 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/samples/README.md @@ -0,0 +1,52 @@ +--- +page_type: sample +languages: + - python +products: + - azure + - azure-maps-geolocation +--- + +# Samples for Azure Maps Geolocation client library for Python + +These code samples show common scenario operations with the Azure Maps Geolocation client library. + +Authenticate the client with a Azure Maps Geolocation [API Key Credential](https://docs.microsoft.com/azure/azure-maps/how-to-manage-account-keys): + +[samples authentication](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/maps/azure-maps-geolocation/samples/sample_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_authentication_async.py)) + +Then for common Azure Maps Geolocation operations: + +* Perform get geolocation: [sample_get_geolocation.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/maps/azure-maps-geolocation/samples/sample_get_geolocation.py) ([async version](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_get_geolocation_async.py)) + +## Prerequisites + +* Python 3.6 or later is required to use this package +* You must have an [Azure subscription](https://azure.microsoft.com/free/) +* A deployed Maps Services resource. You can create the resource via [Azure Portal][azure_portal] or [Azure CLI][azure_cli]. + +## Setup + +1. Install the Azure Maps Geolocation client library for Python with [pip](https://pypi.org/project/pip/): + + ```bash + pip install azure-maps-geolocation --pre + ``` + +2. Clone or download [this repository](https://github.com/Azure/azure-sdk-for-python) +3. Open this sample folder in [Visual Studio Code](https://code.visualstudio.com) or your IDE of choice. + +## Running the samples + +1. Open a terminal window and `cd` to the directory that the samples are saved in. +2. Set the environment variables specified in the sample file you wish to run. +3. Follow the usage described in the file, e.g. `python sample_get_geolocation.py` + +## Next steps + +Check out the [API reference documentation](https://docs.microsoft.com/rest/api/maps/geolocation) +to learn more about what you can do with the Azure Maps Geolocation client library. + + +[azure_portal]: https://portal.azure.com +[azure_cli]: https://docs.microsoft.com/cli/azure diff --git a/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_authentication_async.py b/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_authentication_async.py new file mode 100644 index 000000000000..47f0b283a6f3 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_authentication_async.py @@ -0,0 +1,71 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: sample_authentication_async.py +DESCRIPTION: + This sample demonstrates how to authenticate with the Azure Maps Geolocation + service with an Subscription key. See more details about authentication here: + https://docs.microsoft.com/azure/azure-maps/how-to-manage-account-keys +USAGE: + python sample_authentication_async.py + Set the environment variables with your own values before running the sample: + - AZURE_SUBSCRIPTION_KEY - your Azure Maps subscription key + - TENANT_ID - your tenant ID that wants to access Azure Maps account + - CLIENT_ID - your client ID that wants to access Azure Maps account + - CLIENT_SECRET - your client secret that wants to access Azure Maps account + - AZURE_MAPS_CLIENT_ID - your Azure Maps client ID +""" + +import asyncio +import os +import sys + +async def authentication_maps_service_client_with_subscription_key_credential_async(): + # [START create_maps_geolocation_service_client_with_key_async] + from azure.core.credentials import AzureKeyCredential + from azure.maps.geolocation.aio import GeolocationClient + + subscription_key = os.getenv("AZURE_SUBSCRIPTION_KEY") + + maps_geolocation_client = GeolocationClient(credential=AzureKeyCredential(subscription_key)) + # [END create_maps_geolocation_service_client_with_key_async] + + async with maps_geolocation_client: + result = await maps_geolocation_client.get_geolocation(ip_address="2001:4898:80e8:b::189") + + print(result) + +async def authentication_maps_service_client_with_aad_credential_async(): + """DefaultAzureCredential will use the values from these environment + variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, AZURE_MAPS_CLIENT_ID + """ + # [START create_maps_geolocation_service_client_with_aad_async] + from azure.identity.aio import DefaultAzureCredential + from azure.maps.geolocation.aio import GeolocationClient + + credential = DefaultAzureCredential() + maps_client_id = os.getenv("AZURE_MAPS_CLIENT_ID") + + maps_geolocation_client = GeolocationClient(client_id=maps_client_id, credential=credential) + # [END create_maps_geolocation_service_client_with_aad_async] + + async with maps_geolocation_client: + result = await maps_geolocation_client.get_geolocation(ip_address="2001:4898:80e8:b::189") + + print(result) + + +async def main(): + await authentication_maps_service_client_with_subscription_key_credential_async() + await authentication_maps_service_client_with_aad_credential_async() + +if __name__ == '__main__': + if sys.platform == 'win32': + asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) + asyncio.run(main()) \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_get_geolocation_async.py b/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_get_geolocation_async.py new file mode 100644 index 000000000000..f4d19c2cbbb3 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/samples/async_samples/sample_get_geolocation_async.py @@ -0,0 +1,39 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: sample_get_geolocation_async.py +DESCRIPTION: + This sample demonstrates return the ISO country code for the provided IP address. +USAGE: + python sample_get_geolocation_async.py + + Set the environment variables with your own values before running the sample: + - AZURE_SUBSCRIPTION_KEY - your subscription key +""" +import asyncio +import os + +subscription_key = os.getenv("AZURE_SUBSCRIPTION_KEY") + +async def get_geolocation_async(): + # [START get_geolocation_async] + from azure.core.credentials import AzureKeyCredential + from azure.maps.geolocation.aio import GeolocationClient + + maps_geolocation_client = GeolocationClient(credential=AzureKeyCredential(subscription_key)) + + async with maps_geolocation_client: + result = await maps_geolocation_client.get_geolocation(ip_address="2001:4898:80e8:b::189") + + print("Get Country code with Geolocation:") + print(result.iso_code) + # [END get_geolocation_async] + +if __name__ == '__main__': + asyncio.run(get_geolocation_async()) diff --git a/sdk/maps/azure-maps-geolocation/samples/sample_authentication.py b/sdk/maps/azure-maps-geolocation/samples/sample_authentication.py new file mode 100644 index 000000000000..a8580e5160d1 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/samples/sample_authentication.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. +# -------------------------------------------------------------------------- + +""" +FILE: sample_authentication.py +DESCRIPTION: + This sample demonstrates how to authenticate with the Azure Maps Geolocation + service with an Subscription key. See more details about authentication here: + https://docs.microsoft.com/azure/azure-maps/how-to-manage-account-keys +USAGE: + python sample_authentication.py + Set the environment variables with your own values before running the sample: + - AZURE_SUBSCRIPTION_KEY - your Azure Maps subscription key + - TENANT_ID - your tenant ID that wants to access Azure Maps account + - CLIENT_ID - your client ID that wants to access Azure Maps account + - CLIENT_SECRET - your client secret that wants to access Azure Maps account + - AZURE_MAPS_CLIENT_ID - your Azure Maps client ID +""" + +import os + +def authentication_maps_service_client_with_subscription_key_credential(): + # [START create_maps_geolocation_service_client_with_key] + from azure.core.credentials import AzureKeyCredential + from azure.maps.geolocation import GeolocationClient + + subscription_key = os.getenv("AZURE_SUBSCRIPTION_KEY") + + maps_geolocation_client = GeolocationClient(credential=AzureKeyCredential(subscription_key)) + # [END create_maps_geolocation_service_client_with_key] + + result = maps_geolocation_client.get_geolocation(ip_address="2001:4898:80e8:b::189") + + print(result) + + +def authentication_maps_service_client_with_aad_credential(): + """DefaultAzureCredential will use the values from these environment + variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, AZURE_MAPS_CLIENT_ID + """ + # [START create_maps_geolocation_service_client_with_aad] + from azure.identity import DefaultAzureCredential + from azure.maps.geolocation import GeolocationClient + + credential = DefaultAzureCredential() + maps_client_id = os.getenv("AZURE_MAPS_CLIENT_ID") + + maps_geolocation_client = GeolocationClient(client_id=maps_client_id, credential=credential) + # [END create_maps_geolocation_service_client_with_aad] + + result = maps_geolocation_client.get_geolocation(ip_address="2001:4898:80e8:b::189") + + print(result) + +if __name__ == '__main__': + authentication_maps_service_client_with_subscription_key_credential() + authentication_maps_service_client_with_aad_credential() \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/samples/sample_get_geolocation.py b/sdk/maps/azure-maps-geolocation/samples/sample_get_geolocation.py new file mode 100644 index 000000000000..79b50bf2edbf --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/samples/sample_get_geolocation.py @@ -0,0 +1,40 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: sample_get_geolocation.py +DESCRIPTION: + This sample demonstrates return the ISO country code for the provided IP address. +USAGE: + python sample_get_geolocation.py + + Set the environment variables with your own values before running the sample: + - AZURE_SUBSCRIPTION_KEY - your subscription key +""" + +import os + +subscription_key = os.getenv("AZURE_SUBSCRIPTION_KEY") + +def get_geolocation(): + # [START get_geolocation] + from azure.core.credentials import AzureKeyCredential + from azure.maps.geolocation import GeolocationClient + + maps_geolocation_client = GeolocationClient(credential=AzureKeyCredential(subscription_key)) + + result = maps_geolocation_client.get_geolocation(ip_address="2001:4898:80e8:b::189") + + print("Get Country code with Geolocation:") + print(result.iso_code) + + # [END get_geolocation] + + +if __name__ == '__main__': + get_geolocation() \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/sdk_packaging.toml b/sdk/maps/azure-maps-geolocation/sdk_packaging.toml new file mode 100644 index 000000000000..8e07d3e214f4 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/sdk_packaging.toml @@ -0,0 +1,9 @@ +[packaging] +package_name = "azure-maps-geolocation" +package_nspkg = "azure-maps-nspkg" +package_pprint_name = "Maps Geolocation" +package_doc_id = "" +is_stable = false +is_arm = true +need_msrestazure = false +need_azuremgmtcore = true diff --git a/sdk/maps/azure-maps-geolocation/setup.py b/sdk/maps/azure-maps-geolocation/setup.py new file mode 100644 index 000000000000..3f2a02883105 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/setup.py @@ -0,0 +1,86 @@ +#!/usr/bin/env python + +#------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +#-------------------------------------------------------------------------- + +import re +import os.path +from io import open +from setuptools import find_packages, setup + +# Change the PACKAGE_NAME only to change folder and different name +PACKAGE_NAME = "azure-maps-geolocation" +PACKAGE_PPRINT_NAME = "Maps Geolocation" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace('-', '/') +# a-b-c => a.b.c +namespace_name = PACKAGE_NAME.replace('-', '.') + +# azure v0.x is not compatible with this package +# azure v0.x used to have a __version__ attribute (newer versions don't) +try: + import azure + try: + ver = azure.__version__ + raise Exception( + 'This package is incompatible with azure=={}. '.format(ver) + + 'Uninstall it with "pip uninstall azure".' + ) + except AttributeError: + pass +except ImportError: + pass + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, 'version.py') + if os.path.exists(os.path.join(package_folder_path, 'version.py')) + else os.path.join(package_folder_path, '_version.py'), 'r') as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', + fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError('Cannot find version information') + +with open('README.md', encoding='utf-8') as f: + readme = f.read() +with open('CHANGELOG.md', encoding='utf-8') as f: + changelog = f.read() + +setup( + name=PACKAGE_NAME, + version=version, + description='Microsoft Azure {} Client Library for Python'.format(PACKAGE_PPRINT_NAME), + long_description=readme + '\n\n' + changelog, + long_description_content_type='text/markdown', + license='MIT License', + author='Microsoft Corporation', + author_email='azpysdkhelp@microsoft.com', + url='https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-geolocation', + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages(exclude=[ + 'tests', + # Exclude packages that will be covered by PEP420 or nspkg + 'azure', + 'azure.maps', + ]), + install_requires=[ + 'msrest>=0.6.21', + 'azure-common~=1.1', + 'azure-mgmt-core<2.0.0,>=1.3.0' + ] +) diff --git a/sdk/maps/azure-maps-geolocation/swagger/README.md b/sdk/maps/azure-maps-geolocation/swagger/README.md new file mode 100644 index 000000000000..6ee2d18e5907 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/swagger/README.md @@ -0,0 +1,39 @@ +# Azure Maps Geolocation for Python + +> see https://aka.ms/autorest + +## Setup + +Install Autorest v3 + +```ps +npm install -g autorest +``` + +### Generation + +```ps +cd +autorest --v3 --python +``` + +### Settings + +```yaml +tag: 1.0-preview +require: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/maps/data-plane/Geolocation/readme.md +output-folder: ../azure/maps/route/_generated +namespace: azure.maps.route +no-namespace-folders: true +use-extension: + "@autorest/modelerfour": "4.22.3" + +license-header: MICROSOFT_MIT_NO_VERSION +enable-xml: true +vanilla: true +clear-output-folder: true +python: true +python3-only: true +version-tolerant: true +models-mode: msrest +``` diff --git a/sdk/maps/azure-maps-geolocation/tests/conftest.py b/sdk/maps/azure-maps-geolocation/tests/conftest.py new file mode 100644 index 000000000000..aaf0242a8c16 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/tests/conftest.py @@ -0,0 +1,26 @@ +# ------------------------------------------------------------------------- +# 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 ( + add_general_regex_sanitizer, + add_header_regex_sanitizer, + add_oauth_response_sanitizer, + test_proxy +) + +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + subscription_key = os.environ.get("SUBSCRIPTION_KEY", "subscription-key") + tenant_id = os.environ.get("MAPS_TENANT_ID", "tenant-id") + client_secret = os.environ.get("MAPS_CLIENT_SECRET", "MyClientSecret") + add_general_regex_sanitizer(regex=subscription_key, value="AzureMapsSubscriptionKey") + add_general_regex_sanitizer(regex=tenant_id, value="MyTenantId") + add_general_regex_sanitizer(regex=client_secret, value="MyClientSecret") + # add_oauth_response_sanitizer() diff --git a/sdk/maps/azure-maps-geolocation/tests/geolocation_preparer.py b/sdk/maps/azure-maps-geolocation/tests/geolocation_preparer.py new file mode 100644 index 000000000000..1a0973c12519 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/tests/geolocation_preparer.py @@ -0,0 +1,15 @@ +# ------------------------------------------------------------------------- +# 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 devtools_testutils import EnvironmentVariableLoader + +MapsGeolocationPreparer = functools.partial( + EnvironmentVariableLoader, "maps", + subscription_key="", + maps_client_id="fake_client_id", + maps_client_secret="fake_secret", + maps_tenant_id="fake_tenant_id", +) \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestGeolocationClienttest_get_geolocation.json b/sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestGeolocationClienttest_get_geolocation.json new file mode 100644 index 000000000000..3de74777e328 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestGeolocationClienttest_get_geolocation.json @@ -0,0 +1,34 @@ +{ + "Entries": [ + { + "RequestUri": "https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0.0b1\u0026ip=2001%3A4898%3A80e8%3Ab%3A%3A189", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "application/json", + "Accept-Encoding": "gzip, deflate", + "Connection": "keep-alive", + "subscription-key": "AzureMapsSubscriptionKey", + "User-Agent": "azsdk-python-maps-geolocation/1.0-preview Python/3.9.13 (Windows-10-10.0.22621-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "Content-Length": "70", + "Content-Type": "application/json; charset=utf-8", + "Date": "Fri, 30 Sep 2022 09:08:53 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains", + "X-Cache": "CONFIG_NOCACHE", + "X-Content-Type-Options": "nosniff", + "x-ms-azuremaps-region": "West US 2", + "X-MSEdge-Ref": "Ref A: 5BB3B4B57AE04246ACA09EE9147DA040 Ref B: TPE30EDGE0719 Ref C: 2022-09-30T09:08:53Z" + }, + "ResponseBody": { + "countryRegion": { + "isoCode": "US" + }, + "ipAddress": "2001:4898:80e8:b::189" + } + } + ], + "Variables": {} +} diff --git a/sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestMapsGeolocationClienttest_get_geolocation.json b/sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestMapsGeolocationClienttest_get_geolocation.json new file mode 100644 index 000000000000..14721eac9d58 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/tests/recordings/test_geolocation_client.pyTestMapsGeolocationClienttest_get_geolocation.json @@ -0,0 +1,34 @@ +{ + "Entries": [ + { + "RequestUri": "https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0.0b1\u0026ip=2001%3A4898%3A80e8%3Ab%3A%3A189", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "application/json", + "Accept-Encoding": "gzip, deflate", + "Connection": "keep-alive", + "subscription-key": "AzureMapsSubscriptionKey", + "User-Agent": "azsdk-python-maps-geolocation/1.0-preview Python/3.9.13 (Windows-10-10.0.22621-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "Content-Length": "70", + "Content-Type": "application/json; charset=utf-8", + "Date": "Mon, 26 Sep 2022 18:41:30 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains", + "X-Cache": "CONFIG_NOCACHE", + "X-Content-Type-Options": "nosniff", + "x-ms-azuremaps-region": "West US 2", + "X-MSEdge-Ref": "Ref A: 5F2DC95F34554E0A988509681761B2A6 Ref B: TPE30EDGE0713 Ref C: 2022-09-26T18:41:30Z" + }, + "ResponseBody": { + "countryRegion": { + "isoCode": "US" + }, + "ipAddress": "2001:4898:80e8:b::189" + } + } + ], + "Variables": {} +} diff --git a/sdk/maps/azure-maps-geolocation/tests/test_client_unit.py b/sdk/maps/azure-maps-geolocation/tests/test_client_unit.py new file mode 100644 index 000000000000..788ecd98eb12 --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/tests/test_client_unit.py @@ -0,0 +1,30 @@ +import sys +import pytest +from unittest.mock import Mock +from devtools_testutils import AzureTestCase +from azure.core.exceptions import ServiceRequestError +from azure.core.credentials import AzureKeyCredential +from azure.maps.geolocation import GeolocationClient + + +# cSpell:disable +def create_mock_client(): + return GeolocationClient(credential= Mock(AzureKeyCredential)) + +class AzureGeolocationClientUnitTest(AzureTestCase): + def test_get_geolocation(self): + client = create_mock_client() + with pytest.raises(ServiceRequestError): + client.get_geolocation(ip_address="12345123") + + +if __name__ == "__main__" : + testArgs = [ "-v" , "-s" ] if len(sys.argv) == 1 else sys.argv[1:] + #testArgs = [ "-s" , "-n" , "auto" , "--dist=loadscope" ] if len(sys.argv) == 1 else sys.argv[1:] + #pytest-xdist: -n auto --dist=loadscope + #pytest-parallel: --tests-per-worker auto + #print( "testArgs={}".format(testArgs) ) + + pytest.main(args=testArgs) + + print("main() Leave") \ No newline at end of file diff --git a/sdk/maps/azure-maps-geolocation/tests/test_geolocation_client.py b/sdk/maps/azure-maps-geolocation/tests/test_geolocation_client.py new file mode 100644 index 000000000000..334cf0a9b4aa --- /dev/null +++ b/sdk/maps/azure-maps-geolocation/tests/test_geolocation_client.py @@ -0,0 +1,24 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import os +from azure.core.credentials import AccessToken, AzureKeyCredential +from azure.maps.geolocation import GeolocationClient +from devtools_testutils import AzureRecordedTestCase, recorded_by_proxy +from geolocation_preparer import MapsGeolocationPreparer + +class TestGeolocationClient(AzureRecordedTestCase): + def setup_method(self, method): + self.client = GeolocationClient( + credential=AzureKeyCredential(os.environ.get('AZURE_SUBSCRIPTION_KEY', "AzureMapsSubscriptionKey")) + ) + assert self.client is not None + + @MapsGeolocationPreparer() + @recorded_by_proxy + def test_get_geolocation(self): + result = self.client.get_geolocation(ip_address="2001:4898:80e8:b::189") + assert result is not None + assert result.iso_code == 'US' \ No newline at end of file diff --git a/sdk/maps/ci.yml b/sdk/maps/ci.yml index d195e4f9ced6..ebac701e5ab9 100644 --- a/sdk/maps/ci.yml +++ b/sdk/maps/ci.yml @@ -27,9 +27,12 @@ extends: template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml parameters: ServiceDirectory: maps + TestProxy: true + TestTimeoutInMinutes: 120 Artifacts: - name: azure-mgmt-maps safeName: azuremgmtmaps - name: azure-maps-search safeName: azuremapssearch - + - name: azure-maps-geolocation + safeName: azuremapsgeolocation diff --git a/sdk/maps/test-resources.json b/sdk/maps/test-resources.json index 1c22698a8c53..c0693fc30cf6 100644 --- a/sdk/maps/test-resources.json +++ b/sdk/maps/test-resources.json @@ -1,100 +1,104 @@ { - "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "baseName": { + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": { + "baseName": { + "type": "string", + "defaultValue": "[resourceGroup().name]", + "metadata": { + "description": "The base resource name." + } + }, + "tenantId": { + "type": "string", + "metadata": { + "description": "The tenant id to which the application and resources belong." + } + }, + "testApplicationOid": { "type": "string", - "defaultValue": "[resourceGroup().name]", "metadata": { - "description": "The base resource name." + "description": "The client OID to grant access to test resources." } - }, - "endpointPrefix": { - "defaultValue": "maps", - "type": "string" - }, - "mapsServicesEndpointSuffix": { - "defaultValue": ".maps.azure.com", - "type": "string" - }, - "testApplicationOid": { - "type": "string", + }, + "testApplicationId": { + "type": "string", "metadata": { - "description": "The client OID to grant access to test resources." + "description": "The application client id used to run tests." } - }, - "tenantId": { - "type": "string", - "metadata": { - "description": "The tenant id to which the application and resources belong." + }, + "testApplicationSecret": { + "type": "string", + "metadata": { + "description": "The application client secret used to run tests." } + } + }, + "variables": { + "roleDefinitionId": "[concat('/subscriptions/', subscription().subscriptionId, '/providers/Microsoft.Authorization/roleDefinitions/8f5e0ce6-4f7b-4dcf-bddf-e6f48634a204')]", + "mapsAccountName": "[guid(resourceGroup().id, deployment().name, parameters('baseName'))]" + }, + "resources": [ + { + "type": "Microsoft.Maps/accounts", + "apiVersion": "2021-12-01-preview", + "name": "[variables('mapsAccountName')]", + "location": "eastus", + "sku": { + "name": "G2", + "tier": "Standard" }, - "testApplicationId": { - "type": "string", - "metadata": { - "description": "The application client id used to run tests." - } + "kind": "Gen2", + "identity": { + "type": "None" }, - "testApplicationSecret": { - "type": "string", - "metadata": { - "description": "The application client secret used to run tests." + "properties": { + "disableLocalAuth": false, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "*" + ] + } + ] } } }, - "variables": { - "uniqueSubDomainName": "[format('{0}-{1}', parameters('baseName'), parameters('endpointPrefix'))]", - "contributorRoleId": "b24988ac-6180-42a0-ab88-20f7382dd24c", - "mapsAccountName": "[guid(resourceGroup().id, deployment().name, parameters('baseName'))]" - }, - "resources": [ - { - "type": "Microsoft.Maps/accounts", - "apiVersion": "2021-12-01-preview", - "name": "[variables('mapsAccountName')]", - "location": "eastus", - "sku": { - "name": "G2", - "tier": "Standard" - }, - "kind": "Gen2", - "identity": { - "type": "None" - }, + { + "type": "Microsoft.Authorization/roleAssignments", + "apiVersion": "2018-09-01-preview", + "name": "[guid(resourceGroup().id)]", "properties": { - "disableLocalAuth": false, - "cors": { - "corsRules": [ - { - "allowedOrigins": [ - "*" - ] - } - ] - } + "roleDefinitionId": "[variables('roleDefinitionId')]", + "principalId": "[parameters('testApplicationOid')]" } - } - ], - "outputs": { - "AZURE_TENANT_ID": { - "type": "string", - "value": "[parameters('tenantId')]" - }, - "AZURE_CLIENT_ID": { - "type": "string", - "value": "[parameters('testApplicationId')]" - }, - "AZURE_CLIENT_SECRET": { - "type": "string", - "value": "[parameters('testApplicationSecret')]" - }, - "AZURE_SUBSCRIPTION_KEY": { - "type": "string", - "value": "[listKeys(resourceId('Microsoft.Maps/accounts',variables('mapsAccountName')), '2021-12-01-preview').primaryKey]" - }, - "RESOURCE_GROUP_NAME": { + } + ], + "outputs": { + "AZURE_TENANT_ID": { + "type": "string", + "value": "[parameters('tenantId')]" + }, + "AZURE_CLIENT_ID": { + "type": "string", + "value": "[parameters('testApplicationId')]" + }, + "AZURE_CLIENT_SECRET": { + "type": "string", + "value": "[parameters('testApplicationSecret')]" + }, + "AZURE_MAPS_CLIENT_ID": { "type": "string", - "value": "[resourceGroup().Name]" - } + "value": "[reference(resourceId('Microsoft.Maps/accounts',variables('mapsAccountName'))).uniqueId]" + }, + "AZURE_SUBSCRIPTION_KEY": { + "type": "string", + "value": "[listKeys(resourceId('Microsoft.Maps/accounts',variables('mapsAccountName')), '2021-12-01-preview').primaryKey]" + }, + "RESOURCE_GROUP_NAME": { + "type": "string", + "value": "[resourceGroup().Name]" } - } \ No newline at end of file + } +} diff --git a/sdk/maps/tests.yml b/sdk/maps/tests.yml index c7c2750c9078..6f3c0c15bb33 100644 --- a/sdk/maps/tests.yml +++ b/sdk/maps/tests.yml @@ -13,9 +13,6 @@ stages: - $(sub-config-azure-cloud-test-resources) Clouds: Public EnvVars: - AZURE_CLIENT_ID: $(MAPS_CLIENT_ID) - AZURE_CLIENT_SECRET: $(MAPS_CLIENT_SECRET) - AZURE_SUBSCRIPTION_KEY: $(MAPS_SUBSCRIPTION_ID) - AZURE_TENANT_ID: $(MAPS_TENANT_ID) TEST_MODE: "RunLiveNoRecord" - AZURE_TEST_RUN_LIVE: "true" + AZURE_SKIP_LIVE_RECORDING: "true" + AZURE_TEST_RUN_LIVE: "true" \ No newline at end of file