o GfS@sdZddlmZddlZddlZddlZddlmZddl m Z e dddDZ Gd d d eZGd d d eZd dZdZdS)z" Utilities to support XYZservices ) annotationsN)Callable)quotecCsi|]}|dqS)).0xrr[/home/deployuser/azure_apps/autowriter/venv/lib/python3.10/site-packages/xyzservices/lib.py sr z., -_/c@sReZdZdZddZddZdddZdd d Z ddddZdddZ d S) BunchaA dict with attribute-access :class:`Bunch` is used to store :class:`TileProvider` objects. Examples -------- >>> black_and_white = TileProvider( ... name="My black and white tiles", ... url="https://myserver.com/bw/{z}/{x}/{y}", ... attribution="(C) xyzservices", ... ) >>> colorful = TileProvider( ... name="My colorful tiles", ... url="https://myserver.com/color/{z}/{x}/{y}", ... attribution="(C) xyzservices", ... ) >>> MyTiles = Bunch(BlackAndWhite=black_and_white, Colorful=colorful) >>> MyTiles {'BlackAndWhite': {'name': 'My black and white tiles', 'url': 'https://myserver.com/bw/{z}/{x}/{y}', 'attribution': '(C) xyzservices'}, 'Colorful': {'name': 'My colorful tiles', 'url': 'https://myserver.com/color/{z}/{x}/{y}', 'attribution': '(C) xyzservices'}} >>> MyTiles.BlackAndWhite.url 'https://myserver.com/bw/{z}/{x}/{y}' c Cs0z||WSty}zt||d}~wwN) __getitem__KeyErrorAttributeError)selfkeyerrrrr __getattr__*s   zBunch.__getattr__cCs|Sr )keysrrrr __dir__0sz Bunch.__dir__FcCsd}|D].}t||trd}nd}tt}|d|d|d|d|d||jd d d 7}q|r7dnd td }d|dt|d|d}|S)Nrzxyzservices.TileProviderzxyzservices.BunchzO
  • T)insidez6
    • 
    z
    xyzservices.Bunch
    z items
      z\
    ) isinstance TileProviderstruuiduuid4 _repr_html_ CSS_STYLElen)rrchildrenrobjuidstylehtmlrrr r 3s4    zBunch._repr_html_returndictcsifdd|S)aReturn the nested :class:`Bunch` collapsed into the one level dictionary. Dictionary keys are :class:`TileProvider` names (e.g. ``OpenStreetMap.Mapnik``) and its values are :class:`TileProvider` objects. Returns ------- flattened : dict dictionary of :class:`TileProvider` objects Examples -------- >>> import xyzservices.providers as xyz >>> len(xyz) 36 >>> flat = xyz.flatten() >>> len(xyz) 207 cs2t|tr ||j<dS|D]}|qdSr )rrnamevalues)providerprov_get_providersflatrr r/rs   z%Bunch.flatten.._get_providersrrrr.r flattenYsz Bunch.flattenNkeyword str | Noner*requires_token bool | NonefunctionCallable[[TileProvider], bool]cs(ddfdd|||||dS)a Return a subset of the :class:`Bunch` matching the filter conditions Each :class:`TileProvider` within a :class:`Bunch` is checked against one or more specified conditions and kept if they are satisfied or removed if at least one condition is not met. Parameters ---------- keyword : str (optional) Condition returns ``True`` if ``keyword`` string is present in any string value in a :class:`TileProvider` object. The comparison is not case sensitive. name : str (optional) Condition returns ``True`` if ``name`` string is present in the name attribute of :class:`TileProvider` object. The comparison is not case sensitive. requires_token : bool (optional) Condition returns ``True`` if :meth:`TileProvider.requires_token` returns ``True`` (i.e. if the object requires specification of API token). function : callable (optional) Custom function taking :class:`TileProvider` as an argument and returns bool. If ``function`` is given, other parameters are ignored. Returns ------- filtered : Bunch Examples -------- >>> import xyzservices.providers as xyz You can filter all free providers (not requiring API token): >>> free_providers = xyz.filter(requires_token=False) Or all providers with ``open`` in the name: >>> open_providers = xyz.filter(name="open") You can use keyword search to find all providers based on OpenStreetMap data: >>> osm_providers = xyz.filter(keyword="openstreetmap") You can combine multiple conditions to find providers based on OpenStreetMap data that require API token: >>> osm_locked = xyz.filter(keyword="openstreetmap", requires_token=True) You can also pass custom function that takes :class:`TileProvider` and returns boolean value. You can then find all providers with ``max_zoom`` smaller than 18: >>> def zoom18(provider): ... if hasattr(provider, "max_zoom") and provider.max_zoom < 18: ... return True ... return False >>> small_zoom = xyz.filter(function=zoom18) c Ssg}|dur%d}|D]}t|tr||vrd}nq |||dur;d}||jvr6d}|||durNd}||urId}||t|S)NFT)r+rrlowerappendr*r4all) r,r2r*r4cond keyword_matchv name_match token_matchrrr _validates(     zBunch.filter.._validatec sxt}|D]2\}}t|tr*|dur!||||dr |||<q||r)|||<q|||||d}|r9|||<q|S)N)r2r*r4r2r*r4r6)r itemsrr) bunchr2r*r4r6newrvaluefiltered _filter_bunchr@rr rHs4 z#Bunch.filter.._filter_bunchrAr)rr2r*r4r6rrGr filter}sBz Bunch.filterrrcCsDdd|D}|t}||vr||Std|d)aReturn :class:`TileProvider` based on the name query Returns a matching :class:`TileProvider` from the :class:`Bunch` if the ``name`` contains the same letters in the same order as the provider's name irrespective of the letter case, spaces, dashes and other characters. See examples for details. Parameters ---------- name : str Name of the tile provider. Formatting does not matter. Returns ------- match: TileProvider Examples -------- >>> import xyzservices.providers as xyz All these queries return the same ``CartoDB.Positron`` TileProvider: >>> xyz.query_name("CartoDB Positron") >>> xyz.query_name("cartodbpositron") >>> xyz.query_name("cartodb-positron") >>> xyz.query_name("carto db/positron") >>> xyz.query_name("CARTO_DB_POSITRON") >>> xyz.query_name("CartoDB.Positron") cSs i|] \}}|t|qSr) translateQUERY_NAME_TRANSLATIONr8)rkr=rrr r sz$Bunch.query_name..z*No matching provider found for the query 'z'.)r1rBrJrKr8 ValueError)rr*xyz_flat_lower name_cleanrrr query_names zBunch.query_nameF)r(r))NNNN) r2r3r*r3r4r5r6r7r(r r*rr(r) __name__ __module__ __qualname____doc__rrr r1rIrPrrrr r s  && r csxeZdZdZfddZd!ddZd!ddZ d"d#ddZd$ddZe ddZ d%ddZ e d&dd Z ZS)'ra$ A dict with attribute-access and that can be called to update keys Examples -------- You can create custom :class:`TileProvider` by passing your attributes to the object as it would have been a ``dict()``. It is required to always specify ``name``, ``url``, and ``attribution``. >>> public_provider = TileProvider( ... name="My public tiles", ... url="https://myserver.com/tiles/{z}/{x}/{y}.png", ... attribution="(C) xyzservices", ... ) Alternatively, you can create it from a dictionary of attributes. When specifying a placeholder for the access token, please use the ``""`` string to ensure that :meth:`~xyzservices.TileProvider.requires_token` method works properly. >>> private_provider = TileProvider( ... { ... "url": "https://myserver.com/tiles/{z}/{x}/{y}.png?apikey={accessToken}", ... "attribution": "(C) xyzservices", ... "accessToken": "", ... "name": "my_private_provider", ... } ... ) It is customary to include ``html_attribution`` attribute containing HTML string as ``'© OpenStreetMap contributors'`` alongisde a plain-text ``attribution``. You can then fetch all information as attributes: >>> public_provider.url 'https://myserver.com/tiles/{z}/{x}/{y}.png' >>> public_provider.attribution '(C) xyzservices' To ensure you will be able to use the tiles, you can check if the :class:`TileProvider` requires a token or API key. >>> public_provider.requires_token() False >>> private_provider.requires_token() True You can also generate URL in the required format with or without placeholders: >>> public_provider.build_url() 'https://myserver.com/tiles/{z}/{x}/{y}.png' >>> private_provider.build_url(x=12, y=21, z=11, accessToken="my_token") 'https://myserver.com/tiles/11/12/21.png?access_token=my_token' cs`tj|i|g}dD] }||vr||q t|dkr.dd|d}t|dS)N)r*url attributionrzyThe attributes `name`, `url`, and `attribution` are required to initialise a `TileProvider`. Please provide values for: `z`, ``)super__init__rr9r"joinr)rargskwargsmissingelmsg __class__rr r[es   zTileProvider.__init__r(cKst|}|||Sr )rupdate)rr^rDrrr __call__ts zTileProvider.__call__cCs t|}|Sr r)rrDrrr copyyszTileProvider.copyNTrint | str | Noneyz scale_factorr3fill_subdomainr5rc Ks|}|dur d}|durd}|durd}|||r#td|d}|r3|} |ddn|dd} |rF|d d } | d } nd } |jd|||| | d |S)a Build the URL of tiles from the :class:`TileProvider` object Can return URL with placeholders or the final tile URL. Parameters ---------- x, y, z : int (optional) tile number scale_factor : str (optional) Scale factor (where supported). For example, you can get double resolution (512 x 512) instead of standard one (256 x 256) with ``"@2x"``. If you want to keep a placeholder, pass `"{r}"`. fill_subdomain : bool (optional, default True) Fill subdomain placeholder with the first available subdomain. If False, the URL will contain ``{s}`` placeholder for subdomain. **kwargs Other potential attributes updating the :class:`TileProvider`. Returns ------- url : str Formatted URL Examples -------- >>> import xyzservices.providers as xyz >>> xyz.CartoDB.DarkMatter.build_url() 'https://a.basemaps.cartocdn.com/dark_all/{z}/{x}/{y}.png' >>> xyz.CartoDB.DarkMatter.build_url(x=9, y=11, z=5) 'https://a.basemaps.cartocdn.com/dark_all/5/9/11.png' >>> xyz.CartoDB.DarkMatter.build_url(x=9, y=11, z=5, scale_factor="@2x") 'https://a.basemaps.cartocdn.com/dark_all/5/9/11@2x.png' >>> xyz.MapBox.build_url(accessToken="my_token") 'https://api.mapbox.com/styles/v1/mapbox/streets-v11/tiles/{z}/{x}/{y}?access_token=my_token' Nz{x}z{y}z{z}zToken is required for this provider, but not provided. You can either update TileProvider or pass respective keywords to build_url().rWrr subdomainsabcrz{s})rrirjsrmr)rgrdr4rMpopformat) rrrirjrkrlr^r,rWrmrnrprrr build_url}s,5     zTileProvider.build_urlboolcCs8|D]\}}t|trd|vr||jvrdSqdS)al Returns ``True`` if the TileProvider requires access token to fetch tiles. The token attribute name vary and some :class:`TileProvider` objects may require more than one token (e.g. ``HERE``). The information is deduced from the presence of `'"`` string to ensure that :meth:`~xyzservices.TileProvider.requires_token` method works properly. Returns ------- bool Examples -------- >>> import xyzservices.providers as xyz >>> xyz.MapBox.requires_token() True >>> xyz.CartoDB.Positron False We can specify this API key by calling the object or overriding the attribute. Overriding the attribute will alter existing object: >>> xyz.OpenWeatherMap.Clouds["apiKey"] = "my-private-api-key" Calling the object will return a copy: >>> xyz.OpenWeatherMap.Clouds(apiKey="my-private-api-key") z z
    z
    rrrz
    xyzservices.TileProvider
    z
    z\
    )rBr!r*)rr provider_inforrur&r'rrr r s zTileProvider._repr_html_r*cCsd}ttj|dt|d}|D] }|d|krn qtd|d|d}ttj|d|}||d|d |d |d |d d S)a Creates a :class:`TileProvider` object based on the definition from the `Quick Map Services `__ open catalog. Parameters ---------- name : str Service name Returns ------- :class:`TileProvider` Examples -------- >>> from xyzservices.lib import TileProvider >>> provider = TileProvider.from_qms("OpenTopoMap") z*https://qms.nextgis.com/api/v1/geoservicesz /?search=z &type=tmsr*z Service 'z ' not found.id/rWz_minz_maxcopyright_text)r*rWmin_zoommax_zoomrX)jsonloadurllibrequesturlopenrrMget)clsr* qms_api_urlservicesservice service_idservice_detailsrrr from_qmss( zTileProvider.from_qms)r(r)NNNNT) rrhrirhrjrhrkr3rlr5r(r)r(rtrQrR)rSrTrUrVr[rergrsr4propertyrvr classmethodr __classcell__rrrbr r's" =   W)  rcsVt|}t}|D]}||dvrt||<q tfddD||<q |S)NrWcsi|] }|t|qSrrf)rir,rr r Xsz_load_json..)rloadsr r)fdata providers provider_namerrr _load_jsonKs  ru8 /* CSS stylesheet for displaying xyzservices objects in Jupyter.*/ .xyz-wrap { --xyz-border-color: var(--jp-border-color2, #ddd); --xyz-font-color2: var(--jp-content-font-color2, rgba(128, 128, 128, 1)); --xyz-background-color-white: var(--jp-layout-color1, white); --xyz-background-color: var(--jp-layout-color2, rgba(128, 128, 128, 0.1)); } html[theme=dark] .xyz-wrap, body.vscode-dark .xyz-wrap, body.vscode-high-contrast .xyz-wrap { --xyz-border-color: #222; --xyz-font-color2: rgba(255, 255, 255, 0.54); --xyz-background-color-white: rgba(255, 255, 255, 1); --xyz-background-color: rgba(255, 255, 255, 0.05); } .xyz-header { padding-top: 6px; padding-bottom: 6px; margin-bottom: 4px; border-bottom: solid 1px var(--xyz-border-color); } .xyz-header>div { display: inline; margin-top: 0; margin-bottom: 0; } .xyz-obj, .xyz-name { margin-left: 2px; margin-right: 10px; } .xyz-obj { color: var(--xyz-font-color2); } .xyz-attrs { grid-column: 1 / -1; } dl.xyz-attrs { padding: 0 5px 0 5px; margin: 0; display: grid; grid-template-columns: 135px auto; background-color: var(--xyz-background-color); } .xyz-attrs dt, dd { padding: 0; margin: 0; float: left; padding-right: 10px; width: auto; } .xyz-attrs dt { font-weight: normal; grid-column: 1; } .xyz-attrs dd { grid-column: 2; white-space: pre-wrap; word-break: break-all; } .xyz-details ul>li>label>span { color: var(--xyz-font-color2); padding-left: 10px; } .xyz-inside { display: none; } .xyz-checkbox:checked~.xyz-inside { display: contents; } .xyz-collapsible li>input { display: none; } .xyz-collapsible>li>label { cursor: pointer; } .xyz-collapsible>li>label:hover { color: var(--xyz-font-color2); } ul.xyz-collapsible { list-style: none!important; padding-left: 20px!important; } .xyz-checkbox+label:before { content: '►'; font-size: 11px; } .xyz-checkbox:checked+label:before { content: '▼'; } .xyz-wrap { margin-bottom: 10px; } )rV __future__rrurllib.requestrrtypingr urllib.parserr maketransrKr)r rrr!rrrr s    &