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

r5py/__init__.py

@@ -2,7 +2,8 @@
 
 """Python wrapper for the R5 routing analysis engine."""
 
-__version__ = "0.1.1.dev2"
+__version__ = "0.1.2"
+
 
 from .r5 import (
     DetailedItinerariesComputer,

r5py/__main__.py

@@ -1,16 +1,3 @@
 #!/usr/bin/env python3
 
-
-"""A Python wrapper for the R5 routing analysis engine."""
-
-
-from .util import Config
-
-
-def main():
-    config = Config()
-    arguments = config.get_arguments()  # noqa F401
-
-
-if __name__ == "__main__":
-    main()
+"""Python wrapper for the R5 routing analysis engine."""

r5py/r5/__init__.py

@@ -2,23 +2,37 @@
 
 """R5 classes."""
 
+from .access_leg import AccessLeg
 from .breakdown_stat import BreakdownStat
 from .detailed_itineraries_computer import DetailedItinerariesComputer
+from .direct_leg import DirectLeg
+from .egress_leg import EgressLeg
 from .regional_task import RegionalTask
 from .scenario import Scenario
 from .street_layer import StreetLayer
+from .transfer_leg import TransferLeg
+from .transit_leg import TransitLeg
 from .transport_mode import TransportMode
 from .transport_network import TransportNetwork
 from .travel_time_matrix_computer import TravelTimeMatrixComputer
+from .trip import Trip
+from .trip_planner import TripPlanner
 
 __all__ = [
+    "AccessLeg",
     "BreakdownStat",
     "DetailedItinerariesComputer",
+    "DirectLeg",
+    "EgressLeg",
     "RegionalTask",
     "Scenario",
     "SpeedConfig",
     "StreetLayer",
+    "TransferLeg",
+    "TransitLeg",
     "TransportMode",
     "TransportNetwork",
     "TravelTimeMatrixComputer",
+    "Trip",
+    "TripPlanner",
 ]

r5py/r5/base_travel_time_matrix_computer.py

@@ -91,6 +91,7 @@ class BaseTravelTimeMatrixComputer:
 
     @property
     def destinations(self):
+        """The destinations of this travel time matrix (`geopandas.GeoDataFrame`)."""
         return self._destinations
 
     @destinations.setter
@@ -120,10 +121,7 @@ class BaseTravelTimeMatrixComputer:
         return data_set.map(lambda x: numpy.nan if x == MAX_INT32 else x)
 
     def _prepare_origins_destinations(self):
-        """
-        Make sure we received enough information to route from origins to
-        destinations.
-        """
+        """Make sure we received enough information to route from origins to destinations."""
         try:
             self.origins
         except AttributeError as exception:
@@ -165,6 +163,7 @@ class BaseTravelTimeMatrixComputer:
 
     @property
     def origins(self):
+        """The origins of this travel time matrix (`geopandas.GeoDataFrame`)."""
         return self._origins
 
     @origins.setter

r5py/r5/detailed_itineraries_computer.py

@@ -124,7 +124,6 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
             route number or name), `geometry` (`shapely.LineString`)
             TODO: Add description of output data frame columns and format
         """
-
         self._prepare_origins_destinations()
 
         # warn if public transport routes are requested, but R5 has been
@@ -150,11 +149,12 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
             verbose=(10 * self.verbose),  # joblib has a funny verbosity scale
             n_jobs=self.NUM_THREADS,
         ) as parallel:
+            matrices = parallel(
+                joblib.delayed(self._travel_details_per_od_pair)(from_id, to_id)
+                for _, (from_id, to_id) in self.od_pairs.iterrows()
+            )
             od_matrix = pandas.concat(
-                parallel(
-                    joblib.delayed(self._travel_details_per_od_pair)(from_id, to_id)
-                    for _, (from_id, to_id) in self.od_pairs.iterrows()
-                ),
+                [matrix.astype(matrices[0].dtypes) for matrix in matrices],
                 ignore_index=True,
             )
 
@@ -162,11 +162,7 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
         return od_matrix
 
     def _prepare_origins_destinations(self):
-        """
-        Make sure we received enough information to route from origins to
-        destinations.
-        """
-
+        """Make sure we received enough information to route from origins to destinations."""
         super()._prepare_origins_destinations()
 
         if self.all_to_all:

r5py/r5/direct_leg.py

@@ -15,9 +15,7 @@ __all__ = ["DirectLeg"]
 
 
 class DirectLeg(TripLeg):
-    """
-    Represent one leg of a public transport trip.
-    """
+    """Represent one leg of a public transport trip."""
 
     def __init__(self, transport_mode, street_segment):
         """

r5py/r5/regional_task.py

@@ -200,12 +200,16 @@ class RegionalTask:
         # The value is a static property of com.conveyal.r5.analyst.cluster.PathResult;
         # static properites of Java classes can be modified in a singleton kind of way
         try:
-            com.conveyal.r5.analyst.cluster.PathResult.maxDestinations = max(
-                com.conveyal.r5.analyst.cluster.PathResult.maxDestinations,
-                len(self.destinations) + 1,
-            )
+            num_destinations = len(self.destinations)
         except AttributeError:
-            pass
+            num_destinations = 0
+        if (
+            num_destinations
+            > com.conveyal.r5.analyst.cluster.PathResult.MAX_PATH_DESTINATIONS
+        ):
+            com.conveyal.r5.analyst.cluster.PathResult.MAX_PATH_DESTINATIONS = (
+                num_destinations + 1
+            )
 
     @property
     def departure(self):
@@ -246,8 +250,7 @@ class RegionalTask:
 
     @property
     def departure_time_window(self):
-        """Find public transport connections leaving within
-        ``departure_time_window`` after ``departure`` (datetime.timedelta).
+        """Find public transport connections leaving within ``departure_time_window`` after ``departure`` (datetime.timedelta).
 
         **Note:** The value of ``departure_time_window`` should be set with some
         caution. Specifically, setting values near or below the typical headways

r5py/r5/street_layer.py

@@ -40,6 +40,7 @@ class StreetLayer:
 
     @functools.cached_property
     def extent(self):
+        """The geographic area covered, as a `shapely.box`."""
         envelope = self._street_layer.envelope
         return shapely.box(
             envelope.getMinX(),

r5py/r5/transfer_leg.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python3
 
 
-"""Represent one leg of a trip, specifically transfers between public transport
-vehicles."""
+"""Represent one leg of a trip, specifically transfers between public transport vehicles."""
 
 
 from .direct_leg import DirectLeg
@@ -12,7 +11,4 @@ __all__ = ["TransferLeg"]
 
 
 class TransferLeg(DirectLeg):
-    """
-    Represent one leg of a trip, specifically transfers between public transport
-    vehicles.
-    """
+    """Represent one leg of a trip, specifically transfers between public transport vehicles."""

r5py/r5/transit_layer.py

@@ -90,10 +90,12 @@ class TransitLayer:
 
     @functools.cached_property
     def routes(self):
+        """Return a list of GTFS routes."""
         return list(self._transit_layer.routes)
 
     @functools.cached_property
     def trip_patterns(self):
+        """Return a list of GTFS trip patterns."""
         return list(self._transit_layer.tripPatterns)
 
 

r5py/r5/transit_leg.py

@@ -11,8 +11,4 @@ __all__ = ["TransitLeg"]
 
 
 class TransitLeg(TripLeg):
-    """
-    Represent one leg of a public transport trip.
-    """
-
-    pass
+    """Represent one leg of a public transport trip."""

r5py/r5/transport_mode.py

@@ -68,6 +68,7 @@ class TransportMode(enum.Enum):
         return None
 
     def __add__(self, other):
+        """Combine two transport modes."""
         if isinstance(other, self.__class__):
             return [self, other]
         elif isinstance(other, list):
@@ -78,6 +79,7 @@ class TransportMode(enum.Enum):
             )
 
     def __radd__(self, other):
+        """Combine two transport modes."""
         if other == 0:  # first iteration of sum()
             return self
         elif isinstance(other, list):
@@ -87,17 +89,17 @@ class TransportMode(enum.Enum):
 
     @property
     def is_leg_mode(self):
-        """Can this TransportMode function as a LegMode?"""
+        """Can this TransportMode function as a LegMode?."""
         return self.name in LEG_MODES
 
     @property
     def is_street_mode(self):
-        """Can this TransportMode function as a StreetMode?"""
+        """Can this TransportMode function as a StreetMode?."""
         return self.name in STREET_MODES
 
     @property
     def is_transit_mode(self):
-        """Can this TransportMode function as a TransitMode?"""
+        """Can this TransportMode function as a TransitMode?."""
         return self.name in TRANSIT_MODES
 
     AIR = "AIR"

r5py/r5/transport_network.py

@@ -89,9 +89,7 @@ class TransportNetwork:
         self._transport_network = transport_network
 
     def __del__(self):
-        """
-        Delete all temporary files upon destruction.
-        """
+        """Delete all temporary files upon destruction."""
         MAX_TRIES = 10
 
         # first, close the open osm_file,
@@ -110,13 +108,23 @@ class TransportNetwork:
             del self.transit_layer
         except AttributeError:
             pass
-        del self._transport_network
+        try:
+            del self._transport_network
+        except AttributeError:
+            pass
 
-        time.sleep(0.5)
-        jpype.java.lang.System.gc()
+        time.sleep(1.0)
+        try:
+            jpype.java.lang.System.gc()
+        except jpype.JVMNotRunning:
+            pass
 
         # then, try to delete all files in cache directory
-        temporary_files = [child for child in self._cache_directory.iterdir()]
+        try:
+            temporary_files = [child for child in self._cache_directory.iterdir()]
+        except FileNotFoundError:  # deleted in the meantime/race condition
+            temporary_files = []
+
         for _ in range(MAX_TRIES):
             for temporary_file in temporary_files:
                 try:
@@ -206,6 +214,7 @@ class TransportNetwork:
 
     @property
     def extent(self):
+        """The geographic area covered, as a `shapely.box`."""
         # TODO: figure out how to get the extent of the GTFS schedule,
         # then find the smaller extent of the two (or the larger one?)
         return self.street_layer.extent

r5py/r5/travel_time_matrix_computer.py

@@ -4,7 +4,6 @@
 
 import copy
 
-import joblib
 import pandas
 
 from .base_travel_time_matrix_computer import BaseTravelTimeMatrixComputer
@@ -40,20 +39,10 @@ class TravelTimeMatrixComputer(BaseTravelTimeMatrixComputer):
         self._prepare_origins_destinations()
         self.request.destinations = self.destinations
 
-        # loop over all origins, modify the request, and compute the times
-        # to all destinations.
-        with joblib.Parallel(
-            prefer="threads",
-            verbose=(10 * self.verbose),  # joblib has a funny verbosity scale
-            n_jobs=self.NUM_THREADS,
-        ) as parallel:
-            od_matrix = pandas.concat(
-                parallel(
-                    joblib.delayed(self._travel_times_per_origin)(from_id)
-                    for from_id in self.origins.id
-                ),
-                ignore_index=True,
-            )
+        od_matrix = pandas.concat(
+            [self._travel_times_per_origin(from_id) for from_id in self.origins.id],
+            ignore_index=True,
+        )
 
         try:
             od_matrix = od_matrix.to_crs(self._origins_crs)

r5py/r5/trip.py

@@ -15,9 +15,7 @@ __all__ = ["Trip"]
 
 
 class Trip:
-    """
-    Represent one trip, consisting of one or more `TripLeg`s.
-    """
+    """Represent one trip, consisting of one or more `r5py.r5.TripLeg`."""
 
     COLUMNS = [
         "segment",
@@ -25,7 +23,7 @@ class Trip:
 
     def __init__(self, legs=[]):
         """
-        Represent one trip, consisting of one of more `TripLeg`s.
+        Represent one trip, consisting of one of more `r5py.r5.TripLeg`.
 
         Arguments
         =========
@@ -34,7 +32,13 @@ class Trip:
         """
         self.legs = legs
 
+    def __eq__(self, other):
+        """Check whether `self` and `other` are equal."""
+        if isinstance(other, self.__class__):
+            return self.legs == other.legs
+
     def __repr__(self):
+        """Return a string representation of `self`."""
         legs = ", ".join([str(leg) for leg in self.legs])
         return (
             f"<{self.__class__.__name__}: "

r5py/r5/trip_leg.py

@@ -4,6 +4,11 @@
 """Represent one leg of a trip."""
 
 
+import datetime
+import numpy
+import shapely
+
+
 __all__ = ["TripLeg"]
 
 
@@ -28,12 +33,12 @@ class TripLeg:
     def __init__(
         self,
         transport_mode=None,
-        departure_time=None,
+        departure_time=numpy.datetime64("NaT"),
         distance=None,
-        travel_time=None,
-        wait_time=None,
+        travel_time=datetime.timedelta(seconds=0),
+        wait_time=datetime.timedelta(seconds=0),
         route=None,
-        geometry=None,
+        geometry=shapely.LineString(),
     ):
         """
         Represent one leg of a trip.
@@ -66,6 +71,7 @@ class TripLeg:
         self.geometry = geometry
 
     def __add__(self, other):
+        """Trip-chain `other` to `self`."""
         from .trip import Trip
 
         if isinstance(other, self.__class__):
@@ -80,6 +86,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 +97,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 +146,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.

r5py/r5/trip_planner.py

@@ -43,9 +43,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
@@ -72,7 +70,7 @@ class TripPlanner:
     @property
     def trips(self):
         """
-        Find detailed routes between two points.
+        Detailed routes between two points.
 
         Returns
         =======
@@ -84,6 +82,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,11 +150,16 @@ 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
@@ -168,6 +180,15 @@ class TripPlanner:
 
     @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:
@@ -214,8 +235,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 +255,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 +284,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 +307,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
                                 )
 
@@ -361,12 +394,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 +441,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 +457,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 +505,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 +521,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 +566,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,6 +2,8 @@
 
 """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

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.1-r5py/r5-v7.1-r5py-all.jar"
+)
+R5_JAR_SHA256 = "cd697b50323fd99977c98039ea317698bcf5fbbdb12b59e3e094ae9443648db2"
 # ---
 
 
@@ -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(

r5py/util/config.py

@@ -31,7 +31,6 @@ class Config:
 
     def __init__(self):
         """Load configuration from config files or command line arguments."""
-
         self.argparser.add(
             "-v",
             "--verbose",
@@ -40,6 +39,7 @@ class Config:
         )
 
     def __new__(cls):
+        """Load configuration from config files or command line arguments."""
         if cls._instance is None:
             cls._instance = super(Config, cls).__new__(cls)
         return cls._instance
@@ -55,6 +55,7 @@ class Config:
 
     @property
     def argparser(self):
+        """Return a singleton instance of a `configargparse.ArgumentParser`."""
         try:
             argparser = configargparse.get_argument_parser(
                 prog=PACKAGE,
@@ -67,6 +68,7 @@ class Config:
 
     @functools.cached_property
     def CACHE_DIR(self):
+        """Save persistent cache files into this directory."""
         cache_dir = (
             pathlib.Path(
                 os.environ.get("LOCALAPPDATA")
@@ -80,6 +82,7 @@ class Config:
 
     @functools.cached_property
     def CONFIG_FILES(self):
+        """List locations of potential configuration files."""
         config_files = [
             pathlib.Path(f"/etc/{PACKAGE}.yml"),
             pathlib.Path(
@@ -130,8 +133,14 @@ class Config:
 
     @functools.cached_property
     def TEMP_DIR(self):
+        """
+        Save temporary files to this directory.
+
+        read-only property,
+        use command-line option `--temporary-directory` to change.
+        """
         parent_dir = self.arguments.temporary_directory
-        temp_dir = pathlib.Path(tempfile.mkdtemp(prefix=self.PACKAGE), dir=parent_dir)
+        temp_dir = pathlib.Path(tempfile.mkdtemp(prefix=self.PACKAGE, dir=parent_dir))
         return temp_dir
 
     PACKAGE = PACKAGE

r5py/util/environment.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+
+
+"""Normalise some environment variables that might not always get set."""
+
+
+import os
+import pathlib
+
+
+# if a readthedocs runner uses a conda environment, it fails to
+# properly initialise the JAVA_HOME and PROJ_LIB environment variables
+#
+# this might happen on other installation, so let’s keep this as general
+# as possible.
+#
+# As readthedocs also does not export CONDA_PREFIX, we first reconstruct
+# it from CONDA_ENVS_PATH and CONDA_DEFAULT_ENV
+if (
+    "CONDA_PREFIX" not in os.environ
+    and "CONDA_DEFAULT_ENV" in os.environ
+    and "CONDA_ENVS_PATH" in os.environ
+):
+    os.environ["CONDA_PREFIX"] = str(
+        pathlib.Path(os.environ["CONDA_ENVS_PATH"]) / os.environ["CONDA_DEFAULT_ENV"]
+    )
+if "JAVA_HOME" not in os.environ and "CONDA_PREFIX" in os.environ:
+    os.environ["JAVA_HOME"] = str(
+        pathlib.Path(os.environ["CONDA_PREFIX"]) / "lib" / "jvm"
+    )
+if "PROJ_LIB" not in os.environ and "CONDA_PREFIX" in os.environ:
+    os.environ["PROJ_LIB"] = str(
+        pathlib.Path(os.environ["CONDA_PREFIX"]) / "share" / "proj"
+    )

r5py/util/good_enough_equidistant_crs.py

@@ -31,7 +31,6 @@ class GoodEnoughEquidistantCrs(pyproj.CRS):
             The geographical extent for which to find an equidistant reference
             system, in `EPSG:4326`
         """
-
         if GoodEnoughEquidistantCrs._is_plausible_in_epsg4326(extent):
             # default CRS in case we do not find any better match
             crs = pyproj.CRS.from_epsg(3857)

r5py/util/memory_footprint.py

@@ -62,9 +62,9 @@ def _share_of_ram(share=0.8, leave_at_least=(2 * 1024**3)):
 
 def _parse_value_and_unit(value_and_unit, max_unit_length=1):
     """
-    Extract value and unit from a string containing a possible
-    (non-numeric) unit suffix.
+    Extract value and unit from a string.
 
+    The string is allowed to contain a (non-numeric) unit suffix.
     For instance, input values of `'1M'` or `3.732G` would yield return
     values `(1, 'M')` or `(3.732, 'G')`, respectively.
 
@@ -112,11 +112,10 @@ def _interpret_power_of_two_units(value, unit):
     int:
         interpreted value in bytes
     """
-
-    SUFFIXES = " KMGTPEZY"
     # the position of each suffix in this string is the unit’s exponent
     # over 1024.
     # Compare https://en.wikipedia.org/wiki/ISO%2FIEC_80000#Part_13:_Information_science_and_technology
+    SUFFIXES = " KMGTPEZY"
 
     if unit is None:
         unit = " "
@@ -152,7 +151,6 @@ def _get_max_memory(max_memory):
     int
         Maximum amount of memory allocated for R5 in bytes.
     """
-
     try:
         value, unit = _parse_value_and_unit(max_memory)
     except TypeError:

r5py/util/sample_data_set.py

@@ -25,6 +25,7 @@ class SampleDataSet(pathlib.Path):
     _CACHE_DIR = pathlib.Path(config.CACHE_DIR) / "sampledata"
 
     def __new__(cls, remote_url, sha256_checksum):
+        """Define a data set that is downloaded and cached on demand."""
         # pathlib.Path does everything in __new__, rather than __init__
         cached_path = cls._CACHE_DIR / pathlib.Path(remote_url).name
         return super().__new__(cls, cached_path)
@@ -40,10 +41,16 @@ class SampleDataSet(pathlib.Path):
         sha256_checksum : str
             checksum for this data set, using an SHA256 algorithm
         """
-        super().__init__()
+        cached_path = self._CACHE_DIR / pathlib.Path(remote_url).name
+
+        try:  # Python>=3.12
+            super().__init__(cached_path)
+        except TypeError:
+            super().__init__()
+
         self.remote_url = remote_url
         self.checksum = sha256_checksum
-        self.cached_path = self._CACHE_DIR / pathlib.Path(remote_url).name
+        self.cached_path = cached_path
         self._download_remote_file()
 
     def _download_remote_file(self):
@@ -60,7 +67,8 @@ class SampleDataSet(pathlib.Path):
                     RuntimeWarning,
                 )
             self.cached_path.parent.mkdir(exist_ok=True)
-            with ValidatingRequestsSession() as session, session.get(
-                self.remote_url, self.checksum
-            ) as response:
+            with (
+                ValidatingRequestsSession() as session,
+                session.get(self.remote_url, self.checksum) as response,
+            ):
                 self.cached_path.write_bytes(response.content)

r5py/util/validating_requests_session.py

@@ -30,12 +30,12 @@ class ValidatingRequestsSession(requests.Session):
         self._algorithm = checksum_algorithm
 
     def get(self, url, checksum, **kwargs):
-        """Sends a GET request, tests checksum."""
+        """Send a GET request, tests checksum."""
         kwargs.setdefault("allow_redirects", True)
         return self.request("GET", url, checksum, **kwargs)
 
     def post(self, url, checksum, **kwargs):
-        """Sends a POST request, tests checksum."""
+        """Send a POST request, tests checksum."""
         return self.request("POST", url, checksum, **kwargs)
 
     # delete, put, head don’t return data,

{r5py-0.1.1.dev2.dist-info → r5py-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: r5py
-Version: 0.1.1.dev2
+Version: 0.1.2
 Summary: Python wrapper for the R5 routing analysis engine
 Author: Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
 Author-email: Christoph Fink <christoph.fink@helsinki.fi>
@@ -41,8 +41,8 @@ Requires-Dist: matplotlib ; extra == 'docs'
 Requires-Dist: myst-nb ; extra == 'docs'
 Requires-Dist: nbsphinx ; extra == 'docs'
 Requires-Dist: pybtex-apa7-style ; extra == 'docs'
-Requires-Dist: r5py.sampledata.helsinki >=0.1.1.dev2 ; extra == 'docs'
-Requires-Dist: r5py.sampledata.sao-paulo >=0.1.1.dev2 ; extra == 'docs'
+Requires-Dist: r5py.sampledata.helsinki >=0.1.1 ; extra == 'docs'
+Requires-Dist: r5py.sampledata.sao-paulo >=0.1.1 ; extra == 'docs'
 Requires-Dist: shapely ; extra == 'docs'
 Requires-Dist: sphinx ; extra == 'docs'
 Requires-Dist: sphinx-book-theme ; extra == 'docs'
@@ -50,12 +50,13 @@ Requires-Dist: sphinx-design ; extra == 'docs'
 Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
 Requires-Dist: sphinxcontrib-images ; extra == 'docs'
 Provides-Extra: tests
+Requires-Dist: pyarrow ; extra == 'tests'
 Requires-Dist: pytest ; extra == 'tests'
 Requires-Dist: pytest-asyncio ; extra == 'tests'
 Requires-Dist: pytest-cov ; extra == 'tests'
-Requires-Dist: pytest-lazy-fixture ; extra == 'tests'
-Requires-Dist: r5py.sampledata.helsinki >=0.1.1.dev2 ; extra == 'tests'
-Requires-Dist: r5py.sampledata.sao-paulo >=0.1.1.dev2 ; extra == 'tests'
+Requires-Dist: pytest-lazy-fixtures ; extra == 'tests'
+Requires-Dist: r5py.sampledata.helsinki >=0.1.1 ; extra == 'tests'
+Requires-Dist: r5py.sampledata.sao-paulo >=0.1.1 ; extra == 'tests'
 
 <img class="r5py_logo" align="right" src="https://github.com/r5py/r5py/raw/main/docs/_static/images/r5py_blue.svg" alt="r5py logo" style="width:180px; max-width:30vW;">
 

r5py-0.1.2.dist-info/RECORD

@@ -0,0 +1,43 @@
+r5py/__init__.py,sha256=CvtwufBhIEjDtiNGgSjbvb6mtHtmDAmzOmRYtdOm49M,414
+r5py/__main__.py,sha256=Wvn0ChD7E-dCSZ8b8k_HhHG0KMOk0qMNFkijGuSH3-0,81
+r5py/r5/__init__.py,sha256=xwk-xAck8osVgIW7sSML04c5JuB5y9a23Gym0G6cV4w,999
+r5py/r5/access_leg.py,sha256=W3GfPEpqmWD1c4xipd6UcVIaBC-yb6srGCZV30E2dPY,293
+r5py/r5/base_travel_time_matrix_computer.py,sha256=qxaNyw4AuzLfCi7Yll8M_Y37v6pCoZsQPEZ3WKLhpkc,6454
+r5py/r5/breakdown_stat.py,sha256=ZQkWA0hXlcRH3KVgtxPSNHP0FUDri8MWqdFk8EUdDMU,533
+r5py/r5/detailed_itineraries_computer.py,sha256=6PzypGs5bOJv_NJ2AIm77u7uECzhm6BCF0lUPKlCXrs,8525
+r5py/r5/direct_leg.py,sha256=T7wX8puhOVIssCpflXthYs-G9OA8pasFbdz9p8k8teg,1054
+r5py/r5/egress_leg.py,sha256=9rsCIcwlZUzoZE6q4imNY3VWpjJepO1IJvheVrlPi90,297
+r5py/r5/regional_task.py,sha256=33PptFZziTPuwAlbBsyTqpAtl1K6HT9sjKLc_CxzRzY,23250
+r5py/r5/scenario.py,sha256=nUNAlN3cO7E_b4sMpNqdL0FD7WQaQ49iIvh-k8l4YRM,763
+r5py/r5/street_layer.py,sha256=iGlAWftzmwzaRUpXngis7prVuH3Oq8i-AXS8-pnVXMk,2259
+r5py/r5/transfer_leg.py,sha256=_IpzQJAyW4hDPO5V4k-ZjIPd3uyxhHPa4U6_b8UbKt4,311
+r5py/r5/transit_layer.py,sha256=Z2quvw19IqmB6eeCFbavYp8TFmo3YVWhlk0ifCWbDng,3023
+r5py/r5/transit_leg.py,sha256=R0Qc9YLMEXYu51NIdo7Q0bdmpYIJf5irEDXWrW6pZWE,221
+r5py/r5/transport_mode.py,sha256=zHSqXb0R4oyjTp069CzO69IgoCKt0nmOAwsSy272rGo,3675
+r5py/r5/transport_network.py,sha256=d4PPBEBk3t2QbUI5KMS9zM-a4s4E4zEYOHIV6txCnYg,10777
+r5py/r5/travel_time_matrix_computer.py,sha256=H_zsCfDlBX7LKJcTJZH92TY96P1nTCl9zDdCs78d7Wo,4463
+r5py/r5/trip.py,sha256=ZsEshy4BflMHZQoq-LIFauvYbn4T7gLD-Aa91rV45m8,2854
+r5py/r5/trip_leg.py,sha256=63DVgIYKc_X4nC7oYF6OMRkFeaL5kQy2zRnfkGX3ALc,5642
+r5py/r5/trip_planner.py,sha256=hwarUMO29zw4-nPLbGtA6sxXUovNxVu8KBvo_Bkay54,22937
+r5py/sampledata/_keep/__init__.py,sha256=Dd14TxWipq66sLK3ponMl09SbtzWoqmD-dhbTuS889M,114
+r5py/util/__init__.py,sha256=S-agt-08twU7hFIH1_x_VjuNC-WHfP6844n0xM0E8t8,714
+r5py/util/camel_to_snake_case.py,sha256=zj5F3PNBvsuS6vqN4USeeo8NI-3hnscGhwun0G95AK0,673
+r5py/util/classpath.py,sha256=lqyoJaL2VI3Gu3s9sspKS8BDlmzH2dqA7k4VjJoNwdA,2773
+r5py/util/config.py,sha256=TpT67KZoHj17USjmGgiyH7HKa757CFXVk5nnBEio8E0,4667
+r5py/util/contains_gtfs_data.py,sha256=ooX4hfVDKK0aqX1MI46jSFZ7dZ6riyXaORrgF6PUFrk,1211
+r5py/util/data_validation.py,sha256=H5Mcp2nS4vu5RKym20mPnGpl-8d0SDchzDRJBrrL6WE,1039
+r5py/util/environment.py,sha256=cbSM8TKTuhbXsTIIB06pMtydBOiqLkitF2Lj2asVTho,1082
+r5py/util/exceptions.py,sha256=r65XUg_AJ_bTw8ARNj7A2-GbFZlSTrOAjDynx1pSD2Y,1049
+r5py/util/good_enough_equidistant_crs.py,sha256=1aqJLghNwcd2FbLfODcht_6pyOEqhsrE2KPaC3NLoek,2354
+r5py/util/jvm.py,sha256=NCwoYLDznXydcIRAZl2kzUQA6D6NCvzjVG74pm6ioR0,5027
+r5py/util/memory_footprint.py,sha256=p8efCUs4UXRg6P1GrRxVs71m7SpEw2mASoz6PVTRvgQ,4672
+r5py/util/parse_int_date.py,sha256=JmnV8TwdUdUp3kSp2e73ZSxCbRyqv2FmQzNt0I_MsM0,667
+r5py/util/sample_data_set.py,sha256=SRTFmhnhtwNCYtXRGPNKkh_lh3OEvgcyHS4Fz8N9uM8,2394
+r5py/util/snake_to_camel_case.py,sha256=uJ5hTCVDUEmIxTyy4LGFTbpGC_rtnjDZVQ2vmVRTQ4k,485
+r5py/util/validating_requests_session.py,sha256=sH5FgpS9eGax5DG2qA2GrGuiwgTJgh8tKsZ9OiXKmvk,1807
+r5py/util/warnings.py,sha256=CvxKWKlNO_p3riB4SkNqbU5AGPsaY_3-OzqaBObE3B8,139
+r5py-0.1.2.dist-info/LICENSE,sha256=VAnuGDX1TPylSN9G2xLa-urDpj_SQwn-qqs068dx4tk,51
+r5py-0.1.2.dist-info/METADATA,sha256=8JDgZ6ZNX6a8hvLO7FPahfQxvN59DNz3hoTBHAw9suE,10015
+r5py-0.1.2.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+r5py-0.1.2.dist-info/top_level.txt,sha256=fOH1R85dkNDOI7jkg-lIsl5CQIO4fE5X868K9dTqs9U,5
+r5py-0.1.2.dist-info/RECORD,,

{r5py-0.1.1.dev2.dist-info → r5py-0.1.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: setuptools (71.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

r5py-0.1.1.dev2.dist-info/RECORD

@@ -1,42 +0,0 @@
-r5py/__init__.py,sha256=eWYsVlnfyYPcIveYA3jP_niDewEPlrWau81hem9WybM,418
-r5py/__main__.py,sha256=5p_QWx8hsNbz34OwMKl9mY644bfqwXRFXkFSlTP06AM,239
-r5py/r5/__init__.py,sha256=gq-1XbdrHE4v3XAvyV-Amod-Vcgp_c1Sbs13mgxOD08,643
-r5py/r5/access_leg.py,sha256=W3GfPEpqmWD1c4xipd6UcVIaBC-yb6srGCZV30E2dPY,293
-r5py/r5/base_travel_time_matrix_computer.py,sha256=lnyI70dIGq0e9E1cvLJfF17hIw8eG8Qnt8WfXOwNFBo,6313
-r5py/r5/breakdown_stat.py,sha256=ZQkWA0hXlcRH3KVgtxPSNHP0FUDri8MWqdFk8EUdDMU,533
-r5py/r5/detailed_itineraries_computer.py,sha256=kRV8OBpvdsgYHcNGQzBi6Y3WyAlPCTSQn0HrWoBqvus,8483
-r5py/r5/direct_leg.py,sha256=opX575iuByoy8WORIsSvIgVqAwglBVCl15ZCo1pv_Mk,1064
-r5py/r5/egress_leg.py,sha256=9rsCIcwlZUzoZE6q4imNY3VWpjJepO1IJvheVrlPi90,297
-r5py/r5/regional_task.py,sha256=uzciavh9qWrMPYtixIdSR8hMxg4tyC98FnTYqpN4FME,23136
-r5py/r5/scenario.py,sha256=nUNAlN3cO7E_b4sMpNqdL0FD7WQaQ49iIvh-k8l4YRM,763
-r5py/r5/street_layer.py,sha256=aA8cBXvV60wH7WlEnwqbPXPpPxwQQsPPbW59HDUJrc0,2196
-r5py/r5/transfer_leg.py,sha256=m_9t1Kr8pq5rmtJz4XZSvRpog4_WpMtF2nKeybJ0v8U,325
-r5py/r5/transit_layer.py,sha256=znQcJmtFpqVcsvZziPDHxAcRS0OXvyn3JdWE_lXZv0A,2928
-r5py/r5/transit_leg.py,sha256=zd8QnMiOHCw3hS6WO5uwegxROdwDpqNDqvZwVJ2MlKo,241
-r5py/r5/transport_mode.py,sha256=YJj2CzZ0cz4hAu48udYtX8MnFuSx4he703xcP3BV_7I,3586
-r5py/r5/transport_network.py,sha256=ZWKHEhRkmpy_lQLvMjjjRqp_8ciP5kea7263Y4WwhG0,10470
-r5py/r5/travel_time_matrix_computer.py,sha256=ns4DnWXfyPpslwQlHGM5Vsmpdzvr8NF-hWaRgc8HYGc,4880
-r5py/r5/trip.py,sha256=SvXXQdvkCZzXcAbLyxKjCEwdbft_Jt7SPmPDzdw0K9w,2617
-r5py/r5/trip_leg.py,sha256=gto-VRo_AdUxdRDRlIey6f8jSZ021NI91BODTowp-wQ,4131
-r5py/r5/trip_planner.py,sha256=298IvJioFz4uj1L8qXJE5Ehrqcy51IP_2FoQfo3GEDc,21293
-r5py/sampledata/_keep/__init__.py,sha256=Dd14TxWipq66sLK3ponMl09SbtzWoqmD-dhbTuS889M,114
-r5py/util/__init__.py,sha256=moUcR_oxpITt2vdNQxuej6haFywjA62UcUY4T5TMDns,673
-r5py/util/camel_to_snake_case.py,sha256=zj5F3PNBvsuS6vqN4USeeo8NI-3hnscGhwun0G95AK0,673
-r5py/util/classpath.py,sha256=os4UmHEs2GGk0jnHSD_1wJHEjmpYQU3VAb6T_iUdFEw,2724
-r5py/util/config.py,sha256=M3eT4B2mB0CaFHQYn5DmtFTtSc4_RCK8fS3UuO7X2D8,4216
-r5py/util/contains_gtfs_data.py,sha256=ooX4hfVDKK0aqX1MI46jSFZ7dZ6riyXaORrgF6PUFrk,1211
-r5py/util/data_validation.py,sha256=H5Mcp2nS4vu5RKym20mPnGpl-8d0SDchzDRJBrrL6WE,1039
-r5py/util/exceptions.py,sha256=r65XUg_AJ_bTw8ARNj7A2-GbFZlSTrOAjDynx1pSD2Y,1049
-r5py/util/good_enough_equidistant_crs.py,sha256=VuzPGPTyL7T0Cl3SZba7atBTyyt9uUTLkq7JVMxjGsI,2355
-r5py/util/jvm.py,sha256=NCwoYLDznXydcIRAZl2kzUQA6D6NCvzjVG74pm6ioR0,5027
-r5py/util/memory_footprint.py,sha256=FlOLEAz7yI3YOv3wJe_tejJPh0y640QlDd0Z3Ce5i2s,4660
-r5py/util/parse_int_date.py,sha256=JmnV8TwdUdUp3kSp2e73ZSxCbRyqv2FmQzNt0I_MsM0,667
-r5py/util/sample_data_set.py,sha256=YQcDjcywria2hiR9A3cS8y3LmGsEAraQMDaGXFPg4JU,2165
-r5py/util/snake_to_camel_case.py,sha256=uJ5hTCVDUEmIxTyy4LGFTbpGC_rtnjDZVQ2vmVRTQ4k,485
-r5py/util/validating_requests_session.py,sha256=nkgOsZ_fbaP19R8l0ImZLFo5zUdw9-B289w0DEygtW0,1809
-r5py/util/warnings.py,sha256=CvxKWKlNO_p3riB4SkNqbU5AGPsaY_3-OzqaBObE3B8,139
-r5py-0.1.1.dev2.dist-info/LICENSE,sha256=VAnuGDX1TPylSN9G2xLa-urDpj_SQwn-qqs068dx4tk,51
-r5py-0.1.1.dev2.dist-info/METADATA,sha256=ZFy_vU_mdoQtSMduASSOhF8uIIL0Yq2PG0KxnuBVnCY,9997
-r5py-0.1.1.dev2.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-r5py-0.1.1.dev2.dist-info/top_level.txt,sha256=fOH1R85dkNDOI7jkg-lIsl5CQIO4fE5X868K9dTqs9U,5
-r5py-0.1.1.dev2.dist-info/RECORD,,