Adding render_mode and description of polygons_filter

traveltime-dev · Oct 24, 2024 · 8d65efd · 8d65efd
1 parent a84cbb6
commit 8d65efd
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -73,6 +73,8 @@ Given origin coordinates, find shapes of zones reachable within corresponding tr
 * remove_water_bodies: bool - if set to true (default) - returned shape will not cover large nearby water bodies.
 False - returned shape may cover nearby water bodies like large lakes, wide rivers and seas.
 * [snapping](#snapping): Snapping - Adjusts the process of looking up the nearest roads from the departure / arrival points.
+* [polygons_filter](#polygons-filter): PolygonsFilter - Specifies polygon filter of a single shape.
+* [render_mode](#render-mode): RenderMode - Specifies which render mode should be used.
 
 ### JSON response
 
@@ -295,6 +297,8 @@ A very fast version of `time_map()`. However, the request parameters are much mo
 returns the reachable area for journeys departing from the chosen departure location if true.
 * [level_of_detail](#level-of-detail): LevelOfDetail - When enabled, allows the user to specify how detailed the isochrones should be.
 * [snapping](#snapping): Snapping - Adjusts the process of looking up the nearest roads from the departure / arrival points.
+* [polygons_filter](#polygons-filter): PolygonsFilter - Specifies polygon filter of a single shape.
+* [render_mode](#render-mode): RenderMode - Specifies which render mode should be used.
 
 ### JSON response
 
@@ -1069,3 +1073,33 @@ snapping=Snapping(
     accept_roads=SnappingAcceptRoads.ANY_DRIVABLE
 )
 ```
+
+### Polygons Filter
+
+`polygons_filter` specifies polygon filter of a single shape.
+
+For a more detailed description of how to use this parameter, you can refer to our [API Docs](https://docs.traveltime.com/api/reference/isochrones#departure_searches-polygons_filter)
+
+#### Examples
+
+```python
+from traveltimepy.dto.common import PolygonsFilter
+
+polygons_filter = PolygonsFilter(limit=1)
+polygons_filter = PolygonsFilter(limit=5)
+```
+
+### Render Mode
+
+`render_mode` specifies how the shape should be rendered.
+
+For a more detailed description of how to use this parameter, you can refer to our [API Docs](https://docs.traveltime.com/api/reference/isochrones#departure_searches-render_mode)
+
+#### Examples
+
+```python
+from traveltimepy.dto.common import RenderMode
+
+render_mode = RenderMode.APPROXIMATE_TIME_FILTER  # default
+render_mode = RenderMode.ROAD_BUFFERING
+```
diff --git a/traveltimepy/dto/common.py b/traveltimepy/dto/common.py
@@ -135,9 +135,9 @@ class SnappingAcceptRoads(str, Enum):
 
 class Snapping(BaseModel):
     penalty: Optional[SnappingPenalty] = SnappingPenalty.ENABLED
-    accept_roads: Optional[SnappingAcceptRoads] = (
-        SnappingAcceptRoads.BOTH_DRIVABLE_AND_WALKABLE
-    )
+    accept_roads: Optional[
+        SnappingAcceptRoads
+    ] = SnappingAcceptRoads.BOTH_DRIVABLE_AND_WALKABLE
 
 
 class PropertyProto(int, Enum):
@@ -165,6 +165,11 @@ class PolygonsFilter(BaseModel):
     limit: int
 
 
+class RenderMode(str, Enum):
+    APPROXIMATE_TIME_FILTER = "approximate_time_filter"
+    ROAD_BUFFERING = "road_buffering"
+
+
 class TimeInfo:
     def __init__(self, time_value: datetime):
         self.value = time_value

diff --git a/traveltimepy/dto/requests/time_map.py b/traveltimepy/dto/requests/time_map.py
@@ -17,7 +17,7 @@
     CyclingPublicTransport,
     LevelOfDetail,
 )
-from traveltimepy.dto.common import PolygonsFilter, Snapping
+from traveltimepy.dto.common import PolygonsFilter, RenderMode, Snapping
 from traveltimepy.dto.requests.request import TravelTimeRequest
 from traveltimepy.dto.responses.time_map import TimeMapResponse
 from traveltimepy.itertools import split, flatten
@@ -42,6 +42,7 @@ class DepartureSearch(BaseModel):
     snapping: Optional[Snapping]
     polygons_filter: Optional[PolygonsFilter]
     remove_water_bodies: Optional[bool]
+    render_mode: Optional[RenderMode]
 
 
 class ArrivalSearch(BaseModel):
@@ -63,6 +64,7 @@ class ArrivalSearch(BaseModel):
     snapping: Optional[Snapping] = None
     polygons_filter: Optional[PolygonsFilter]
     remove_water_bodies: Optional[bool]
+    render_mode: Optional[RenderMode]
 
 
 class Intersection(BaseModel):

diff --git a/traveltimepy/dto/requests/time_map_fast.py b/traveltimepy/dto/requests/time_map_fast.py
@@ -6,6 +6,7 @@
     Coordinates,
     LevelOfDetail,
     PolygonsFilter,
+    RenderMode,
     Snapping,
 )
 from traveltimepy.dto.requests.request import TravelTimeRequest
@@ -20,9 +21,10 @@ class Search(BaseModel):
     transportation: Transportation
     travel_time: int
     arrival_time_period: str
-    level_of_detail: Optional[LevelOfDetail] = None
+    level_of_detail: Optional[LevelOfDetail]
     snapping: Optional[Snapping] = None
-    polygons_filter: Optional[PolygonsFilter] = None
+    polygons_filter: Optional[PolygonsFilter]
+    render_mode: Optional[RenderMode]
 
 
 class ArrivalSearches(BaseModel):

diff --git a/traveltimepy/http.py b/traveltimepy/http.py
@@ -35,6 +35,7 @@ async def send_post_request_async(
     request: TravelTimeRequest,
     rate_limit: AsyncLimiter,
 ) -> T:
+    print(request.model_dump_json())
     async with rate_limit:
         async with client.post(
             url=url, headers=headers, data=request.model_dump_json()

diff --git a/traveltimepy/mapper.py b/traveltimepy/mapper.py
@@ -17,6 +17,7 @@
     Range,
     LevelOfDetail,
     PropertyProto,
+    RenderMode,
     TimeInfo,
     ArrivalTime,
     DepartureTime,
@@ -130,7 +131,8 @@ def create_time_map_fast(
     level_of_detail: Optional[LevelOfDetail],
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
-    one_to_many: bool = True,
+    render_mode: Optional[RenderMode],
+    one_to_many: bool,
 ) -> TimeMapFastRequest:
     if one_to_many:
         return TimeMapFastRequest(
@@ -145,6 +147,7 @@ def create_time_map_fast(
                         level_of_detail=level_of_detail,
                         snapping=snapping,
                         polygons_filter=polygons_filter,
+                        render_mode=render_mode,
                     )
                     for ind, cur_coordinates in enumerate(coordinates)
                 ],
@@ -164,6 +167,7 @@ def create_time_map_fast(
                         level_of_detail=level_of_detail,
                         snapping=snapping,
                         polygons_filter=polygons_filter,
+                        render_mode=render_mode,
                     )
                     for ind, cur_coordinates in enumerate(coordinates)
                 ],
@@ -179,7 +183,8 @@ def create_time_map_fast_geojson(
     level_of_detail: Optional[LevelOfDetail],
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
-    one_to_many: bool = True,
+    render_mode: Optional[RenderMode],
+    one_to_many: bool,
 ) -> TimeMapFastGeojsonRequest:
     if one_to_many:
         return TimeMapFastGeojsonRequest(
@@ -194,6 +199,7 @@ def create_time_map_fast_geojson(
                         level_of_detail=level_of_detail,
                         snapping=snapping,
                         polygons_filter=polygons_filter,
+                        render_mode=render_mode,
                     )
                     for ind, cur_coordinates in enumerate(coordinates)
                 ],
@@ -213,6 +219,7 @@ def create_time_map_fast_geojson(
                         level_of_detail=level_of_detail,
                         snapping=snapping,
                         polygons_filter=polygons_filter,
+                        render_mode=render_mode,
                     )
                     for ind, cur_coordinates in enumerate(coordinates)
                 ],
@@ -228,7 +235,8 @@ def create_time_map_fast_wkt(
     level_of_detail: Optional[LevelOfDetail],
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
-    one_to_many: bool = True,
+    render_mode: Optional[RenderMode],
+    one_to_many: bool,
 ) -> TimeMapFastWKTRequest:
     if one_to_many:
         return TimeMapFastWKTRequest(
@@ -243,6 +251,7 @@ def create_time_map_fast_wkt(
                         level_of_detail=level_of_detail,
                         snapping=snapping,
                         polygons_filter=polygons_filter,
+                        render_mode=render_mode,
                     )
                     for ind, cur_coordinates in enumerate(coordinates)
                 ],
@@ -262,6 +271,7 @@ def create_time_map_fast_wkt(
                         level_of_detail=level_of_detail,
                         snapping=snapping,
                         polygons_filter=polygons_filter,
+                        render_mode=render_mode,
                     )
                     for ind, cur_coordinates in enumerate(coordinates)
                 ],
@@ -512,6 +522,7 @@ def create_time_map(
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
     remove_water_bodies: Optional[bool],
+    render_mode: Optional[RenderMode],
 ) -> TimeMapRequest:
     if isinstance(time_info, ArrivalTime):
         return TimeMapRequest(
@@ -527,6 +538,7 @@ def create_time_map(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -548,6 +560,7 @@ def create_time_map(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -577,6 +590,7 @@ def create_time_map_geojson(
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
     remove_water_bodies: Optional[bool],
+    render_mode: Optional[RenderMode],
 ) -> TimeMapRequestGeojson:
     if isinstance(time_info, ArrivalTime):
         return TimeMapRequestGeojson(
@@ -592,6 +606,7 @@ def create_time_map_geojson(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -611,6 +626,7 @@ def create_time_map_geojson(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -638,6 +654,7 @@ def create_time_map_wkt(
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
     remove_water_bodies: Optional[bool],
+    render_mode: Optional[RenderMode],
 ) -> TimeMapWKTRequest:
     if isinstance(time_info, ArrivalTime):
         return TimeMapWKTRequest(
@@ -653,6 +670,7 @@ def create_time_map_wkt(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -671,6 +689,7 @@ def create_time_map_wkt(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -757,6 +776,7 @@ def create_intersection(
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
     remove_water_bodies: Optional[bool],
+    render_mode: Optional[RenderMode],
 ) -> TimeMapRequest:
     if isinstance(time_info, ArrivalTime):
         return TimeMapRequest(
@@ -772,6 +792,7 @@ def create_intersection(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -798,6 +819,7 @@ def create_intersection(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -832,6 +854,7 @@ def create_union(
     snapping: Optional[Snapping],
     polygons_filter: Optional[PolygonsFilter],
     remove_water_bodies: Optional[bool],
+    render_mode: Optional[RenderMode],
 ) -> TimeMapRequest:
     if isinstance(time_info, ArrivalTime):
         return TimeMapRequest(
@@ -847,6 +870,7 @@ def create_union(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],
@@ -873,6 +897,7 @@ def create_union(
                     snapping=snapping,
                     polygons_filter=polygons_filter,
                     remove_water_bodies=remove_water_bodies,
+                    render_mode=render_mode,
                 )
                 for ind, cur_coordinates in enumerate(coordinates)
             ],