def test_empty_ds():
ds = Docstring(None)
ds.replace_block('summary', ['The is the new summary.'])
ds.remove_parameters('x')
new = Parameter('w', 'ndarray', ['An array input.'])
ds.insert_parameters('y', new)
assert str(ds) == 'None'
def test_insert_parameters():
new = Parameter('w', 'ndarray', ['An array input.'])
ds = Docstring(good)
ds.insert_parameters('y', new)
assert 'w : ndarray' in str(ds)
assert 'An array input.' in str(ds)
other = Parameter('q', 'DataFrame', ['A pandas dataframe.'])
ds = Docstring(good)
ds.insert_parameters(None, [new, other])
assert 'w : ndarray' in str(ds)
assert 'An array input.' in str(ds)
assert 'q : DataFrame' in str(ds)
assert 'A pandas dataframe.' in str(ds)
assert '---\nw : ndarray' in str(ds)
ds = Docstring(good)
with pytest.raises(ValueError):
ds.insert_parameters('unknown', new)
from statsmodels.iolib.summary import SimpleTable, Summary
from statsmodels.tools.docstring import Docstring, Parameter, indent
from statsmodels.tsa.base.prediction import PredictionResults
from statsmodels.tsa.base.tsa_model import get_index_loc, get_prediction_index
from statsmodels.tsa.seasonal import STL, DecomposeResult
from statsmodels.tsa.statespace.kalman_filter import _check_dynamic
DateLike = Union[int, str, dt.datetime, pd.Timestamp, np.datetime64]
ds = Docstring(STL.__doc__)
ds.insert_parameters(
"endog",
Parameter(
"model",
"Model",
[
"The model used to forecast endog after the seasonality has been "
"removed using STL"
],
),
)
ds.insert_parameters(
"model",
Parameter(
"model_kwargs",
"Dict[str, Any]",
[
"Any additional arguments needed to initialized the model using "
"the residuals produced by subtracting the seasonality."
],
),
)
return SimpleTable(
data,
header=cols,
stubs=stubs,
title="Descriptive Statistics",
txt_fmt={"data_fmts": {0: "%s", 1: _formatter}},
datatypes=[1] * len(data),
)
def __str__(self) -> str:
return str(self.summary().as_text())
ds = Docstring(Description.__doc__)
ds.replace_block(
"Returns", Parameter(None, "DataFrame", ["Descriptive statistics"])
)
ds.replace_block("Attributes", [])
ds.replace_block(
"See Also",
[
(
[("pandas.DataFrame.describe", None)],
["Basic descriptive statistics"],
),
(
[("Description", None)],
["Descriptive statistics class with additional output options"],
),
],
)
