Table Of Contents

Previous topic

sardanaevent

Next topic

sardanameta

This Page

sardanamodulemanager

This module is part of the Python Sardana library. It defines the base classes for module manager

Classes

ModuleManager

Inheritance diagram of ModuleManager

class ModuleManager[source]

This class handles python module loading/reloading and unloading.

init(*args, **kwargs)[source]

Singleton instance initialization.

reInit()[source]
cleanUp()[source]
reset_python_path()[source]
remove_python_path(path_id)[source]
add_python_path(path)[source]
findFullModuleName(module_name, path=None)[source]
reloadModule(module_name, path=None, reload=True)[source]

Loads/reloads the given module name

deep_reload_module(module_name, path=None, exclude=None)[source]
loadModule(module_name, path=None)[source]

Loads the given module name. If the module has been already loaded into this python interpreter, nothing is done.

Parameters:
  • module_name (str) – the module to be loaded.
  • path (seq<str> or None) – list of paths to look for modules [default: None]
Returns:

python module

Raises:

ImportError

unloadModule(module_name)[source]

Unloads the given module name

unloadModules(module_list=None)[source]

Unloads the given module name

getModule(module_name)[source]

Returns the module object for the given module name

getModuleNames()[source]
Critical = 50
Debug = 10
DftLogFormat = <logging.Formatter object at 0xb6f76fcc>
DftLogLevel = 20
DftLogMessageFormat = '%(threadName)-14s %(levelname)-8s %(asctime)s %(name)s: %(message)s'
Error = 40
Fatal = 50
Info = 20
Trace = 5
Warning = 30
addChild(child)

Adds a new logging child

Parameters:child – (logging.Logger) the new child
classmethod addLevelName(level_no, level_name)

Registers a new log level

Parameters:
  • level_no – (int) the level number
  • level_name – (str) the corresponding name
addLogHandler(handler)

Registers a new handler in this object’s logger

Parameters:handler – (logging.Handler) the new handler to be added
classmethod addRootLogHandler(h)

Adds a new handler to the root logger

Parameters:h – (logging.Handler) the new log handler
call__init__(klass, *args, **kw)

Method to be called from subclasses to call superclass corresponding __init__ method. This method ensures that classes from diamond like class hierarquies don’t call their super classes __init__ more than once.

call__init__wo_kw(klass, *args)

Same as call__init__ but without keyword arguments because PyQT does not support them.

changeLogName(name)

Change the log name for this object.

Parameters:name – (str) the new log name
copyLogHandlers(other)

Copies the log handlers of other object to this object

Parameters:other – (object) object which contains ‘log_handlers’
critical(msg, *args, **kw)

Record a critical message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.critical().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
debug(msg, *args, **kw)

Record a debug message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.debug().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
deprecated(msg, *args, **kw)

Record a deprecated warning message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.warning().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
classmethod disableLogOutput()

Disables the logging.StreamHandler which dumps log records, by default, to the stderr.

classmethod enableLogOutput()

Enables the logging.StreamHandler which dumps log records, by default, to the stderr.

error(msg, *args, **kw)

Record an error message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.error().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
exception(msg, *args)

Log a message with severity ‘ERROR’ on the root logger, with exception information.. Accepted args are the same as logging.Logger.exception().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
fatal(msg, *args, **kw)

Record a fatal message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.fatal().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
flushOutput()

Flushes the log output

getAttrDict()
getChildren()

Returns the log children for this object

Returns:(sequence<logging.Logger) the list of log children
classmethod getLogFormat()

Retuns the current log message format (the root log format)

Returns:(str) the log message format
getLogFullName()

Gets the full log name for this object

Returns:(str) the full log name
classmethod getLogLevel()

Retuns the current log level (the root log level)

Returns:(int) a number representing the log level
getLogName()

Gets the log name for this object

Returns:(str) the log name
getLogObj()

Returns the log object for this object

Returns:(logging.Logger) the log object
classmethod getLogger(name=None)
getParent()

Returns the log parent for this object or None if no parent exists

Returns:(logging.Logger or None) the log parent for this object
classmethod getRootLog()

Retuns the root logger

Returns:(logging.Logger) the root logger
info(msg, *args, **kw)

Record an info message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.info().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
classmethod initRoot()

Class method to initialize the root logger. Do NOT call this method directly in your code

log(level, msg, *args, **kw)

Record a log message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.log().

Parameters:
  • level – (int) the record level
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
log_format = <logging.Formatter object at 0xb6f76fcc>
log_level = 20
classmethod removeRootLogHandler(h)

Removes the given handler from the root logger

Parameters:h – (logging.Handler) the handler to be removed
classmethod resetLogFormat()

Resets the log message format (the root log format)

classmethod resetLogLevel()

Resets the log level (the root log level)

root_init_lock = <thread.lock object at 0xb74e1db0>
root_inited = False
classmethod setLogFormat(format)

sets the new log message format

Parameters:level – (str) the new log message format
classmethod setLogLevel(level)

sets the new log level (the root log level)

Parameters:level – (int) the new log level
stack(target=5)

Log the usual stack information, followed by a listing of all the local variables in each frame.

Parameters:target – (int) the log level assigned to the record
Returns:(str) The stack string representation
stream_handler = None
syncLog()

Synchronises the log output

trace(msg, *args, **kw)

Record a trace message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.log().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
traceback(level=5, extended=True)

Log the usual traceback information, followed by a listing of all the local variables in each frame.

Parameters:
  • level – (int) the log level assigned to the traceback record
  • extended – (bool) if True, the log record message will have multiple lines
Returns:

(str) The traceback string representation

updateAttrDict(other)
warning(msg, *args, **kw)

Record a warning message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.warning().

Parameters:
  • msg – (str) the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments