Depots.collect_gwr_codes¶

Depots.collect_gwr_codes(confirmation_required=True, verbose=False)[source]¶

Collects Great Western Railway (GWR) depot codes from the source web page.

Parameters:

confirmation_required (bool) – Whether user confirmation is required before proceeding; defaults to True.
verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

Returns:

A dictionary containing the GWR depot codes and the date they were last updated, or None if no data is collected.

Return type:

dict | None

Examples:

>>> from pyrcs.other_assets import Depots  # from pyrcs import Depots
>>> depots = Depots()
>>> gwr_codes = depots.collect_gwr_codes()
To collect data of GWR codes
? [No]|Yes: yes
>>> type(gwr_codes)
dict
>>> list(gwr_codes.keys())
['GWR codes', 'Last updated date']
>>> depots.KEY_TO_GWR
'GWR codes'
>>> gwr_codes_dat = gwr_codes[depots.KEY_TO_GWR]
>>> type(gwr_codes_dat)
dict
>>> list(gwr_codes_dat.keys())
['Alphabetical codes', 'Numerical codes']
>>> gwr_alpha_codes = gwr_codes_dat['Alphabetical codes']
>>> type(gwr_alpha_codes)
pandas.core.frame.DataFrame
>>> gwr_alpha_codes.head()
    Code   Depot name
0  ABEEG     Aberbeeg
1    ABG     Aberbeeg
2    AYN    Abercynon
3   ABDR     Aberdare
4    ABH  Aberystwyth