diff options
| author | 2012-02-29 01:22:16 +0100 | |
|---|---|---|
| committer | 2012-02-29 01:22:16 +0100 | |
| commit | d5a26bd35820b1cb3de991fd45460345b9d3f492 (patch) | |
| tree | db935b1c504b86b4208946f9e15c3d89b04611db /pygithub3/core | |
| parent | Repos.watchers service done (diff) | |
| download | python-github3-d5a26bd35820b1cb3de991fd45460345b9d3f492.tar.xz python-github3-d5a26bd35820b1cb3de991fd45460345b9d3f492.zip | |
Init documentation
+core
+services.user
~services.repos
Diffstat (limited to 'pygithub3/core')
| -rw-r--r-- | pygithub3/core/client.py | 6 | ||||
| -rw-r--r-- | pygithub3/core/result.py | 10 |
2 files changed, 8 insertions, 8 deletions
diff --git a/pygithub3/core/client.py b/pygithub3/core/client.py index a9e9ad4..ce6cf7c 100644 --- a/pygithub3/core/client.py +++ b/pygithub3/core/client.py @@ -15,12 +15,6 @@ class Client(object): """ Client to send configurated requests""" def __init__(self, **kwargs): - """ - It can be configurated - - :login, :password, :user, :repo, :token, :per_page, :base_url, :verbose - """ - self.requester = requests.session() self.config = { 'per_page': 100, diff --git a/pygithub3/core/result.py b/pygithub3/core/result.py index 226d6ab..9e69e7d 100644 --- a/pygithub3/core/result.py +++ b/pygithub3/core/result.py @@ -135,10 +135,11 @@ class Page(object): class Result(object): - """ """ + """ + Result is a very lazy paginator. It only do a real request when is needed + """ def __init__(self, client, request, **kwargs): - """ """ self.getter = Method(client.get, request, **kwargs) self.page = Page(self.getter) @@ -158,9 +159,14 @@ class Result(object): @property def pages(self): + """ Total number of pages in request """ return self.getter.last def get_page(self, page): + """ Get ``Page`` of resources + + :param int page: Page number + """ if page in xrange(1, self.pages + 1): return Page(self.getter, page) return None |
