Depots.fetch_four_digit_pre_tops_codes

Depots.fetch_four_digit_pre_tops_codes(update=False, pickle_it=False, data_dir=None, verbose=False)[source]

Fetch four-digit pre-TOPS 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) – whether to print relevant information in console as the function runs, defaults to False

Returns

data of two-character TOPS codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Depots

>>> depots = Depots()

>>> four_digit_pre_tops_codes_dat = depots.fetch_four_digit_pre_tops_codes()

>>> type(four_digit_pre_tops_codes_dat)
<class 'dict'>
>>> print(list(four_digit_pre_tops_codes_dat.keys()))
['Four digit pre-TOPS codes', 'Last updated date']

>>> four_digit_pre_tops_codes =             ...     four_digit_pre_tops_codes_dat['Four digit pre-TOPS codes']

>>> print(list(four_digit_pre_tops_codes.keys()))
['Main Works',
 'London Midland Region',
 'Western Region',
 'Southern Region',
 'Eastern Region',
 'Scottish Region']