cmdargparse 0.2.0__tar.gz → 0.3.0__tar.gz

{cmdargparse-0.2.0 → cmdargparse-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmdargparse
-Version: 0.2.0
+Version: 0.3.0
 Summary: A declarative way to define `cmd2` argument parsers.
 Home-page: https://github.com/krnd/cmdargparse
 Author: Kilian Kaiping (krnd)
@@ -76,6 +76,9 @@ class MyApplication(cmd2.Cmd):
 * `default` <br/>
     The arguments default value if not specified.
     <br/> (Providing a default value makes the argument optional.)
+* `nargs` <br/>
+    The number of command-line values to be consumed.
+    <br/> https://docs.python.org/3/library/argparse.html#nargs
 * `type` <br/>
     Explicitly specifies the `type` to be used by `argparse`.
     <br/> https://docs.python.org/3/library/argparse.html#type
@@ -94,6 +97,8 @@ arg: str | None = cmdfield.argument(
     },
     default=None,
 )
+args: list[str] = cmdfield.argument()
+more: list[str] = cmdfield.argument(nargs="+")
 ```
 
 
@@ -116,6 +121,9 @@ arg: str | None = cmdfield.argument(
     Explicitly specifies all option declarations.
 * `more_decls` <br/>
     Specifies additional option declarations.
+* `nargs` <br/>
+    The number of command-line values to be consumed.
+    <br/> https://docs.python.org/3/library/argparse.html#nargs
 * `type` <br/>
     Explicitly specifies the `type` to be used by `argparse`.
     <br/> https://docs.python.org/3/library/argparse.html#type
@@ -131,6 +139,8 @@ arg: str | None = cmdfield.argument(
 xx: str | None = cmdfield.option()
 yy: int | None = cmdfield.option([1, 2, 3])
 zz: str = cmdfield.option(required=True)
+hh: list[str] | None = cmdfield.option(default=None)
+qq: list[int] | None = cmdfield.option(nargs=2, default=None)
 ```
 
 #### Declarations
@@ -145,6 +155,7 @@ mm: str | None = cmdfield.option(decls="--mm")           # --mm
 nn: str | None = cmdfield.option(decls="-oo")            # -oo
 pp: str | None = cmdfield.option(decls=("--rr", "-ss"))  # --rr, -ss
 tt: str | None = cmdfield.option(more_decls="-uu")       # -tt, -uu
+vv_ww: str | None = cmdfield.option()                    # -vv-ww  OR  --vv-ww
 ```
 
 
@@ -192,6 +203,7 @@ mm: bool = cmdfield.flag(decls="--mm")           # --mm
 nn: bool = cmdfield.flag(decls="-oo")            # -oo
 pp: bool = cmdfield.flag(decls=("--rr", "-ss"))  # --rr, -ss
 tt: bool = cmdfield.flag(more_decls="-uu")       # -tt, -uu
+vv_ww: bool = cmdfield.flag()                    # -vv-ww  OR  --vv-ww
 ```
 
 

{cmdargparse-0.2.0 → cmdargparse-0.3.0}/README.md

@@ -43,6 +43,9 @@ class MyApplication(cmd2.Cmd):
 * `default` <br/>
     The arguments default value if not specified.
     <br/> (Providing a default value makes the argument optional.)
+* `nargs` <br/>
+    The number of command-line values to be consumed.
+    <br/> https://docs.python.org/3/library/argparse.html#nargs
 * `type` <br/>
     Explicitly specifies the `type` to be used by `argparse`.
     <br/> https://docs.python.org/3/library/argparse.html#type
@@ -61,6 +64,8 @@ arg: str | None = cmdfield.argument(
     },
     default=None,
 )
+args: list[str] = cmdfield.argument()
+more: list[str] = cmdfield.argument(nargs="+")
 ```
 
 
@@ -83,6 +88,9 @@ arg: str | None = cmdfield.argument(
     Explicitly specifies all option declarations.
 * `more_decls` <br/>
     Specifies additional option declarations.
+* `nargs` <br/>
+    The number of command-line values to be consumed.
+    <br/> https://docs.python.org/3/library/argparse.html#nargs
 * `type` <br/>
     Explicitly specifies the `type` to be used by `argparse`.
     <br/> https://docs.python.org/3/library/argparse.html#type
@@ -98,6 +106,8 @@ arg: str | None = cmdfield.argument(
 xx: str | None = cmdfield.option()
 yy: int | None = cmdfield.option([1, 2, 3])
 zz: str = cmdfield.option(required=True)
+hh: list[str] | None = cmdfield.option(default=None)
+qq: list[int] | None = cmdfield.option(nargs=2, default=None)
 ```
 
 #### Declarations
@@ -112,6 +122,7 @@ mm: str | None = cmdfield.option(decls="--mm")           # --mm
 nn: str | None = cmdfield.option(decls="-oo")            # -oo
 pp: str | None = cmdfield.option(decls=("--rr", "-ss"))  # --rr, -ss
 tt: str | None = cmdfield.option(more_decls="-uu")       # -tt, -uu
+vv_ww: str | None = cmdfield.option()                    # -vv-ww  OR  --vv-ww
 ```
 
 
@@ -159,6 +170,7 @@ mm: bool = cmdfield.flag(decls="--mm")           # --mm
 nn: bool = cmdfield.flag(decls="-oo")            # -oo
 pp: bool = cmdfield.flag(decls=("--rr", "-ss"))  # --rr, -ss
 tt: bool = cmdfield.flag(more_decls="-uu")       # -tt, -uu
+vv_ww: bool = cmdfield.flag()                    # -vv-ww  OR  --vv-ww
 ```
 
 

{cmdargparse-0.2.0 → cmdargparse-0.3.0}/cmdargparse/command.py

@@ -36,14 +36,15 @@ class _cmdcommand(type):
     ]:
         """Decorate as command function."""
 
-        if hasattr(argtype, "_cmdargparse_command_decorator"):
-            return getattr(argtype, "_cmdargparse_command_decorator")
+        if "_cmdargparse_command_decorator" in argtype.__dict__:
+            return argtype.__dict__["_cmdargparse_command_decorator"]
 
         parser = ArgumentParser()
 
         _dcfields = dataclasses.fields(
             argtype  # pyright: ignore[reportArgumentType]
         )
+        _fieldtypes = typing.get_type_hints(argtype, include_extras=True)
 
         default_form: _DeclFormSpecifier
         default_form = getattr(argtype, "_cmdargparse_default_form")
@@ -63,7 +64,7 @@ class _cmdcommand(type):
             )
 
             args: dict[str, Any]
-            args = field.metadata["args"]
+            args = dict(field.metadata["args"])
 
             assert "dest" not in args, (
                 "Specifying 'dest' directly is not supported."
@@ -86,8 +87,11 @@ class _cmdcommand(type):
                 continue
 
             # Resolve the type from the fields type annotation.
+            (_type, _nargs) = argparse_type(_fieldtypes[field.name])
             if args.get("type", None) is None:
-                args["type"] = argparse_type(field.type)
+                args["type"] = _type
+            if args.get("nargs", None) is None and _nargs is not None:
+                args["nargs"] = _nargs
 
             # Remove custom unspecified arguments.
             if args.get("choicesmap", None) is None:
@@ -168,7 +172,7 @@ def argparse_name_or_flags(
     return tuple(
         _decl
         for _decl in (
-            decl or (form + field),
+            decl or (form + field.replace("_", "-")),
             altdecl,
             *more_decls,
         )
@@ -176,13 +180,10 @@ def argparse_name_or_flags(
     )
 
 
-def argparse_type(type: Any, /) -> Type[Any]:
-    if isinstance(type, str):
-        raise TypeError("forward reference type annotations are not supported")
-
+def argparse_type(type: Any, /) -> Tuple[Type[Any], str | None]:
     origin = typing.get_origin(type)
     if origin is None:
-        return type
+        return (type, None)
 
     if origin is typing.Annotated:
         (argtype, *_) = typing.get_args(type)
@@ -192,9 +193,12 @@ def argparse_type(type: Any, /) -> Type[Any]:
     # should be passed to the `argparse` module.
     if isinstance(type, types.UnionType):
         (argtype, *_) = typing.get_args(type)
-        return argtype
+        return argparse_type(argtype)
     elif origin is typing.Union:
         (argtype, *_) = typing.get_args(type)
-        return argtype
+        return argparse_type(argtype)
+    elif origin is list:
+        (argtype, *_) = typing.get_args(type)
+        return (argparse_type(argtype)[0], "*")
 
     raise TypeError("unsupported type annotation")

{cmdargparse-0.2.0 → cmdargparse-0.3.0}/cmdargparse/field.py

@@ -112,6 +112,8 @@ class _cmdfield(type):
 
     class _ArgumentArgs(TypedDict, total=False):
 
+        nargs: Annotated[int, "N"] | Literal["?", "*", "+"]
+
         type: Annotated[Any, Callable[[str], Annotated[Any, "FieldType"]]]
 
         help: str
@@ -180,6 +182,9 @@ class _cmdfield(type):
             The arguments default value if not specified.
             (Providing a default value makes the argument optional.)
 
+        :param nargs:
+            The number of command-line values to be consumed.
+            <br/> https://docs.python.org/3/library/argparse.html#nargs
         :param type:
             Explicitly specifies the `type` to be used by `argparse`.
             <br/> https://docs.python.org/3/library/argparse.html#type
@@ -192,10 +197,10 @@ class _cmdfield(type):
         """
         return _argparse(
             None,
-            nargs=("?" if not isunset(default) else None),
             choices=choices,
             choicesmap=choicesmap,
             default=on_unset(default, None),
+            nargs=args.get("nargs", ("?" if not isunset(default) else None)),
             type=args.get("type", None),
             help=args.get("help", None),
             metavar=args.get("helpvar", None),
@@ -209,6 +214,8 @@ class _cmdfield(type):
         decls: Tuple[str, str] | str
         more_decls: Sequence[str] | str
 
+        nargs: Annotated[int, "N"] | Literal["?", "*", "+"]
+
         type: Annotated[Any, Callable[[str], Annotated[Any, "FieldType"]]]
 
         required: bool
@@ -388,6 +395,9 @@ class _cmdfield(type):
         :param more_decls:
             Specifies additional option declarations.
 
+        :param nargs:
+            The number of command-line values to be consumed.
+            <br/> https://docs.python.org/3/library/argparse.html#nargs
         :param type:
             Explicitly specifies the `type` to be used by `argparse`.
             <br/> https://docs.python.org/3/library/argparse.html#type
@@ -431,6 +441,7 @@ class _cmdfield(type):
             choicesmap=choicesmap,
             default=on_unset(default, None),
             required=args.get("required", False),
+            nargs=args.get("nargs", None),
             type=args.get("type", None),
             help=args.get("help", None),
             metavar=args.get("helpvar", None),

{cmdargparse-0.2.0 → cmdargparse-0.3.0}/cmdargparse.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmdargparse
-Version: 0.2.0
+Version: 0.3.0
 Summary: A declarative way to define `cmd2` argument parsers.
 Home-page: https://github.com/krnd/cmdargparse
 Author: Kilian Kaiping (krnd)
@@ -76,6 +76,9 @@ class MyApplication(cmd2.Cmd):
 * `default` <br/>
     The arguments default value if not specified.
     <br/> (Providing a default value makes the argument optional.)
+* `nargs` <br/>
+    The number of command-line values to be consumed.
+    <br/> https://docs.python.org/3/library/argparse.html#nargs
 * `type` <br/>
     Explicitly specifies the `type` to be used by `argparse`.
     <br/> https://docs.python.org/3/library/argparse.html#type
@@ -94,6 +97,8 @@ arg: str | None = cmdfield.argument(
     },
     default=None,
 )
+args: list[str] = cmdfield.argument()
+more: list[str] = cmdfield.argument(nargs="+")
 ```
 
 
@@ -116,6 +121,9 @@ arg: str | None = cmdfield.argument(
     Explicitly specifies all option declarations.
 * `more_decls` <br/>
     Specifies additional option declarations.
+* `nargs` <br/>
+    The number of command-line values to be consumed.
+    <br/> https://docs.python.org/3/library/argparse.html#nargs
 * `type` <br/>
     Explicitly specifies the `type` to be used by `argparse`.
     <br/> https://docs.python.org/3/library/argparse.html#type
@@ -131,6 +139,8 @@ arg: str | None = cmdfield.argument(
 xx: str | None = cmdfield.option()
 yy: int | None = cmdfield.option([1, 2, 3])
 zz: str = cmdfield.option(required=True)
+hh: list[str] | None = cmdfield.option(default=None)
+qq: list[int] | None = cmdfield.option(nargs=2, default=None)
 ```
 
 #### Declarations
@@ -145,6 +155,7 @@ mm: str | None = cmdfield.option(decls="--mm")           # --mm
 nn: str | None = cmdfield.option(decls="-oo")            # -oo
 pp: str | None = cmdfield.option(decls=("--rr", "-ss"))  # --rr, -ss
 tt: str | None = cmdfield.option(more_decls="-uu")       # -tt, -uu
+vv_ww: str | None = cmdfield.option()                    # -vv-ww  OR  --vv-ww
 ```
 
 
@@ -192,6 +203,7 @@ mm: bool = cmdfield.flag(decls="--mm")           # --mm
 nn: bool = cmdfield.flag(decls="-oo")            # -oo
 pp: bool = cmdfield.flag(decls=("--rr", "-ss"))  # --rr, -ss
 tt: bool = cmdfield.flag(more_decls="-uu")       # -tt, -uu
+vv_ww: bool = cmdfield.flag()                    # -vv-ww  OR  --vv-ww
 ```
 
 

{cmdargparse-0.2.0 → cmdargparse-0.3.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r", encoding="utf-8") as file:
 
 setup(
     name="cmdargparse",
-    version="0.2.0",
+    version="0.3.0",
     description="A declarative way to define `cmd2` argument parsers.",
     long_description=README,
     long_description_content_type="text/markdown",