python.ConfigAccumulator Namespace Reference

Classes
class	ConfigAccumulator
class	ContainerConfig
class	DataType
class	OutputConfig
class	SelectionConfig

Functions
def	deprecated (str reason="")

Variables
	deprecationWarningCategory = FutureWarning

Function Documentation

deprecated()

def python.ConfigAccumulator.deprecated

(

str

reason = ""

)

Definition at line 13 of file ConfigAccumulator.py.

def deprecated(reason: str = ""):
    def decorator(func):
        message = f"{func.__qualname__} is deprecated."
        if reason:
            message += " " + reason
 
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            warnings.warn(
                message,
                category=deprecationWarningCategory,
                stacklevel=2,
            )
            return func(*args, **kwargs)
 
        return wrapper
    return decorator
 

Variable Documentation

deprecationWarningCategory

python.ConfigAccumulator.deprecationWarningCategory = FutureWarning

Definition at line 12 of file ConfigAccumulator.py.