quantlab.utils.cli.add_output_dir_args#

quantlab.utils.cli.add_output_dir_args(parser, download_help=None, data_help=None)[source]#

Add --download-dir and --data-dir to parser.

Both default to the current directory. Defined once here so the flag names, help text and defaults are identical on every script that offers them; resolve_output_dirs reads them back.

Parameters:

parserargparse.ArgumentParser: The parser to extend.
download_helpstr or None, default None: Help text for --download-dir when the script names where under <download-dir>/<vendor>/ its raw files go.
data_helpstr or None, default None: Help text for --data-dir when the script names the stores it writes or reads under the data root.

Returns:

argparse.ArgumentParser: parser, for chaining.

Examples

>>> parser = add_output_dir_args(argparse.ArgumentParser())
>>> parser.parse_args(["--download-dir", "/mnt/raw", "--data-dir", "/mnt/data"])
Namespace(download_dir='/mnt/raw', data_dir='/mnt/data')
>>> parser.parse_args([])
Namespace(download_dir='.', data_dir='.')