Export backtesting results by default

closes #4977
2021-06-14 19:57:24 +02:00 · 2021-06-14 19:57:24 +02:00 · cf7394d01c
commit cf7394d01c
parent 9c789856bd
7 changed files with 28 additions and 20 deletions
--- a/docs/backtesting.md
+++ b/docs/backtesting.md
@ -19,7 +19,7 @@ usage: freqtrade backtesting [-h] [-v] [--logfile FILE] [-V] [-c PATH]
                             [--enable-protections]
                             [--dry-run-wallet DRY_RUN_WALLET]
                             [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
-                             [--export EXPORT] [--export-filename PATH]
+                             [--export {none,trades}] [--export-filename PATH]

 optional arguments:
  -h, --help            show this help message and exit
@ -63,8 +63,8 @@ optional arguments:
                        name is injected into the filename (so `backtest-
                        data.json` becomes `backtest-data-
                        DefaultStrategy.json`
-  --export EXPORT       Export backtest results, argument are: trades.
-                        Example: `--export=trades`
+  --export {none,trades}
+                        Export backtest results (default: trades).
  --export-filename PATH
                        Save backtest results to the file with this filename.
                        Requires `--export` to be set as well. Example:
@ -100,7 +100,7 @@ Strategy arguments:
 Now you have good Buy and Sell strategies and some historic data, you want to test it against
 real data. This is what we call [backtesting](https://en.wikipedia.org/wiki/Backtesting).

-Backtesting will use the crypto-currencies (pairs) from your config file and load historical candle (OHCLV) data from `user_data/data/<exchange>` by default.
+Backtesting will use the crypto-currencies (pairs) from your config file and load historical candle (OHLCV) data from `user_data/data/<exchange>` by default.
 If no data is available for the exchange / pair / timeframe combination, backtesting will ask you to download them first using `freqtrade download-data`.
 For details on downloading, please refer to the [Data Downloading](data-download.md) section in the documentation.

@ -110,11 +110,16 @@ All profit calculations include fees, and freqtrade will use the exchange's defa

 !!! Warning "Using dynamic pairlists for backtesting"
    Using dynamic pairlists is possible, however it relies on the current market conditions - which will not reflect the historic status of the pairlist.
-    Also, when using pairlists other than StaticPairlist, reproducability of backtesting-results cannot be guaranteed.
+    Also, when using pairlists other than StaticPairlist, reproducibility of backtesting-results cannot be guaranteed.
    Please read the [pairlists documentation](plugins.md#pairlists) for more information.

    To achieve reproducible results, best generate a pairlist via the [`test-pairlist`](utils.md#test-pairlist) command and use that as static pairlist.

+!!! Note
+    By default, Freqtrade will export backtesting results to `user_data/backtest_results`.
+    The exported trades can be used for [further analysis](#further-backtest-result-analysis) or can be used by the [plotting sub-command](plotting.md#plot-price-and-indicators) (`freqtrade plot-dataframe`) in the scripts directory.
+
+
 ### Starting balance

 Backtesting will require a starting balance, which can be provided as `--dry-run-wallet <balance>` or `--starting-balance <balance>` command line argument, or via `dry_run_wallet` configuration setting.
@ -174,13 +179,13 @@ Where `SampleStrategy1` and `AwesomeStrategy` refer to class names of strategies

 ---

-Exporting trades to file
+Prevent exporting trades to file

 ```bash
-freqtrade backtesting --strategy backtesting --export trades --config config.json 
+freqtrade backtesting --strategy backtesting --export none --config config.json 
 ```

-The exported trades can be used for [further analysis](#further-backtest-result-analysis), or can be used by the plotting script `plot_dataframe.py` in the scripts directory.
+Only use this if you're sure you'll not want to plot or analyze your results further.

 ---

--- a/freqtrade/commands/cli_options.py
+++ b/freqtrade/commands/cli_options.py
@ -167,8 +167,9 @@ AVAILABLE_CLI_OPTIONS = {
    ),
    "export": Arg(
        '--export',
-        help='Export backtest results, argument are: trades. '
-        'Example: `--export=trades`',
+        help='Export backtest results (default: trades).',
+        choices=constants.EXPORT_OPTIONS,
+
    ),
    "exportfilename": Arg(
        '--export-filename',
--- a/freqtrade/constants.py
+++ b/freqtrade/constants.py
@ -12,6 +12,7 @@ PROCESS_THROTTLE_SECS = 5  # sec
 HYPEROPT_EPOCH = 100  # epochs
 RETRY_TIMEOUT = 30  # sec
 TIMEOUT_UNITS = ['minutes', 'seconds']
+EXPORT_OPTIONS = ['none', 'trades']
 DEFAULT_DB_PROD_URL = 'sqlite:///tradesv3.sqlite'
 DEFAULT_DB_DRYRUN_URL = 'sqlite:///tradesv3.dryrun.sqlite'
 UNLIMITED_STAKE_AMOUNT = 'unlimited'
@ -308,6 +309,7 @@ CONF_SCHEMA = {
            'required': ['enabled', 'listen_ip_address', 'listen_port', 'username', 'password']
        },
        'db_url': {'type': 'string'},
+        'export': {'type': 'string', 'enum': EXPORT_OPTIONS, 'default': 'trades'},
        'initial_state': {'type': 'string', 'enum': ['running', 'stopped']},
        'forcebuy_enable': {'type': 'boolean'},
        'disable_dataframe_checks': {'type': 'boolean'},
--- a/freqtrade/optimize/backtesting.py
+++ b/freqtrade/optimize/backtesting.py
@ -520,7 +520,7 @@ class Backtesting:
            stats = generate_backtest_stats(data, self.all_results,
                                            min_date=min_date, max_date=max_date)

-            if self.config.get('export', False):
+            if self.config.get('export', 'none') == 'trades':
                store_backtest_stats(self.config['exportfilename'], stats)

            # Show backtest results
--- a/tests/conftest.py
+++ b/tests/conftest.py
@ -326,6 +326,7 @@ def get_default_conf(testdatadir):
        "strategy_path": str(Path(__file__).parent / "strategy" / "strats"),
        "strategy": "DefaultStrategy",
        "internals": {},
+        "export": "none",
    }
    return configuration

--- a/tests/optimize/test_backtesting.py
+++ b/tests/optimize/test_backtesting.py
@ -155,6 +155,7 @@ def test_setup_optimize_configuration_without_arguments(mocker, default_conf, ca
        'backtesting',
        '--config', 'config.json',
        '--strategy', 'DefaultStrategy',
+        '--export', 'none'
    ]

    config = setup_optimize_configuration(get_args(args), RunMode.BACKTEST)
@ -172,7 +173,8 @@ def test_setup_optimize_configuration_without_arguments(mocker, default_conf, ca
    assert not log_has('Parameter --enable-position-stacking detected ...', caplog)

    assert 'timerange' not in config
-    assert 'export' not in config
+    assert 'export' in config
+    assert config['export'] == 'none'
    assert 'runmode' in config
    assert config['runmode'] == RunMode.BACKTEST

@ -193,7 +195,6 @@ def test_setup_bt_configuration_with_arguments(mocker, default_conf, caplog) ->
        '--enable-position-stacking',
        '--disable-max-market-positions',
        '--timerange', ':100',
-        '--export', '/bar/foo',
        '--export-filename', 'foo_bar.json',
        '--fee', '0',
    ]
@ -223,7 +224,6 @@ def test_setup_bt_configuration_with_arguments(mocker, default_conf, caplog) ->
    assert log_has('Parameter --timerange detected: {} ...'.format(config['timerange']), caplog)

    assert 'export' in config
-    assert log_has('Parameter --export detected: {} ...'.format(config['export']), caplog)
    assert 'exportfilename' in config
    assert isinstance(config['exportfilename'], Path)
    assert log_has('Storing backtest results to {} ...'.format(config['exportfilename']), caplog)
@ -395,7 +395,7 @@ def test_backtesting_start_no_data(default_conf, mocker, caplog, testdatadir) ->

    default_conf['timeframe'] = "1m"
    default_conf['datadir'] = testdatadir
-    default_conf['export'] = None
+    default_conf['export'] = 'none'
    default_conf['timerange'] = '20180101-20180102'

    backtesting = Backtesting(default_conf)
@ -416,7 +416,7 @@ def test_backtesting_no_pair_left(default_conf, mocker, caplog, testdatadir) ->

    default_conf['timeframe'] = "1m"
    default_conf['datadir'] = testdatadir
-    default_conf['export'] = None
+    default_conf['export'] = 'none'
    default_conf['timerange'] = '20180101-20180102'

    with pytest.raises(OperationalException, match='No pair in whitelist.'):
@ -440,7 +440,7 @@ def test_backtesting_pairlist_list(default_conf, mocker, caplog, testdatadir, ti

    default_conf['ticker_interval'] = "1m"
    default_conf['datadir'] = testdatadir
-    default_conf['export'] = None
+    default_conf['export'] = 'none'
    # Use stoploss from strategy
    del default_conf['stoploss']
    default_conf['timerange'] = '20180101-20180102'
--- a/tests/test_configuration.py
+++ b/tests/test_configuration.py
@ -425,7 +425,6 @@ def test_setup_configuration_without_arguments(mocker, default_conf, caplog) ->
    assert not log_has('Parameter --enable-position-stacking detected ...', caplog)

    assert 'timerange' not in config
-    assert 'export' not in config


 def test_setup_configuration_with_arguments(mocker, default_conf, caplog) -> None:
@ -448,7 +447,7 @@ def test_setup_configuration_with_arguments(mocker, default_conf, caplog) -> Non
        '--enable-position-stacking',
        '--disable-max-market-positions',
        '--timerange', ':100',
-        '--export', '/bar/foo',
+        '--export', 'trades',
        '--stake-amount', 'unlimited'
    ]

@ -496,7 +495,7 @@ def test_setup_configuration_with_stratlist(mocker, default_conf, caplog) -> Non
        'backtesting',
        '--config', 'config.json',
        '--ticker-interval', '1m',
-        '--export', '/bar/foo',
+        '--export', 'trades',
        '--strategy-list',
        'DefaultStrategy',
        'TestStrategy'