-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
test_folium.py
349 lines (277 loc) · 11.8 KB
/
test_folium.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# -*- coding: utf-8 -*-
"""
Folium Tests
-------
"""
import json
import os
import branca.element
import folium
from folium.features import GeoJson, Choropleth
import jinja2
from jinja2 import Environment, PackageLoader
from jinja2.utils import htmlsafe_json_dumps
import numpy as np
import pandas as pd
import pytest
try:
from unittest import mock
except ImportError:
import mock
rootpath = os.path.abspath(os.path.dirname(__file__))
# For testing remote requests
remote_url = 'https://raw.githubusercontent.com/python-visualization/folium/master/examples/data/us-states.json' # noqa
def setup_data():
"""Import economic data for testing."""
with open(os.path.join(rootpath, 'us-counties.json')) as f:
get_id = json.load(f)
county_codes = [x['id'] for x in get_id['features']]
county_df = pd.DataFrame({'FIPS_Code': county_codes}, dtype=str)
# Read into Dataframe, cast to string for consistency.
df = pd.read_csv(os.path.join(rootpath, 'us_county_data.csv'),
na_values=[' '])
df['FIPS_Code'] = df['FIPS_Code'].astype(str)
# Perform an inner join, pad NA's with data from nearest county.
merged = pd.merge(df, county_df, on='FIPS_Code', how='inner')
return merged.fillna(method='pad')
def test_get_templates():
"""Test template getting."""
env = branca.utilities.get_templates()
assert isinstance(env, jinja2.environment.Environment)
def test_location_args():
"""Test some data types for a location arg."""
location = np.array([45.5236, -122.6750])
m = folium.Map(location)
assert m.location == [45.5236, -122.6750]
df = pd.DataFrame({"location": [45.5236, -122.6750]})
m = folium.Map(df["location"])
assert m.location == [45.5236, -122.6750]
class TestFolium(object):
"""Test class for the Folium library."""
def setup(self):
"""Setup Folium Map."""
with mock.patch('branca.element.uuid4') as uuid4:
uuid4().hex = '0' * 32
attr = 'http://openstreetmap.org'
self.m = folium.Map(
location=[45.5236, -122.6750],
width=900,
height=400,
max_zoom=20,
zoom_start=4,
max_bounds=True,
attr=attr
)
self.env = Environment(loader=PackageLoader('folium', 'templates'))
def test_init(self):
"""Test map initialization."""
assert self.m.get_name() == 'map_00000000000000000000000000000000'
assert self.m.get_root() == self.m._parent
assert self.m.location == [45.5236, -122.6750]
assert self.m.options['zoom'] == 4
assert self.m.options['maxBounds'] == [[-90, -180], [90, 180]]
assert self.m.position == 'relative'
assert self.m.height == (400, 'px')
assert self.m.width == (900, 'px')
assert self.m.left == (0, '%')
assert self.m.top == (0, '%')
assert self.m.global_switches.no_touch is False
assert self.m.global_switches.disable_3d is False
assert self.m.to_dict() == {
'name': 'Map',
'id': '00000000000000000000000000000000',
'children': {
'openstreetmap': {
'name': 'TileLayer',
'id': '00000000000000000000000000000000',
'children': {}
}
}
}
def test_builtin_tile(self):
"""Test custom maptiles."""
default_tiles = [
"OpenStreetMap",
"Stamen Terrain",
"Stamen Toner",
"Mapbox Bright",
"Mapbox Control Room",
"CartoDB positron",
"CartoDB dark_matter",
]
for tiles in default_tiles:
m = folium.Map(location=[45.5236, -122.6750], tiles=tiles)
tiles = "".join(tiles.lower().strip().split())
url = "tiles/{}/tiles.txt".format
attr = "tiles/{}/attr.txt".format
url = m._env.get_template(url(tiles)).render()
attr = m._env.get_template(attr(tiles)).render()
assert m._children[tiles].tiles == url
assert htmlsafe_json_dumps(attr) in m._parent.render()
bounds = m.get_bounds()
assert bounds == [[None, None], [None, None]], bounds
def test_custom_tile(self):
"""Test custom tile URLs."""
url = "http://{s}.custom_tiles.org/{z}/{x}/{y}.png"
attr = "Attribution for custom tiles"
with pytest.raises(ValueError):
folium.Map(location=[45.5236, -122.6750], tiles=url)
m = folium.Map(location=[45.52, -122.67], tiles=url, attr=attr)
assert m._children[url].tiles == url
assert attr in m._parent.render()
bounds = m.get_bounds()
assert bounds == [[None, None], [None, None]], bounds
def test_feature_group(self):
"""Test FeatureGroup."""
m = folium.Map()
feature_group = folium.FeatureGroup()
feature_group.add_child(folium.Marker([45, -30],
popup=folium.Popup('-30')))
feature_group.add_child(folium.Marker([45, 30],
popup=folium.Popup('30')))
m.add_child(feature_group)
m.add_child(folium.LayerControl())
m._repr_html_()
bounds = m.get_bounds()
assert bounds == [[45, -30], [45, 30]], bounds
def test_topo_json_smooth_factor(self):
"""Test topojson smooth factor method."""
self.m = folium.Map([43, -100], zoom_start=4)
# Adding TopoJSON as additional layer.
with open(os.path.join(rootpath, 'or_counties_topo.json')) as f:
choropleth = Choropleth(f, topojson='objects.or_counties_geo',
smooth_factor=0.5).add_to(self.m)
out = self.m._parent.render()
# Verify TopoJson
topo_json = choropleth.geojson
topojson_str = topo_json._template.module.script(topo_json)
assert ''.join(topojson_str.split())[:-1] in ''.join(out.split())
def test_choropleth_features(self):
"""Test to make sure that Choropleth function doesn't allow
values outside of the domain defined by bins.
It also tests that all parameters work as expected regarding
nan and missing values.
"""
self.setup()
with open(os.path.join(rootpath, 'us-counties.json')) as f:
geo_data = json.load(f)
data = {'1001': -1}
fill_color = 'BuPu'
key_on = 'id'
with pytest.raises(ValueError):
Choropleth(
geo_data=geo_data,
data=data,
key_on=key_on,
fill_color=fill_color,
bins=[0, 1, 2, 3]).add_to(self.m)
self.m._parent.render()
Choropleth(
geo_data=geo_data,
data={'1001': 1, '1003': float('nan')},
key_on=key_on,
fill_color=fill_color,
fill_opacity=0.543212345,
nan_fill_color='a_random_color',
nan_fill_opacity=0.123454321).add_to(self.m)
out = self.m._parent.render()
out_str = ''.join(out.split())
assert '"fillColor":"a_random_color","fillOpacity":0.123454321' in out_str
assert '"fillOpacity":0.543212345' in out_str
def test_choropleth_warning(self):
"""Test that the Map.choropleth method works and raises a warning."""
self.setup()
with open(os.path.join(rootpath, 'us-counties.json')) as f:
geo_data = json.load(f)
with pytest.warns(FutureWarning):
self.m.choropleth(geo_data)
assert any([isinstance(child, Choropleth)
for child in self.m._children.values()])
def test_tile_attr_unicode(self):
"""Test tile attribution unicode"""
m = folium.Map(location=[45.5236, -122.6750],
tiles='test', attr='юникод')
m._parent.render()
def test_fit_bounds(self):
"""Test fit_bounds."""
bounds = ((52.193636, -2.221575), (52.636878, -1.139759))
self.setup()
self.m.fit_bounds(bounds)
fitbounds = [val for key, val in self.m._children.items() if
isinstance(val, folium.FitBounds)][0]
out = self.m._parent.render()
fit_bounds_tpl = self.env.get_template('fit_bounds.js')
fit_bounds_rendered = fit_bounds_tpl.render({
'bounds': json.dumps(bounds),
'this': fitbounds,
'fit_bounds_options': {}, })
assert ''.join(fit_bounds_rendered.split()) in ''.join(out.split())
self.setup()
self.m.fit_bounds(bounds, max_zoom=15, padding=(3, 3))
fitbounds = [val for key, val in self.m._children.items() if
isinstance(val, folium.FitBounds)][0]
out = self.m._parent.render()
fit_bounds_tpl = self.env.get_template('fit_bounds.js')
fit_bounds_rendered = fit_bounds_tpl.render({
'bounds': json.dumps(bounds),
'fit_bounds_options': json.dumps({'maxZoom': 15,
'padding': (3, 3), },
sort_keys=True),
'this': fitbounds,
})
assert ''.join(fit_bounds_rendered.split()) in ''.join(out.split())
bounds = self.m.get_bounds()
assert bounds == [[None, None], [None, None]], bounds
def test_custom_icon(self):
"""Test CustomIcon."""
self.setup()
icon_image = 'http://leafletjs.com/docs/images/leaf-green.png'
shadow_image = 'http://leafletjs.com/docs/images/leaf-shadow.png'
self.m = folium.Map([45, -100], zoom_start=4)
i = folium.features.CustomIcon(icon_image,
icon_size=(38, 95),
icon_anchor=(22, 94),
shadow_image=shadow_image,
shadow_size=(50, 64),
shadow_anchor=(4, 62),
popup_anchor=(-3, -76),)
mk = folium.Marker([45, -100], icon=i,
popup=folium.Popup('Hello'))
self.m.add_child(mk)
self.m._parent.render()
bounds = self.m.get_bounds()
assert bounds == [[45, -100], [45, -100]], bounds
def test_global_switches(self):
m = folium.Map(prefer_canvas=True)
out = m._parent.render()
out_str = ''.join(out.split())
assert "preferCanvas:true" in out_str
assert not m.global_switches.no_touch
assert not m.global_switches.disable_3d
m = folium.Map(no_touch=True)
out = m._parent.render()
out_str = ''.join(out.split())
assert "preferCanvas:false" in out_str
assert m.global_switches.no_touch
assert not m.global_switches.disable_3d
m = folium.Map(disable_3d=True)
out = m._parent.render()
out_str = ''.join(out.split())
assert "preferCanvas:false" in out_str
assert not m.global_switches.no_touch
assert m.global_switches.disable_3d
m = folium.Map(prefer_canvas=True, no_touch=True, disable_3d=True)
out = m._parent.render()
out_str = ''.join(out.split())
assert "preferCanvas:true" in out_str
assert m.global_switches.no_touch
assert m.global_switches.disable_3d
@pytest.mark.web
def test_json_request(self):
"""Test requests for remote GeoJSON files."""
self.m = folium.Map(zoom_start=4)
# Adding remote GeoJSON as additional layer.
GeoJson(remote_url, smooth_factor=0.5).add_to(self.m)
self.m._parent.render()
bounds = self.m.get_bounds()
assert bounds == [[18.948267, -178.123152], [71.351633, 173.304726]], bounds # noqa