From 3401e3506badf3084b52a83023d12aff01981731 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 08:09:03 +0100 Subject: [PATCH 01/31] Move rest_client to it's own sub-structure --- ft_client/freqtrade_client/__init__.py | 4 ++++ .../freqtrade_client/ft_rest_client.py | 0 2 files changed, 4 insertions(+) create mode 100644 ft_client/freqtrade_client/__init__.py rename scripts/rest_client.py => ft_client/freqtrade_client/ft_rest_client.py (100%) diff --git a/ft_client/freqtrade_client/__init__.py b/ft_client/freqtrade_client/__init__.py new file mode 100644 index 000000000..788256881 --- /dev/null +++ b/ft_client/freqtrade_client/__init__.py @@ -0,0 +1,4 @@ +from ft_rest_client import FtRestClient + + +__all__ = ['FtRestClient'] diff --git a/scripts/rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py similarity index 100% rename from scripts/rest_client.py rename to ft_client/freqtrade_client/ft_rest_client.py From 1036a890b8f85d8d51b7ce492953e71ff0657bd8 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 08:33:41 +0100 Subject: [PATCH 02/31] Split rest client script --- ft_client/freqtrade_client/__init__.py | 25 ++++- ft_client/freqtrade_client/ft_client.py | 106 +++++++++++++++++++ ft_client/freqtrade_client/ft_rest_client.py | 92 ---------------- ft_client/requirements.txt | 3 + 4 files changed, 133 insertions(+), 93 deletions(-) create mode 100644 ft_client/freqtrade_client/ft_client.py create mode 100644 ft_client/requirements.txt diff --git a/ft_client/freqtrade_client/__init__.py b/ft_client/freqtrade_client/__init__.py index 788256881..b5ccc914e 100644 --- a/ft_client/freqtrade_client/__init__.py +++ b/ft_client/freqtrade_client/__init__.py @@ -1,4 +1,27 @@ -from ft_rest_client import FtRestClient +from freqtrade_client.ft_rest_client import FtRestClient __all__ = ['FtRestClient'] + + +__version__ = '2024.3-dev' + +if 'dev' in __version__: + from pathlib import Path + try: + import subprocess + freqtrade_basedir = Path(__file__).parent + + __version__ = __version__ + '-' + subprocess.check_output( + ['git', 'log', '--format="%h"', '-n 1'], + stderr=subprocess.DEVNULL, cwd=freqtrade_basedir).decode("utf-8").rstrip().strip('"') + + except Exception: # pragma: no cover + # git not available, ignore + try: + # Try Fallback to freqtrade_commit file (created by CI while building docker image) + versionfile = Path('./freqtrade_commit') + if versionfile.is_file(): + __version__ = f"docker-{__version__}-{versionfile.read_text()[:8]}" + except Exception: + pass diff --git a/ft_client/freqtrade_client/ft_client.py b/ft_client/freqtrade_client/ft_client.py new file mode 100644 index 000000000..db34bce16 --- /dev/null +++ b/ft_client/freqtrade_client/ft_client.py @@ -0,0 +1,106 @@ +import argparse +import inspect +import json +import logging +import re +import sys +from pathlib import Path +from typing import Any, Dict + +import rapidjson +from freqtrade_client import __version__ +from freqtrade_client.ft_rest_client import FtRestClient + + +logging.basicConfig( + level=logging.INFO, + format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', +) +logger = logging.getLogger("ft_rest_client") + + +def add_arguments(): + parser = argparse.ArgumentParser() + parser.add_argument("command", + help="Positional argument defining the command to execute.", + nargs="?" + ) + parser.add_argument('-V', '--version', action='version', version=f'%(prog)s {__version__}') + parser.add_argument('--show', + help='Show possible methods with this client', + dest='show', + action='store_true', + default=False + ) + + parser.add_argument('-c', '--config', + help='Specify configuration file (default: %(default)s). ', + dest='config', + type=str, + metavar='PATH', + default='config.json' + ) + + parser.add_argument("command_arguments", + help="Positional arguments for the parameters for [command]", + nargs="*", + default=[] + ) + + args = parser.parse_args() + return vars(args) + + +def load_config(configfile): + file = Path(configfile) + if file.is_file(): + with file.open("r") as f: + config = rapidjson.load(f, parse_mode=rapidjson.PM_COMMENTS | + rapidjson.PM_TRAILING_COMMAS) + return config + else: + logger.warning(f"Could not load config file {file}.") + sys.exit(1) + + +def print_commands(): + # Print dynamic help for the different commands using the commands doc-strings + client = FtRestClient(None) + print("Possible commands:\n") + for x, y in inspect.getmembers(client): + if not x.startswith('_'): + doc = re.sub(':return:.*', '', getattr(client, x).__doc__, flags=re.MULTILINE).rstrip() + print(f"{x}\n\t{doc}\n") + + +def main_exec(args: Dict[str, Any]): + + if args.get("show"): + print_commands() + sys.exit() + + config = load_config(args['config']) + url = config.get('api_server', {}).get('listen_ip_address', '127.0.0.1') + port = config.get('api_server', {}).get('listen_port', '8080') + username = config.get('api_server', {}).get('username') + password = config.get('api_server', {}).get('password') + + server_url = f"http://{url}:{port}" + client = FtRestClient(server_url, username, password) + + m = [x for x, y in inspect.getmembers(client) if not x.startswith('_')] + command = args["command"] + if command not in m: + logger.error(f"Command {command} not defined") + print_commands() + return + + print(json.dumps(getattr(client, command)(*args["command_arguments"]))) + + +def main(): + """ + Main entry point for the client + """ + args = add_arguments() + main_exec(args) diff --git a/ft_client/freqtrade_client/ft_rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py index 5970b0c5b..9dccefc33 100755 --- a/ft_client/freqtrade_client/ft_rest_client.py +++ b/ft_client/freqtrade_client/ft_rest_client.py @@ -7,25 +7,15 @@ Should not import anything from freqtrade, so it can be used as a standalone script. """ -import argparse -import inspect import json import logging -import re -import sys -from pathlib import Path from typing import Optional from urllib.parse import urlencode, urlparse, urlunparse -import rapidjson import requests from requests.exceptions import ConnectionError -logging.basicConfig( - level=logging.INFO, - format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', -) logger = logging.getLogger("ft_rest_client") @@ -427,85 +417,3 @@ class FtRestClient: return self._get("health") -def add_arguments(): - parser = argparse.ArgumentParser() - parser.add_argument("command", - help="Positional argument defining the command to execute.", - nargs="?" - ) - - parser.add_argument('--show', - help='Show possible methods with this client', - dest='show', - action='store_true', - default=False - ) - - parser.add_argument('-c', '--config', - help='Specify configuration file (default: %(default)s). ', - dest='config', - type=str, - metavar='PATH', - default='config.json' - ) - - parser.add_argument("command_arguments", - help="Positional arguments for the parameters for [command]", - nargs="*", - default=[] - ) - - args = parser.parse_args() - return vars(args) - - -def load_config(configfile): - file = Path(configfile) - if file.is_file(): - with file.open("r") as f: - config = rapidjson.load(f, parse_mode=rapidjson.PM_COMMENTS | - rapidjson.PM_TRAILING_COMMAS) - return config - else: - logger.warning(f"Could not load config file {file}.") - sys.exit(1) - - -def print_commands(): - # Print dynamic help for the different commands using the commands doc-strings - client = FtRestClient(None) - print("Possible commands:\n") - for x, y in inspect.getmembers(client): - if not x.startswith('_'): - doc = re.sub(':return:.*', '', getattr(client, x).__doc__, flags=re.MULTILINE).rstrip() - print(f"{x}\n\t{doc}\n") - - -def main(args): - - if args.get("show"): - print_commands() - sys.exit() - - config = load_config(args['config']) - url = config.get('api_server', {}).get('listen_ip_address', '127.0.0.1') - port = config.get('api_server', {}).get('listen_port', '8080') - username = config.get('api_server', {}).get('username') - password = config.get('api_server', {}).get('password') - - server_url = f"http://{url}:{port}" - client = FtRestClient(server_url, username, password) - - m = [x for x, y in inspect.getmembers(client) if not x.startswith('_')] - command = args["command"] - if command not in m: - logger.error(f"Command {command} not defined") - print_commands() - return - - print(json.dumps(getattr(client, command)(*args["command_arguments"]))) - - -if __name__ == "__main__": - args = add_arguments() - main(args) diff --git a/ft_client/requirements.txt b/ft_client/requirements.txt new file mode 100644 index 000000000..56def4059 --- /dev/null +++ b/ft_client/requirements.txt @@ -0,0 +1,3 @@ +# Requirements for freqtrade client library +requests==2.31.0 +python-rapidjson==1.16 From bfe739da3cf8b1f0c2a0177597bcc3d058e7d027 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 08:34:00 +0100 Subject: [PATCH 03/31] Add pyproject.toml for ft_client installs --- ft_client/pyproject.toml | 54 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 ft_client/pyproject.toml diff --git a/ft_client/pyproject.toml b/ft_client/pyproject.toml new file mode 100644 index 000000000..b19757a64 --- /dev/null +++ b/ft_client/pyproject.toml @@ -0,0 +1,54 @@ +[build-system] +requires = ["setuptools >= 64.0.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "freqtrade_client" +dynamic = ["version"] + +authors = [ + {name = "Freqtrade Team"}, + {name = "Freqtrade Team", email = "freqtrade@protonmail.com"}, +] + +description = "Freqtrade - Client scripts" +# readme = "README.md" +requires-python = ">=3.9" +license = {text = "GPLv3"} +# license = "GPLv3" +classifiers = [ + "Environment :: Console", + "Intended Audience :: Science/Research", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Operating System :: MacOS", + "Operating System :: Unix", + "Topic :: Office/Business :: Financial :: Investment", +] + +dependencies = [ + 'requests >= 2.26.0', + 'python-rapidjson >= 1.0', +] + + +[project.urls] +Homepage = "https://github.com/freqtrade/freqtrade" +Documentation = "https://freqtrade.io" +"Bug Tracker" = "https://github.com/freqtrade/freqtrade/issues" + + +[project.scripts] +ft_rest = "freqtrade_client.ft_client:main" + +[tool.setuptools.packages.find] +where = ["."] +include = ["freqtrade_client*"] +exclude = ["tests", "tests.*"] +namespaces = true + +[tool.setuptools.dynamic] +version = {attr = "freqtrade_client.__version__"} From 5888da5bc5a8069786844c99ca38d14b23bfc1bc Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 08:39:28 +0100 Subject: [PATCH 04/31] Re-add rest_client script --- ft_client/freqtrade_client/ft_rest_client.py | 2 -- scripts/rest_client.py | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) create mode 100755 scripts/rest_client.py diff --git a/ft_client/freqtrade_client/ft_rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py index 9dccefc33..d88c99c9b 100755 --- a/ft_client/freqtrade_client/ft_rest_client.py +++ b/ft_client/freqtrade_client/ft_rest_client.py @@ -415,5 +415,3 @@ class FtRestClient: :return: json object """ return self._get("health") - - diff --git a/scripts/rest_client.py b/scripts/rest_client.py new file mode 100755 index 000000000..c22dd18ae --- /dev/null +++ b/scripts/rest_client.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python3 +""" +Simple command line client into RPC commands +Can be used as an alternate to Telegram + +Should not import anything from freqtrade, +so it can be used as a standalone script. +""" + +from freqtrade_client.ft_client import main + + +if __name__ == '__main__': + main() From 46622f617218131aa2dcd97fe4db6b2d9c6b8f54 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 09:00:22 +0100 Subject: [PATCH 05/31] Add minimal readme --- ft_client/README.md | 7 +++++++ ft_client/pyproject.toml | 4 ++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 ft_client/README.md diff --git a/ft_client/README.md b/ft_client/README.md new file mode 100644 index 000000000..a1921aa24 --- /dev/null +++ b/ft_client/README.md @@ -0,0 +1,7 @@ +# Freqtrade Client + +# ![freqtrade](https://raw.githubusercontent.com/freqtrade/freqtrade/develop/docs/assets/freqtrade_poweredby.svg) + +Provides a minimal rest client for the freqtrade rest api. + +Please check out the [main project](https://github.com/freqtrade/freqtrade) for more information or details. diff --git a/ft_client/pyproject.toml b/ft_client/pyproject.toml index b19757a64..e308eefea 100644 --- a/ft_client/pyproject.toml +++ b/ft_client/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools >= 64.0.0", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "freqtrade_client" +name = "freqtrade-client" dynamic = ["version"] authors = [ @@ -12,7 +12,7 @@ authors = [ ] description = "Freqtrade - Client scripts" -# readme = "README.md" +readme = "README.md" requires-python = ">=3.9" license = {text = "GPLv3"} # license = "GPLv3" From bd49ad642015932243037d3e2ea733826b316031 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 09:07:43 +0100 Subject: [PATCH 06/31] Add CI step for ft_rest_client --- .github/workflows/ci.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c3b0d6cb9..141f3786c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -467,6 +467,19 @@ jobs: dist retention-days: 10 + - name: Build Client distribution + run: | + pip install -U build + python -m build --sdist --wheel ft_client + + - name: Upload artifacts 📦 + uses: actions/upload-artifact@v4 + with: + name: freqtrade-client-build + path: | + ft_client/dist + retention-days: 10 + deploy-pypi: name: "Deploy to PyPI" needs: [ build ] @@ -484,8 +497,10 @@ jobs: - name: Download artifact 📦 uses: actions/download-artifact@v4 with: - name: freqtrade-build + name: freqtrade*-build path: dist + merge-multiple: true + - name: Publish to PyPI (Test) uses: pypa/gh-action-pypi-publish@v1.8.14 From 127f61ccb90bfba2fbf2b83dcb3c1eaf48777b61 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 09:08:21 +0100 Subject: [PATCH 07/31] Improve odering of things in ft-client --- ft_client/freqtrade_client/__init__.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/ft_client/freqtrade_client/__init__.py b/ft_client/freqtrade_client/__init__.py index b5ccc914e..c56ddf9fd 100644 --- a/ft_client/freqtrade_client/__init__.py +++ b/ft_client/freqtrade_client/__init__.py @@ -1,10 +1,7 @@ from freqtrade_client.ft_rest_client import FtRestClient -__all__ = ['FtRestClient'] - - -__version__ = '2024.3-dev' +__version__ = '2024.3-dev1' if 'dev' in __version__: from pathlib import Path @@ -25,3 +22,5 @@ if 'dev' in __version__: __version__ = f"docker-{__version__}-{versionfile.read_text()[:8]}" except Exception: pass + +__all__ = ['FtRestClient'] From bef15b5238d97a9a577eff8c73ba56bc23d72396 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 09:17:37 +0100 Subject: [PATCH 08/31] Add license for client file, exclude tests directory --- ft_client/LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++ ft_client/MANIFEST.in | 4 + 2 files changed, 678 insertions(+) create mode 100644 ft_client/LICENSE create mode 100644 ft_client/MANIFEST.in diff --git a/ft_client/LICENSE b/ft_client/LICENSE new file mode 100644 index 000000000..9cecc1d46 --- /dev/null +++ b/ft_client/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/ft_client/MANIFEST.in b/ft_client/MANIFEST.in new file mode 100644 index 000000000..cee1ed220 --- /dev/null +++ b/ft_client/MANIFEST.in @@ -0,0 +1,4 @@ +include LICENSE +include README.md + +prune tests From 7e3e65ecd85d5ee3504e7235ec27f7849b88b4ce Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 09:52:25 +0100 Subject: [PATCH 09/31] Add tests for rest client --- ft_client/test_client/__init__.py | 0 ft_client/test_client/test_rest_client.py | 94 +++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 ft_client/test_client/__init__.py create mode 100644 ft_client/test_client/test_rest_client.py diff --git a/ft_client/test_client/__init__.py b/ft_client/test_client/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py new file mode 100644 index 000000000..aab9e2bdd --- /dev/null +++ b/ft_client/test_client/test_rest_client.py @@ -0,0 +1,94 @@ +from unittest.mock import MagicMock + +import pytest +from freqtrade_client import FtRestClient + + +def get_rest_client(): + client = FtRestClient('http://localhost:8080', 'freqtrader', 'password') + client._session = MagicMock() + request_mock = MagicMock() + client._session.request = request_mock + return client, request_mock + + +def test_FtRestClient_init(): + client = FtRestClient('http://localhost:8080', 'freqtrader', 'password') + assert client is not None + assert client._serverurl == 'http://localhost:8080' + assert client._session is not None + assert client._session.auth is not None + assert client._session.auth == ('freqtrader', 'password') + + +@pytest.mark.parametrize('method', ['GET', 'POST', 'DELETE']) +def test_FtRestClient_call(method): + client, mock = get_rest_client() + client._call(method, '/dummytest') + assert mock.call_count == 1 + + getattr(client, f"_{method.lower()}")('/dummytest') + assert mock.call_count == 2 + + +@pytest.mark.parametrize('method,args', [ + ('start', []), + ('stop', []), + ('stopbuy', []), + ('reload_config', []), + ('balance', []), + ('count', []), + ('entries', []), + ('exits', []), + ('mix_tags', []), + ('locks', []), + ('delete_lock', [2]), + ('daily', []), + ('daily', [15]), + ('weekly', []), + ('weekly', [15]), + ('monthly', []), + ('monthly', [12]), + ('edge', []), + ('profit', []), + ('stats', []), + ('performance', []), + ('status', []), + ('version', []), + ('show_config', []), + ('ping', []), + ('logs', []), + ('logs', [55]), + ('trades', []), + ('trades', [5]), + ('trades', [5, 5]), # With offset + ('trade', [1]), + ('delete_trade', [1]), + ('cancel_open_order', [1]), + ('whitelist', []), + ('blacklist', ['XRP/USDT']), + ('blacklist', ['XRP/USDT', 'BTC/USDT']), + ('forcebuy', ['XRP/USDT']), + ('forcebuy', ['XRP/USDT', 1.5]), + ('forceenter', ['XRP/USDT', 'short']), + ('forceenter', ['XRP/USDT', 'short', 1.5]), + ('forceexit', [1]), + ('forceexit', [1, 'limit']), + ('forceexit', [1, 'limit', 100]), + ('strategies', []), + ('strategy', ['sampleStrategy']), + ('pairlists_available', []), + ('plot_config', []), + ('available_pairs', []), + ('available_pairs', ['5m']), + ('pair_candles', ['XRP/USDT', '5m']), + ('pair_candles', ['XRP/USDT', '5m', 500]), + ('pair_history', ['XRP/USDT', '5m', 'SampleStrategy']), + ('sysinfo', []), + ('health', []), +]) +def test_FtRestClient_call_explicit_methods(method, args): + client, mock = get_rest_client() + exec = getattr(client, method) + exec(*args) + assert mock.call_count == 1 From f0e0957579aad39fa9b7c5b2d2d28c15006dfcb6 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 09:57:12 +0100 Subject: [PATCH 10/31] Don't set same parameters twice --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 141f3786c..0e355131f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -404,7 +404,7 @@ jobs: env: CI_WEB_PROXY: http://152.67.78.211:13128 run: | - pytest --random-order --longrun --durations 20 -n auto --dist loadscope + pytest --random-order --longrun --durations 20 -n auto # Notify only once - when CI completes (and after deploy) in case it's successfull From 0c026f950b49cd6ca537c4265dc0223fe46a92d1 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 10:03:15 +0100 Subject: [PATCH 11/31] Ensure versions are aligned between freqtrade and freqtrade_client --- .github/workflows/ci.yml | 4 ++++ build_helpers/freqtrade_client_version_align.py | 17 +++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 build_helpers/freqtrade_client_version_align.py diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0e355131f..2685a23bc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -108,6 +108,10 @@ jobs: run: | ruff check --output-format=github . + - name: Check for version alignment + run: | + build_helpers/freqtrade_client_version_align.py + - name: Mypy run: | mypy freqtrade scripts tests diff --git a/build_helpers/freqtrade_client_version_align.py b/build_helpers/freqtrade_client_version_align.py new file mode 100644 index 000000000..1b9b52b56 --- /dev/null +++ b/build_helpers/freqtrade_client_version_align.py @@ -0,0 +1,17 @@ +from freqtrade_client import __version__ as client_version + +from freqtrade import __version__ as ft_version + + +def main(): + if ft_version != client_version: + print(f"Versions do not match: \n" + f"ft: {ft_version} \n" + f"client: {client_version}") + exit(1) + print(f"Versions match: ft: {ft_version}, client: {client_version}") + exit(0) + + +if __name__ == '__main__': + main() From 772dbeaf7eae58792998bfbccb05198775afada0 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 10:15:35 +0100 Subject: [PATCH 12/31] Fix file permissions --- build_helpers/freqtrade_client_version_align.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 build_helpers/freqtrade_client_version_align.py diff --git a/build_helpers/freqtrade_client_version_align.py b/build_helpers/freqtrade_client_version_align.py old mode 100644 new mode 100755 From 01bb7706e42134cff7925fc01cfa1ec0f388d5ed Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 10:26:18 +0100 Subject: [PATCH 13/31] Fix messed up version-align script --- build_helpers/freqtrade_client_version_align.py | 1 + 1 file changed, 1 insertion(+) diff --git a/build_helpers/freqtrade_client_version_align.py b/build_helpers/freqtrade_client_version_align.py index 1b9b52b56..3e2c32e20 100755 --- a/build_helpers/freqtrade_client_version_align.py +++ b/build_helpers/freqtrade_client_version_align.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 from freqtrade_client import __version__ as client_version from freqtrade import __version__ as ft_version From afe3d3ebdad4705a2e671ee4fa3c3631ecc5639c Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 10:26:44 +0100 Subject: [PATCH 14/31] Move Version check to the top --- .github/workflows/ci.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2685a23bc..3d96aa04e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -62,6 +62,10 @@ jobs: pip install -r requirements-dev.txt pip install -e . + - name: Check for version alignment + run: | + build_helpers/freqtrade_client_version_align.py + - name: Tests run: | pytest --random-order --cov=freqtrade --cov-config=.coveragerc @@ -108,10 +112,6 @@ jobs: run: | ruff check --output-format=github . - - name: Check for version alignment - run: | - build_helpers/freqtrade_client_version_align.py - - name: Mypy run: | mypy freqtrade scripts tests From 3f226c50220b000ab263962fdda5db18c4136d84 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 10:35:55 +0100 Subject: [PATCH 15/31] Also install ft-client in linux CI --- .github/workflows/ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3d96aa04e..45204b69b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -60,11 +60,12 @@ jobs: export TA_LIBRARY_PATH=${HOME}/dependencies/lib export TA_INCLUDE_PATH=${HOME}/dependencies/include pip install -r requirements-dev.txt + pip install -e ft_client/ pip install -e . - name: Check for version alignment run: | - build_helpers/freqtrade_client_version_align.py + python build_helpers/freqtrade_client_version_align.py - name: Tests run: | From fba028abd104bb010743c1ca10516a7133afee51 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 10:41:48 +0100 Subject: [PATCH 16/31] Fix version number --- ft_client/freqtrade_client/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ft_client/freqtrade_client/__init__.py b/ft_client/freqtrade_client/__init__.py index c56ddf9fd..4d945935a 100644 --- a/ft_client/freqtrade_client/__init__.py +++ b/ft_client/freqtrade_client/__init__.py @@ -1,7 +1,7 @@ from freqtrade_client.ft_rest_client import FtRestClient -__version__ = '2024.3-dev1' +__version__ = '2024.3-dev' if 'dev' in __version__: from pathlib import Path From ca9d792d2a76ad0f223dfc8116e1ffe232df6d6f Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 11:08:40 +0100 Subject: [PATCH 17/31] License to link --- ft_client/LICENSE | 675 +--------------------------------------------- 1 file changed, 1 insertion(+), 674 deletions(-) mode change 100644 => 120000 ft_client/LICENSE diff --git a/ft_client/LICENSE b/ft_client/LICENSE deleted file mode 100644 index 9cecc1d46..000000000 --- a/ft_client/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - {project} Copyright (C) {year} {fullname} - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/ft_client/LICENSE b/ft_client/LICENSE new file mode 120000 index 000000000..ea5b60640 --- /dev/null +++ b/ft_client/LICENSE @@ -0,0 +1 @@ +../LICENSE \ No newline at end of file From 79b8363b7b0ff9f8eff7ccfd8954a436464b140a Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 12:31:25 +0100 Subject: [PATCH 18/31] Depend on freqtrade-client on install --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index dea1966fa..f292a5349 100644 --- a/setup.py +++ b/setup.py @@ -112,6 +112,7 @@ setup( 'python-dateutil', 'pytz', 'packaging', + 'freqtrade-client', ], extras_require={ 'dev': all_extra, From 7eb91c74a8706af923126f9e335cc932c4c60f8b Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 12:32:00 +0100 Subject: [PATCH 19/31] CI - always install ft_client --- .github/workflows/ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 45204b69b..e101100eb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -193,6 +193,7 @@ jobs: export TA_LIBRARY_PATH=${HOME}/dependencies/lib export TA_INCLUDE_PATH=${HOME}/dependencies/include pip install -r requirements-dev.txt + pip install -e ft_client/ pip install -e . - name: Tests @@ -403,6 +404,7 @@ jobs: export TA_LIBRARY_PATH=${HOME}/dependencies/lib export TA_INCLUDE_PATH=${HOME}/dependencies/include pip install -r requirements-dev.txt + pip install -e ft_client/ pip install -e . - name: Tests incl. ccxt compatibility tests From a6ad36d08bf6c88c8416848c0d0853997df11da4 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 12:33:28 +0100 Subject: [PATCH 20/31] Coverage for ft_client ... --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e101100eb..cb6d306ee 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -69,7 +69,7 @@ jobs: - name: Tests run: | - pytest --random-order --cov=freqtrade --cov-config=.coveragerc + pytest --random-order --cov-config=.coveragerc - name: Coveralls if: (runner.os == 'Linux' && matrix.python-version == '3.10' && matrix.os == 'ubuntu-22.04') From 0a0105c31ee4066b79ef16167a468954190a8d38 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 12:46:05 +0100 Subject: [PATCH 21/31] Re-add --cov args --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cb6d306ee..b88d87928 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -69,7 +69,7 @@ jobs: - name: Tests run: | - pytest --random-order --cov-config=.coveragerc + pytest --random-order --cov=freqtrade --cov=freqtrade_client --cov-config=.coveragerc - name: Coveralls if: (runner.os == 'Linux' && matrix.python-version == '3.10' && matrix.os == 'ubuntu-22.04') From 66422ce9a90401d4a987592e506f4a70e612fb00 Mon Sep 17 00:00:00 2001 From: froggleston Date: Fri, 29 Mar 2024 11:52:00 +0000 Subject: [PATCH 22/31] Add support for requests pool size configuration --- ft_client/freqtrade_client/ft_rest_client.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/ft_client/freqtrade_client/ft_rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py index d88c99c9b..bc6990181 100755 --- a/ft_client/freqtrade_client/ft_rest_client.py +++ b/ft_client/freqtrade_client/ft_rest_client.py @@ -21,10 +21,19 @@ logger = logging.getLogger("ft_rest_client") class FtRestClient: - def __init__(self, serverurl, username=None, password=None): + def __init__(self, serverurl, username=None, password=None, + pool_connections=10, pool_maxsize=10): self._serverurl = serverurl self._session = requests.Session() + + # allow configuration of pool + adapter = requests.adapters.HTTPAdapter( + pool_connections=pool_connections, + pool_maxsize=pool_maxsize + ) + self._session.mount('http://', adapter) + self._session.auth = (username, password) def _call(self, method, apipath, params: Optional[dict] = None, data=None, files=None): From e971f043f42e96dbdc8b17204e02c9edcfe4c9ce Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 13:12:01 +0100 Subject: [PATCH 23/31] Improve test cov --- ft_client/freqtrade_client/ft_client.py | 6 +++--- ft_client/test_client/test_rest_client.py | 14 ++++++++++++++ 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/ft_client/freqtrade_client/ft_client.py b/ft_client/freqtrade_client/ft_client.py index db34bce16..96a7510ff 100644 --- a/ft_client/freqtrade_client/ft_client.py +++ b/ft_client/freqtrade_client/ft_client.py @@ -19,7 +19,7 @@ logging.basicConfig( logger = logging.getLogger("ft_rest_client") -def add_arguments(): +def add_arguments(args: Any = None): parser = argparse.ArgumentParser() parser.add_argument("command", help="Positional argument defining the command to execute.", @@ -47,8 +47,8 @@ def add_arguments(): default=[] ) - args = parser.parse_args() - return vars(args) + pargs = parser.parse_args(args) + return vars(pargs) def load_config(configfile): diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py index aab9e2bdd..24affd67c 100644 --- a/ft_client/test_client/test_rest_client.py +++ b/ft_client/test_client/test_rest_client.py @@ -2,6 +2,7 @@ from unittest.mock import MagicMock import pytest from freqtrade_client import FtRestClient +from freqtrade_client.ft_client import add_arguments, main_exec def get_rest_client(): @@ -92,3 +93,16 @@ def test_FtRestClient_call_explicit_methods(method, args): exec = getattr(client, method) exec(*args) assert mock.call_count == 1 + + +def test_ft_client(capsys): + with pytest.raises(SystemExit): + args = add_arguments(['-V']) + + args = add_arguments(['--show']) + assert isinstance(args, dict) + assert args['show'] is True + with pytest.raises(SystemExit): + main_exec(args) + captured = capsys.readouterr() + assert 'Possible commands' in captured.out From e072522ed169051c1b67afd0815d6d21358a165f Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 13:18:11 +0100 Subject: [PATCH 24/31] Improve tests --- ft_client/test_client/test_rest_client.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py index 24affd67c..58728b37b 100644 --- a/ft_client/test_client/test_rest_client.py +++ b/ft_client/test_client/test_rest_client.py @@ -4,6 +4,8 @@ import pytest from freqtrade_client import FtRestClient from freqtrade_client.ft_client import add_arguments, main_exec +from freqtrade.vendor.qtpylib.indicators import returns + def get_rest_client(): client = FtRestClient('http://localhost:8080', 'freqtrader', 'password') @@ -95,7 +97,7 @@ def test_FtRestClient_call_explicit_methods(method, args): assert mock.call_count == 1 -def test_ft_client(capsys): +def test_ft_client(mocker, capsys): with pytest.raises(SystemExit): args = add_arguments(['-V']) @@ -106,3 +108,13 @@ def test_ft_client(capsys): main_exec(args) captured = capsys.readouterr() assert 'Possible commands' in captured.out + + mock = mocker.patch('freqtrade_client.ft_client.FtRestClient._call') + args = add_arguments([ + '--config', + 'tests/testdata/testconfigs/main_test_config.json', + 'ping' + ]) + main_exec(args) + captured = capsys.readouterr() + assert mock.call_count == 1 From d047ac67a8b5e1c803001877467476ccbf4c20eb Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 15:06:58 +0100 Subject: [PATCH 25/31] Remove unused import --- ft_client/test_client/test_rest_client.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py index 58728b37b..bd16803b4 100644 --- a/ft_client/test_client/test_rest_client.py +++ b/ft_client/test_client/test_rest_client.py @@ -4,8 +4,6 @@ import pytest from freqtrade_client import FtRestClient from freqtrade_client.ft_client import add_arguments, main_exec -from freqtrade.vendor.qtpylib.indicators import returns - def get_rest_client(): client = FtRestClient('http://localhost:8080', 'freqtrader', 'password') From 411322357c7b2872496fb6f4d6f91e07a4054e63 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 15:52:35 +0100 Subject: [PATCH 26/31] Slightly enhance test cov --- ft_client/test_client/test_rest_client.py | 34 ++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py index bd16803b4..60decbe18 100644 --- a/ft_client/test_client/test_rest_client.py +++ b/ft_client/test_client/test_rest_client.py @@ -3,6 +3,12 @@ from unittest.mock import MagicMock import pytest from freqtrade_client import FtRestClient from freqtrade_client.ft_client import add_arguments, main_exec +from requests.exceptions import ConnectionError + + +def log_has(line, logs): + """Check if line is found on some caplog's message.""" + return any(line == message for message in logs.messages) def get_rest_client(): @@ -32,6 +38,17 @@ def test_FtRestClient_call(method): assert mock.call_count == 2 +def test_FtRestClient_call_invalid(caplog): + client, _ = get_rest_client() + with pytest.raises(ValueError): + client._call('PUTTY', '/dummytest') + + client._session.request = MagicMock(side_effect=ConnectionError()) + client._call('GET', '/dummytest') + + assert log_has('Connection error', caplog) + + @pytest.mark.parametrize('method,args', [ ('start', []), ('stop', []), @@ -67,6 +84,7 @@ def test_FtRestClient_call(method): ('delete_trade', [1]), ('cancel_open_order', [1]), ('whitelist', []), + ('blacklist', []), ('blacklist', ['XRP/USDT']), ('blacklist', ['XRP/USDT', 'BTC/USDT']), ('forcebuy', ['XRP/USDT']), @@ -95,7 +113,7 @@ def test_FtRestClient_call_explicit_methods(method, args): assert mock.call_count == 1 -def test_ft_client(mocker, capsys): +def test_ft_client(mocker, capsys, caplog): with pytest.raises(SystemExit): args = add_arguments(['-V']) @@ -116,3 +134,17 @@ def test_ft_client(mocker, capsys): main_exec(args) captured = capsys.readouterr() assert mock.call_count == 1 + + with pytest.raises(SystemExit): + args = add_arguments(['--config', '/dev/null']) + main_exec(args) + + assert log_has('Could not load config file /dev/null.', caplog) + + args = add_arguments([ + '--config', + 'tests/testdata/testconfigs/main_test_config.json', + 'whatever' + ]) + main_exec(args) + assert log_has('Command whatever not defined', caplog) From e8cea35f5ed1b11a4a02711ce48a04e70312f0fb Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 16:15:50 +0100 Subject: [PATCH 27/31] Have Pool parameters be kw only --- ft_client/freqtrade_client/ft_rest_client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ft_client/freqtrade_client/ft_rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py index bc6990181..a30b1be87 100755 --- a/ft_client/freqtrade_client/ft_rest_client.py +++ b/ft_client/freqtrade_client/ft_rest_client.py @@ -21,7 +21,7 @@ logger = logging.getLogger("ft_rest_client") class FtRestClient: - def __init__(self, serverurl, username=None, password=None, + def __init__(self, serverurl, username=None, password=None, *, pool_connections=10, pool_maxsize=10): self._serverurl = serverurl From 8ad037507347e39357f92436e9c4ae3e8b7438f7 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 16:16:34 +0100 Subject: [PATCH 28/31] Update docstring --- ft_client/freqtrade_client/ft_rest_client.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/ft_client/freqtrade_client/ft_rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py index a30b1be87..de782ee65 100755 --- a/ft_client/freqtrade_client/ft_rest_client.py +++ b/ft_client/freqtrade_client/ft_rest_client.py @@ -1,10 +1,8 @@ -#!/usr/bin/env python3 """ -Simple command line client into RPC commands -Can be used as an alternate to Telegram +A Rest Client for Freqtrade bot Should not import anything from freqtrade, -so it can be used as a standalone script. +so it can be used as a standalone script, and can be installed independently. """ import json From 01f09ca5c85188f2f134ead9591b8cfcae72ef3c Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 16:38:13 +0100 Subject: [PATCH 29/31] Update command name and documentation --- docs/rest-api.md | 12 +++++++----- ft_client/pyproject.toml | 2 +- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/rest-api.md b/docs/rest-api.md index 229fa5f94..3baff8506 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -95,11 +95,13 @@ Make sure that the following 2 lines are available in your docker-compose file: ### Consuming the API -You can consume the API by using the script `scripts/rest_client.py`. -The client script only requires the `requests` module, so Freqtrade does not need to be installed on the system. +You can consume the API by using `freqtrade-client` (also available as `scripts/rest_client.py`). +This command can be installed independent of the bot by using `pip install freqtrade-client`. + +This module is designed to be lightweight, and only depends on the `requests` and `python-rapidjson` modules, skipping all heavy dependencies freqtrade otherwise needs. ``` bash -python3 scripts/rest_client.py [optional parameters] +freqtrade-client [optional parameters] ``` By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be used, however you can specify a configuration file to override this behaviour. @@ -120,7 +122,7 @@ By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be use ``` ``` bash -python3 scripts/rest_client.py --config rest_config.json [optional parameters] +freqtrade-client --config rest_config.json [optional parameters] ``` ### Available endpoints @@ -176,7 +178,7 @@ python3 scripts/rest_client.py --config rest_config.json [optional par Possible commands can be listed from the rest-client script using the `help` command. ``` bash -python3 scripts/rest_client.py help +freqtrade-client help ``` ``` output diff --git a/ft_client/pyproject.toml b/ft_client/pyproject.toml index e308eefea..919e524f8 100644 --- a/ft_client/pyproject.toml +++ b/ft_client/pyproject.toml @@ -42,7 +42,7 @@ Documentation = "https://freqtrade.io" [project.scripts] -ft_rest = "freqtrade_client.ft_client:main" +freqtrade-client = "freqtrade_client.ft_client:main" [tool.setuptools.packages.find] where = ["."] From d606d6d08a709bf313c3da1bf9ab3e3191df421f Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 17:03:31 +0100 Subject: [PATCH 30/31] Use a path that works on windows, too. --- ft_client/test_client/test_rest_client.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py index 60decbe18..880e0974c 100644 --- a/ft_client/test_client/test_rest_client.py +++ b/ft_client/test_client/test_rest_client.py @@ -136,10 +136,11 @@ def test_ft_client(mocker, capsys, caplog): assert mock.call_count == 1 with pytest.raises(SystemExit): - args = add_arguments(['--config', '/dev/null']) + args = add_arguments(['--config', 'tests/testdata/testconfigs/nonexisting.json']) main_exec(args) - assert log_has('Could not load config file /dev/null.', caplog) + assert log_has('Could not load config file tests/testdata/testconfigs/nonexisting.json.', + caplog) args = add_arguments([ '--config', From e100a06785e690dd44d0acb747351c5906089703 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2024 19:09:23 +0100 Subject: [PATCH 31/31] Use regex to match logs in rest-client tests --- ft_client/test_client/test_rest_client.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/ft_client/test_client/test_rest_client.py b/ft_client/test_client/test_rest_client.py index 880e0974c..e7c2f32e6 100644 --- a/ft_client/test_client/test_rest_client.py +++ b/ft_client/test_client/test_rest_client.py @@ -1,3 +1,4 @@ +import re from unittest.mock import MagicMock import pytest @@ -6,9 +7,9 @@ from freqtrade_client.ft_client import add_arguments, main_exec from requests.exceptions import ConnectionError -def log_has(line, logs): - """Check if line is found on some caplog's message.""" - return any(line == message for message in logs.messages) +def log_has_re(line, logs): + """Check if line matches some caplog's message.""" + return any(re.match(line, message) for message in logs.messages) def get_rest_client(): @@ -46,7 +47,7 @@ def test_FtRestClient_call_invalid(caplog): client._session.request = MagicMock(side_effect=ConnectionError()) client._call('GET', '/dummytest') - assert log_has('Connection error', caplog) + assert log_has_re('Connection error', caplog) @pytest.mark.parametrize('method,args', [ @@ -139,8 +140,8 @@ def test_ft_client(mocker, capsys, caplog): args = add_arguments(['--config', 'tests/testdata/testconfigs/nonexisting.json']) main_exec(args) - assert log_has('Could not load config file tests/testdata/testconfigs/nonexisting.json.', - caplog) + assert log_has_re(r'Could not load config file .*nonexisting\.json\.', + caplog) args = add_arguments([ '--config', @@ -148,4 +149,4 @@ def test_ft_client(mocker, capsys, caplog): 'whatever' ]) main_exec(args) - assert log_has('Command whatever not defined', caplog) + assert log_has_re('Command whatever not defined', caplog)