Custom Iterator Structures

Many of the methods in github3.py that return iterators of another object are actually returning one of the iterators below. These iterators effectively allow users to ignore GitHub’s API pagination of large sets of data. In all senses, they behave like a normal Python iterator. Their difference is that they have extra logic around making API requests and coercing the JSON into predefined objects.

class github3.structs.GitHubIterator(count, url, cls, session, params=None, etag=None, headers=None)

The GitHubIterator class powers all of the iter_* methods.

as_dict()

Return the attributes for this object as a dictionary.

This is equivalent to calling:

json.loads(obj.as_json())
Returns:this object’s attributes serialized to a dictionary
Return type:dict
as_json()

Return the json data for this object.

This is equivalent to calling:

json.dumps(obj.as_dict())
Returns:this object’s attributes as a JSON string
Return type:str
cls = None

Class for constructing an item to return

count = None

Number of items left in the iterator

etag = None

The ETag Header value returned by GitHub

classmethod from_dict(json_dict, session)

Return an instance of this class formed from json_dict.

classmethod from_json(json, session)

Return an instance of this class formed from json.

headers = None

Headers generated for the GET request

last_response = None

The last response seen

last_status = None

Last status code received

last_url = None

Last URL that was requested

new_session()

Generate a new session.

Returns:A brand new session
Return type:GitHubSession
next()

Return the next item from the iterator. When exhausted, raise StopIteration

original = None

Original number of items requested

params = None

Parameters of the query string

ratelimit_remaining

Number of requests before GitHub imposes a ratelimit.

Returns:int
url = None

URL the class used to make it’s first GET

class github3.structs.SearchIterator(count, url, cls, session, params=None, etag=None, headers=None)

This is a special-cased class for returning iterable search results.

It inherits from GitHubIterator. All members and methods documented here are unique to instances of this class. For other members and methods, check its parent class.

as_dict()

Return the attributes for this object as a dictionary.

This is equivalent to calling:

json.loads(obj.as_json())
Returns:this object’s attributes serialized to a dictionary
Return type:dict
as_json()

Return the json data for this object.

This is equivalent to calling:

json.dumps(obj.as_dict())
Returns:this object’s attributes as a JSON string
Return type:str
classmethod from_dict(json_dict, session)

Return an instance of this class formed from json_dict.

classmethod from_json(json, session)

Return an instance of this class formed from json.

items = None

Items array returned in the last request

new_session()

Generate a new session.

Returns:A brand new session
Return type:GitHubSession
next()

Return the next item from the iterator. When exhausted, raise StopIteration

ratelimit_remaining

Number of requests before GitHub imposes a ratelimit.

Returns:int
total_count = None

Total count returned by GitHub