import argparse
from pathlib import Path
from typing import Any, List, Tuple
from ..modulefile import get_module_file_directory
[docs]def get_parser(description: str,
help_arguments: str = None,
with_appli: bool = False,
with_verbose: bool = False,
options: List[Tuple[str, Any, str]] = None,
args: List = None) -> argparse.Namespace:
"""Create a parser for entry-points.
Parameters
----------
description : str
Description of the command
help_arguments : str, optional
Help for the arguments, by default None
with_appli : bool, optional
True to enable '--appli' option, by default False
with_verbose : bool, optional
True to enable '--verbise' option, by default False
options: List[Tuple[str, Any, str]], optional
list of options defined as ('--option-name', default, 'help'), by default None
args : List, optional
list of arguments if not given throug cli, by default None
Returns
-------
argparse.Namespace
parsed arguments
"""
parser = argparse.ArgumentParser(description=description)
parser.add_argument("virtual_env",
help="Path to the virtual env to modify")
if with_verbose:
parser.add_argument('--verbose', action='store_true', help='To display the result.')
if with_appli:
parser.add_argument('--appli', metavar='appli', default="",
help='Name of the appli modulefile (case insensitive)')
if help_arguments:
parser.add_argument('arguments', nargs='+', default=[], help=help_arguments)
if options:
for option in options:
parser.add_argument(f"--{option[0]}",
metavar=option[0].replace("-","_"),
default=option[1],
help=option[2])
return parser.parse_args(args)
[docs]def get_module_filename(virtual_env_name: str, appli_name: str = None) -> str:
"""_summary_
Parameters
----------
virtual_env_name : str
name or path to the virtual env
appli_name : str, optional
name of the application, by default None
Returns
-------
str
name of the module file associated to the appli
"""
virtual_env = Path(virtual_env_name).absolute()
name = (appli_name if appli_name else virtual_env.name).lower()
virtual_env = virtual_env / get_module_file_directory(virtual_env)
return str(virtual_env / name)