openseries 1.7.1__tar.gz → 1.7.2__tar.gz

{openseries-1.7.1 → openseries-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openseries
-Version: 1.7.1
+Version: 1.7.2
 Summary: Tools for analyzing financial timeseries.
 Home-page: https://github.com/CaptorAB/openseries
 License: BSD-3-Clause
@@ -28,7 +28,7 @@ Requires-Dist: pyarrow (>=14.0.2,<18.0.0)
 Requires-Dist: pydantic (>=2.5.2,<3.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.20.0,<3.0.0)
-Requires-Dist: scipy (>=1.11.4,<2.0.0)
+Requires-Dist: scipy (>=1.11.4,<1.14.1)
 Requires-Dist: statsmodels (>=0.14.0,<1.0.0)
 Project-URL: Repository, https://github.com/CaptorAB/openseries
 Description-Content-Type: text/markdown
@@ -261,7 +261,6 @@ make lint
 
 | Method                   | Applies to       | Description                                                                                                                                    |
 |:-------------------------|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
-| `setup_class`            | `OpenTimeSeries` | Class method that defines the `domestic` home currency and the `countries` home countries attributes.                                          |
 | `pandas_df`              | `OpenTimeSeries` | Method to create the `tsdf` pandas.DataFrame from the `dates` and `values`.                                                                    |
 | `set_new_label`          | `OpenTimeSeries` | Method to change the pandas.DataFrame column MultiIndex.                                                                                       |
 | `running_adjustment`     | `OpenTimeSeries` | Adjusts the series performance with a `float` factor.                                                                                          |

{openseries-1.7.1 → openseries-1.7.2}/README.md

@@ -226,7 +226,6 @@ make lint
 
 | Method                   | Applies to       | Description                                                                                                                                    |
 |:-------------------------|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
-| `setup_class`            | `OpenTimeSeries` | Class method that defines the `domestic` home currency and the `countries` home countries attributes.                                          |
 | `pandas_df`              | `OpenTimeSeries` | Method to create the `tsdf` pandas.DataFrame from the `dates` and `values`.                                                                    |
 | `set_new_label`          | `OpenTimeSeries` | Method to change the pandas.DataFrame column MultiIndex.                                                                                       |
 | `running_adjustment`     | `OpenTimeSeries` | Adjusts the series performance with a `float` factor.                                                                                          |

{openseries-1.7.1 → openseries-1.7.2}/openseries/_common_model.py

@@ -484,9 +484,7 @@ class _CommonModel(BaseModel):
                     "Argument months_offset implies start"
                     "date before first date in series."
                 )
-                raise ValueError(
-                    msg,
-                )
+                raise ValueError(msg)
             later = self.last_idx
         else:
             if from_dt is not None:
@@ -785,9 +783,7 @@ class _CommonModel(BaseModel):
         if labels:
             if len(labels) != self.tsdf.shape[1]:
                 msg = "Must provide same number of labels as items in frame."
-                raise ValueError(
-                    msg,
-                )
+                raise ValueError(msg)
         else:
             labels = list(self.tsdf.columns.get_level_values(0))
 
@@ -902,9 +898,7 @@ class _CommonModel(BaseModel):
         if labels:
             if len(labels) != self.tsdf.shape[1]:
                 msg = "Must provide same number of labels as items in frame."
-                raise ValueError(
-                    msg,
-                )
+                raise ValueError(msg)
         else:
             labels = list(self.tsdf.columns.get_level_values(0))
 
@@ -1932,9 +1926,7 @@ class _CommonModel(BaseModel):
                 "Simple return cannot be calculated due to "
                 f"an initial value being zero. ({self.tsdf.head(3)})"
             )
-            raise ValueError(
-                msg,
-            )
+            raise ValueError(msg)
 
         result = self.tsdf.loc[later] / self.tsdf.loc[earlier] - 1
 

{openseries-1.7.1 → openseries-1.7.2}/openseries/datefixer.py

@@ -92,9 +92,7 @@ def holiday_calendar(
             "Argument countries must be a string country code or "
             "a list of string country codes according to ISO 3166-1 alpha-2."
         )
-        raise ValueError(
-            msg,
-        )
+        raise ValueError(msg)
 
     return busdaycalendar(holidays=hols)
 
@@ -115,6 +113,7 @@ def date_fix(
         Parsed date
 
     """
+    msg = f"Unknown date format {fixerdate!s} of type {type(fixerdate)!s} encountered"
     if isinstance(fixerdate, (Timestamp, dt.datetime)):
         return fixerdate.date()
     if isinstance(fixerdate, dt.date):
@@ -125,10 +124,7 @@ def date_fix(
         )
     if isinstance(fixerdate, str):
         return dt.datetime.strptime(fixerdate, "%Y-%m-%d").astimezone().date()
-    msg = f"Unknown date format {fixerdate!s} of type {type(fixerdate)!s} encountered"
-    raise TypeError(
-        msg,
-    )
+    raise TypeError(msg)
 
 
 def date_offset_foll(
@@ -372,9 +368,7 @@ def generate_calendar_date_range(
         "Provide one of start or end date, but not both. "
         "Date range is inferred from number of trading days."
     )
-    raise ValueError(
-        msg,
-    )
+    raise ValueError(msg)
 
 
 # noinspection PyUnusedLocal

{openseries-1.7.1 → openseries-1.7.2}/openseries/frame.py

@@ -13,7 +13,6 @@ if TYPE_CHECKING:
 
 import statsmodels.api as sm  # type: ignore[import-untyped,unused-ignore]
 from numpy import (
-    array,
     cov,
     cumprod,
     divide,
@@ -777,6 +776,7 @@ class OpenFrame(_CommonModel):
         earlier, later = self.calc_range(months_from_last, from_date, to_date)
         fraction = (later - earlier).days / 365.25
 
+        msg = "base_column should be a tuple[str, ValueType] or an integer."
         if isinstance(base_column, tuple):
             shortdf = self.tsdf.loc[cast(int, earlier) : cast(int, later)].loc[
                 :,
@@ -798,10 +798,7 @@ class OpenFrame(_CommonModel):
             ].name
             short_label = cast(tuple[str, str], self.tsdf.iloc[:, base_column].name)[0]
         else:
-            msg = "base_column should be a tuple[str, ValueType] or an integer."
-            raise TypeError(
-                msg,
-            )
+            raise TypeError(msg)
 
         if periods_in_a_year_fixed:
             time_factor = float(periods_in_a_year_fixed)
@@ -870,6 +867,7 @@ class OpenFrame(_CommonModel):
         earlier, later = self.calc_range(months_from_last, from_date, to_date)
         fraction = (later - earlier).days / 365.25
 
+        msg = "base_column should be a tuple[str, ValueType] or an integer."
         if isinstance(base_column, tuple):
             shortdf = self.tsdf.loc[cast(int, earlier) : cast(int, later)].loc[
                 :,
@@ -891,10 +889,7 @@ class OpenFrame(_CommonModel):
             ].name
             short_label = cast(tuple[str, str], self.tsdf.iloc[:, base_column].name)[0]
         else:
-            msg = "base_column should be a tuple[str, ValueType] or an integer."
-            raise TypeError(
-                msg,
-            )
+            raise TypeError(msg)
 
         if periods_in_a_year_fixed:
             time_factor = float(periods_in_a_year_fixed)
@@ -974,6 +969,7 @@ class OpenFrame(_CommonModel):
         earlier, later = self.calc_range(months_from_last, from_date, to_date)
         fraction = (later - earlier).days / 365.25
 
+        msg = "base_column should be a tuple[str, ValueType] or an integer."
         if isinstance(base_column, tuple):
             shortdf = self.tsdf.loc[cast(int, earlier) : cast(int, later)].loc[
                 :,
@@ -995,10 +991,7 @@ class OpenFrame(_CommonModel):
             ].name
             short_label = cast(tuple[str, str], self.tsdf.iloc[:, base_column].name)[0]
         else:
-            msg = "base_column should be a tuple[str, ValueType] or an integer."
-            raise TypeError(
-                msg,
-            )
+            raise TypeError(msg)
 
         if periods_in_a_year_fixed:
             time_factor = float(periods_in_a_year_fixed)
@@ -1014,6 +1007,7 @@ class OpenFrame(_CommonModel):
                     :,
                     item,
                 ]
+                msg = "ratio must be one of 'up', 'down' or 'both'."
                 if ratio == "up":
                     uparray = (
                         longdf.pct_change(fill_method=None)[
@@ -1109,7 +1103,6 @@ class OpenFrame(_CommonModel):
                         (up_rtrn / up_idx_return) / (down_return / down_idx_return),
                     )
                 else:
-                    msg = "ratio must be one of 'up', 'down' or 'both'."
                     raise ValueError(msg)
 
         if ratio == "up":
@@ -1156,25 +1149,23 @@ class OpenFrame(_CommonModel):
             x_value == ValueType.RTRN
             for x_value in self.tsdf.columns.get_level_values(1).to_numpy()
         ):
+            msg = "asset should be a tuple[str, ValueType] or an integer."
             if isinstance(asset, tuple):
                 y_value = self.tsdf.loc[:, asset]
             elif isinstance(asset, int):
                 y_value = self.tsdf.iloc[:, asset]
             else:
-                msg = "asset should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
+
+            msg = "market should be a tuple[str, ValueType] or an integer."
             if isinstance(market, tuple):
                 x_value = self.tsdf.loc[:, market]
             elif isinstance(market, int):
                 x_value = self.tsdf.iloc[:, market]
             else:
-                msg = "market should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
         else:
+            msg = "asset should be a tuple[str, ValueType] or an integer."
             if isinstance(asset, tuple):
                 y_value = log(
                     self.tsdf.loc[:, asset] / self.tsdf.loc[:, asset].iloc[0],
@@ -1184,10 +1175,9 @@ class OpenFrame(_CommonModel):
                     self.tsdf.iloc[:, asset] / cast(float, self.tsdf.iloc[0, asset]),
                 )
             else:
-                msg = "asset should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
+
+            msg = "market should be a tuple[str, ValueType] or an integer."
             if isinstance(market, tuple):
                 x_value = log(
                     self.tsdf.loc[:, market] / self.tsdf.loc[:, market].iloc[0],
@@ -1197,10 +1187,7 @@ class OpenFrame(_CommonModel):
                     self.tsdf.iloc[:, market] / cast(float, self.tsdf.iloc[0, market]),
                 )
             else:
-                msg = "market should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
 
         covariance = cov(y_value, x_value, ddof=dlta_degr_freedms)
         beta = covariance[0, 1] / covariance[1, 1]
@@ -1241,6 +1228,7 @@ class OpenFrame(_CommonModel):
             The Statsmodels regression output
 
         """
+        msg = "y_column should be a tuple[str, ValueType] or an integer."
         if isinstance(y_column, tuple):
             y_value = self.tsdf.loc[:, y_column]
             y_label = cast(
@@ -1251,11 +1239,9 @@ class OpenFrame(_CommonModel):
             y_value = self.tsdf.iloc[:, y_column]
             y_label = cast(tuple[str, str], self.tsdf.iloc[:, y_column].name)[0]
         else:
-            msg = "y_column should be a tuple[str, ValueType] or an integer."
-            raise TypeError(
-                msg,
-            )
+            raise TypeError(msg)
 
+        msg = "x_column should be a tuple[str, ValueType] or an integer."
         if isinstance(x_column, tuple):
             x_value = self.tsdf.loc[:, x_column]
             x_label = cast(
@@ -1266,10 +1252,7 @@ class OpenFrame(_CommonModel):
             x_value = self.tsdf.iloc[:, x_column]
             x_label = cast(tuple[str, str], self.tsdf.iloc[:, x_column].name)[0]
         else:
-            msg = "x_column should be a tuple[str, ValueType] or an integer."
-            raise TypeError(
-                msg,
-            )
+            raise TypeError(msg)
 
         results = sm.OLS(y_value, x_value).fit(method=method, cov_type=cov_type)
         if fitted_series:
@@ -1315,6 +1298,7 @@ class OpenFrame(_CommonModel):
             x == ValueType.RTRN
             for x in self.tsdf.columns.get_level_values(1).to_numpy()
         ):
+            msg = "asset should be a tuple[str, ValueType] or an integer."
             if isinstance(asset, tuple):
                 asset_log = self.tsdf.loc[:, asset]
                 asset_cagr = asset_log.mean()
@@ -1322,10 +1306,9 @@ class OpenFrame(_CommonModel):
                 asset_log = self.tsdf.iloc[:, asset]
                 asset_cagr = asset_log.mean()
             else:
-                msg = "asset should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
+
+            msg = "market should be a tuple[str, ValueType] or an integer."
             if isinstance(market, tuple):
                 market_log = self.tsdf.loc[:, market]
                 market_cagr = market_log.mean()
@@ -1333,11 +1316,9 @@ class OpenFrame(_CommonModel):
                 market_log = self.tsdf.iloc[:, market]
                 market_cagr = market_log.mean()
             else:
-                msg = "market should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
         else:
+            msg = "asset should be a tuple[str, ValueType] or an integer."
             if isinstance(asset, tuple):
                 asset_log = log(
                     self.tsdf.loc[:, asset] / self.tsdf.loc[:, asset].iloc[0],
@@ -1369,10 +1350,9 @@ class OpenFrame(_CommonModel):
                         - 1
                     )
             else:
-                msg = "asset should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
+
+            msg = "market should be a tuple[str, ValueType] or an integer."
             if isinstance(market, tuple):
                 market_log = log(
                     self.tsdf.loc[:, market] / self.tsdf.loc[:, market].iloc[0],
@@ -1404,10 +1384,7 @@ class OpenFrame(_CommonModel):
                         - 1
                     )
             else:
-                msg = "market should be a tuple[str, ValueType] or an integer."
-                raise TypeError(
-                    msg,
-                )
+                raise TypeError(msg)
 
         covariance = cov(asset_log, market_log, ddof=dlta_degr_freedms)
         beta = covariance[0, 1] / covariance[1, 1]
@@ -1439,9 +1416,7 @@ class OpenFrame(_CommonModel):
                 "OpenFrame weights property must be provided "
                 "to run the make_portfolio method."
             )
-            raise ValueError(
-                msg,
-            )
+            raise ValueError(msg)
         dframe = self.tsdf.copy()
         if not any(
             x == ValueType.RTRN
@@ -1449,6 +1424,8 @@ class OpenFrame(_CommonModel):
         ):
             dframe = dframe.pct_change(fill_method=None)
             dframe.iloc[0] = 0
+
+        msg = "Weight strategy not implemented"
         if weight_strat:
             if weight_strat == "eq_weights":
                 self.weights = [1.0 / self.item_count] * self.item_count
@@ -1457,10 +1434,10 @@ class OpenFrame(_CommonModel):
                 vol[isinf(vol)] = nan
                 self.weights = list(divide(vol, vol.sum()))
             else:
-                msg = "Weight strategy not implemented"
                 raise NotImplementedError(msg)
+
         return DataFrame(
-            data=dframe.dot(other=array(self.weights)).add(1.0).cumprod(),
+            data=(dframe @ self.weights).add(1.0).cumprod(),
             index=self.tsdf.index,
             columns=[[name], [ValueType.PRICE]],
             dtype="float64",

{openseries-1.7.1 → openseries-1.7.2}/openseries/portfoliotools.py

@@ -10,7 +10,6 @@ from typing import TYPE_CHECKING, Callable, cast
 from numpy import (
     append,
     array,
-    dot,
     float64,
     inf,
     isnan,
@@ -106,11 +105,8 @@ def simulate_portfolios(
         weights = weights / npsum(weights)
         all_weights[x, :] = weights
 
-        vol_arr[x] = sqrt(
-            dot(
-                weights.T,
-                dot(log_ret.cov() * simframe.periods_in_a_year, weights),
-            ),
+        vol_arr[x] = sqrt(weights.T @
+                (log_ret.cov() * simframe.periods_in_a_year @ weights),
         )
 
         ret_arr[x] = npsum(log_ret.mean() * weights * simframe.periods_in_a_year)
@@ -198,7 +194,7 @@ def efficient_frontier(  # noqa: C901
         per_in_yr: float,
     ) -> NDArray[float64]:
         ret = npsum(lg_ret.mean() * weights) * per_in_yr
-        volatility = sqrt(dot(weights.T, dot(lg_ret.cov() * per_in_yr, weights)))
+        volatility = sqrt(weights.T @ (lg_ret.cov() * per_in_yr @ weights))
         sr = ret / volatility
         return cast(NDArray[float64], array([ret, volatility, sr]))
 
@@ -288,6 +284,7 @@ def efficient_frontier(  # noqa: C901
         frontier_x.append(result["fun"])
         frontier_weights.append(result["x"])
 
+    # noinspection PyUnreachableCode
     line_df = concat(
         [
             DataFrame(data=frontier_weights, columns=eframe.columns_lvl_zero),

{openseries-1.7.1 → openseries-1.7.2}/openseries/series.py

@@ -107,20 +107,20 @@ class OpenTimeSeries(_CommonModel):
 
     @field_validator("domestic", mode="before")
     @classmethod
-    def validate_domestic(cls, value: CurrencyStringType) -> CurrencyStringType:
+    def _validate_domestic(cls, value: CurrencyStringType) -> CurrencyStringType:
         """Pydantic validator to ensure domestic field is validated."""
         _ = Currency(ccy=value)
         return value
 
     @field_validator("countries", mode="before")
     @classmethod
-    def validate_countries(cls, value: CountriesType) -> CountriesType:
+    def _validate_countries(cls, value: CountriesType) -> CountriesType:
         """Pydantic validator to ensure countries field is validated."""
         _ = Countries(countryinput=value)
         return value
 
     @model_validator(mode="after")  # type: ignore[misc,unused-ignore]
-    def dates_and_values_validate(self: Self) -> Self:
+    def _dates_and_values_validate(self: Self) -> Self:
         """Pydantic validator to ensure dates and values are validated."""
         values_list_length = len(self.values)
         dates_list_length = len(self.dates)
@@ -233,8 +233,11 @@ class OpenTimeSeries(_CommonModel):
             An OpenTimeSeries object
 
         """
-        if isinstance(dframe, Series):
-            if isinstance(dframe.name, tuple):
+        msg = "Argument dframe must be pandas Series or DataFrame."
+        if isinstance(dframe, Series):  # type: ignore[unreachable,unused-ignore]
+            if isinstance(  # type: ignore[unreachable,unused-ignore]
+                    dframe.name, tuple,
+            ):
                 label, _ = dframe.name
             else:
                 label = dframe.name
@@ -263,7 +266,6 @@ class OpenTimeSeries(_CommonModel):
             else:
                 label = cast(MultiIndex, dframe.columns).to_numpy()[column_nmbr]
         else:
-            msg = "Argument dframe must be pandas Series or DataFrame."
             raise TypeError(msg)
 
         dates = [date_fix(d).strftime("%Y-%m-%d") for d in dframe.index]
@@ -337,9 +339,7 @@ class OpenTimeSeries(_CommonModel):
             )
         elif not isinstance(d_range, DatetimeIndex) and not all([days, end_dt]):
             msg = "If d_range is not provided both days and end_dt must be."
-            raise ValueError(
-                msg,
-            )
+            raise ValueError(msg)
 
         deltas = array(
             [

{openseries-1.7.1 → openseries-1.7.2}/openseries/types.py

@@ -272,9 +272,7 @@ class OpenTimeSeriesPropertiesList(list[str]):
                 msg = (
                     f"Invalid string: {item}. Allowed strings: {self.allowed_strings}"
                 )
-                raise ValueError(
-                    msg,
-                )
+                raise ValueError(msg)
             if item in seen:
                 msg = f"Duplicate string: {item}"
                 raise ValueError(msg)
@@ -323,9 +321,7 @@ class OpenFramePropertiesList(list[str]):
                 msg = (
                     f"Invalid string: {item}. Allowed strings: {self.allowed_strings}"
                 )
-                raise ValueError(
-                    msg,
-                )
+                raise ValueError(msg)
             if item in seen:
                 msg = f"Duplicate string: {item}"
                 raise ValueError(msg)

{openseries-1.7.1 → openseries-1.7.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openseries"
-version = "1.7.1"
+version = "1.7.2"
 description = "Tools for analyzing financial timeseries."
 authors = ["Martin Karrin <martin.karrin@captor.se>"]
 repository = "https://github.com/CaptorAB/openseries"
@@ -42,7 +42,7 @@ pyarrow = ">=14.0.2,<18.0.0"
 pydantic = ">=2.5.2,<3.0.0"
 python-dateutil = ">=2.8.2,<3.0.0"
 requests = ">=2.20.0,<3.0.0"
-scipy = ">=1.11.4,<2.0.0"
+scipy = ">=1.11.4,<1.14.1"
 statsmodels = ">=0.14.0,<1.0.0"
 
 [tool.poetry.group.dev.dependencies]
@@ -53,7 +53,7 @@ mypy = "^1.11.1"
 pandas-stubs = ">=2.1.2,<3.0.0"
 pre-commit = ">=3.7.1,<4.0.0"
 pytest = ">=8.2.2,<9.0.0"
-ruff = "^0.5.7"
+ruff = "^0.6.2"
 types-openpyxl = ">=3.1.2,<4.0.0"
 types-python-dateutil = ">=2.8.2,<3.0.0"
 types-requests = ">=2.20.0,<3.0.0"
@@ -79,7 +79,7 @@ output = "coverage.xml"
 exclude = ["venv/*"]
 strict = true
 pretty = true
-warn_unreachable = false
+warn_unreachable = true
 warn_redundant_casts = true
 warn_unused_ignores = true
 disallow_any_generics = true