sardanabase

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

Classes

SardanaBaseObject

Inheritance diagram of SardanaBaseObject
class SardanaBaseObject(**kwargs)[source]

The Sardana most abstract object. It contains only two members:

  • _manager : a weak reference to the manager (pool or ms) where it belongs

  • _name : the name

  • _full_name : the name (usually a tango device name, but can be anything else.)

get_manager()[source]

Return the sardana.Manager which owns this sardana object.

Return type:

Any

Returns:

the manager which owns this pool object.

get_name()[source]

Returns this sardana object name

Return type:

str

Returns:

this sardana object name

set_name(name)[source]

Sets sardana object name

Param:

sardana object name

get_full_name()[source]

Returns this sardana object full name

Return type:

str

Returns:

this sardana object full name

get_type()[source]

Returns this sardana object type.

Return type:

ElementType

Returns:

this sardana object type

get_parent()[source]

Returns this pool object parent.

Return type:

SardanaBaseObject

Returns:

this objects parent

get_parent_name()[source]

Returns this sardana object parent’s name.

Return type:

str

Returns:

this objects parent

get_frontend()[source]

Returns this sardana frontend object or None if no frontend is registered

Return type:

Any

Returns:

this objects frontend

fire_event(event_type, event_value, listeners=None, protected=True)[source]
get_interfaces()[source]

Returns the set of interfaces this object implements.

Return type:

Set[Interface]

Returns:

The set of interfaces this object implements.

get_interface()[source]

Returns the interface this object implements.

Return type:

Interface

Returns:

The interface this object implements.

get_interface_names()[source]

Returns a sequence of interface names this object implements.

Return type:

Sequence[str]

Returns:

The sequence of interfaces this object implements.

serialize(*args, **kwargs)[source]
serialized(*args, **kwargs)[source]
str(*args, **kwargs)[source]
property manager: Any

reference to the sardana.Manager

property name: str

object name

property full_name: str

object full name

property frontend: Any

the object frontend

Critical = 50

Critical message level (constant)

Debug = 10

Debug message level (constant)

DftLogFormat = <logging.Formatter object>

Default log format (constant)

DftLogLevel = 20

Default log level (constant)

DftLogMessageFormat = '%(threadName)-14s %(levelname)-8s %(asctime)s %(name)s: %(message)s'

Default log message format (constant)

Error = 40

Error message level (constant)

Fatal = 50

Fatal message level (constant)

Info = 20

Info message level (constant)

Trace = 5

Trace message level (constant)

Warning = 30

Warning message level (constant)

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

add_listener(listener)

Adds a new listener for this object.

Parameters:

listener – a listener

are_events_blocked()
block_events()
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 PyQt4 does not support them.

changeLogName(name)

Change the log name for this object.

Parameters:

name (str) – the new log name

cleanUp()

The cleanUp. Default implementation does nothing Overwrite when necessary

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=None, dep=None, alt=None, rel=None, dbg_msg=None, _callerinfo=None, **kw)

Record a deprecated warning message in this object’s logger. If message is not passed, a estandard deprecation message is constructued using dep, alt, rel arguments. Also, an extra debug message can be recorded, followed by traceback info.

Parameters:

  • msg (str) – the message to be recorded (if None passed, it will be constructed using dep (and, optionally, alt and rel)

  • dep (str) – name of deprecated feature (in case msg is None)

  • alt (str) – name of alternative feature (in case msg is None)

  • rel (str) – name of release from which the feature was deprecated (in case msg is None)

  • dbg_msg (str) – msg for debug (or None to log only the warning)

  • _callerinfo – for internal use only. Do not use this argument.

  • kw – any additional keyword arguments, are passed to logging.Logger.warning()

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

flush_queue()
getAttrDict()
getChildren()

Returns the log children for this object

Returns:

the list of log children

Return type:

sequence<logging.Logger

classmethod getLogFormat()

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

Returns:

the log message format

Return type:

str

getLogFullName()

Gets the full log name for this object

Returns:

the full log name

Return type:

str

classmethod getLogLevel()

Retuns the current log level (the root log level)

Returns:

a number representing the log level

Return type:

int

getLogName()

Gets the log name for this object

Returns:

the log name

Return type:

str

getLogObj()

Returns the log object for this object

Returns:

the log object

Return type:

logging.Logger

classmethod getLogger(name=None)
getParent()

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

Returns:

the log parent for this object

Return type:

logging.Logger or None

classmethod getRootLog()

Retuns the root logger

Returns:

the root logger

Return type:

logging.Logger

get_listeners()
has_listeners()

Returns True if anybody is listening to events from this object

Returns:

True is at least one listener is listening or False otherwise

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>

Default log message format

log_level = 20

Current global log level

queue_event(event_type, event_value, listeners=None)
removeLogHandler(handler)

Removes the given handler from this object’s logger

Parameters:

handler (logging.Handler) – the handler to be removed

classmethod removeRootLogHandler(h)

Removes the given handler from the root logger

Parameters:

h (logging.Handler) – the handler to be removed

remove_listener(listener)

Removes an existing listener for this object.

Parameters:

listener – the listener to be removed

Returns:

True is succeeded or False otherwise

classmethod resetLogFormat()

Resets the log message format (the root log format)

classmethod resetLogLevel()

Resets the log level (the root log level)

root_init_lock = <unlocked _thread.lock object>

Internal usage

root_inited = True

Internal usage

classmethod setLogFormat(format)

sets the new log message format

Parameters:

format (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:

The stack string representation

Return type:

str

stream_handler = <StreamHandler <stderr> (NOTSET)>

the main stream handler

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:

The traceback string representation

Return type:

str

unblock_events()
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

SardanaObjectID

Inheritance diagram of SardanaObjectID
class SardanaObjectID(id=0)[source]

To be used by sardana objects which have an ID associated to them.

get_id()[source]

Returns this sardana object ID

Return type:

int

Returns:

this sardana object ID

serialize(*args, **kwargs)[source]
property id: int

object ID