如何从python docstring中获取摘要行？

Question

I write test functions. In the docstring, I usually mention test case name as the summary line. The test case description follows that. Now I just need to fetch the test case name (first line) from docstring. Is there any pythonic way to do it?

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

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

So I need a way here just to print the first line of the docstring, ie, "This is test case name of test_filesystem_001." Thanks in advance.

Answer 1

Just getting the first line:

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

You split the __doc__ string at a new line. This returns an array of the part before the new line and the part after the new line. To access the first part use [0]

Answer 2

取文档字符串，将其分成几行，然后取第一个。

print test_filesystem_001.__doc__.splitlines()[0]