freqtrade_origin/freqtrade/commands/deploy_commands.py

190 lines
6.5 KiB
Python
Raw Permalink Normal View History

import logging
import sys
from pathlib import Path
2021-01-31 13:39:46 +00:00
from typing import Any, Dict, Optional, Tuple
2021-01-10 13:06:06 +00:00
import requests
from freqtrade.configuration import setup_utils_configuration
2020-09-28 17:39:41 +00:00
from freqtrade.configuration.directory_operations import copy_sample_files, create_userdata_dir
2021-09-11 06:36:57 +00:00
from freqtrade.constants import USERPATH_STRATEGIES
2021-06-08 19:20:35 +00:00
from freqtrade.enums import RunMode
2024-03-19 06:13:17 +00:00
from freqtrade.exceptions import ConfigurationError, OperationalException
2023-08-15 05:42:05 +00:00
from freqtrade.util import render_template, render_template_with_fallback
2020-09-28 17:39:41 +00:00
logger = logging.getLogger(__name__)
# Timeout for requests
req_timeout = 30
def start_create_userdir(args: Dict[str, Any]) -> None:
"""
Create "user_data" directory to contain user data strategies, hyperopt, ...)
:param args: Cli args from Arguments()
:return: None
"""
if "user_data_dir" in args and args["user_data_dir"]:
userdir = create_userdata_dir(args["user_data_dir"], create_dir=True)
copy_sample_files(userdir, overwrite=args["reset"])
else:
logger.warning("`create-userdir` requires --userdir to be set.")
sys.exit(1)
2020-02-02 04:00:40 +00:00
def deploy_new_strategy(strategy_name: str, strategy_path: Path, subtemplate: str) -> None:
"""
Deploy new strategy from template to strategy_path
"""
2024-05-12 14:27:03 +00:00
fallback = "full"
attributes = render_template_with_fallback(
templatefile=f"strategy_subtemplates/strategy_attributes_{subtemplate}.j2",
templatefallbackfile=f"strategy_subtemplates/strategy_attributes_{fallback}.j2",
)
indicators = render_template_with_fallback(
templatefile=f"strategy_subtemplates/indicators_{subtemplate}.j2",
templatefallbackfile=f"strategy_subtemplates/indicators_{fallback}.j2",
2021-08-06 22:19:36 +00:00
)
buy_trend = render_template_with_fallback(
templatefile=f"strategy_subtemplates/buy_trend_{subtemplate}.j2",
templatefallbackfile=f"strategy_subtemplates/buy_trend_{fallback}.j2",
2021-08-06 22:19:36 +00:00
)
sell_trend = render_template_with_fallback(
templatefile=f"strategy_subtemplates/sell_trend_{subtemplate}.j2",
templatefallbackfile=f"strategy_subtemplates/sell_trend_{fallback}.j2",
2021-08-06 22:19:36 +00:00
)
plot_config = render_template_with_fallback(
templatefile=f"strategy_subtemplates/plot_config_{subtemplate}.j2",
templatefallbackfile=f"strategy_subtemplates/plot_config_{fallback}.j2",
)
additional_methods = render_template_with_fallback(
templatefile=f"strategy_subtemplates/strategy_methods_{subtemplate}.j2",
templatefallbackfile="strategy_subtemplates/strategy_methods_empty.j2",
)
2024-05-12 14:27:03 +00:00
strategy_text = render_template(
templatefile="base_strategy.py.j2",
arguments={
"strategy": strategy_name,
"attributes": attributes,
"indicators": indicators,
"buy_trend": buy_trend,
"sell_trend": sell_trend,
"plot_config": plot_config,
"additional_methods": additional_methods,
},
)
logger.info(f"Writing strategy to `{strategy_path}`.")
strategy_path.write_text(strategy_text)
def start_new_strategy(args: Dict[str, Any]) -> None:
config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
if "strategy" in args and args["strategy"]:
2024-05-12 14:27:03 +00:00
new_path = config["user_data_dir"] / USERPATH_STRATEGIES / (args["strategy"] + ".py")
if new_path.exists():
2024-05-12 14:27:03 +00:00
raise OperationalException(
2024-05-12 15:51:21 +00:00
f"`{new_path}` already exists. Please choose another Strategy Name."
2024-05-12 14:27:03 +00:00
)
2024-05-12 14:27:03 +00:00
deploy_new_strategy(args["strategy"], new_path, args["template"])
else:
2024-03-19 06:13:17 +00:00
raise ConfigurationError("`new-strategy` requires --strategy to be set.")
2021-01-10 12:55:16 +00:00
def clean_ui_subdir(directory: Path):
if directory.is_dir():
2021-01-10 13:06:06 +00:00
logger.info("Removing UI directory content.")
2021-01-10 12:55:16 +00:00
2024-05-12 14:27:03 +00:00
for p in reversed(list(directory.glob("**/*"))): # iterate contents from leaves to root
if p.name in (".gitkeep", "fallback_file.html"):
2021-01-10 12:55:16 +00:00
continue
if p.is_file():
p.unlink()
elif p.is_dir():
p.rmdir()
2021-01-31 13:39:46 +00:00
def read_ui_version(dest_folder: Path) -> Optional[str]:
2024-05-12 14:27:03 +00:00
file = dest_folder / ".uiversion"
2021-01-31 13:39:46 +00:00
if not file.is_file():
return None
2024-05-12 14:27:03 +00:00
with file.open("r") as f:
2021-01-31 13:39:46 +00:00
return f.read()
def download_and_install_ui(dest_folder: Path, dl_url: str, version: str):
2021-01-10 12:55:16 +00:00
from io import BytesIO
from zipfile import ZipFile
logger.info(f"Downloading {dl_url}")
resp = requests.get(dl_url, timeout=req_timeout).content
2021-01-31 14:37:57 +00:00
dest_folder.mkdir(parents=True, exist_ok=True)
2021-01-10 12:55:16 +00:00
with ZipFile(BytesIO(resp)) as zf:
for fn in zf.filelist:
with zf.open(fn) as x:
destfile = dest_folder / fn.filename
if fn.is_dir():
destfile.mkdir(exist_ok=True)
else:
destfile.write_bytes(x.read())
2024-05-12 14:27:03 +00:00
with (dest_folder / ".uiversion").open("w") as f:
2021-01-31 13:39:46 +00:00
f.write(version)
2021-01-10 12:55:16 +00:00
def get_ui_download_url(version: Optional[str] = None) -> Tuple[str, str]:
2024-05-12 14:27:03 +00:00
base_url = "https://api.github.com/repos/freqtrade/frequi/"
2021-01-10 13:06:06 +00:00
# Get base UI Repo path
resp = requests.get(f"{base_url}releases", timeout=req_timeout)
2021-01-10 13:06:06 +00:00
resp.raise_for_status()
r = resp.json()
if version:
2024-05-12 14:27:03 +00:00
tmp = [x for x in r if x["name"] == version]
if tmp:
2024-05-12 14:27:03 +00:00
latest_version = tmp[0]["name"]
assets = tmp[0].get("assets", [])
else:
raise ValueError("UI-Version not found.")
else:
2024-05-12 14:27:03 +00:00
latest_version = r[0]["name"]
assets = r[0].get("assets", [])
dl_url = ""
if assets and len(assets) > 0:
2024-05-12 14:27:03 +00:00
dl_url = assets[0]["browser_download_url"]
# URL not found - try assets url
if not dl_url:
2024-05-12 14:27:03 +00:00
assets = r[0]["assets_url"]
resp = requests.get(assets, timeout=req_timeout)
r = resp.json()
2024-05-12 14:27:03 +00:00
dl_url = r[0]["browser_download_url"]
2021-01-10 13:06:06 +00:00
return dl_url, latest_version
2021-01-10 13:46:59 +00:00
def start_install_ui(args: Dict[str, Any]) -> None:
2024-05-12 14:27:03 +00:00
dest_folder = Path(__file__).parents[1] / "rpc/api_server/ui/installed/"
2021-01-10 13:46:59 +00:00
# First make sure the assets are removed.
2024-05-12 14:27:03 +00:00
dl_url, latest_version = get_ui_download_url(args.get("ui_version"))
2021-01-31 13:39:46 +00:00
curr_version = read_ui_version(dest_folder)
2024-05-12 14:27:03 +00:00
if curr_version == latest_version and not args.get("erase_ui_only"):
2021-01-31 13:43:16 +00:00
logger.info(f"UI already up-to-date, FreqUI Version {curr_version}.")
2021-01-31 13:39:46 +00:00
return
2021-01-31 13:43:16 +00:00
clean_ui_subdir(dest_folder)
2024-05-12 14:27:03 +00:00
if args.get("erase_ui_only"):
2021-01-16 09:15:27 +00:00
logger.info("Erased UI directory content. Not downloading new version.")
else:
# Download a new version
2021-01-31 13:39:46 +00:00
download_and_install_ui(dest_folder, dl_url, latest_version)