Partager via

Azure Maps bibliothèque cliente de package de routage pour Python - version 1.0.0b1

  • Article

Ce package contient un Kit de développement logiciel (SDK) Python pour Azure Maps Services for Route. 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) service route Azure Maps.

pip install azure-maps-route

Créer et authentifier mapsRouteClient

Pour créer un objet client afin d’accéder à l’API route Azure Maps, vous avez besoin d’un objet d’informations d’identification. Azure Maps client Route 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.route import MapsRouteClient

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

route_client = MapsRouteClient(
    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.route import MapsRouteClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
route_client = MapsRouteClient(
    client_id="<Azure Maps Client ID>",
    credential=credential
)

Concepts clés

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

Synchroniser les clients

MapsRouteClientest le client principal pour les développeurs qui utilisent la bibliothèque cliente route Azure Maps pour Python. Une fois que vous avez initialisé une MapsRouteClient classe, vous pouvez explorer les méthodes de cet objet client pour comprendre les différentes fonctionnalités du service route 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 routage Azure Maps les plus courantes, notamment :

Demander et obtenir des itinéraires

Cette demande de service retourne un itinéraire entre une origine et une destination, en passant par des waypoints s’ils sont spécifiés. L’itinéraire tiendra compte de facteurs tels que la circulation actuelle et les vitesses typiques de la route le jour de la semaine et l’heure de la journée demandés.

from azure.maps.route import MapsRouteClient

route_directions_result = client.get_route_directions(route_points=[LatLon(47.60323, -122.33028), LatLon(53.2, -106)]);

Demander et obtenir la plage de routes

Ce service calcule un ensemble d’emplacements qui peuvent être atteints à partir du point d’origine à l’aide de coordonnées données et en fonction du carburant, de l’énergie, du temps ou du budget de distance spécifié.

from azure.maps.route import MapsRouteClient

route_range_result = client.get_route_range(coordinates=LatLon(47.60323, -122.33028), time_budget_in_sec=6000);

Obtenir la matrice de routage

Si la demande Matrix Route a été acceptée avec succès, l’en-tête Location dans la réponse contient l’URL permettant de télécharger les résultats de la demande.

Récupère le résultat d’une demande de matrice de routage précédente. La méthode retourne un polleur pour récupérer le résultat.

from azure.maps.route import MapsRouteClient

route_matrix_result = client.begin_get_route_matrix_result(matrix_id="11111111-2222-3333-4444-555555555555");

Get Route Directions Batch

Récupère le résultat d’une demande de lot de sens de route précédente. La méthode retourne un polleur pour récupérer le résultat.

from azure.maps.route import MapsRouteClient

route_directions_batch_poller_result = client.begin_get_route_directions_batch_result(batch_id="11111111-2222-3333-4444-555555555555");

Dépannage

Général

Les clients de routage de mappages déclenchent 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.route import MapsRouteClient

# Create a logger for the 'azure.maps.route' SDK
logger = logging.getLogger('azure.maps.route')
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 d’itinéraires Maps (exemples de version asynchrone).

Plusieurs exemples Azure Maps du Kit de développement logiciel (SDK) Route Python sont disponibles dans le dépôt GitHub du SDK. Ces exemples fournissent un exemple de code pour d’autres scénarios couramment rencontrés lors de l’utilisation de Maps Route

set AZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"

pip install azure-maps-route --pre

python samples/sample_authentication.py
python sample/sample_get_route_range.py
python samples/sample_get_route_directions.py
python samples/sample_request_route_matrix.py
python samples/async_samples/sample_authentication_async.py
python samples/async_samples/sample_get_route_range_async.py
python samples/async_samples/sample_request_route_matrix_async.py
python samples/async_samples/sample_get_route_directions_async.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 Azure Maps Route, consultez la documentation route 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.