kwargs-only 1.1.1

为什么？

如果您正在制作一个库（仍然支持Python 2），您可能希望使其API中的所有函数都只接受关键字参数，出于以下几个原因

• 为了避免用户混淆，例如，如果您将 x 和 y 参数作为坐标，很容易忘记它们应该以什么顺序传递。

• 为了使您的API更容易扩展 - 您将知道没有调用者依赖于位置参数的顺序，因此可以重构以使其有意义。

安装

使用 pip

pip install kwargs-only

支持Python 2.7和3.4到3.8。

用法

导入装饰器并将其应用于函数

from kwargs_only import kwargs_only

@kwargs_only
def myfunction(foo=1, bar=2):
    pass

然后使用位置参数调用函数将导致它因 TypeError 而失败

>>> myfunction(1, 2)
...
TypeError: myfunction should only be called with keyword args

装饰器通过允许第一个参数为位置参数，如果它的名字是 self 或 cls，来检测方法和类方法。应该在 classmethod 之前将 kwargs_only 应用到函数上。例如：

class MyClass:

    @classmethod
    @kwargs_only
    def my_class_method(cls, foo=1):
        pass

    @kwargs_only
    def my_instance_method(self, bar=1):
        pass

这就是全部内容！祝您享受！

历史