python 中的关键字参数别名

我总是觉得奇怪的是，有一些关键字参数（或参数）可以传递给函数或__init__类的方法。如何防止不熟悉您的代码的用户犯错误？如何让用户立即（几乎本能地）熟悉您的代码，而无需编写糟糕或冗长的文档，或者进行多次试验和错误，从而阻止用户快速、舒适地使用您的代码或模块？

在Python中我们很幸运，因为我们有help and dir函数通常可以指导我们更好地理解某些函​​数参数是什么。但有时也写得不好__doc__没有任何解释的字符串。

让我举一些例子来说明我的意思：

    >>> help(str.lower)
    Help on method_descriptor:

        lower(...)
        S.lower() -> string

    Return a copy of the string S converted to lowercase

。 例如这里我们有一些函数...输入参数。这个参数代表什么，对于完全的新手（就像我第一次深入Python时一样），这很令人困惑，我经常跳过这一部分。

一些提供建议或教程的网站只是打印帮助功能文件或仅实现 sed 函数的众多功能之一。

1 示例函数的功能 https://www.tutorialspoint.com/python/string_lower.htm

或直接来自 python.org

str.lower()
返回字符串的副本，其中所有大小写字符 [4] 都转换为小写。 对于 8 位字符串，此方法与区域设置相关。

现在，对于刚刚开始编程并且不会（或不能）深入研究位和字节、地址等的人来说，这是一些只有术士大师才能执行的古老咒语，甚至不要让我开始解释为什么这是这样对非英语国家的人没有帮助。

对于这个特定的示例函数，我可以找出 2-3 个其他示例，它可以以不同的方式完成其工作，而且我还必须发现可以通过将字符串输入来使用此示例函数str.lower(here) part.

这里的大问题（当然，正如我所看到的）是，很少用谷歌搜索的 str 本身就可以描述，并且它的功能只能通过维基百科从逻辑上得出结论。

如果我总结问题很简单，那么有没有办法在用作参数时修改关键字以接受比我们定义的更多名称，这样用户就不必在介绍教程的第一步中扯掉他/她的头发？

现在我知道你们中的一些人会说这样的话：“如果你不明白，就不要这样做”或“我不是你妈妈教你的东西”......对此我不得不说“分享就是关怀”和“您有时也需要编码方面的帮助，否则您就不会在这个网站上”。

我将这个装饰器命名为 kwargs。奇迹般有效

def alias_param(param_name: str, param_alias: str) -> Callable:
    """
    Decorator for aliasing a param in a function

    Args:
        param_name: name of param in function to alias
        param_alias: alias that can be used for this param
    Returns:
    """
    def decorator(func: Callable):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            alias_param_value = kwargs.get(param_alias)
            if alias_param_value:
                kwargs[param_name] = alias_param_value
                del kwargs[param_alias]
            result = func(*args, **kwargs)
            return result
        return wrapper

然后就可以像这样使用

@alias_param("param_1", alias='p1')
def function(param_1=None):
    return param_1

function(p1='value')