citric._compat

Compatibility functions and classes for different versions of LimeSurvey.

Exceptions

FutureVersionWarning

Warning for features only available in an unreleased version of LimeSurvey.

Functions

future(version)

Mark a function as only available in the current development build of LimeSurvey.

future_parameter(version, parameter)

Mark a function as only available in the current development build of LimeSurvey.

Module Contents

exception citric._compat.FutureVersionWarning[source]

Bases: UserWarning

Warning for features only available in an unreleased version of LimeSurvey.

citric._compat.future(version)[source]

Mark a function as only available in the current development build of LimeSurvey.

Parameters:

version (str) – The earliest version of LimeSurvey that this function is available in.

Returns:

The wrapped function.

Return type:

Callable

citric._compat.future_parameter(version, parameter)[source]

Mark a function as only available in the current development build of LimeSurvey.

Parameters:

  • version (str) – The earliest version of LimeSurvey that this parameter is available in.

  • parameter (str) – The parameter that is only available in the current development build of LimeSurvey.

Returns:

The wrapped function.

Return type:

Callable