[Azure Maps] - Onboarding/Signoff for Search SDKs (Azure#24953)

* Search SDK onboarding review

* Update README

* Modification

- Add SearchClientBase
- Aligned SearchClient usage for README, samples and tests
- New recordings
- Code clean up

* more clean up

* Update async

* fix minor pylint error

* fix according to comment

* modify test.yaml

* Fix syntax errors

* update

* Update README

* update README

* update sample files

* update README

* Changed naming from SearchClient to MapsSearchClient

* Update according to PR feedback

- Update sync/async client operations
- Update README
- Update Samples files structures
- Modify tests
- Delete unused files
- Create samples for Async
- Create README.md for samples

* Minor update typo

* update overload method

* polish methods doc-string

* expose GeoJsonObject

* update README

* Update accroding to board review

* Update README samples & setup.py

* update according to feedback

* update

* Update according to feedback

- Created convertor.py for converting geo_interface property type to
  GeoJson
- Created e2e tests for all the SDKs
- Update doc strings, samples, README

* update

* Update expected release date&removed Python2.7 packages

* Modified BoundingBox type

* Update

* update converter.py & minor enhancement

* Minor update for testing

* update unittest & docstring

* minor update

Author: alextts627

sdk/maps/azure-maps-search/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History
+
+## 1.0.0b1 (2022-09-02)
+
+* Initial Release

sdk/maps/azure-maps-search/MANIFEST.in

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

sdk/maps/azure-maps-search/README.md

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

sdk/maps/azure-maps-search/azure/__init__.py

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

sdk/maps/azure-maps-search/azure/maps/__init__.py

@@ -0,0 +1,12 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+from ._version import VERSION
+from ._search_client import MapsSearchClient
+
+__all__ = [
+    'MapsSearchClient'
+]
+__version__ = VERSION

sdk/maps/azure-maps-search/azure/maps/search/__init__.py

@@ -0,0 +1,51 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+# pylint: disable=unused-import
+from typing import Union, Any
+from azure.core.pipeline.policies import AzureKeyCredentialPolicy
+from azure.core.credentials import AzureKeyCredential, TokenCredential
+from ._generated import SearchClient as _MapsSearchClient
+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 MapsSearchClientBase:
+    def __init__(
+        self,
+        credential: Union[AzureKeyCredential, TokenCredential],
+        **kwargs: Any
+    ) -> None:
+
+        self._maps_client = _MapsSearchClient(
+            credential=credential,  # type: ignore
+            api_version=kwargs.pop("api_version", VERSION),
+            base_url=kwargs.pop("base_url", None),
+            client_id=kwargs.pop("client_id", None),
+            authentication_policy=kwargs.pop("authentication_policy", _authentication_policy(credential)),
+            **kwargs
+        )
+        self._search_client = self._maps_client.search
+
+    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

sdk/maps/azure-maps-search/azure/maps/search/_base_client.py

@@ -0,0 +1,19 @@
+# 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 ._search_client import SearchClient
+from ._version import VERSION
+
+__version__ = VERSION
+__all__ = ['SearchClient']
+
+try:
+    from ._patch import patch_sdk  # type: ignore
+    patch_sdk()
+except ImportError:
+    pass

sdk/maps/azure-maps-search/azure/maps/search/_common/__init__.py

@@ -0,0 +1,68 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from typing import 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 typing import Any, Optional
+
+    from azure.core.credentials import TokenCredential
+
+
+class SearchClientConfiguration(Configuration):
+    """Configuration for SearchClient.
+
+    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.
+    :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 <https://aka.ms/amauthdetails>`_ for guidance.
+    :type client_id: str
+    """
+
+    def __init__(
+        self,
+        credential,  # type: "TokenCredential"
+        client_id=None,  # type: Optional[str]
+        **kwargs  # type: Any
+    ):
+        # type: (...) -> None
+        if credential is None:
+            raise ValueError("Parameter 'credential' must not be None.")
+        super(SearchClientConfiguration, self).__init__(**kwargs)
+
+        self.credential = credential
+        self.client_id = client_id
+        self.api_version = "1.0"
+        self.credential_scopes = kwargs.pop('credential_scopes', ['https://atlas.microsoft.com/.default'])
+        kwargs.setdefault('sdk_moniker', 'maps-search/{}'.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)