Partager via

Azure Maps bibliothèque cliente de package de géolocalisation pour Python - version 1.0.0b1

  • Article

Ce package contient un Kit de développement logiciel (SDK) Python pour Azure Maps Services pour la géolocalisation. En savoir plus sur Azure Maps Services ici

| Code sourceDocumentation de référence sur les | API Documentation produit

Clause d’exclusion de responsabilité

La prise en charge des packages Python du SDK Azure pour Python 2.7 a pris fin le 1er janvier 2022. Pour obtenir plus d’informations et poser des questions, reportez-vous à https://github.com/Azure/azure-sdk-for-python/issues/20691

Prise en main

Prérequis

Si vous utilisez Azure CLI, remplacez <resource-group-name> et <account-name> de votre choix, puis sélectionnez un niveau tarifaire approprié en fonction de vos besoins via le <sku-name> paramètre . Pour plus d’informations, consultez cette page.

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

Installer le package

Installez le Kit de développement logiciel (SDK) Azure Maps Service Geolocation.

pip install azure-maps-geolocation

Créer et authentifier mapsGeolocationClient

Pour créer un objet client afin d’accéder à l’API de géolocalisation Azure Maps, vous avez besoin d’un objet d’informations d’identification. Azure Maps client de géolocalisation prend également en charge deux méthodes d’authentification.

1. S’authentifier avec des informations d’identification de clé d’abonnement

Vous pouvez vous authentifier avec votre clé d’abonnement Azure Maps. Une fois la clé d’abonnement Azure Maps créée, définissez la valeur de la clé comme variable d’environnement : AZURE_SUBSCRIPTION_KEY. Passez ensuite un AZURE_SUBSCRIPTION_KEY en tant que credential paramètre dans une instance d’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. S’authentifier avec des informations d’identification Azure Active Directory

Vous pouvez vous authentifier avec les informations d’identification de jeton Azure Active Directory (AAD) à l’aide de la bibliothèque Azure Identity. L’authentification à l’aide d’AAD nécessite une configuration initiale :

Après l’installation, vous pouvez choisir le type d’informations d’identificationazure.identity à utiliser. Par exemple, DefaultAzureCredential peut être utilisé pour authentifier le client :

Ensuite, définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application AAD en tant que variables d’environnement : AZURE_CLIENT_ID, AZURE_TENANT_ID, , AZURE_CLIENT_SECRET

Vous devez également spécifier la ressource Azure Maps que vous envisagez d’utiliser en spécifiant dans clientId les options du client. L’ID client de ressource Azure Maps se trouve dans les sections Authentification de la ressource Azure Maps. Reportez-vous à la documentation pour savoir comment le trouver.

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

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

Concepts clés

La bibliothèque cliente de géolocalisation Azure Maps pour Python vous permet d’interagir avec chacun des composants via l’utilisation d’un objet client dédié.

Synchroniser les clients

MapsGeolocationClientest le client principal pour les développeurs qui utilisent la bibliothèque cliente de géolocalisation Azure Maps pour Python. Une fois que vous avez initialisé une MapsGeolocationClient classe, vous pouvez explorer les méthodes de cet objet client pour comprendre les différentes fonctionnalités du service de géolocalisation Azure Maps auquel vous pouvez accéder.

Clients asynchrones

Cette bibliothèque inclut une API asynchrone complète prise en charge sur Python 3.5+. Pour l’utiliser, vous devez d’abord installer un transport asynchrone, tel que aiohttp. Pour plus d’informations, consultez la documentation azure-core .

Les clients et les informations d’identification asynchrones doivent être fermés lorsqu’ils ne sont plus nécessaires. Ces objets sont des gestionnaires de contexte asynchrones et définissent des méthodes asynchrones close .

Exemples

Les sections suivantes fournissent plusieurs extraits de code couvrant certaines des tâches de géolocalisation les plus courantes Azure Maps, notamment :

Obtenir la géolocalisation

Ce service retourne le code de pays ISO pour l’adresse IP fournie. Les développeurs peuvent utiliser ces informations pour bloquer ou modifier certains contenus en fonction des emplacements géographiques à partir desquels l’application est consultée.

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

Dépannage

Général

Les clients de géolocalisation mappent des exceptions définies dans Azure Core.

Cette liste peut être utilisée à des fins de référence pour intercepter les exceptions levées. Pour obtenir le code d’erreur spécifique de l’exception, utilisez l’attribut error_code , exception.error_codec’est-à-dire .

Journalisation

Cette bibliothèque utilise la bibliothèque de journalisation standard pour la journalisation. Les informations de base sur les sessions HTTP (URL, en-têtes, etc.) sont enregistrées au niveau INFO.

La journalisation détaillée au niveau DEBUG, y compris les corps de requête/réponse et les en-têtes non expurgés, peut être activée sur un client avec l’argument logging_enable :

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)

Informations supplémentaires

Vous rencontrez toujours des problèmes ? Si vous rencontrez des bogues ou si vous avez des suggestions, signalez un problème dans la section Problèmes du projet.

Étapes suivantes

Autres exemples de code

Prise en main de nos exemples de géolocalisation Maps (exemples de version asynchrone).

Plusieurs exemples Azure Maps kit de développement logiciel (SDK) Geolocation Python sont disponibles dans le dépôt GitHub du SDK. Ces exemples fournissent un exemple de code pour d’autres scénarios fréquemment rencontrés lors de l’utilisation de la géolocalisation maps

set AZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"

pip install azure-maps-geolocation --pre

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

Remarques : --pre l’indicateur peut être ajouté éventuellement. Il s’agit d’inclure les versions de préversion et de développement pour pip install. Par défaut, pip recherche uniquement les versions stables.

Pour plus d’informations, reportez-vous à La présentation des exemples

Documentation complémentaire

Pour obtenir une documentation plus complète sur la géolocalisation Azure Maps, consultez la documentation sur la géolocalisation Azure Maps sur docs.microsoft.com.

Contribution

Ce projet accepte les contributions et les suggestions. La plupart des contributions vous demandent d’accepter un contrat de licence de contribution (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez réellement, les droits d’utilisation de votre contribution. Pour plus d’informations, visitez https://cla.microsoft.com.

Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous ne devez effectuer cette opération qu’une seule fois sur tous les dépôts utilisant notre contrat CLA.

Ce projet a adopté le Code de conduite Open Source de Microsoft. Pour plus d’informations, consultez les Questions fréquentes (FAQ) sur le code de conduite ou envoyez vos questions ou vos commentaires à opencode@microsoft.com.