This repository was archived by the owner on May 7, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 69
Expand file tree
/
Copy pathtest_geoseries.py
More file actions
659 lines (556 loc) · 19.5 KB
/
test_geoseries.py
File metadata and controls
659 lines (556 loc) · 19.5 KB
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import re
import bigframes_vendored.constants as constants
import geopandas as gpd
from geopandas.array import GeometryDtype
import geopandas.testing
import google.api_core.exceptions
import pandas as pd
import pytest
from shapely.geometry import ( # type: ignore
GeometryCollection,
LineString,
Point,
Polygon,
)
import bigframes.geopandas
import bigframes.pandas
import bigframes.series
import bigframes.session
from bigframes.testing.utils import assert_series_equal
@pytest.fixture(scope="session")
def urban_areas_dfs(session, urban_areas_table_id):
bf_ua = session.read_gbq(urban_areas_table_id, index_col="geo_id")
pd_ua = bf_ua.to_pandas()
return (bf_ua, pd_ua)
def test_geo_x(urban_areas_dfs):
bf_ua, pd_ua = urban_areas_dfs
bf_series: bigframes.geopandas.GeoSeries = bf_ua["internal_point_geom"].geo
pd_series: geopandas.GeoSeries = geopandas.GeoSeries(pd_ua["internal_point_geom"])
bf_result = bf_series.x.to_pandas()
pd_result = pd_series.x
assert_series_equal(
pd_result.astype(pd.Float64Dtype()),
bf_result,
)
def test_geo_x_non_point(urban_areas_dfs):
bf_ua, _ = urban_areas_dfs
bf_series: bigframes.geopandas.GeoSeries = bf_ua["urban_area_geom"].geo
with pytest.raises(google.api_core.exceptions.BadRequest, match="ST_X"):
bf_series.x.to_pandas()
def test_geo_y(urban_areas_dfs):
bf_ua, pd_ua = urban_areas_dfs
bf_series: bigframes.geopandas.GeoSeries = bf_ua["internal_point_geom"].geo
pd_series: geopandas.GeoSeries = geopandas.GeoSeries(pd_ua["internal_point_geom"])
bf_result = bf_series.y.to_pandas()
pd_result = pd_series.y
assert_series_equal(
pd_result.astype(pd.Float64Dtype()),
bf_result,
)
def test_geo_area_not_supported(session: bigframes.session.Session):
s = bigframes.pandas.Series(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
dtype=GeometryDtype(),
session=session,
)
bf_series: bigframes.geopandas.GeoSeries = s.geo
with pytest.raises(
NotImplementedError,
match=re.escape(
f"GeoSeries.area is not supported. Use bigframes.bigquery.st_area(series), instead. {constants.FEEDBACK_LINK}"
),
):
bf_series.area
def test_geoseries_length_property_not_implemented(session):
gs = bigframes.geopandas.GeoSeries([Point(0, 0)], session=session)
with pytest.raises(
NotImplementedError,
match=re.escape(
"GeoSeries.length is not yet implemented. Please use bigframes.bigquery.st_length(geoseries) instead."
),
):
_ = gs.length
def test_geo_distance_not_supported(session: bigframes.session.Session):
s1 = bigframes.pandas.Series(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
dtype=GeometryDtype(),
session=session,
)
s2 = bigframes.geopandas.GeoSeries(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
session=session,
)
with pytest.raises(
NotImplementedError,
match=re.escape("GeoSeries.distance is not supported."),
):
s1.geo.distance(s2)
def test_geo_from_xy(session: bigframes.session.Session):
x = [2.5, 5, -3.0]
y = [0.5, 1, 1.5]
bf_result = (
bigframes.geopandas.GeoSeries.from_xy(x, y, session=session)
.astype(geopandas.array.GeometryDtype())
.to_pandas()
)
pd_result = geopandas.GeoSeries.from_xy(x, y, crs="EPSG:4326").astype(
geopandas.array.GeometryDtype()
)
pd.testing.assert_series_equal(
bf_result,
pd_result,
check_series_type=False,
check_index=False,
)
def test_geo_from_wkt(session: bigframes.session.Session):
wkts = [
"Point(0 1)",
"Point(2 4)",
"Point(5 3)",
"Point(6 8)",
]
bf_result = bigframes.geopandas.GeoSeries.from_wkt(
wkts, session=session
).to_pandas()
pd_result = geopandas.GeoSeries.from_wkt(wkts)
pd.testing.assert_series_equal(
bf_result,
pd_result,
check_series_type=False,
check_index=False,
)
def test_geo_to_wkt(session: bigframes.session.Session):
bf_geo = bigframes.geopandas.GeoSeries(
[
Point(0, 1),
Point(2, 4),
Point(5, 3),
Point(6, 8),
],
session=session,
)
pd_geo = geopandas.GeoSeries(
[
Point(0, 1),
Point(2, 4),
Point(5, 3),
Point(6, 8),
]
)
# Test was failing before using str.replace because the pd_result had extra
# whitespace "POINT (0 1)" while bf_result had none "POINT(0 1)".
# str.replace replaces any encountered whitespaces with none.
bf_result = (
bf_geo.to_wkt().astype("string[pyarrow]").to_pandas().str.replace(" ", "")
)
pd_result = pd_geo.to_wkt().astype("string[pyarrow]").str.replace(" ", "")
pd.testing.assert_series_equal(
bf_result,
pd_result,
check_index=False,
)
def test_geo_boundary(session: bigframes.session.Session):
bf_s = bigframes.series.Series(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
session=session,
)
pd_s = geopandas.GeoSeries(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
index=pd.Index([0, 1, 2, 3, 4], dtype="Int64"),
crs="WGS84",
)
bf_result = bf_s.geo.boundary.to_pandas()
pd_result = pd_s.boundary
geopandas.testing.assert_geoseries_equal( # type: ignore
bf_result,
pd_result,
check_series_type=False,
check_index_type=False,
)
# the GeoSeries and GeoPandas results are not always the same.
# For example, when the difference between two polygons is empty,
# GeoPandas returns 'POLYGON EMPTY' while GeoSeries returns 'GeometryCollection([])'.
# This is why we are hard-coding the expected results.
def test_geo_difference_with_geometry_objects(session: bigframes.session.Session):
data1 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1), (0, 0)]),
Point(0, 1),
]
data2 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1), (0, 0)]),
LineString([(2, 0), (0, 2)]),
]
bf_s1 = bigframes.geopandas.GeoSeries(data=data1, session=session)
bf_s2 = bigframes.geopandas.GeoSeries(data=data2, session=session)
bf_result = bf_s1.difference(bf_s2).to_pandas()
expected = bigframes.geopandas.GeoSeries(
[
Polygon([]),
Polygon([]),
Point(0, 1),
],
index=[0, 1, 2],
session=session,
).to_pandas()
assert bf_result.dtype == "geometry"
assert expected.iloc[0].equals(bf_result.iloc[0])
assert expected.iloc[1].equals(bf_result.iloc[1])
assert expected.iloc[2].equals(bf_result.iloc[2])
def test_geo_difference_with_single_geometry_object(session: bigframes.session.Session):
data1 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(4, 2), (6, 2), (8, 6), (4, 2)]),
Point(0, 1),
]
bf_s1 = bigframes.geopandas.GeoSeries(data=data1, session=session)
bf_result = bf_s1.difference(
bigframes.geopandas.GeoSeries(
[
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(1, 0), (0, 5), (0, 0), (1, 0)]),
],
session=session,
),
).to_pandas()
expected = bigframes.geopandas.GeoSeries(
[
GeometryCollection([]),
Polygon([(4, 2), (6, 2), (8, 6), (4, 2)]),
None,
],
index=[0, 1, 2],
session=session,
).to_pandas()
assert bf_result.dtype == "geometry"
assert (expected.iloc[0]).equals(bf_result.iloc[0])
assert expected.iloc[1] == bf_result.iloc[1]
assert expected.iloc[2] == bf_result.iloc[2]
def test_geo_difference_with_similar_geometry_objects(
session: bigframes.session.Session,
):
data1 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
]
bf_s1 = bigframes.geopandas.GeoSeries(data=data1, session=session)
bf_result = bf_s1.difference(bf_s1).to_pandas()
expected = bigframes.geopandas.GeoSeries(
[GeometryCollection([]), GeometryCollection([]), GeometryCollection([])],
index=[0, 1, 2],
session=session,
).to_pandas()
assert bf_result.dtype == "geometry"
assert expected.iloc[0].equals(bf_result.iloc[0])
assert expected.iloc[1].equals(bf_result.iloc[1])
assert expected.iloc[2].equals(bf_result.iloc[2])
def test_geo_drop_duplicates(session: bigframes.session.Session):
bf_series = bigframes.geopandas.GeoSeries(
[Point(1, 1), Point(2, 2), Point(3, 3), Point(2, 2)],
session=session,
)
pd_series = geopandas.GeoSeries(
[Point(1, 1), Point(2, 2), Point(3, 3), Point(2, 2)]
)
bf_result = bf_series.drop_duplicates().to_pandas()
pd_result = pd_series.drop_duplicates()
pd.testing.assert_series_equal(
geopandas.GeoSeries(bf_result), pd_result, check_index=False
)
# the GeoSeries and GeoPandas results are not always the same.
# For example, when the intersection between two polygons is empty,
# GeoPandas returns 'POLYGON EMPTY' while GeoSeries returns 'GeometryCollection([])'.
# This is why we are hard-coding the expected results.
def test_geo_intersection_with_geometry_objects(session: bigframes.session.Session):
data1 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1), (0, 0)]),
Point(0, 1),
]
data2 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1), (0, 0)]),
LineString([(2, 0), (0, 2)]),
]
bf_s1 = bigframes.geopandas.GeoSeries(data=data1, session=session)
bf_s2 = bigframes.geopandas.GeoSeries(data=data2, session=session)
bf_result = bf_s1.intersection(bf_s2).to_pandas()
expected = bigframes.geopandas.GeoSeries(
[
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1), (0, 0)]),
GeometryCollection([]),
],
session=session,
).to_pandas()
assert bf_result.dtype == "geometry"
assert expected.iloc[0].equals(bf_result.iloc[0])
assert expected.iloc[1].equals(bf_result.iloc[1])
assert expected.iloc[2].equals(bf_result.iloc[2])
def test_geo_intersection_with_single_geometry_object(
session: bigframes.session.Session,
):
data1 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(4, 2), (6, 2), (8, 6), (4, 2)]),
Point(0, 1),
]
bf_s1 = bigframes.geopandas.GeoSeries(data=data1, session=session)
bf_result = bf_s1.intersection(
bigframes.geopandas.GeoSeries(
[
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(1, 0), (0, 5), (0, 0), (1, 0)]),
],
session=session,
),
).to_pandas()
expected = bigframes.geopandas.GeoSeries(
[
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
GeometryCollection([]),
None,
],
index=[0, 1, 2],
session=session,
).to_pandas()
assert bf_result.dtype == "geometry"
assert (expected.iloc[0]).equals(bf_result.iloc[0])
assert expected.iloc[1] == bf_result.iloc[1]
assert expected.iloc[2] == bf_result.iloc[2]
def test_geo_intersection_with_similar_geometry_objects(
session: bigframes.session.Session,
):
data1 = [
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
]
bf_s1 = bigframes.geopandas.GeoSeries(data=data1, session=session)
bf_result = bf_s1.intersection(bf_s1).to_pandas()
expected = bigframes.geopandas.GeoSeries(
[
Polygon([(0, 0), (10, 0), (10, 10), (0, 0)]),
Polygon([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
index=[0, 1, 2],
session=session,
).to_pandas()
assert bf_result.dtype == "geometry"
assert expected.iloc[0].equals(bf_result.iloc[0])
assert expected.iloc[1].equals(bf_result.iloc[1])
assert expected.iloc[2].equals(bf_result.iloc[2])
def test_geo_is_valid(session: bigframes.session.Session):
gseries = geopandas.GeoSeries.from_wkt(
[
"POLYGON ((0 0, 1 1, 0 1, 0 0))",
"POLYGON ((0 0, 1 1, 1 0, 0 1, 0 0))",
]
)
bf_gseries = bigframes.geopandas.GeoSeries(gseries, session=session)
result = gpd.GeoSeries(bf_gseries.is_valid.to_pandas())
expected = gseries.is_valid
assert_series_equal(
expected, result, check_index=False, check_names=False, check_dtype=False
)
def test_geo_is_simple(session: bigframes.session.Session):
gseries = geopandas.GeoSeries.from_wkt(
[
"LINESTRING (0 0, 1 1)",
"LINESTRING (0 0, 1 1, 0 1, 1 0)",
]
)
bf_gseries = bigframes.geopandas.GeoSeries(gseries, session=session)
result = gpd.GeoSeries(bf_gseries.is_simple.to_pandas())
expected = gseries.is_simple
assert_series_equal(
expected, result, check_index=False, check_names=False, check_dtype=False
)
def test_geo_geom_type(session: bigframes.session.Session):
gseries = geopandas.GeoSeries.from_wkt(
[
"POINT (0 0)",
"POLYGON ((0 0, 1 1, 0 1, 0 0))",
]
)
bf_gseries = bigframes.geopandas.GeoSeries(gseries, session=session)
result = gpd.GeoSeries(bf_gseries.geom_type.to_pandas())
expected = gseries.geom_type
assert_series_equal(
expected, result, check_index=False, check_names=False, check_dtype=False
)
def test_geo_union(session: bigframes.session.Session):
gseries1 = geopandas.GeoSeries.from_wkt(
[
"POINT (0 0)",
"POLYGON ((0 0, 1 0, 1 1, 0 1, 0 0))",
]
)
gseries2 = geopandas.GeoSeries.from_wkt(
[
"POINT (1 1)",
"POLYGON ((2 0, 3 0, 3 1, 2 1, 2 0))",
]
)
bf_gseries1 = bigframes.geopandas.GeoSeries(gseries1, session=session)
bf_gseries2 = bigframes.geopandas.GeoSeries(gseries2, session=session)
result = bf_gseries1.union(bf_gseries2).to_pandas()
expected = gseries1.union(gseries2)
geopandas.testing.assert_geoseries_equal( # type: ignore
gpd.GeoSeries(result), expected, check_series_type=False
)
def test_geo_is_ring(session: bigframes.session.Session):
gseries = geopandas.GeoSeries.from_wkt(
[
"LINESTRING (0 0, 1 0, 1 1, 0 1, 0 0)",
"LINESTRING (0 0, 1 1, 1 0, 0 1)",
]
)
bf_gseries = bigframes.geopandas.GeoSeries(gseries, session=session)
result = gpd.GeoSeries(bf_gseries.is_ring.to_pandas())
expected = gseries.is_ring
assert_series_equal(
expected, result, check_index=False, check_names=False, check_dtype=False
)
def test_geo_is_closed_not_supported(session: bigframes.session.Session):
s = bigframes.series.Series(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
dtype=GeometryDtype(),
session=session,
)
bf_series: bigframes.geopandas.GeoSeries = s.geo
with pytest.raises(
NotImplementedError,
match=re.escape(
f"GeoSeries.is_closed is not supported. Use bigframes.bigquery.st_isclosed(series), instead. {constants.FEEDBACK_LINK}"
),
):
bf_series.is_closed
def test_geo_buffer_raises_notimplemented(session: bigframes.session.Session):
"""GeoPandas takes distance in units of the coordinate system, but BigQuery
uses meters.
"""
s = bigframes.geopandas.GeoSeries(
[
Point(0, 0),
],
session=session,
)
with pytest.raises(
NotImplementedError, match=re.escape("bigframes.bigquery.st_buffer")
):
s.buffer(1000)
def test_geo_centroid(session: bigframes.session.Session):
bf_s = bigframes.series.Series(
[
Polygon([(0, 0), (0.1, 0.1), (0, 0.1)]),
LineString([(10, 10), (10.0001, 10.0001), (10, 10.0001)]),
Point(-10, -10),
],
session=session,
)
pd_s = geopandas.GeoSeries(
[
Polygon([(0, 0), (0.1, 0.1), (0, 0.1)]),
LineString([(10, 10), (10.0001, 10.0001), (10, 10.0001)]),
Point(-10, -10),
],
index=pd.Index([0, 1, 2], dtype="Int64"),
crs="WGS84",
)
bf_result = bf_s.geo.centroid.to_pandas()
# Avoid warning that centroid is incorrect for geographic CRS.
# https://gis.stackexchange.com/a/401815/275289
pd_result = pd_s.to_crs("+proj=cea").centroid.to_crs("WGS84")
geopandas.testing.assert_geoseries_equal( # type: ignore
bf_result,
pd_result,
check_series_type=False,
check_index_type=False,
# BigQuery geography calculations are on a sphere, so results will be
# slightly different.
check_less_precise=True,
)
def test_geo_convex_hull(session: bigframes.session.Session):
bf_s = bigframes.series.Series(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
session=session,
)
pd_s = geopandas.GeoSeries(
[
Polygon([(0, 0), (1, 1), (0, 1)]),
Polygon([(10, 0), (10, 5), (0, 0)]),
Polygon([(0, 0), (2, 2), (2, 0)]),
LineString([(0, 0), (1, 1), (0, 1)]),
Point(0, 1),
],
index=pd.Index([0, 1, 2, 3, 4], dtype="Int64"),
crs="WGS84",
)
bf_result = bf_s.geo.convex_hull.to_pandas()
pd_result = pd_s.convex_hull
geopandas.testing.assert_geoseries_equal( # type: ignore
bf_result,
pd_result,
check_series_type=False,
check_index_type=False,
)