stable/tests/pairlist/test_pairlist.py

368 lines
15 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
2019-11-09 08:31:17 +00:00
from freqtrade.pairlist.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
2018-11-30 06:06:02 +00:00
# whitelist, blacklist
@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'
]
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
@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-04-14 18:39:54 +00:00
def test_log_on_refresh(mocker, static_pl_conf, markets, tickers):
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
pl = freqtrade.pairlists._pairlists[0]
pl.log_on_refresh(logmock, 'Hello world')
assert logmock.call_count == 1
pl.log_on_refresh(logmock, 'Hello world')
assert logmock.call_count == 1
assert pl._log_cache.currsize == 1
assert ('Hello world',) in pl._log_cache._Cache__data
pl.log_on_refresh(logmock, 'Hello world2')
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),
)
# 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()
2019-11-09 08:31:17 +00:00
2020-05-15 00:41:41 +00:00
assert whitelist == freqtrade.pairlists.whitelist
2019-11-09 08:31:17 +00:00
whitelist_conf['pairlists'] = [{'method': 'VolumePairList',
'config': {}
}
]
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)
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)
@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-17 23:37:03 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC', 'HOT/BTC']),
# Different sorting depending on quote or bid volume
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "bidVolume"}],
2020-05-17 23:37:03 +00:00
"BTC", ['HOT/BTC', 'FUEL/BTC', 'XRP/BTC', 'LTC/BTC', 'TKN/BTC']),
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"}],
2020-05-17 23:37:03 +00:00
"USDT", ['ETH/USDT', 'NANO/USDT', 'ADAHALF/USDT']),
# No pair for ETH, VolumePairList
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"}],
"ETH", []),
2020-05-17 23:37:03 +00:00
# No pair for ETH, StaticPairList
([{"method": "StaticPairList"}],
"ETH", []),
# No pair for ETH, all handlers
([{"method": "StaticPairList"},
{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "PrecisionFilter"},
{"method": "PriceFilter", "low_price_ratio": 0.03},
2020-05-18 20:48:06 +00:00
{"method": "SpreadFilter", "max_spread_ratio": 0.005},
2020-05-17 23:37:03 +00:00
{"method": "ShuffleFilter"}],
"ETH", []),
# Precisionfilter and quote volume
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
2019-11-14 19:12:41 +00:00
{"method": "PrecisionFilter"}], "BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC', 'XRP/BTC']),
# Precisionfilter bid
2019-11-19 05:34:54 +00:00
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "bidVolume"},
2019-11-14 19:12:41 +00:00
{"method": "PrecisionFilter"}], "BTC", ['FUEL/BTC', 'XRP/BTC', 'LTC/BTC', 'TKN/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-17 23:37:03 +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-17 23:37:03 +00:00
"USDT", ['ETH/USDT', 'NANO/USDT']),
2019-10-29 09:39:27 +00:00
# Hot is removed by precision_filter, Fuel by low_price_filter.
2019-11-14 19:12:41 +00:00
([{"method": "VolumePairList", "number_assets": 6, "sort_key": "quoteVolume"},
{"method": "PrecisionFilter"},
2020-05-17 23:37:03 +00:00
{"method": "PriceFilter", "low_price_ratio": 0.02}],
"BTC", ['ETH/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-17 23:37:03 +00:00
"BTC", ['ETH/BTC', 'TKN/BTC', 'LTC/BTC']),
# StaticPairlist only
([{"method": "StaticPairList"}],
"BTC", ['ETH/BTC', 'TKN/BTC']),
# Static Pairlist before VolumePairList - sorting changes
([{"method": "StaticPairList"},
2020-05-17 23:37:03 +00:00
{"method": "VolumePairList", "number_assets": 5, "sort_key": "bidVolume"}],
"BTC", ['TKN/BTC', 'ETH/BTC']),
# 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-17 23:37:03 +00:00
"USDT", ['ETH/USDT']),
# ShuffleFilter
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "ShuffleFilter", "seed": 77}],
"USDT", ['ETH/USDT', 'ADAHALF/USDT', 'NANO/USDT']),
# ShuffleFilter, other seed
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "ShuffleFilter", "seed": 42}],
"USDT", ['NANO/USDT', 'ETH/USDT', 'ADAHALF/USDT']),
# ShuffleFilter, no seed
([{"method": "VolumePairList", "number_assets": 5, "sort_key": "quoteVolume"},
{"method": "ShuffleFilter"}],
"USDT", 3),
])
def test_VolumePairList_whitelist_gen(mocker, whitelist_conf, shitcoinmarkets, tickers,
pairlists, base_currency, 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
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
2018-12-04 06:16:34 +00:00
freqtrade = get_patched_freqtradebot(mocker, whitelist_conf)
2019-11-09 12:40:36 +00:00
mocker.patch.multiple('freqtrade.exchange.Exchange',
get_tickers=tickers,
markets=PropertyMock(return_value=shitcoinmarkets),
)
2019-11-09 12:40:36 +00:00
freqtrade.pairlists.refresh_pairlist()
whitelist = freqtrade.pairlists.whitelist
assert isinstance(whitelist, list)
2020-05-18 10:18:05 +00:00
# Verify length of pairlist matches (used for ShuffleFilter without seed)
2020-05-17 23:37:03 +00:00
if type(whitelist_result) is list:
assert whitelist == whitelist_result
else:
len(whitelist) == whitelist_result
for pairlist in pairlists:
2020-05-17 23:37:03 +00:00
if pairlist['method'] == 'PrecisionFilter' and whitelist_result:
assert log_has_re(r'^Removed .* from whitelist, because stop price .* '
r'would be <= stop limit.*', caplog)
2020-05-17 23:37:03 +00:00
if pairlist['method'] == 'PriceFilter' and whitelist_result:
assert (log_has_re(r'^Removed .* from whitelist, because 1 unit is .*%$', caplog) or
2020-04-24 05:57:43 +00:00
log_has_re(r"^Removed .* from whitelist, because ticker\['last'\] 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)
def test_gen_pair_whitelist_not_supported(mocker, default_conf, tickers) -> None:
2019-11-09 12:40:36 +00:00
default_conf['pairlists'] = [{'method': 'VolumePairList',
'config': {'number_assets': 10}
}]
mocker.patch.multiple('freqtrade.exchange.Exchange',
get_tickers=tickers,
exchange_has=MagicMock(return_value=False),
)
with pytest.raises(OperationalException):
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")
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
new_whitelist = freqtrade.pairlists._pairlists[0]._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
def test_volumepairlist_invalid_sortvalue(mocker, markets, 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)
assert freqtrade.pairlists._pairlists[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-15 00:41:41 +00:00
assert freqtrade.pairlists._pairlists[0]._last_refresh != 0
lrf = freqtrade.pairlists._pairlists[0]._last_refresh
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-15 00:41:41 +00:00
assert freqtrade.pairlists._pairlists[0]._last_refresh == lrf
2019-11-09 13:49:25 +00:00
def test_pairlistmanager_no_pairlist(mocker, markets, whitelist_conf, caplog):
mocker.patch('freqtrade.exchange.Exchange.exchange_has', MagicMock(return_value=True))
whitelist_conf['pairlists'] = []
with pytest.raises(OperationalException,
match=r"No Pairlist defined!"):
get_patched_freqtradebot(mocker, whitelist_conf)