argset 0.1.0

安装

argset 需要 Python 3.6 或更高版本。只需使用 Python 3 的 pip 安装 argset 及其依赖项即可（你有 pip，对吧？）

python3 -m pip install argset

示例

检查函数的参数

>>> from argset import argset
>>> def my_func(foo, bar):
...     print(f"foo={foo!r}")
...     print(f"bar={bar!r}")
...
>>> a = argset(my_func)
>>> "foo" in a
True
>>> "quux" in a
False

过滤一组参数，仅保留函数接受的参数

>>> a.select({"foo": 42, "bar": 23, "quux": 17})
{'foo': 42, 'bar': 23}
>>> my_func(**a.select({"foo": 42, "bar": 23, "quux": 17}))
foo=42
bar=23

与上述相同，但现在函数接受 **kwargs

>>> from argset import argset
>>> def my_func2(foo, **kwargs):
...     print(f"foo={foo!r}")
...     for k, v in kwargs.items():
...          print(f"{k}={v!r}")
...
>>> a2 = argset(my_func2)
>>> "foo" in a2
True
>>> "quux" in a2
True
>>> a2.select({"foo": 42, "bar": 23, "quux": 17})
{'foo': 42, 'bar': 23, 'quux': 17}
>>> my_func2(**a2.select({"foo": 42, "bar": 23, "quux": 17}))
foo=42
bar=23
quux=17

API

argset(func: Callable) -> ArgSet

检查一个可调用对象，并返回其参数的摘要作为一个 ArgSet

class ArgSet

一个表示可调用参数的表示。它具有以下属性和特性

required_positional_only: int

只有位置参数且没有默认值的参数数量

optional_positional_only: int

只有位置参数且有默认值的参数数量

positional_only: int

所有位置参数的总数

required_args: frozenset[str]

所有没有默认值的位参数或关键字参数的名称

optional_args: frozenset[str]

所有有默认值的位参数或关键字参数的名称

argnames: frozenset[str]

所有位参数或关键字参数的名称

takes_args: bool

可调用是否有形式为*args的参数

takes_kwargs: bool

可调用是否有形式为**kwargs的参数

ArgSet对象支持in操作符；形式为argname in a的表达式在argname在a.argnames中或a.takes_kwargs为True时返回True。

ArgSet对象具有以下方法

ArgSet.select(kwargs: Dict[str, Any]) -> Dict[str, Any]

返回所有在kwargs中且键为可调用接受的位参数或关键字参数的项。如果takes_kwargs为True，则返回值是kwargs的副本。

ArgSet.missing(kwargs: Dict[str, Any]) -> FrozenSet[str]

返回所有在required_args中但不在kwargs中出现的键