Add / fix some comments

This commit is contained in:
Matthias 2018-12-16 14:14:17 +01:00
parent eb7034c7a7
commit 806ab3729f
2 changed files with 10 additions and 8 deletions

View File

@ -1,6 +1,7 @@
""" """
Module to handle data operations for freqtrade bot Module to handle data operations for freqtrade
""" """
# limit what's imported when using `from freqtrad.data import *`` # limit what's imported when using `from freqtrad.data import *``
__all__ = [ __all__ = [
'convert' 'convert'

View File

@ -69,10 +69,10 @@ def trim_tickerlist(tickerlist: List[Dict], timerange: TimeRange) -> List[Dict]:
def load_tickerdata_file( def load_tickerdata_file(
datadir: Optional[Path], pair: str, datadir: Optional[Path], pair: str,
ticker_interval: str, ticker_interval: str,
timerange: Optional[TimeRange] = None) -> Optional[List[Dict]]: timerange: Optional[TimeRange] = None) -> Optional[list]:
""" """
Load a pair from file, either .json.gz or .json Load a pair from file, either .json.gz or .json
:return dict(<pair>:<tickerlist>) or None if unsuccesful :return tickerlist or None if unsuccesful
""" """
path = make_testdata_path(datadir) path = make_testdata_path(datadir)
pair_s = pair.replace('/', '_') pair_s = pair.replace('/', '_')
@ -105,6 +105,7 @@ def load_pair_history(pair: str,
) -> DataFrame: ) -> DataFrame:
""" """
Loads cached ticker history for the given pair. Loads cached ticker history for the given pair.
:return: DataFrame with ohlcv data
""" """
pairdata = load_tickerdata_file(datadir, pair, ticker_interval, timerange=timerange) pairdata = load_tickerdata_file(datadir, pair, ticker_interval, timerange=timerange)
@ -145,7 +146,7 @@ def load_data(datadir: Optional[Path],
timerange: TimeRange = TimeRange(None, None, 0, 0)) -> Dict[str, DataFrame]: timerange: TimeRange = TimeRange(None, None, 0, 0)) -> Dict[str, DataFrame]:
""" """
Loads ticker history data for a list of pairs the given parameters Loads ticker history data for a list of pairs the given parameters
:return: dict :return: dict(<pair>:<tickerlist>)
""" """
result = {} result = {}
@ -185,9 +186,9 @@ def load_cached_data_for_updating(filename: Path, tick_interval: str,
if filename.is_file(): if filename.is_file():
with open(filename, "rt") as file: with open(filename, "rt") as file:
data = json_load(file) data = json_load(file)
# remove the last item, could be incomplete candle # remove the last item, could be incomplete candle
if data: if data:
data.pop() data.pop()
else: else:
data = [] data = []
@ -217,7 +218,7 @@ def download_pair_history(datadir: Optional[Path],
:param pair: pair to download :param pair: pair to download
:param tick_interval: ticker interval :param tick_interval: ticker interval
:param timerange: range of time to download :param timerange: range of time to download
:return: None :return: bool with success state
""" """
try: try: