# coding: utf-8
import argparse
import re
from typing import Optional
from .generic_utils import str_strip
[docs]def ListParamProcessorCreate(type: object = str):
"""Create a ListParamProcessor
Args:
type (object) : type of each element in list.
Returns:
ListParamProcessor (argparse.Action) : Processor which receives list arguments.
Examples:
>>> import argparse
>>> from veditor.utils import ListParamProcessorCreate
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--list_params", action=ListParamProcessorCreate())
>>> args = parser.parse_args(args=["--list_params", "[あ, い, う]"])
>>> args.list_params
['あ', 'い', 'う']
"""
class ListParamProcessor(argparse.Action):
"""Receive List arguments.
Examples:
>>> import argparse
>>> from veditor.utils import ListParamProcessor
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--list_params", action=ListParamProcessor)
>>> args = parser.parse_args(args=["--list_params", "[あ, い, う]"])
>>> args.list_params
['あ', 'い', 'う']
Note:
If you run from the command line, execute as follows::
$ python app.py --list_params "[あ, い, う]"
"""
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: str,
option_strings: Optional[str] = None,
**kwargs
):
"""The ``__call__`` method may perform arbitrary actions, but will typically set attributes on the ``namespace`` based on ``dest`` and ``values``.
Args:
parser (argparse.ArgumentParser) : The ``argparse.ArgumentParser`` object which contains this action..
namespace (argparse.Namespace) : The ``argparse.Namespace`` object that will be returned by ``parse_args()``. Most actions add an attribute to this object using ``setattr()``.
values (str) : The associated command-line arguments, with any type conversions applied. Type conversions are specified with the ``type`` keyword argument to ``add_argument().``
option_strings (Optional[str], optional) : The option string that was used to invoke this action. Defaults to ``None``.
"""
match = re.match(pattern=r"(?:\[|\()(.+)(?:\]|\))", string=values)
if match:
values = [type(str_strip(e)) for e in match.group(1).split(",")]
else:
values = [type(values)]
setattr(namespace, self.dest, values)
return ListParamProcessor
[docs]class DictParamProcessor(argparse.Action):
"""Receive an argument as a dictionary.
Raises:
ValueError: You must give one argument for each one keyword.
Examples:
>>> import argparse
>>> from veditor.utils import DictParamProcessor
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--dict_params", action=DictParamProcessor)
>>> args = parser.parse_args(args=["--dict_params", "foo = [a, b, c]", "--dict_params", "bar=d"])
>>> args.dict_params
{'foo': ['a', 'b', 'c'], 'bar': 'd'}
>>> args = parser.parse_args(args=["--dict_params", "foo=a, bar=b"])
ValueError: too many values to unpack (expected 2)
Note:
If you run from the command line, execute as follows::
$ python app.py --dict_params "foo = [a, b, c]" --dict_params bar=c
"""
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: str,
option_strings: Optional[str] = None,
):
"""The ``__call__`` method may perform arbitrary actions, but will typically set attributes on the ``namespace`` based on ``dest`` and ``values``.
Args:
parser (argparse.ArgumentParser) : The ``argparse.ArgumentParser`` object which contains this action..
namespace (argparse.Namespace) : The ``argparse.Namespace`` object that will be returned by ``parse_args()``. Most actions add an attribute to this object using ``setattr()``.
values (str) : The associated command-line arguments, with any type conversions applied. Type conversions are specified with the ``type`` keyword argument to ``add_argument().``
option_strings (Optional[str], optional) : The option string that was used to invoke this action. Defaults to ``None``.
"""
param_dict = getattr(namespace, self.dest) or {}
k, v = values.split("=")
match = re.match(pattern=r"\[(.+)\]", string=str_strip(v))
if match is not None:
v = [str_strip(e) for e in match.group(1).split(",")]
else:
v = str_strip(v)
param_dict[str_strip(k)] = v
setattr(namespace, self.dest, param_dict)
[docs]class KwargsParamProcessor(argparse.Action):
"""Set a new argument.
Examples:
>>> import argparse
>>> from veditor.utils import KwargsParamProcessor
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--kwargs", action=KwargsParamProcessor)
>>> args = parser.parse_args(args=["--kwargs", "foo=a", "--kwargs", "bar=b"])
>>> (args.kwargs, args.foo, args.bar)
(None, 'a', 'b')
Note:
If you run from the command line, execute as follows::
$ python app.py --kwargs foo=a --kwargs bar=b
"""
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: str,
option_strings: Optional[str] = None,
):
"""The ``__call__`` method may perform arbitrary actions, but will typically set attributes on the ``namespace`` based on ``dest`` and ``values``.
Args:
parser (argparse.ArgumentParser) : The ``argparse.ArgumentParser`` object which contains this action..
namespace (argparse.Namespace) : The ``argparse.Namespace`` object that will be returned by ``parse_args()``. Most actions add an attribute to this object using ``setattr()``.
values (str) : The associated command-line arguments, with any type conversions applied. Type conversions are specified with the ``type`` keyword argument to ``add_argument().``
option_strings (Optional[str], optional) : The option string that was used to invoke this action. Defaults to ``None``.
"""
k, v = values.split("=")
setattr(namespace, k, v)
