Add type hints to Timeseries Factory, add custom literal types (!121) · Merge requests · ghsc / National Geomagnetism Program / geomag-algorithms

Suggestion for type hinting in Timeseries Factory.

Biggest change: Parameters interval and type are hinted with custom literals

Literals are specified in geomag_types.py:

DataInterval = Literal["tenhertz", "second", ...]

DataType = Literal["adjusted", ...]

My thinking is that the geomag_types module holds custom types we would like specified more than their underlying data type. @jmfee thoughts?

Edited Aug 16, 2021 by Cain, Payton David

Add type hints to Timeseries Factory, add custom literal types