Skip to content

Stubs for slumber #5764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyrightconfig.stricter.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"stubs/waitress",
"stubs/Werkzeug",
"stubs/beautifulsoup4",
"stubs/slumber",
],
"typeCheckingMode": "basic",
"strictListInference": true,
Expand Down
2 changes: 2 additions & 0 deletions stubs/slumber/@tests/stubtest_allowlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
slumber.API.__init__
slumber.Resource.as_raw
1 change: 1 addition & 0 deletions stubs/slumber/METADATA.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
version = "0.7"
30 changes: 30 additions & 0 deletions stubs/slumber/slumber/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
from typing import Any

class ResourceAttributesMixin:
def __getattr__(self, item): ...

class Resource(ResourceAttributesMixin):
def __init__(self, *args, **kwargs) -> None: ...
def __call__(self, id: Any | None = ..., format: Any | None = ..., url_override: Any | None = ...): ...
def as_raw(self): ...
def get(self, **kwargs): ...
def options(self, **kwargs): ...
def head(self, **kwargs): ...
def post(self, data: Any | None = ..., files: Any | None = ..., **kwargs): ...
def patch(self, data: Any | None = ..., files: Any | None = ..., **kwargs): ...
def put(self, data: Any | None = ..., files: Any | None = ..., **kwargs): ...
def delete(self, **kwargs): ...
def url(self): ...

class API(ResourceAttributesMixin):
resource_class: Any
def __init__(
self,
base_url: Any | None = ...,
auth: Any | None = ...,
format: Any | None = ...,
append_slash: bool = ...,
session: Any | None = ...,
serializer: Any | None = ...,
raw: bool = ...,
) -> None: ...
11 changes: 11 additions & 0 deletions stubs/slumber/slumber/exceptions.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
class SlumberBaseException(Exception): ...

class SlumberHttpBaseException(SlumberBaseException):
def __init__(self, *args, **kwargs) -> None: ...

class HttpClientError(SlumberHttpBaseException): ...
class HttpNotFoundError(HttpClientError): ...
class HttpServerError(SlumberHttpBaseException): ...
class SerializerNoAvailable(SlumberBaseException): ...
class SerializerNotAvailable(SlumberBaseException): ...
class ImproperlyConfigured(SlumberBaseException): ...
29 changes: 29 additions & 0 deletions stubs/slumber/slumber/serialize.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
from typing import Any

class BaseSerializer:
content_types: Any
key: Any
def get_content_type(self): ...
def loads(self, data) -> None: ...
def dumps(self, data) -> None: ...

class JsonSerializer(BaseSerializer):
content_types: Any
key: str
def loads(self, data): ...
def dumps(self, data): ...

class YamlSerializer(BaseSerializer):
content_types: Any
key: str
def loads(self, data): ...
def dumps(self, data): ...

class Serializer:
serializers: Any
default: Any
def __init__(self, default: Any | None = ..., serializers: Any | None = ...) -> None: ...
def get_serializer(self, name: Any | None = ..., content_type: Any | None = ...): ...
def loads(self, data, format: Any | None = ...): ...
def dumps(self, data, format: Any | None = ...): ...
def get_content_type(self, format: Any | None = ...): ...
3 changes: 3 additions & 0 deletions stubs/slumber/slumber/utils.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
def url_join(base, *args): ...
def copy_kwargs(dictionary): ...
def iterator(d): ...