LocationIdentifiers.fetch_location_codes

LocationIdentifiers.fetch_location_codes(update=False, pickle_it=False, data_dir=None, verbose=False)[source]

Fetch CRS, NLC, TIPLOC, STANME and STANOX codes from local backup.

Parameters

  • update (bool) – whether to check on update and proceed to update the package data, defaults to False

  • pickle_it (bool) – whether to replace the current package data with newly collected data, defaults to False

  • data_dir (str or None) – name of package data folder, defaults to None

  • verbose (bool or int) – whether to print relevant information in console as the function runs, defaults to False

Returns

data of location codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.line_data import LocationIdentifiers

>>> lid = LocationIdentifiers()

>>> loc_codes = lid.fetch_location_codes()

>>> type(loc_codes)
<class 'dict'>
>>> print(list(loc_codes.keys()))
['Location codes',
 'Other systems',
 'Additional notes',
 'Last updated date']