Depots.fetch_depot_codes

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

Fetch depots 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 depot codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Depots

>>> depots = Depots()

>>> # depot_codes_dat = depots.fetch_depot_codes(update=True, verbose=True)
>>> depot_codes_dat = depots.fetch_depot_codes()

>>> type(depot_codes_dat)
dict
>>> list(depot_codes_dat.keys())
['Depots', 'Last updated date']

>>> print(depots.Key)
Depots

>>> type(depot_codes_dat[depots.Key])
dict
>>> list(depot_codes_dat[depots.Key].keys())
['1950 system (pre-TOPS) codes',
 'Four digit pre-TOPS codes',
 'GWR codes',
 'Two character TOPS codes']

>>> print(depots.FDPTKey)

>>> depot_codes_dat[depots.Key][depots.FDPTKey].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