How to get just summary line from 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, i.e., "This is test case name of test_filesystem_001." Thanks in advance.

This is clearly not duplicate of the mentioned link. This question is specific to getting summary/first line from doc string. — XgigPro
– XgigPro, Commented Mar 22, 2019 at 11:46
Yeah, but the part which isn't obvious from the duplicate is not well-defined in your question. — tripleee
– tripleee, Commented Mar 22, 2019 at 11:51

Uli Sotschok · Accepted Answer · 2019-03-22 10:51:39Z

6

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]

answered Mar 22, 2019 at 10:51

Uli Sotschok

1,2461 gold badge9 silver badges19 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Peter Westlake · Accepted Answer · 2019-03-22 10:53:58Z

1

Take the docstring, split it into lines, and take the first.

print test_filesystem_001.__doc__.splitlines()[0]

answered Mar 22, 2019 at 10:53

Peter Westlake

5,0801 gold badge28 silver badges38 bronze badges

Collectives™ on Stack Overflow

How to get just summary line from python docstring?

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related