mridc.utils.decorators package

Submodules

mridc.utils.decorators.deprecated module

mridc.utils.decorators.deprecated.deprecated(wrapped=None, version=None, explanation=None)[source]

This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.

Parameters

  • wrapped (The function to be decorated.) – function

  • version (The version of the package where the function was deprecated.) – str

  • explanation (The explanation of the deprecation.) – str

Return type

The decorated function.

mridc.utils.decorators.experimental module

mridc.utils.decorators.experimental.experimental(cls)[source]

Decorator to mark a class as experimental.

Parameters

cls (The class to be decorated.) – class

Return type

The decorated class.

mridc.utils.decorators.port_docs module

mridc.utils.decorators.port_docs.add_port_docs(wrapped=None, instance=None, value='')[source]

Adds port documentation to the wrapped function.

Parameters

  • wrapped (The function to decorate.) – function

  • instance (The instance of the function.) – object

  • value (The value of the port.) – object

Return type

The decorated function.

Module contents