DHBW/TelegramAktienBot
1
0
Fork 0
Code Issues 6 Pull Requests 26 Actions Packages Projects Releases Wiki Activity

added missing docstring part

Browse Source
This commit is contained in:
Linus E 2022-05-10 09:55:41 +02:00
parent b63744d08a
commit 5e0c6dabba
1 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
telegram_bot/api_handling/api_handler.py
View File

@ -70,6 +70,12 @@ class API_Handler:
Args: Args:
email (string): email of the user email (string): email of the user
password (string): password of the user password (string): password of the user
Returns:
token (string): new token or None if not 200
Raises:
None
""" """
payload = {'email': email, 'password': password} payload = {'email': email, 'password': password}
with r.Session() as s: with r.Session() as s:
@ -91,6 +97,9 @@ class API_Handler:
Returns: Returns:
json: json of user infos json: json of user infos
Raises:
None
""" """
if max_retries <= 0: if max_retries <= 0:
return None return None
@ -113,6 +122,9 @@ class API_Handler:
Returns: Returns:
list: list of users list: list of users
Raises:
None
""" """
if max_retries <= 0: if max_retries <= 0:
return None return None
@ -136,6 +148,9 @@ class API_Handler:
Returns: Returns:
list: list of keywords list: list of keywords
Raises:
None
""" """
if max_retries <= 0: if max_retries <= 0:
return None return None
@ -165,6 +180,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
with r.Session() as s: with r.Session() as s:
headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)} headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@ -182,6 +200,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
with r.Session() as s: with r.Session() as s:
headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)} headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@ -199,6 +220,9 @@ class API_Handler:
Returns: Returns:
list: list of shares list: list of shares
Raises:
None
""" """
if max_retries <= 0: if max_retries <= 0:
return None return None
@ -228,6 +252,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
with r.Session() as s: with r.Session() as s:
headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)} headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@ -244,6 +271,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
with r.Session() as s: with r.Session() as s:
headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)} headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@ -260,6 +290,9 @@ class API_Handler:
Returns: Returns:
dict: dictionary of transactions dict: dictionary of transactions
Raises:
None
""" """
if max_retries <= 0: if max_retries <= 0:
return None return None
@ -288,6 +321,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
with r.Session() as s: with r.Session() as s:
time = time[:-3] + "Z" # remove last character and add Z to make it a valid date for db time = time[:-3] + "Z" # remove last character and add Z to make it a valid date for db
@ -306,6 +342,9 @@ class API_Handler:
Returns: Returns:
dict: dictionary of portfolio dict: dictionary of portfolio
Raises:
None
""" """
if max_retries <= 0: if max_retries <= 0:
return None return None
@ -328,6 +367,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
if not croniter.is_valid(cron_interval): # check if cron_interval is in valid format if not croniter.is_valid(cron_interval): # check if cron_interval is in valid format
print("Error: Invalid cron format") print("Error: Invalid cron format")
@ -348,6 +390,9 @@ class API_Handler:
Returns: Returns:
int: status code int: status code
Raises:
None
""" """
with r.Session() as s: with r.Session() as s:
headers = {'Authorization': 'Bearer ' + self.token} # only bot token is needed, user is chosen by email headers = {'Authorization': 'Bearer ' + self.token} # only bot token is needed, user is chosen by email