API Reference¶
This section provides detailed API documentation for all transit-parser modules.
Core Classes¶
GTFS¶
- GtfsFeed - Eager-loading GTFS feed
- LazyGtfsFeed - Lazy-loading GTFS feed
TXC¶
- TxcDocument - TransXChange document
- TxcToGtfsConverter - TXC to GTFS converter
Filtering¶
- GtfsFilter - Filtering and querying API
Schedule¶
- Schedule - Schedule container
- ScheduleRow - Individual schedule row
- ValidationConfig - Validation settings
- ValidationResult - Validation results
- DeadheadInferenceResult - Deadhead inference results
Data Models¶
All GTFS entities are exposed as Python classes:
| Class | Description |
|---|---|
Agency |
Transit agency |
Stop |
Transit stop/station |
Route |
Transit route |
Trip |
Individual trip |
StopTime |
Arrival/departure at a stop |
Calendar |
Service schedule |
CalendarDate |
Service exception |
Shape |
Route geometry |
Exceptions¶
See Exceptions for the complete exception hierarchy:
TransitParserError- Base exceptionGtfsError- GTFS-related errorsTxcError- TXC-related errorsConversionError- Conversion errorsFilterError- Filtering errors
Module Structure¶
transit_parser
├── GtfsFeed
├── LazyGtfsFeed
├── TxcDocument
├── TxcToGtfsConverter
├── ConversionOptions
├── ConversionResult
├── ConversionStats
├── Schedule
├── ScheduleRow
├── ValidationConfig
├── ValidationResult
├── DeadheadInferenceResult
├── Agency, Stop, Route, Trip, StopTime, Calendar, CalendarDate, Shape
├── TransitParserError, GtfsError, TxcError, ...
├── filtering
│ └── GtfsFilter
└── dataframes
└── GtfsDataFrames