jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 05:21:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

add docstrings

Browse Source
This commit is contained in:
Diogo Sousa
2023-01-26 18:14:12 +00:00
parent e4ebc1b380
commit d4c1f8546b
1 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
openbb_terminal/session/session_model.py
View File

@@ -10,7 +10,17 @@ from openbb_terminal.rich_config import console
def create_session(email: str, password: str, save: bool) -> dict:
"""Create a session."""
"""Create a session.
Parameters
----------
email : str
The email.
password : str
The password.
save : bool
Save the session.
"""
session = Hub.get_session(email, password)
if session and save:
@@ -19,7 +29,13 @@ def create_session(email: str, password: str, save: bool) -> dict:
def logout(cls: bool = False):
"""Logout and clear session."""
"""Logout and clear session.
Parameters
----------
cls : bool
Clear the screen.
"""
if cls:
system_clear()
User.clear()
@@ -38,4 +54,4 @@ def logout(cls: bool = False):
Hub.delete_session()
Local.remove_session_file()
plt.close("all")
console.print("[green]\nLogout successful[/green]")
console.print("[green]\nLogout successful.[/green]")