Python için coğrafi konum paketi istemci kitaplığını Azure Haritalar - sürüm 1.0.0b1
Bu paket, Coğrafi Konum için Azure Haritalar Hizmetleri için bir Python SDK'sı içerir. Azure Haritalar Hizmetleri hakkında daha fazla bilgiyi burada bulabilirsiniz
Kaynak kodu | API başvuru belgeleri | Ürün belgeleri
Bildirim
Python 2.7 için Azure SDK Python paketleri desteği 01 Ocak 2022'de sona erdi. Daha fazla bilgi ve soru için lütfen https://github.com/Azure/azure-sdk-for-python/issues/20691
Başlarken
Önkoşullar
- Bu paketi kullanmak için Python 3.7 veya üzeri gereklidir.
- Azure aboneliği ve Azure Haritalar hesabı.
- Dağıtılmış bir Haritalar Hizmetleri kaynağı. Kaynağı Azure Portal veya Azure CLI aracılığıyla oluşturabilirsiniz.
Azure CLI kullanıyorsanız, istediğiniz ve <account-name>
öğesini değiştirin <resource-group-name>
ve parametresi aracılığıyla <sku-name>
gereksinimlerinize göre uygun bir fiyatlandırma katmanı seçin. Daha fazla ayrıntı için lütfen bu sayfaya bakın.
az maps account create --resource-group <resource-group-name> --account-name <account-name> --sku <sku-name>
Paketi yükleme
Azure Haritalar Hizmeti Coğrafi Konum SDK'sını yükleyin.
pip install azure-maps-geolocation
MapsGeolocationClient Oluşturma ve Kimliğini Doğrulama
Azure Haritalar Coğrafi Konum API'sine erişmek üzere bir istemci nesnesi oluşturmak için bir kimlik bilgisi nesnesi gerekir. Azure Haritalar Coğrafi Konum istemcisi kimlik doğrulaması için iki yolu da destekler.
1. Abonelik Anahtarı Kimlik Bilgileri ile kimlik doğrulaması yapma
Azure Haritalar Abonelik Anahtarınızla kimlik doğrulaması yapabilirsiniz.
Azure Haritalar Abonelik Anahtarı oluşturulduktan sonra anahtarın değerini ortam değişkeni olarak ayarlayın: AZURE_SUBSCRIPTION_KEY
.
Ardından parametresi olarak credential
bir AZURE_SUBSCRIPTION_KEY
AzureKeyCredential örneğine geçirin.
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. Azure Active Directory kimlik bilgileriyle kimlik doğrulaması
Azure Kimlik kitaplığını kullanarak Azure Active Directory (AAD) belirteci kimlik bilgileriyle kimlik doğrulaması yapabilirsiniz. AAD kullanarak kimlik doğrulaması için bazı ilk kurulumlar gerekir:
- azure-identity yükleme
- Yeni bir AAD uygulaması kaydetme
- Hizmet sorumlunuza uygun rolü atayarak Azure Haritalar erişimi verin. Lütfen Kimlik doğrulamasını yönetme sayfasına bakın.
Kurulumdan sonra, hangi kimlik bilgisiazure.identity
türünü kullanacağınızı seçebilirsiniz.
Örneğin, istemcinin kimliğini doğrulamak için DefaultAzureCredential kullanılabilir:
Ardından, AAD uygulamasının istemci kimliği, kiracı kimliği ve istemci gizli dizisi değerlerini ortam değişkenleri olarak ayarlayın: AZURE_CLIENT_ID
, AZURE_TENANT_ID
, AZURE_CLIENT_SECRET
İstemci seçeneklerinde öğesini belirterek kullanmayı planladığınız Azure Haritalar kaynağını da belirtmeniz clientId
gerekir. Azure Haritalar kaynağı istemci kimliği, Azure Haritalar kaynağının Kimlik Doğrulaması bölümlerinde bulunabilir. Lütfen nasıl bulabileceğinize ilişkin belgelere bakın.
from azure.maps.geolocation import MapsGeolocationClient
from azure.identity import DefaultAzureCredential
credential = DefaultAzureCredential()
geolocation_client = MapsGeolocationClient(
client_id="<Azure Maps Client ID>",
credential=credential
)
Önemli kavramlar
Python için Azure Haritalar Coğrafi Konum istemci kitaplığı, ayrılmış bir istemci nesnesi kullanarak bileşenlerin her biriyle etkileşim kurmanızı sağlar.
eşitleme istemcileri
MapsGeolocationClient
, Python için Azure Haritalar Coğrafi Konum istemci kitaplığını kullanan geliştiriciler için birincil istemcidir.
Bir MapsGeolocationClient
sınıf başlatıldıktan sonra, erişebileceğiniz Azure Haritalar Coğrafi Konum hizmetinin farklı özelliklerini anlamak için bu istemci nesnesinde yöntemleri keşfedebilirsiniz.
Zaman Uyumsuz İstemciler
Bu kitaplık, Python 3.5+ üzerinde desteklenen tam bir zaman uyumsuz API içerir. Bunu kullanmak için önce aiohttp gibi bir zaman uyumsuz aktarım yüklemeniz gerekir. Daha fazla bilgi için bkz. azure-core belgeleri .
Zaman uyumsuz istemciler ve kimlik bilgileri artık gerekli olmadığında kapatılmalıdır. Bu nesneler zaman uyumsuz bağlam yöneticileridir ve zaman uyumsuz close
yöntemler tanımlar.
Örnekler
Aşağıdaki bölümlerde, coğrafi konumla ilgili en yaygın Azure Haritalar görevlerinden bazılarını kapsayan çeşitli kod parçacıkları sağlanmaktadır:
Coğrafi Konum Alma
Bu hizmet, sağlanan IP adresi için ISO ülke kodunu döndürür. Geliştiriciler, uygulamanın görüntülendiği coğrafi konumlara göre belirli içerikleri engellemek veya değiştirmek için bu bilgileri kullanabilir.
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")
Sorun giderme
Genel
Haritalar Coğrafi Konum istemcileri , Azure Core'da tanımlanan özel durumları tetikler.
Bu liste, atılan özel durumları yakalamak için başvuru için kullanılabilir. Özel durumun belirli hata kodunu almak için özniteliğini error_code
kullanın, örneğin. exception.error_code
Günlüğe Kaydetme
Bu kitaplık , günlüğe kaydetme için standart günlük kitaplığını kullanır. HTTP oturumları (URL'ler, üst bilgiler vb.) hakkındaki temel bilgiler BİlGİ düzeyinde günlüğe kaydedilir.
İstek/yanıt gövdeleri ve kaydedilmemiş üst bilgiler de dahil olmak üzere ayrıntılı HATA AYıKLAMA düzeyi günlüğe kaydetme, istemcide şu bağımsız değişkenle logging_enable
etkinleştirilebilir:
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)
Ek
Hala sorunlarla mı karşılaşılıyor? Hatalarla karşılaşırsanız veya önerileriniz varsa lütfen projenin Sorunlar bölümünde bir sorun oluşturun.
Sonraki adımlar
Daha fazla örnek kod
Haritalar Coğrafi Konum örneklerimizi (Zaman Uyumsuz Sürüm örnekleri) kullanmaya başlayın.
SDK'nın GitHub deposunda birkaç Azure Haritalar Coğrafi Konum Python SDK'sı örneği kullanabilirsiniz. Bu örnekler, Haritalar Coğrafi Konumu ile çalışırken yaygın olarak karşılaşılan ek senaryolar için örnek kod sağlar
set AZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"
pip install azure-maps-geolocation --pre
python samples/sample_authentication.py
python sample/sample_get_country_code.py
Notlar:
--pre
bayrağı isteğe bağlı olarak eklenebilir; için yayın öncesi ve geliştirme sürümlerini eklemektirpip install
. Varsayılan olarak,pip
yalnızca kararlı sürümleri bulur.
Daha ayrıntılı bilgi için bkz . Örneklere Giriş
Diğer belgeler
coğrafi konum Azure Haritalar hakkında daha kapsamlı belgeler için docs.microsoft.com Azure Haritalar Coğrafi Konum belgelerine bakın.
Katkıda bulunma
Bu proje, katkı ve önerilere açıktır. Çoğu durumda, sağladığınız katkıyı kullanmamız için bize hak tanıma hakkına sahip olduğunuzu ve bu hakkı bize tanıdığınızı bildiren bir Katkıda Bulunan Lisans Sözleşmesi’ni (CLA) kabul etmeniz gerekir. Ayrıntılar için bkz. https://cla.microsoft.com.
Bir çekme isteği gönderdiğinizde, CLA robotu bir CLA sağlamanız gerekip gerekmediğini otomatik olarak belirler ve çekme isteğini uygun şekilde donatır (örn. etiket, açıklama). Robot tarafından sağlanan yönergeleri izlemeniz yeterlidir. Bu işlemi, CLA’mızı kullanarak tüm depolarda yalnızca bir kere yapmanız gerekir.
Bu proje Microsoft Open Source Code of Conduct (Microsoft Açık Kaynak Kullanım Kuralları) belgesinde listelenen kurallara uygundur. Daha fazla bilgi için Kullanım Kuralları SSS bölümüne bakın veya ek sorularınız veya yorumlarınızla iletişime geçin opencode@microsoft.com .
Azure SDK for Python