Move pairlists and background tasks API's to separate file

freqtrade/rpc/api_server/api_background_tasks.py

@@ -0,0 +1,129 @@
+import logging
+from copy import deepcopy
+
+from fastapi import APIRouter, BackgroundTasks, Depends
+from fastapi.exceptions import HTTPException
+
+from freqtrade.constants import Config
+from freqtrade.exceptions import OperationalException
+from freqtrade.rpc.api_server.api_schemas import (BackgroundTaskStatus, BgJobStarted,
+                                                  PairListsPayload, PairListsResponse,
+                                                  WhitelistEvaluateResponse)
+from freqtrade.rpc.api_server.deps import get_config, get_exchange
+from freqtrade.rpc.api_server.webserver_bgwork import ApiBG
+
+
+logger = logging.getLogger(__name__)
+
+# Private API, protected by authentication and webserver_mode dependency
+router = APIRouter()
+
+
+@router.get('/background/{jobid}', response_model=BackgroundTaskStatus, tags=['webserver'])
+def background_job(jobid: str):
+    if not (job := ApiBG.jobs.get(jobid)):
+        raise HTTPException(status_code=404, detail='Job not found.')
+
+    return {
+        'job_id': jobid,
+        'job_category': job['category'],
+        'status': job['status'],
+        'running': job['is_running'],
+        'progress': job.get('progress'),
+        # 'job_error': job['error'],
+    }
+
+
+@router.get('/pairlists/available',
+            response_model=PairListsResponse, tags=['pairlists', 'webserver'])
+def list_pairlists(config=Depends(get_config)):
+    from freqtrade.resolvers import PairListResolver
+    pairlists = PairListResolver.search_all_objects(
+        config, False)
+    pairlists = sorted(pairlists, key=lambda x: x['name'])
+
+    return {'pairlists': [{
+        "name": x['name'],
+        "is_pairlist_generator": x['class'].is_pairlist_generator,
+        "params": x['class'].available_parameters(),
+        "description": x['class'].description(),
+         } for x in pairlists
+    ]}
+
+
+def __run_pairlist(job_id: str, config_loc: Config):
+    try:
+
+        ApiBG.jobs[job_id]['is_running'] = True
+        from freqtrade.plugins.pairlistmanager import PairListManager
+
+        exchange = get_exchange(config_loc)
+        pairlists = PairListManager(exchange, config_loc)
+        pairlists.refresh_pairlist()
+        ApiBG.jobs[job_id]['result'] = {
+                'method': pairlists.name_list,
+                'length': len(pairlists.whitelist),
+                'whitelist': pairlists.whitelist
+            }
+        ApiBG.jobs[job_id]['status'] = 'success'
+    except (OperationalException, Exception) as e:
+        logger.exception(e)
+        ApiBG.jobs[job_id]['error'] = str(e)
+    finally:
+        ApiBG.jobs[job_id]['is_running'] = False
+        ApiBG.jobs[job_id]['status'] = 'failed'
+        ApiBG.pairlist_running = False
+
+
+@router.post('/pairlists/evaluate', response_model=BgJobStarted, tags=['pairlists'])
+def pairlists_evaluate(payload: PairListsPayload, background_tasks: BackgroundTasks,
+                       config=Depends(get_config)):
+    if ApiBG.pairlist_running:
+        raise HTTPException(status_code=400, detail='Pairlist evaluation is already running.')
+
+    config_loc = deepcopy(config)
+    config_loc['stake_currency'] = payload.stake_currency
+    config_loc['pairlists'] = payload.pairlists
+    # TODO: overwrite blacklist? make it optional and fall back to the one in config?
+    # Outcome depends on the UI approach.
+    config_loc['exchange']['pair_blacklist'] = payload.blacklist
+    # Random job id
+    job_id = ApiBG.get_job_id()
+
+    ApiBG.jobs[job_id] = {
+        'category': 'pairlist',
+        'status': 'pending',
+        'progress': None,
+        'is_running': False,
+        'result': {},
+        'error': None,
+    }
+    ApiBG.running_jobs.append(job_id)
+    background_tasks.add_task(__run_pairlist, job_id, config_loc)
+    ApiBG.pairlist_running = True
+
+    return {
+        'status': 'Pairlist evaluation started in background.',
+        'job_id': job_id,
+    }
+
+
+@router.get('/pairlists/evaluate/{jobid}', response_model=WhitelistEvaluateResponse,
+            tags=['pairlists'])
+def pairlists_evaluate_get(jobid: str):
+    if not (job := ApiBG.jobs.get(jobid)):
+        raise HTTPException(status_code=404, detail='Job not found.')
+
+    if job['is_running']:
+        raise HTTPException(status_code=400, detail='Job not finished yet.')
+
+    if error := job['error']:
+        return {
+            'status': 'failed',
+            'error': error,
+        }
+
+    return {
+        'status': 'success',
+        'result': job['result'],
+    }

freqtrade/rpc/api_server/api_v1.py

@@ -2,29 +2,25 @@ import logging
 from copy import deepcopy
 from typing import List, Optional
 
-from fastapi import APIRouter, BackgroundTasks, Depends, Query
+from fastapi import APIRouter, Depends, Query
 from fastapi.exceptions import HTTPException
 
 from freqtrade import __version__
-from freqtrade.constants import Config
 from freqtrade.data.history import get_datahandler
 from freqtrade.enums import CandleType, TradingMode
 from freqtrade.exceptions import OperationalException
 from freqtrade.rpc import RPC
-from freqtrade.rpc.api_server.api_schemas import (AvailablePairs, BackgroundTaskStatus, Balances,
+from freqtrade.rpc.api_server.api_schemas import (AvailablePairs, Balances, BlacklistPayload,
-                                                  BgJobStarted, BlacklistPayload, BlacklistResponse,
+                                                  BlacklistResponse, Count, Daily,
-                                                  Count, Daily, DeleteLockRequest, DeleteTrade,
+                                                  DeleteLockRequest, DeleteTrade, ForceEnterPayload,
-                                                  ForceEnterPayload, ForceEnterResponse,
+                                                  ForceEnterResponse, ForceExitPayload,
-                                                  ForceExitPayload, FreqAIModelListResponse, Health,
+                                                  FreqAIModelListResponse, Health, Locks, Logs,
-                                                  Locks, Logs, OpenTradeSchema, PairHistory,
+                                                  OpenTradeSchema, PairHistory, PerformanceEntry,
-                                                  PairListsPayload, PairListsResponse,
+                                                  Ping, PlotConfig, Profit, ResultMsg, ShowConfig,
-                                                  PerformanceEntry, Ping, PlotConfig, Profit,
+                                                  Stats, StatusMsg, StrategyListResponse,
-                                                  ResultMsg, ShowConfig, Stats, StatusMsg,
+                                                  StrategyResponse, SysInfo, Version,
-                                                  StrategyListResponse, StrategyResponse, SysInfo,
-                                                  Version, WhitelistEvaluateResponse,
                                                   WhitelistResponse)
 from freqtrade.rpc.api_server.deps import get_config, get_exchange, get_rpc, get_rpc_optional
-from freqtrade.rpc.api_server.webserver_bgwork import ApiBG
 from freqtrade.rpc.rpc import RPCException
 
 
@@ -317,116 +313,6 @@ def get_strategy(strategy: str, config=Depends(get_config)):
     }
 
 
-@router.get('/pairlists/available',
-            response_model=PairListsResponse, tags=['pairlists', 'webserver'])
-def list_pairlists(config=Depends(get_config)):
-    from freqtrade.resolvers import PairListResolver
-    pairlists = PairListResolver.search_all_objects(
-        config, False)
-    pairlists = sorted(pairlists, key=lambda x: x['name'])
-
-    return {'pairlists': [{
-        "name": x['name'],
-        "is_pairlist_generator": x['class'].is_pairlist_generator,
-        "params": x['class'].available_parameters(),
-        "description": x['class'].description(),
-         } for x in pairlists
-    ]}
-
-
-def __run_pairlist(job_id: str, config_loc: Config):
-    try:
-
-        ApiBG.jobs[job_id]['is_running'] = True
-        from freqtrade.plugins.pairlistmanager import PairListManager
-
-        exchange = get_exchange(config_loc)
-        pairlists = PairListManager(exchange, config_loc)
-        pairlists.refresh_pairlist()
-        ApiBG.jobs[job_id]['result'] = {
-                'method': pairlists.name_list,
-                'length': len(pairlists.whitelist),
-                'whitelist': pairlists.whitelist
-            }
-        ApiBG.jobs[job_id]['status'] = 'success'
-    except (OperationalException, Exception) as e:
-        logger.exception(e)
-        ApiBG.jobs[job_id]['error'] = str(e)
-    finally:
-        ApiBG.jobs[job_id]['is_running'] = False
-        ApiBG.jobs[job_id]['status'] = 'failed'
-        ApiBG.pairlist_running = False
-
-
-@router.post('/pairlists/evaluate', response_model=BgJobStarted, tags=['pairlists'])
-def pairlists_evaluate(payload: PairListsPayload, background_tasks: BackgroundTasks,
-                       config=Depends(get_config)):
-    if ApiBG.pairlist_running:
-        raise HTTPException(status_code=400, detail='Pairlist evaluation is already running.')
-
-    config_loc = deepcopy(config)
-    config_loc['stake_currency'] = payload.stake_currency
-    config_loc['pairlists'] = payload.pairlists
-    # TODO: overwrite blacklist? make it optional and fall back to the one in config?
-    # Outcome depends on the UI approach.
-    config_loc['exchange']['pair_blacklist'] = payload.blacklist
-    # Random job id
-    job_id = ApiBG.get_job_id()
-
-    ApiBG.jobs[job_id] = {
-        'category': 'pairlist',
-        'status': 'pending',
-        'progress': None,
-        'is_running': False,
-        'result': {},
-        'error': None,
-    }
-    ApiBG.running_jobs.append(job_id)
-    background_tasks.add_task(__run_pairlist, job_id, config_loc)
-    ApiBG.pairlist_running = True
-
-    return {
-        'status': 'Pairlist evaluation started in background.',
-        'job_id': job_id,
-    }
-
-
-@router.get('/pairlists/evaluate/{jobid}', response_model=WhitelistEvaluateResponse,
-            tags=['pairlists'])
-def pairlists_evaluate_get(jobid: str):
-    if not (job := ApiBG.jobs.get(jobid)):
-        raise HTTPException(status_code=404, detail='Job not found.')
-
-    if job['is_running']:
-        raise HTTPException(status_code=400, detail='Job not finished yet.')
-
-    if error := job['error']:
-        return {
-            'status': 'failed',
-            'error': error,
-        }
-
-    return {
-        'status': 'success',
-        'result': job['result'],
-    }
-
-
-@router.get('/background/{jobid}', response_model=BackgroundTaskStatus, tags=['webserver'])
-def background_job(jobid: str):
-    if not (job := ApiBG.jobs.get(jobid)):
-        raise HTTPException(status_code=404, detail='Job not found.')
-
-    return {
-        'job_id': jobid,
-        'job_category': job['category'],
-        'status': job['status'],
-        'running': job['is_running'],
-        'progress': job.get('progress'),
-        # 'job_error': job['error'],
-    }
-
-
 @router.get('/freqaimodels', response_model=FreqAIModelListResponse, tags=['freqai'])
 def list_freqaimodels(config=Depends(get_config)):
     from freqtrade.resolvers.freqaimodel_resolver import FreqaiModelResolver

freqtrade/rpc/api_server/webserver.py

@@ -114,6 +114,7 @@ class ApiServer(RPCHandler):
 
     def configure_app(self, app: FastAPI, config):
         from freqtrade.rpc.api_server.api_auth import http_basic_or_jwt_token, router_login
+        from freqtrade.rpc.api_server.api_background_tasks import router as api_bg_tasks
         from freqtrade.rpc.api_server.api_backtest import router as api_backtest
         from freqtrade.rpc.api_server.api_v1 import router as api_v1
         from freqtrade.rpc.api_server.api_v1 import router_public as api_v1_public
@@ -130,6 +131,10 @@ class ApiServer(RPCHandler):
                            dependencies=[Depends(http_basic_or_jwt_token),
                                          Depends(is_webserver_mode)],
                            )
+        app.include_router(api_bg_tasks, prefix="/api/v1",
+                           dependencies=[Depends(http_basic_or_jwt_token),
+                                         Depends(is_webserver_mode)],
+                           )
         app.include_router(ws_router, prefix="/api/v1")
         app.include_router(router_login, prefix="/api/v1", tags=["auth"])
         # UI Router MUST be last!