Depots.fetch_two_char_tops_codes

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

Fetch two-character 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()

>>> # tct_dat = depots.fetch_two_char_tops_codes(update=True, verbose=True)
>>> tct_dat = depots.fetch_two_char_tops_codes()

>>> type(tct_dat)
dict
>>> list(tct_dat.keys())
['Two character TOPS codes', 'Last updated date']

>>> print(depots.TCTKey)
Two character TOPS codes

>>> tct_codes = tct_dat[depots.TCTKey]

>>> type(tct_codes)
pandas.core.frame.DataFrame
>>> tct_codes.head()
  Code click to sort  ...                Notes
0                 AB  ...          Closed 1987
1                 AB  ...
2                 AC  ...  Became WH from 1994
3                 AC  ...
4                 AD  ...
[5 rows x 5 columns]