U
s r
z., -_/c @ s` e Zd ZdZdd Zdd ZdddZd d
d d Zdddddd dddZdddddZ d
S )Buncha A 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
C s> z | |W S tk
r8 } zt||W 5 d }~X Y nX d S N) __getitem__KeyErrorAttributeError)selfkeyerrr r r __getattr__* s zBunch.__getattr__c C s | S r )keysr r r r __dir__0 s z
Bunch.__dir__Fc C s d}| D ]\}t | | tr d}nd}tt }|d| d| d| d| d| | jd d
d 7 }q|rndn
d t d
}d| dt| d| d}|S )Nr zxyzservices.TileProviderzxyzservices.BunchzO
z zM
T)insidez6
)
isinstance TileProviderstruuidZuuid4 _repr_html_ CSS_STYLElen)r r childrenr objuidstylehtmlr r r r 3 s4
zBunch._repr_html_dictreturnc s i fdd | S )a Return 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
c s0 t | tr| | j< n| D ] } | q d S r )r r namevalues)providerZprov_get_providersZflatr r r. r s
z%Bunch.flatten.._get_providersr r r r- r flattenY s z
Bunch.flattenN
str | None bool | Nonez Callable[[TileProvider], bool])keywordr* requires_tokenfunctionr) c s( dd fdd | ||||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 S s g }|d k rJd}| D ]&}t|tr| | krd} q@q|| |d k rvd}| | j krld}|| |d k rd}| |krd}|| t|S )NFT)r+ r r lowerappendr* r3 all) r, r2 r* r3 ZcondZ
keyword_matchvZ
name_matchZ token_matchr r r _validate s&
z Bunch.filter.._validatec sx t }| D ]d\}}t|trT|d krB||||drR|||< qr||rr|||< q |||||d}|r|||< q|S )N)r2 r* r3 r2 r* r3 r4 )r itemsr r ) Zbunchr2 r* r3 r4 newr valuefiltered
_filter_bunchr9 r r r@ s.
z#Bunch.filter.._filter_bunchr: r )r r2 r* r3 r4 r r? r filter} s B z Bunch.filterr r r* r) c C sH dd | D }|t }||kr4|| S td| ddS )a Return :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")
c S s i | ]\}}| t |qS r ) translateQUERY_NAME_TRANSLATIONr5 )r kr8 r r r r
s z$Bunch.query_name..z*No matching provider found for the query 'z'.N)r/ r; rC rD r5
ValueError)r r* Zxyz_flat_lowerZ
name_cleanr r r
query_name s
zBunch.query_name)F)NNNN)
__name__
__module__ __qualname____doc__r r r r/ rA rG r r r r r s
&& r c s e Zd ZdZ fddZd dddZd dddZd d d d d d
ddddZddddZe dd Z
d ddZ e dd ddd Z
ZS ) r a$
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'
c s\ t j|| g }dD ]}|| kr|| qt|dkrXdd| d}t|d S )N)r* url attributionr zyThe attributes `name`, `url`, and `attribution` are required to initialise a `TileProvider`. Please provide values for: `z`, ``)super__init__r r6 r! joinr )r argskwargsmissingelmsg __class__r r rP e s zTileProvider.__init__r( c K s t | }|| |S r )r update)r rS r< r r r __call__t s
zTileProvider.__call__c C s t | }|S r r )r r< r r r copyy s zTileProvider.copyNTzint | str | Noner0 r1 r )r yz scale_factorfill_subdomainr) c K s | }|dkrd}|dkr d}|dkr,d}|| | rFtd|d}|rf|} |dd n |dd} |r|d d
}
|
d } nd } |jf |||| | 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().rL rr
subdomainsabcr z{s})r r] r^ sra )r\ rY r3 rF popformat) r r r] r^ r_ r` rS r, rL ra rb rd r r r build_url} s, 5
zTileProvider.build_urlboolc C s8 | D ]*\}}t|trd|kr|| jkr dS qdS )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 r r r z
)r; r r* )r r Z
provider_infor ri r% r& r r r r s
zTileProvider._repr_html_rB c C s d}t tj| dt| d}|D ]}|d |kr* qPq*td| d|d }t tj| d| }| |d |d |d
|d |d d
S )a
Creates a :class:`TileProvider` object based on the definition from
the `Quick Map Services .)rm loadsr r )fdataZ providersZ
provider_namer ry r
_load_jsonK s
r} u8
/* 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;
}
)rK
__future__r rm urllib.requestro r typingr urllib.parser r maketransrD r' r r r} r r r r r s &