adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1947 from hroff-1902/arguments-cleanup

Browse Source 
arguments cleanup
This commit is contained in:
Matthias 2019-06-21 06:41:46 +02:00 committed by GitHub
commit a75f08cf17
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 103 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
freqtrade/arguments.py
View File

@ -33,7 +33,8 @@ class Arguments(object):
self.parser = argparse.ArgumentParser(description=description) self.parser = argparse.ArgumentParser(description=description)
def _load_args(self) -> None: def _load_args(self) -> None:
self.common_args_parser() self.common_options()
self.main_options()
self._build_subcommands() self._build_subcommands()
def get_parsed_arg(self) -> argparse.Namespace: def get_parsed_arg(self) -> argparse.Namespace:
@ -60,63 +61,66 @@ class Arguments(object):
return parsed_arg return parsed_arg
def common_args_parser(self) -> None: def common_options(self) -> None:
""" """
Parses given common arguments and returns them as a parsed object. Parses arguments that are common for the main Freqtrade, all subcommands and scripts.
""" """
self.parser.add_argument( parser = self.parser
parser.add_argument(
'-v', '--verbose', '-v', '--verbose',
help='Verbose mode (-vv for more, -vvv to get all messages).', help='Verbose mode (-vv for more, -vvv to get all messages).',
action='count', action='count',
dest='loglevel', dest='loglevel',
default=0, default=0,
) )
self.parser.add_argument( parser.add_argument(
'--logfile', '--logfile',
help='Log to the file specified', help='Log to the file specified',
dest='logfile', dest='logfile',
type=str, metavar='FILE',
metavar='FILE'
) )
self.parser.add_argument( parser.add_argument(
'--version', '--version',
action='version', action='version',
version=f'%(prog)s {__version__}' version=f'%(prog)s {__version__}'
) )
self.parser.add_argument( parser.add_argument(
'-c', '--config', '-c', '--config',
help="Specify configuration file (default: %(default)s). " help="Specify configuration file (default: %(default)s). "
"Multiple --config options may be used. " "Multiple --config options may be used. "
"Can be set to '-' to read config from stdin.", "Can be set to '-' to read config from stdin.",
dest='config', dest='config',
action='append', action='append',
type=str,
metavar='PATH', metavar='PATH',
) )
self.parser.add_argument( parser.add_argument(
'-d', '--datadir', '-d', '--datadir',
help='Path to backtest data.', help='Path to backtest data.',
dest='datadir', dest='datadir',
default=None,
type=str,
metavar='PATH', metavar='PATH',
) )
self.parser.add_argument(
def main_options(self) -> None:
"""
Parses arguments for the main Freqtrade.
"""
parser = self.parser
parser.add_argument(
'-s', '--strategy', '-s', '--strategy',
help='Specify strategy class name (default: %(default)s).', help='Specify strategy class name (default: %(default)s).',
dest='strategy', dest='strategy',
default='DefaultStrategy', default='DefaultStrategy',
type=str,
metavar='NAME', metavar='NAME',
) )
self.parser.add_argument( parser.add_argument(
'--strategy-path', '--strategy-path',
help='Specify additional strategy lookup path.', help='Specify additional strategy lookup path.',
dest='strategy_path', dest='strategy_path',
type=str,
metavar='PATH', metavar='PATH',
) )
self.parser.add_argument( parser.add_argument(
'--dynamic-whitelist', '--dynamic-whitelist',
help='Dynamically generate and update whitelist' help='Dynamically generate and update whitelist'
' based on 24h BaseVolume (default: %(const)s).' ' based on 24h BaseVolume (default: %(const)s).'
@ -127,52 +131,46 @@ class Arguments(object):
metavar='INT', metavar='INT',
nargs='?', nargs='?',
) )
self.parser.add_argument( parser.add_argument(
'--db-url', '--db-url',
help='Override trades database URL, this is useful if dry_run is enabled' help='Override trades database URL, this is useful if dry_run is enabled'
' or in custom deployments (default: %(default)s).', ' or in custom deployments (default: %(default)s).',
dest='db_url', dest='db_url',
type=str,
metavar='PATH', metavar='PATH',
) )
self.parser.add_argument( parser.add_argument(
'--sd-notify', '--sd-notify',
help='Notify systemd service manager.', help='Notify systemd service manager.',
action='store_true', action='store_true',
dest='sd_notify', dest='sd_notify',
) )
@staticmethod def common_optimize_options(self, subparser: argparse.ArgumentParser = None) -> None:
def optimizer_shared_options(parser: argparse.ArgumentParser) -> None:
""" """
Parses given common arguments for Backtesting, Edge and Hyperopt modules. Parses arguments common for Backtesting, Edge and Hyperopt modules.
:param parser: :param parser:
:return:
""" """
parser = subparser or self.parser
parser.add_argument( parser.add_argument(
'-i', '--ticker-interval', '-i', '--ticker-interval',
help='Specify ticker interval (1m, 5m, 30m, 1h, 1d).', help='Specify ticker interval (1m, 5m, 30m, 1h, 1d).',
dest='ticker_interval', dest='ticker_interval',
type=str,
) )
parser.add_argument( parser.add_argument(
'--timerange', '--timerange',
help='Specify what timerange of data to use.', help='Specify what timerange of data to use.',
default=None,
type=str,
dest='timerange', dest='timerange',
) )
parser.add_argument( parser.add_argument(
'--max_open_trades', '--max_open_trades',
help='Specify max_open_trades to use.', help='Specify max_open_trades to use.',
default=None,
type=int, type=int,
dest='max_open_trades', dest='max_open_trades',
) )
parser.add_argument( parser.add_argument(
'--stake_amount', '--stake_amount',
help='Specify stake_amount.', help='Specify stake_amount.',
default=None,
type=float, type=float,
dest='stake_amount', dest='stake_amount',
) )
@ -185,11 +183,12 @@ class Arguments(object):
dest='refresh_pairs', dest='refresh_pairs',
) )
@staticmethod def backtesting_options(self, subparser: argparse.ArgumentParser = None) -> None:
def backtesting_options(parser: argparse.ArgumentParser) -> None:
""" """
Parses given arguments for Backtesting module. Parses given arguments for Backtesting module.
""" """
parser = subparser or self.parser
parser.add_argument( parser.add_argument(
'--eps', '--enable-position-stacking', '--eps', '--enable-position-stacking',
help='Allow buying the same pair multiple times (position stacking).', help='Allow buying the same pair multiple times (position stacking).',
@ -225,8 +224,6 @@ class Arguments(object):
'--export', '--export',
help='Export backtest results, argument are: trades. ' help='Export backtest results, argument are: trades. '
'Example --export=trades', 'Example --export=trades',
type=str,
default=None,
dest='export', dest='export',
) )
parser.add_argument( parser.add_argument(
@ -235,37 +232,36 @@ class Arguments(object):
requires --export to be set as well\ requires --export to be set as well\
Example --export-filename=user_data/backtest_data/backtest_today.json\ Example --export-filename=user_data/backtest_data/backtest_today.json\
(default: %(default)s)', (default: %(default)s)',
type=str,
default=os.path.join('user_data', 'backtest_data', 'backtest-result.json'), default=os.path.join('user_data', 'backtest_data', 'backtest-result.json'),
dest='exportfilename', dest='exportfilename',
metavar='PATH', metavar='PATH',
) )
@staticmethod def edge_options(self, subparser: argparse.ArgumentParser = None) -> None:
def edge_options(parser: argparse.ArgumentParser) -> None:
""" """
Parses given arguments for Edge module. Parses given arguments for Edge module.
""" """
parser = subparser or self.parser
parser.add_argument( parser.add_argument(
'--stoplosses', '--stoplosses',
help='Defines a range of stoploss against which edge will assess the strategy ' help='Defines a range of stoploss against which edge will assess the strategy '
'the format is "min,max,step" (without any space).' 'the format is "min,max,step" (without any space).'
'example: --stoplosses=-0.01,-0.1,-0.001', 'example: --stoplosses=-0.01,-0.1,-0.001',
type=str,
dest='stoploss_range', dest='stoploss_range',
) )
@staticmethod def hyperopt_options(self, subparser: argparse.ArgumentParser = None) -> None:
def hyperopt_options(parser: argparse.ArgumentParser) -> None:
""" """
Parses given arguments for Hyperopt module. Parses given arguments for Hyperopt module.
""" """
parser = subparser or self.parser
parser.add_argument( parser.add_argument(
'--customhyperopt', '--customhyperopt',
help='Specify hyperopt class name (default: %(default)s).', help='Specify hyperopt class name (default: %(default)s).',
dest='hyperopt', dest='hyperopt',
default=constants.DEFAULT_HYPEROPT, default=constants.DEFAULT_HYPEROPT,
type=str,
metavar='NAME', metavar='NAME',
) )
parser.add_argument( parser.add_argument(
@ -322,7 +318,6 @@ class Arguments(object):
'--random-state', '--random-state',
help='Set random state to some positive integer for reproducible hyperopt results.', help='Set random state to some positive integer for reproducible hyperopt results.',
dest='hyperopt_random_state', dest='hyperopt_random_state',
default=None,
type=Arguments.check_int_positive, type=Arguments.check_int_positive,
metavar='INT', metavar='INT',
) )
@ -336,11 +331,12 @@ class Arguments(object):
metavar='INT', metavar='INT',
) )
@staticmethod def list_exchanges_options(self, subparser: argparse.ArgumentParser = None) -> None:
def list_exchanges_options(parser: argparse.ArgumentParser) -> None:
""" """
Parses given arguments for the list-exchanges command. Parses given arguments for the list-exchanges command.
""" """
parser = subparser or self.parser
parser.add_argument( parser.add_argument(
'-1', '--one-column', '-1', '--one-column',
help='Print exchanges in one column', help='Print exchanges in one column',
@ -350,7 +346,7 @@ class Arguments(object):
def _build_subcommands(self) -> None: def _build_subcommands(self) -> None:
""" """
Builds and attaches all subcommands Builds and attaches all subcommands.
:return: None :return: None
""" """
from freqtrade.optimize import start_backtesting, start_hyperopt, start_edge from freqtrade.optimize import start_backtesting, start_hyperopt, start_edge
@ -361,19 +357,19 @@ class Arguments(object):
# Add backtesting subcommand # Add backtesting subcommand
backtesting_cmd = subparsers.add_parser('backtesting', help='Backtesting module.') backtesting_cmd = subparsers.add_parser('backtesting', help='Backtesting module.')
backtesting_cmd.set_defaults(func=start_backtesting) backtesting_cmd.set_defaults(func=start_backtesting)
self.optimizer_shared_options(backtesting_cmd) self.common_optimize_options(backtesting_cmd)
self.backtesting_options(backtesting_cmd) self.backtesting_options(backtesting_cmd)
# Add edge subcommand # Add edge subcommand
edge_cmd = subparsers.add_parser('edge', help='Edge module.') edge_cmd = subparsers.add_parser('edge', help='Edge module.')
edge_cmd.set_defaults(func=start_edge) edge_cmd.set_defaults(func=start_edge)
self.optimizer_shared_options(edge_cmd) self.common_optimize_options(edge_cmd)
self.edge_options(edge_cmd) self.edge_options(edge_cmd)
# Add hyperopt subcommand # Add hyperopt subcommand
hyperopt_cmd = subparsers.add_parser('hyperopt', help='Hyperopt module.') hyperopt_cmd = subparsers.add_parser('hyperopt', help='Hyperopt module.')
hyperopt_cmd.set_defaults(func=start_hyperopt) hyperopt_cmd.set_defaults(func=start_hyperopt)
self.optimizer_shared_options(hyperopt_cmd) self.common_optimize_options(hyperopt_cmd)
self.hyperopt_options(hyperopt_cmd) self.hyperopt_options(hyperopt_cmd)
# Add list-exchanges subcommand # Add list-exchanges subcommand
@ -438,69 +434,43 @@ class Arguments(object):
) )
return uint return uint
def scripts_options(self) -> None: def common_scripts_options(self, subparser: argparse.ArgumentParser = None) -> None:
""" """
Parses given arguments for scripts. Parses arguments common for scripts.
""" """
self.parser.add_argument( parser = subparser or self.parser
parser.add_argument(
'-p', '--pairs', '-p', '--pairs',
help='Show profits for only this pairs. Pairs are comma-separated.', help='Show profits for only this pairs. Pairs are comma-separated.',
dest='pairs', dest='pairs',
default=None
) )
def download_data_options(self) -> None: def download_data_options(self) -> None:
""" """
Parses given arguments for testdata download Parses given arguments for testdata download script
""" """
self.parser.add_argument( parser = self.parser
'-v', '--verbose',
help='Verbose mode (-vv for more, -vvv to get all messages).', parser.add_argument(
action='count',
dest='loglevel',
default=0,
)
self.parser.add_argument(
'--logfile',
help='Log to the file specified',
dest='logfile',
type=str,
metavar='FILE',
)
self.parser.add_argument(
'-c', '--config',
help='Specify configuration file (default: %(default)s). '
'Multiple --config options may be used.',
dest='config',
action='append',
type=str,
metavar='PATH',
)
self.parser.add_argument(
'-d', '--datadir',
help='Path to backtest data.',
dest='datadir',
metavar='PATH',
)
self.parser.add_argument(
'--pairs-file', '--pairs-file',
help='File containing a list of pairs to download.', help='File containing a list of pairs to download.',
dest='pairs_file', dest='pairs_file',
metavar='FILE', metavar='FILE',
) )
self.parser.add_argument( parser.add_argument(
'--days', '--days',
help='Download data for given number of days.', help='Download data for given number of days.',
dest='days', dest='days',
type=Arguments.check_int_positive, type=Arguments.check_int_positive,
metavar='INT', metavar='INT',
) )
self.parser.add_argument( parser.add_argument(
'--exchange', '--exchange',
help='Exchange name (default: %(default)s). Only valid if no config is provided.', help='Exchange name (default: %(default)s). Only valid if no config is provided.',
dest='exchange', dest='exchange',
) )
self.parser.add_argument( parser.add_argument(
'-t', '--timeframes', '-t', '--timeframes',
help='Specify which tickers to download. Space separated list. \ help='Specify which tickers to download. Space separated list. \
Default: %(default)s.', Default: %(default)s.',
@ -509,9 +479,39 @@ class Arguments(object):
nargs='+', nargs='+',
dest='timeframes', dest='timeframes',
) )
self.parser.add_argument( parser.add_argument(
'--erase', '--erase',
help='Clean all existing data for the selected exchange/pairs/timeframes.', help='Clean all existing data for the selected exchange/pairs/timeframes.',
dest='erase', dest='erase',
action='store_true' action='store_true'
) )
def plot_dataframe_options(self) -> None:
"""
Parses given arguments for plot dataframe script
"""
parser = self.parser
parser.add_argument(
'--indicators1',
help='Set indicators from your strategy you want in the first row of the graph. '
'Separate them with a coma. E.g: ema3,ema5 (default: %(default)s)',
default='sma,ema3,ema5',
dest='indicators1',
)
parser.add_argument(
'--indicators2',
help='Set indicators from your strategy you want in the third row of the graph. '
'Separate them with a coma. E.g: fastd,fastk (default: %(default)s)',
default='macd,macdsignal',
dest='indicators2',
)
parser.add_argument(
'--plot-limit',
help='Specify tick limit for plotting - too high values cause huge files - '
'Default: %(default)s',
dest='plot_limit',
default=750,
type=int,
)

5
freqtrade/tests/test_arguments.py
View File

@ -47,9 +47,9 @@ def test_parse_args_verbose() -> None:
assert args.loglevel == 1 assert args.loglevel == 1
def test_scripts_options() -> None: def test_common_scripts_options() -> None:
arguments = Arguments(['-p', 'ETH/BTC'], '') arguments = Arguments(['-p', 'ETH/BTC'], '')
arguments.scripts_options() arguments.common_scripts_options()
args = arguments.get_parsed_arg() args = arguments.get_parsed_arg()
assert args.pairs == 'ETH/BTC' assert args.pairs == 'ETH/BTC'
@ -178,6 +178,7 @@ def test_download_data_options() -> None:
'--exchange', 'binance' '--exchange', 'binance'
] ]
arguments = Arguments(args, '') arguments = Arguments(args, '')
arguments.common_options()
arguments.download_data_options() arguments.download_data_options()
args = arguments.parse_args() args = arguments.parse_args()
assert args.pairs_file == 'file_with_pairs' assert args.pairs_file == 'file_with_pairs'

3
scripts/download_backtest_data.py
View File

@ -20,7 +20,8 @@ logger = logging.getLogger('download_backtest_data')
DEFAULT_DL_PATH = 'user_data/data' DEFAULT_DL_PATH = 'user_data/data'
arguments = Arguments(sys.argv[1:], 'download utility') arguments = Arguments(sys.argv[1:], 'Download backtest data')
arguments.common_options()
arguments.download_data_options() arguments.download_data_options()
# Do not read the default config if config is not specified # Do not read the default config if config is not specified

35
scripts/plot_dataframe.py
View File

@ -349,35 +349,12 @@ def plot_parse_args(args: List[str]) -> Namespace:
:return: args: Array with all arguments :return: args: Array with all arguments
""" """
arguments = Arguments(args, 'Graph dataframe') arguments = Arguments(args, 'Graph dataframe')
arguments.scripts_options() arguments.common_options()
arguments.parser.add_argument( arguments.main_options()
'--indicators1', arguments.common_optimize_options()
help='Set indicators from your strategy you want in the first row of the graph. Separate ' arguments.backtesting_options()
'them with a coma. E.g: ema3,ema5 (default: %(default)s)', arguments.common_scripts_options()
type=str, arguments.plot_dataframe_options()
default='sma,ema3,ema5',
dest='indicators1',
)
arguments.parser.add_argument(
'--indicators2',
help='Set indicators from your strategy you want in the third row of the graph. Separate '
'them with a coma. E.g: fastd,fastk (default: %(default)s)',
type=str,
default='macd,macdsignal',
dest='indicators2',
)
arguments.parser.add_argument(
'--plot-limit',
help='Specify tick limit for plotting - too high values cause huge files - '
'Default: %(default)s',
dest='plot_limit',
default=750,
type=int,
)
arguments.common_args_parser()
arguments.optimizer_shared_options(arguments.parser)
arguments.backtesting_options(arguments.parser)
return arguments.parse_args() return arguments.parse_args()

9
scripts/plot_profit.py
View File

@ -206,10 +206,11 @@ def plot_parse_args(args: List[str]) -> Namespace:
:return: args: Array with all arguments :return: args: Array with all arguments
""" """
arguments = Arguments(args, 'Graph profits') arguments = Arguments(args, 'Graph profits')
arguments.scripts_options() arguments.common_options()
arguments.common_args_parser() arguments.main_options()
arguments.optimizer_shared_options(arguments.parser) arguments.common_optimize_options()
arguments.backtesting_options(arguments.parser) arguments.backtesting_options()
arguments.common_scripts_options()
return arguments.parse_args() return arguments.parse_args()