openseries 1.7.8__py3-none-any.whl → 1.8.1__py3-none-any.whl

openseries/portfoliotools.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 
 from inspect import stack
 from pathlib import Path
-from typing import TYPE_CHECKING, Callable, cast
+from typing import TYPE_CHECKING, cast
 
 from numpy import (
     append,
@@ -21,7 +21,6 @@ from numpy import (
 from numpy import (
     sum as npsum,
 )
-from numpy.typing import NDArray
 from pandas import (
     DataFrame,
     Series,
@@ -33,19 +32,24 @@ from plotly.offline import plot  # type: ignore[import-untyped,unused-ignore]
 from scipy.optimize import minimize  # type: ignore[import-untyped,unused-ignore]
 
 from .load_plotly import load_plotly_dict
-from .series import OpenTimeSeries
-
-# noinspection PyProtectedMember
-from .simulation import _random_generator
-from .types import (
+from .owntypes import (
+    AtLeastOneFrameError,
     LiteralLinePlotMode,
     LiteralMinimizeMethods,
     LiteralPlotlyJSlib,
     LiteralPlotlyOutput,
+    MixedValuetypesError,
     ValueType,
 )
+from .series import OpenTimeSeries
+
+# noinspection PyProtectedMember
+from .simulation import _random_generator
 
 if TYPE_CHECKING:  # pragma: no cover
+    from collections.abc import Callable
+
+    from numpy.typing import NDArray
     from pydantic import DirectoryPath
 
     from .frame import OpenFrame
@@ -91,7 +95,7 @@ def simulate_portfolios(
         log_ret = copi.tsdf.copy()
     else:
         msg = "Mix of series types will give inconsistent results"
-        raise ValueError(msg)
+        raise MixedValuetypesError(msg)
 
     log_ret.columns = log_ret.columns.droplevel(level=1)
 
@@ -127,7 +131,7 @@ def simulate_portfolios(
 
 
 # noinspection PyUnusedLocal
-def efficient_frontier(  # noqa: C901
+def efficient_frontier(
     eframe: OpenFrame,
     num_ports: int = 5000,
     seed: int = 71,
@@ -175,7 +179,7 @@ def efficient_frontier(  # noqa: C901
         log_ret = copi.tsdf.copy()
     else:
         msg = "Mix of series types will give inconsistent results"
-        raise ValueError(msg)
+        raise MixedValuetypesError(msg)
 
     log_ret.columns = log_ret.columns.droplevel(level=1)
 
@@ -199,7 +203,7 @@ def efficient_frontier(  # noqa: C901
         ret = npsum(lg_ret.mean() * weights) * per_in_yr
         volatility = sqrt(weights.T @ (lg_ret.cov() * per_in_yr @ weights))
         sr = ret / volatility
-        return cast(NDArray[float64], array([ret, volatility, sr]))
+        return cast("NDArray[float64]", array([ret, volatility, sr]))
 
     def _diff_return(
         lg_ret: DataFrame,
@@ -208,14 +212,14 @@ def efficient_frontier(  # noqa: C901
         poss_return: float,
     ) -> float64:
         return cast(
-            float64,
+            "float64",
             _get_ret_vol_sr(lg_ret=lg_ret, weights=weights, per_in_yr=per_in_yr)[0]
             - poss_return,
         )
 
     def _neg_sharpe(weights: NDArray[float64]) -> float64:
         return cast(
-            float64,
+            "float64",
             _get_ret_vol_sr(
                 lg_ret=log_ret,
                 weights=weights,
@@ -228,7 +232,7 @@ def efficient_frontier(  # noqa: C901
         weights: NDArray[float64],
     ) -> float64:
         return cast(
-            float64,
+            "float64",
             _get_ret_vol_sr(
                 lg_ret=log_ret,
                 weights=weights,
@@ -261,7 +265,7 @@ def efficient_frontier(  # noqa: C901
 
     for possible_return in frontier_y:
         cons = cast(
-            dict[str, str | Callable[[float, NDArray[float64]], float64]],
+            "dict[str, str | Callable[[float, NDArray[float64]], float64]]",
             (
                 {"type": "eq", "fun": _check_sum},
                 {
@@ -413,14 +417,16 @@ def prepare_plot_data(
         [
             f"{wgt:.1%}  {nm}"
             for wgt, nm in zip(
-                cast(list[float], assets.weights),
+                cast("list[float]", assets.weights),
                 assets.columns_lvl_zero,
+                strict=True,
             )
         ],
     )
 
     opt_text_list = [
-        f"{wgt:.1%}  {nm}" for wgt, nm in zip(optimized[3:], assets.columns_lvl_zero)
+        f"{wgt:.1%}  {nm}"
+        for wgt, nm in zip(optimized[3:], assets.columns_lvl_zero, strict=True)
     ]
     opt_text = "<br><br>Weights:<br>" + "<br>".join(opt_text_list)
     vol: Series[float] = assets.vol
@@ -442,7 +448,7 @@ def prepare_plot_data(
     return plotframe
 
 
-def sharpeplot(  # noqa: C901
+def sharpeplot(
     sim_frame: DataFrame | None = None,
     line_frame: DataFrame | None = None,
     point_frame: DataFrame | None = None,
@@ -511,7 +517,7 @@ def sharpeplot(  # noqa: C901
 
     if sim_frame is None and line_frame is None and point_frame is None:
         msg = "One of sim_frame, line_frame or point_frame must be provided."
-        raise ValueError(msg)
+        raise AtLeastOneFrameError(msg)
 
     if sim_frame is not None:
         returns.extend(list(sim_frame.loc[:, "ret"]))
@@ -549,10 +555,10 @@ def sharpeplot(  # noqa: C901
 
     if point_frame is not None:
         colorway = cast(
-            dict[str, str | int | float | bool | list[str]],
+            "dict[str, str | int | float | bool | list[str]]",
             fig["layout"],
         ).get("colorway")[: len(point_frame.columns)]
-        for col, clr in zip(point_frame.columns, colorway):
+        for col, clr in zip(point_frame.columns, colorway, strict=True):
             returns.extend([point_frame.loc["ret", col]])
             risk.extend([point_frame.loc["stdev", col]])
             figure.add_scatter(
@@ -597,7 +603,7 @@ def sharpeplot(  # noqa: C901
             auto_open=auto_open,
             auto_play=False,
             link_text="",
-            include_plotlyjs=cast(bool, include_plotlyjs),
+            include_plotlyjs=cast("bool", include_plotlyjs),
             config=fig["config"],
             output_type=output_type,
         )
@@ -608,7 +614,7 @@ def sharpeplot(  # noqa: C901
             fig=figure,
             config=fig["config"],
             auto_play=False,
-            include_plotlyjs=cast(bool, include_plotlyjs),
+            include_plotlyjs=cast("bool", include_plotlyjs),
             full_html=False,
             div_id=div_id,
         )

openseries/series.py

@@ -1,12 +1,15 @@
 """Defining the OpenTimeSeries class."""
 
+# mypy: disable-error-code="no-any-return"
 from __future__ import annotations
 
-import datetime as dt
 from collections.abc import Iterable
 from copy import deepcopy
-from logging import warning
-from typing import Any, TypeVar, cast
+from logging import getLogger
+from typing import TYPE_CHECKING, Any, TypeVar, cast
+
+if TYPE_CHECKING:  # pragma: no cover
+    import datetime as dt
 
 from numpy import (
     append,
@@ -27,31 +30,35 @@ from pandas import (
     date_range,
 )
 from pydantic import field_validator, model_validator
-from typing_extensions import Self
 
 from ._common_model import _CommonModel
 from .datefixer import _do_resample_to_business_period_ends, date_fix
-from .types import (
+from .owntypes import (
     Countries,
     CountriesType,
     Currency,
     CurrencyStringType,
+    DateAlignmentError,
     DateListType,
     DaysInYearType,
+    IncorrectArgumentComboError,
     LiteralBizDayFreq,
     LiteralPandasReindexMethod,
     LiteralSeriesProps,
     OpenTimeSeriesPropertiesList,
+    Self,
     ValueListType,
     ValueType,
 )
 
+logger = getLogger(__name__)
+
 __all__ = ["OpenTimeSeries", "timeseries_chain"]
 
 TypeOpenTimeSeries = TypeVar("TypeOpenTimeSeries", bound="OpenTimeSeries")
 
 
-# noinspection PyUnresolvedReferences
+# noinspection PyUnresolvedReferences,PyNestedDecorators
 class OpenTimeSeries(_CommonModel):
     """OpenTimeSeries objects are at the core of the openseries package.
 
@@ -142,7 +149,7 @@ class OpenTimeSeries(_CommonModel):
 
     @classmethod
     def from_arrays(
-        cls: type[OpenTimeSeries],
+        cls,
         name: str,
         dates: DateListType,
         values: ValueListType,
@@ -153,7 +160,7 @@ class OpenTimeSeries(_CommonModel):
         baseccy: CurrencyStringType = "SEK",
         *,
         local_ccy: bool = True,
-    ) -> OpenTimeSeries:
+    ) -> Self:
         """Create series from a Pandas DataFrame or Series.
 
         Parameters
@@ -204,14 +211,14 @@ class OpenTimeSeries(_CommonModel):
 
     @classmethod
     def from_df(
-        cls: type[OpenTimeSeries],
+        cls,
         dframe: Series[float] | DataFrame,
         column_nmbr: int = 0,
         valuetype: ValueType = ValueType.PRICE,
         baseccy: CurrencyStringType = "SEK",
         *,
         local_ccy: bool = True,
-    ) -> OpenTimeSeries:
+    ) -> Self:
         """Create series from a Pandas DataFrame or Series.
 
         Parameters
@@ -240,7 +247,7 @@ class OpenTimeSeries(_CommonModel):
                 label, _ = dframe.name
             else:
                 label = dframe.name
-            values = cast(list[float], dframe.to_numpy().tolist())
+            values = cast("list[float]", dframe.to_numpy().tolist())
         elif isinstance(dframe, DataFrame):
             values = dframe.iloc[:, column_nmbr].to_list()
             if isinstance(dframe.columns, MultiIndex):
@@ -249,7 +256,7 @@ class OpenTimeSeries(_CommonModel):
                 ):
                     label = "Series"
                     msg = f"Label missing. Adding: {label}"
-                    warning(msg=msg)
+                    logger.warning(msg=msg)
                 else:
                     label = dframe.columns.get_level_values(0).to_numpy()[column_nmbr]
                 if _check_if_none(
@@ -257,13 +264,13 @@ class OpenTimeSeries(_CommonModel):
                 ):
                     valuetype = ValueType.PRICE
                     msg = f"valuetype missing. Adding: {valuetype.value}"
-                    warning(msg=msg)
+                    logger.warning(msg=msg)
                 else:
                     valuetype = dframe.columns.get_level_values(1).to_numpy()[
                         column_nmbr
                     ]
             else:
-                label = cast(MultiIndex, dframe.columns).to_numpy()[column_nmbr]
+                label = cast("MultiIndex", dframe.columns).to_numpy()[column_nmbr]
         else:
             raise TypeError(msg)
 
@@ -289,7 +296,7 @@ class OpenTimeSeries(_CommonModel):
 
     @classmethod
     def from_fixed_rate(
-        cls: type[OpenTimeSeries],
+        cls,
         rate: float,
         d_range: DatetimeIndex | None = None,
         days: int | None = None,
@@ -299,7 +306,7 @@ class OpenTimeSeries(_CommonModel):
         baseccy: CurrencyStringType = "SEK",
         *,
         local_ccy: bool = True,
-    ) -> OpenTimeSeries:
+    ) -> Self:
         """Create series from values accruing with a given fixed rate return.
 
         Providing a date_range of type Pandas DatetimeIndex takes priority over
@@ -338,7 +345,7 @@ class OpenTimeSeries(_CommonModel):
             )
         elif not isinstance(d_range, Iterable) and not all([days, end_dt]):
             msg = "If d_range is not provided both days and end_dt must be."
-            raise ValueError(msg)
+            raise IncorrectArgumentComboError(msg)
 
         deltas = array(
             [i.days for i in DatetimeIndex(d_range)[1:] - DatetimeIndex(d_range)[:-1]],  # type: ignore[arg-type]
@@ -413,7 +420,7 @@ class OpenTimeSeries(_CommonModel):
         """
         if not properties:
             properties = cast(
-                list[LiteralSeriesProps],
+                "list[LiteralSeriesProps]",
                 OpenTimeSeriesPropertiesList.allowed_strings,
             )
 
@@ -435,7 +442,9 @@ class OpenTimeSeries(_CommonModel):
         returns.iloc[0] = 0
         self.valuetype = ValueType.RTRN
         arrays = [[self.label], [self.valuetype]]
-        returns.columns = MultiIndex.from_arrays(arrays=arrays)
+        returns.columns = MultiIndex.from_arrays(
+            arrays=arrays  # type: ignore[arg-type,unused-ignore]
+        )
         self.tsdf = returns.copy()
         return self
 
@@ -513,7 +522,9 @@ class OpenTimeSeries(_CommonModel):
 
         deltas = array([i.days for i in self.tsdf.index[1:] - self.tsdf.index[:-1]])
         # noinspection PyTypeChecker
-        arr = cumprod(insert(1.0 + deltas * arr[:-1] / days_in_year, 0, 1.0))
+        arr = cumprod(  # type: ignore[assignment,unused-ignore]
+            a=insert(arr=1.0 + deltas * arr[:-1] / days_in_year, obj=0, values=1.0)
+        )
 
         self.dates = [d.strftime("%Y-%m-%d") for d in self.tsdf.index]
         self.values = list(arr)
@@ -622,26 +633,26 @@ class OpenTimeSeries(_CommonModel):
             time_factor = float(periods_in_a_year_fixed)
         else:
             how_many = self.tsdf.loc[
-                cast(int, earlier) : cast(int, later),
+                cast("int", earlier) : cast("int", later),
                 self.tsdf.columns.to_numpy()[0],
             ].count()
             fraction = (later - earlier).days / 365.25
             time_factor = how_many / fraction
 
-        data = self.tsdf.loc[cast(int, earlier) : cast(int, later)].copy()
+        data = self.tsdf.loc[cast("int", earlier) : cast("int", later)].copy()
 
         data[self.label, ValueType.RTRN] = (
             data.loc[:, self.tsdf.columns.to_numpy()[0]].apply(log).diff()
         )
 
         rawdata = [
-            data.loc[:, cast(int, (self.label, ValueType.RTRN))]
+            data.loc[:, cast("int", (self.label, ValueType.RTRN))]
             .iloc[1:day_chunk]
             .std(ddof=dlta_degr_freedms)
             * sqrt(time_factor),
         ]
 
-        for item in data.loc[:, cast(int, (self.label, ValueType.RTRN))].iloc[1:]:
+        for item in data.loc[:, cast("int", (self.label, ValueType.RTRN))].iloc[1:]:
             prev = rawdata[-1]
             rawdata.append(
                 sqrt(
@@ -682,7 +693,7 @@ class OpenTimeSeries(_CommonModel):
             values = [1.0]
             returns_input = True
         else:
-            values = [cast(float, self.tsdf.iloc[0, 0])]
+            values = [cast("float", self.tsdf.iloc[0, 0])]
             ra_df = self.tsdf.ffill().pct_change()
             returns_input = False
         ra_df = ra_df.dropna()
@@ -691,16 +702,16 @@ class OpenTimeSeries(_CommonModel):
         dates: list[dt.date] = [prev]
 
         for idx, row in ra_df.iterrows():
-            dates.append(cast(dt.date, idx))
+            dates.append(cast("dt.date", idx))
             values.append(
                 values[-1]
                 * (
                     1
                     + row.iloc[0]
-                    + adjustment * (cast(dt.date, idx) - prev).days / days_in_year
+                    + adjustment * (cast("dt.date", idx) - prev).days / days_in_year
                 ),
             )
-            prev = cast(dt.date, idx)
+            prev = cast("dt.date", idx)
         self.tsdf = DataFrame(data=values, index=dates)
         self.valuetype = ValueType.PRICE
         self.tsdf.columns = MultiIndex.from_arrays(
@@ -750,7 +761,7 @@ class OpenTimeSeries(_CommonModel):
             self.valuetype = lvl_one
         else:
             self.tsdf.columns = MultiIndex.from_arrays([[lvl_zero], [lvl_one]])
-            self.label, self.valuetype = lvl_zero, cast(ValueType, lvl_one)
+            self.label, self.valuetype = lvl_zero, cast("ValueType", lvl_one)
         if delete_lvl_one:
             self.tsdf.columns = self.tsdf.columns.droplevel(level=1)
         return self
@@ -760,7 +771,7 @@ def timeseries_chain(
     front: TypeOpenTimeSeries,
     back: TypeOpenTimeSeries,
     old_fee: float = 0.0,
-) -> TypeOpenTimeSeries | OpenTimeSeries:
+) -> TypeOpenTimeSeries:
     """Chain two timeseries together.
 
     The function assumes that the two series have at least one date in common.
@@ -776,7 +787,7 @@ def timeseries_chain(
 
     Returns
     -------
-    TypeOpenTimeSeries | OpenTimeSeries
+    TypeOpenTimeSeries
         An OpenTimeSeries object or a subclass thereof
 
     """
@@ -788,14 +799,14 @@ def timeseries_chain(
 
     if old.last_idx < first:
         msg = "Timeseries dates must overlap to allow them to be chained."
-        raise ValueError(msg)
+        raise DateAlignmentError(msg)
 
     while first not in old.tsdf.index:
         idx += 1
         first = new.tsdf.index[idx]
         if first > old.tsdf.index[-1]:
             msg = "Failed to find a matching date between series"
-            raise ValueError(msg)
+            raise DateAlignmentError(msg)
 
     dates: list[str] = [x.strftime("%Y-%m-%d") for x in old.tsdf.index if x < first]
 
@@ -807,27 +818,6 @@ def timeseries_chain(
 
     dates.extend([x.strftime("%Y-%m-%d") for x in new.tsdf.index])
 
-    # noinspection PyUnresolvedReferences
-    if back.__class__.__subclasscheck__(
-        OpenTimeSeries,
-    ):
-        return OpenTimeSeries(
-            timeseries_id=new.timeseries_id,
-            instrument_id=new.instrument_id,
-            currency=new.currency,
-            dates=dates,
-            name=new.name,
-            label=new.name,
-            valuetype=new.valuetype,
-            values=list(values),
-            local_ccy=new.local_ccy,
-            tsdf=DataFrame(
-                data=values,
-                index=[d.date() for d in DatetimeIndex(dates)],
-                columns=[[new.label], [new.valuetype]],
-                dtype="float64",
-            ),
-        )
     return back.__class__(
         timeseries_id=new.timeseries_id,
         instrument_id=new.instrument_id,
@@ -862,7 +852,7 @@ def _check_if_none(item: Any) -> bool:  # noqa: ANN401
 
     """
     try:
-        return cast(bool, isnan(item))
+        return cast("bool", isnan(item))
     except TypeError:
         if item is None:
             return True

openseries/simulation.py

@@ -1,5 +1,6 @@
 """Defining the ReturnSimulation class."""
 
+# mypy: disable-error-code="no-any-return"
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, cast
@@ -22,12 +23,12 @@ from pydantic import (
     PositiveFloat,
     PositiveInt,
 )
-from typing_extensions import Self
 
 from .datefixer import generate_calendar_date_range
-from .types import (
+from .owntypes import (
     CountriesType,
     DaysInYearType,
+    Self,
     ValueType,
 )
 
@@ -49,7 +50,7 @@ def _random_generator(seed: int | None) -> Generator:
 
     """
     ss = SeedSequence(entropy=seed)
-    bg = PCG64(seed=cast(int | None, ss))
+    bg = PCG64(seed=cast("int | None", ss))
     return Generator(bit_generator=bg)
 
 
@@ -121,7 +122,7 @@ class ReturnSimulation(BaseModel):
 
         """
         return cast(
-            float,
+            "float",
             (
                 self.results.ffill().pct_change().mean() * self.trading_days_in_year
             ).iloc[0],
@@ -138,7 +139,7 @@ class ReturnSimulation(BaseModel):
 
         """
         return cast(
-            float,
+            "float",
             (
                 self.results.ffill().pct_change().std()
                 * sqrt(self.trading_days_in_year)

openseries-1.8.1.dist-info/LICENSE.md

@@ -0,0 +1,27 @@
+# BSD 3-Clause License
+
+## Copyright (c) Captor Fund Management AB
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of
+   conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list
+   of conditions and the following disclaimer in the documentation and/or other
+   materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be
+   used to endorse or promote products derived from this software without specific prior
+   written permission.
+
+This software is provided by the copyright holders and contributors “as is” and any
+express or implied warranties, including, but not limited to, the implied warranties of
+merchantability and fitness for a particular purpose, are disclaimed. In no event shall
+the copyright holder or contributors be liable for any direct, indirect, incidental,
+special, exemplary, or consequential damages (including, but not limited to, procurement
+of substitute goods or services; loss of use, data, or profits; or business interruption)
+however caused and on any theory of liability, whether in contract, strict liability,
+or tort (including negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.