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

Update pairlist docstring to be less missleading

Browse Source
This commit is contained in:
Matthias 2022-10-10 11:54:13 +00:00
parent 6be9b81f4c
commit d3b2b2972e
13 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
freqtrade/plugins/pairlist/AgeFilter.py
View File

@ -70,7 +70,7 @@ class AgeFilter(IPairList):
def filter_pairlist(self, pairlist: List[str], tickers: Dict) -> List[str]:
"""
:param pairlist: pairlist to filter or sort
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new allowlist
"""
needed_pairs: ListPairsWithTimeframes = [

6
freqtrade/plugins/pairlist/IPairList.py
View File

@ -69,7 +69,7 @@ class IPairList(LoggingMixin, ABC):
filter_pairlist() method.
:param pair: Pair that's currently validated
:param ticker: ticker dict as returned from ccxt.fetch_tickers()
:param ticker: ticker dict as returned from ccxt.fetch_ticker
:return: True if the pair can stay, false if it should be removed
"""
raise NotImplementedError()
@ -85,7 +85,7 @@ class IPairList(LoggingMixin, ABC):
it will raise the exception if a Pairlist Handler is used at the first
position in the chain.
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: List of pairs
"""
raise OperationalException("This Pairlist Handler should not be used "
@ -103,7 +103,7 @@ class IPairList(LoggingMixin, ABC):
own filtration.
:param pairlist: pairlist to filter or sort
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new whitelist
"""
if self._enabled:

2
freqtrade/plugins/pairlist/OffsetFilter.py
View File

@ -47,7 +47,7 @@ class OffsetFilter(IPairList):
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.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new whitelist
"""
if self._offset > len(pairlist):

2
freqtrade/plugins/pairlist/PerformanceFilter.py
View File

@ -44,7 +44,7 @@ class PerformanceFilter(IPairList):
Filters and sorts pairlist and returns the allowlist 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.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new allowlist
"""
# Get the trading performance for pairs from database

2
freqtrade/plugins/pairlist/PrecisionFilter.py
View File

@ -49,7 +49,7 @@ class PrecisionFilter(IPairList):
Check if pair has enough room to add a stoploss to avoid "unsellable" buys of very
low value pairs.
:param pair: Pair that's currently validated
:param ticker: ticker dict as returned from ccxt.fetch_tickers()
:param ticker: ticker dict as returned from ccxt.fetch_ticker
:return: True if the pair can stay, false if it should be removed
"""
if ticker.get('last', None) is None:

2
freqtrade/plugins/pairlist/PriceFilter.py
View File

@ -68,7 +68,7 @@ class PriceFilter(IPairList):
"""
Check if if one price-step (pip) is > than a certain barrier.
:param pair: Pair that's currently validated
:param ticker: ticker dict as returned from ccxt.fetch_tickers()
:param ticker: ticker dict as returned from ccxt.fetch_ticker
:return: True if the pair can stay, false if it should be removed
"""
if ticker.get('last', None) is None or ticker.get('last') == 0:

4
freqtrade/plugins/pairlist/ProducerPairList.py
View File

@ -71,7 +71,7 @@ class ProducerPairList(IPairList):
def gen_pairlist(self, tickers: Dict) -> List[str]:
"""
Generate the pairlist
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: List of pairs
"""
pairs = self._filter_pairlist(None)
@ -84,7 +84,7 @@ class ProducerPairList(IPairList):
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.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new whitelist
"""
return self._filter_pairlist(pairlist)

2
freqtrade/plugins/pairlist/ShuffleFilter.py
View File

@ -52,7 +52,7 @@ class ShuffleFilter(IPairList):
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.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new whitelist
"""
# Shuffle is done inplace

2
freqtrade/plugins/pairlist/SpreadFilter.py
View File

@ -48,7 +48,7 @@ class SpreadFilter(IPairList):
"""
Validate spread for the ticker
:param pair: Pair that's currently validated
:param ticker: ticker dict as returned from ccxt.fetch_tickers()
:param ticker: ticker dict as returned from ccxt.fetch_ticker
:return: True if the pair can stay, false if it should be removed
"""
if 'bid' in ticker and 'ask' in ticker and ticker['ask'] and ticker['bid']:

4
freqtrade/plugins/pairlist/StaticPairList.py
View File

@ -42,7 +42,7 @@ class StaticPairList(IPairList):
def gen_pairlist(self, tickers: Dict) -> List[str]:
"""
Generate the pairlist
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: List of pairs
"""
if self._allow_inactive:
@ -58,7 +58,7 @@ class StaticPairList(IPairList):
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.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new whitelist
"""
pairlist_ = deepcopy(pairlist)

2
freqtrade/plugins/pairlist/VolatilityFilter.py
View File

@ -66,7 +66,7 @@ class VolatilityFilter(IPairList):
"""
Validate trading range
:param pairlist: pairlist to filter or sort
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new allowlist
"""
needed_pairs: ListPairsWithTimeframes = [

4
freqtrade/plugins/pairlist/VolumePairList.py
View File

@ -113,7 +113,7 @@ class VolumePairList(IPairList):
def gen_pairlist(self, tickers: Dict) -> List[str]:
"""
Generate the pairlist
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: List of pairs
"""
# Generate dynamic whitelist
@ -150,7 +150,7 @@ class VolumePairList(IPairList):
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.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new whitelist
"""
if self._use_range:

2
freqtrade/plugins/pairlist/rangestabilityfilter.py
View File

@ -64,7 +64,7 @@ class RangeStabilityFilter(IPairList):
"""
Validate trading range
:param pairlist: pairlist to filter or sort
:param tickers: Tickers (from exchange.get_tickers()). May be cached.
:param tickers: Tickers (from exchange.get_tickers). May be cached.
:return: new allowlist
"""
needed_pairs: ListPairsWithTimeframes = [