feat: add methods to generate multi_polygon, multi_polygon2d and multi_polygon3d

Author: impocode

geojson_faker/constants.py

@@ -22,6 +22,9 @@ class geo_keys(NamedTuple):
     polygon = "polygon"
     polygon2d = "polygon2d"
     polygon3d = "polygon3d"
+    multi_polygon = "multi_polygon"
+    multi_polygon2d = "multi_polygon2d"
+    multi_polygon3d = "multi_polygon3d"
 
 
 DIMENSIONS = [Dimension.two, Dimension.three]

geojson_faker/faker.py

@@ -1,14 +1,22 @@
 from collections.abc import Callable
 from typing import TypeVar
 
-from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point, Polygon
+from geojson_pydantic.geometries import (
+    LineString,
+    MultiLineString,
+    MultiPoint,
+    MultiPolygon,
+    Point,
+    Polygon,
+)
 from geojson_pydantic.types import Position
 
 from geojson_faker.constants import geo_keys
 from geojson_faker.generators import (
     fake_line_string,
     fake_multi_line_string,
     fake_multi_point,
+    fake_multi_polygon,
     fake_point,
     fake_polygon,
     fake_position,
@@ -40,6 +48,9 @@ def __init__(self, random_always: bool = True):
             geo_keys.polygon: None,
             geo_keys.polygon2d: None,
             geo_keys.polygon3d: None,
+            geo_keys.multi_polygon: None,
+            geo_keys.multi_polygon2d: None,
+            geo_keys.multi_polygon3d: None,
         }
 
     @property
@@ -132,6 +143,22 @@ def polygon2d(self) -> Polygon:
     def polygon3d(self) -> Polygon:
         return self._fake(func=fake_polygon, geo_key=geo_keys.polygon3d, dimension=Dimension.three)
 
+    @property
+    def multi_polygon(self) -> MultiPolygon:
+        return self._fake(func=fake_multi_polygon, geo_key=geo_keys.multi_polygon)
+
+    @property
+    def multi_polygon2d(self) -> MultiPolygon:
+        return self._fake(
+            func=fake_multi_polygon, geo_key=geo_keys.multi_polygon2d, dimension=Dimension.two
+        )
+
+    @property
+    def multi_polygon3d(self) -> MultiPolygon:
+        return self._fake(
+            func=fake_multi_polygon, geo_key=geo_keys.multi_polygon3d, dimension=Dimension.three
+        )
+
     def _fake(
         self,
         func: Callable[[Dimension | None], _GeoJsonType],

geojson_faker/generators.py

@@ -1,6 +1,13 @@
 from random import randint, randrange, uniform
 
-from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point, Polygon
+from geojson_pydantic.geometries import (
+    LineString,
+    MultiLineString,
+    MultiPoint,
+    MultiPolygon,
+    Point,
+    Polygon,
+)
 from geojson_pydantic.types import Position, Position2D, Position3D
 
 from geojson_faker.constants import DIMENSIONS
@@ -103,3 +110,33 @@ def fake_polygon(
         linear_ring.append(end_coordinates)
         coordinates.append(linear_ring)
     return Polygon(type="Polygon", coordinates=coordinates)
+
+
+def fake_multi_polygon(
+    dimension: Dimension | None = None,
+    max_coordinates: int = 100,
+    max_polygon_coordinates: int = 100,
+    max_linear_ring_coordinates: int = 100,
+) -> MultiPolygon:
+    min_linear_ring_coordinates = 4
+    if max_linear_ring_coordinates < min_linear_ring_coordinates:
+        max_linear_ring_coordinates = min_linear_ring_coordinates
+    coordinates = []
+    for _ in _randintrange(1, max_coordinates):
+        polygon_coordinates = []
+        for _ in _randintrange(1, max_polygon_coordinates):
+            start_coordinates = end_coordinates = fake_position(dimension=dimension)
+            linear_ring = []
+            linear_ring.append(start_coordinates)
+            linear_ring.extend(
+                [
+                    fake_position(dimension=dimension)
+                    for _ in _randintrange(
+                        min_linear_ring_coordinates - 2, max_linear_ring_coordinates - 2
+                    )
+                ]
+            )
+            linear_ring.append(end_coordinates)
+            polygon_coordinates.append(linear_ring)
+        coordinates.append(polygon_coordinates)
+    return MultiPolygon(type="MultiPolygon", coordinates=coordinates)

readme.md

@@ -14,7 +14,7 @@
 |     LineString     |     done    |
 |  MultiLineString   |     done    |
 |      Polygon       |     done    |
-|    MultiPolygon    | in progress |
+|    MultiPolygon    |     done    |
 | GeometryCollection | in progress |
 |      Feature       | in progress |
 |  FeatureCollection | in progress |

tests/faker_test.py

@@ -1,4 +1,11 @@
-from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point, Polygon
+from geojson_pydantic.geometries import (
+    LineString,
+    MultiLineString,
+    MultiPoint,
+    MultiPolygon,
+    Point,
+    Polygon,
+)
 from geojson_pydantic.types import Position, Position2D, Position3D
 
 from geojson_faker import GeoJsonFaker
@@ -291,3 +298,67 @@ def test_polygon3d():
             assert isinstance(coordinates.longitude, float)
             assert isinstance(coordinates.latitude, float)
             assert isinstance(coordinates.altitude, float)
+
+
+def test_multi_polygon():
+    geojson_faker = GeoJsonFaker()
+    multi_polygon = geojson_faker.multi_polygon
+
+    assert isinstance(multi_polygon, MultiPolygon)
+    assert multi_polygon.type == "MultiPolygon"
+    assert 0 < len(multi_polygon.coordinates) <= 100
+
+    for polygon in multi_polygon.coordinates:
+        assert isinstance(polygon, list)
+        for linear_ring in polygon:
+            assert isinstance(linear_ring, list)
+            assert 4 <= len(linear_ring) <= 100
+            for coordinates in linear_ring:
+                assert isinstance(coordinates, Position2D) or isinstance(coordinates, Position3D)
+                assert isinstance(coordinates.longitude, float)
+                assert isinstance(coordinates.latitude, float)
+                if isinstance(coordinates, Position3D):
+                    assert isinstance(coordinates.altitude, float)
+
+
+def test_multi_polygon2d():
+    geojson_faker = GeoJsonFaker()
+    multi_polygon = geojson_faker.multi_polygon2d
+
+    assert isinstance(multi_polygon, MultiPolygon)
+    assert multi_polygon.type == "MultiPolygon"
+    assert 0 < len(multi_polygon.coordinates) <= 100
+
+    for polygon in multi_polygon.coordinates:
+        assert isinstance(polygon, list)
+        for linear_ring in polygon:
+            assert isinstance(linear_ring, list)
+            assert 4 <= len(linear_ring) <= 100
+            for coordinates in linear_ring:
+                assert isinstance(coordinates, Position2D) and not isinstance(
+                    coordinates, Position3D
+                )
+                assert isinstance(coordinates.longitude, float)
+                assert isinstance(coordinates.latitude, float)
+
+
+def test_multi_polygon3d():
+    geojson_faker = GeoJsonFaker()
+    multi_polygon = geojson_faker.multi_polygon3d
+
+    assert isinstance(multi_polygon, MultiPolygon)
+    assert multi_polygon.type == "MultiPolygon"
+    assert 0 < len(multi_polygon.coordinates) <= 100
+
+    for polygon in multi_polygon.coordinates:
+        assert isinstance(polygon, list)
+        for linear_ring in polygon:
+            assert isinstance(linear_ring, list)
+            assert 4 <= len(linear_ring) <= 100
+            for coordinates in linear_ring:
+                assert isinstance(coordinates, Position3D) and not isinstance(
+                    coordinates, Position2D
+                )
+                assert isinstance(coordinates.longitude, float)
+                assert isinstance(coordinates.latitude, float)
+                assert isinstance(coordinates.altitude, float)