将关键字参数和 **kwargs 传递给子函数

Question

我有一个用于执行 sql 脚本的子类。

def execute_script(self, script_path, **kwargs):
    pass # connect to db
    query = open(script_path, "r").read().format(**kwargs)
    pass # execute script and close connection

根据我要执行的操作类型，我有不同的包装函数，使用不同的关键字参数，例如

def create_job(self, **kwargs):
    self.execute_script("create_job.sql", **kwargs)

现在，这非常适合格式化我的 sql 脚本以包含我的关键字参数，例如我执行create_job(job_name='foo')。该脚本获取job_name 并使用上面指出的.format()-方法将其放入我的sql 脚本中。

但是，随着 sql 脚本变长，需要传入更多参数，我可能很难准确记住需要传递哪些参数，因此我想从 *kwargs 切换到显式关键字参数，像这样：

def create_job2(self, job_name, **kwargs):
    self.execute_script("create_job.sql", **kwargs)

但是，这给我带来了以下错误：

KeyError: 'job_name'

所以，我在子函数中包含了job_name，认为execute_script() 中的**kwargs 参数意味着我可以将任意数量的关键字参数传递给函数。 然而，

def create_job3(self, job_name, **kwargs):
    self.execute_script("create_job.sql", job_name, **kwargs)

结果

TypeError: execute_script() takes exactly 2 arguments (3 given)

如果我省略了子函数 execute_script() 的 **kwargs 参数，也会发生同样的错误

我的问题：如何修改 execute_script() 函数，以便我可以将 any 关键字参数传递给包装函数？

或者（这实际上是首选），我可以离开**kwargs-connotation，而是使用文档字符串或任何其他机制来提醒我需要传递的参数（我我指的是弹出一个框并突出显示所需的参数，如 Sublime Text 或 PyCharm 正在做的）？

Answer 1

使用此代码：

def create_job2(self, job_name, **kwargs):
    self.execute_script("create_job.sql", **kwargs)

def execute_script(self, script_path, **kwargs):
    pass # connect to db
    query = open(script_path, "r").read().format(**kwargs)
    pass # execute script and close connection

job_name 参数在create_job 内部“丢失”，并且没有传递给execute_script。 kwargs 只是一个您可以编辑的映射：

def create_job2(self, job_name, **kwargs):
    kwargs['job_name'] = job_name
    self.execute_script("create_job.sql", **kwargs)

但由于您实际上并未在 create_job 中使用 job_name，因此我认为以这种方式拆分它没有帮助（并且会坚持您对 create_job 的原始定义）。

KeyError 表示后面的某些东西期待命名参数 job_name，或者您正试图将其从 kwargs 字典中提取出来。

正如您所指出的，“记住”（或被提醒）参数的一种方法是在方法定义中明确列出它们。

但另一个是新建一个类，例如：

class Job:
    def __init__(self, name, foo, bar, ...):
        self.name = name
        ...

所以你在一个地方有一堆参数可能很烦人并且难以维护，但它只在一个地方并且不会在你的每个函数中重复。

然后你在函数/方法之间传递一个 Job 对象，它们访问 Job 实例属性。

根据您的结构，您甚至可以实现Job.execute() 方法。