Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions pypfopt/expected_returns.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,27 @@ def returns_from_prices(prices, log_returns=False):
-------
pd.DataFrame
(daily) returns

Warns
-----
UserWarning
If an observed price is zero or negative. Percentage returns from such
prices can be misleading; consider absolute price changes instead.
"""
nonpositive = prices.le(0).fillna(False).to_numpy()
if nonpositive.any():
position = np.argwhere(nonpositive)[0]
date = prices.index[position[0]]
asset = (
prices.name if isinstance(prices, pd.Series) else prices.columns[position[1]]
)
warnings.warn(
f"Non-positive price for asset {asset!r} at {date!r}. "
"Percentage returns may be misleading. Consider absolute price changes "
"for instruments that can trade at or below zero.",
UserWarning,
stacklevel=2,
)
if log_returns:
returns = np.log(1 + prices.pct_change(fill_method=None)).dropna(how="all")
else:
Expand Down
71 changes: 71 additions & 0 deletions tests/test_expected_returns_price_validation.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import warnings

import numpy as np
import pandas as pd
import pytest

from pypfopt import expected_returns


@pytest.mark.parametrize("bad_price", [0.0, -1.0])
@pytest.mark.parametrize("log_returns", [False, True])
@pytest.mark.parametrize("as_series", [False, True])
def test_nonpositive_prices_warn_with_asset_and_date(bad_price, log_returns, as_series):
prices = pd.DataFrame(
{"WTI": [10.0, bad_price, -2.0]},
index=pd.date_range("2020-04-20", periods=3),
)
if as_series:
prices = prices["WTI"]

with warnings.catch_warnings():
warnings.simplefilter("ignore", RuntimeWarning)
with pytest.warns(UserWarning, match="Non-positive price.*WTI.*2020-04-21"):
actual = expected_returns.returns_from_prices(
prices, log_returns=log_returns
)
reference = prices.pct_change(fill_method=None)
if log_returns:
reference = np.log(1 + reference)
reference = reference.dropna(how="all")

if as_series:
pd.testing.assert_series_equal(actual, reference)
else:
pd.testing.assert_frame_equal(actual, reference)


@pytest.mark.parametrize("log_returns", [False, True])
def test_positive_prices_and_missing_observations_do_not_warn(log_returns):
prices = pd.DataFrame(
{"A": [np.nan, 10.0, 11.0, 9.0], "B": [20.0, np.nan, 19.0, 20.0]}
)
original = prices.copy(deep=True)
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
expected_returns.returns_from_prices(prices, log_returns=log_returns)

assert not caught
pd.testing.assert_frame_equal(prices, original)


@pytest.mark.parametrize(
"estimator",
[expected_returns.mean_historical_return, expected_returns.ema_historical_return],
)
def test_estimators_warn_for_negative_prices(estimator):
prices = pd.DataFrame({"WTI": [-10.0, -11.0, -12.0]})
with pytest.warns(UserWarning, match="Non-positive price.*WTI"):
estimator(prices, frequency=1)


def test_negative_return_inputs_are_not_treated_as_prices():
returns = pd.DataFrame({"A": [-0.1, 0.0, 0.2]})
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
actual = expected_returns.mean_historical_return(
returns, returns_data=True, frequency=1
)

assert not caught
pd.testing.assert_series_equal(actual, (1 + returns).prod() ** (1 / 3) - 1)