将 function 的文档字符串传递给另一个文件 python3

Question

我正在使用 apispec 来生成 openapi 规范（swagger），以便在 AWS 中进一步使用。

我试图通过创建另一个包含与实现的路由相关的文档字符串的函数的文件来优化我当前的文件。 我仍然不确定这是否可能，但我确定它对我不起作用。 到目前为止，这是我已经实现的：

文件login_file.py中login_doc()下面的 function 包含与登录路由相关的文档字符串。

def login_doc():
"""
post:
  responses:
    "200":
      description: "200 response"
      content:
        application/json:
          schema:
          $ref: "#/components/schemas/Empty"
"""
pass

在文件generate_openapi.py我这样做了：

import login_file

@app.route('/login', methods=['POST'])
def login():
  login_file.login_doc.__doc__

PS：进口的 rest 工作得很好，只是在发布这个问题时删除了它们。

不幸的是，这对我不起作用。 正如我之前所说，我试图尽量减少generate_openapi.py的代码行数，使其更具可读性和可理解性。 提前感谢大家的时间。

Answer 1

虽然我怀疑它是否有助于可读性，但如果您在 function 之外定义文档字符串，则可以在定义 function 之后设置文档字符串，如下所示：

import login_file

@app.route('/login', methods=['POST'])
def login():
  ...

login.__doc__ = login_file.login_doc.__doc__

或者，定义一个装饰器来更改 function 的文档字符串。