WithReference¶
-
class
utilipy.utils.
WithReference
(wrapped: Any, *, doc: Optional[str] = None, reference: Optional[Any] = None, **kw)[source]¶ Bases:
utilipy.utils.collections.WithMeta
,utilipy.utils.collections.WithDocstring
Objects wrapt to include reference(s) and other metadata.
Notes
see
metadata
for usage of the metadata module.- Attributes
meta
MetaData
Metadata.
Object wrapt to include a reference, and any other metadata.
- Parameters
- wrappedAny
WithMeta
wraps anything, just adding metadata.- reference: Any, optional
The attribution for the object, such as a paper link.
- kwDict[Any, Any], any
the key, value pairs for the metadata