r5py 0.1.1.dev2__py3-none-any.whl → 1.0.0__py3-none-any.whl

r5py/r5/trip_leg.py

@@ -4,6 +4,11 @@
 """Represent one leg of a trip."""
 
 
+import datetime
+import numpy
+import shapely
+
+
 __all__ = ["TripLeg"]
 
 
@@ -21,39 +26,56 @@ class TripLeg:
         "distance",
         "travel_time",
         "wait_time",
-        "route",
+        "feed",
+        "agency_id",
+        "route_id",
+        "start_stop_id",
+        "end_stop_id",
         "geometry",
     ]
 
     def __init__(
         self,
         transport_mode=None,
-        departure_time=None,
+        departure_time=numpy.datetime64("NaT"),
         distance=None,
-        travel_time=None,
-        wait_time=None,
-        route=None,
-        geometry=None,
+        travel_time=datetime.timedelta(seconds=0),
+        wait_time=datetime.timedelta(seconds=0),
+        feed=None,
+        agency_id=None,
+        route_id=None,
+        start_stop_id=None,
+        end_stop_id=None,
+        geometry=shapely.LineString(),
     ):
         """
         Represent one leg of a trip.
 
-        This is a base class, use one the specific classes,
-        e.g., TransitLeg, or DirectLeg
+        This is a base class, use one of the more specific classes, e.g.,
+        TransitLeg, or DirectLeg
 
         Arguments
         =========
         transport_mode : r5py.TransportMode
             mode of transport this trip leg was travelled
-        departure_time : datetime.datetime,
+        departure_time : datetime.datetime
+            departure time of this trip leg
         distance : float
             distance covered by this trip leg, in metres
         travel_time : datetime.timedelta
             time spent travelling on this trip leg
         wait_time : datetime.timedelta
             time spent waiting for a connection on this trip leg
-        route : str
-            public transport route used for this trip leg
+        feed : str
+            the GTFS feed identifier used for this trip leg
+        agency_id : str
+            the GTFS id the agency used for this trip leg
+        route_id : str
+            the GTFS id of the public transport route used for this trip leg
+        start_stop_id : str
+            the GTFS stop_id of the boarding stop used for this trip leg
+        end_stop_id : str
+            the GTFS stop_id of the aligning stop used for this trip leg
         geometry : shapely.LineString
             spatial representation of this trip leg
         """
@@ -62,10 +84,15 @@ class TripLeg:
         self.distance = distance
         self.travel_time = travel_time
         self.wait_time = wait_time
-        self.route = route
+        self.feed = feed
+        self.agency_id = agency_id
+        self.route_id = route_id
+        self.start_stop_id = start_stop_id
+        self.end_stop_id = end_stop_id
         self.geometry = geometry
 
     def __add__(self, other):
+        """Trip-chain `other` to `self`."""
         from .trip import Trip
 
         if isinstance(other, self.__class__):
@@ -80,6 +107,7 @@ class TripLeg:
             )
 
     def __radd__(self, other):
+        """Trip-chain `self` to `other`."""
         from .trip import Trip
 
         if other == 0:  # first iteration of sum()
@@ -90,31 +118,43 @@ class TripLeg:
         else:
             return self.__add__(other)
 
+    def __eq__(self, other):
+        """Check if `other` is an equal `TripLeg`."""
+        if isinstance(other, self.__class__):
+            return False not in [
+                self._are_columns_equal(other, column) for column in self.COLUMNS
+            ]
+
     def __gt__(self, other):
+        """Check if `other` has a longer travel time."""
         if isinstance(other, TripLeg):
             return (self.travel_time + self.wait_time) > (
                 other.travel_time + other.wait_time
             )
 
     def __ge__(self, other):
+        """Check if `other` has a longer or equal travel time."""
         if isinstance(other, TripLeg):
             return (self.travel_time + self.wait_time) >= (
                 other.travel_time + other.wait_time
             )
 
     def __lt__(self, other):
+        """Check if `other` has a shorter travel time."""
         if isinstance(other, TripLeg):
             return (self.travel_time + self.wait_time) < (
                 other.travel_time + other.wait_time
             )
 
     def __le__(self, other):
+        """Check if `other` has a shorter or equal travel time."""
         if isinstance(other, TripLeg):
             return (self.travel_time + self.wait_time) <= (
                 other.travel_time + other.wait_time
             )
 
     def __repr__(self):
+        """Return a string representation."""
         try:
             first_point = self.geometry.coords[0]
             last_point = self.geometry.coords[-1]
@@ -127,10 +167,30 @@ class TripLeg:
                 f"{first_point} -> {last_point}"
                 ">"
             )
-        except AttributeError:
+        except (AttributeError, IndexError):
             _repr = f"<{self.__class__.__name__}>"
         return _repr
 
+    def _are_columns_equal(self, other, column):
+        """
+        Check if a column equals the same column of a different `Trip`.
+
+        Compare if attribute `column` of self equals attribute `column` of
+        other. Also True if both values are None or NaN or NaT.
+        """
+        self_column = getattr(self, column)
+        other_column = getattr(other, column)
+
+        return (
+            self_column == other_column
+            or (self_column is None and other_column is None)
+            or (self_column == numpy.nan and other_column == numpy.nan)
+            or (
+                self_column == numpy.datetime64("NaT")
+                and other_column == numpy.datetime64("NaT")
+            )
+        )
+
     def as_table_row(self):
         """
         Return a table row (list) of this trip leg’s details.
@@ -138,7 +198,8 @@ class TripLeg:
         Returns
         =======
         list : detailed information about this trip leg: ``transport_mode``,
-        ``departure_time``, ``distance``, ``travel_time``, ``wait_time``,
-        ``route``, ``geometry``
+            ``departure_time``, ``distance``, ``travel_time``, ``wait_time``,
+            ``feed``, ``agency_id`` ``route_id``, ``start_stop_id``,
+            ``end_stop_id``, ``geometry``
         """
         return [getattr(self, column) for column in self.COLUMNS]

r5py/r5/trip_planner.py

@@ -17,6 +17,7 @@ import shapely
 from .access_leg import AccessLeg
 from .direct_leg import DirectLeg
 from .egress_leg import EgressLeg
+from .street_segment import StreetSegment
 from .transfer_leg import TransferLeg
 from .transit_leg import TransitLeg
 from .transport_mode import TransportMode
@@ -43,9 +44,7 @@ ZERO_SECONDS = datetime.timedelta(seconds=0)
 
 
 class TripPlanner:
-    """
-    Find detailed routes between two points.
-    """
+    """Find detailed routes between two points."""
 
     MAX_ACCESS_TIME = datetime.timedelta(hours=1)
     MAX_EGRESS_TIME = MAX_ACCESS_TIME
@@ -66,13 +65,15 @@ class TripPlanner:
 
         EQUIDISTANT_CRS = GoodEnoughEquidistantCrs(self.transport_network.extent)
         self._crs_transformer_function = pyproj.Transformer.from_crs(
-            R5_CRS, EQUIDISTANT_CRS
+            R5_CRS,
+            EQUIDISTANT_CRS,
+            always_xy=True,
         ).transform
 
     @property
     def trips(self):
         """
-        Find detailed routes between two points.
+        Detailed routes between two points.
 
         Returns
         =======
@@ -84,6 +85,15 @@ class TripPlanner:
 
     @property
     def direct_paths(self):
+        """
+        Detailed routes between two points using direct modes.
+
+        Returns
+        =======
+        list[r5py.r5.Trip]
+            Detailed routes that meet the requested parameters, using direct
+            modes (walking, cycling, driving).
+        """
         direct_paths = []
         request = copy.copy(self.request)
 
@@ -143,31 +153,41 @@ class TripPlanner:
                             ]
                         )
                     )
-                except java.lang.NullPointerException:
+                except (
+                    java.lang.NullPointerException,
+                    java.util.NoSuchElementException,
+                ):
                     warnings.warn(
                         f"Could not find route between origin "
-                        f"({self.request.fromLon}, {self.request.fromLat}) "
-                        f"and destination ({self.request.toLon}, {self.request.toLat})",
+                        f"({self.request._regional_task.fromLon}, "
+                        f"{self.request._regional_task.fromLat}) "
+                        f"and destination ({self.request._regional_task.toLon}, "
+                        f"{self.request._regional_task.toLat})",
                         RuntimeWarning,
                     )
         return direct_paths
 
     def _street_segment_from_router_state(self, router_state, transport_mode):
-        """Retrieve a com.conveyal.r5.street.StreetSegment for a route."""
+        """Retrieve a StreetSegment for a route."""
         street_path = com.conveyal.r5.profile.StreetPath(
             router_state,
             self.transport_network,
             False,
         )
-        street_segment = com.conveyal.r5.api.util.StreetSegment(
-            street_path,
-            transport_mode,
-            self.transport_network.street_layer,
-        )
+        street_segment = StreetSegment(street_path)
         return street_segment
 
     @functools.cached_property
     def transit_paths(self):
+        """
+        Detailed routes between two points on public transport.
+
+        Returns
+        =======
+        list[r5py.r5.Trip]
+            Detailed routes that meet the requested parameters, on public
+            transport.
+        """
         transit_paths = []
 
         # if any transit mode requested:
@@ -195,7 +215,6 @@ class TripPlanner:
                                 distance=0.0,
                                 travel_time=ZERO_SECONDS,
                                 wait_time=ZERO_SECONDS,
-                                route=None,
                                 geometry=shapely.LineString(((lon, lat), (lon, lat))),
                             )
                         ]
@@ -214,8 +233,8 @@ class TripPlanner:
                     com.conveyal.r5.profile.McRaptorSuboptimalPathProfileRouter(
                         self.transport_network,
                         request,
-                        self.transit_access_times,
-                        self.transit_egress_times,
+                        self._transit_access_times,
+                        self._transit_egress_times,
                         list_supplier_callback,
                         None,
                         True,
@@ -234,18 +253,26 @@ class TripPlanner:
                     for state in list(states)  # some departure times yield no results
                 }
 
+                # keep another cache layer of shortest access and egress legs
+                access_legs_by_stop = {}
+                egress_legs_by_stop = {}
+
                 for departure_time, state in final_states.items():
                     trip = Trip()
                     while state:
                         if state.stop == -1:  # EgressLeg
-                            leg = min(
-                                [
-                                    self.transit_egress_paths[transport_mode][
-                                        state.back.stop
+                            try:
+                                leg = egress_legs_by_stop[state.back.stop]
+                            except KeyError:
+                                leg = min(
+                                    [
+                                        self._transit_egress_paths[transport_mode][
+                                            state.back.stop
+                                        ]
+                                        for transport_mode in self._transit_egress_paths.keys()
                                     ]
-                                    for transport_mode in self.transit_egress_paths.keys()
-                                ]
-                            )
+                                )
+                                egress_legs_by_stop[state.back.stop] = leg
                             leg.wait_time = ZERO_SECONDS
                             leg.departure_time = (
                                 midnight
@@ -255,14 +282,18 @@ class TripPlanner:
                             leg.arrival_time = leg.departure_time + leg.travel_time
 
                         elif state.back is None:  # AccessLeg
-                            leg = min(
-                                [
-                                    self.transit_access_paths[transport_mode][
-                                        state.stop
+                            try:
+                                leg = access_legs_by_stop[state.stop]
+                            except KeyError:
+                                leg = min(
+                                    [
+                                        self._transit_access_paths[transport_mode][
+                                            state.stop
+                                        ]
+                                        for transport_mode in self._transit_access_paths.keys()
                                     ]
-                                    for transport_mode in self.transit_access_paths.keys()
-                                ]
-                            )
+                                )
+                                access_legs_by_stop[state.stop] = leg
                             leg.wait_time = ZERO_SECONDS
                             leg.arrival_time = midnight + datetime.timedelta(
                                 seconds=state.time
@@ -274,7 +305,7 @@ class TripPlanner:
                                 departure_stop = state.back.stop
                                 arrival_stop = state.stop
 
-                                leg = self.transit_transfer_path(
+                                leg = self._transit_transfer_path(
                                     departure_stop, arrival_stop
                                 )
 
@@ -294,6 +325,17 @@ class TripPlanner:
 
                             else:  # TransitLeg
                                 pattern = transit_layer.trip_patterns[state.pattern]
+
+                                # Use the indices to look up the stop ids, which are scoped by the GTFS feed supplied
+                                start_stop_id = transit_layer.get_stop_id_from_index(
+                                    state.back.stop
+                                ).split(":")[1]
+                                end_stop = transit_layer.get_stop_id_from_index(
+                                    state.stop
+                                )
+                                end_stop_id = end_stop.split(":")[1]
+                                feed = end_stop.split(":")[0]
+
                                 route = transit_layer.routes[pattern.routeIndex]
                                 transport_mode = TransportMode(
                                     com.conveyal.r5.transit.TransitLayer.getTransitModes(
@@ -346,13 +388,17 @@ class TripPlanner:
                                     distance = None
 
                                 leg = TransitLeg(
-                                    transport_mode,
-                                    departure_time,
-                                    distance,
-                                    travel_time,
-                                    wait_time,
-                                    str(route.route_short_name),
-                                    geometry,
+                                    transport_mode=transport_mode,
+                                    departure_time=departure_time,
+                                    distance=distance,
+                                    travel_time=travel_time,
+                                    wait_time=wait_time,
+                                    feed=str(feed),
+                                    agency_id=str(route.agency_id),
+                                    route_id=str(route.route_id),
+                                    start_stop_id=str(start_stop_id),
+                                    end_stop_id=str(end_stop_id),
+                                    geometry=geometry,
                                 )
 
                         # we traverse in reverse order:
@@ -361,12 +407,14 @@ class TripPlanner:
                         trip = leg + trip
                         state = state.back
 
-                    transit_paths.append(trip)
+                    # R5 sometimes reports the same path more than once, skip duplicates
+                    if trip not in transit_paths:
+                        transit_paths.append(trip)
 
         return transit_paths
 
     @functools.cached_property
-    def transit_access_paths(self):
+    def _transit_access_paths(self):
         access_paths = {}
 
         request = copy.copy(self.request)
@@ -406,9 +454,12 @@ class TripPlanner:
         return access_paths
 
     @functools.cached_property
-    def transit_access_times(self):
-        """Times to reached stops in the format required by
-        McRaptorSuboptimalPathProfileRouter."""
+    def _transit_access_times(self):
+        """
+        Times to reached stops.
+
+        In the format required by McRaptorSuboptimalPathProfileRouter.
+        """
         access_times = jpype.JObject(
             {
                 com.conveyal.r5.api.util.LegMode
@@ -419,14 +470,14 @@ class TripPlanner:
                         for transfer_leg in reached_stops.values()
                     ],
                 )
-                for mode, reached_stops in self.transit_access_paths.items()
+                for mode, reached_stops in self._transit_access_paths.items()
             },
             "java.util.Map<com.conveyal.r5.LegMode, gnu.trove.map.TIntIntMap>",
         )
         return access_times
 
     @functools.cached_property
-    def transit_egress_paths(self):
+    def _transit_egress_paths(self):
         egress_paths = {}
 
         request = copy.copy(self.request)
@@ -467,9 +518,12 @@ class TripPlanner:
         return egress_paths
 
     @functools.cached_property
-    def transit_egress_times(self):
-        """Times to reached stops in the format required by
-        McRaptorSuboptimalPathProfileRouter."""
+    def _transit_egress_times(self):
+        """
+        Times to reached stops.
+
+        In the format required by McRaptorSuboptimalPathProfileRouter.
+        """
         egress_times = jpype.JObject(
             {
                 com.conveyal.r5.api.util.LegMode
@@ -480,13 +534,14 @@ class TripPlanner:
                         for transfer_leg in reached_stops.values()
                     ],
                 )
-                for mode, reached_stops in self.transit_egress_paths.items()
+                for mode, reached_stops in self._transit_egress_paths.items()
             },
             "java.util.Map<com.conveyal.r5.LegMode, gnu.trove.map.TIntIntMap>",
         )
         return egress_times
 
-    def transit_transfer_path(self, from_stop, to_stop):
+    def _transit_transfer_path(self, from_stop, to_stop):
+        """Find a transfer path between two transit stops."""
         self._transfer_paths = {}
         while True:
             try:
@@ -524,8 +579,8 @@ class TripPlanner:
                     TransportMode.WALK,
                 )
 
-                transfer_path = self._transfer_paths[
-                    (from_stop, to_stop)
-                ] = TransferLeg(TransportMode.WALK, street_segment)
+                transfer_path = self._transfer_paths[(from_stop, to_stop)] = (
+                    TransferLeg(TransportMode.WALK, street_segment)
+                )
 
                 return transfer_path

r5py/util/__init__.py

@@ -2,22 +2,30 @@
 
 """Utility functions, e.g., starting a JVM, and accessing configuration."""
 
+from . import environment  # noqa: F401
+
 from .camel_to_snake_case import camel_to_snake_case
 from .config import Config
 from .contains_gtfs_data import contains_gtfs_data
 from .data_validation import check_od_data_set
+from .file_digest import FileDigest
 from .good_enough_equidistant_crs import GoodEnoughEquidistantCrs
 from .jvm import start_jvm
 from .parse_int_date import parse_int_date
 from .snake_to_camel_case import snake_to_camel_case
+from .spatially_clustered_geodataframe import SpatiallyClusteredGeoDataFrame
+from .working_copy import WorkingCopy
 
 __all__ = [
     "camel_to_snake_case",
     "check_od_data_set",
     "Config",
     "contains_gtfs_data",
+    "FileDigest",
     "GoodEnoughEquidistantCrs",
     "parse_int_date",
     "snake_to_camel_case",
+    "SpatiallyClusteredGeoDataFrame",
     "start_jvm",
+    "WorkingCopy",
 ]

r5py/util/classpath.py

@@ -17,8 +17,10 @@ from .warnings import R5pyWarning
 
 
 # update these to use a newer R5 version if no R5 available locally
-R5_JAR_URL = "https://github.com/conveyal/r5/releases/download/v6.9/r5-v6.9-all.jar"
-R5_JAR_SHA256 = "a7e1c5ff8786a9fb9191073b8f31a6933b862f44b9ff85b2c00a68c85491274d"
+R5_JAR_URL = (
+    "https://github.com/r5py/r5/releases/download/v7.3-r5py/r5-v7.3-r5py-all.jar"
+)
+R5_JAR_SHA256 = "cb1ccad370757ba229cf17f1bedc9549ff5d77fdbb44b7a3058104fe1f243f53"
 # ---
 
 
@@ -73,9 +75,11 @@ def find_r5_classpath(arguments):
                     "Could not find R5 jar, trying to download it from upstream",
                     R5pyWarning,
                 )
-            with ValidatingRequestsSession() as session, session.get(
-                R5_JAR_URL, R5_JAR_SHA256
-            ) as response, open(r5_classpath, "wb") as jar:
+            with (
+                ValidatingRequestsSession() as session,
+                session.get(R5_JAR_URL, R5_JAR_SHA256) as response,
+                open(r5_classpath, "wb") as jar,
+            ):
                 jar.write(response.content)
             if arguments.verbose:
                 warnings.warn(