如何仅从python docstring获取摘要行?

时间:2019-03-22 10:48:01

标签: python docstring

我编写测试功能。在文档字符串中,我通常将测试用例名称作为摘要行。测试用例描述如下。现在,我只需要从文档字符串中获取测试用例名称(第一行)。有什么pythonic的方法可以做到吗?

   def test_filesystem_001():
        """This is test case name of test_filesystem_001.

        [Test Description]
        -Create a file
        -write some data
        -delete it
        """
        pass

所以我这里需要一种方法来仅打印文档字符串的第一行,即“这是test_filesystem_001的测试用例名称”。 预先感谢。

2 个答案:

答案 0 :(得分:3)

只获得第一行:

>>>test_filesystem_001.__doc__.split("\n")[0]
This is test case name of test_filesystem_001.

split __doc__字符串在新行中。这将返回新行之前部分和新行之后部分的数组。要访问第一部分,请使用[0]

答案 1 :(得分:0)

获取文档字符串,将其拆分为几行,然后获取第一个。

print test_filesystem_001.__doc__.splitlines()[0]