Build out more of our type-stubs

sigmavirus24 · sigmavirus24 · commit ab8105f28ba4 · 2018-03-19T18:48:52.000-05:00
diff --git a/github3/decorators.pyi b/github3/decorators.pyi
@@ -0,0 +1,35 @@
+from typing import (
+    Any,
+)
+
+import io
+
+import requests
+
+
+class RequestsStringIO(io.BytesIO):
+    def read(self, n: int=-1, *args, **kwargs) -> bytes:  # type: ignore
+        ...
+
+
+# These decorators are broken until there's a solution to
+# https://github.com/python/typing/issues/193
+# https://github.com/python/mypy/issues/1317
+def requires_auth(func: Any) -> Any:
+    ...
+
+
+def requires_basic_auth(func: Any) -> Any:
+    ...
+
+
+def requires_app_credentials(func: Any) -> Any:
+    ...
+
+
+def generate_fake_error_message(
+    msg: str,
+    status_code: int=401,
+    encoding: str='utf-8',
+) -> requests.models.Response:
+    ...
diff --git a/github3/gists/gist.pyi b/github3/gists/gist.pyi
@@ -1,4 +1,7 @@
-class _Gist:
+from .. import models
+
+
+class _Gist(models.GitHubCore):
     ...
 
 
diff --git a/github3/github.pyi b/github3/github.pyi
@@ -9,6 +9,7 @@ from typing import (
 )
 
 from . import auths
+from . import decorators
 from . import events
 from . import models
 from . import orgs
@@ -30,6 +31,7 @@ class GitHub(models.GitHubCore):
     ) -> None:
         ...
 
+    @decorators.requires_auth
     def add_email_addresses(
         self: T,
         addresses: List[str]=[],
@@ -70,6 +72,7 @@ class GitHub(models.GitHubCore):
     ) -> structs.GitHubIterator[users.ShortUser]:
         ...
 
+    @decorators.requires_basic_auth
     def authorization(
         self: T,
         id_num: Union[int, str],
@@ -109,6 +112,7 @@ class GitHub(models.GitHubCore):
     ) -> gist.Gist:
         ...
 
+    @decorators.requires_auth
     def create_issue(
         self: T,
         owner: str,
@@ -122,6 +126,7 @@ class GitHub(models.GitHubCore):
     ) -> issue.ShortIssue:
         ...
 
+    @decorators.requires_auth
     def create_key(
         self: T,
         title: str,
@@ -130,6 +135,7 @@ class GitHub(models.GitHubCore):
     ) -> users.Key:
         ...
 
+    @decorators.requires_auth
     def create_repository(
         self: T,
         name: str,
@@ -143,12 +149,14 @@ class GitHub(models.GitHubCore):
     ) -> repo.Repository:
         ...
 
+    @decorators.requires_auth
     def delete_email_addresses(
         self: T,
         addresses: List[str],
     ) -> bool:
         ...
 
+    @decorators.requires_auth
     def emails(
         self: T,
         number: int=-1,
@@ -162,6 +170,7 @@ class GitHub(models.GitHubCore):
     def feeds(self: T) -> Dict[str, Any]:
         ...
 
+    @decorators.requires_auth
     def follow(
         self: T,
         username: str
@@ -175,3 +184,49 @@ class GitHub(models.GitHubCore):
         etag: Optional[str]=None,
     ) -> structs.GitHubIterator[users.ShortUser]:
         ...
+
+    @decorators.requires_auth
+    def followers(
+        self: T,
+        number: int=-1,
+        etag: Optional[str]=None,
+    ) -> structs.GitHubIterator[users.ShortUser]:
+        ...
+
+    def followers_of(
+        self: T,
+        username: str,
+        number: int=-1,
+        etag: Optional[str]=None,
+    ) -> structs.GitHubIterator[users.ShortUser]:
+        ...
+
+    @decorators.requires_auth
+    def following(
+        self: T,
+        number: int=-1,
+        etag: Optional[str]=None,
+    ) -> structs.GitHubIterator[users.ShortUser]:
+        ...
+
+    def gist(
+        self: T,
+        id_num: int,
+    ) -> gist.Gist:
+        ...
+
+    @decorators.requires_auth
+    def gists(
+        self: T,
+        number: int=-1,
+        etag: Optional[str]=None,
+    ) -> structs.GitHubIterator[gist.ShortGist]:
+        ...
+
+    def gists_by(
+        self: T,
+        username: str,
+        number: int=-1,
+        etag: Optional[str]=None,
+    ) -> structs.GitHubIterator[gist.ShortGist]:
+        ...
