1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | #!/usr/bin/python2.5 # Copyright (C) 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from agency import Agency from fareattribute import FareAttribute from farerule import FareRule from frequency import Frequency import loader import problems from route import Route import schedule from serviceperiod import ServicePeriod from shape import Shape from shapepoint import ShapePoint from stop import Stop from stoptime import StopTime from transfer import Transfer from trip import Trip class GtfsFactory(object): """A factory for the default GTFS objects""" _REQUIRED_MAPPING_FIELDS = ['classes', 'required', 'loading_order'] def __init__(self): self._class_mapping = { 'Agency': Agency, 'ServicePeriod': ServicePeriod, 'FareAttribute': FareAttribute, 'FareRule': FareRule, 'Frequency': Frequency, 'Shape': Shape, 'ShapePoint': ShapePoint, 'Stop': Stop, 'StopTime': StopTime, 'Route': Route, 'Transfer': Transfer, 'Trip': Trip, } self._file_mapping = { 'agency.txt': { 'required': True, 'loading_order': 0, 'classes': ['Agency'] }, 'calendar.txt': { 'required': False, 'loading_order': None, 'classes': ['ServicePeriod']}, 'calendar_dates.txt': { 'required': False, 'loading_order': None, 'classes': ['ServicePeriod']}, 'fare_attributes.txt': { 'required': False, 'loading_order': 50, 'classes': ['FareAttribute']}, 'fare_rules.txt': { 'required': False, 'loading_order': 60, 'classes': ['FareRule']}, 'frequencies.txt': { 'required': False, 'loading_order': 70, 'classes': ['Frequency']}, 'shapes.txt': { 'required': False, 'loading_order': None, 'classes': ['Shape', 'ShapePoint']}, 'stops.txt': { 'required': True, 'loading_order': 10, 'classes': ['Stop']}, 'stop_times.txt': { 'required': True, 'loading_order': None, 'classes': ['StopTime']}, 'routes.txt': { 'required': True, 'loading_order': 20, 'classes': ['Route']}, 'transfers.txt': { 'required': False, 'loading_order': 30, 'classes': ['Transfer']}, 'trips.txt': { 'required': True, 'loading_order': 40, 'classes': ['Trip']}, } def __getattr__(self, name): if name == 'Schedule': return schedule.Schedule if name == 'Loader': return loader.Loader if name in self._class_mapping: return self._class_mapping[name] raise AttributeError(name) def GetGtfsClassByFileName(self, filename): """Returns the transitfeed class corresponding to a GTFS file. Args: filename: The filename whose class is to be returned Raises: NonStandardMapping if the specified filename has more than one corresponding class """ if filename not in self._file_mapping: return None mapping = self._file_mapping[filename] class_list = mapping['classes'] if len(class_list) > 1: raise problems.NonStandardMapping(filename) else: return self._class_mapping[class_list[0]] def GetLoadingOrder(self): """Returns a list of filenames sorted by loading order. Only includes files that Loader's standardized loading knows how to load""" result = {} for filename, mapping in self._file_mapping.iteritems(): loading_order = mapping['loading_order'] if loading_order is not None: result[loading_order] = filename return list(result[key] for key in sorted(result)) def IsFileRequired(self, filename): """Returns true if a file is required by GTFS, false otherwise. Unknown files are, by definition, not required""" if filename not in self._file_mapping: return False mapping = self._file_mapping[filename] return mapping['required'] def GetKnownFilenames(self): """Returns a list of all known filenames""" return self._file_mapping.keys() def RemoveMapping(self, filename): """Removes an entry from the list of known filenames. An entry is identified by its filename. filename: The filename whose mapping is to be updated. """ if filename in self._file_mapping: del self._file_mapping[filename] def AddMapping(self, filename, new_mapping): """Adds an entry to the list of known filenames. Args: filename: The filename whose mapping is being added. new_mapping: A dictionary with the mapping to add. Must contain all fields in _REQUIRED_MAPPING_FIELDS. Raises: DuplicateMapping if the filename already exists in the mapping InvalidMapping if not all required fields are present """ for field in self._REQUIRED_MAPPING_FIELDS: if field not in new_mapping: raise problems.InvalidMapping(field) if filename in self.GetKnownFilenames(): raise problems.DuplicateMapping(filename) self._file_mapping[filename] = new_mapping def UpdateMapping(self, filename, mapping_update): """Updates an entry in the list of known filenames. An entry is identified by its filename. Args: filename: The filename whose mapping is to be updated mapping_update: A dictionary containing the fields to update and their new values. Raises: InexistentMapping if the filename does not exist in the mapping """ if filename not in self._file_mapping: raise problems.NonexistentMapping(filename) mapping = self._file_mapping[filename] mapping.update(mapping_update) def AddClass(self, class_name, gtfs_class): """Adds an entry to the list of known classes. Args: class_name: A string with name through which gtfs_class is to be made accessible. gtfs_class: The class to be added. Raises: DuplicateMapping if class_name is already present in the class mapping. """ if class_name in self._class_mapping: raise problems.DuplicateMapping(class_name) self._class_mapping[class_name] = gtfs_class def UpdateClass(self, class_name, gtfs_class): """Updates an entry in the list of known classes. Args: class_name: A string with the class name that is to be updated. gtfs_class: The new class Raises: NonexistentMapping if there is no class with the specified class_name. """ if class_name not in self._class_mapping: raise problems.NonexistentMapping(class_name) self._class_mapping[class_name] = gtfs_class def RemoveClass(self, class_name): """Removes an entry from the list of known classes. Args: class_name: A string with the class name that is to be removed. Raises: NonexistentMapping if there is no class with the specified class_name. """ if class_name not in self._class_mapping: raise problems.NonexistentMapping(class_name) del self._class_mapping[class_name] def GetProblemReporter(self): return problems.ProblemReporter() def GetGtfsFactory(): """Called by FeedValidator to retrieve this extension's GtfsFactory. Extensions will most likely only need to create an instance of transitfeed.GtfsFactory, call {Remove,Add,Update}Mapping as needed, and return that instance""" return GtfsFactory() |