Merge pull request #4198 from OpenBB-finance/feature/mypy10

Bumping to mypy 1.0

.github/workflows/linting.yml

@@ -45,7 +45,7 @@ jobs:
           restore-keys: ${{ runner.os }}-linting-${{ hashFiles('**/poetry.lock') }}
 
       - run: |
-          pip install bandit black codespell mypy==0.982 safety pylint==2.15.2 packaging==22 ruff==0.0.243
+          pip install bandit black codespell mypy==1.0.0 pylint==2.15.2 ruff==0.0.247
           pip install types-pytz types-requests types-termcolor types-tabulate types-PyYAML types-python-dateutil types-setuptools types-six
       - run: bandit -x ./tests -r . || true
       - run: black --diff --check .

.pre-commit-config.yaml

@@ -10,11 +10,11 @@ repos:
       - id: check-merge-conflict
       - id: detect-private-key
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.1.0
     hooks:
       - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.243'
+    rev: 'v0.0.247'
     hooks:
       - id: ruff
   - repo: https://github.com/codespell-project/codespell

openbb_terminal/account/account_controller.py

@@ -3,7 +3,7 @@
 import logging
 import os
 from pathlib import Path
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 from prompt_toolkit.completion import NestedCompleter
 
@@ -43,7 +43,7 @@ class AccountController(BaseController):
 
     PATH = "/account/"
 
-    def __init__(self, queue: List[str] = None):
+    def __init__(self, queue: Optional[List[str]] = None):
         super().__init__(queue)
         self.ROUTINE_FILES: Dict[str, Path] = {}
         self.REMOTE_CHOICES: List[str] = []

openbb_terminal/alternative/alt_controller.py

@@ -3,7 +3,7 @@
 
 import argparse
 import logging
-from typing import List
+from typing import List, Optional
 
 from openbb_terminal import feature_flags as obbff
 from openbb_terminal.alternative import hackernews_view
@@ -26,7 +26,7 @@ class AlternativeDataController(BaseController):
     PATH = "/alternative/"
     CHOICES_GENERATION = True
 
-    def __init__(self, queue: List[str] = None):
+    def __init__(self, queue: Optional[List[str]] = None):
         """Constructor"""
         super().__init__(queue)
 

openbb_terminal/alternative/covid/covid_controller.py

@@ -4,7 +4,7 @@
 import argparse
 import logging
 import pathlib
-from typing import List
+from typing import List, Optional
 
 import pandas as pd
 
@@ -33,7 +33,7 @@ class CovidController(BaseController):
     PATH = "/alternative/covid/"
     CHOICES_GENERATION = True
 
-    def __init__(self, queue: List[str] = None):
+    def __init__(self, queue: Optional[List[str]] = None):
         """Constructor"""
         super().__init__(queue)
 

openbb_terminal/alternative/covid/covid_view.py

@@ -132,7 +132,7 @@ def display_covid_ov(
     raw: bool = False,
     limit: int = 10,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     plot: bool = True,
 ) -> None:
     """Prints table showing historical cases and deaths by country.
@@ -184,7 +184,7 @@ def display_covid_stat(
     raw: bool = False,
     limit: int = 10,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     plot: bool = True,
 ) -> None:
     """Prints table showing historical cases and deaths by country.
@@ -241,7 +241,7 @@ def display_case_slopes(
     threshold: int = 10000,
     ascend: bool = False,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
 ) -> None:
     """Prints table showing countries with the highest case slopes.
 

openbb_terminal/alternative/hackernews_view.py

@@ -3,6 +3,7 @@
 
 import logging
 import os
+from typing import Optional
 
 from openbb_terminal.alternative.hackernews_model import get_stories
 from openbb_terminal.decorators import log_start_end
@@ -12,7 +13,9 @@
 
 
 @log_start_end(log=logger)
-def display_stories(limit: int = 10, export: str = "", sheet_name: str = None) -> None:
+def display_stories(
+    limit: int = 10, export: str = "", sheet_name: Optional[str] = None
+) -> None:
     """View top stories from HackerNews.
     Parameters
     ----------

openbb_terminal/alternative/oss/github_view.py

@@ -31,7 +31,7 @@
 def display_star_history(
     repo: str,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ) -> None:
     """Plots repo summary [Source: https://api.github.com].
@@ -79,7 +79,7 @@ def display_top_repos(
     categories: str = "",
     limit: int = 10,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ) -> None:
     """Plots repo summary [Source: https://api.github.com].
@@ -139,7 +139,9 @@ def display_top_repos(
 
 
 @log_start_end(log=logger)
-def display_repo_summary(repo: str, export: str = "", sheet_name: str = None) -> None:
+def display_repo_summary(
+    repo: str, export: str = "", sheet_name: Optional[str] = None
+) -> None:
     """Prints table showing repo summary [Source: https://api.github.com].
 
     Parameters

openbb_terminal/alternative/oss/oss_controller.py

@@ -3,7 +3,7 @@
 
 import argparse
 import logging
-from typing import List
+from typing import List, Optional
 
 from openbb_terminal import feature_flags as obbff
 from openbb_terminal.alternative.oss import github_view, runa_model, runa_view
@@ -29,7 +29,7 @@ class OSSController(BaseController):
     PATH = "/alternative/oss/"
     CHOICES_GENERATION = True
 
-    def __init__(self, queue: List[str] = None):
+    def __init__(self, queue: Optional[List[str]] = None):
         """Constructor"""
         super().__init__(queue)
 

openbb_terminal/alternative/oss/runa_view.py

@@ -35,7 +35,7 @@ def display_rossindex(
     show_growth: bool = True,
     chart_type: str = "stars",
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ) -> None:
     """Plots list of startups from ross index [Source: https://runacap.com/]

openbb_terminal/alternative/realestate/realestate_controller.py

@@ -4,7 +4,7 @@
 import argparse
 import logging
 from datetime import datetime, timedelta
-from typing import List
+from typing import List, Optional
 
 from openbb_terminal import feature_flags as obbff
 from openbb_terminal.alternative.realestate import landRegistry_view
@@ -40,7 +40,7 @@ class RealEstateController(BaseController):
     CHOICES_GENERATION = True
     # FILE_PATH = os.path.join(os.path.dirname(__file__), "README.md")
 
-    def __init__(self, queue: List[str] = None):
+    def __init__(self, queue: Optional[List[str]] = None):
         """Construct Data."""
         super().__init__(queue)
 

openbb_terminal/common/behavioural_analysis/finbrain_view.py

@@ -36,7 +36,7 @@ def display_sentiment_analysis(
     symbol: str,
     raw: bool = False,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots Sentiment analysis from FinBrain. Prints table if raw is True. [Source: FinBrain]

openbb_terminal/common/behavioural_analysis/finnhub_view.py

@@ -3,6 +3,7 @@
 
 import logging
 import os
+from typing import Optional
 
 import pandas as pd
 
@@ -16,7 +17,9 @@
 
 @log_start_end(log=logger)
 @check_api_key(["API_FINNHUB_KEY"])
-def display_sentiment_stats(ticker: str, export: str = "", sheet_name: str = None):
+def display_sentiment_stats(
+    ticker: str, export: str = "", sheet_name: Optional[str] = None
+):
     """
     Prints Sentiment stats which displays buzz, news score, articles last week, articles weekly average,
     bullish vs bearish percentages, sector average bullish percentage, and sector average news score

openbb_terminal/common/behavioural_analysis/google_view.py

@@ -27,7 +27,7 @@ def display_mentions(
     symbol: str,
     start_date: str = "",
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots weekly bars of stock's interest over time. other users watchlist. [Source: Google].
@@ -97,7 +97,7 @@ def display_correlation_interest(
     data: pd.DataFrame,
     words: List[str],
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots interest over time of words/sentences versus stock price. [Source: Google].
@@ -173,7 +173,7 @@ def display_regions(
     symbol: str,
     limit: int = 5,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots bars of regions based on stock's interest. [Source: Google].
@@ -229,7 +229,7 @@ def display_regions(
 
 @log_start_end(log=logger)
 def display_queries(
-    symbol: str, limit: int = 5, export: str = "", sheet_name: str = None
+    symbol: str, limit: int = 5, export: str = "", sheet_name: Optional[str] = None
 ):
     """Prints table showing top related queries with this stock's query. [Source: Google].
 
@@ -268,7 +268,7 @@ def display_queries(
 
 @log_start_end(log=logger)
 def display_rise(
-    symbol: str, limit: int = 10, export: str = "", sheet_name: str = None
+    symbol: str, limit: int = 10, export: str = "", sheet_name: Optional[str] = None
 ):
     """Prints top rising related queries with this stock's query. [Source: Google].
 

openbb_terminal/common/behavioural_analysis/reddit_view.py

@@ -196,7 +196,7 @@ def display_popular_tickers(
     post_limit: int = 50,
     subreddits: str = "",
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
 ):
     """Prints table showing latest popular tickers. [Source: Reddit].
 
@@ -412,7 +412,7 @@ def display_redditsent(
     subreddits: str = "all",
     display: bool = False,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots Reddit sentiment about a search term. Prints table showing if display is True.

openbb_terminal/common/behavioural_analysis/twitter_view.py

@@ -27,7 +27,7 @@
 
 @log_start_end(log=logger)
 def display_inference(
-    symbol: str, limit: int = 100, export: str = "", sheet_name: str = None
+    symbol: str, limit: int = 100, export: str = "", sheet_name: Optional[str] = None
 ):
     """Prints Inference sentiment from past n tweets.
 
@@ -92,7 +92,7 @@ def display_sentiment(
     n_days_past: int = 2,
     compare: bool = False,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots sentiments from symbol

openbb_terminal/common/feedparser_view.py

@@ -3,6 +3,7 @@
 
 import logging
 import os
+from typing import Optional
 
 from openbb_terminal.common import feedparser_model
 from openbb_terminal.decorators import log_start_end
@@ -18,7 +19,7 @@ def display_news(
     sources: str = "",
     limit: int = 5,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     sort: str = "published",
 ):
     """Plots news for a given term and source. [Source: Feedparser]

openbb_terminal/common/newsapi_view.py

@@ -23,7 +23,7 @@ def display_news(
     show_newest: bool = True,
     sources: str = "",
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
 ) -> None:
     """Prints table showing news for a given term. [Source: NewsAPI]
 

openbb_terminal/common/quantitative_analysis/qa_view.py

@@ -51,7 +51,7 @@ def lambda_color_red(val: Any) -> str:
 
 @log_start_end(log=logger)
 def display_summary(
-    data: pd.DataFrame, export: str = "", sheet_name: str = None
+    data: pd.DataFrame, export: str = "", sheet_name: Optional[str] = None
 ) -> None:
     """Prints table showing summary statistics
 
@@ -164,7 +164,7 @@ def display_cdf(
     target: str,
     symbol: str = "",
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ):
     """Plots Cumulative Distribution Function
@@ -665,7 +665,7 @@ def display_seasonal(
     target: str,
     multiplicative: bool = False,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ) -> None:
     """Plots seasonal decomposition data
@@ -810,7 +810,7 @@ def display_seasonal(
 
 @log_start_end(log=logger)
 def display_normality(
-    data: pd.DataFrame, target: str, export: str = "", sheet_name: str = None
+    data: pd.DataFrame, target: str, export: str = "", sheet_name: Optional[str] = None
 ) -> None:
     """Prints table showing normality statistics
 
@@ -852,7 +852,7 @@ def display_unitroot(
     fuller_reg: str = "c",
     kpss_reg: str = "c",
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
 ):
     """Prints table showing unit root test calculations
 
@@ -895,7 +895,7 @@ def display_raw(
     ascend: bool = False,
     limit: int = 20,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
 ) -> None:
     """Prints table showing raw stock data
 
@@ -956,7 +956,7 @@ def display_line(
     markers_lines: Optional[List[datetime]] = None,
     markers_scatter: Optional[List[datetime]] = None,
     export: str = "",
-    sheet_name: str = None,
+    sheet_name: Optional[str] = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ) -> None:
     """Display line plot of data