diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml new file mode 100644 index 000000000..c50337113 --- /dev/null +++ b/.github/workflows/python_ci.yml @@ -0,0 +1,192 @@ +# This file is autogenerated by maturin v1.7.4 +# To update, run +# +# maturin generate-ci github +# +name: Python package + +on: + push: + branches: + - main + - master + tags: + - '*' + pull_request: + workflow_dispatch: + +permissions: + contents: read + +jobs: + linux: + runs-on: ${{ matrix.platform.runner }} + strategy: + matrix: + platform: + - runner: ubuntu-latest + target: x86_64 + - runner: ubuntu-latest + target: x86 + - runner: ubuntu-latest + target: aarch64 + - runner: ubuntu-latest + target: armv7 + - runner: ubuntu-latest + target: s390x + - runner: ubuntu-latest + target: ppc64le + steps: + - uses: actions/checkout@v4 + - name: Install Python dev + run: | + sudo apt-get update + sudo apt-get install -y python3-dev + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Build wheels + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + args: --release --out dist --find-interpreter --manifest-path transit_model_python/Cargo.toml + sccache: 'true' + manylinux: auto + - name: Upload wheels + uses: actions/upload-artifact@v4 + with: + name: wheels-linux-${{ matrix.platform.target }} + path: dist + + musllinux: + runs-on: ${{ matrix.platform.runner }} + strategy: + matrix: + platform: + - runner: ubuntu-latest + target: x86_64 + - runner: ubuntu-latest + target: x86 + - runner: ubuntu-latest + target: aarch64 + - runner: ubuntu-latest + target: armv7 + steps: + - uses: actions/checkout@v4 + - name: Install Python dev + run: | + sudo apt-get update + sudo apt-get install -y python3-dev + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Build wheels + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + args: --release --out dist --find-interpreter --manifest-path transit_model_python/Cargo.toml + sccache: 'true' + manylinux: musllinux_1_2 + - name: Upload wheels + uses: actions/upload-artifact@v4 + with: + name: wheels-musllinux-${{ matrix.platform.target }} + path: dist + + windows: + runs-on: ${{ matrix.platform.runner }} + strategy: + matrix: + platform: + - runner: windows-latest + target: x64 + - runner: windows-latest + target: x86 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: 3.x + architecture: ${{ matrix.platform.target }} + - name: Build wheels + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + args: --release --out dist --find-interpreter --manifest-path transit_model_python/Cargo.toml + sccache: 'true' + - name: Upload wheels + uses: actions/upload-artifact@v4 + with: + name: wheels-windows-${{ matrix.platform.target }} + path: dist + + macos: + runs-on: ${{ matrix.platform.runner }} + strategy: + matrix: + platform: + - runner: macos-12 + target: x86_64 + - runner: macos-14 + target: aarch64 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Build wheels + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + args: --release --out dist --find-interpreter --manifest-path transit_model_python/Cargo.toml + sccache: 'true' + - name: Upload wheels + uses: actions/upload-artifact@v4 + with: + name: wheels-macos-${{ matrix.platform.target }} + path: dist + + sdist: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install Python dev + run: | + sudo apt-get update + sudo apt-get install -y python3-dev + - uses: actions/setup-python@v5 + - name: Build sdist + uses: PyO3/maturin-action@v1 + with: + command: sdist + args: --out dist --manifest-path transit_model_python/Cargo.toml + - name: Upload sdist + uses: actions/upload-artifact@v4 + with: + name: wheels-sdist + path: dist + +# release: +# name: Release +# runs-on: ubuntu-latest +# if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }} +# needs: [linux, musllinux, windows, macos, sdist] +# permissions: +# # Use to sign the release artifacts +# id-token: write +# # Used to upload release artifacts +# contents: write +# # Used to generate artifact attestation +# attestations: write +# steps: +# - uses: actions/download-artifact@v4 +# - name: Generate artifact attestation +# uses: actions/attest-build-provenance@v1 +# with: +# subject-path: 'wheels-*/*' +# - name: Publish to PyPI +# if: ${{startsWith(github.ref, 'refs/tags/')}} +# uses: PyO3/maturin-action@v1 +# with: +# command: upload +# args: --non-interactive --skip-existing wheels-*/* diff --git a/Cargo.toml b/Cargo.toml index fd73acbfa..37de6745d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -29,12 +29,14 @@ members = [ "ntfs2netexfr", "ntfs2ntfs", "restrict-validity-period", + "transit_model_python" ] [features] xmllint = ["proj"] gtfs = [] parser = [] +downloadable = [] [dependencies] anyhow = "1" @@ -67,6 +69,8 @@ walkdir = "2" wkt = "0.10" zip = { version = "2", default-features = false, features = ["deflate"] } git-version = "0.3" +reqwest = { version = "0.12.12", default-features = false, features = ["json"] } +tokio = "1.43.0" [[test]] name = "write_netex_france" @@ -78,3 +82,6 @@ approx = "0.5" log = "0.4" rust_decimal_macros = "1" testing_logger = "0.1" +mockito = "0.31" +tokio = { version = "1.0", features = ["full", "test-util"] } +futures = "0.3" diff --git a/downloadable_model_graph.md b/downloadable_model_graph.md new file mode 100644 index 000000000..b039b0e9e --- /dev/null +++ b/downloadable_model_graph.md @@ -0,0 +1,51 @@ +```mermaid +graph TD + A[DownloadableTransitModel] --> B[ModelConfig] + A --> C[NavitiaConfig] + A --> D[Downloader] + A --> E[Arc>] + A --> F[Arc>] + + subgraph Initialization + G[Start] --> H[initialize_model] + H --> I[get_remote_version] + I --> J[Navitia API] + H --> K[run_download] + K --> L[Downloader] + H --> M[ntfs::read] + end + + subgraph Background Updater + N[start_background_updater] --> O[check_and_update] + O --> P[get_remote_version] + O --> Q{Version Newer?} + Q -->|Yes| R[run_download] + Q -->|No| S[Return false] + R --> T[ntfs::read] + T --> U[Atomic Model Swap] + U --> V[Version Update] + end + + subgraph External Components + J -->|HTTP GET| W((Navitia Server)) + L -->|Storage| X[(S3/File System)] + M --> Y[NTFS Parser] + end + + subgraph Concurrency + E -.->|RwLock| Z[Thread-safe Reads] + E -.->|Write Lock| AA[Atomic Updates] + F -.->|Mutex| AB[Version Safety] + N --> AC[Tokio Spawn] + end + + style A fill:#f9f,stroke:#333 + style B fill:#ccf,stroke:#333 + style C fill:#ccf,stroke:#333 + style D fill:#cfc,stroke:#333 + style J fill:#fcc,stroke:#333 + style L fill:#fcc,stroke:#333 + style W fill:#cff,stroke:#333 + style X fill:#cff,stroke:#333 + style Y fill:#cff,stroke:#333 +``` \ No newline at end of file diff --git a/src/downloadable_model.rs b/src/downloadable_model.rs new file mode 100644 index 000000000..cb1f20a76 --- /dev/null +++ b/src/downloadable_model.rs @@ -0,0 +1,474 @@ +// Copyright (C) 2025 Hove and/or its affiliates. +// +// This program is free software: you can redistribute it and/or modify it +// under the terms of the GNU Affero General Public License as published by the +// Free Software Foundation, version 3. + +// This program is distributed in the hope that it will be useful, but WITHOUT +// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more +// details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see + +//! A module for managing downloadable transit models with Navitia integration +//! +//! This system provides: +//! 1. Automatic updates from Navitia-powered transit feeds +//! 2. Secure authentication for Navitia API +//! 3. Thread-safe model access +//! 4. Configurable update intervals +//! 5. Pluggable download implementations + +use crate::ntfs; +use reqwest::header; +use serde::Deserialize; +use std::error::Error; +use std::future::Future; +use std::pin::Pin; +use std::sync::Arc; +use std::time::Duration; +use tokio::sync::Mutex; +use tokio::sync::RwLock; + +/// Configuration for model management +#[derive(Clone, Deserialize)] +pub struct ModelConfig { + /// Update check interval in seconds + pub check_interval_secs: u64, + /// Local path for storing downloaded models + pub path: String, +} + +/// Configuration for Navitia API connection +#[derive(Clone, Deserialize)] +pub struct NavitiaConfig { + /// Base URL of Navitia API + pub navitia_url: String, + /// Coverage area identifier + pub coverage: String, + /// Authentication token for Navitia + pub navitia_token: String, +} + +type DownloadResult = + Pin>> + Send>>; + +/// Trait defining model download functionality +pub trait Downloader: Send + Sync + 'static { + /// Downloads a specific model version + /// + /// # Arguments + /// * `config` - Model configuration + /// * `version` - Target version identifier + /// + /// # Returns + /// Future resolving to local path of downloaded model + fn run_download(&self, config: &ModelConfig, version: &str) -> DownloadResult; +} + +/// Main structure managing the transit model lifecycle +pub struct DownloadableTransitModel { + /// Thread-safe model access + pub current_model: Arc>, + /// Current model version + version: Arc>, + /// Download implementation + downloader: D, + /// Model configuration + config: ModelConfig, + /// Navitia API configuration + navitia_config: NavitiaConfig, +} + +impl DownloadableTransitModel { + /// Initializes a new model manager + /// + /// # Arguments + /// * `navitia_config` - Navitia API credentials + /// * `config` - Model management settings + /// * `downloader` - Download implementation + /// + /// # Flow + /// 1. Fetch current version from Navitia + /// 2. Download initial model + /// 3. Start background updater + pub async fn new( + navitia_config: NavitiaConfig, + config: ModelConfig, + downloader: D, + ) -> Result> { + let (model, version) = + Self::initialize_model(&config, &navitia_config, &downloader).await?; + + let instance = Self { + current_model: Arc::new(RwLock::new(model)), + version: Arc::new(Mutex::new(version)), + downloader, + config, + navitia_config, + }; + + instance.start_background_updater(); + Ok(instance) + } + + /// Fetches the current model + /// + /// # Arguments + /// * `config` - Model configuration + /// * `navitia_config` - Navitia API credentials + /// * `downloader` - Download implementation + /// + /// # Returns + /// A reference to the current model + /// A reference to the current model version path + async fn initialize_model( + config: &ModelConfig, + navitia_config: &NavitiaConfig, + downloader: &D, + ) -> Result<(crate::Model, String), Box> { + let version = Self::get_remote_version(navitia_config).await?; + let folder_saved_at_path = downloader.run_download(config, &version).await?; + let model = ntfs::read(&folder_saved_at_path).map_err(anyhow::Error::from)?; + Ok((model, version)) + } + + /// Starts the background updater + /// + /// # Arguments + /// + /// * `self` - The current instance + /// + /// # Flow + /// + /// 1. Periodically checks for updates + /// 2. Downloads and updates the model if a new version is available + /// 3. Logs the update + /// + /// # Note + /// + /// This function runs indefinitely in the background + /// + fn start_background_updater(&self) { + let config = self.config.clone(); + let downloader = self.downloader.clone(); + let model_ref = self.current_model.clone(); + let version_ref = self.version.clone(); + let navitia_config = self.navitia_config.clone(); + + tokio::spawn(async move { + let mut interval = + tokio::time::interval(Duration::from_secs(config.check_interval_secs)); + loop { + interval.tick().await; + match Self::check_and_update( + &config, + &downloader, + &model_ref, + &version_ref, + &navitia_config, + ) + .await + { + Ok(updated) => { + if updated { + println!("Updated to version {}", *version_ref.lock().await); + } + } + Err(e) => eprintln!("Background update failed: {}", e), + } + } + }); + } + + /// Checks for updates and updates the model if a new version is available + /// + /// # Arguments + /// + /// * `config` - Model configuration + /// * `downloader` - Download implementation + /// * `model` - The current model + /// * `version` - The current model version + /// * `navitia_config` - Navitia API credentials + /// + /// # Returns + /// + /// A boolean indicating whether the model was updated + async fn check_and_update( + config: &ModelConfig, + downloader: &D, + model: &Arc>, + version: &Mutex, + navitia_config: &NavitiaConfig, + ) -> Result> { + let remote_version = Self::get_remote_version(navitia_config).await?; + let current_version = version.lock().await.clone(); + + if remote_version > current_version { + // Download and load the model before acquiring the write lock + let saved_to_path = downloader.run_download(config, &remote_version).await?; + let new_model = ntfs::read(&saved_to_path).map_err(anyhow::Error::from)?; + + let mut model_lock = model.write().await; + *model_lock = new_model; + + // Update version + let mut version_lock = version.lock().await; + *version_lock = remote_version; + + Ok(true) + } else { + Ok(false) + } + } + + /// Fetches the current version from Navitia + /// + /// # Arguments + /// + /// * `config` - Navitia API configuration + /// + /// # Returns + /// + /// The current version identifier + async fn get_remote_version( + config: &NavitiaConfig, + ) -> Result> { + #[derive(Deserialize)] + struct Status { + dataset_created_at: String, + } + + #[derive(Deserialize)] + struct StatusResponse { + status: Status, + } + + let url = format!("{}/coverage/{}/status", config.navitia_url, config.coverage); + let client = reqwest::Client::new(); + let response = client + .get(&url) + .header( + header::AUTHORIZATION, + format!("Bearer {}", config.navitia_token), + ) + .send() + .await?; + + if !response.status().is_success() { + return Err(format!("Failed to fetch status: {}", response.status()).into()); + } + + let res = response.json::().await?; + Ok(res.status.dataset_created_at) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use mockito::mock; + use std::sync::atomic::{AtomicUsize, Ordering}; + use tokio::time::{self, Duration}; + + #[derive(Clone)] + struct MockDownloader; + + impl Downloader for MockDownloader { + fn run_download(&self, _config: &ModelConfig, _version: &str) -> DownloadResult { + Box::pin(async move { + time::sleep(Duration::from_secs(1)).await; + Ok("tests/fixtures/minimal_ntfs/".into()) + }) + } + } + + fn create_test_config() -> (ModelConfig, NavitiaConfig) { + ( + ModelConfig { + check_interval_secs: 1, + path: "test_path".into(), + }, + NavitiaConfig { + navitia_url: mockito::server_url(), + coverage: "test_coverage".into(), + navitia_token: "test_token".into(), + }, + ) + } + + async fn create_mock_navitia_response(version: &str) -> mockito::Mock { + mock("GET", "/coverage/test_coverage/status") + .with_status(200) + .with_header("content-type", "application/json") + .with_body(format!( + r#"{{"status": {{"dataset_created_at": "{}"}}}}"#, + version + )) + .create() + } + + #[tokio::test] + async fn test_initialization() { + let (config, navitia_config) = create_test_config(); + let _m = create_mock_navitia_response("1.0.0").await; + + let model = DownloadableTransitModel::::new( + navitia_config, + config, + MockDownloader {}, + ) + .await + .unwrap(); + let version = model.version.lock().await; + assert_eq!(*version, "1.0.0"); + } + + #[tokio::test] + async fn test_background_update() { + let (config, navitia_config) = create_test_config(); + let _m = create_mock_navitia_response("1.0.0").await; + + let model = DownloadableTransitModel::::new( + navitia_config.clone(), + config.clone(), + MockDownloader {}, + ) + .await + .unwrap(); + let version = model.version.clone(); + let model_ref = model.current_model.clone(); + + // update to 1.0.1 version + let _m = create_mock_navitia_response("1.0.1").await; + + // Force an update + let updated = DownloadableTransitModel::::check_and_update( + &config, + &MockDownloader {}, + &model_ref, + &version, + &navitia_config, + ) + .await + .unwrap(); + assert!(updated); + + let version = model.version.lock().await; + assert_eq!(*version, "1.0.1"); + } + + #[tokio::test] + async fn test_no_update_when_version_same() { + let _m = create_mock_navitia_response("1.0.0").await; + let (model_config, navitia_config) = create_test_config(); + let downloader = MockDownloader {}; + + let model_manager = DownloadableTransitModel::new( + navitia_config.clone(), + model_config.clone(), + downloader.clone(), + ) + .await + .unwrap(); + + let updated = DownloadableTransitModel::check_and_update( + &model_config, + &downloader, + &model_manager.current_model, + &model_manager.version, + &navitia_config, + ) + .await + .unwrap(); + + assert!(!updated); + } + + #[tokio::test] + async fn test_concurrent_access_during_update() { + let _m = create_mock_navitia_response("1.0.0").await; + let (model_config, navitia_config) = create_test_config(); + let downloader = MockDownloader {}; + + let model_manager = DownloadableTransitModel::new(navitia_config, model_config, downloader) + .await + .unwrap(); + + let handle = model_manager.current_model.clone(); + let (tx, rx) = tokio::sync::oneshot::channel(); + + // Spawn a reader that holds the lock + tokio::spawn(async move { + let _guard = handle.read().await; + let lines = _guard + .lines + .get_idx("M1") + .iter() + .map(|idx| _guard.lines[*idx].name.to_string()) + .collect::>(); + assert_eq!(lines, vec!["Metro 1".to_string(),]); + tx.send(()).unwrap(); + tokio::time::sleep(Duration::from_millis(500)).await; + }); + + // Wait for read lock acquisition + rx.await.unwrap(); + + // Attempt update + let update_handle = model_manager.current_model.clone(); + tokio::spawn(async move { + let _guard = update_handle.write().await; + }); + } + + #[tokio::test] + async fn test_atomic_update() { + let version_counter = Arc::new(AtomicUsize::new(0)); + let (model_config, navitia_config) = create_test_config(); + + #[derive(Clone)] + struct CountingDownloader { + counter: Arc, + } + + impl Downloader for CountingDownloader { + fn run_download(&self, _: &ModelConfig, _: &str) -> DownloadResult { + let counter = self.counter.clone(); + Box::pin(async move { + counter.fetch_add(1, Ordering::SeqCst); + Ok("tests/fixtures/minimal_ntfs/".into()) + }) + } + } + + let downloader = CountingDownloader { + counter: version_counter.clone(), + }; + + let _m = create_mock_navitia_response("1.0.0").await; + let model_manager = DownloadableTransitModel::new( + navitia_config.clone(), + model_config.clone(), + downloader.clone(), + ) + .await + .unwrap(); + + // Trigger multiple update checks + for _ in 0..5 { + let _ = DownloadableTransitModel::check_and_update( + &model_config, + &downloader, + &model_manager.current_model, + &model_manager.version, + &navitia_config, + ) + .await; + } + + assert_eq!(version_counter.load(Ordering::SeqCst), 1); + } +} diff --git a/src/file_handler/mod.rs b/src/file_handler/mod.rs index 0c825f165..eb3ac3773 100644 --- a/src/file_handler/mod.rs +++ b/src/file_handler/mod.rs @@ -45,7 +45,7 @@ impl> PathFileHandler

{ } } -impl<'a, P: AsRef> FileHandler for &'a mut PathFileHandler

{ +impl> FileHandler for &mut PathFileHandler

{ type Reader = File; fn get_file_if_exists(self, name: &str) -> Result<(Option, PathBuf)> { let f = self.base_path.as_ref().join(name); diff --git a/src/gtfs/mod.rs b/src/gtfs/mod.rs index 3f89e92ec..2a67734c5 100644 --- a/src/gtfs/mod.rs +++ b/src/gtfs/mod.rs @@ -69,7 +69,7 @@ struct Agency { ticketing_deep_link_id: Option, } -impl<'a> From<&'a objects::Network> for Agency { +impl From<&objects::Network> for Agency { fn from(obj: &objects::Network) -> Agency { Agency { id: Some(obj.id.clone()), @@ -247,7 +247,7 @@ struct BookingRule { booking_url: Option, } -impl<'a> From<&'a objects::BookingRule> for BookingRule { +impl From<&objects::BookingRule> for BookingRule { fn from(obj: &objects::BookingRule) -> BookingRule { BookingRule { id: obj.id.clone(), @@ -285,7 +285,7 @@ struct Transfer { min_transfer_time: Option, } -impl<'a> From<&'a objects::Transfer> for Transfer { +impl From<&objects::Transfer> for Transfer { fn from(obj: &objects::Transfer) -> Transfer { Transfer { from_stop_id: obj.from_stop_id.clone(), diff --git a/src/gtfs/write.rs b/src/gtfs/write.rs index 6ca8461e9..8e7944450 100644 --- a/src/gtfs/write.rs +++ b/src/gtfs/write.rs @@ -375,7 +375,7 @@ where .collect() } -impl<'a> From<&'a objects::PhysicalMode> for RouteType { +impl From<&objects::PhysicalMode> for RouteType { fn from(obj: &objects::PhysicalMode) -> RouteType { match obj.id.as_str() { "RailShuttle" | "Tramway" => RouteType::Tramway, diff --git a/src/lib.rs b/src/lib.rs index b78c53283..7ec76240c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -77,6 +77,10 @@ pub mod validity_period; mod version_utils; pub mod vptranslator; +/// The `downloadable_model` module is used to manage a transit model that can be downloaded from a remote location. +// #[cfg(feature = "downloadable")] +pub mod downloadable_model; + // Good average size for initialization of the `StopTime` collection in `VehicleJourney` // Note: they are shrinked down in `Model::new()` to fit the real size pub(crate) const STOP_TIMES_INIT_CAPACITY: usize = 50; diff --git a/src/model_builder.rs b/src/model_builder.rs index 6606b4f01..156119c41 100644 --- a/src/model_builder.rs +++ b/src/model_builder.rs @@ -606,7 +606,7 @@ impl AsDateTime for &NaiveDateTime { } } -impl<'a> VehicleJourneyBuilder<'a> { +impl VehicleJourneyBuilder<'_> { fn find_or_create_sp(&mut self, sp: &str) -> Idx { self.model .collections @@ -1039,7 +1039,7 @@ impl<'a> VehicleJourneyBuilder<'a> { } } -impl<'a> Drop for VehicleJourneyBuilder<'a> { +impl Drop for VehicleJourneyBuilder<'_> { fn drop(&mut self) { use std::ops::DerefMut; let collections = &mut self.model.collections; diff --git a/src/objects.rs b/src/objects.rs index 268729038..5270f68df 100644 --- a/src/objects.rs +++ b/src/objects.rs @@ -25,6 +25,7 @@ use rust_decimal::Decimal; use serde::{Deserialize, Serialize}; use std::cmp::Ordering; use std::collections::BTreeSet; +use std::fmt; use std::hash::{Hash, Hasher}; use std::ops::{Add, Div, Rem, Sub}; use std::str::FromStr; @@ -923,7 +924,9 @@ impl<'de> ::serde::Deserialize<'de> for Time { // using the visitor pattern to avoid a string allocation struct TimeVisitor; - impl<'de> Visitor<'de> for TimeVisitor { + + // Use anonymous lifetime for Visitor implementation + impl Visitor<'_> for TimeVisitor { type Value = Time; fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { formatter.write_str("a time in the format HH:MM:SS") @@ -993,6 +996,16 @@ pub enum StopTimePrecision { Estimated, } +impl fmt::Display for StopTimePrecision { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match self { + StopTimePrecision::Exact => write!(f, "Exact"), + StopTimePrecision::Approximate => write!(f, "Approximate"), + StopTimePrecision::Estimated => write!(f, "Estimated"), + } + } +} + #[derive(Serialize, Deserialize, Copy, Clone, Debug, PartialEq, Default)] pub struct Coord { pub lon: f64, diff --git a/transit_model_python/.gitignore b/transit_model_python/.gitignore new file mode 100644 index 000000000..c8f044299 --- /dev/null +++ b/transit_model_python/.gitignore @@ -0,0 +1,72 @@ +/target + +# Byte-compiled / optimized / DLL files +__pycache__/ +.pytest_cache/ +*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +.venv/ +env/ +bin/ +build/ +develop-eggs/ +dist/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +include/ +man/ +venv/ +*.egg-info/ +.installed.cfg +*.egg + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt +pip-selfcheck.json + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Rope +.ropeproject + +# Django stuff: +*.log +*.pot + +.DS_Store + +# Sphinx documentation +docs/_build/ + +# PyCharm +.idea/ + +# VSCode +.vscode/ + +# Pyenv +.python-version diff --git a/transit_model_python/Cargo.toml b/transit_model_python/Cargo.toml new file mode 100644 index 000000000..ac9dd0c69 --- /dev/null +++ b/transit_model_python/Cargo.toml @@ -0,0 +1,25 @@ +[package] +name = "transit_model_python" +version = "0.1.0" +edition = "2021" +description = "A Python library for communicating with the transit_model Rust library" +license = "AGPL-3.0-only" +repository = "https://github.com/hove-io/transit_model/transit_model_python" +keywords = ["ntfs", "gtfs", "netex", "navitia", "transit"] +categories = ["data-structures", "encoding", "parser-implementations"] +readme = "python_README.md" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +[lib] +name = "transit_model_python" +crate-type = ["cdylib"] + +[dependencies] +transit_model = { path = "../", features = ["downloadable"] } +typed_index_collection = { git = "https://github.com/hove-io/typed_index_collection", tag = "v2", features=["expose-inner"] } +relational_types = { git = "https://github.com/hove-io/relational_types", tag = "v2" } +tokio = { version = "1.43.0", features = ["full"] } + +[dependencies.pyo3] +version = "0.23.4" + diff --git a/transit_model_python/LICENSE_python b/transit_model_python/LICENSE_python new file mode 100644 index 000000000..be3f7b28e --- /dev/null +++ b/transit_model_python/LICENSE_python @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/transit_model_python/example.py b/transit_model_python/example.py new file mode 100644 index 000000000..a297d68df --- /dev/null +++ b/transit_model_python/example.py @@ -0,0 +1,46 @@ +from transit_model_python import ( + PythonDownloadableModel, + NTFSDownloader, + PythonModelConfig, + PythonNavitiaConfig +) +import asyncio + +print("Hello World! from python_test.py") + + +class CustomDownloader(NTFSDownloader): + def __new__(cls): + # Create instance by passing the class as 'obj' to parent __new__ + return super().__new__(cls, cls) + async def run_download(self, config: PythonModelConfig, version: str) -> str: + print(f"Downloading model v{version}") + return "../tests/fixtures/minimal_ntfs/" + + +config = PythonModelConfig( + check_interval_secs=3600, + path="./models" +) + +navitia_config = PythonNavitiaConfig( + navitia_url="http://localhost:8080", + navitia_token="dummy_token", + coverage="test_coverage" +) + + +async def main(): + model = PythonDownloadableModel( + navitia_config=navitia_config, + model_config=config, + downloader=CustomDownloader() + ) + + + lines = model.get_lines("B42") + print(lines) # Should return ["Metro 1"] + + +if __name__ == "__main__": + asyncio.run(main()) \ No newline at end of file diff --git a/transit_model_python/example_simple.py b/transit_model_python/example_simple.py new file mode 100644 index 000000000..21c0980f4 --- /dev/null +++ b/transit_model_python/example_simple.py @@ -0,0 +1,6 @@ +from transit_model_python import PythonTransitModel + +print("Hello World! from python_test.py") +model = PythonTransitModel("../tests/fixtures/minimal_ntfs/") +lines = model.get_lines("B42") +print(lines) # Output: ["Metro 1"] \ No newline at end of file diff --git a/transit_model_python/pyproject.toml b/transit_model_python/pyproject.toml new file mode 100644 index 000000000..2b9cf4a1c --- /dev/null +++ b/transit_model_python/pyproject.toml @@ -0,0 +1,24 @@ +[build-system] +requires = ["maturin>=1.7,<2.0"] +build-backend = "maturin" + +[project] +name = "transit_model_python" +description = "A Python library for communicating with the transit_model Rust library" +requires-python = ">=3.8" +readme = "python_README.md" +license = {file = "LICENSE_python"} +classifiers = [ + "Programming Language :: Rust", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", +] +dynamic = ["version"] +[tool.maturin] +features = ["pyo3/extension-module"] +authors = [ + {name = "Prince Merveil ONDONDA",email = "prince.ondonda@hove.com"} +] +maintainers = [ + {name = "Prince Merveil ONDONDA",email = "prince.ondonda@hove.com"} +] diff --git a/transit_model_python/python_README.md b/transit_model_python/python_README.md new file mode 100644 index 000000000..242a1e869 --- /dev/null +++ b/transit_model_python/python_README.md @@ -0,0 +1,99 @@ +# PythonTransitModel + +**PythonTransitModel** is a Rust library that provides a Python interface to interact with transit data models. This library allows users to retrieve transit-related data, such as lines, contributors, networks, stop areas, and vehicle journeys, via Python. + +## Features + +- Retrieve lines passing through a stop. +- Get contributors providing data for a specific stop. +- Retrieve networks using a stop. +- Access stop area details by ID. +- Fetch vehicle journey information by ID, etc. + +## Requirements + +- Rust +- Python >= 3.8 +- [pyo3](https://pyo3.rs/) +- [transit_model](https://github.com/hove-io/transit_model) + +## Installation + +1. Clone the repository: + ```bash + git clone + cd + python3 -m venv .venv + source .venv/bin/activate + ``` + +2. Install Maturin and Build the Python module: + ```bash + pip install maturin + maturin develop + ``` + This command builds and installs the Python module locally. + +3. Import the module in your Python scripts: + ```python + from transit_model_python import PythonTransitModel + ``` + +## Usage + +### Initializing the Model +```python +model = PythonTransitModel("../tests/fixtures/minimal_ntfs/") +``` + +### Fetching Lines Passing Through a Stop +```python +lines = model.get_lines("M1") +print(lines) # Output: ["Metro 1"] +``` + +### Fetching Contributors Providing Data for a Stop +```python +contributors = model.get_contributors("TGC") +print(contributors) # Output: ["The Great Contributor"] +``` + +### Fetching Networks Using a Stop +```python +networks = model.get_networks("TGN") +print(networks) # Output: ["The Great Network"] +``` + +### Fetching Stop Area Details by ID +```python +stop_area = model.get_stop_area_by_id("GDL") +print(stop_area) # Output: "Gare de Lyon" +``` + +### Fetching Vehicle Journey Details by ID +```python +vehicle_journey = model.get_vehicule_journey_by_id("VJ1") +print(vehicle_journey) # Output: Optional["Journey Pattern ID"] +``` + +## Development + +### Running Tests +To run the tests, execute: +```bash +cargo test +``` + +## Contributing +Contributions are welcome! Please follow these steps: + +1. Fork the repository. +2. Create a new branch for your feature or bug fix. +3. Submit a pull request. + +## License +This project is licensed under the [GNU](LICENSE). + +## Acknowledgments +- [pyo3](https://pyo3.rs/) for enabling seamless integration between Rust and Python. +- [transit_model](https://github.com/hove-io/transit_model) for the underlying transit model library. diff --git a/transit_model_python/src/lib.rs b/transit_model_python/src/lib.rs new file mode 100644 index 000000000..f256cdb86 --- /dev/null +++ b/transit_model_python/src/lib.rs @@ -0,0 +1,153 @@ +// Copyright (C) 2024 Hove and/or its affiliates. +// +// This program is free software: you can redistribute it and/or modify it +// under the terms of the GNU Affero General Public License as published by the +// Free Software Foundation, version 3. + +// This program is distributed in the hope that it will be useful, but WITHOUT +// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more +// details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see + +//! PyO3 bindings for transit model data structures and operations +//! +//! Provides Python interfaces to access and manipulate transit model data +//! from NTFS (NeTEx France Standard) datasets. + +pub mod modules; + +use modules::downloadable_model::{NTFSDownloader, PythonDownloadableModel}; +use modules::python_transit_model::PythonTransitModel; +use pyo3::prelude::*; +use transit_model::downloadable_model::{ModelConfig, NavitiaConfig}; +use transit_model::objects::StopTime; + +#[pyclass] +pub struct PStopTime(StopTime); + +#[pymethods] +impl PStopTime { + #[getter] + fn get_stop_time(&self) -> PyResult { + Python::with_gil(|py| { + let stop_time = &self.0; + let dict = pyo3::types::PyDict::new(py); + dict.set_item("stop_point_idx", stop_time.stop_point_idx.get().to_string())?; + dict.set_item("sequence", stop_time.sequence)?; + dict.set_item( + "arrival_time", + stop_time + .arrival_time + .as_ref() + .map_or("None".to_string(), |t| t.total_seconds().to_string()), + )?; + dict.set_item( + "departure_time", + stop_time + .departure_time + .as_ref() + .map_or("None".to_string(), |t| t.total_seconds().to_string()), + )?; + dict.set_item( + "start_pickup_drop_off_window", + stop_time + .start_pickup_drop_off_window + .as_ref() + .map_or("None".to_string(), |t| t.to_string()), + )?; + dict.set_item( + "end_pickup_drop_off_window", + stop_time + .end_pickup_drop_off_window + .as_ref() + .map_or("None".to_string(), |t| t.to_string()), + )?; + dict.set_item("boarding_duration", stop_time.boarding_duration.to_string())?; + dict.set_item( + "alighting_duration", + stop_time.alighting_duration.to_string(), + )?; + dict.set_item("pickup_type", stop_time.pickup_type.to_string())?; + dict.set_item("drop_off_type", stop_time.drop_off_type.to_string())?; + dict.set_item( + "local_zone_id", + stop_time + .local_zone_id + .as_ref() + .map_or("None".to_string(), |t| t.to_string()), + )?; + dict.set_item( + "precision", + stop_time.precision.as_ref().map_or( + "None".to_string(), + |t: &transit_model::objects::StopTimePrecision| t.clone().to_string(), + ), + )?; + Ok(dict.into()) // Return the Python object + }) + } +} + +#[pyclass] +#[derive(Clone)] +pub struct PythonModelConfig(ModelConfig); + +#[pymethods] +impl PythonModelConfig { + #[new] + fn new(check_interval_secs: u64, path: String) -> Self { + let model = ModelConfig { + check_interval_secs, + path, + }; + PythonModelConfig(model) + } +} + +impl From for ModelConfig { + fn from(config: PythonModelConfig) -> Self { + config.0 + } +} + +impl From for PythonModelConfig { + fn from(config: ModelConfig) -> Self { + PythonModelConfig(config) + } +} + +#[pyclass] +#[derive(Clone)] +pub struct PythonNavitiaConfig(NavitiaConfig); + +impl From for NavitiaConfig { + fn from(config: PythonNavitiaConfig) -> Self { + config.0 + } +} + +#[pymethods] +impl PythonNavitiaConfig { + #[new] + fn new(navitia_url: String, coverage: String, navitia_token: String) -> Self { + let navitia_config = NavitiaConfig { + navitia_url, + coverage, + navitia_token, + }; + PythonNavitiaConfig(navitia_config) + } +} + +#[pymodule] +fn transit_model_python(m: &Bound<'_, PyModule>) -> PyResult<()> { + m.add_class::()?; + m.add_class::()?; + m.add_class::()?; + m.add_class::()?; + m.add_class::()?; + Ok(()) +} diff --git a/transit_model_python/src/modules/downloadable_model.rs b/transit_model_python/src/modules/downloadable_model.rs new file mode 100644 index 000000000..b3f1cb995 --- /dev/null +++ b/transit_model_python/src/modules/downloadable_model.rs @@ -0,0 +1,297 @@ +// Copyright (C) 2024 Hove and/or its affiliates. +// +// This program is free software: you can redistribute it and/or modify it +// under the terms of the GNU Affero General Public License as published by the +// Free Software Foundation, version 3. + +// This program is distributed in the hope that it will be useful, but WITHOUT +// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more +// details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see +//! PyO3 bindings for transit model components to enable Python interoperability + +use pyo3::{exceptions::PyValueError, prelude::*}; +use std::{error::Error, future::Future, pin::Pin}; +use tokio::runtime::Runtime; +use transit_model::downloadable_model::{DownloadableTransitModel, Downloader, ModelConfig}; + +use crate::{PStopTime, PythonModelConfig, PythonNavitiaConfig}; + +/// Python wrapper for a downloader component implementing the Downloader trait +/// +/// Acts as a bridge between Rust's Downloader trait and Python implementations, +/// allowing Python classes to provide download functionality to Rust code +#[pyclass(subclass)] +pub struct NTFSDownloader { + /// The underlying Python object implementing the download logic + inner: Py, +} + +impl Clone for NTFSDownloader { + /// Creates a new reference to the same Python downloader object + /// + /// Uses Python's GIL to safely clone the Python object reference + fn clone(&self) -> Self { + Python::with_gil(|py| NTFSDownloader { + inner: self.inner.clone_ref(py), + }) + } +} + +#[pymethods] +impl NTFSDownloader { + /// Creates a new NTFSDownloader wrapping a Python object + /// + /// # Arguments + /// * `obj` - Python object implementing the `run_download` method + #[new] + fn new(obj: Py) -> Self { + NTFSDownloader { inner: obj } + } +} + +impl Downloader for NTFSDownloader { + /// Executes the download operation by calling into Python implementation + /// + /// # Arguments + /// * `config` - Model configuration parameters + /// * `version` - Target version identifier for download + /// + /// # Returns + /// Future resolving to local path of downloaded model or error + fn run_download( + &self, + config: &ModelConfig, + version: &str, + ) -> Pin>> + Send>> { + let model = Python::with_gil(|py| self.inner.clone_ref(py)); + let version = version.to_string(); + let config = config.clone(); + + Box::pin(async move { + Python::with_gil(|py| { + model + .bind(py) + .call_method("run_download", (PythonModelConfig(config), version), None) + .map_err(|e| Box::new(e) as Box) + .and_then(|result| { + result + .extract() + .map_err(|e| Box::new(e) as Box) + }) + }) + }) + } +} + +/// Python-exposed interface for interacting with downloadable transit models +/// +/// Provides thread-safe access to transit model data with async-aware locking +#[pyclass] +pub struct PythonDownloadableModel { + /// The underlying Rust implementation of the downloadable transit model + model: DownloadableTransitModel, +} + +#[pymethods] +impl PythonDownloadableModel { + /// Initializes a new downloadable transit model instance + /// + /// # Arguments + /// * `navitia_config` - Configuration for Navitia integration + /// * `model_config` - General model configuration parameters + /// * `downloader` - Downloader component implementing the download logic + /// + /// # Errors + /// Returns `PyValueError` if initialization fails at any stage + #[new] + pub fn new( + navitia_config: PythonNavitiaConfig, + model_config: PythonModelConfig, + downloader: Py, + ) -> PyResult { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = rt + .block_on(async { + let rust_downloader = Python::with_gil(|py| match downloader.bind(py).extract() { + Ok(downloader) => Ok(downloader), + Err(e) => Err(PyValueError::new_err(format!( + "Failed to extract downloader: {}", + e + ))), + })?; + + DownloadableTransitModel::new( + navitia_config.into(), + model_config.into(), + rust_downloader, + ) + .await + }) + .map_err(|e| PyValueError::new_err(format!("Failed to create model: {}", e)))?; + + Ok(Self { model }) + } + + /// Retrieves transit lines associated with a given stop identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the stop + /// + /// # Returns + /// List of line names servicing the specified stop + pub fn get_lines(&self, idx: String) -> PyResult> { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = &self.model; + + let lines = rt.block_on(async { + let guard = model.current_model.read().await; + guard + .lines + .get_idx(&idx) + .iter() + .map(|index| guard.lines[*index].name.clone()) + .collect::>() + }); + + Ok(lines) + } + + /// Retrieves contributors associated with a given stop identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the stop + /// + /// # Returns + /// List of contributor names providing data for the specified stop + pub fn get_contributors(&self, idx: String) -> PyResult> { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = &self.model; + + let contributors = rt.block_on(async { + let guard = model.current_model.read().await; + guard + .contributors + .get_idx(&idx) + .iter() + .map(|index| guard.contributors[*index].name.clone()) + .collect::>() + }); + + Ok(contributors) + } + + /// Retrieves networks associated with a given stop identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the stop + /// + /// # Returns + /// List of network names the specified stop belongs to + pub fn get_networks(&self, idx: String) -> PyResult> { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = &self.model; + + let networks = rt.block_on(async { + let guard = model.current_model.read().await; + guard + .networks + .get_idx(&idx) + .iter() + .map(|index| guard.networks[*index].name.clone()) + .collect::>() + }); + + Ok(networks) + } + + /// Retrieves the name of a stop area by its identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the stop area + /// + /// # Returns + /// Name of the specified stop area + pub fn get_stop_area_by_id(&self, idx: String) -> PyResult { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = &self.model; + + let stop_area = rt.block_on(async { + let guard = model.current_model.read().await; + guard + .stop_areas + .get_idx(&idx) + .iter() + .map(|index| guard.stop_areas[*index].name.clone()) + .collect::() + }); + + Ok(stop_area) + } + + /// Retrieves a vehicle journey by its identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the vehicle journey + /// + /// # Returns + /// ID of the specified vehicle journey + pub fn get_vehicle_journey_by_id(&self, idx: String) -> PyResult { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = &self.model; + + let vehicle_journey = rt.block_on(async { + let guard = model.current_model.read().await; + guard + .vehicle_journeys + .get_idx(&idx) + .iter() + .map(|index| guard.vehicle_journeys[*index].id.clone()) + .collect::() + }); + + Ok(vehicle_journey) + } + + /// Retrieves stop times for a specific vehicle journey + /// + /// # Arguments + /// * `idx` - Unique identifier for the vehicle journey + /// + /// # Returns + /// List of stop times associated with the specified vehicle journey + pub fn get_vehicle_journey_stop_times(&self, idx: String) -> PyResult> { + let rt = Runtime::new() + .map_err(|e| PyValueError::new_err(format!("Failed to create runtime: {}", e)))?; + + let model = &self.model; + + let vehicle_journey_stop_times = rt.block_on(async { + let guard = model.current_model.read().await; + guard + .vehicle_journeys + .get_idx(&idx) + .iter() + .flat_map(|index| guard.vehicle_journeys[*index].stop_times.iter().cloned()) + .map(PStopTime) + .collect::>() + }); + + Ok(vehicle_journey_stop_times) + } +} diff --git a/transit_model_python/src/modules/mod.rs b/transit_model_python/src/modules/mod.rs new file mode 100644 index 000000000..213444b1f --- /dev/null +++ b/transit_model_python/src/modules/mod.rs @@ -0,0 +1,2 @@ +pub mod downloadable_model; +pub mod python_transit_model; diff --git a/transit_model_python/src/modules/python_transit_model.rs b/transit_model_python/src/modules/python_transit_model.rs new file mode 100644 index 000000000..851ac9af7 --- /dev/null +++ b/transit_model_python/src/modules/python_transit_model.rs @@ -0,0 +1,267 @@ +// Copyright (C) 2024 Hove and/or its affiliates. +// +// This program is free software: you can redistribute it and/or modify it +// under the terms of the GNU Affero General Public License as published by the +// Free Software Foundation, version 3. + +// This program is distributed in the hope that it will be useful, but WITHOUT +// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more +// details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see + +//! PyO3 bindings for transit model data structures and operations +//! +//! Provides Python interfaces to access and manipulate transit model data +//! from NTFS (NeTEx France Standard) datasets. +//! + +use pyo3::{exceptions::PyValueError, prelude::*}; +use std::sync::Arc; +use transit_model as intern_transit_model; +use transit_model::model::Model; +use typed_index_collection::Id; + +use crate::PStopTime; + +/// Thread-safe wrapper for transit model data with Python bindings +/// +/// Provides read-only access to transit model components through +/// atomic reference counting for safe concurrent access. +#[pyclass] +pub struct PythonTransitModel { + /// Shared reference to the underlying transit model data + model: Arc, +} + +#[pymethods] +impl PythonTransitModel { + /// Creates a new transit model instance from NTFS data + /// + /// # Arguments + /// * `path` - Path to the NTFS dataset directory + /// + /// # Panics + /// Will panic if the NTFS data cannot be read from the specified path + /// + /// # Example + /// ```python + /// model = PythonTransitModel("/path/to/ntfs/data") + /// ``` + #[new] + pub fn new(path: &str) -> Self { + let transit_objects = + intern_transit_model::ntfs::read(path).expect("Failed to read transit objects"); + Self { + model: Arc::new(transit_objects), + } + } + + /// Retrieves line names by line identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the transit line + /// + /// # Returns + /// Vector of line names matching the identifier (empty if not found) + /// + /// # Example + /// ```python + /// line_names = model.get_lines("line:123") + /// ``` + pub fn get_lines(&self, idx: String) -> PyResult> { + Ok(self + .model + .lines + .get_idx(&idx) + .iter() + .map(|idx| self.model.lines[*idx].name.to_string()) + .collect()) + } + + /// Retrieves contributor names by contributor identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the contributor + /// + /// # Returns + /// Vector of contributor names matching the identifier (empty if not found) + pub fn get_contributors(&self, idx: String) -> PyResult> { + Ok(self + .model + .contributors + .get_idx(&idx) + .iter() + .map(|idx| self.model.contributors[*idx].name.to_string()) + .collect()) + } + + /// Retrieves network identifiers by network identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the network + /// + /// # Returns + /// Vector containing the network ID if found (empty if not found) + /// + /// # Note + /// Returns the same identifier provided as input when exists in the model + pub fn get_networks(&self, idx: String) -> PyResult> { + Ok(self + .model + .networks + .get_idx(&idx) + .iter() + .map(|idx| self.model.networks[*idx].id().to_string()) + .collect()) + } + + /// Retrieves stop area name by stop area identifier + /// + /// # Arguments + /// * `idx` - Unique identifier for the stop area + /// + /// # Returns + /// Concatenated string of stop area names (empty if not found) + pub fn get_stop_area_by_id(&self, idx: String) -> PyResult { + Ok(self + .model + .stop_areas + .get_idx(&idx) + .iter() + .map(|idx| self.model.stop_areas[*idx].name.clone()) + .collect()) + } + + /// Retrieves vehicle journey identifier by journey ID + /// + /// # Arguments + /// * `idx` - Unique identifier for the vehicle journey + /// + /// # Returns + /// Concatenated string of journey IDs (empty if not found) + pub fn get_vehicule_journey_by_id(&self, idx: String) -> PyResult { + Ok(self + .model + .vehicle_journeys + .get_idx(&idx) + .iter() + .map(|idx| self.model.vehicle_journeys[*idx].id.as_str()) + .collect()) + } + + /// Retrieves all stop times for a specific vehicle journey + /// + /// # Arguments + /// * `idx` - Unique identifier for the vehicle journey + /// + /// # Returns + /// Vector of StopTime objects for the specified journey (empty if not found) + pub fn get_vehicule_journey_stop_times(&self, idx: String) -> PyResult> { + Ok(self + .model + .vehicle_journeys + .get_idx(&idx) + .iter() + .flat_map(|idx| self.model.vehicle_journeys[*idx].stop_times.iter().cloned()) + .map(PStopTime) + .collect()) + } + + /// Filters stop times for a specific vehicle journey and stop point + /// + /// # Arguments + /// * `vehicule_id` - Vehicle journey identifier + /// * `stop_id` - Stop point identifier + /// + /// # Returns + /// Vector of matching StopTime objects + /// + /// # Errors + /// Returns PyValueError if either the stop point or vehicle journey is not found + pub fn get_vehicule_journey_stop_times_by_stop_id( + &self, + vehicule_id: String, + stop_id: String, + ) -> PyResult> { + let stop_point_idx = self + .model + .stop_points + .get_idx(&stop_id) + .ok_or_else(|| PyValueError::new_err("StopPoint not found"))?; + + let stop_times: Vec = self + .model + .vehicle_journeys + .get_idx(&vehicule_id) + .into_iter() + .flat_map(|idx| &self.model.vehicle_journeys[idx].stop_times) + .filter(|st| st.stop_point_idx == stop_point_idx) + .cloned() + .map(PStopTime) + .collect::>(); + + if stop_times.is_empty() { + Err(PyValueError::new_err("StopTime not found")) + } else { + Ok(stop_times) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_get_lines() { + let transit_objects = intern_transit_model::ntfs::read("../tests/fixtures/minimal_ntfs/") + .expect("Failed to read transit objects"); + let python_transit_model = PythonTransitModel { + model: Arc::new(transit_objects), + }; + let lines = python_transit_model.get_lines("M1".to_string()).unwrap(); + assert_eq!(lines, vec!["Metro 1".to_string(),]); + } + + #[test] + fn test_get_contributors() { + let transit_objects = intern_transit_model::ntfs::read("../tests/fixtures/minimal_ntfs/") + .expect("Failed to read transit objects"); + let python_transit_model = PythonTransitModel { + model: Arc::new(transit_objects), + }; + let contributors = python_transit_model + .get_contributors("TGC".to_string()) + .unwrap(); + assert_eq!(contributors, vec!["The Great Contributor".to_string(),]); + } + + #[test] + fn test_get_networks() { + let transit_objects = intern_transit_model::ntfs::read("../tests/fixtures/minimal_ntfs/") + .expect("Failed to read transit objects"); + let python_transit_model = PythonTransitModel { + model: Arc::new(transit_objects), + }; + let networks: Vec = python_transit_model + .get_networks("TGN".to_string()) + .unwrap(); + assert_eq!(networks, vec!["TGN".to_string(),]); + } + + #[test] + fn test_get_stop_area_by_id() { + let transit_objects = intern_transit_model::ntfs::read("../tests/fixtures/minimal_ntfs/") + .expect("Failed to read transit objects"); + let python_transit_model = PythonTransitModel { + model: Arc::new(transit_objects), + }; + let stop_area = python_transit_model + .get_stop_area_by_id("GDL".to_string()) + .unwrap(); + assert_eq!(stop_area, "Gare de Lyon".to_string()); + } +}