pydox.commodities.PlotParams.get

classmethod PlotParams.get(obj: Callable | TPlotParams | None = None, **kwargs) → PlotParams

Return a pydox.commodities.PlotParams instance from an object

Behavior:

• If object is None, return a default pydox.commodities.PlotParams instance with **kwargs.

• If object is a functools.partial of pydox.commodities.PlotParams, return the called functools.partial.

• If object is an instance of pydox.commodities.PlotParams, return it unchanged.

In any other case, a ValueError is raised.

This class method can thus be used as an object validator, that will return an instance of pydox.commodities.PlotParams or fails.

Parameters:

• obj (None | functools.partial`(:class:`pydox.commodities.PlotParams) | pydox.commodities.PlotParams)

• **kwargs – Passed to pydox.commodities.PlotParams if obj is None. Ignored otherwise.

Return type:

pydox.commodities.PlotParams

Raises:

ValueError –