Code snippet demonstrating how to match parameter details from function docstrings formatted to numpy/scipy docstring standards.

function_parameter_match_regex.py

# first run parameter match regex
param_re = re.compile(r"(?s)\w+ : .*?(?=\w+ :)")
# the above will not find the final parameter, this will
param_re2 = re.compile(r"(?s)\w+ : .*")

params = []  # initialise parameter list

while True:
    # find a parameter
    new_param = param_re.search(text)

    if new_param is None:
        # if no parameters have been found, try with modified regex
        new_param = param_re2.search(text)
 
        if new_param is None:
            # if we still cannot find any new parameters, break
            break

    # we have a parameter so add to list
    params.append(new_param.group())
    # remove from text so that we don't keep matching the same parameter
    text = text.replace(new_param.group(), "")