mirror of
https://github.com/freqtrade/freqtrade.git
synced 2024-11-16 05:03:55 +00:00
309 lines
11 KiB
Python
309 lines
11 KiB
Python
import asyncio
|
|
import logging
|
|
from copy import deepcopy
|
|
from datetime import datetime
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List
|
|
|
|
from fastapi import APIRouter, BackgroundTasks, Depends
|
|
from fastapi.exceptions import HTTPException
|
|
|
|
from freqtrade.configuration.config_validation import validate_config_consistency
|
|
from freqtrade.constants import Config
|
|
from freqtrade.data.btanalysis import (delete_backtest_result, get_backtest_result,
|
|
get_backtest_resultlist, load_and_merge_backtest_result,
|
|
update_backtest_metadata)
|
|
from freqtrade.enums import BacktestState
|
|
from freqtrade.exceptions import DependencyException, OperationalException
|
|
from freqtrade.exchange.common import remove_exchange_credentials
|
|
from freqtrade.misc import deep_merge_dicts, is_file_in_dir
|
|
from freqtrade.rpc.api_server.api_schemas import (BacktestHistoryEntry, BacktestMetadataUpdate,
|
|
BacktestRequest, BacktestResponse)
|
|
from freqtrade.rpc.api_server.deps import get_config
|
|
from freqtrade.rpc.api_server.webserver_bgwork import ApiBG
|
|
from freqtrade.rpc.rpc import RPCException
|
|
from freqtrade.types import get_BacktestResultType_default
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Private API, protected by authentication and webserver_mode dependency
|
|
router = APIRouter()
|
|
|
|
|
|
def __run_backtest_bg(btconfig: Config):
|
|
from freqtrade.optimize.optimize_reports import generate_backtest_stats, store_backtest_stats
|
|
from freqtrade.resolvers import StrategyResolver
|
|
asyncio.set_event_loop(asyncio.new_event_loop())
|
|
try:
|
|
# Reload strategy
|
|
lastconfig = ApiBG.bt['last_config']
|
|
strat = StrategyResolver.load_strategy(btconfig)
|
|
validate_config_consistency(btconfig)
|
|
|
|
if (
|
|
not ApiBG.bt['bt']
|
|
or lastconfig.get('timeframe') != strat.timeframe
|
|
or lastconfig.get('timeframe_detail') != btconfig.get('timeframe_detail')
|
|
or lastconfig.get('timerange') != btconfig['timerange']
|
|
):
|
|
from freqtrade.optimize.backtesting import Backtesting
|
|
ApiBG.bt['bt'] = Backtesting(btconfig)
|
|
ApiBG.bt['bt'].load_bt_data_detail()
|
|
else:
|
|
ApiBG.bt['bt'].config = btconfig
|
|
ApiBG.bt['bt'].init_backtest()
|
|
# Only reload data if timeframe changed.
|
|
if (
|
|
not ApiBG.bt['data']
|
|
or not ApiBG.bt['timerange']
|
|
or lastconfig.get('timeframe') != strat.timeframe
|
|
or lastconfig.get('timerange') != btconfig['timerange']
|
|
):
|
|
ApiBG.bt['data'], ApiBG.bt['timerange'] = ApiBG.bt[
|
|
'bt'].load_bt_data()
|
|
|
|
lastconfig['timerange'] = btconfig['timerange']
|
|
lastconfig['timeframe'] = strat.timeframe
|
|
lastconfig['protections'] = btconfig.get('protections', [])
|
|
lastconfig['enable_protections'] = btconfig.get('enable_protections')
|
|
lastconfig['dry_run_wallet'] = btconfig.get('dry_run_wallet')
|
|
|
|
ApiBG.bt['bt'].enable_protections = btconfig.get('enable_protections', False)
|
|
ApiBG.bt['bt'].strategylist = [strat]
|
|
ApiBG.bt['bt'].results = get_BacktestResultType_default()
|
|
ApiBG.bt['bt'].load_prior_backtest()
|
|
|
|
ApiBG.bt['bt'].abort = False
|
|
strategy_name = strat.get_strategy_name()
|
|
if (ApiBG.bt['bt'].results and
|
|
strategy_name in ApiBG.bt['bt'].results['strategy']):
|
|
# When previous result hash matches - reuse that result and skip backtesting.
|
|
logger.info(f'Reusing result of previous backtest for {strategy_name}')
|
|
else:
|
|
min_date, max_date = ApiBG.bt['bt'].backtest_one_strategy(
|
|
strat, ApiBG.bt['data'], ApiBG.bt['timerange'])
|
|
|
|
ApiBG.bt['bt'].results = generate_backtest_stats(
|
|
ApiBG.bt['data'], ApiBG.bt['bt'].all_results,
|
|
min_date=min_date, max_date=max_date)
|
|
|
|
if btconfig.get('export', 'none') == 'trades':
|
|
fn = store_backtest_stats(
|
|
btconfig['exportfilename'], ApiBG.bt['bt'].results,
|
|
datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
|
|
)
|
|
ApiBG.bt['bt'].results['metadata'][strategy_name]['filename'] = str(fn.name)
|
|
ApiBG.bt['bt'].results['metadata'][strategy_name]['strategy'] = strategy_name
|
|
|
|
logger.info("Backtest finished.")
|
|
|
|
except (Exception, OperationalException, DependencyException) as e:
|
|
logger.exception(f"Backtesting caused an error: {e}")
|
|
ApiBG.bt['bt_error'] = str(e)
|
|
pass
|
|
finally:
|
|
ApiBG.bgtask_running = False
|
|
|
|
|
|
@router.post('/backtest', response_model=BacktestResponse, tags=['webserver', 'backtest'])
|
|
async def api_start_backtest(
|
|
bt_settings: BacktestRequest, background_tasks: BackgroundTasks,
|
|
config=Depends(get_config)):
|
|
ApiBG.bt['bt_error'] = None
|
|
"""Start backtesting if not done so already"""
|
|
if ApiBG.bgtask_running:
|
|
raise RPCException('Bot Background task already running')
|
|
|
|
if ':' in bt_settings.strategy:
|
|
raise HTTPException(status_code=500, detail="base64 encoded strategies are not allowed.")
|
|
|
|
btconfig = deepcopy(config)
|
|
remove_exchange_credentials(btconfig['exchange'], True)
|
|
settings = dict(bt_settings)
|
|
if settings.get('freqai', None) is not None:
|
|
settings['freqai'] = dict(settings['freqai'])
|
|
# Pydantic models will contain all keys, but non-provided ones are None
|
|
|
|
btconfig = deep_merge_dicts(settings, btconfig, allow_null_overrides=False)
|
|
try:
|
|
btconfig['stake_amount'] = float(btconfig['stake_amount'])
|
|
except ValueError:
|
|
pass
|
|
|
|
# Force dry-run for backtesting
|
|
btconfig['dry_run'] = True
|
|
|
|
# Start backtesting
|
|
# Initialize backtesting object
|
|
|
|
background_tasks.add_task(__run_backtest_bg, btconfig=btconfig)
|
|
ApiBG.bgtask_running = True
|
|
|
|
return {
|
|
"status": "running",
|
|
"running": True,
|
|
"progress": 0,
|
|
"step": str(BacktestState.STARTUP),
|
|
"status_msg": "Backtest started",
|
|
}
|
|
|
|
|
|
@router.get('/backtest', response_model=BacktestResponse, tags=['webserver', 'backtest'])
|
|
def api_get_backtest():
|
|
"""
|
|
Get backtesting result.
|
|
Returns Result after backtesting has been ran.
|
|
"""
|
|
from freqtrade.persistence import LocalTrade
|
|
if ApiBG.bgtask_running:
|
|
return {
|
|
"status": "running",
|
|
"running": True,
|
|
"step": (ApiBG.bt['bt'].progress.action if ApiBG.bt['bt']
|
|
else str(BacktestState.STARTUP)),
|
|
"progress": ApiBG.bt['bt'].progress.progress if ApiBG.bt['bt'] else 0,
|
|
"trade_count": len(LocalTrade.trades),
|
|
"status_msg": "Backtest running",
|
|
}
|
|
|
|
if not ApiBG.bt['bt']:
|
|
return {
|
|
"status": "not_started",
|
|
"running": False,
|
|
"step": "",
|
|
"progress": 0,
|
|
"status_msg": "Backtest not yet executed"
|
|
}
|
|
if ApiBG.bt['bt_error']:
|
|
return {
|
|
"status": "error",
|
|
"running": False,
|
|
"step": "",
|
|
"progress": 0,
|
|
"status_msg": f"Backtest failed with {ApiBG.bt['bt_error']}"
|
|
}
|
|
|
|
return {
|
|
"status": "ended",
|
|
"running": False,
|
|
"status_msg": "Backtest ended",
|
|
"step": "finished",
|
|
"progress": 1,
|
|
"backtest_result": ApiBG.bt['bt'].results,
|
|
}
|
|
|
|
|
|
@router.delete('/backtest', response_model=BacktestResponse, tags=['webserver', 'backtest'])
|
|
def api_delete_backtest():
|
|
"""Reset backtesting"""
|
|
if ApiBG.bgtask_running:
|
|
return {
|
|
"status": "running",
|
|
"running": True,
|
|
"step": "",
|
|
"progress": 0,
|
|
"status_msg": "Backtest running",
|
|
}
|
|
if ApiBG.bt['bt']:
|
|
ApiBG.bt['bt'].cleanup()
|
|
del ApiBG.bt['bt']
|
|
ApiBG.bt['bt'] = None
|
|
del ApiBG.bt['data']
|
|
ApiBG.bt['data'] = None
|
|
logger.info("Backtesting reset")
|
|
return {
|
|
"status": "reset",
|
|
"running": False,
|
|
"step": "",
|
|
"progress": 0,
|
|
"status_msg": "Backtest reset",
|
|
}
|
|
|
|
|
|
@router.get('/backtest/abort', response_model=BacktestResponse, tags=['webserver', 'backtest'])
|
|
def api_backtest_abort():
|
|
if not ApiBG.bgtask_running:
|
|
return {
|
|
"status": "not_running",
|
|
"running": False,
|
|
"step": "",
|
|
"progress": 0,
|
|
"status_msg": "Backtest ended",
|
|
}
|
|
ApiBG.bt['bt'].abort = True
|
|
return {
|
|
"status": "stopping",
|
|
"running": False,
|
|
"step": "",
|
|
"progress": 0,
|
|
"status_msg": "Backtest ended",
|
|
}
|
|
|
|
|
|
@router.get('/backtest/history', response_model=List[BacktestHistoryEntry],
|
|
tags=['webserver', 'backtest'])
|
|
def api_backtest_history(config=Depends(get_config)):
|
|
# Get backtest result history, read from metadata files
|
|
return get_backtest_resultlist(config['user_data_dir'] / 'backtest_results')
|
|
|
|
|
|
@router.get('/backtest/history/result', response_model=BacktestResponse,
|
|
tags=['webserver', 'backtest'])
|
|
def api_backtest_history_result(filename: str, strategy: str, config=Depends(get_config)):
|
|
# Get backtest result history, read from metadata files
|
|
bt_results_base: Path = config['user_data_dir'] / 'backtest_results'
|
|
fn = (bt_results_base / filename).with_suffix('.json')
|
|
|
|
results: Dict[str, Any] = {
|
|
'metadata': {},
|
|
'strategy': {},
|
|
'strategy_comparison': [],
|
|
}
|
|
if not is_file_in_dir(fn, bt_results_base):
|
|
raise HTTPException(status_code=404, detail="File not found.")
|
|
load_and_merge_backtest_result(strategy, fn, results)
|
|
return {
|
|
"status": "ended",
|
|
"running": False,
|
|
"step": "",
|
|
"progress": 1,
|
|
"status_msg": "Historic result",
|
|
"backtest_result": results,
|
|
}
|
|
|
|
|
|
@router.delete('/backtest/history/{file}', response_model=List[BacktestHistoryEntry],
|
|
tags=['webserver', 'backtest'])
|
|
def api_delete_backtest_history_entry(file: str, config=Depends(get_config)):
|
|
# Get backtest result history, read from metadata files
|
|
bt_results_base: Path = config['user_data_dir'] / 'backtest_results'
|
|
file_abs = (bt_results_base / file).with_suffix('.json')
|
|
# Ensure file is in backtest_results directory
|
|
if not is_file_in_dir(file_abs, bt_results_base):
|
|
raise HTTPException(status_code=404, detail="File not found.")
|
|
|
|
delete_backtest_result(file_abs)
|
|
return get_backtest_resultlist(config['user_data_dir'] / 'backtest_results')
|
|
|
|
|
|
@router.patch('/backtest/history/{file}', response_model=List[BacktestHistoryEntry],
|
|
tags=['webserver', 'backtest'])
|
|
def api_update_backtest_history_entry(file: str, body: BacktestMetadataUpdate,
|
|
config=Depends(get_config)):
|
|
# Get backtest result history, read from metadata files
|
|
bt_results_base: Path = config['user_data_dir'] / 'backtest_results'
|
|
file_abs = (bt_results_base / file).with_suffix('.json')
|
|
# Ensure file is in backtest_results directory
|
|
if not is_file_in_dir(file_abs, bt_results_base):
|
|
raise HTTPException(status_code=404, detail="File not found.")
|
|
content = {
|
|
'notes': body.notes
|
|
}
|
|
try:
|
|
update_backtest_metadata(file_abs, body.strategy, content)
|
|
except ValueError as e:
|
|
raise HTTPException(status_code=400, detail=str(e))
|
|
|
|
return get_backtest_result(file_abs)
|