Compartir a través de

biblioteca cliente del paquete de geolocalización Azure Maps para Python: versión 1.0.0b1

  • Artículo

Este paquete contiene un SDK de Python para Azure Maps Services para geolocalización. Obtenga más información sobre Azure Maps Services aquí.

Código | fuente Documentación | de referencia de APIDocumentación del producto

Declinación de responsabilidades

Los paquetes de Python del SDK de Azure para Python 2.7 finalizaron el 01 de enero de 2022. Para más información y preguntas, consulte https://github.com/Azure/azure-sdk-for-python/issues/20691.

Introducción

Requisitos previos

Si usa la CLI de Azure, reemplace <resource-group-name> y <account-name> elija y seleccione un plan de tarifa adecuado en función de sus necesidades a través del <sku-name> parámetro . Consulte esta página para obtener más detalles.

az maps account create --resource-group <resource-group-name> --account-name <account-name> --sku <sku-name>

Instalar el paquete

Instale el SDK de geolocalización de Azure Maps Service.

pip install azure-maps-geolocation

Creación y autenticación de MapsGeolocationClient

Para crear un objeto de cliente para acceder a la API de geolocalización de Azure Maps, necesitará un objeto de credencial. Azure Maps cliente de geolocalización también admite dos maneras de autenticarse.

1. Autenticación con una credencial de clave de suscripción

Puede autenticarse con la clave de suscripción de Azure Maps. Una vez creada la clave de suscripción de Azure Maps, establezca el valor de la clave como variable de entorno: AZURE_SUBSCRIPTION_KEY. A continuación, pase un AZURE_SUBSCRIPTION_KEY como parámetro credential a una instancia de AzureKeyCredential.

from azure.core.credentials import AzureKeyCredential
from azure.maps.geolocation import MapsGeolocationClient

credential = AzureKeyCredential(os.environ.get("AZURE_SUBSCRIPTION_KEY"))

geolocation_client = MapsGeolocationClient(
    credential=credential,
)

2. Autenticación con una credencial de Azure Active Directory

Puede autenticarse con credenciales de token de Azure Active Directory (AAD) mediante la biblioteca de identidades de Azure. La autenticación mediante AAD requiere una configuración inicial:

Después de la instalación, puede elegir el tipo de credencial de azure.identity que se va a usar. Por ejemplo, Se puede usar DefaultAzureCredential para autenticar al cliente:

A continuación, establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de AAD como variables de entorno: AZURE_CLIENT_ID, , AZURE_TENANT_ID. AZURE_CLIENT_SECRET

También deberá especificar el recurso Azure Maps que va a usar especificando en clientId las opciones de cliente. El Azure Maps identificador de cliente de recursos se puede encontrar en las secciones Autenticación del recurso Azure Maps. Consulte la documentación sobre cómo encontrarlo.

from azure.maps.geolocation import MapsGeolocationClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
geolocation_client = MapsGeolocationClient(
    client_id="<Azure Maps Client ID>",
    credential=credential
)

Conceptos clave

La biblioteca cliente de geolocalización Azure Maps para Python le permite interactuar con cada uno de los componentes mediante el uso de un objeto de cliente dedicado.

Sincronizar clientes

MapsGeolocationClientes el cliente principal para los desarrolladores que usan la biblioteca cliente de geolocalización de Azure Maps para Python. Una vez que haya inicializado una MapsGeolocationClient clase, puede explorar los métodos de este objeto de cliente para comprender las distintas características del servicio de geolocalización Azure Maps al que puede acceder.

Clientes asincrónicos

Esta biblioteca incluye una API asincrónica completa compatible con Python 3.5 y versiones posteriores. Para usarlo, primero debe instalar un transporte asincrónico, como aiohttp. Consulte la documentación de azure-core para más información.

Los clientes asincrónicos y las credenciales deben cerrarse cuando ya no sean necesarios. Estos objetos son administradores de contexto asincrónicos y definen métodos asincrónicos close .

Ejemplos

En las secciones siguientes se proporcionan varios fragmentos de código que abarcan algunas de las tareas de geolocalización más comunes Azure Maps, entre las que se incluyen:

Obtención de geolocalización

Este servicio devolverá el código de país ISO para la dirección IP proporcionada. Los desarrolladores pueden usar esta información para bloquear o modificar cierto contenido en función de las ubicaciones geográficas desde las que se ve la aplicación.

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_country_code(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")

Solución de problemas

General

Los clientes de Geolocalización de Maps generan excepciones definidas en Azure Core.

Esta lista se puede usar como referencia para detectar excepciones iniciadas. Para obtener el código de error específico de la excepción, use el error_code atributo , es decir, exception.error_code.

Registro

Esta biblioteca usa la biblioteca de registro estándar para el registro. La información básica sobre las sesiones HTTP (direcciones URL, encabezados, etc.) se registra en el nivel INFO.

El registro detallado de nivel DEBUG, incluidos los cuerpos de solicitud/respuesta y los encabezados no aprobados, se puede habilitar en un cliente con el logging_enable argumento :

import sys
import logging
from azure.maps.geolocation import MapsGeolocationClient

# 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)

Adicional

¿Sigue teniendo problemas? Si encuentra algún error o tiene sugerencias, envíe un problema en la sección Problemas del proyecto.

Pasos siguientes

Más código de ejemplo

Empiece a trabajar con nuestros ejemplos de geolocalización de Maps (ejemplos de versión asincrónica).

Hay varios ejemplos de SDK de Python de Azure Maps geolocalización disponibles en el repositorio de GitHub del SDK. Estos ejemplos proporcionan código de ejemplo para escenarios adicionales que se encuentran habitualmente al trabajar con la geolocalización de Maps.

set AZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"

pip install azure-maps-geolocation --pre

python samples/sample_authentication.py
python sample/sample_get_country_code.py

Notas: --pre la marca se puede agregar opcionalmente, es incluir versiones preliminares y de desarrollo para pip install. De forma predeterminada, pip solo encuentra versiones estables.

Para obtener más información, consulte Introducción a ejemplos.

Documentación adicional

Para obtener documentación más amplia sobre Azure Maps Geolocalización, consulte la documentación de Azure Maps Geolocalización en docs.microsoft.com.

Contribuciones

Este proyecto agradece las contribuciones y sugerencias. La mayoría de las contribuciones requieren que acepte un Contrato de licencia para el colaborador (CLA) que declara que tiene el derecho a concedernos y nos concede los derechos para usar su contribución. Para más detalles, visite https://cla.microsoft.com.

Cuando se envía una solicitud de incorporación de cambios, un bot de CLA determinará de forma automática si tiene que aportar un CLA y completar la PR adecuadamente (por ejemplo, la etiqueta, el comentario). Solo siga las instrucciones que le dará el bot. Solo será necesario que lo haga una vez en todos los repositorios con nuestro CLA.

Este proyecto ha adoptado el Código de conducta de Microsoft Open Source. Para más información, consulte las preguntas más frecuentes del código de conducta o póngase en contacto con opencode@microsoft.com si tiene cualquier otra pregunta o comentario.