stable/tests/plugins/test_pairlist.py

807 lines
35 KiB
Python
Raw Normal View History

# pragma pylint: disable=missing-docstring,C0103,protected-access
2018-01-28 07:38:41 +00:00
2019-03-05 18:46:03 +00:00
from unittest.mock import MagicMock, PropertyMock
import pytest
2018-12-03 19:48:51 +00:00
from freqtrade.constants import AVAILABLE_PAIRLISTS
from freqtrade.exceptions import OperationalException
from freqtrade.plugins.pairlistmanager import PairListManager
from freqtrade.resolvers import PairListResolver
from tests.conftest import get_patched_freqtradebot, log_has, log_has_re
2018-07-04 07:31:35 +00:00
@pytest.fixture(scope="function")
def whitelist_conf(default_conf):
default_conf['stake_currency'] = 'BTC'
default_conf['exchange']['pair_whitelist'] = [
2018-03-24 19:42:51 +00:00
'ETH/BTC',
'TKN/BTC',
'TRST/BTC',
'SWT/BTC',
'BCC/BTC',
'HOT/BTC',
]
default_conf['exchange']['pair_blacklist'] = [
2018-03-24 19:42:51 +00:00
'BLK/BTC'
]
2019-11-09 08:31:17 +00:00
default_conf['pairlists'] = [
{
"method": "VolumePairList",
2019-11-19 05:34:54 +00:00
"number_assets": 5,
"sort_key": "quoteVolume",
2019-11-09 08:31:17 +00:00
},
]
return default_conf
2019-11-09 08:31:17 +00:00
2020-05-21 09:41:00 +00:00
@pytest.fixture(scope="function")
def whitelist_conf_2(default_conf):
default_conf['stake_currency'] = 'BTC'
default_conf['exchange']['pair_whitelist'] = [
'ETH/BTC', 'TKN/BTC', 'BLK/BTC', 'LTC/BTC',
'BTT/BTC', 'HOT/BTC', 'FUEL/BTC', 'XRP/BTC'
]
default_conf['exchange']['pair_blacklist'] = [
'BLK/BTC'
]
default_conf['pairlists'] = [
# { "method": "StaticPairList"},
{
"method": "VolumePairList",
"number_assets": 5,
"sort_key": "quoteVolume",
"refresh_period": 0,
},
]
return default_conf
2020-06-24 22:58:12 +00:00
@pytest.fixture(scope="function")
2020-11-21 14:51:39 +00:00
def whitelist_conf_agefilter(default_conf):
2020-06-24 22:58:12 +00:00
default_conf['stake_currency'] = 'BTC'
default_conf['exchange']['pair_whitelist'] = [
'ETH/BTC', 'TKN/BTC', 'BLK/BTC', 'LTC/BTC',
'BTT/BTC', 'HOT/BTC', 'FUEL/BTC', 'XRP/BTC'
]
default_conf['exchange']['pair_blacklist'] = [
'BLK/BTC'
]
default_conf['pairlists'] = [
{
"method": "VolumePairList",
"number_assets": 5,
"sort_key": "quoteVolume",
"refresh_period": 0,
},
{
"method": "AgeFilter",
"min_days_listed": 2
}
]
return default_conf
2019-11-09 08:31:17 +00:00
@pytest.fixture(scope="function")
2019-11-09 08:42:34 +00:00
def static_pl_conf(whitelist_conf):
whitelist_conf['pairlists'] = [
2019-11-09 08:31:17 +00:00
{
"method": "StaticPairList",
},
]
2019-11-09 08:42:34 +00:00
return whitelist_conf
2020-11-19 18:45:22 +00:00
def test_log_cached(mocker, static_pl_conf, markets, tickers):
2020-04-14 18:39:54 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
freqtrade = get_patched_freqtradebot(mocker, static_pl_conf)
logmock = MagicMock()
# Assign starting whitelist
2020-05-19 00:35:01 +00:00
pl = freqtrade.pairlists._pairlist_handlers[0]
2020-11-22 10:49:41 +00:00
pl.log_once('Hello world', logmock)
2020-04-14 18:39:54 +00:00
assert logmock.call_count == 1
2020-11-22 10:49:41 +00:00
pl.log_once('Hello world', logmock)
2020-04-14 18:39:54 +00:00
assert logmock.call_count == 1
assert pl._log_cache.currsize == 1
assert ('Hello world',) in pl._log_cache._Cache__data
2020-11-22 10:49:41 +00:00
pl.log_once('Hello world2', logmock)
2020-04-14 18:39:54 +00:00
assert logmock.call_count == 2
assert pl._log_cache.currsize == 2
2018-12-05 19:45:11 +00:00
def test_load_pairlist_noexist(mocker, markets, default_conf):
2020-05-15 00:41:41 +00:00
freqtrade = get_patched_freqtradebot(mocker, default_conf)
2019-03-10 14:26:55 +00:00
mocker.patch('freqtrade.exchange.Exchange.markets', PropertyMock(return_value=markets))
2020-05-15 00:41:41 +00:00
plm = PairListManager(freqtrade.exchange, default_conf)
2019-07-12 20:45:49 +00:00
with pytest.raises(OperationalException,
match=r"Impossible to load Pairlist 'NonexistingPairList'. "
r"This class does not exist or contains Python code errors."):
2020-05-15 00:41:41 +00:00
PairListResolver.load_pairlist('NonexistingPairList', freqtrade.exchange, plm,
default_conf, {}, 1)
2018-12-05 19:45:11 +00:00
2019-11-09 08:31:17 +00:00
def test_refresh_market_pair_not_in_whitelist(mocker, markets, static_pl_conf):
2020-05-15 00:41:41 +00:00
freqtrade = get_patched_freqtradebot(mocker, static_pl_conf)
2019-03-05 18:46:03 +00:00
mocker.patch('freqtrade.exchange.Exchange.markets', PropertyMock(return_value=markets))
2020-05-15 00:41:41 +00:00
freqtrade.pairlists.refresh_pairlist()
# List ordered by BaseVolume
2018-03-24 19:42:51 +00:00
whitelist = ['ETH/BTC', 'TKN/BTC']
# Ensure all except those in whitelist are removed
2020-05-15 00:41:41 +00:00
assert set(whitelist) == set(freqtrade.pairlists.whitelist)
# Ensure config dict hasn't been changed
2019-11-09 08:31:17 +00:00
assert (static_pl_conf['exchange']['pair_whitelist'] ==
2020-05-15 00:41:41 +00:00
freqtrade.config['exchange']['pair_whitelist'])
2018-01-02 12:46:16 +00:00
2019-11-09 08:42:34 +00:00
def test_refresh_static_pairlist(mocker, markets, static_pl_conf):
2020-05-15 00:41:41 +00:00
freqtrade = get_patched_freqtradebot(mocker, static_pl_conf)
2019-11-09 08:31:17 +00:00
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
exchange_has=MagicMock(return_value=True),
markets=PropertyMock(return_value=markets),
)
2020-05-15 00:41:41 +00:00
freqtrade.pairlists.refresh_pairlist()
# List ordered by BaseVolume
2018-03-24 19:42:51 +00:00
whitelist = ['ETH/BTC', 'TKN/BTC']
# Ensure all except those in whitelist are removed
2020-05-15 00:41:41 +00:00
assert set(whitelist) == set(freqtrade.pairlists.whitelist)
assert static_pl_conf['exchange']['pair_blacklist'] == freqtrade.pairlists.blacklist
def test_refresh_pairlist_dynamic(mocker, shitcoinmarkets, tickers, whitelist_conf):
2018-03-26 09:24:20 +00:00
mocker.patch.multiple(
2018-06-17 17:54:51 +00:00
'freqtrade.exchange.Exchange',
2018-03-26 09:24:20 +00:00
get_tickers=tickers,
2019-11-09 08:31:17 +00:00
exchange_has=MagicMock(return_value=True),
2018-03-26 09:24:20 +00:00
)
2020-05-15 00:41:41 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
# Remock markets with shitcoinmarkets since get_patched_freqtradebot uses the markets fixture
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=shitcoinmarkets),
2020-05-21 09:41:00 +00:00
)
# argument: use the whitelist dynamically by exchange-volume
2019-11-14 19:12:41 +00:00
whitelist = ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC', 'HOT/BTC']
2020-05-15 00:41:41 +00:00
freqtrade.pairlists.refresh_pairlist()
assert whitelist == freqtrade.pairlists.whitelist
2020-05-21 09:41:00 +00:00
whitelist_conf['pairlists'] = [{'method': 'VolumePairList'}]
with pytest.raises(OperationalException,
match=r'`number_assets` not specified. Please check your configuration '
r'for "pairlist.config.number_assets"'):
2020-05-15 00:41:41 +00:00
PairListManager(freqtrade.exchange, whitelist_conf)
2020-05-21 09:41:00 +00:00
def test_refresh_pairlist_dynamic_2(mocker, shitcoinmarkets, tickers, whitelist_conf_2):
tickers_dict = tickers()
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
exchange_has=MagicMock(return_value=True),
)
# Remove caching of ticker data to emulate changing volume by the time of second call
mocker.patch.multiple(
'freqtrade.plugins.pairlistmanager.PairListManager',
2020-05-21 09:41:00 +00:00
_get_cached_tickers=MagicMock(return_value=tickers_dict),
)
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf_2)
# Remock markets with shitcoinmarkets since get_patched_freqtradebot uses the markets fixture
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=shitcoinmarkets),
)
whitelist = ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC', 'HOT/BTC']
freqtrade.pairlists.refresh_pairlist()
assert whitelist == freqtrade.pairlists.whitelist
whitelist = ['FUEL/BTC', 'ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC']
tickers_dict['FUEL/BTC']['quoteVolume'] = 10000.0
freqtrade.pairlists.refresh_pairlist()
assert whitelist == freqtrade.pairlists.whitelist
2018-12-04 06:16:34 +00:00
def test_VolumePairList_refresh_empty(mocker, markets_empty, whitelist_conf):
2019-11-09 08:42:34 +00:00
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
exchange_has=MagicMock(return_value=True),
)
2020-05-15 00:41:41 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
2019-03-05 18:46:03 +00:00
mocker.patch('freqtrade.exchange.Exchange.markets', PropertyMock(return_value=markets_empty))
# argument: use the whitelist dynamically by exchange-volume
whitelist = []
whitelist_conf['exchange']['pair_whitelist'] = []
2020-05-15 00:41:41 +00:00
freqtrade.pairlists.refresh_pairlist()
pairslist = whitelist_conf['exchange']['pair_whitelist']
assert set(whitelist) == set(pairslist)
2020-05-22 13:42:02 +00:00
@pytest.mark.parametrize("pairlists,base_currency,whitelist_result", [
2020-05-17 23:37:03 +00:00
# VolumePairList only
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC', 'HOT/BTC']),
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"}],
2020-07-21 18:34:19 +00:00
"USDT", ['ETH/USDT', 'NANO/USDT', 'ADAHALF/USDT', 'ADADOUBLE/USDT']),
2020-05-17 23:37:03 +00:00
# No pair for ETH, VolumePairList
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"}],
2020-05-22 13:42:02 +00:00
"ETH", []),
2020-05-17 23:37:03 +00:00
# No pair for ETH, StaticPairList
([{"method": "StaticPairList"}],
2020-05-22 13:42:02 +00:00
"ETH", []),
2020-05-17 23:37:03 +00:00
# No pair for ETH, all handlers
([{"method": "StaticPairList"},
{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
2020-06-24 22:58:12 +00:00
{"method": "AgeFilter", "min_days_listed": 2},
2020-05-17 23:37:03 +00:00
{"method": "PrecisionFilter"},
{"method": "PriceFilter", "low_price_ratio": 0.03},
2020-05-18 20:48:06 +00:00
{"method": "SpreadFilter", "max_spread_ratio": 0.005},
{"method": "ShuffleFilter"}, {"method": "PerformanceFilter"}],
2020-05-22 13:42:02 +00:00
"ETH", []),
2020-06-24 22:58:12 +00:00
# AgeFilter and VolumePairList (require 2 days only, all should pass age test)
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "AgeFilter", "min_days_listed": 2}],
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC', 'HOT/BTC']),
# AgeFilter and VolumePairList (require 10 days, all should fail age test)
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "AgeFilter", "min_days_listed": 10}],
"BTC", []),
# Precisionfilter and quote volume
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "PrecisionFilter"}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC']),
2019-11-19 05:41:05 +00:00
# PriceFilter and VolumePairList
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
2019-11-19 05:41:05 +00:00
{"method": "PriceFilter", "low_price_ratio": 0.03}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC']),
# PriceFilter and VolumePairList
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "PriceFilter", "low_price_ratio": 0.03}],
2020-05-22 13:42:02 +00:00
"USDT", ['ETH/USDT', 'NANO/USDT']),
# Hot is removed by precision_filter, Fuel by low_price_ratio, Ripple by min_price.
2019-11-14 19:12:41 +00:00
([{"method": "VolumePairList", "number_assets": 6, "sort_key": "quoteVolume"},
{"method": "PrecisionFilter"},
{"method": "PriceFilter", "low_price_ratio": 0.02, "min_price": 0.01}],
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC']),
# Hot is removed by precision_filter, Fuel by low_price_ratio, Ethereum by max_price.
([{"method": "VolumePairList", "number_assets": 6, "sort_key": "quoteVolume"},
{"method": "PrecisionFilter"},
{"method": "PriceFilter", "low_price_ratio": 0.02, "max_price": 0.05}],
"BTC", ['TKN/BTC', 'LTC/BTC', 'XRP/BTC']),
# HOT and XRP are removed because below 1250 quoteVolume
([{"method": "VolumePairList", "number_assets": 5,
"sort_key": "quoteVolume", "min_value": 1250}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC']),
2020-05-17 23:37:03 +00:00
# StaticPairlist only
([{"method": "StaticPairList"}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'HOT/BTC']),
# Static Pairlist before VolumePairList - sorting changes
# SpreadFilter
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
2020-05-18 20:48:06 +00:00
{"method": "SpreadFilter", "max_spread_ratio": 0.005}],
2020-05-22 13:42:02 +00:00
"USDT", ['ETH/USDT']),
2020-05-17 23:37:03 +00:00
# ShuffleFilter
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "ShuffleFilter", "seed": 77}],
2020-07-21 18:34:19 +00:00
"USDT", ['ADADOUBLE/USDT', 'ETH/USDT', 'NANO/USDT', 'ADAHALF/USDT']),
2020-05-17 23:37:03 +00:00
# ShuffleFilter, other seed
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "ShuffleFilter", "seed": 42}],
2020-07-21 18:34:19 +00:00
"USDT", ['ADAHALF/USDT', 'NANO/USDT', 'ADADOUBLE/USDT', 'ETH/USDT']),
2020-05-17 23:37:03 +00:00
# ShuffleFilter, no seed
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "ShuffleFilter"}],
2020-06-24 22:58:12 +00:00
"USDT", 3), # whitelist_result is integer -- check only length of randomized pairlist
# AgeFilter only
([{"method": "AgeFilter", "min_days_listed": 2}],
"BTC", 'filter_at_the_beginning'), # OperationalException expected
# PrecisionFilter after StaticPairList
([{"method": "StaticPairList"},
{"method": "PrecisionFilter"}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC']),
# PrecisionFilter only
([{"method": "PrecisionFilter"}],
"BTC", 'filter_at_the_beginning'), # OperationalException expected
# PriceFilter after StaticPairList
([{"method": "StaticPairList"},
{"method": "PriceFilter", "low_price_ratio": 0.02, "min_price": 0.000001, "max_price": 0.1}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC']),
# PriceFilter only
([{"method": "PriceFilter", "low_price_ratio": 0.02}],
"BTC", 'filter_at_the_beginning'), # OperationalException expected
# ShuffleFilter after StaticPairList
([{"method": "StaticPairList"},
{"method": "ShuffleFilter", "seed": 42}],
2020-05-22 13:42:02 +00:00
"BTC", ['TKN/BTC', 'ETH/BTC', 'HOT/BTC']),
# ShuffleFilter only
([{"method": "ShuffleFilter", "seed": 42}],
"BTC", 'filter_at_the_beginning'), # OperationalException expected
2020-11-29 16:30:43 +00:00
# PerformanceFilter after StaticPairList
([{"method": "StaticPairList"},
2020-11-28 06:39:18 +00:00
{"method": "PerformanceFilter"}],
2020-11-28 07:34:40 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'HOT/BTC']),
2020-11-28 06:38:06 +00:00
# PerformanceFilter only
2020-11-28 06:39:18 +00:00
([{"method": "PerformanceFilter"}],
2020-11-28 23:17:40 +00:00
"BTC", 'filter_at_the_beginning'), # OperationalException expected
# SpreadFilter after StaticPairList
([{"method": "StaticPairList"},
{"method": "SpreadFilter", "max_spread_ratio": 0.005}],
2020-05-22 13:42:02 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC']),
# SpreadFilter only
([{"method": "SpreadFilter", "max_spread_ratio": 0.005}],
"BTC", 'filter_at_the_beginning'), # OperationalException expected
# Static Pairlist after VolumePairList, on a non-first position
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "StaticPairList"}],
"BTC", 'static_in_the_middle'),
2020-07-21 18:34:19 +00:00
([{"method": "VolumePairList", "number_assets": 20, "sort_key": "quoteVolume"},
{"method": "PriceFilter", "low_price_ratio": 0.02}],
"USDT", ['ETH/USDT', 'NANO/USDT']),
2020-11-21 14:39:04 +00:00
([{"method": "StaticPairList"},
{"method": "RangeStabilityFilter", "lookback_days": 10,
"min_rate_of_change": 0.01, "refresh_period": 1440}],
2020-11-21 14:39:04 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'HOT/BTC']),
])
def test_VolumePairList_whitelist_gen(mocker, whitelist_conf, shitcoinmarkets, tickers,
2020-12-15 19:49:46 +00:00
ohlcv_history, pairlists, base_currency,
2020-06-24 22:58:12 +00:00
whitelist_result, caplog) -> None:
whitelist_conf['pairlists'] = pairlists
2020-05-15 00:59:13 +00:00
whitelist_conf['stake_currency'] = base_currency
2019-10-29 09:39:27 +00:00
2020-12-15 19:49:46 +00:00
ohlcv_data = {
('ETH/BTC', '1d'): ohlcv_history,
('TKN/BTC', '1d'): ohlcv_history,
('LTC/BTC', '1d'): ohlcv_history,
('XRP/BTC', '1d'): ohlcv_history,
('HOT/BTC', '1d'): ohlcv_history,
}
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
2019-11-09 12:40:36 +00:00
if whitelist_result == 'static_in_the_middle':
with pytest.raises(OperationalException,
match=r"StaticPairList can only be used in the first position "
r"in the list of Pairlist Handlers."):
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
return
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
2019-11-09 12:40:36 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
get_tickers=tickers,
2020-06-24 22:58:12 +00:00
markets=PropertyMock(return_value=shitcoinmarkets)
2019-11-09 12:40:36 +00:00
)
2020-06-24 22:58:12 +00:00
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
2020-12-15 19:49:46 +00:00
refresh_latest_ohlcv=MagicMock(return_value=ohlcv_data),
2020-06-24 22:58:12 +00:00
)
# Provide for PerformanceFilter's dependency
mocker.patch.multiple('freqtrade.persistence.Trade',
get_overall_performance=MagicMock(return_value=[])
2020-11-28 07:49:46 +00:00
)
2020-05-22 13:42:02 +00:00
# Set whitelist_result to None if pairlist is invalid and should produce exception
if whitelist_result == 'filter_at_the_beginning':
with pytest.raises(OperationalException,
match=r"This Pairlist Handler should not be used at the first position "
r"in the list of Pairlist Handlers."):
freqtrade.pairlists.refresh_pairlist()
2020-05-17 23:37:03 +00:00
else:
freqtrade.pairlists.refresh_pairlist()
whitelist = freqtrade.pairlists.whitelist
assert isinstance(whitelist, list)
# Verify length of pairlist matches (used for ShuffleFilter without seed)
if type(whitelist_result) is list:
assert whitelist == whitelist_result
else:
len(whitelist) == whitelist_result
for pairlist in pairlists:
2020-06-24 22:58:12 +00:00
if pairlist['method'] == 'AgeFilter' and pairlist['min_days_listed'] and \
2020-12-15 19:49:46 +00:00
len(ohlcv_history) <= pairlist['min_days_listed']:
2020-07-02 09:38:38 +00:00
assert log_has_re(r'^Removed .* from whitelist, because age .* is less than '
2020-06-24 22:58:12 +00:00
r'.* day.*', caplog)
if pairlist['method'] == 'PrecisionFilter' and whitelist_result:
assert log_has_re(r'^Removed .* from whitelist, because stop price .* '
r'would be <= stop limit.*', caplog)
if pairlist['method'] == 'PriceFilter' and whitelist_result:
assert (log_has_re(r'^Removed .* from whitelist, because 1 unit is .*%$', caplog) or
log_has_re(r'^Removed .* from whitelist, '
r'because last price < .*%$', caplog) or
log_has_re(r'^Removed .* from whitelist, '
r'because last price > .*%$', caplog) or
log_has_re(r"^Removed .* from whitelist, because ticker\['last'\] "
r"is empty.*", caplog))
if pairlist['method'] == 'VolumePairList':
logmsg = ("DEPRECATED: using any key other than quoteVolume for "
"VolumePairList is deprecated.")
if pairlist['sort_key'] != 'quoteVolume':
assert log_has(logmsg, caplog)
else:
assert not log_has(logmsg, caplog)
2020-11-28 04:18:49 +00:00
def test_PrecisionFilter_error(mocker, whitelist_conf) -> None:
whitelist_conf['pairlists'] = [{"method": "StaticPairList"}, {"method": "PrecisionFilter"}]
del whitelist_conf['stoploss']
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
with pytest.raises(OperationalException,
match=r"PrecisionFilter can only work with stoploss defined\..*"):
PairListManager(MagicMock, whitelist_conf)
def test_gen_pair_whitelist_not_supported(mocker, default_conf, tickers) -> None:
2020-05-21 09:41:00 +00:00
default_conf['pairlists'] = [{'method': 'VolumePairList', 'number_assets': 10}]
2019-11-09 12:40:36 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
get_tickers=tickers,
exchange_has=MagicMock(return_value=False),
)
2020-05-21 09:41:00 +00:00
with pytest.raises(OperationalException,
match=r'Exchange does not support dynamic whitelist.*'):
2018-12-03 19:00:18 +00:00
get_patched_freqtradebot(mocker, default_conf)
2018-12-03 19:48:51 +00:00
@pytest.mark.parametrize("pairlist", AVAILABLE_PAIRLISTS)
2018-12-04 06:16:34 +00:00
def test_pairlist_class(mocker, whitelist_conf, markets, pairlist):
2019-11-09 08:42:34 +00:00
whitelist_conf['pairlists'][0]['method'] = pairlist
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True)
)
2018-12-03 19:48:51 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
2018-12-04 06:16:34 +00:00
2019-11-09 13:00:32 +00:00
assert freqtrade.pairlists.name_list == [pairlist]
2019-11-09 08:42:34 +00:00
assert pairlist in str(freqtrade.pairlists.short_desc())
2018-12-04 06:16:34 +00:00
assert isinstance(freqtrade.pairlists.whitelist, list)
assert isinstance(freqtrade.pairlists.blacklist, list)
2019-03-17 17:18:44 +00:00
@pytest.mark.parametrize("pairlist", AVAILABLE_PAIRLISTS)
@pytest.mark.parametrize("whitelist,log_message", [
(['ETH/BTC', 'TKN/BTC'], ""),
# TRX/ETH not in markets
(['ETH/BTC', 'TKN/BTC', 'TRX/ETH'], "is not compatible with exchange"),
# wrong stake
(['ETH/BTC', 'TKN/BTC', 'ETH/USDT'], "is not compatible with your stake currency"),
# BCH/BTC not available
(['ETH/BTC', 'TKN/BTC', 'BCH/BTC'], "is not compatible with exchange"),
# BTT/BTC is inactive
(['ETH/BTC', 'TKN/BTC', 'BTT/BTC'], "Market is not active"),
# XLTCUSDT is not a valid pair
(['ETH/BTC', 'TKN/BTC', 'XLTCUSDT'], "is not tradable with Freqtrade"),
2019-03-17 17:18:44 +00:00
])
def test__whitelist_for_active_markets(mocker, whitelist_conf, markets, pairlist, whitelist, caplog,
2019-11-09 12:40:36 +00:00
log_message, tickers):
whitelist_conf['pairlists'][0]['method'] = pairlist
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
2019-03-17 17:18:44 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
caplog.clear()
2018-12-04 06:16:34 +00:00
2019-11-09 12:40:36 +00:00
# Assign starting whitelist
2020-05-19 00:35:01 +00:00
pairlist_handler = freqtrade.pairlists._pairlist_handlers[0]
new_whitelist = pairlist_handler._whitelist_for_active_markets(whitelist)
2018-12-04 06:16:34 +00:00
2019-03-17 17:18:44 +00:00
assert set(new_whitelist) == set(['ETH/BTC', 'TKN/BTC'])
assert log_message in caplog.text
2019-11-09 13:44:39 +00:00
2020-06-10 17:57:47 +00:00
@pytest.mark.parametrize("pairlist", AVAILABLE_PAIRLISTS)
2020-11-28 04:18:49 +00:00
def test__whitelist_for_active_markets_empty(mocker, whitelist_conf, pairlist, tickers):
2020-06-10 17:57:47 +00:00
whitelist_conf['pairlists'][0]['method'] = pairlist
mocker.patch('freqtrade.exchange.Exchange.exchange_has', return_value=True)
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=None),
get_tickers=tickers
)
# Assign starting whitelist
pairlist_handler = freqtrade.pairlists._pairlist_handlers[0]
with pytest.raises(OperationalException, match=r'Markets not loaded.*'):
pairlist_handler._whitelist_for_active_markets(['ETH/BTC'])
2020-11-28 04:18:49 +00:00
def test_volumepairlist_invalid_sortvalue(mocker, whitelist_conf):
2019-11-19 05:34:54 +00:00
whitelist_conf['pairlists'][0].update({"sort_key": "asdf"})
2019-11-09 13:44:39 +00:00
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
with pytest.raises(OperationalException,
match=r"key asdf not in .*"):
get_patched_freqtradebot(mocker, whitelist_conf)
def test_volumepairlist_caching(mocker, markets, whitelist_conf, tickers):
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
2020-05-15 00:41:41 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
2020-05-19 00:35:01 +00:00
assert freqtrade.pairlists._pairlist_handlers[0]._last_refresh == 0
2019-11-09 18:45:09 +00:00
assert tickers.call_count == 0
2020-05-15 00:41:41 +00:00
freqtrade.pairlists.refresh_pairlist()
2019-11-09 18:45:09 +00:00
assert tickers.call_count == 1
2019-11-09 13:44:39 +00:00
2020-05-19 00:35:01 +00:00
assert freqtrade.pairlists._pairlist_handlers[0]._last_refresh != 0
lrf = freqtrade.pairlists._pairlist_handlers[0]._last_refresh
2020-05-15 00:41:41 +00:00
freqtrade.pairlists.refresh_pairlist()
2019-11-09 18:45:09 +00:00
assert tickers.call_count == 1
2019-11-09 13:44:39 +00:00
# Time should not be updated.
2020-05-19 00:35:01 +00:00
assert freqtrade.pairlists._pairlist_handlers[0]._last_refresh == lrf
2019-11-09 13:49:25 +00:00
def test_agefilter_min_days_listed_too_small(mocker, default_conf, markets, tickers):
default_conf['pairlists'] = [{'method': 'VolumePairList', 'number_assets': 10},
{'method': 'AgeFilter', 'min_days_listed': -1}]
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
with pytest.raises(OperationalException,
2020-08-15 07:11:46 +00:00
match=r'AgeFilter requires min_days_listed to be >= 1'):
get_patched_freqtradebot(mocker, default_conf)
def test_agefilter_min_days_listed_too_large(mocker, default_conf, markets, tickers):
default_conf['pairlists'] = [{'method': 'VolumePairList', 'number_assets': 10},
{'method': 'AgeFilter', 'min_days_listed': 99999}]
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
with pytest.raises(OperationalException,
2020-08-15 07:11:46 +00:00
match=r'AgeFilter requires min_days_listed to not exceed '
r'exchange max request size \([0-9]+\)'):
get_patched_freqtradebot(mocker, default_conf)
2020-12-15 19:49:46 +00:00
def test_agefilter_caching(mocker, markets, whitelist_conf_agefilter, tickers, ohlcv_history):
ohlcv_data = {
('ETH/BTC', '1d'): ohlcv_history,
('TKN/BTC', '1d'): ohlcv_history,
('LTC/BTC', '1d'): ohlcv_history,
}
2020-06-24 22:58:12 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
2020-12-15 19:49:46 +00:00
refresh_latest_ohlcv=MagicMock(return_value=ohlcv_data),
2020-06-24 22:58:12 +00:00
)
2020-11-21 14:51:39 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf_agefilter)
2020-12-15 19:49:46 +00:00
assert freqtrade.exchange.refresh_latest_ohlcv.call_count == 0
2020-06-24 22:58:12 +00:00
freqtrade.pairlists.refresh_pairlist()
assert len(freqtrade.pairlists.whitelist) == 3
2020-12-15 19:49:46 +00:00
assert freqtrade.exchange.refresh_latest_ohlcv.call_count > 0
# freqtrade.config['exchange']['pair_whitelist'].append('HOT/BTC')
2020-06-24 22:58:12 +00:00
2020-12-15 19:49:46 +00:00
previous_call_count = freqtrade.exchange.refresh_latest_ohlcv.call_count
2020-06-24 22:58:12 +00:00
freqtrade.pairlists.refresh_pairlist()
assert len(freqtrade.pairlists.whitelist) == 3
# Called once for XRP/BTC
assert freqtrade.exchange.refresh_latest_ohlcv.call_count == previous_call_count + 1
2020-06-24 22:58:12 +00:00
def test_rangestabilityfilter_checks(mocker, default_conf, markets, tickers):
2020-11-21 14:51:39 +00:00
default_conf['pairlists'] = [{'method': 'VolumePairList', 'number_assets': 10},
{'method': 'RangeStabilityFilter', 'lookback_days': 99999}]
2020-11-21 14:51:39 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
with pytest.raises(OperationalException,
match=r'RangeStabilityFilter requires lookback_days to not exceed '
2020-11-21 14:51:39 +00:00
r'exchange max request size \([0-9]+\)'):
get_patched_freqtradebot(mocker, default_conf)
default_conf['pairlists'] = [{'method': 'VolumePairList', 'number_assets': 10},
{'method': 'RangeStabilityFilter', 'lookback_days': 0}]
2020-11-21 14:51:39 +00:00
with pytest.raises(OperationalException,
match='RangeStabilityFilter requires lookback_days to be >= 1'):
2020-11-21 14:51:39 +00:00
get_patched_freqtradebot(mocker, default_conf)
@pytest.mark.parametrize('min_rate_of_change,expected_length', [
2020-11-21 15:01:52 +00:00
(0.01, 5),
(0.05, 0), # Setting rate_of_change to 5% removes all pairs from the whitelist.
2020-11-21 15:01:52 +00:00
])
2020-12-15 19:49:46 +00:00
def test_rangestabilityfilter_caching(mocker, markets, default_conf, tickers, ohlcv_history,
min_rate_of_change, expected_length):
2020-11-21 15:01:52 +00:00
default_conf['pairlists'] = [{'method': 'VolumePairList', 'number_assets': 10},
{'method': 'RangeStabilityFilter', 'lookback_days': 2,
'min_rate_of_change': min_rate_of_change}]
2020-11-21 15:01:52 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True),
get_tickers=tickers
)
2020-12-15 19:49:46 +00:00
ohlcv_data = {
('ETH/BTC', '1d'): ohlcv_history,
('TKN/BTC', '1d'): ohlcv_history,
('LTC/BTC', '1d'): ohlcv_history,
('XRP/BTC', '1d'): ohlcv_history,
('HOT/BTC', '1d'): ohlcv_history,
('BLK/BTC', '1d'): ohlcv_history,
}
2020-11-21 15:01:52 +00:00
mocker.patch.multiple(
'freqtrade.exchange.Exchange',
2020-12-15 19:49:46 +00:00
refresh_latest_ohlcv=MagicMock(return_value=ohlcv_data),
2020-11-21 15:01:52 +00:00
)
freqtrade = get_patched_freqtradebot(mocker, default_conf)
2020-12-15 19:49:46 +00:00
assert freqtrade.exchange.refresh_latest_ohlcv.call_count == 0
2020-11-21 15:01:52 +00:00
freqtrade.pairlists.refresh_pairlist()
assert len(freqtrade.pairlists.whitelist) == expected_length
2020-12-15 19:49:46 +00:00
assert freqtrade.exchange.refresh_latest_ohlcv.call_count > 0
2020-11-21 15:01:52 +00:00
2020-12-15 19:49:46 +00:00
previous_call_count = freqtrade.exchange.refresh_latest_ohlcv.call_count
2020-11-21 15:01:52 +00:00
freqtrade.pairlists.refresh_pairlist()
assert len(freqtrade.pairlists.whitelist) == expected_length
# Should not have increased since first call.
2020-12-15 19:49:46 +00:00
assert freqtrade.exchange.refresh_latest_ohlcv.call_count == previous_call_count
2020-11-21 15:01:52 +00:00
2020-07-22 19:46:30 +00:00
@pytest.mark.parametrize("pairlistconfig,desc_expected,exception_expected", [
2020-07-10 18:21:33 +00:00
({"method": "PriceFilter", "low_price_ratio": 0.001, "min_price": 0.00000010,
2020-07-22 19:46:30 +00:00
"max_price": 1.0},
"[{'PriceFilter': 'PriceFilter - Filtering pairs priced below "
"0.1% or below 0.00000010 or above 1.00000000.'}]",
None
2020-07-22 19:56:24 +00:00
),
2020-07-10 18:21:33 +00:00
({"method": "PriceFilter", "low_price_ratio": 0.001, "min_price": 0.00000010},
2020-07-22 19:46:30 +00:00
"[{'PriceFilter': 'PriceFilter - Filtering pairs priced below 0.1% or below 0.00000010.'}]",
None
2020-07-22 19:56:24 +00:00
),
2020-07-10 18:21:33 +00:00
({"method": "PriceFilter", "low_price_ratio": 0.001, "max_price": 1.00010000},
2020-07-22 19:46:30 +00:00
"[{'PriceFilter': 'PriceFilter - Filtering pairs priced below 0.1% or above 1.00010000.'}]",
None
2020-07-22 19:56:24 +00:00
),
2020-07-10 18:21:33 +00:00
({"method": "PriceFilter", "min_price": 0.00002000},
2020-07-22 19:46:30 +00:00
"[{'PriceFilter': 'PriceFilter - Filtering pairs priced below 0.00002000.'}]",
None
2020-07-22 19:56:24 +00:00
),
2020-07-10 18:21:33 +00:00
({"method": "PriceFilter"},
2020-07-22 19:46:30 +00:00
"[{'PriceFilter': 'PriceFilter - No price filters configured.'}]",
None
2020-07-22 19:56:24 +00:00
),
2020-07-22 19:46:30 +00:00
({"method": "PriceFilter", "low_price_ratio": -0.001},
None,
2020-08-15 07:11:46 +00:00
"PriceFilter requires low_price_ratio to be >= 0"
2020-07-22 19:56:24 +00:00
), # OperationalException expected
2020-07-22 19:46:30 +00:00
({"method": "PriceFilter", "min_price": -0.00000010},
None,
2020-08-15 07:11:46 +00:00
"PriceFilter requires min_price to be >= 0"
2020-07-22 19:56:24 +00:00
), # OperationalException expected
2020-07-22 19:46:30 +00:00
({"method": "PriceFilter", "max_price": -1.00010000},
None,
2020-08-15 07:11:46 +00:00
"PriceFilter requires max_price to be >= 0"
2020-07-22 19:56:24 +00:00
), # OperationalException expected
({"method": "RangeStabilityFilter", "lookback_days": 10, "min_rate_of_change": 0.01},
"[{'RangeStabilityFilter': 'RangeStabilityFilter - Filtering pairs with rate of change below "
"0.01 over the last days.'}]",
2020-11-21 14:39:04 +00:00
None
),
2020-07-10 18:21:33 +00:00
])
2020-07-22 19:46:30 +00:00
def test_pricefilter_desc(mocker, whitelist_conf, markets, pairlistconfig,
desc_expected, exception_expected):
2020-07-10 18:21:33 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
markets=PropertyMock(return_value=markets),
exchange_has=MagicMock(return_value=True)
)
whitelist_conf['pairlists'] = [pairlistconfig]
2020-07-22 19:46:30 +00:00
if desc_expected is not None:
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
short_desc = str(freqtrade.pairlists.short_desc())
assert short_desc == desc_expected
2020-07-22 19:56:24 +00:00
else: # OperationalException expected
2020-07-22 19:46:30 +00:00
with pytest.raises(OperationalException,
match=exception_expected):
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
2020-07-10 18:21:33 +00:00
2020-11-28 04:18:49 +00:00
def test_pairlistmanager_no_pairlist(mocker, whitelist_conf):
2019-11-09 13:49:25 +00:00
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
whitelist_conf['pairlists'] = []
with pytest.raises(OperationalException,
2020-05-19 00:35:01 +00:00
match=r"No Pairlist Handlers defined"):
2019-11-09 13:49:25 +00:00
get_patched_freqtradebot(mocker, whitelist_conf)
2020-11-28 07:15:36 +00:00
@pytest.mark.parametrize("pairlists,pair_allowlist,overall_performance,allowlist_result", [
# No trades yet
([{"method": "StaticPairList"}, {"method": "PerformanceFilter"}],
['ETH/BTC', 'TKN/BTC', 'LTC/BTC'], [], ['ETH/BTC', 'TKN/BTC', 'LTC/BTC']),
# Happy path: Descending order, all values filled
2020-11-28 07:34:18 +00:00
([{"method": "StaticPairList"}, {"method": "PerformanceFilter"}],
['ETH/BTC', 'TKN/BTC'],
[{'pair': 'TKN/BTC', 'profit': 5, 'count': 3}, {'pair': 'ETH/BTC', 'profit': 4, 'count': 2}],
['TKN/BTC', 'ETH/BTC']),
2020-11-28 07:15:36 +00:00
# Performance data outside allow list ignored
2020-11-28 07:34:18 +00:00
([{"method": "StaticPairList"}, {"method": "PerformanceFilter"}],
['ETH/BTC', 'TKN/BTC'],
2020-11-28 07:43:19 +00:00
[{'pair': 'OTHER/BTC', 'profit': 5, 'count': 3},
2020-11-28 07:34:18 +00:00
{'pair': 'ETH/BTC', 'profit': 4, 'count': 2}],
['ETH/BTC', 'TKN/BTC']),
2020-11-28 07:15:36 +00:00
# Partial performance data missing and sorted between positive and negative profit
2020-11-28 07:34:18 +00:00
([{"method": "StaticPairList"}, {"method": "PerformanceFilter"}],
['ETH/BTC', 'TKN/BTC', 'LTC/BTC'],
[{'pair': 'ETH/BTC', 'profit': -5, 'count': 100},
{'pair': 'TKN/BTC', 'profit': 4, 'count': 2}],
['TKN/BTC', 'LTC/BTC', 'ETH/BTC']),
# Tie in performance data broken by count (ascending)
2020-11-28 07:34:18 +00:00
([{"method": "StaticPairList"}, {"method": "PerformanceFilter"}],
['ETH/BTC', 'TKN/BTC', 'LTC/BTC'],
[{'pair': 'LTC/BTC', 'profit': -5.01, 'count': 101},
{'pair': 'TKN/BTC', 'profit': -5.01, 'count': 2},
{'pair': 'ETH/BTC', 'profit': -5.01, 'count': 100}],
['TKN/BTC', 'ETH/BTC', 'LTC/BTC']),
# Tie in performance and count, broken by alphabetical sort
([{"method": "StaticPairList"}, {"method": "PerformanceFilter"}],
['ETH/BTC', 'TKN/BTC', 'LTC/BTC'],
[{'pair': 'LTC/BTC', 'profit': -5.01, 'count': 1},
{'pair': 'TKN/BTC', 'profit': -5.01, 'count': 1},
{'pair': 'ETH/BTC', 'profit': -5.01, 'count': 1}],
['ETH/BTC', 'LTC/BTC', 'TKN/BTC']),
2020-11-28 07:15:36 +00:00
])
2020-11-28 07:34:18 +00:00
def test_performance_filter(mocker, whitelist_conf, pairlists, pair_allowlist, overall_performance,
allowlist_result, tickers, markets, ohlcv_history_list):
2020-11-28 07:15:36 +00:00
allowlist_conf = whitelist_conf
allowlist_conf['pairlists'] = pairlists
allowlist_conf['exchange']['pair_whitelist'] = pair_allowlist
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
freqtrade = get_patched_freqtradebot(mocker, allowlist_conf)
mocker.patch.multiple('freqtrade.exchange.Exchange',
get_tickers=tickers,
markets=PropertyMock(return_value=markets)
)
2020-11-28 07:34:18 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
get_historic_ohlcv=MagicMock(return_value=ohlcv_history_list),
2020-11-28 07:43:19 +00:00
)
2020-11-28 07:15:36 +00:00
mocker.patch.multiple('freqtrade.persistence.Trade',
2020-11-28 07:34:18 +00:00
get_overall_performance=MagicMock(return_value=overall_performance),
)
2020-11-28 07:15:36 +00:00
freqtrade.pairlists.refresh_pairlist()
allowlist = freqtrade.pairlists.whitelist
assert allowlist == allowlist_result