小编lat*_*oin的帖子

记录命名元组的标准方法是什么?

希望通过使用命名元组来保存多个变量以通过多个函数来清理一些代码。下面是一个简化的例子(我实际上还有一些额外的参数)。

前:

def my_function(session_cass, session_solr, session_mysql, some_var, another):
"""Blah blah.

Args:
    session_cass (Session): Cassandra session to execute queries with.
    session_solr (SolrConnection): Solr connection to execute requests with.
    session_mysql (connection): MySQL connection to execute queries with.
    some_var (str): Yada yada.
    another (int): Yada yada.
"""
Run Code Online (Sandbox Code Playgroud)

后:

def my_function(sessions, some_var, another):
"""Blah blah.

Args:
    sessions (namedtuple): Holds all the database sessions.
    some_var (str): Yada yada.
    another (int): Yada yada.
"""
Run Code Online (Sandbox Code Playgroud)

对于文档字符串,我一直在遵循 Google 样式指南,并添加了类型(受这篇文章的启发),我非常喜欢它,因为它可以更轻松地跟踪传入的类型。

我的问题是,在这种情况下,您将如何记录命名元组?显然,由于它当前已设置,因此您没有关于 namedtuple 中的类型的信息。是否有一种可接受的方法可以在此处扩展文档字符串,或者记录定义它的命名元组(未显示)?

我知道你可以在这个庄园里记录一个类,但我试图远离使用一个类,因为除了保存变量之外,我真的没有任何目的。

python code-documentation

5
推荐指数
2
解决办法
1349
查看次数

标签 统计

code-documentation ×1

python ×1