adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve interface docstrings for analyze functions

Browse Source
This commit is contained in:
Matthias
2020-06-18 07:05:06 +02:00
parent f2a778d294
commit 48225e0d80
1 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
freqtrade/strategy/interface.py
View File

@@ -346,7 +346,7 @@ class IStrategy(ABC):
return dataframe return dataframe
def analyze_pair(self, pair: str): def analyze_pair(self, pair: str) -> None:
""" """
Fetch data for this pair from dataprovider and analyze. Fetch data for this pair from dataprovider and analyze.
Stores the dataframe into the dataprovider. Stores the dataframe into the dataprovider.
@@ -376,7 +376,11 @@ class IStrategy(ABC):
logger.warning('Empty dataframe for pair %s', pair) logger.warning('Empty dataframe for pair %s', pair)
return return
def analyze(self, pairs: List[str]): def analyze(self, pairs: List[str]) -> None:
"""
Analyze all pairs using analyze_pair().
:param pairs: List of pairs to analyze
"""
for pair in pairs: for pair in pairs:
self.analyze_pair(pair) self.analyze_pair(pair)
@@ -386,7 +390,9 @@ class IStrategy(ABC):
return len(dataframe), dataframe["close"].iloc[-1], dataframe["date"].iloc[-1] return len(dataframe), dataframe["close"].iloc[-1], dataframe["date"].iloc[-1]
def assert_df(self, dataframe: DataFrame, df_len: int, df_close: float, df_date: datetime): def assert_df(self, dataframe: DataFrame, df_len: int, df_close: float, df_date: datetime):
""" make sure data is unmodified """ """
Ensure dataframe (length, last candle) was not modified, and has all elements we need.
"""
message = "" message = ""
if df_len != len(dataframe): if df_len != len(dataframe):
message = "length" message = "length"
@@ -403,10 +409,9 @@ class IStrategy(ABC):
def get_signal(self, pair: str, timeframe: str) -> Tuple[bool, bool]: def get_signal(self, pair: str, timeframe: str) -> Tuple[bool, bool]:
""" """
Calculates current signal based based on the buy / sell columns of the dataframe. Calculates current signal based based on the buy / sell columns of the dataframe.
Used by Bot to get the latest signal Used by Bot to get the signal to buy or sell
:param pair: pair in format ANT/BTC :param pair: pair in format ANT/BTC
:param timeframe: timeframe to use :param timeframe: timeframe to use
:param dataframe: Dataframe to analyze
:return: (Buy, Sell) A bool-tuple indicating buy/sell signal :return: (Buy, Sell) A bool-tuple indicating buy/sell signal
""" """
if not self.dp: if not self.dp:
@@ -429,8 +434,7 @@ class IStrategy(ABC):
if latest_date < (arrow.utcnow().shift(minutes=-(timeframe_minutes * 2 + offset))): if latest_date < (arrow.utcnow().shift(minutes=-(timeframe_minutes * 2 + offset))):
logger.warning( logger.warning(
'Outdated history for pair %s. Last tick is %s minutes old', 'Outdated history for pair %s. Last tick is %s minutes old',
pair, pair, (arrow.utcnow() - latest_date).seconds // 60
(arrow.utcnow() - latest_date).seconds // 60
) )
return False, False return False, False