SignalBoxes.fetch_prefix_codes

SignalBoxes.fetch_prefix_codes(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch signal box prefix codes from local backup.

Parameters

  • update (bool) – whether to do an update check (for the package data), defaults to False

  • pickle_it (bool) – whether to save the data as a pickle file, 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, defaults to False

Returns

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

Return type

dict

Example:

>>> from pyrcs.other_assets import SignalBoxes

>>> sb = SignalBoxes()

>>> # sb_prefix_codes_dat = sb.fetch_prefix_codes(update=True, verbose=True)
>>> sb_prefix_codes_dat = sb.fetch_prefix_codes()

>>> type(sb_prefix_codes_dat)
dict
>>> list(sb_prefix_codes_dat.keys())
['Signal boxes', 'Last updated date']

>>> print(sb.Key)
Signal boxes

>>> sb_prefix_codes = sb_prefix_codes_dat[sb.Key]

>>> type(sb_prefix_codes)
pandas.core.frame.DataFrame
>>> sb_prefix_codes.head()
  Code               Signal Box  ...            Closed        Control to
0   AF  Abbey Foregate Junction  ...
1   AJ           Abbey Junction  ...  16 February 1992     Nuneaton (NN)
2    R           Abbey Junction  ...  16 February 1992     Nuneaton (NN)
3   AW               Abbey Wood  ...      13 July 1975      Dartford (D)
4   AE         Abbey Works East  ...   1 November 1987  Port Talbot (PT)
[5 rows x 8 columns]