refinegems.developement subpackage

This subpackage contains mainly modules with functions and more helpful for maintainers and developers of the refineGEMs toolbox.

decorators module

This module contains decorator functions.

refinegems.developement.decorators.debug(func)

A decorator for debug functions.

Debug functions are for giving developers detailed output for debugging the code.

refinegems.developement.decorators.deprecate(func=None, note: str = None)

A decorator to tell the user, that the function will soon be deprecated.

Used to give hints to users, that their code will not work as expected, if they update to a newer version.

refinegems.developement.decorators.implement(func)

A decorator for functions that need to be implemented.

Used to give a hint to other developers, that this function is not yet implemented, but should be to make the program executable.

refinegems.developement.decorators.suppress_log_message(logger_name, level, message_substring)

refinegems.developement.decorators.suppress_warning(msg_substring)

A decorator to suppress warnings that contain a specific substring.

Args:

• msg_substring (str):

  The substring to look for in warning messages.

refinegems.developement.decorators.template(func)

A decorator for template functions.

Template functions are not executable and are mainly for giving developers a sense of how functions for the functionality this template is for should look like.