Stations.fetch_catalogue¶

Stations.fetch_catalogue(update=False, dump_dir=None, verbose=False, **kwargs)[source]¶

Fetches the catalogue of railway station data.

Parameters:

update (bool) – Whether to check for updates to the package data; defaults to False.
dump_dir (str | None) – The path to a directory where the data file will be saved; defaults to None.
verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

Returns:

A dictionary containing the catalogue of railway station data, or None if no data catalogue is collected.

Return type:

dict | None

Examples:

>>> from pyrcs.other_assets import Stations  # from pyrcs import Stations
>>> stn = Stations()
>>> stn_data_cat = stn.fetch_catalogue()
>>> type(stn_data_cat)
dict
>>> list(stn_data_cat.keys())
['Mileages, operators and grid coordinates',
 'Bilingual names',
 'Sponsored signs',
 'Not served by SFO',
 'International',
 'Trivia',
 'Access rights',
 'Barrier error codes',
 'London Underground',
 'Railnet']