stable/freqtrade/plugins/pairlist/StaticPairList.py

70 lines
2.3 KiB
Python
Raw Normal View History

2018-11-30 05:34:56 +00:00
"""
2020-05-17 11:26:21 +00:00
Static Pair List provider
2018-11-30 05:34:56 +00:00
2020-05-17 11:26:21 +00:00
Provides pair white list as it configured in config
"""
2018-11-30 05:34:56 +00:00
import logging
from copy import deepcopy
from typing import Any, Dict, List
2018-12-05 19:44:56 +00:00
2022-09-18 11:20:36 +00:00
from freqtrade.constants import Config
from freqtrade.exchange.types import Tickers
from freqtrade.plugins.pairlist.IPairList import IPairList
2018-11-30 05:34:56 +00:00
2020-05-17 11:26:21 +00:00
2018-11-30 05:34:56 +00:00
logger = logging.getLogger(__name__)
2018-12-05 19:44:56 +00:00
class StaticPairList(IPairList):
2018-11-30 05:34:56 +00:00
def __init__(self, exchange, pairlistmanager,
2022-09-18 11:20:36 +00:00
config: Config, pairlistconfig: Dict[str, Any],
pairlist_pos: int) -> None:
super().__init__(exchange, pairlistmanager, config, pairlistconfig, pairlist_pos)
self._allow_inactive = self._pairlistconfig.get('allow_inactive', False)
@property
def needstickers(self) -> bool:
"""
Boolean property defining if tickers are necessary.
2020-11-24 19:24:51 +00:00
If no Pairlist requires tickers, an empty Dict is passed
as tickers argument to filter_pairlist
"""
return False
2018-12-03 19:31:25 +00:00
def short_desc(self) -> str:
"""
Short whitelist method description - used for startup-messages
-> Please overwrite in subclasses
"""
2019-11-09 06:07:33 +00:00
return f"{self.name}"
2018-12-03 19:31:25 +00:00
def gen_pairlist(self, tickers: Tickers) -> List[str]:
"""
Generate the pairlist
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: List of pairs
"""
if self._allow_inactive:
return self.verify_whitelist(
self._config['exchange']['pair_whitelist'], logger.info, keep_invalid=True
)
else:
2021-01-12 00:13:58 +00:00
return self._whitelist_for_active_markets(
self.verify_whitelist(self._config['exchange']['pair_whitelist'], logger.info))
def filter_pairlist(self, pairlist: List[str], tickers: Tickers) -> List[str]:
2018-11-30 05:34:56 +00:00
"""
2019-11-09 05:55:16 +00:00
Filters and sorts pairlist and returns the whitelist again.
Called on each bot iteration - please use internal caching if necessary
:param pairlist: pairlist to filter or sort
:param tickers: Tickers (from exchange.get_tickers). May be cached.
2019-11-09 05:55:16 +00:00
:return: new whitelist
2018-11-30 05:34:56 +00:00
"""
pairlist_ = deepcopy(pairlist)
for pair in self._config['exchange']['pair_whitelist']:
if pair not in pairlist_:
pairlist_.append(pair)
return pairlist_