Vega strike Python Modules doc: warnings Namespace Reference

All Data Structures Namespaces Files Functions Variables

Data Structures
class	_OptionError

Functions
def	warn

def	warn_explicit

def	showwarning

def	formatwarning

def	filterwarnings

def	resetwarnings

Variables
list	__all__

string	defaultaction = "default"

list	filters = []

dictionary	onceregistry = {}

Detailed Description

Python part of the warnings subsystem.

Function Documentation

def warnings.filterwarnings	(	action,
		message = `""`,
		category = `Warning`,
		module = `""`,
		lineno = `0`,
		append = `0`
	)

Insert an entry into the list of warnings filters (at the front).

Use assertions to check that all arguments have the right type.

Definition at line 113 of file warnings.py.

 
                    append=0):
     """Insert an entry into the list of warnings filters (at the front).
 
     Use assertions to check that all arguments have the right type."""
 #    assert action in ("error", "ignore", "always", "default", "module",
 #                      "once"), "invalid action: %s" % `action`
 #    assert isinstance(message, types.StringType), "message must be a string"
 #    assert isinstance(category, types.ClassType), "category must be a class"
 #    assert issubclass(category, Warning), "category must be a Warning subclass"
 #    assert type(module) is types.StringType, "module must be a string"
 #    assert type(lineno) is types.IntType and lineno >= 0, \
 #           "lineno must be an int >= 0"
 #    item = (action, re.compile(message, re.I), category,
 #            re.compile(module), lineno)
 #    if append:
 #        filters.append(item)
 #    else:
 #        filters.insert(0, item)

def warnings.formatwarning	(	message,
		category,
		filename,
		lineno
	)

Function to format a warning the standard way.

Definition at line 103 of file warnings.py.

References filterwarnings(), linecache.getline(), and string.strip().

 
 def formatwarning(message, category, filename, lineno):
     """Function to format a warning the standard way."""
     import linecache
     s =  "%s:%s: %s: %s\n" % (filename, lineno, category.__name__, message)
     line = linecache.getline(filename, lineno).strip()
     if line:
         s = s + "  " + line + "\n"
     return s

def warnings.showwarning	(	message,
		category,
		filename,
		lineno,
		file = `None`
	)

Hook to write a warning to a file; replace if you like.

Definition at line 97 of file warnings.py.

References formatwarning().

 
 def showwarning(message, category, filename, lineno, file=None):
     """Hook to write a warning to a file; replace if you like."""
     if file is None:
         file = sys.stderr
     file.write(formatwarning(message, category, filename, lineno))

def warnings.warn	(	message,
		category = `None`,
		stacklevel = `1`
	)

Issue a warning, or maybe ignore it or raise an exception.

Definition at line 12 of file warnings.py.

References warn_explicit().

 
 def warn(message, category=None, stacklevel=1):
     """Issue a warning, or maybe ignore it or raise an exception."""
     # Check category argument
     if category is None:
         category = UserWarning
     assert issubclass(category, Warning)
     # Get context information
     try:
         caller = sys._getframe(stacklevel)
     except ValueError:
         globals = sys.__dict__
         lineno = 1
     else:
         globals = caller.f_globals
         lineno = caller.f_lineno
     if globals.has_key('__name__'):
         module = globals['__name__']
     else:
         module = "<string>"
     filename = globals.get('__file__')
     if filename:
         fnl = filename.lower()
         if fnl.endswith(".pyc") or fnl.endswith(".pyo"):
             filename = filename[:-1]
     else:
         if module == "__main__":
             filename = sys.argv[0]
         if not filename:
             filename = module
     registry = globals.setdefault("__warningregistry__", {})
     warn_explicit(message, category, filename, lineno, module, registry)

def warnings.warn_explicit	(	message,
		category,
		filename,
		lineno,
		module = `None`,
		registry = `None`
	)

Definition at line 45 of file warnings.py.

References string.lower(), showwarning(), and locale.str().

 
                   module=None, registry=None):
     if module is None:
         module = filename
         if module[-3:].lower() == ".py":
             module = module[:-3] # XXX What about leading pathname?
     if registry is None:
         registry = {}
     key = (message, category, lineno)
     # Quick test for common case
     if registry.get(key):
         return
     # Search the filters
     for item in filters:
         action, msg, cat, mod, ln = item
         if (msg.match(message) and
             issubclass(category, cat) and
             mod.match(module) and
             (ln == 0 or lineno == ln)):
             break
     else:
         action = defaultaction
     # Early exit actions
     if action == "ignore":
         registry[key] = 1
         return
     if action == "error":
         raise category(message)
     # Other actions
     if action == "once":
         registry[key] = 1
         oncekey = (message, category)
         if onceregistry.get(oncekey):
             return
         onceregistry[oncekey] = 1
     elif action == "always":
         pass
     elif action == "module":
         registry[key] = 1
         altkey = (message, category, 0)
         if registry.get(altkey):
             return
         registry[altkey] = 1
     elif action == "default":
         registry[key] = 1
     else:
         # Unrecognized actions are errors
         raise RuntimeError(
               "Unrecognized action (%s) in warnings.filters:\n %s" %
               (`action`, str(item)))
     # Print message and context
     showwarning(message, category, filename, lineno)

Data Structures

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation