openbb-sec 1.2.2__tar.gz → 1.2.3__tar.gz

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openbb-sec
-Version: 1.2.2
+Version: 1.2.3
 Summary: SEC extension for OpenBB
 License: AGPL-3.0-only
 Author: OpenBB Team
@@ -16,7 +16,7 @@ Requires-Dist: aiohttp-client-cache (>=0.11.0,<0.12.0)
 Requires-Dist: aiosqlite (>=0.20.0,<0.21.0)
 Requires-Dist: bs4 (>=0.0.2,<0.0.3)
 Requires-Dist: lxml (>=5.2.1,<6.0.0)
-Requires-Dist: openbb-core (>=1.2.4,<2.0.0)
+Requires-Dist: openbb-core (>=1.2.5,<2.0.0)
 Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
 Description-Content-Type: text/markdown
 

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/models/company_filings.py

@@ -10,6 +10,7 @@ from typing import Any, Dict, List, Optional, Union
 
 from aiohttp_client_cache import SQLiteBackend
 from aiohttp_client_cache.session import CachedSession
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.app.utils import get_user_cache_directory
 from openbb_core.provider.abstract.fetcher import Fetcher
 from openbb_core.provider.standard_models.company_filings import (
@@ -158,9 +159,9 @@ class SecCompanyFilingsFetcher(
                 query.symbol.lower(), use_cache=query.use_cache
             )
             if not query.cik:
-                raise ValueError(f"CIK not found for symbol {query.symbol}")
+                raise OpenBBError(f"CIK not found for symbol {query.symbol}")
         if query.cik is None:
-            raise ValueError("Error: CIK or symbol must be provided.")
+            raise OpenBBError("CIK or symbol must be provided.")
 
         # The leading 0s need to be inserted but are typically removed from the data to store as an integer.
         if len(query.cik) != 10:  # type: ignore

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/models/etf_holdings.py

@@ -11,6 +11,7 @@ import pandas as pd
 import xmltodict
 from aiohttp_client_cache import SQLiteBackend
 from aiohttp_client_cache.session import CachedSession
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.app.utils import get_user_cache_directory
 from openbb_core.provider.abstract.annotated_result import AnnotatedResult
 from openbb_core.provider.abstract.fetcher import Fetcher
@@ -348,7 +349,7 @@ class SecEtfHoldingsFetcher(
                 raise e
         filing_candidates = pd.DataFrame.from_records(filings)
         if filing_candidates.empty:
-            raise ValueError(f"No N-Port records found for {query.symbol}.")
+            raise OpenBBError(f"No N-Port records found for {query.symbol}.")
         dates = filing_candidates.period_ending.to_list()
         new_date: str = ""
         if query.date is not None:
@@ -397,7 +398,6 @@ class SecEtfHoldingsFetcher(
         **kwargs: Any,
     ) -> AnnotatedResult[List[SecEtfHoldingsData]]:
         """Transform the data."""
-
         if not data:
             raise EmptyDataError(f"No data was returned for the symbol, {query.symbol}")
         results = []

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/models/schema_files.py

@@ -2,6 +2,7 @@
 
 from typing import Any, Dict, List, Optional
 
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.provider.abstract.data import Data
 from openbb_core.provider.abstract.fetcher import Fetcher
 from openbb_core.provider.standard_models.cot_search import CotSearchQueryParams
@@ -43,7 +44,7 @@ class SecSchemaFilesFetcher(Fetcher[SecSchemaFilesQueryParams, SecSchemaFilesDat
     ) -> Dict:
         """Return the raw data from the SEC endpoint."""
         if query.url and ".xsd" in query.url or query.url and ".xml" in query.url:
-            raise ValueError("Invalid URL. This endpoint does not parse the files.")
+            raise OpenBBError("Invalid URL. This endpoint does not parse the files.")
         results = get_schema_filelist(query.query, query.url)
 
         return {"files": results}

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/models/symbol_map.py

@@ -4,6 +4,7 @@
 
 from typing import Any, Dict, Optional
 
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.provider.abstract.data import Data
 from openbb_core.provider.abstract.fetcher import Fetcher
 from openbb_core.provider.standard_models.symbol_map import SymbolMapQueryParams
@@ -46,7 +47,7 @@ class SecSymbolMapFetcher(
     ) -> Dict:
         """Return the raw data from the SEC endpoint."""
         if not query.query.isdigit():
-            raise ValueError("Query is required and must be a valid CIK.")
+            raise OpenBBError("Query is required and must be a valid CIK.")
         symbol = await cik_map(int(query.query), query.use_cache)
         response = {"symbol": symbol}
         return response

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/utils/frames.py

@@ -9,6 +9,7 @@ from warnings import warn
 
 from aiohttp_client_cache import SQLiteBackend
 from aiohttp_client_cache.session import CachedSession
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.app.utils import get_user_cache_directory
 from openbb_core.provider.utils.errors import EmptyDataError
 from openbb_core.provider.utils.helpers import amake_request
@@ -180,7 +181,7 @@ FACTS = [
     "LongTermDebt",
     "LongTermDebtCurrent",
     "LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive",
-    "LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths",
+    "LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths",  # pragma: allowlist secret
     "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive",
     "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour",
     "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree",
@@ -736,7 +737,7 @@ async def get_frame(  # pylint: disable =too-many-arguments,too-many-locals, too
             try:
                 response = await fetch_data(url, use_cache, persist)
             except Exception:
-                raise ValueError(message) from e
+                raise OpenBBError(message) from e
         elif "Q" in url and not url.endswith("I.json"):
             warn(
                 "No frame was found for the requested quarter, trying instantaneous data."
@@ -745,9 +746,9 @@ async def get_frame(  # pylint: disable =too-many-arguments,too-many-locals, too
             try:
                 response = await fetch_data(url, use_cache, persist)
             except Exception:
-                raise ValueError(message) from e
+                raise OpenBBError(message) from e
         else:
-            raise ValueError(message) from e
+            raise OpenBBError(message) from e
 
     data = sorted(response.get("data", {}), key=lambda x: x["val"], reverse=True)  # type: ignore
     metadata = {
@@ -779,9 +780,9 @@ async def get_concept(
     taxonomy: Optional[TAXONOMIES] = "us-gaap",
     use_cache: bool = True,
 ) -> Dict:
-    """Return all the XBRL disclosures from a single company (CIK)
-    and concept (a taxonomy and tag) into a single JSON file, with a separate array of facts
-    for each units on measure that the company has chosen to disclose
+    """Return all the XBRL disclosures from a single company (CIK) Concept (a taxonomy and tag) into a single JSON file.
+
+    Each entry contains a separate array of facts for each units of measure that the company has chosen to disclose
     (e.g. net profits reported in U.S. dollars and in Canadian dollars).
 
     Parameters

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/utils/helpers.py

@@ -9,6 +9,7 @@ from zipfile import ZipFile
 import pandas as pd
 from aiohttp_client_cache import SQLiteBackend
 from aiohttp_client_cache.session import CachedSession
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.app.utils import get_user_cache_directory
 from openbb_core.provider.utils.helpers import amake_request, make_request
 from openbb_sec.utils.definitions import HEADERS, SEC_HEADERS
@@ -280,7 +281,7 @@ async def get_series_id(
 
     results = pd.DataFrame()
     if not symbol and not cik:
-        raise ValueError("Either symbol or cik must be provided.")
+        raise OpenBBError("Either symbol or cik must be provided.")
 
     target = symbol if symbol else cik
     choice = "cik" if not symbol else "symbol"
@@ -310,9 +311,9 @@ async def get_nport_candidates(symbol: str, use_cache: bool = True) -> List[Dict
             else _series_id["seriesId"].iloc[0]
         )
     except IndexError as e:
-        raise ValueError("Fund not found for, the symbol: " + symbol) from e
+        raise OpenBBError("Fund not found for, the symbol: " + symbol) from e
     if series_id == "" or series_id is None:
-        raise ValueError("Fund not found for, the symbol: " + symbol)
+        raise OpenBBError("Fund not found for, the symbol: " + symbol)
 
     url = f"https://efts.sec.gov/LATEST/search-index?q={series_id}&dateRange=all&forms=NPORT-P"
     response: Union[dict, List[dict]] = {}

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/openbb_sec/utils/parse_13f.py

@@ -4,6 +4,7 @@ from typing import Any, Dict, Optional
 
 import xmltodict
 from bs4 import BeautifulSoup
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.provider.utils.helpers import amake_request
 from openbb_sec.models.company_filings import SecCompanyFilingsFetcher
 from openbb_sec.utils.definitions import HEADERS
@@ -28,14 +29,14 @@ async def get_13f_candidates(symbol: Optional[str] = None, cik: Optional[str] =
     if symbol is not None:
         params["symbol"] = symbol
     if cik is None and symbol is None:
-        raise ValueError("Either symbol or cik must be provided.")
+        raise OpenBBError("Either symbol or cik must be provided.")
 
     params["use_cache"] = False
     params["form_type"] = "13F-HR"
     filings = await fetcher.fetch_data(params, {})
     filings = [d.model_dump() for d in filings]
     if len(filings) == 0:
-        raise ValueError(f"No 13F-HR filings found for {symbol if symbol else cik}.")
+        raise OpenBBError(f"No 13F-HR filings found for {symbol if symbol else cik}.")
 
     # Filings before June 30, 2013 are non-structured and are not supported by downstream parsers.
     up_to = to_datetime("2013-06-30").date()  # pylint: disable=unused-variable # noqa
@@ -52,7 +53,7 @@ async def complete_submission_callback(response, _):
     """Use callback function for processing the response object."""
     if response.status == 200:
         return await response.text()
-    raise RuntimeError(f"Request failed with status code {response.status}")
+    raise OpenBBError(f"Request failed with status code {response.status}")
 
 
 async def get_complete_submission(url: str):
@@ -75,7 +76,7 @@ def parse_header(filing_str: str) -> Dict:
         header_dict = xmltodict.parse(str(header_xml)).get("type")
     if header_dict:
         return header_dict  # type: ignore
-    raise ValueError(
+    raise OpenBBError(
         "Failed to parse the form header."
         + " Check the `filing_str` to for the tag, 'headerData'."
     )
@@ -91,7 +92,7 @@ def get_submission_type(filing_str: str):
         except KeyError:
             form_type = header["#text"]
             return form_type
-    raise ValueError(
+    raise OpenBBError(
         "Failed to get the submission type from the form header."
         + " Check the response from `parse_header`."
     )
@@ -102,7 +103,7 @@ def get_period_ending(filing_str: str):
     header = parse_header(filing_str)
     if header.get("filerInfo"):
         return header["filerInfo"].get("periodOfReport")
-    raise ValueError(
+    raise OpenBBError(
         "Failed to get the period of report from the form header."
         + " Check the response from `parse_header`."
     )
@@ -118,12 +119,12 @@ async def parse_13f_hr(filing: str):
 
     # Validate the submission so we know that we can parse it.
     if get_submission_type(filing) not in ("13F-HR", "13F-HR/A"):
-        raise ValueError("Submission type is not 13F-HR.")
+        raise OpenBBError("Submission type is not 13F-HR.")
 
     soup = BeautifulSoup(filing, "lxml-xml")
 
     info_table = soup.find_all("informationTable")
-    if info_table == []:
+    if not info_table:
         info_table = soup.find_all("table")[-1]
 
     parsed_xml = xmltodict.parse(
@@ -131,7 +132,7 @@ async def parse_13f_hr(filing: str):
     )["informationTable"]["infoTable"]
 
     if parsed_xml is None:
-        raise ValueError(
+        raise OpenBBError(
             "Failed to parse the 13F-HR information table."
             + " Check the `filing_str` to make sure it is valid and contains the tag 'informationTable'."
             + " Documents filed before Q2 2013 are not supported."

{openbb_sec-1.2.2 → openbb_sec-1.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-sec"
-version = "1.2.2"
+version = "1.2.3"
 description = "SEC extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -9,7 +9,7 @@ packages = [{ include = "openbb_sec" }]
 
 [tool.poetry.dependencies]
 python = ">=3.8,<3.12"
-openbb-core = "^1.2.4"
+openbb-core = "^1.2.5"
 aiohttp-client-cache = "^0.11.0"
 aiosqlite = "^0.20.0"
 xmltodict = "^0.13.0"