tspy.data_structures.io.TimeSeriesReader module¶
-
class
tspy.data_structures.io.TimeSeriesReader.TimeSeriesReader¶ Bases:
objectinterface to represent reading time-series data from a data-source
Methods
close()close the connection to our source
end()end reading data
read(start, end, inclusive)read from a source between start and end
start()start reading data
-
abstract
close()¶ close the connection to our source
-
abstract
end()¶ end reading data
- Returns
- int
get the ending time-tick in the source data
-
abstract
read(start, end, inclusive)¶ read from a source between start and end
- Parameters
- startint
start of range (inclusive)
- endint
end of range (inclusive)
- inclusivebool, optional
if true, will use inclusive bounds (default is False)
- Returns
- iter
an iterator to a set of observations between floor(start) and ceiling(end) of our source
-
abstract
start()¶ start reading data
- Returns
- int
get the starting time-tick in the source data
-
abstract