stable/freqtrade/worker.py

166 lines
5.5 KiB
Python
Raw Normal View History

2019-03-25 14:45:03 +00:00
"""
Main Freqtrade worker class.
"""
import logging
import time
import traceback
from typing import Any, Callable, Dict, Optional
2019-03-25 14:45:03 +00:00
import sdnotify
from freqtrade import __version__, constants
2019-03-25 14:45:03 +00:00
from freqtrade.configuration import Configuration
from freqtrade.exceptions import OperationalException, TemporaryError
from freqtrade.freqtradebot import FreqtradeBot
from freqtrade.state import State
2019-03-25 14:45:03 +00:00
logger = logging.getLogger(__name__)
2019-09-12 01:39:52 +00:00
class Worker:
2019-03-25 14:45:03 +00:00
"""
Freqtradebot worker class
"""
2020-02-02 04:00:40 +00:00
def __init__(self, args: Dict[str, Any], config: Dict[str, Any] = None) -> None:
2019-03-25 14:45:03 +00:00
"""
Init all variables and objects the bot needs to work
"""
logger.info('Starting worker %s', __version__)
self._args = args
self._config = config
self._init(False)
2019-03-25 14:45:03 +00:00
# Tell systemd that we completed initialization phase
if self._sd_notify:
logger.debug("sd_notify: READY=1")
self._sd_notify.notify("READY=1")
2019-04-30 16:47:55 +00:00
def _init(self, reconfig: bool) -> None:
2019-03-25 14:45:03 +00:00
"""
Also called from the _reconfigure() method (with reconfig=True).
2019-03-25 14:45:03 +00:00
"""
if reconfig or self._config is None:
# Load configuration
self._config = Configuration(self._args, None).get_config()
2019-03-25 14:45:03 +00:00
# Init the instance of the bot
self.freqtrade = FreqtradeBot(self._config)
2019-03-25 14:45:03 +00:00
self._throttle_secs = self._config.get('internals', {}).get(
'process_throttle_secs',
constants.PROCESS_THROTTLE_SECS
)
self._sd_notify = sdnotify.SystemdNotifier() if \
self._config.get('internals', {}).get('sd_notify', False) else None
2019-04-30 16:47:55 +00:00
def run(self) -> None:
2019-03-25 14:45:03 +00:00
state = None
while True:
state = self._worker(old_state=state)
2019-03-25 14:45:03 +00:00
if state == State.RELOAD_CONF:
2019-04-30 07:29:49 +00:00
self._reconfigure()
2019-03-25 14:45:03 +00:00
2019-04-30 16:47:55 +00:00
def _worker(self, old_state: Optional[State], throttle_secs: Optional[float] = None) -> State:
2019-03-25 14:45:03 +00:00
"""
Trading routine that must be run at each loop
:param old_state: the previous service state from the previous call
:return: current service state
"""
state = self.freqtrade.state
if throttle_secs is None:
throttle_secs = self._throttle_secs
2019-03-25 14:45:03 +00:00
# Log state transition
if state != old_state:
2020-01-27 00:34:53 +00:00
self.freqtrade.notify_status(f'{state.name.lower()}')
2019-03-25 14:45:03 +00:00
logger.info('Changing state to: %s', state.name)
if state == State.RUNNING:
2019-05-19 18:06:26 +00:00
self.freqtrade.startup()
2019-03-25 14:45:03 +00:00
if state == State.STOPPED:
# Ping systemd watchdog before sleeping in the stopped state
if self._sd_notify:
logger.debug("sd_notify: WATCHDOG=1\\nSTATUS=State: STOPPED.")
self._sd_notify.notify("WATCHDOG=1\nSTATUS=State: STOPPED.")
time.sleep(throttle_secs)
elif state == State.RUNNING:
# Ping systemd watchdog before throttling
if self._sd_notify:
logger.debug("sd_notify: WATCHDOG=1\\nSTATUS=State: RUNNING.")
self._sd_notify.notify("WATCHDOG=1\nSTATUS=State: RUNNING.")
self._throttle(func=self._process, min_secs=throttle_secs)
return state
def _throttle(self, func: Callable[..., Any], min_secs: float, *args, **kwargs) -> Any:
"""
Throttles the given callable that it
takes at least `min_secs` to finish execution.
:param func: Any callable
:param min_secs: minimum execution time in seconds
:return: Any
"""
start = time.time()
result = func(*args, **kwargs)
end = time.time()
duration = max(min_secs - (end - start), 0.0)
logger.debug('Throttling %s for %.2f seconds', func.__name__, duration)
time.sleep(duration)
return result
2019-08-13 07:36:52 +00:00
def _process(self) -> None:
logger.debug("========================================")
2019-03-25 14:45:03 +00:00
try:
2019-08-13 07:36:52 +00:00
self.freqtrade.process()
2019-03-25 14:45:03 +00:00
except TemporaryError as error:
logger.warning(f"Error: {error}, retrying in {constants.RETRY_TIMEOUT} seconds...")
time.sleep(constants.RETRY_TIMEOUT)
except OperationalException:
tb = traceback.format_exc()
hint = 'Issue `/start` if you think it is safe to restart.'
2020-01-27 00:34:53 +00:00
self.freqtrade.notify_status(f'OperationalException:\n```\n{tb}```{hint}')
2019-03-25 14:45:03 +00:00
logger.exception('OperationalException. Stopping trader ...')
self.freqtrade.state = State.STOPPED
2019-03-25 14:45:03 +00:00
2019-04-30 16:47:55 +00:00
def _reconfigure(self) -> None:
2019-03-25 14:45:03 +00:00
"""
Cleans up current freqtradebot instance, reloads the configuration and
2019-03-30 20:33:52 +00:00
replaces it with the new instance
2019-03-25 14:45:03 +00:00
"""
# Tell systemd that we initiated reconfiguration
if self._sd_notify:
logger.debug("sd_notify: RELOADING=1")
self._sd_notify.notify("RELOADING=1")
# Clean up current freqtrade modules
self.freqtrade.cleanup()
# Load and validate config and create new instance of the bot
self._init(True)
2019-03-25 14:45:03 +00:00
2020-01-27 00:34:53 +00:00
self.freqtrade.notify_status('config reloaded')
2019-03-25 14:45:03 +00:00
# Tell systemd that we completed reconfiguration
if self._sd_notify:
logger.debug("sd_notify: READY=1")
self._sd_notify.notify("READY=1")
2019-04-30 16:47:55 +00:00
def exit(self) -> None:
2019-03-25 14:45:03 +00:00
# Tell systemd that we are exiting now
if self._sd_notify:
logger.debug("sd_notify: STOPPING=1")
self._sd_notify.notify("STOPPING=1")
if self.freqtrade:
2020-01-27 00:34:53 +00:00
self.freqtrade.notify_status('process died')
2019-03-25 14:45:03 +00:00
self.freqtrade.cleanup()