Audited models for missing fields, removed unneeded arrays and enum imports, add Exceptions docs (#176)

Author: Darcy-Linde

docs/source/Exceptions.rst

@@ -0,0 +1,18 @@
+.. _exceptions_header:
+
+Exceptions
+==============================================================
+
+==============================================================
+AuthError
+==============================================================
+.. autoclass:: polygon.websocket.__init__.AuthError
+    :members:
+    :undoc-members:  
+
+==============================================================
+NoResultsError
+==============================================================
+.. autoclass:: polygon.rest.base.NoResultsError
+    :members:
+    :undoc-members:  

docs/source/Models.rst

@@ -51,12 +51,12 @@ Last Quote
 ==============================================================
 Snapshot Min
 ==============================================================
-.. autoclass:: polygon.rest.models.SnapshotMin
+.. autoclass:: polygon.rest.models.MinuteSnapshot
 
 ==============================================================
 Snapshot
 ==============================================================
-.. autoclass:: polygon.rest.models.Snapshot
+.. autoclass:: polygon.rest.models.TickerSnapshot
 
 ==============================================================
 Day Option Contract Snapshot
@@ -68,15 +68,10 @@ Option Details
 ==============================================================
 .. autoclass:: polygon.rest.models.OptionDetails
 
-==============================================================
-Option Last Quote
-==============================================================
-.. autoclass:: polygon.rest.models.OptionLastQuote
-
 ==============================================================
 Option Greeks
 ==============================================================
-.. autoclass:: polygon.rest.models.OptionGreeks
+.. autoclass:: polygon.rest.models.Greeks
 
 ==============================================================
 Underlying Asset
@@ -106,7 +101,7 @@ Ticker
 ==============================================================
 Address
 ==============================================================
-.. autoclass:: polygon.rest.models.Address
+.. autoclass:: polygon.rest.models.CompanyAddress
 
 ==============================================================
 Branding

docs/source/index.rst

@@ -18,6 +18,7 @@ This documentation is for the Python client only. For details about the response
   Models
   Enums
   WebSocket-Enums
+  Exceptions
 
 Indices and tables
 ==================

polygon/__init__.py

@@ -1,3 +1,3 @@
 from .rest import RESTClient
-from .rest.base import NoResults
+from .rest.base import NoResultsError
 from .websocket import WebSocketClient, AuthError

polygon/rest/base.py

@@ -14,7 +14,7 @@
     pass
 
 
-class NoResults(Exception):
+class NoResultsError(Exception):
     pass
 
 
@@ -84,7 +84,7 @@ def _get(
 
         if result_key:
             if result_key not in obj:
-                raise NoResults(
+                raise NoResultsError(
                     f'Expected key "{result_key}" in response {obj}.'
                     + "Make sure you have sufficient permissions and your request parameters are valid."
                     + f"This is the url that returned no results: {resp.geturl()}"

polygon/rest/models/conditions.py

@@ -1,5 +1,4 @@
-from typing import Optional
-from .common import AssetClass, DataType
+from typing import Optional, List
 from dataclasses import dataclass
 
 
@@ -50,19 +49,19 @@ def from_dict(d):
         return UpdateRules(
             consolidated=None
             if "consolidated" not in d
-            else [Consolidated.from_dict(d["consolidated"])],
+            else Consolidated.from_dict(d["consolidated"]),
             market_center=None
             if "market_center" not in d
-            else [MarketCenter.from_dict(d["market_center"])],
+            else MarketCenter.from_dict(d["market_center"]),
         )
 
 
 @dataclass
 class Condition:
     "Condition contains data for a condition that Polygon.io uses."
     abbreviation: Optional[str] = None
-    asset_class: Optional[AssetClass] = None
-    data_types: Optional[DataType] = None
+    asset_class: Optional[str] = None
+    data_types: Optional[List[str]] = None
     description: Optional[str] = None
     exchange: Optional[int] = None
     id: Optional[int] = None
@@ -85,9 +84,9 @@ def from_dict(d):
             name=d.get("name", None),
             sip_mapping=None
             if "sip_mapping" not in d
-            else [SipMapping.from_dict(d["sip_mapping"])],
+            else SipMapping.from_dict(d["sip_mapping"]),
             type=d.get("type", None),
             update_rules=None
             if "update_rules" not in d
-            else [UpdateRules.from_dict(d["update_rules"])],
+            else UpdateRules.from_dict(d["update_rules"]),
         )

polygon/rest/models/dividends.py

@@ -1,5 +1,4 @@
 from typing import Optional
-from .common import DividendType, Frequency
 from dataclasses import dataclass
 
 
@@ -8,9 +7,9 @@ class Dividend:
     "Dividend contains data for a historical cash dividend, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount."
     cash_amount: Optional[float] = None
     declaration_date: Optional[str] = None
-    dividend_type: Optional[DividendType] = None
+    dividend_type: Optional[str] = None
     ex_dividend_date: Optional[str] = None
-    frequency: Optional[Frequency] = None
+    frequency: Optional[int] = None
     pay_date: Optional[str] = None
     record_date: Optional[str] = None
     ticker: Optional[str] = None

polygon/rest/models/exchanges.py

@@ -1,20 +1,19 @@
 from typing import Optional
-from .common import AssetClass, Locale, ExchangeType
 from dataclasses import dataclass
 
 
 @dataclass
 class Exchange:
     "Exchange contains data for a condition that Polygon.io uses."
     acronym: Optional[str] = None
-    asset_class: Optional[AssetClass] = None
+    asset_class: Optional[str] = None
     id: Optional[int] = None
-    locale: Optional[Locale] = None
+    locale: Optional[str] = None
     mic: Optional[str] = None
     name: Optional[str] = None
     operating_mic: Optional[str] = None
     participant_id: Optional[str] = None
-    type: Optional[ExchangeType] = None
+    type: Optional[str] = None
     url: Optional[str] = None
 
     @staticmethod

polygon/rest/models/markets.py

@@ -56,11 +56,11 @@ def from_dict(d):
             after_hours=d.get("after_hours", None),
             currencies=None
             if "currencies" not in d
-            else [MarketCurrencies.from_dict(d["currencies"])],
+            else MarketCurrencies.from_dict(d["currencies"]),
             early_hours=d.get("early_hours", None),
             exchanges=None
             if "exchanges" not in d
-            else [MarketExchanges.from_dict(d["exchanges"])],
+            else MarketExchanges.from_dict(d["exchanges"]),
             market=d.get("market", None),
             server_time=d.get("server_time", None),
         )

polygon/rest/models/quotes.py

@@ -63,7 +63,7 @@ def from_dict(d):
 
 
 @dataclass
-class Last:
+class ForexQuote:
     "Contains data for a forex quote."
     ask: Optional[float] = None
     bid: Optional[float] = None
@@ -72,19 +72,19 @@ class Last:
 
     @staticmethod
     def from_dict(d):
-        return Last(**d)
+        return ForexQuote(**d)
 
 
 @dataclass
 class LastForexQuote:
     "ForexLastQuote contains data for the last quote tick for a forex currency pair."
-    last: Optional[Last] = None
+    last: Optional[ForexQuote] = None
     symbol: Optional[str] = None
 
     @staticmethod
     def from_dict(d):
         return LastForexQuote(
-            last=None if "last" not in d else Last.from_dict(d["last"]),
+            last=None if "last" not in d else ForexQuote.from_dict(d["last"]),
             symbol=d.get("symbol", None),
         )
 
@@ -95,7 +95,7 @@ class RealTimeCurrencyConversion:
     converted: Optional[float] = None
     from_: Optional[str] = None
     initial_amount: Optional[float] = None
-    last: Optional[Last] = None
+    last: Optional[ForexQuote] = None
     to: Optional[str] = None
 
     @staticmethod
@@ -104,6 +104,6 @@ def from_dict(d):
             converted=d.get("converted", None),
             from_=d.get("from_", None),
             initial_amount=d.get("initialAmount", None),
-            last=None if "last" not in d else Last.from_dict(d["last"]),
+            last=None if "last" not in d else ForexQuote.from_dict(d["last"]),
             to=d.get("to", None),
         )