Python 函数有太多带有默认值的参数，如何使其更简洁？

Question

我有以下函数签名，它看起来真的很难看，我该怎么做才能使它看起来更干净？

def contact(
  request, sender=settings.DEFAULT_FROM_EMAIL,
  subj_tmpl='contato/subject.txt',msg_tmpl='contato/msg.html',
  template='contato/contato.html', success_template='contato/success.html',
  success_redir='/',append_message=None,):

Answer 1

如果我是你，我想我会这样做：

def contact(request, sender=None, append_message=None, context=None):

   if not sender:
       sender = settings.DEFAULT_FROM_EMAIL  # i hope that you can access settings here

   # The context arg is a dictionary where you can put all the others argument and 
   # you can use it like so :

   subj_tmpl = context.get('subj_tmpl', 'contato/subject.txt')
   # ....

希望这会对你有所帮助。

Answer 2

我的建议是删除参数。您真的需要能够单独指定所有模板吗？只指定模板文件夹，然后强制其中包含 subject.txt、msg.html 等内容，难道还不够吗？

如果您只是想提高可读性，请将其重新格式化为每行一个参数：

def contact(
  request, 
  sender=settings.DEFAULT_FROM_EMAIL,
  subj_tmpl='contato/subject.txt',
  msg_tmpl='contato/msg.html',
  template='contato/contato.html', 
  success_template='contato/success.html',
  success_redir='/',
  append_message=None,):

这将使读者更快地掌握参数名称。

Answer 3

您可以将其重写为：

def contact( request, **kargs):
    try:
        sender = kwargs.pop ('sender')
    except KeyError:
        sender=settings.DEFAULT_FROM_EMAIL

    try:
        subj_tmpl = kwargs.pop ('subj_tmpl')
    except KeyError:
        subj_tmpl='contato/subject.txt'

    # ... 
    # and so on 
    # ...

Answer 4

def contact(request, **kwargs):
    sender = kwargs.get('sender', settings.DEFAULT_FROM_EMAIL)
    subj_template = kwargs.get('subj_template', 'contato/subject.txt')
    ..

话虽如此，我认为您当前的解决方案比使用 **kwargs 更好。

Answer 5

这对我来说似乎并不那么丑陋：你有一个函数，你有足够的参数来修改函数的行为方式，并且你有合理的默认值，这样你就不需要在每个函数调用时指定所有参数。

可以将函数打包在类中：在类构造函数中，您指定参数列表中的所有这些值，并且您有一个不带参数的特殊方法来执行核心功能。

像这样的东西：

class ContactForm(object):
    def __init__( self, 
                  subj_tmpl='contato/subject.txt',
                  msg_tmpl='contato/msg.html',
                  template='contato/contato.html',  
                  success_template='contato/success.html',
                  success_redir='/',
                  append_message=None):
        self.subj_tmpl = subj_tmpl
        self.msg_tmpl = msg_tmpl
        self.template = template
        self.success_template = success_template
        self.success_redir = success_redir
        self.append_message = append_message

    def __call__( self, request, sender=settings.DEFAULT_FROM_EMAIL ):
        # do something

# use case:
contact = ContactForm()
contact( req, sndr )

（我从参数名称中猜测哪些值是特定于站点的，哪些是特定于用户的。我不知道您的具体应用程序，请按照您想要的方式进行调整）