From 0361362d889c666464d55364241a39f38d032bdf Mon Sep 17 00:00:00 2001 From: NW/RL Date: Fri, 29 Mar 2024 16:28:08 -0500 Subject: Note to self --- steamrelationships/sr.py | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'steamrelationships') diff --git a/steamrelationships/sr.py b/steamrelationships/sr.py index 54a6464..88045b1 100644 --- a/steamrelationships/sr.py +++ b/steamrelationships/sr.py @@ -11,7 +11,7 @@ class SteamRelationships: reqjson: str = "requests.json" def __init__(self, webapikey: str, timeout: int = 30, reqdelay: float = 0.5, delayrand: float = 1.25, reqsafetybuffer: float = 0.9, reqjson: str = "requests.json") -> None: - f''' + """ (str/int) webapikey - Steam dev api key required to use Steam's ISteamUser/GetFriendList interface Request Options: @@ -19,12 +19,13 @@ class SteamRelationships: (float) reqdelay (Default: 0.5) - Default amount of seconds to wait between sending each request to Steam (float) delayrand (Default: 1.25) - The max percentage of extra delay to randomly add to each request (1 = no randomness, <1 = randomly shorter, >1 = randomly longer) (float) reqsafetybuffer (Default: 0.9) - Highest percent of Steam's API request limit you are willing to run - > Steam has an API request limit of {CONST.STEAMAPI_MAXREQ} requests per day. - reqsafetybuffer = {reqsafetybuffer} means SteamRequests will send a max of {int(CONST.STEAMAPI_MAXREQ * reqsafetybuffer)} requests per day. - Entering a number higher than 1 will not result in sending more than {CONST.STEAMAPI_MAXREQ} requests per day + > Steam has an API request limit of 100,000 requests per day. + reqsafetybuffer = 0.9 means SteamRequests will send a max of 90,000 requests per day. + Entering a number higher than 1 will not result in sending more than 100,000 requests per day (str) reqjson (Default: "requests.json") - The name/filepath of the file to store request times in - ''' + """ # I can't make this a formatted string :sob: + self.webapikey = webapikey self.timeout = timeout self.reqdelay = reqdelay @@ -116,6 +117,11 @@ class SteamRelationships: url = "https://api.steampowered.com/ISteamUser/GetFriendList/v0001/" options = {"key": self.webapikey, "steamid": steamid64, "relationship": "friend"} + # BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING # + # BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING # + # BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING BIG WARNING # + + # TODO: FIX THIS SO IT DOESN"T EXPLODE EVERYTHING ALL THE TIME if self._checkrequests() > 0: response = self.session.get(url, params=options, timeout=self.timeout) # GET should be as secure as POST because ssl is being used -- cgit v1.2.3