argsig 0.1.0__tar.gz → 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: argsig
3
- Version: 0.1.0
4
- Summary: Add your description here
3
+ Version: 0.1.2
4
+ Summary: A modern, signature-driven CLI framework. Auto-infer type, choices, and nargs directly from type hints and Annotated.
5
5
  Author: Avery Zhou X
6
6
  Author-email: Avery Zhou X <leisure-zyf@qq.com>
7
7
  Requires-Python: >=3.12
@@ -1,7 +1,7 @@
1
1
  [project]
2
2
  name = "argsig"
3
- version = "0.1.0"
4
- description = "Add your description here"
3
+ version = "0.1.2"
4
+ description = "A modern, signature-driven CLI framework. Auto-infer type, choices, and nargs directly from type hints and Annotated."
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.12"
7
7
  dependencies = []
@@ -1,7 +1,7 @@
1
1
  [project]
2
2
  name = "argsig"
3
- version = "0.1.0"
4
- description = "Add your description here"
3
+ version = "0.1.2"
4
+ description = "A modern, signature-driven CLI framework. Auto-infer type, choices, and nargs directly from type hints and Annotated."
5
5
  readme = "README.md"
6
6
  authors = [
7
7
  { name = "Avery Zhou X", email = "leisure-zyf@qq.com" }
@@ -1,2 +1,4 @@
1
+ from .definitions import *
2
+
1
3
  def main() -> None:
2
4
  print("Hello from argsig!")
@@ -0,0 +1,133 @@
1
+ import argparse
2
+
3
+ # import functools
4
+ import inspect
5
+ from collections.abc import Callable
6
+
7
+ # import sys
8
+ from functools import wraps
9
+ from typing import (
10
+ Annotated,
11
+ # Any,
12
+ # Generic,
13
+ ParamSpec,
14
+ TypeVar,
15
+ get_args,
16
+ get_origin,
17
+ get_type_hints,
18
+ )
19
+
20
+ # === 泛型装饰器部分 ===
21
+ P = ParamSpec("P")
22
+ R = TypeVar("R")
23
+
24
+
25
+ # 关键修复:必须显式继承 Generic[P, R]
26
+ class Function[**P, R]:
27
+ def __init__(self, func: Callable[P, R], v="") -> None:
28
+ self.func = func
29
+ # 把原函数的名称、文档字符串等元数据复制给实例,方便终端打印或调试
30
+ wraps(func)(self)
31
+
32
+ self.register(v)
33
+
34
+ def register(self, v):
35
+
36
+ sig = inspect.signature(self.func)
37
+ hints = get_type_hints(self.func, include_extras=True)
38
+ self.parser = parser = argparse.ArgumentParser(description=self.func.__doc__)
39
+
40
+ if v:
41
+ parser.add_argument("-v", "--version", action="version", version=v)
42
+
43
+ for name, param in sig.parameters.items():
44
+ hint = hints.get(name)
45
+
46
+ # 0. 基础配置
47
+ names = [f"--{name.replace('_', '-')}"]
48
+ # *name_or_flags: str,
49
+ kwargs = {}
50
+ # type: _ActionType = ...,
51
+ # help: str | None = ...,
52
+ # default: Any = ...,
53
+ # choices: Iterable[Any] | None = ...,
54
+ # nargs: int | str | None = None,
55
+ # required: bool = ...,
56
+ # action: str | type[Action] = ...,
57
+ # version: str = ...,
58
+ # const: Any = ...,
59
+ # metavar: str | tuple[str, ...] | None = ...,
60
+ # dest: str | None = ...,
61
+ type_ = hint
62
+ metadata = []
63
+
64
+ # 1. 拆解 Annotated
65
+ if get_origin(hint) is Annotated:
66
+ type_, *metadata = get_args(hint)
67
+ # print(get_args(hint))
68
+
69
+ if isinstance(type_, bool):
70
+ ...
71
+ # if param.default is True:
72
+ # # 用户写的是 flag: bool = True
73
+ # # 自动生成 --no-flag,传了变成 False
74
+ # names = [f"--no-{name.replace('_', '-')}"]
75
+ # kwargs["action"] = "store_false"
76
+ # else:
77
+ # # 用户写的是 flag: bool = False(或者没写默认值)
78
+ # # 自动生成 --flag,传了变成 True
79
+ # kwargs["action"] = "store_true"
80
+ # kwargs["default"] = False
81
+ else:
82
+ kwargs["type"] = type_
83
+
84
+ # 2. 自动推断(类型、列表、布尔)
85
+ for m in metadata:
86
+ if m in [""]:
87
+ continue
88
+
89
+ if isinstance(m, str):
90
+ if len(m) == 1:
91
+ if m in ["*", "+", "?"]:
92
+ kwargs["nargs"] = m
93
+ if m == "~":
94
+ kwargs["nargs"] = None
95
+ else:
96
+ kwargs["help"] = m
97
+
98
+ elif isinstance(m, int):
99
+ kwargs["nargs"] = m
100
+
101
+ elif isinstance(m, list):
102
+ kwargs["choices"] = m
103
+
104
+ # 3. 处理默认值和必填
105
+ if param.default is not inspect.Parameter.empty:
106
+ kwargs["default"] = param.default
107
+ else:
108
+ if not isinstance(type_, bool):
109
+ kwargs["required"] = True
110
+
111
+ print(names, dict(sorted(kwargs.items())))
112
+
113
+ # 4. 回调 argparse
114
+ parser.add_argument(*names, **kwargs)
115
+
116
+ def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R:
117
+ return self.func(*args, **kwargs)
118
+
119
+ def run(self):
120
+ args = self.parser.parse_args()
121
+ kwargs = vars(args)
122
+ return self.func(**kwargs) # type: ignore
123
+
124
+
125
+ def Arg[**P, R](func: Callable[P, R]) -> Function[P, R]:
126
+ return Function(func)
127
+
128
+
129
+ def Argument(version: str = ""):
130
+ def Arg_[**P, R](func: Callable[P, R]) -> Function[P, R]:
131
+ return Function(func, version)
132
+
133
+ return Arg_
@@ -0,0 +1,36 @@
1
+ from typing import Annotated
2
+
3
+ import argsig as arg
4
+
5
+
6
+ # === 测试区 ===
7
+ @arg.Argument("v0.1.0") # 这里写version 和 help
8
+ def foo(
9
+ a: Annotated[int, [1, 2], "这里是help信息", "*"],
10
+ b: Annotated[str, "这里是help信息", "?"],
11
+ *,
12
+ c: Annotated[str, "这里是help信息", [1, 2], 2] = "",
13
+ ) -> bool:
14
+ """使用说明"""
15
+ print(f"执行了 foo: a={a}, b={b}")
16
+ return True
17
+
18
+ # - *name_or_flags: str,
19
+ # - type: _ActionType = ...,
20
+ # - help: str | None = ...,
21
+ # - default: Any = ...,
22
+ # - choices: Iterable[Any] | None = ...,
23
+ # - nargs: int | str | None = None,
24
+ # - required: bool = ...,
25
+ # action: str | type[Action] = ...,
26
+ # - version: str = ...,
27
+
28
+
29
+ # const: Any = ...,
30
+ # metavar: str | tuple[str, ...] | None = ...,
31
+ # dest: str | None = ...,
32
+
33
+ # 测试
34
+ foo(1, "a")
35
+ foo("a", 1) # type: ignore
36
+ foo.run()
File without changes