Skip to content

docs: improve typehints of method sign_request #370

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
8 changes: 7 additions & 1 deletion binance/api.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import json
from json import JSONDecodeError
import logging
from typing import Any, Literal
import requests
from .__version__ import __version__
from binance.error import ClientError, ServerError
Expand Down Expand Up @@ -85,7 +86,12 @@ def limit_request(self, http_method, url_path, payload=None):
check_required_parameter(self.api_key, "api_key")
return self.send_request(http_method, url_path, payload=payload)

def sign_request(self, http_method, url_path, payload=None):
def sign_request(
self,
http_method: Literal["GET", "POST", "DELETE", "PUT"],
url_path: str,
payload: dict[str, Any] | None = None,
) -> dict[str, Any]:
if payload is None:
payload = {}
payload["timestamp"] = get_timestamp()
Expand Down