推荐用于函数参数处理的 Python 模块？

Question

有许多用于解析和协调命令行选项的 Python 模块（argparse、getopt、blargs 等）。 Python 拥有良好的内置功能/习惯用法，可用于处理各种函数参数（例如，默认值、*varargs、**keyword_args）。但是，当我阅读各种项目的顶级函数代码时，我发现函数参数的纪律和标准化明显少于命令行参数。

对于简单的函数来说，这不是问题；内置的论证功能非常有效并且绰绰有余。但是有很多功能丰富的模块，其顶级函数提供了许多不同的参数和选项（一些是互补的或排他的）、不同的操作模式、默认值、覆盖等——也就是说，它们具有参数复杂性接近命令行参数。他们似乎主要以临时方式处理他们的论点。

考虑到命令行处理模块的数量，以及它们随着时间的推移变得多么精致，我期望至少有一些模块可以简化复杂函数参数的争论。但我搜索了 PyPi、stackoverflow 和 Google，但没有成功。那么...您有推荐的函数（不是命令行！）参数处理模块吗？

---用示例更新---

很难给出一个真正简单的具体示例，因为只有在处理复杂的模块时用例才会出现。但这里有一个在代码中解释问题的机会：具有默认值的格式化程序模块可以在格式化程序实例化中或在调用函数/方法时覆盖。由于只有几个选项，已经有大量的选项处理废话，并且选项名称重复得令人恶心。

defaults = { 'indent':     4,
              'prefix':    None,
              'suffix':    None,
              'name':      'aFormatter',
              'reverse':   False,
              'show_name': False
            }

class Formatter(object):

    def __init__(self, **kwargs):
        self.name    = kwargs.get('name',    defaults['name'])
        self.indent  = kwargs.get('indent',  defaults['indent'])
        self.prefix  = kwargs.get('prefix',  defaults['prefix'])
        self.suffix  = kwargs.get('suffix',  defaults['suffix'])
        self.reverse = kwargs.get('reverse', defaults['reverse'])
        self.show_name = kwargs.get('show_name', defaults['show_name'])

    def show_lower(self, *args, **kwargs):
        indent = kwargs.get('indent', self.indent) or 0
        prefix = kwargs.get('prefix', self.prefix) 
        suffix = kwargs.get('suffix', self.suffix)
        reverse = kwargs.get('reverse', self.reverse)
        show_name = kwargs.get('show_name', self.show_name)

        strings = []
        if show_name:
            strings.append(self.name + ": ")
        if indent:
            strings.append(" " * indent)
        if prefix:
            strings.append(prefix)
        for a in args:
            strings.append(a.upper() if reverse else a.lower())
        if suffix:
            strings.append(suffix)
        print ''.join(strings)

if __name__ == '__main__':
    fmt = Formatter()
    fmt.show_lower("THIS IS GOOD")
    fmt.show_lower("THIS", "IS", "GOOD")
    fmt.show_lower('this IS good', reverse=True)
    fmt.show_lower("something!", show_name=True)

    upper = Formatter(reverse=True)
    upper.show_lower("this is good!")
    upper.show_lower("and so is this!", reverse=False)

Answer 1

当我第一次读到你的问题时，我心想你是在要求一个创可贴模块，但它不存在，因为没有人愿意编写一个使糟糕设计持续存在的模块。

但我意识到情况比这更复杂。创建您所描述的模块的目的是创建可重用的通用代码。现在，很可能有一些接口相当复杂。但这些接口恰恰是一般情况代码可能无法轻松处理的接口。它们很复杂，因为它们解决具有许多特殊情况的问题域。

换句话说，如果一个接口确实无法重构，那么它可能需要大量自定义的特殊情况代码，这些代码的可预测性不足以值得在模块中进行概括。相反，如果一个接口可以很容易地用您所描述的那种模块进行修补，那么它也可能可以被重构——在这种情况下它应该是这样。

Answer 2

1. 我认为命令行解析和函数参数处理没有太多共同点。命令行的主要问题是唯一可用的数据结构是字符串的平面列表，并且您没有像函数头这样的工具可用于定义每个字符串的含义。在Python函数的头中，您可以为每个参数命名，可以接受容器作为参数，可以定义默认参数值等。命令行解析库的作用实际上是为命令行提供一些Python 为函数调用提供的功能：为参数命名、分配默认值、转换为所需的类型等。在 Python 中，所有这些功能都是内置的，因此您不需要库即可获得这种便利。

2. 关于您的示例，可以通过多种方式使用该语言提供的功能来改进此设计。您可以使用默认参数值而不是 defaults 字典，您可以将所有标志封装在 FormatterConfig 类中，并且只传递一个参数，而不是一遍又一遍地传递所有这些参数。但我们假设您想要的正是示例代码中给出的接口。实现此目的的一种方法是使用以下代码：

   类配置（字典）：
       def __init__(自我，配置)：
           dict.__init__(自我，配置)
           self.__dict__ = 自我
   
   def get_config(kwargs, 默认值):
       配置=默认值.copy()
       配置.更新(kwargs)
       返回配置（配置）
   
   类格式化程序（对象）：
   
       def __init__(self, **kwargs):
           self.config = get_config(kwargs, 默认值)
   
       def show_lower(self, *args, **kwargs):
           config = get_config(kwargs, self.config)
   
           字符串=[]
           如果config.show_name：
               strings.append(config.name + ": ")
           strings.append(" " * config.indent)
           如果配置.前缀：
               strings.append(config.prefix)
           对于参数中的 a：
               strings.append(a.upper() if config.reverse else a.lower())
           如果配置.后缀：
               strings.append(config.suffix)
           打印“”.join(字符串)
   

   Python 提供了很多工具来进行此类参数处理。因此，即使我们决定不使用其中一些（例如默认参数），我们仍然可以避免太多重复。

Answer 3

如果您的 API 非常复杂，您认为使用某些模块来处理传递给您的选项会更容易，那么实际的解决方案很可能是简化您的 API。事实上，有些模块有非常复杂的方式来调用东西，这是一种耻辱，而不是一个特性。

Answer 4

它在开发人员手中，但是如果您正在制作一个可能对其他一些项目有用或将在其他用户之间发布的库，那么我认为首先您需要确定您的问题并对其进行分析，

很好地记录您的功能，这很好尽量减少参数的数量，
为函数参数提供默认值，用户可能难以指定到底需要传递什么。

对于某些复杂的要求，您可以提供特殊的类方法，这些方法可以被高级编程覆盖，或者被真正想要实现他们正在使用库的东西的高级用户覆盖，继承总是存在的。

您也可以阅读 PEP8 ，这可能会有所帮助，但最终目标是指定参数的最小数量，限制用户输入必需的参数，最好为可选参数提供默认值 - 以您的 library / code 易于理解的方式普通开发者也...

Answer 5

您可以为默认编写更通用的代码。

如果您考虑以相反的方式进行默认设置，请检查默认设置并覆盖关键字（如果不存在）。

 defaults = { 'indent':     4,
          'prefix':    None,
          'suffix':    None,
          'name':      'aFormatter',
          'reverse':   False,
          'show_name': False
        }

class Formatter(object):

   def __init__(self, **kwargs):
      for d,dv in defaults.iteritems():
         kwargs[d] = kwargs.get(d, dv)

旁注：
我建议在 __init__ 方法定义中使用默认关键字 args。这使得function定义真正成为类的其他开发人员和用户的契约（Formatter）

def __init__(self, indent=4, reverse=False .....etc..... ):