一种python方式来包装接受大量参数的子进程调用

Question

我正在编写一个python脚本，它为命令行工具提供了一个更用户友好的API。一些必要的命令调用需要很多参数(有时多达10个左右)，但这在Python中不是好的做法。它们不可能只是违约;必须能够为给定的调用设置所有参数。

我当前的结构是一个API类，它具有expose_image()等函数，然后是一个接口类，用于处理子进程命令的构造和调用。我不认为添加更多的类会有帮助，因为API类仍然需要以某种方式生成和传递参数。

我想到的一个解决方案是用参数填充字典或namedtuple，并将其作为**kwargs传递，这使事情看起来更好一些，但不那么显式。

是否有更好的处理方法?

谢谢!

Answer 1

值得赞扬的是，您希望为该命令构建一个python API，而不仅仅是一个API。

我不知道你为什么无视默认参数?如果默认值是None，您可以将其视为不向命令行添加内容的指南。

例如，假设您想调用tree命令。你可以这样写:

def my_tree(dirs_only=False, full_prefix=False, max_level=None, pattern=None):
   cmd_line = ['tree']
   if dirs_only:
       cmd_line.append('-d')
   if full_prefix:
       cmd_line.append('-f')
   if max_level is not None:
       cmd_line.append('-L')
       cmd_line.append(str(max_level))
   if pattern is not None:
       cmd_line.append('-P')
       cmd_line.append(pattern)
   subprocess.do_something_with(cmd_line)

my_tree的调用者可以像在shell中那样与它交互:

my_tree()
my_tree(dirs_only=True)
my_tree(pattern='Foo*')
my_tree(pattern='Foo*', max_level=2, full_prefix=True)

在Java、c#或Dart等语言中，您经常会看到"流畅"的api，也许这些api会有所帮助。它将导致如下代码:

my_tree().call()
my_tree().dirs_only().call()
my_tree().with_pattern('Foo*').call()
my_tree() 
    .with_pattern('Foo*') 
    .with_max_level(2) 
    .full_prefix() 
    .call()

虽然调用看起来更好，但是为了获得这样的优美，您需要编写大量的样板文件，这肯定会让人感觉有点不像python。

Answer 2

就像你说的，**的kvargs是方便的方式传递几个参数到你的函数，但它总是更好地在函数定义中显式声明参数:

def store(data, database,
          user, password,
          host=DEFAULT_HOST,
          port=PG_DEFAULT_PORT,
          chunk_size=64,
          flags=None):
     pass
# call
params = {"data": generate_data(),
          "database": "mydb",
          "user": "guest",
          "password": "guest",
          "chunk_size": 128
          }
store(**params)

另一种方法是使用"参数"类，像这样(从pika库的一个例子):

class ConnectionParameters(Parameters):
    def __init__(self,
                 host=None,
                 port=None,
                 virtual_host=None,
                 credentials=None,
                 channel_max=None,
                 frame_max=None,
                 heartbeat_interval=None,
                 ssl=None,
                 ssl_options=None,
                 connection_attempts=None,
                 retry_delay=None,
                 socket_timeout=None,
                 locale=None,
                 backpressure_detection=None):
        super(ConnectionParameters, self).__init__()
        # Create the default credentials object
        if not credentials:
            credentials = self._credentials(self.DEFAULT_USERNAME,
                                            self.DEFAULT_PASSWORD)
        ...
# call
conn_params = pika.ConnectionParameters(host=self._host,
                                            port=self._port,
                                            credentials=cred)
conn = pika.BlockingConnection(parameters=conn_params)