Depots.fetch_depot_codes

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

Fetch depots 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 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']

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

>>> print(depot_codes_dat['Depots']['Four digit pre-TOPS 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