Quick hack generator for GitHub paginated responses

agithub_paginate.py

"""
Quick hack to transparently get paginated responses from GitHub
"""

import copy  # noqa: E402

class AG_Exception(Exception):
    pass


def ag_call(func, *args, expected_rc=None, **kwargs):
    """
    Wrap AGitHub calls with basic error detection.

    Not smart, and hides any error information from caller.
    But very convenient. :)
    """
    if expected_rc is None:
        expected_rc = [200, ]
    rc, body = func(*args, **kwargs)
    if rc not in expected_rc:
        raise AG_Exception
    return body


def ag_get_all(func, *orig_args, **orig_kwargs):
    """
    Generator for multi-page GitHub responses

    It hacks the "page" query parameter to each call to get the next page. This
    is Not a general solution - it does not follow the links in the headers
    like a good client should.
    """
    kwargs = copy.deepcopy(orig_kwargs)
    args = copy.deepcopy(orig_args)
    kwargs["page"] = 1
    while True:
        body = ag_call(func, *args, **kwargs)
        if len(body) >= 1:
            for elem in body:
                yield elem
        else:
            break
        # fix up to get next page
        kwargs["page"] += 1