[Azure Maps] Update client prefix on Geolocation SDK Python (Azure#26675)

Author: alextts627

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

@@ -31,7 +31,7 @@ Install the Azure Maps Service Geolocation SDK.
 pip install azure-maps-geolocation
 ```
 
-### Create and Authenticate the GeolocationClient
+### Create and Authenticate the MapsGeolocationClient
 
 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.
 
@@ -43,11 +43,11 @@ Then pass an `AZURE_SUBSCRIPTION_KEY` as the `credential` parameter into an inst
 
 ```python
 from azure.core.credentials import AzureKeyCredential
-from azure.maps.geolocation import GeolocationClient
+from azure.maps.geolocation import MapsGeolocationClient
 
 credential = AzureKeyCredential(os.environ.get("AZURE_SUBSCRIPTION_KEY"))
 
-geolocation_client = GeolocationClient(
+geolocation_client = MapsGeolocationClient(
     credential=credential,
 )
 ```
@@ -71,11 +71,11 @@ Next, set the values of the client ID, tenant ID, and client secret of the AAD a
 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.maps.geolocation import MapsGeolocationClient
 from azure.identity import DefaultAzureCredential
 
 credential = DefaultAzureCredential()
-geolocation_client = GeolocationClient(
+geolocation_client = MapsGeolocationClient(
     client_id="<Azure Maps Client ID>",
     credential=credential
 )
@@ -87,8 +87,8 @@ The Azure Maps Geolocation client library for Python allows you to interact with
 
 ### 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.
+`MapsGeolocationClient` is the primary client for developers using the Azure Maps Geolocation client library for Python.
+Once you initialized a `MapsGeolocationClient` 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
 
@@ -109,11 +109,11 @@ The following sections provide several code snippets covering some of the most c
 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
+from azure.maps.geolocation import MapsGeolocationClient
 
 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)
+geolocation_result = client.get_country_code(ip_address=INCOME_IP_ADDRESS)
 
 result_country_code = geolocation_result.iso_code
 
@@ -139,7 +139,7 @@ Detailed DEBUG level logging, including request/response bodies and unredacted h
 ```python
 import sys
 import logging
-from azure.maps.geolocation import GeolocationClient
+from azure.maps.geolocation import MapsGeolocationClient
 
 # Create a logger for the 'azure.maps.geolocation' SDK
 logger = logging.getLogger('azure.maps.geolocation')
@@ -169,7 +169,7 @@ set AZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"
 pip install azure-maps-geolocation --pre
 
 python samples/sample_authentication.py
-python sample/sample_get_geolocation.py
+python sample/sample_get_country_code.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.

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

@@ -4,9 +4,9 @@
 # ------------------------------------
 
 from ._version import VERSION
-from ._geolocation_client import GeolocationClient
+from ._geolocation_client import MapsGeolocationClient
 
 __all__ = [
-    'GeolocationClient'
+    'MapsGeolocationClient'
 ]
 __version__ = VERSION

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

@@ -25,7 +25,7 @@ def _authentication_policy(credential):
         )
     return authentication_policy
 
-class GeolocationClientBase:
+class MapsGeolocationClientBase:
     def __init__(
         self,
         credential: Union[AzureKeyCredential, TokenCredential],

sdk/maps/azure-maps-geolocation/azure/maps/geolocation/_geolocation_client.py

@@ -8,14 +8,14 @@
 from azure.core.tracing.decorator import distributed_trace
 from azure.core.credentials import AzureKeyCredential, TokenCredential
 
-from ._base_client import GeolocationClientBase
+from ._base_client import MapsGeolocationClientBase
 from .models import (
-    Geolocation
+    CountryRegionResult
 )
 
 
 # By default, use the latest supported API version
-class GeolocationClient(GeolocationClientBase):
+class MapsGeolocationClient(MapsGeolocationClientBase):
     """Azure Maps Geolocation REST APIs.
 
     :param credential:
@@ -37,13 +37,13 @@ class GeolocationClient(GeolocationClientBase):
             :end-before: [END create_maps_geolocation_service_client_with_key]
             :language: python
             :dedent: 4
-            :caption: Creating the GeolocationClient with an subscription key.
+            :caption: Creating the MapsGeolocationClient 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.
+            :caption: Creating the MapsGeolocationClient with a token credential.
     """
 
     def __init__(
@@ -57,11 +57,11 @@ def __init__(
         )
 
     @distributed_trace
-    def get_geolocation(
+    def get_country_code(
         self,
         ip_address: str,
         **kwargs: Any
-    ) -> Geolocation:
+    ) -> CountryRegionResult:
         """
         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
@@ -72,16 +72,16 @@ def get_geolocation(
         :type ip_address:
             str
         :return:
-            Geolocation
+            CountryRegionResult
         :rtype:
-            ~azure.maps.geolocation.models.Geolocation
+            ~azure.maps.geolocation.models.CountryRegionResult
         :raises ~azure.core.exceptions.HttpResponseError:
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/sample_get_geolocation.py
-                :start-after: [START get_geolocation]
-                :end-before: [END get_geolocation]
+            .. literalinclude:: ../samples/sample_get_country_code.py
+                :start-after: [START get_country_code]
+                :end-before: [END get_country_code]
                 :language: python
                 :dedent: 4
                 :caption:  Return the ISO country code for the provided IP address.
@@ -93,7 +93,7 @@ def get_geolocation(
             **kwargs
         )
 
-        return Geolocation(
+        return CountryRegionResult(
             ip_address=geolocation_result.ip_address,
             iso_code=geolocation_result.country_region.iso_code
         )

sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/__init__.py

@@ -6,5 +6,5 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-from ._geolocation_client_async import GeolocationClient
-__all__ = ['GeolocationClient']
+from ._geolocation_client_async import MapsGeolocationClient
+__all__ = ['MapsGeolocationClient']

sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_base_client_async.py

@@ -7,7 +7,7 @@
 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 .._generated.aio import GeolocationClient as _MapsGeolocationClient
 from .._version import VERSION
 
 def _authentication_policy(credential):
@@ -25,14 +25,14 @@ def _authentication_policy(credential):
         )
     return authentication_policy
 
-class AsyncGeolocationClientBase:
+class AsyncMapsGeolocationClientBase:
     def __init__(
         self,
         credential: Union[AzureKeyCredential, AsyncTokenCredential],
         **kwargs: Any
     ) -> None:
 
-        self._maps_client = _GeolocationClient(
+        self._maps_client = _MapsGeolocationClient(
             credential=credential,  # type: ignore
             api_version=kwargs.pop("api_version", VERSION),
             authentication_policy=kwargs.pop("authentication_policy", _authentication_policy(credential)),

sdk/maps/azure-maps-geolocation/azure/maps/geolocation/aio/_geolocation_client_async.py

@@ -10,13 +10,13 @@
 from azure.core.credentials import AzureKeyCredential
 from azure.core.credentials_async import AsyncTokenCredential
 
-from ._base_client_async import AsyncGeolocationClientBase
+from ._base_client_async import AsyncMapsGeolocationClientBase
 from ..models import (
-    Geolocation
+    CountryRegionResult
 )
 
 # By default, use the latest supported API version
-class GeolocationClient(AsyncGeolocationClientBase):
+class MapsGeolocationClient(AsyncMapsGeolocationClientBase):
     """Azure Maps Geolocation REST APIs.
 
     :param credential: Credential needed for the client to connect to Azure.
@@ -36,13 +36,13 @@ class GeolocationClient(AsyncGeolocationClientBase):
             :end-before: [END create_maps_geolocation_service_client_with_key_async]
             :language: python
             :dedent: 4
-            :caption: Creating the GeolocationClient with an subscription key.
+            :caption: Creating the MapsGeolocationClient 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.
+            :caption: Creating the MapsGeolocationClient with a token credential.
     """
     def __init__(
         self,
@@ -55,11 +55,11 @@ def __init__(
 
 
     @distributed_trace_async
-    async def get_geolocation(
+    async def get_country_code(
         self,
         ip_address: str,
         **kwargs: Any
-    ) -> Geolocation:
+    ) -> CountryRegionResult:
         """
         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
@@ -69,16 +69,16 @@ async def get_geolocation(
             The IP address. Both IPv4 and IPv6 are allowed. Required.
         :type ip_address: str
         :return:
-            Geolocation
+            CountryRegionResult
         :rtype:
-            ~azure.maps.geolocation.models.Geolocation
+            ~azure.maps.geolocation.models.CountryRegionResult
         :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]
+            .. literalinclude:: ../samples/async_samples/sample_get_country_code_async.py
+                :start-after: [START get_country_code_async]
+                :end-before: [END get_country_code_async]
                 :language: python
                 :dedent: 4
                 :caption:  Return the ISO country code for the provided IP address.
@@ -90,7 +90,7 @@ async def get_geolocation(
             **kwargs
         )
 
-        return Geolocation(
+        return CountryRegionResult(
             ip_address=geolocation_result.ip_address,
             iso_code=geolocation_result.country_region.iso_code
         )

sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/__init__.py

@@ -1,9 +1,9 @@
 
 from ._models import (
-    Geolocation
+    CountryRegionResult
 )
 
 
 __all__ = [
-    'Geolocation'
+    'CountryRegionResult'
 ]

sdk/maps/azure-maps-geolocation/azure/maps/geolocation/models/_models.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License.
 # ------------------------------------
 
-class Geolocation(object):
+class CountryRegionResult(object):
     """Represents coordinate latitude and longitude
 
     :keyword ip_address:

sdk/maps/azure-maps-geolocation/samples/async_samples/sample_authentication_async.py

@@ -29,15 +29,15 @@
 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
+    from azure.maps.geolocation.aio import MapsGeolocationClient
 
     subscription_key = os.getenv("AZURE_SUBSCRIPTION_KEY")
 
-    maps_geolocation_client = GeolocationClient(credential=AzureKeyCredential(subscription_key))
+    maps_geolocation_client = MapsGeolocationClient(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")
+        result = await maps_geolocation_client.get_country_code(ip_address="2001:4898:80e8:b::189")
 
     print(result)
 
@@ -47,16 +47,16 @@ async def authentication_maps_service_client_with_aad_credential_async():
     """
     # [START create_maps_geolocation_service_client_with_aad_async]
     from azure.identity.aio import DefaultAzureCredential
-    from azure.maps.geolocation.aio import GeolocationClient
+    from azure.maps.geolocation.aio import MapsGeolocationClient
 
     credential = DefaultAzureCredential()
     maps_client_id = os.getenv("AZURE_MAPS_CLIENT_ID")
 
-    maps_geolocation_client = GeolocationClient(client_id=maps_client_id, credential=credential)
+    maps_geolocation_client = MapsGeolocationClient(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")
+        result = await maps_geolocation_client.get_country_code(ip_address="2001:4898:80e8:b::189")
 
     print(result)