regex101: Python google docstring format

^start of line

Non-Capturing Group(?: {4}|\t)

1st Alternative {4}

{4}the literal (32₁₀ / 40₈ / 20₁₆) , repeated exactly 4 times

2nd Alternative\t

\ta tab character (ASCII 9)

Group name(?P<name>\*{0,2}\w+)

\*{0,2}the literal * (42₁₀ / 52₈ / 2A₁₆) , repeated between 0 and 2 times

\w+a Unicode word character, repeated at least once

:the literal : (58₁₀ / 72₈ / 3A₁₆)

Group desc(?P<desc>(?:\s|.*)*)

Non-Capturing Group(?:\s|.*)*

*repeats the group contents below any number of times:

1st Alternative\s

\sa Unicode whitespace character

2nd Alternative.*

.*any Unicode character (except for line terminators), repeated any number of times

Global pattern flags

m modifier: multiline. Causes ^ and $ to match the start and end of each line, not only the start and end of the string

g modifier: global. Finds all matches instead of stopping after the first

Search reference

Regular Expression

^(?: {4}|\t)(?P<name>\*{0,2}\w+):(?P<desc>(?:\s|.*)*)

New

    bool: True if successful, False otherwise.

    The return type is optional and may be specified at the beginning of
    the ``Returns`` section followed by a colon.

    The ``Returns`` section may span multiple lines and paragraphs.
    Following lines should be indented to match the first line.

    The ``Returns`` section supports any reStructuredText formatting,
    including literal blocks::

        {
            'param1': param1,
            'param2': param2
        }

Regular Expressions 101

Regular Expression

Extraction