Depots.fetch_four_digit_pre_tops_codes

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

Fetch four-digit pre-TOPS 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 a folder where the pickle file is to be saved, defaults to None

  • verbose (bool or int) – whether to print relevant information in console, 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()

>>> # fdpt = depots.fetch_four_digit_pre_tops_codes(update=True, verbose=True)
>>> fdpt = depots.fetch_four_digit_pre_tops_codes()

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

>>> print(depots.FDPTKey)
Four digit pre-TOPS codes

>>> fdpt_codes = fdpt[depots.FDPTKey]

>>> type(fdpt_codes)
pandas.core.frame.DataFrame
>>> fdpt_codes.head()
   Code             Depot name          Region
0  2000             Accrington  London Midland
1  2001   Derby Litchurch Lane      Main Works
2  2003              Blackburn  London Midland
3  2004  Bolton Trinity Street  London Midland
4  2006                Burnley  London Midland