r5py 1.0.1__tar.gz → 1.0.3.dev0__tar.gz

r5py-1.0.3.dev0/MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include tests *.py
+recursive-include tests/data *
+global-exclude *.pyc

{r5py-1.0.1/src/r5py.egg-info → r5py-1.0.3.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: r5py
-Version: 1.0.1
+Version: 1.0.3.dev0
 Summary: Python wrapper for the R5 routing analysis engine
 Author: Christoph Fink, Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
 License: GPL-3.0-or-later or MIT
@@ -58,6 +58,7 @@ 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"
 Requires-Dist: typing-extensions; extra == "tests"
+Dynamic: license-file
 
 <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-1.0.1 → r5py-1.0.3.dev0}/src/r5py/__init__.py

@@ -2,7 +2,7 @@
 
 """Python wrapper for the R5 routing analysis engine."""
 
-__version__ = "1.0.1"
+__version__ = "1.0.3.dev0"
 
 
 from .r5 import (

{r5py-1.0.1 → r5py-1.0.3.dev0}/src/r5py/r5/__init__.py

@@ -3,7 +3,6 @@
 """R5 classes."""
 
 from .access_leg import AccessLeg
-from .breakdown_stat import BreakdownStat
 from .detailed_itineraries import DetailedItineraries, DetailedItinerariesComputer
 from .direct_leg import DirectLeg
 from .egress_leg import EgressLeg
@@ -21,7 +20,6 @@ from .trip_planner import TripPlanner
 
 __all__ = [
     "AccessLeg",
-    "BreakdownStat",
     "DetailedItineraries",
     "DetailedItinerariesComputer",
     "DirectLeg",

{r5py-1.0.1 → r5py-1.0.3.dev0}/src/r5py/r5/regional_task.py

@@ -45,7 +45,6 @@ class RegionalTask:
         speed_cycling=12.0,
         max_public_transport_rides=8,
         max_bicycle_traffic_stress=3,
-        breakdown=False,
     ):
         """
         Create a RegionalTask, a computing request for R5.
@@ -110,8 +109,6 @@ class RegionalTask:
         max_bicycle_traffic_stress : int
             Maximum stress level for cyclist routing, ranges from 1-4 see
             https://docs.conveyal.com/learn-more/traffic-stress Default: 3
-        breakdown : bool
-            Compute a more detailed breakdown of the routes. Default: False
         """
         self._regional_task = com.conveyal.r5.analyst.cluster.RegionalTask()
         self.scenario = Scenario()
@@ -149,8 +146,6 @@ class RegionalTask:
 
         # always record travel times
         self._regional_task.recordTimes = True
-        # also report paths, if `breakdown`
-        self.breakdown = breakdown
 
         # a few settings we don’t expose (yet?)
         self._regional_task.makeTauiSite = False
@@ -185,32 +180,6 @@ class RegionalTask:
             access_modes, com.conveyal.r5.api.util.LegMode
         )
 
-    @property
-    def breakdown(self):
-        """Compute a more detailed breakdown of the routes."""
-        return self._breakdown
-
-    @breakdown.setter
-    def breakdown(self, breakdown):
-        self._breakdown = breakdown
-        self._regional_task.includePathResults = breakdown
-
-        # R5 has a maximum number of destinations for which it returns detailed
-        # information, and it’s set to 5000 by default.
-        # 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:
-            num_destinations = len(self.destinations)
-        except AttributeError:
-            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):
         """Find public transport connections leaving within ``departure_time_window`` after ``departure`` (datetime.datetime)."""
@@ -225,8 +194,10 @@ class RegionalTask:
         ):
             # fmt: on
             warnings.warn(
-                f"Departure time {departure} is outside of the time range "
-                "covered by currently loaded GTFS data sets.",
+                (
+                    "The currently loaded GTFS data sets do not define "
+                    f"any services on {departure.date()}."
+                ),
                 RuntimeWarning,
             )
 

{r5py-1.0.1 → r5py-1.0.3.dev0}/src/r5py/r5/transit_layer.py

@@ -4,13 +4,12 @@
 """Wraps a com.conveyal.r5.transit.TransitLayer."""
 
 
-import datetime
 import functools
 
 import jpype
 import jpype.types
 
-from ..util import parse_int_date
+import java.time
 
 
 __all__ = ["TransitLayer"]
@@ -32,44 +31,24 @@ class TransitLayer:
         instance._transit_layer = transit_layer
         return instance
 
-    @functools.cached_property
-    def start_date(self):
-        """The earliest date the loaded GTFS data covers."""
-        try:
-            start_date = min(
-                [
-                    parse_int_date(service.calendar.start_date)
-                    for service in self._transit_layer.services
-                ]
-            )
-        except (AttributeError, ValueError) as exception:
-            raise ValueError("No GTFS data set loaded") from exception
-        return start_date
+    def covers(self, date):
+        """
+        Check whether `date` is covered by GTFS data sets.
 
-    @functools.cached_property
-    def end_date(self):
-        """The latest date the loaded GTFS data covers."""
-        try:
-            end_date = max(
-                [
-                    parse_int_date(service.calendar.end_date)
-                    for service in self._transit_layer.services
-                ]
-            )
-            end_date += datetime.timedelta(
-                hours=23, minutes=59, seconds=59
-            )  # *end* of day
-        except (AttributeError, ValueError) as exception:
-            raise ValueError("No GTFS data set loaded") from exception
-        return end_date
-
-    def covers(self, point_in_time):
-        """Check whether `point_in_time` is covered by GTFS data sets."""
-        try:
-            covers = self.start_date <= point_in_time <= self.end_date
-        except ValueError:  # no GTFS data loaded
-            covers = False
-        return covers
+        Arguments:
+        ----------
+        date : datetime.date
+            date for which to check whether a GTFS service exists.
+
+        Returns:
+        --------
+        bool
+            Whether or not any services exist on `date`.
+        """
+        date = java.time.LocalDate.of(date.year, date.month, date.day)
+        return True in set(
+            [service.activeOn(date) for service in self._transit_layer.services]
+        )
 
     def get_street_vertex_for_stop(self, stop):
         """

{r5py-1.0.1 → r5py-1.0.3.dev0}/src/r5py/r5/transport_network.py

@@ -16,6 +16,7 @@ from .street_layer import StreetLayer
 from .transit_layer import TransitLayer
 from .transport_mode import TransportMode
 from ..util import Config, contains_gtfs_data, FileDigest, start_jvm, WorkingCopy
+from ..util.exceptions import GtfsFileError
 
 import com.conveyal.gtfs
 import com.conveyal.osmlib
@@ -35,7 +36,7 @@ start_jvm()
 class TransportNetwork:
     """Wrap a com.conveyal.r5.transit.TransportNetwork."""
 
-    def __init__(self, osm_pbf, gtfs=[]):
+    def __init__(self, osm_pbf, gtfs=[], allow_errors=False):
         """
         Load a transport network.
 
@@ -45,6 +46,9 @@ class TransportNetwork:
             file path of an OpenStreetMap extract in PBF format
         gtfs : str | pathlib.Path | list[str] | list[pathlib.Path]
             path(s) to public transport schedule information in GTFS format
+        allow_errors : bool
+            try to proceed with loading the transport network even if input data
+            contain errors
         """
         osm_pbf = WorkingCopy(osm_pbf)
         if isinstance(gtfs, (str, pathlib.Path)):
@@ -79,9 +83,31 @@ class TransportNetwork:
             transport_network.transitLayer = com.conveyal.r5.transit.TransitLayer()
             transport_network.transitLayer.parentNetwork = transport_network
             for gtfs_file in gtfs:
-                gtfs_feed = com.conveyal.gtfs.GTFSFeed.readOnlyTempFileFromGtfs(
+                gtfs_feed = com.conveyal.gtfs.GTFSFeed.writableTempFileFromGtfs(
                     f"{gtfs_file}"
                 )
+                if gtfs_feed.errors.size() > 0:
+                    errors = [
+                        f"{error.errorType}: {error.getMessageWithContext()}"
+                        for error in gtfs_feed.errors
+                    ]
+                    if allow_errors:
+                        warnings.warn(
+                            (
+                                "R5 reported the following issues with "
+                                f"GTFS file {gtfs_file.name}: \n"
+                                + ("\n- ".join(errors))
+                            ),
+                            RuntimeWarning,
+                        )
+                    else:
+                        raise GtfsFileError(
+                            (
+                                f"Could not load GTFS file {gtfs_file.name}. \n"
+                                + ("\n- ".join(errors))
+                            )
+                        )
+
                 transport_network.transitLayer.loadFromGtfs(gtfs_feed)
                 gtfs_feed.close()
 

{r5py-1.0.1 → r5py-1.0.3.dev0}/src/r5py/util/exceptions.py

@@ -12,6 +12,10 @@ class R5pyError(Exception):
 
 
 # more specific exceptions
+class GtfsFileError(R5pyError):
+    """GTFS file contained errors."""
+
+
 class ChecksumFailed(requests.RequestException, R5pyError):
     """Requested resource did not pass checksum test."""
 

{r5py-1.0.1 → r5py-1.0.3.dev0/src/r5py.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: r5py
-Version: 1.0.1
+Version: 1.0.3.dev0
 Summary: Python wrapper for the R5 routing analysis engine
 Author: Christoph Fink, Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
 License: GPL-3.0-or-later or MIT
@@ -58,6 +58,7 @@ 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"
 Requires-Dist: typing-extensions; extra == "tests"
+Dynamic: license-file
 
 <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-1.0.1 → r5py-1.0.3.dev0}/src/r5py.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE
+MANIFEST.in
 README.md
 pyproject.toml
 src/r5py/__init__.py
@@ -11,7 +12,6 @@ src/r5py.egg-info/top_level.txt
 src/r5py/r5/__init__.py
 src/r5py/r5/access_leg.py
 src/r5py/r5/base_travel_time_matrix.py
-src/r5py/r5/breakdown_stat.py
 src/r5py/r5/detailed_itineraries.py
 src/r5py/r5/direct_leg.py
 src/r5py/r5/egress_leg.py
@@ -48,7 +48,9 @@ src/r5py/util/spatially_clustered_geodataframe.py
 src/r5py/util/validating_requests_session.py
 src/r5py/util/warnings.py
 src/r5py/util/working_copy.py
-tests/test_breakdownstats.py
+tests/__init__.py
+tests/conftest.py
+tests/temporary_directory.py
 tests/test_camel_to_snake_case.py
 tests/test_classpath.py
 tests/test_config.py
@@ -75,4 +77,40 @@ tests/test_trip_leg.py
 tests/test_trip_planner.py
 tests/test_validating_request_session.py
 tests/test_verbose_warnings.py
-tests/test_working_directory.py
+tests/test_working_directory.py
+tests/conftest_d/__init__.py
+tests/conftest_d/data_directory.py
+tests/conftest_d/destinations.py
+tests/conftest_d/file_digest.py
+tests/conftest_d/garbage_collection.py
+tests/conftest_d/origins.py
+tests/conftest_d/r5_jar.py
+tests/conftest_d/routing_parameters.py
+tests/conftest_d/routing_results.py
+tests/conftest_d/sample_data.py
+tests/conftest_d/transport_network.py
+tests/conftest_d/upstream_r5.py
+tests/data/test_broken_gtfs.zip
+tests/data/test_detailed_itineraries_bicycle.gpkg.zip
+tests/data/test_detailed_itineraries_car.gpkg.zip
+tests/data/test_detailed_itineraries_transit.gpkg.zip
+tests/data/test_detailed_itineraries_walk.gpkg.zip
+tests/data/test_invalid_points_duplicate_ids.geojson
+tests/data/test_invalid_points_no_id_column.geojson
+tests/data/test_isochrones_bicycle.gpkg.zip
+tests/data/test_isochrones_car.gpkg.zip
+tests/data/test_isochrones_from_multiple_origins.gpkg.zip
+tests/data/test_isochrones_transit.gpkg.zip
+tests/data/test_isochrones_walk.gpkg.zip
+tests/data/test_multiple_origins.geojson
+tests/data/test_snapped_population_grid_centroids.geojson
+tests/data/test_travel_times_bicycle.csv
+tests/data/test_travel_times_car.csv
+tests/data/test_travel_times_transit.csv
+tests/data/test_travel_times_walk.csv
+tests/data/test_valid_points_data.geojson
+tests/data/test_valid_single_point_data.geojson
+tests/data/test_walking_details_not_snapped.csv
+tests/data/test_walking_details_snapped.csv
+tests/data/test_walking_times_not_snapped.csv
+tests/data/test_walking_times_snapped.csv

r5py-1.0.3.dev0/tests/__init__.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+
+"""Test the r5py package."""

r5py-1.0.3.dev0/tests/conftest.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+
+"""Configuration and fixtures for testing r5py."""
+
+# This is a init file common to all tests. It is automatically sourced
+# by pytest et al.
+
+# This file imports all files in the conftest.d directory
+
+# Define common constants (e.g., paths to test data) and fixtures (e.g.,
+# transport network) there and import the fixtures into conftest_d/__init__.py.
+
+from .conftest_d import *  # noqa: F401,F403

r5py-1.0.3.dev0/tests/conftest_d/__init__.py

@@ -0,0 +1,152 @@
+#!/usr/bin/env python3
+
+
+"""Fixtures to be used in r5py tests."""
+
+
+from .destinations import (
+    population_grid,
+    population_grid_points,
+    population_grid_points_first_three,
+    population_grid_points_second_three,
+    population_grid_points_four,
+    snapped_population_grid_points,
+    unreachable_stops,
+    unsnappable_points,
+)
+
+from .file_digest import (
+    file_digest_test_file_as_pathlib_path,
+    file_digest_test_file_as_str,
+    file_digest_sha256,
+    file_digest_blake2b,
+    file_digest_blake2s,
+)
+
+from .garbage_collection import java_garbage_collection
+
+from .origins import (
+    multiple_origins,
+    origin_point,
+    origins_invalid_duplicate_ids,
+    origins_invalid_no_id,
+    origins_valid_ids,
+)
+
+from .r5_jar import (
+    r5_jar_cached,
+    r5_jar_cached_invalid,
+    r5_jar_sha256,
+    r5_jar_sha256_github_error_message_when_posting,
+    r5_jar_sha256_invalid,
+    r5_jar_url,
+)
+
+from .routing_parameters import (
+    departure_datetime,
+    regional_task,
+)
+
+from .routing_results import (
+    detailed_itineraries_bicycle,
+    detailed_itineraries_car,
+    detailed_itineraries_transit,
+    detailed_itineraries_walk,
+    isochrones_from_multiple_origins,
+    isochrones_bicycle,
+    isochrones_car,
+    isochrones_transit,
+    isochrones_walk,
+    travel_times_bicycle,
+    travel_times_car,
+    travel_times_transit,
+    travel_times_walk,
+    walking_details_not_snapped,
+    walking_details_snapped,
+    walking_times_not_snapped,
+    walking_times_snapped,
+)
+
+from .sample_data import (
+    sample_data_set_sha256,
+    sample_data_set_url,
+)
+
+from .transport_network import (
+    broken_gtfs_file_path,
+    gtfs_file_path,
+    gtfs_timezone_helsinki,
+    helsinki_osm_pbf_file_path,
+    not_a_gtfs_file,
+    sao_paulo_osm_pbf_file_path,
+    transport_network,
+    transport_network_files_tuple,
+    transport_network_from_test_directory,
+    transport_network_from_test_files,
+    transport_network_from_test_files_without_gtfs,
+)
+
+from .upstream_r5 import (
+    can_compute_detailed_route_geometries,
+)
+
+__all__ = [
+    "broken_gtfs_file_path",
+    "can_compute_detailed_route_geometries",
+    "departure_datetime",
+    "detailed_itineraries_bicycle",
+    "detailed_itineraries_car",
+    "detailed_itineraries_transit",
+    "detailed_itineraries_walk",
+    "file_digest_blake2b",
+    "file_digest_blake2s",
+    "file_digest_sha256",
+    "file_digest_test_file_as_pathlib_path",
+    "file_digest_test_file_as_str",
+    "gtfs_file_path",
+    "gtfs_timezone_helsinki",
+    "helsinki_osm_pbf_file_path",
+    "isochrones_bicycle",
+    "isochrones_car",
+    "isochrones_from_multiple_origins",
+    "isochrones_transit",
+    "isochrones_walk",
+    "java_garbage_collection",
+    "multiple_origins",
+    "not_a_gtfs_file",
+    "origin_point",
+    "origins_invalid_duplicate_ids",
+    "origins_invalid_no_id",
+    "origins_valid_ids",
+    "population_grid",
+    "population_grid_points",
+    "population_grid_points_first_three",
+    "population_grid_points_four",
+    "population_grid_points_second_three",
+    "r5_jar_cached",
+    "r5_jar_cached_invalid",
+    "r5_jar_sha256",
+    "r5_jar_sha256_github_error_message_when_posting",
+    "r5_jar_sha256_invalid",
+    "r5_jar_url",
+    "regional_task",
+    "sample_data_set_sha256",
+    "sample_data_set_url",
+    "sao_paulo_osm_pbf_file_path",
+    "snapped_population_grid_points",
+    "transport_network",
+    "transport_network_files_tuple",
+    "transport_network_from_test_directory",
+    "transport_network_from_test_files",
+    "transport_network_from_test_files_without_gtfs",
+    "travel_times_bicycle",
+    "travel_times_car",
+    "travel_times_transit",
+    "travel_times_walk",
+    "unreachable_stops",
+    "unsnappable_points",
+    "walking_details_not_snapped",
+    "walking_details_snapped",
+    "walking_times_not_snapped",
+    "walking_times_snapped",
+]

r5py-1.0.3.dev0/tests/conftest_d/data_directory.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+
+
+"""Path to test data sets."""
+import pathlib
+
+
+DATA_DIRECTORY = pathlib.Path(__file__).resolve().parent.parent / "data"

r5py-1.0.3.dev0/tests/conftest_d/destinations.py

@@ -0,0 +1,83 @@
+#!/usr/bin/env python3
+
+
+"""Fixtures related to the destinations used in routing."""
+
+
+import geopandas
+import pytest
+import shapely
+
+from .data_directory import DATA_DIRECTORY
+
+
+SNAPPED_POPULATION_GRID_POINTS = (
+    DATA_DIRECTORY / "test_snapped_population_grid_centroids.geojson"
+)
+
+
+@pytest.fixture(scope="session")
+def population_grid():
+    """Load the grid point data set."""
+    import r5py.sampledata.helsinki
+
+    yield geopandas.read_file(r5py.sampledata.helsinki.population_grid)
+
+
+@pytest.fixture(scope="session")
+def population_grid_points(population_grid):
+    """Return the grid point data set in EPSG:4326."""
+    population_grid_points = population_grid.copy()
+    population_grid_points.geometry = population_grid_points.geometry.to_crs(
+        "EPSG:3067"
+    ).centroid.to_crs("EPSG:4326")
+    yield population_grid_points
+
+
+@pytest.fixture(scope="session")
+def population_grid_points_first_three(population_grid_points):
+    """Return the first set of three grid points."""
+    yield population_grid_points[0:3]
+
+
+@pytest.fixture(scope="session")
+def population_grid_points_second_three(population_grid_points):
+    """Return the second set of three grid points."""
+    yield population_grid_points[4:7]
+
+
+@pytest.fixture(scope="session")
+def population_grid_points_four(population_grid_points):
+    """Return four grid points."""
+    yield population_grid_points[10:14]
+
+
+@pytest.fixture(scope="session")
+def snapped_population_grid_points():
+    """Return a `geopandas.GeoDataFrame` that contains grid points snapped to the street network."""
+    yield geopandas.read_file(SNAPPED_POPULATION_GRID_POINTS)
+
+
+@pytest.fixture
+def unreachable_stops():
+    """Return a list of public transport stops that cannot be reached."""
+    yield [
+        1294132,
+        1174101,
+        1452601,
+    ]
+
+
+@pytest.fixture
+def unsnappable_points():
+    """Retrieve a set of points that cannot be snapped to the sample data network."""
+    yield geopandas.GeoDataFrame(
+        {
+            "id": [1, 2],
+            "geometry": [
+                shapely.Point(48.20, 16.36),  # far away from Helsinki
+                shapely.Point(-0.22, -78.51),  # even further
+            ],
+        },
+        crs="EPSG:4326",
+    )

r5py-1.0.3.dev0/tests/conftest_d/file_digest.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+
+"""Fixtures describing the expected routing results."""
+
+
+import pytest
+
+from .routing_results import ISOCHRONES_WALK
+
+
+ISOCHRONES_WALK_BLAKE2B = "163f6b2bc985e7eb347020320392a151ba1c156a09e82f87c0149273de2714516a098984e581bf99742c075232e18d69f5171370589cb5ec64d70f42f539f76c"
+ISOCHRONES_WALK_BLAKE2S = (
+    "9f0af2c9946982b2e7d17a0b2205b596cbef01b1037874f5ad72348407ad381e"
+)
+ISOCHRONES_WALK_SHA256 = (
+    "b632d148ca5d9875482197461809f25fe790d71827e821983cefe2394841b417"
+)
+
+
+@pytest.fixture
+def file_digest_test_file_as_pathlib_path():
+    """Return the path of a test file as a pathlib.Path."""
+    yield ISOCHRONES_WALK
+
+
+@pytest.fixture
+def file_digest_test_file_as_str(file_digest_test_file_as_pathlib_path):
+    """Return the path of a test file as a str."""
+    yield f"{file_digest_test_file_as_pathlib_path}"
+
+
+@pytest.fixture()
+def file_digest_sha256():
+    """Return the expected SHA256 hash for the test file."""
+    yield ISOCHRONES_WALK_SHA256
+
+
+@pytest.fixture()
+def file_digest_blake2b():
+    """Return the expected BLAKE2B hash for the test file."""
+    yield ISOCHRONES_WALK_BLAKE2B
+
+
+@pytest.fixture()
+def file_digest_blake2s():
+    """Return the expected BLAKE2S hash for the test file."""
+    yield ISOCHRONES_WALK_BLAKE2S

r5py-1.0.3.dev0/tests/conftest_d/garbage_collection.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+
+
+"""An auto-use fixture that calls Java garbage collection before every function."""
+
+
+import jpype
+import pytest
+
+
+@pytest.fixture(autouse=True, scope="function")
+def java_garbage_collection():
+    """Call Java GC before every function."""
+    jpype.java.lang.System.gc()