feat: add methods to generate polygon, polygon2d and polygon3d

Author: impocode

geojson_faker/__init__.py

@@ -7,6 +7,7 @@
     fake_multi_line_string,
     fake_multi_point,
     fake_point,
+    fake_polygon,
     fake_position,
 )
 
@@ -22,4 +23,5 @@
     "fake_multi_point",
     "fake_line_string",
     "fake_multi_line_string",
+    "fake_polygon",
 ]

geojson_faker/constants.py

@@ -19,6 +19,9 @@ class geo_keys(NamedTuple):
     multi_line_string = "multi_line_string"
     multi_line_string2d = "multi_line_string2d"
     multi_line_string3d = "multi_line_string3d"
+    polygon = "polygon"
+    polygon2d = "polygon2d"
+    polygon3d = "polygon3d"
 
 
 DIMENSIONS = [Dimension.two, Dimension.three]

geojson_faker/faker.py

@@ -1,7 +1,7 @@
 from collections.abc import Callable
 from typing import TypeVar
 
-from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point
+from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point, Polygon
 from geojson_pydantic.types import Position
 
 from geojson_faker.constants import geo_keys
@@ -10,6 +10,7 @@
     fake_multi_line_string,
     fake_multi_point,
     fake_point,
+    fake_polygon,
     fake_position,
 )
 from geojson_faker.types import Dimension
@@ -36,6 +37,9 @@ def __init__(self, random_always: bool = True):
             geo_keys.multi_line_string: None,
             geo_keys.multi_line_string2d: None,
             geo_keys.multi_line_string3d: None,
+            geo_keys.polygon: None,
+            geo_keys.polygon2d: None,
+            geo_keys.polygon3d: None,
         }
 
     @property
@@ -116,6 +120,18 @@ def multi_line_string3d(self) -> MultiLineString:
             dimension=Dimension.three,
         )
 
+    @property
+    def polygon(self) -> Polygon:
+        return self._fake(func=fake_polygon, geo_key=geo_keys.polygon)
+
+    @property
+    def polygon2d(self) -> Polygon:
+        return self._fake(func=fake_polygon, geo_key=geo_keys.polygon2d, dimension=Dimension.two)
+
+    @property
+    def polygon3d(self) -> Polygon:
+        return self._fake(func=fake_polygon, geo_key=geo_keys.polygon3d, dimension=Dimension.three)
+
     def _fake(
         self,
         func: Callable[[Dimension | None], _GeoJsonType],

geojson_faker/generators.py

@@ -1,6 +1,6 @@
 from random import randint, randrange, uniform
 
-from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point
+from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point, Polygon
 from geojson_pydantic.types import Position, Position2D, Position3D
 
 from geojson_faker.constants import DIMENSIONS
@@ -11,6 +11,10 @@ def _get_dimension(dimension: Dimension | None = None) -> Dimension:
     return dimension or DIMENSIONS[randrange(len(DIMENSIONS))]
 
 
+def _randintrange(min_value: int, max_value: int) -> range:
+    return range(0, randint(min_value, max_value))
+
+
 def fake_longitude() -> float:
     return uniform(-180, 180)
 
@@ -36,34 +40,66 @@ def fake_point(dimension: Dimension | None = None) -> Point:
     return Point(type="Point", coordinates=fake_position(dimension=dimension))
 
 
-def fake_multi_point(dimension: Dimension | None = None, max_length: int = 1000) -> MultiPoint:
+def fake_multi_point(dimension: Dimension | None = None, max_coordinates: int = 100) -> MultiPoint:
     return MultiPoint(
         type="MultiPoint",
-        coordinates=[fake_position(dimension=dimension) for _ in range(0, randint(1, max_length))],
+        coordinates=[fake_position(dimension=dimension) for _ in _randintrange(1, max_coordinates)],
     )
 
 
-def fake_line_string(dimension: Dimension | None = None, max_length: int = 1000) -> LineString:
-    min_length = 2
-    if max_length < min_length:
-        max_length = min_length
+def fake_line_string(dimension: Dimension | None = None, max_coordinates: int = 100) -> LineString:
+    min_coordinates = 2
+    if max_coordinates < min_coordinates:
+        max_coordinates = min_coordinates
     return LineString(
         type="LineString",
         coordinates=[
-            fake_position(dimension=dimension) for _ in range(0, randint(min_length, max_length))
+            fake_position(dimension=dimension)
+            for _ in _randintrange(min_coordinates, max_coordinates)
         ],
     )
 
 
 def fake_multi_line_string(
-    dimension: Dimension | None = None, max_length: int = 1000
+    dimension: Dimension | None = None,
+    max_coordinates: int = 100,
+    max_line_string_coordinates: int = 100,
 ) -> MultiLineString:
-    min_length = 2
-    if max_length < min_length:
-        max_length = min_length
+    min_line_string_coordinates = 2
+    if max_line_string_coordinates < min_line_string_coordinates:
+        max_line_string_coordinates = min_line_string_coordinates
     coordinates = []
-    for _ in range(0, randint(1, max_length)):
+    for _ in _randintrange(1, max_coordinates):
         coordinates.append(
-            fake_position(dimension=dimension) for _ in range(0, randint(min_length, max_length))
+            [
+                fake_position(dimension=dimension)
+                for _ in _randintrange(min_line_string_coordinates, max_line_string_coordinates)
+            ]
         )
     return MultiLineString(type="MultiLineString", coordinates=coordinates)
+
+
+def fake_polygon(
+    dimension: Dimension | None = None,
+    max_coordinates: int = 100,
+    max_linear_ring_coordinates: int = 100,
+) -> Polygon:
+    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):
+        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)
+        coordinates.append(linear_ring)
+    return Polygon(type="Polygon", coordinates=coordinates)

readme.md

@@ -13,7 +13,7 @@
 |     MultiPoint     |     done    |
 |     LineString     |     done    |
 |  MultiLineString   |     done    |
-|      Polygon       | in progress |
+|      Polygon       |     done    |
 |    MultiPolygon    | in progress |
 | GeometryCollection | in progress |
 |      Feature       | in progress |

tests/faker_test.py

@@ -1,4 +1,4 @@
-from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point
+from geojson_pydantic.geometries import LineString, MultiLineString, MultiPoint, Point, Polygon
 from geojson_pydantic.types import Position, Position2D, Position3D
 
 from geojson_faker import GeoJsonFaker
@@ -101,7 +101,7 @@ def test_multi_point():
 
     assert isinstance(multi_point, MultiPoint)
     assert multi_point.type == "MultiPoint"
-    assert 0 < len(multi_point.coordinates) < 1000
+    assert 0 < len(multi_point.coordinates) <= 100
 
     for coordinates in multi_point.coordinates:
         assert isinstance(coordinates, Position2D) or isinstance(coordinates, Position3D)
@@ -117,7 +117,7 @@ def test_multi_point2d():
 
     assert isinstance(multi_point, MultiPoint)
     assert multi_point.type == "MultiPoint"
-    assert 0 < len(multi_point.coordinates) < 1000
+    assert 0 < len(multi_point.coordinates) <= 100
 
     for coordinates in multi_point.coordinates:
         assert isinstance(coordinates, Position2D) and not isinstance(coordinates, Position3D)
@@ -131,7 +131,7 @@ def test_multi_point3d():
 
     assert isinstance(multi_point, MultiPoint)
     assert multi_point.type == "MultiPoint"
-    assert 0 < len(multi_point.coordinates) < 1000
+    assert 0 < len(multi_point.coordinates) <= 100
 
     for coordinates in multi_point.coordinates:
         assert isinstance(coordinates, Position3D) and not isinstance(coordinates, Position2D)
@@ -146,7 +146,7 @@ def test_line_string():
 
     assert isinstance(line_string, LineString)
     assert line_string.type == "LineString"
-    assert 2 < len(line_string.coordinates) < 1000
+    assert 2 <= len(line_string.coordinates) <= 100
 
     for coordinates in line_string.coordinates:
         assert isinstance(coordinates, Position2D) or isinstance(coordinates, Position3D)
@@ -162,7 +162,7 @@ def test_line_string2d():
 
     assert isinstance(line_string, LineString)
     assert line_string.type == "LineString"
-    assert 2 < len(line_string.coordinates) < 1000
+    assert 2 <= len(line_string.coordinates) <= 100
 
     for coordinates in line_string.coordinates:
         assert isinstance(coordinates, Position2D) and not isinstance(coordinates, Position3D)
@@ -176,7 +176,7 @@ def test_line_string3d():
 
     assert isinstance(line_string, LineString)
     assert line_string.type == "LineString"
-    assert 2 < len(line_string.coordinates) < 1000
+    assert 2 <= len(line_string.coordinates) <= 100
 
     for coordinates in line_string.coordinates:
         assert isinstance(coordinates, Position3D) and not isinstance(coordinates, Position2D)
@@ -191,11 +191,11 @@ def test_multi_line_string():
 
     assert isinstance(multi_line_string, MultiLineString)
     assert multi_line_string.type == "MultiLineString"
-    assert 0 < len(multi_line_string.coordinates) < 1000
+    assert 0 < len(multi_line_string.coordinates) <= 100
 
     for line_string in multi_line_string.coordinates:
         assert isinstance(line_string, list)
-        assert 2 < len(multi_line_string.coordinates) < 1000
+        assert 2 <= len(line_string) <= 100
         for coordinates in line_string:
             assert isinstance(coordinates, Position2D) or isinstance(coordinates, Position3D)
             assert isinstance(coordinates.longitude, float)
@@ -210,11 +210,11 @@ def test_multi_line_string2d():
 
     assert isinstance(multi_line_string, MultiLineString)
     assert multi_line_string.type == "MultiLineString"
-    assert 0 < len(multi_line_string.coordinates) < 1000
+    assert 0 < len(multi_line_string.coordinates) <= 100
 
     for line_string in multi_line_string.coordinates:
         assert isinstance(line_string, list)
-        assert 2 < len(multi_line_string.coordinates) < 1000
+        assert 2 <= len(line_string) <= 100
         for coordinates in line_string:
             assert isinstance(coordinates, Position2D) and not isinstance(coordinates, Position3D)
             assert isinstance(coordinates.longitude, float)
@@ -227,13 +227,67 @@ def test_multi_line_string3d():
 
     assert isinstance(multi_line_string, MultiLineString)
     assert multi_line_string.type == "MultiLineString"
-    assert 0 < len(multi_line_string.coordinates) < 1000
+    assert 0 < len(multi_line_string.coordinates) <= 100
 
     for line_string in multi_line_string.coordinates:
         assert isinstance(line_string, list)
-        assert 2 < len(multi_line_string.coordinates) < 1000
+        assert 2 <= len(line_string) <= 100
         for coordinates in line_string:
             assert isinstance(coordinates, Position3D) and not isinstance(coordinates, Position2D)
             assert isinstance(coordinates.longitude, float)
             assert isinstance(coordinates.latitude, float)
             assert isinstance(coordinates.altitude, float)
+
+
+def test_polygon():
+    geojson_faker = GeoJsonFaker()
+    polygon = geojson_faker.polygon
+
+    assert isinstance(polygon, Polygon)
+    assert polygon.type == "Polygon"
+    assert 0 < len(polygon.coordinates) <= 100
+
+    for linear_ring in polygon.coordinates:
+        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_polygon2d():
+    geojson_faker = GeoJsonFaker()
+    polygon = geojson_faker.polygon2d
+
+    assert isinstance(polygon, Polygon)
+    assert polygon.type == "Polygon"
+    assert 0 < len(polygon.coordinates) <= 100
+
+    for linear_ring in polygon.coordinates:
+        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_polygon3d():
+    geojson_faker = GeoJsonFaker()
+    polygon = geojson_faker.polygon3d
+
+    assert isinstance(polygon, Polygon)
+    assert polygon.type == "Polygon"
+    assert 0 < len(polygon.coordinates) <= 100
+
+    for linear_ring in polygon.coordinates:
+        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)