Function main

tools/changelog.py:109–177

(token, revision_range)

def main(token, revision_range):
    lst_release, cur_release = [r.strip() for r in revision_range.split('..')]

    github = Github(token)
    github_repo = github.get_repo('numpy/numpy')

    # document authors
    authors = get_authors(revision_range)
    heading = "Contributors"
    print()
    print(heading)
    print("=" * len(heading))
    print(author_msg % len(authors))

    for s in authors:
        print('* ' + s)

    # document pull requests
    pull_requests = get_pull_requests(github_repo, revision_range)
    heading = "Pull requests merged"
    pull_msg = "* `#{0} <{1}>`__: {2}"

    print()
    print(heading)
    print("=" * len(heading))
    print(pull_request_msg % len(pull_requests))

    def backtick_repl(matchobj):
        """repl to add an escaped space following a code block if needed"""
        if matchobj.group(2) != ' ':
            post = r'\ ' + matchobj.group(2)
        else:
            post = matchobj.group(2)
        return '``' + matchobj.group(1) + '``' + post

    for pull in pull_requests:
        # sanitize whitespace
        title = re.sub(r"\s+", " ", pull.title.strip())

        # substitute any single backtick not adjacent to a backtick
        # for a double backtick
        title = re.sub(
            r"(?P<pre>(?:^|(?<=[^`])))`(?P<post>(?=[^`]|$))",
            r"\g<pre>``\g<post>",
            title
        )
        # add an escaped space if code block is not followed by a space
        title = re.sub(r"``(.*?)``(.)", backtick_repl, title)

        # sanitize asterisks
        title = title.replace('*', '\\*')

        if len(title) > 60:
            remainder = re.sub(r"\s.*$", "...", title[60:])
            if len(remainder) > 20:
                # just use the first 80 characters, with ellipses.
                # note: this was previously bugged,
                # assigning to `remainder` rather than `title`