deprecation Namespace Reference

Functions
def	__deprecated_with_msg (func, msg)
def	deprecated (msg=msg_seedoc)
	This is a decorator which can be used to mark functions as deprecated. More...
def	deprecated_module (msg=msg_seedoc)
	This function can be used to mark a module as deprecated. More...
def	is_called_by_sphinx ()
	Determine if the calling code is ultimately called by sphinx to generate documentation. More...
def	__show_colored_warning (message, category, filename, lineno, file=None, line=None)

Variables
string	msg_seedoc = "See documentation for possible replacements."

Function Documentation

__deprecated_with_msg()

def deprecation.__deprecated_with_msg (   func,   msg  )

private

Referenced by deprecated().

__show_colored_warning()

def deprecation.__show_colored_warning (   message,   category,   filename,   lineno,   file = None,   line = None  )

private

References termcolor.canDisplayColor(), and termcolor.makeColoredMessage().

Variable Documentation

msg_seedoc

string deprecation.msg_seedoc = "See documentation for possible replacements."