optfunc2 0.2.2__tar.gz → 0.2.4__tar.gz

{optfunc2-0.2.2 → optfunc2-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: optfunc2
-Version: 0.2.2
+Version: 0.2.4
 Summary: Generate command line options and help/tips from function automatically.
 License: PyPA
 Author: bajeer
@@ -16,9 +16,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: docstring-parser (>=0.16,<0.17)
 Requires-Dist: prettytable (==3.11.0)
-Project-URL: Bug Reports, https://gitee.com/z-bajer/autocall/issues
-Project-URL: Homepage, https://gitee.com/z-bajer/autocall
-Project-URL: Source, https://gitee.com/z-bajer/autocall
+Project-URL: Bug Tracker, https://github.com/yjloong/optfunc2/issues
+Project-URL: Homepage, https://github.com/yjloong/optfunc2
 Description-Content-Type: text/markdown
 
 # Call function directly in cmd line
@@ -33,24 +32,6 @@ Description-Content-Type: text/markdown
 2. Function with @optfunc_default has @optfunc implicitly.
 3. Not support two type of variadic arguments.
 
-### ChangeLog
-### 0.2.2 (2025-2-16)
-1. Support single argument in bool type.
-2. Don't need user to pass globals() in cmdline_start().
-3. Support pytest to run test.
-4. Support omitting called function name who is default.
-5. pyproject.toml format change for poetry version 2.1.0.
-
-#### 0.2.1 (2025-2-14)
-1. Fix installing dependencies automatically.
-2. Add function 'called_directly' used to check if the function is called as entry point.
-   This function can be used in function development.
-   
-#### 0.1.2 (2023-05-06)
-1. Add support for default called functions.
-2. Fix README.md.
-3. Add ChangeLog in README.md.
-
 ### Code example1 -- calculator
 ``` python
 from optfunc2 import cmdline, cmdline_default, cmdline_start
@@ -66,7 +47,7 @@ def add(a: float, b: float):
     print(f"{a} + {b} = {a + b}")
 
 @cmdline
-def multiply(x: int, y: int = 5):
+def multiply(x: int|float, y: int = 5):
     """multiply two numbers. The second number is optional.
 
     Args:
@@ -138,6 +119,8 @@ Arguments:
 2.3 + 3.0 = 5.3
 ~/optfunc2$ python src/example_calc.py multiply -x 3
 3 × 5 = 15
+~/optfunc2$ python src/example_calc.py multiply -x 2.3
+2.3 × 5 = 11.5
 ~/optfunc2$ python src/example_calc.py stats --numbers '[1, 2, 3, 4, 5]'
 sum: 15
 average: 3.00

{optfunc2-0.2.2 → optfunc2-0.2.4}/README.md

@@ -10,24 +10,6 @@
 2. Function with @optfunc_default has @optfunc implicitly.
 3. Not support two type of variadic arguments.
 
-### ChangeLog
-### 0.2.2 (2025-2-16)
-1. Support single argument in bool type.
-2. Don't need user to pass globals() in cmdline_start().
-3. Support pytest to run test.
-4. Support omitting called function name who is default.
-5. pyproject.toml format change for poetry version 2.1.0.
-
-#### 0.2.1 (2025-2-14)
-1. Fix installing dependencies automatically.
-2. Add function 'called_directly' used to check if the function is called as entry point.
-   This function can be used in function development.
-   
-#### 0.1.2 (2023-05-06)
-1. Add support for default called functions.
-2. Fix README.md.
-3. Add ChangeLog in README.md.
-
 ### Code example1 -- calculator
 ``` python
 from optfunc2 import cmdline, cmdline_default, cmdline_start
@@ -43,7 +25,7 @@ def add(a: float, b: float):
     print(f"{a} + {b} = {a + b}")
 
 @cmdline
-def multiply(x: int, y: int = 5):
+def multiply(x: int|float, y: int = 5):
     """multiply two numbers. The second number is optional.
 
     Args:
@@ -115,6 +97,8 @@ Arguments:
 2.3 + 3.0 = 5.3
 ~/optfunc2$ python src/example_calc.py multiply -x 3
 3 × 5 = 15
+~/optfunc2$ python src/example_calc.py multiply -x 2.3
+2.3 × 5 = 11.5
 ~/optfunc2$ python src/example_calc.py stats --numbers '[1, 2, 3, 4, 5]'
 sum: 15
 average: 3.00

{optfunc2-0.2.2 → optfunc2-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "optfunc2"
-version = "0.2.2"
+version = "0.2.4"
 description = "Generate command line options and help/tips from function automatically."
 authors = [
     {name = "bajeer",email = "z-bajeer@yeah.net"}
@@ -19,9 +19,8 @@ requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [project.urls]
-"Homepage" = "https://gitee.com/z-bajer/autocall"
-"Bug Reports" = "https://gitee.com/z-bajer/autocall/issues"
-"Source" = "https://gitee.com/z-bajer/autocall"
+"Homepage" = "https://github.com/yjloong/optfunc2"
+"Bug Tracker" = "https://github.com/yjloong/optfunc2/issues"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.4"

{optfunc2-0.2.2 → optfunc2-0.2.4}/src/optfunc2/parser.py

@@ -3,10 +3,12 @@ import prettytable
 import docstring_parser
 import sys
 import ast
+import types
+from typing import Callable, Any, List
 
 # functions taged by @cmdline
-registered_funcs = []
-registered_func_default = None
+registered_funcs: List[Callable[..., Any]] = []
+registered_func_default: Callable[..., Any] = None
 
 # Main eval function in this module must be called only once.
 _called_func = None
@@ -93,7 +95,7 @@ def decode_opts(arg_pairs, func: callable):
             raise ValueError(f'--{name} need more arguments.')
         
         try:
-            if anno != inspect.Signature.empty and anno not in [dict, list]:
+            if anno not in [dict, list, inspect.Signature.empty] and type(anno) != types.UnionType:
                 value = anno(val)
             else:
                 try: 
@@ -104,7 +106,13 @@ def decode_opts(arg_pairs, func: callable):
                 anno_new = type(value)
 
                 if anno != inspect.Signature.empty:
-                    if anno_new != anno:
+                    if type(anno) == types.UnionType:
+                        type_list = [i.strip() for i in str(anno).split('|')]
+                        if anno_new.__name__ not in type_list:
+                            raise Exception(f'Type of {opt} should be one of {repr(type_list)}.')
+                         
+                    elif anno_new != anno:
+                        print(f'{anno_new = } {anno = }')
                         raise ValueError(f'Value type of {opt} should be {anno.__name__}.')
                 
                 anno = anno_new
@@ -131,7 +139,7 @@ def hibit_variadic(func: callable):
             color_end()
             exit(1)
 
-def cmdline_default(func):
+def cmdline_default(func: Callable[..., Any]) -> Callable[..., Any]:
     global registered_func_default
     global registered_funcs
     
@@ -152,7 +160,7 @@ def cmdline_default(func):
     # globals()[funcname] = func
     return func
 
-def cmdline(func):
+def cmdline(func: Callable[..., Any]) -> Callable[..., Any]:
     global registered_funcs
     if func not in registered_funcs:
         registered_funcs.append(func)
@@ -161,7 +169,7 @@ def cmdline(func):
     return func
 
     
-def cmd_help(func: callable, has_abbrev = True):
+def cmd_help(func: Callable[..., Any], has_abbrev: bool = True):
     args_list = decode_func_args(func)
     
     func_desc = docstring_parser.parse(func.__doc__).description
@@ -361,6 +369,9 @@ def cmdline_start(globals = None, locals = None, *, argv = sys.argv, header_doc:
         help(header_doc)
         return
     
+    if not registered_func_default and argv[1][0] == '-':
+        return
+    
     if argv[1][0] == '-':
         # use the default function
         argv.insert(1, registered_func_default.__name__)