add extensive tests (cert session only); coverage >95 enforced (tasty…

…ware#99) * Adds extensive testing for most elements of SDK * pytest-cov used, enforcing >95% coverage * Most unimplemented tests are due to incompatibility with certification sessions * Link watchlist docs in sidebar * Update typing for some functions to make it clear they don't work with cert sessions
damonmo · Nov 15, 2023 · 51e97ba · 51e97ba
1 parent bd74562
commit 51e97ba
Show file tree

Hide file tree

Showing 19 changed files with 289 additions and 52 deletions.
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v2
@@ -31,7 +31,7 @@ jobs:
         mypy -p tastytrade
     - name: Testing...
       run: |
-        python -m pytest --cov=tastytrade --cov-report=term-missing tests/
+        python -m pytest --cov=tastytrade --cov-report=term-missing tests/ --cov-fail-under=95
       env:
         TT_USERNAME: ${{ secrets.TT_USERNAME }}
         TT_PASSWORD: ${{ secrets.TT_PASSWORD }}
diff --git a/Makefile b/Makefile
@@ -14,10 +14,7 @@ lint:
 	mypy -p tests
 
 test:
-	python -m pytest --cov=tastytrade --cov-report=term-missing tests/
-
-test:
-	python -m pytest --cov=tastytrade --cov-report=term-missing tests/
+	python -m pytest --cov=tastytrade --cov-report=term-missing tests/ --cov-fail-under=95
 
 install:
 	env/bin/pip install -e .

diff --git a/docs/index.rst b/docs/index.rst
@@ -7,6 +7,7 @@
    installation
    sessions
    data-streamer
+   watchlists
 
 .. toctree::
    :maxdepth: 2

diff --git a/requirements.txt b/requirements.txt
@@ -7,3 +7,4 @@ websockets==11.0.3
 pydantic==1.10.11
 pytest==7.4.0
 pytest_cov==4.1.0
+pytest-asyncio==0.21.1
diff --git a/tastytrade/account.py b/tastytrade/account.py
@@ -1,16 +1,22 @@
 from datetime import date, datetime
 from decimal import Decimal
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Union
 
 import requests
+from pydantic import BaseModel
 
 from tastytrade.order import (InstrumentType, NewOrder, OrderStatus,
                               PlacedOrder, PlacedOrderResponse, PriceEffect)
-from tastytrade.session import Session
+from tastytrade.session import ProductionSession, Session
 from tastytrade.utils import (TastytradeError, TastytradeJsonDataclass,
                               validate_response)
 
 
+class EmptyDict(BaseModel):
+    class Config:
+        extra = 'forbid'
+
+
 class AccountBalance(TastytradeJsonDataclass):
     """
     Dataclass containing account balance information.
@@ -168,21 +174,21 @@ class MarginReportEntry(TastytradeJsonDataclass):
     code: str
     underlying_symbol: str
     underlying_type: str
-    expected_price_range_up_percent: Decimal
-    expected_price_range_down_percent: Decimal
-    point_of_no_return_percent: Decimal
     margin_calculation_type: str
     margin_requirement: Decimal
     margin_requirement_effect: PriceEffect
-    initial_requirement: Decimal
-    initial_requirement_effect: PriceEffect
     maintenance_requirement: Decimal
     maintenance_requirement_effect: PriceEffect
     buying_power: Decimal
     buying_power_effect: PriceEffect
     groups: List[Dict[str, Any]]
     price_increase_percent: Decimal
     price_decrease_percent: Decimal
+    expected_price_range_up_percent: Optional[Decimal] = None
+    expected_price_range_down_percent: Optional[Decimal] = None
+    point_of_no_return_percent: Optional[Decimal] = None
+    initial_requirement: Optional[Decimal] = None
+    initial_requirement_effect: Optional[PriceEffect] = None
 
 
 class MarginReport(TastytradeJsonDataclass):
@@ -207,8 +213,8 @@ class MarginReport(TastytradeJsonDataclass):
     reg_t_option_buying_power_effect: PriceEffect
     maintenance_excess: Decimal
     maintenance_excess_effect: PriceEffect
-    groups: List[MarginReportEntry]
     last_state_timestamp: int
+    groups: List[Union[MarginReportEntry, EmptyDict]]
     initial_requirement: Optional[Decimal] = None
     initial_requirement_effect: Optional[PriceEffect] = None
 
@@ -706,15 +712,16 @@ def get_total_fees(
 
     def get_net_liquidating_value_history(
         self,
-        session: Session,
+        session: ProductionSession,
         time_back: Optional[str] = None,
         start_time: Optional[datetime] = None
-    ) -> List[NetLiqOhlc]:
+    ) -> List[NetLiqOhlc]:  # pragma: no cover
         """
         Returns a list of account net liquidating value snapshots over the
         specified time period.
 
-        :param session: the session to use for the request.
+        :param session:
+            the session to use for the request, can't be certification.
         :param time_back:
             the time period to get net liquidating value snapshots for. This
             param is required if start_time is not given. Possible values are:
@@ -766,13 +773,14 @@ def get_position_limit(self, session: Session) -> PositionLimit:
 
     def get_effective_margin_requirements(
         self,
-        session: Session,
+        session: ProductionSession,
         symbol: str
-    ) -> MarginRequirement:
+    ) -> MarginRequirement:  # pragma: no cover
         """
         Get the effective margin requirements for a given symbol.
 
-        :param session: the session to use for the request.
+        :param session:
+            the session to use for the request, can't be certification
         :param symbol: the symbol to get margin requirements for.
 
         :return: a :class:`MarginRequirement` object.

diff --git a/tastytrade/dxfeed/event.py b/tastytrade/dxfeed/event.py
@@ -25,7 +25,7 @@ class EventType(str, Enum):
 
 class Event(ABC):
     @classmethod
-    def from_stream(cls, data: list) -> List['Event']:
+    def from_stream(cls, data: list) -> List['Event']:  # pragma: no cover
         """
         Makes a list of event objects from a list of raw trade data fetched by
         a :class:`~tastyworks.streamer.DataStreamer`.

diff --git a/tastytrade/instruments.py b/tastytrade/instruments.py
@@ -6,7 +6,7 @@
 import requests
 
 from tastytrade.order import InstrumentType, TradeableTastytradeJsonDataclass
-from tastytrade.session import Session
+from tastytrade.session import ProductionSession, Session
 from tastytrade.utils import TastytradeJsonDataclass, validate_response
 
 
@@ -1060,9 +1060,9 @@ def get_option_chain(
 
 
 def get_future_option_chain(
-    session: Session,
+    session: ProductionSession,
     symbol: str
-) -> Dict[date, List[FutureOption]]:
+) -> Dict[date, List[FutureOption]]:  # pragma: no cover
     """
     Returns a mapping of expiration date to a list of futures options
     objects representing the options chain for the given symbol.

diff --git a/tastytrade/metrics.py b/tastytrade/metrics.py
@@ -4,7 +4,7 @@
 
 import requests
 
-from tastytrade.session import Session
+from tastytrade.session import ProductionSession, Session
 from tastytrade.utils import TastytradeJsonDataclass, validate_response
 
 
@@ -91,9 +91,9 @@ class MarketMetricInfo(TastytradeJsonDataclass):
 
 
 def get_market_metrics(
-    session: Session,
+    session: ProductionSession,
     symbols: List[str]
-) -> List[MarketMetricInfo]:
+) -> List[MarketMetricInfo]:  # pragma: no cover
     """
     Retrieves market metrics for the given symbols.
 
@@ -114,7 +114,10 @@ def get_market_metrics(
     return [MarketMetricInfo(**entry) for entry in data]
 
 
-def get_dividends(session: Session, symbol: str) -> List[DividendInfo]:
+def get_dividends(
+    session: ProductionSession,
+    symbol: str
+) -> List[DividendInfo]:  # pragma: no cover
     """
     Retrieves dividend information for the given symbol.
 
@@ -136,10 +139,10 @@ def get_dividends(session: Session, symbol: str) -> List[DividendInfo]:
 
 
 def get_earnings(
-    session: Session,
+    session: ProductionSession,
     symbol: str,
     start_date: date
-) -> List[EarningsInfo]:
+) -> List[EarningsInfo]:  # pragma: no cover
     """
     Retrieves earnings information for the given symbol.
 

diff --git a/tastytrade/search.py b/tastytrade/search.py
@@ -2,7 +2,7 @@
 
 import requests
 
-from tastytrade.session import Session
+from tastytrade.session import ProductionSession
 from tastytrade.utils import TastytradeJsonDataclass
 
 
@@ -14,7 +14,10 @@ class SymbolData(TastytradeJsonDataclass):
     description: str
 
 
-def symbol_search(session: Session, symbol: str) -> List[SymbolData]:
+def symbol_search(
+    session: ProductionSession,
+    symbol: str
+) -> List[SymbolData]:  # pragma: no cover
     """
     Performs a symbol search using the Tastytrade API and returns a
     list of symbols that are similar to the given search phrase.

diff --git a/tastytrade/session.py b/tastytrade/session.py
@@ -113,7 +113,7 @@ def __init__(
         self.validate()
 
 
-class ProductionSession(Session):
+class ProductionSession(Session):  # pragma: no cover
     """
     Contains a local user login which can then be used to interact with the
     remote API.
@@ -326,7 +326,7 @@ def get_time_and_sale(
 def _map_event(
     event_type: str,
     event_dict: Any  # Usually Dict[str, Any]; sometimes a list
-) -> Event:
+) -> Event:  # pragma: no cover
     """
     Parses the raw JSON data from the dxfeed REST API into event objects.
 

diff --git a/tastytrade/streamer.py b/tastytrade/streamer.py
@@ -248,7 +248,7 @@ async def _subscribe(
         await self._websocket.send(json.dumps(message))  # type: ignore
 
 
-class DataStreamer:
+class DataStreamer:  # pragma: no cover
     """
     A :class:`DataStreamer` object is used to fetch quotes or greeks
     for a given symbol or list of symbols. It should always be

diff --git a/tastytrade/utils.py b/tastytrade/utils.py
@@ -30,7 +30,7 @@ class Config:
         allow_population_by_field_name = True
 
 
-def validate_response(response: Response) -> None:
+def validate_response(response: Response) -> None:  # pragma: no cover
     """
     Checks if the given code is an error; if so, raises an exception.