enforce isort, strict typing (+mypy) (#251)

* enforce isort, strict typing (+mypy)

* all lints passing

* fix unused import

Author: Graeme22

.github/workflows/python-app.yml

@@ -25,6 +25,9 @@ jobs:
     - name: Type check with pyright
       run: |
         uv run pyright tastytrade/ tests/
+    - name: Type check with mypy
+      run: |
+        uv run mypy tastytrade/
     - name: Test with pytest
       run: |
         uv run pytest --cov=tastytrade --cov-report=term-missing tests/ --cov-fail-under=95

Makefile

@@ -2,12 +2,13 @@
 
 install:
 	uv sync
-	uv pip install -e .
 
 lint:
+	uv run ruff check --select I --fix
 	uv run ruff format tastytrade/ tests/
 	uv run ruff check tastytrade/ tests/
 	uv run pyright tastytrade/ tests/
+	uv run mypy tastytrade/
 
 test:
 	uv run pytest --cov=tastytrade --cov-report=term-missing tests/ --cov-fail-under=95

pyproject.toml

@@ -59,16 +59,31 @@ dev = [
     "pytest-aio>=1.5.0",
     "pytest-cov>=5.0.0",
     "ruff>=0.6.9",
-    "pyright>=1.1.390",
+    "pyright>=1.1.401",
     "sphinx>=7.4.7",
     "enum-tools[sphinx]>=0.12.0",
     "autodoc-pydantic>=2.2.0",
     "proxy-py>=2.4.9",
     "sphinx-immaterial>=0.12.5",
+    "mypy>=1.15.0",
 ]
 
 [tool.setuptools.package-data]
 "tastytrade" = ["py.typed"]
 
 [tool.setuptools.packages.find]
 where = ["tastytrade"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.pyright]
+pythonVersion = "3.9"
+include = ["tastytrade", "tests"]
+exclude = ["**/__pycache__"]
+typeCheckingMode = "strict"
+reportPrivateUsage = false
+
+[tool.mypy]
+strict = true
+warn_unused_ignores = false

tastytrade/__init__.py

@@ -4,10 +4,10 @@
 BACKTEST_URL = "https://backtester.vast.tastyworks.com"
 CERT_URL = "https://api.cert.tastyworks.com"
 VAST_URL = "https://vast.tastyworks.com"
-VERSION = "10.2.1"
+VERSION = "10.2.2"
 
 __version__ = VERSION
-version_str = f"tastyware/tastytrade:v{VERSION}"
+version_str: str = f"tastyware/tastytrade:v{VERSION}"
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)

tastytrade/account.py

@@ -1,6 +1,6 @@
 from datetime import date, datetime
 from decimal import Decimal
-from typing import Any, Literal, Optional, Union, overload
+from typing import Any, Literal, Optional, Union, cast, overload
 
 import httpx
 from pydantic import BaseModel, model_validator
@@ -22,8 +22,8 @@
 from tastytrade.session import Session
 from tastytrade.utils import (
     PriceEffect,
-    TastytradeError,
     TastytradeData,
+    TastytradeError,
     set_sign_for,
     today_in_new_york,
     validate_response,
@@ -94,9 +94,10 @@ class AccountBalance(TastytradeData):
     @classmethod
     def validate_price_effects(cls, data: Any) -> Any:
         if isinstance(data, dict):
+            data = cast(dict[str, Any], data)
             key = "unsettled-cryptocurrency-fiat-amount"
-            effect = data.get("unsettled-cryptocurrency-fiat-effect")
-            if effect == PriceEffect.DEBIT:
+            effect: Any = data.get("unsettled-cryptocurrency-fiat-effect")
+            if effect == PriceEffect.DEBIT.value:
                 data[key] = -abs(Decimal(data[key]))
         return set_sign_for(data, ["pending_cash", "buying_power_adjustment"])
 
@@ -149,8 +150,9 @@ class AccountBalanceSnapshot(TastytradeData):
     @classmethod
     def validate_price_effects(cls, data: Any) -> Any:
         if isinstance(data, dict):
+            data = cast(dict[str, Any], data)
             key = "unsettled-cryptocurrency-fiat-amount"
-            effect = data.get("unsettled-cryptocurrency-fiat-effect")
+            effect: Any = data.get("unsettled-cryptocurrency-fiat-effect")
             if effect == PriceEffect.DEBIT:
                 data[key] = -abs(Decimal(data[key]))
         return set_sign_for(data, ["pending_cash"])
@@ -614,7 +616,8 @@ async def a_get_balance_snapshots(
         :param end_date: the ending date of the range.
         :param snapshot_date: the date of the snapshot to get.
         :param time_of_day:
-            the time of day of the snapshots to get, either 'EOD' (End Of Day) or 'BOD' (Beginning Of Day).
+            the time of day of the snapshots to get, either 'EOD' (End Of Day) or 'BOD'
+            (Beginning Of Day).
         """
         paginate = False
         if page_offset is None:
@@ -629,7 +632,7 @@ async def a_get_balance_snapshots(
             "snapshot-date": snapshot_date,
             "time-of-day": time_of_day,
         }
-        snapshots = []
+        snapshots: list[AccountBalanceSnapshot] = []
         while True:
             response = await session.async_client.get(
                 f"/accounts/{self.account_number}/balance-snapshots",
@@ -677,7 +680,8 @@ def get_balance_snapshots(
         :param end_date: the ending date of the range.
         :param snapshot_date: the date of the snapshot to get.
         :param time_of_day:
-            the time of day of the snapshots to get, either 'EOD' (End Of Day) or 'BOD' (Beginning Of Day).
+            the time of day of the snapshots to get, either 'EOD' (End Of Day) or 'BOD'
+            (Beginning Of Day).
         """
         paginate = False
         if page_offset is None:
@@ -692,7 +696,7 @@ def get_balance_snapshots(
             "snapshot-date": snapshot_date,
             "time-of-day": time_of_day,
         }
-        snapshots = []
+        snapshots: list[AccountBalanceSnapshot] = []
         while True:
             response = session.sync_client.get(
                 f"/accounts/{self.account_number}/balance-snapshots",
@@ -878,7 +882,7 @@ async def a_get_history(
             "end-at": end_at,
         }
         # loop through pages and get all transactions
-        txns = []
+        txns: list[Transaction] = []
         while True:
             response = await session.async_client.get(
                 f"/accounts/{self.account_number}/transactions",
@@ -973,7 +977,7 @@ def get_history(
             "end-at": end_at,
         }
         # loop through pages and get all transactions
-        txns = []
+        txns: list[Transaction] = []
         while True:
             response = session.sync_client.get(
                 f"/accounts/{self.account_number}/transactions",
@@ -1376,7 +1380,7 @@ async def a_get_order_history(
             "end-at": end_at,
         }
         # loop through pages and get all transactions
-        orders = []
+        orders: list[PlacedOrder] = []
         while True:
             response = await session.async_client.get(
                 f"/accounts/{self.account_number}/orders",
@@ -1457,7 +1461,7 @@ def get_order_history(
             "end-at": end_at,
         }
         # loop through pages and get all transactions
-        orders = []
+        orders: list[PlacedOrder] = []
         while True:
             response = session.sync_client.get(
                 f"/accounts/{self.account_number}/orders",
@@ -1500,11 +1504,11 @@ async def a_get_complex_order_history(
             paginate = True
         params = {"per-page": per_page, "page-offset": page_offset}
         # loop through pages and get all transactions
-        orders = []
+        orders: list[PlacedComplexOrder] = []
         while True:
             response = await session.async_client.get(
                 f"/accounts/{self.account_number}/complex-orders",
-                params={k: v for k, v in params.items() if v is not None},
+                params=params,
             )
             validate_response(response)
             json = response.json()
@@ -1539,11 +1543,11 @@ def get_complex_order_history(
             paginate = True
         params = {"per-page": per_page, "page-offset": page_offset}
         # loop through pages and get all transactions
-        orders = []
+        orders: list[PlacedComplexOrder] = []
         while True:
             response = session.sync_client.get(
                 f"/accounts/{self.account_number}/complex-orders",
-                params={k: v for k, v in params.items() if v is not None},
+                params=params,
             )
             validate_response(response)
             json = response.json()
@@ -1698,7 +1702,7 @@ async def a_get_order_chains(
             response = await client.get(
                 f"{VAST_URL}/order-chains",
                 headers=headers,
-                params=params,
+                params=params,  # type: ignore[arg-type]
             )
             validate_response(response)
             chains = response.json()["data"]["items"]
@@ -1736,7 +1740,7 @@ def get_order_chains(
         response = httpx.get(
             f"{VAST_URL}/order-chains",
             headers=headers,
-            params=params,
+            params=params,  # type: ignore[arg-type]
         )
         validate_response(response)
         chains = response.json()["data"]["items"]

tastytrade/dxfeed/candle.py

@@ -1,5 +1,5 @@
 from decimal import Decimal
-from typing import Annotated, Any, Optional
+from typing import Annotated, Any, Optional, cast
 
 from pydantic import (
     ValidationError,
@@ -17,7 +17,7 @@ def zero_from_none(
     v: Any, handler: ValidatorFunctionWrapHandler, info: ValidationInfo
 ) -> Decimal:
     try:
-        return handler(v)
+        return cast(Decimal, handler(v))
     except ValidationError:
         return ZERO
 

tastytrade/dxfeed/event.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
@@ -33,7 +35,7 @@ def change_nan_to_none(cls, v: Any) -> Any:
         return v
 
     @classmethod
-    def from_stream(cls, data: list) -> list["Event"]:
+    def from_stream(cls, data: list[Any]) -> list[Event]:
         """
         Makes a list of event objects from a list of raw trade data fetched by
         a :class:`~tastyworks.streamer.DXFeedStreamer`.
@@ -42,7 +44,7 @@ def from_stream(cls, data: list) -> list["Event"]:
 
         :return: list of event objects from data
         """
-        objs = []
+        objs: list[Event] = []
         size = len(cls.model_fields)
         multiples = len(data) / size
         if not multiples.is_integer():

tastytrade/instruments.py

@@ -162,7 +162,7 @@ class NestedFutureOptionFuture(TastytradeData):
 
     @field_validator("maturity_date", mode="before")
     @classmethod
-    def parse_date_with_utc(cls, value: Any) -> str:
+    def parse_date_with_utc(cls, value: Any) -> Any:
         if isinstance(value, str):
             return value.split(" ")[0]
         return value
@@ -327,7 +327,7 @@ async def a_get_active_equities(
             "lendability": lendability,
         }
         # loop through pages and get all active equities
-        equities = []
+        equities: list[Self] = []
         while True:
             response = await session.async_client.get(
                 "/instruments/equities/active",
@@ -378,7 +378,7 @@ def get_active_equities(
             "lendability": lendability,
         }
         # loop through pages and get all active equities
-        equities = []
+        equities: list[Self] = []
         while True:
             response = session.sync_client.get(
                 "/instruments/equities/active",
@@ -581,10 +581,10 @@ async def a_get(
                 f"/instruments/equity-options/{symbol}", params=params
             )
             return cls(**data)
-        params = {"symbol[]": symbols, "active": active, "with-expired": with_expired}
+        _params = {"symbol[]": symbols, "active": active, "with-expired": with_expired}
         data = await session._a_get(
             "/instruments/equity-options",
-            params={k: v for k, v in params.items() if v is not None},
+            params={k: v for k, v in _params.items() if v is not None},
         )
         return [cls(**i) for i in data["items"]]
 
@@ -628,10 +628,10 @@ def get(
             params = {"active": active} if active is not None else None
             data = session._get(f"/instruments/equity-options/{symbol}", params=params)
             return cls(**data)
-        params = {"symbol[]": symbols, "active": active, "with-expired": with_expired}
+        _params = {"symbol[]": symbols, "active": active, "with-expired": with_expired}
         data = session._get(
             "/instruments/equity-options",
-            params={k: v for k, v in params.items() if v is not None},
+            params={k: v for k, v in _params.items() if v is not None},
         )
         return [cls(**i) for i in data["items"]]
 
@@ -649,7 +649,7 @@ def _set_streamer_symbol(self) -> None:
         )
 
     @classmethod
-    def streamer_symbol_to_occ(cls, streamer_symbol) -> str:
+    def streamer_symbol_to_occ(cls, streamer_symbol: str) -> str:
         """
         Returns the OCC 2010 symbol equivalent to the given streamer symbol.
 
@@ -670,7 +670,7 @@ def streamer_symbol_to_occ(cls, streamer_symbol) -> str:
         return f"{symbol}{exp}{option_type}{strike}{decimal}"
 
     @classmethod
-    def occ_to_streamer_symbol(cls, occ) -> str:
+    def occ_to_streamer_symbol(cls, occ: str) -> str:
         """
         Returns the dxfeed symbol for use in the streamer from the given OCC
         2010 symbol.
@@ -1100,7 +1100,7 @@ class FutureOption(TradeableTastytradeData):
 
     @field_validator("maturity_date", mode="before")
     @classmethod
-    def parse_date_with_utc(cls, value: Any) -> str:
+    def parse_date_with_utc(cls, value: Any) -> Any:
         if isinstance(value, str):
             return value.split(" ")[0]
         return value
@@ -1386,7 +1386,7 @@ async def a_get_option_chain(session: Session, symbol: str) -> dict[date, list[O
     """
     symbol = symbol.replace("/", "%2F")
     data = await session._a_get(f"/option-chains/{symbol}")
-    chain = defaultdict(list)
+    chain: dict[date, list[Option]] = defaultdict(list)
     for i in data["items"]:
         option = Option(**i)
         chain[option.expiration_date].append(option)
@@ -1409,7 +1409,7 @@ def get_option_chain(session: Session, symbol: str) -> dict[date, list[Option]]:
     """
     symbol = symbol.replace("/", "%2F")
     data = session._get(f"/option-chains/{symbol}")
-    chain = defaultdict(list)
+    chain: dict[date, list[Option]] = defaultdict(list)
     for i in data["items"]:
         option = Option(**i)
         chain[option.expiration_date].append(option)
@@ -1434,7 +1434,7 @@ async def a_get_future_option_chain(
     """
     symbol = symbol.replace("/", "")
     data = await session._a_get(f"/futures-option-chains/{symbol}")
-    chain = defaultdict(list)
+    chain: dict[date, list[FutureOption]] = defaultdict(list)
     for i in data["items"]:
         option = FutureOption(**i)
         chain[option.expiration_date].append(option)
@@ -1459,7 +1459,7 @@ def get_future_option_chain(
     """
     symbol = symbol.replace("/", "")
     data = session._get(f"/futures-option-chains/{symbol}")
-    chain = defaultdict(list)
+    chain: dict[date, list[FutureOption]] = defaultdict(list)
     for i in data["items"]:
         option = FutureOption(**i)
         chain[option.expiration_date].append(option)

tastytrade/market_sessions.py

@@ -45,7 +45,7 @@ class MarketSessionSnapshot(TastytradeData):
 
 class MarketSession(TastytradeData):
     """
-    Dataclass representing the current session as well as the next and previous sessions.
+    Dataclass representing the current, next, and previous sessions.
     """
 
     close_at: Optional[datetime] = None