footings.model.step¶
-
step(method: Optional[callable] = None, *, uses: List[str], impacts: List[str], name: Optional[str] = None, docstring: Optional[str] = None, metadata: Optional[dict] = None)[source]¶ Turn a method into a step within the footings framework.
- Parameters
None] method (Union[callable,) – The method to decorate, by default None.
uses (List[str]) – A list of the object names used by the step.
impacts (List[str]) – A list of the object names that are impacted by the step (i.e., the returns and intermediates).
none] name (Union[str,) – Assign a step name to step, optional.
none] docstring (Union[str,) – Assign a docstring to step, optional.
none] metadata (Union[dict,) – Assign metadata to step, optional.
- Returns
The decorated method with a attributes for uses and impacts and updated docstring if wrap passed.
- Return type
callable